c++: Make *_cast<*> parsing more robust to errors [PR108438]
[official-gcc.git] / gcc / ada / sinfo.ads
blob599f4f63cce06be60fb5417794fbe9c82c3dfd0f
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S I N F O --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2024, 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_Source
86 -- This flag is present in all nodes. It is set if the
87 -- node is built by the scanner or parser, and clear if
88 -- the node is built by the analyzer or expander. It
89 -- indicates that the node corresponds to a construct
90 -- that appears in the original source program.
92 -- Analyzed This flag is present in all nodes. It is set when
93 -- a node is analyzed, and is used to avoid analyzing
94 -- the same node twice. Analysis includes expansion if
95 -- expansion is active, so in this case if the flag is
96 -- set it means the node has been analyzed and expanded.
98 -- Error_Posted This flag is present in all nodes. It is set when
99 -- an error message is posted which is associated with
100 -- the flagged node. This is used to avoid posting more
101 -- than one message on the same node.
103 -- Link For a node, points to the Parent. For a list, points
104 -- to the list header. Note that in the latter case, a
105 -- client cannot modify the link field. This field is
106 -- private to the Atree package (but is also modified
107 -- by the Nlists package).
109 -- The following additional fields are common to all entities (that is,
110 -- nodes whose Nkind is in N_Entity):
112 -- Ekind Entity type.
114 -- Convention Entity convention (Convention_Id value)
116 --------------------------------
117 -- Implicit Nodes in the Tree --
118 --------------------------------
120 -- Generally the structure of the tree very closely follows the grammar as
121 -- defined in the RM. However, certain nodes are omitted to save space and
122 -- simplify semantic processing. Two general classes of such omitted nodes
123 -- are as follows:
125 -- If the only possibilities for a non-terminal are one or more other
126 -- non-terminals (i.e. the rule is a "skinny" rule), then usually the
127 -- corresponding node is omitted from the tree, and the target construct
128 -- appears directly. For example, a real type definition is either
129 -- floating point definition or a fixed point definition. No explicit node
130 -- appears for real type definition. Instead either the floating point
131 -- definition or fixed point definition appears directly.
133 -- If a non-terminal corresponds to a list of some other non-terminal
134 -- (possibly with separating punctuation), then usually it is omitted from
135 -- the tree, and a list of components appears instead. For example,
136 -- sequence of statements does not appear explicitly in the tree. Instead
137 -- a list of statements appears directly.
139 -- Some additional cases of omitted nodes occur and are documented
140 -- individually. In particular, many nodes are omitted in the tree
141 -- generated for an expression.
143 -------------------------------------------
144 -- Handling of Defining Identifier Lists --
145 -------------------------------------------
147 -- In several declarative forms in the syntax, lists of defining
148 -- identifiers appear (object declarations, component declarations, number
149 -- declarations etc.)
151 -- The semantics of such statements are equivalent to a series of identical
152 -- declarations of single defining identifiers (except that conformance
153 -- checks require the same grouping of identifiers in the parameter case).
155 -- To simplify semantic processing, the parser breaks down such multiple
156 -- declaration cases into sequences of single declarations, duplicating
157 -- type and initialization information as required. The flags More_Ids and
158 -- Prev_Ids are used to record the original form of the source in the case
159 -- where the original source used a list of names, More_Ids being set on
160 -- all but the last name and Prev_Ids being set on all but the first name.
161 -- These flags are used to reconstruct the original source (e.g. in the
162 -- Sprint package), and also are included in the conformance checks, but
163 -- otherwise have no semantic significance.
165 -- Note: the reason that we use More_Ids and Prev_Ids rather than
166 -- First_Name and Last_Name flags is so that the flags are off in the
167 -- normal one identifier case, which minimizes tree print output.
169 -----------------------
170 -- Use of Node Lists --
171 -----------------------
173 -- With a few exceptions, if a construction of the form {non-terminal}
174 -- appears in the tree, lists are used in the corresponding tree node (see
175 -- package Nlists for handling of node lists). In this case a field of the
176 -- parent node points to a list of nodes for the non-terminal. The field
177 -- name for such fields has a plural name which always ends in "s". For
178 -- example, a case statement has a field Alternatives pointing to list of
179 -- case statement alternative nodes.
181 -- Only fields pointing to lists have names ending in "s", so generally the
182 -- structure is strongly typed, fields not ending in s point to single
183 -- nodes, and fields ending in s point to lists.
185 -- The following example shows how a traversal of a list is written. We
186 -- suppose here that Stmt points to a N_Case_Statement node which has a
187 -- list field called Alternatives:
189 -- Alt := First (Alternatives (Stmt));
190 -- while Present (Alt) loop
191 -- ..
192 -- -- processing for case statement alternative Alt
193 -- ..
194 -- Alt := Next (Alt);
195 -- end loop;
197 -- The Present function tests for Empty, which in this case signals the end
198 -- of the list. First returns Empty immediately if the list is empty.
199 -- Present is defined in Atree; First and Next are defined in Nlists.
201 -- The exceptions to this rule occur with {DEFINING_IDENTIFIERS} in all
202 -- contexts, which is handled as described in the previous section, and
203 -- with {,library_unit_NAME} in the N_With_Clause node, which is handled
204 -- using the First_Name and Last_Name flags, as further detailed in the
205 -- description of the N_With_Clause node.
207 -------------
208 -- Pragmas --
209 -------------
211 -- Pragmas can appear in many different context, but are not included in
212 -- the grammar. Still they must appear in the tree, so they can be properly
213 -- processed.
215 -- Two approaches are used. In some cases, an extra field is defined in an
216 -- appropriate node that contains a list of pragmas appearing in the
217 -- expected context. For example pragmas can appear before an
218 -- Accept_Alternative in a Selective_Accept_Statement, and these pragmas
219 -- appear in the Pragmas_Before field of the N_Accept_Alternative node.
221 -- The other approach is to simply allow pragmas to appear in syntactic
222 -- lists where the grammar (of course) does not include the possibility.
223 -- For example, the Variants field of an N_Variant_Part node points to a
224 -- list that can contain both N_Pragma and N_Variant nodes.
226 -- To make processing easier in the latter case, the Nlists package
227 -- provides a set of routines (First_Non_Pragma, Last_Non_Pragma,
228 -- Next_Non_Pragma, Prev_Non_Pragma) that allow such lists to be handled
229 -- ignoring all pragmas.
231 -- In the case of the variants list, we can either write:
233 -- Variant := First (Variants (N));
234 -- while Present (Variant) loop
235 -- ...
236 -- Variant := Next (Variant);
237 -- end loop;
239 -- or
241 -- Variant := First_Non_Pragma (Variants (N));
242 -- while Present (Variant) loop
243 -- ...
244 -- Variant := Next_Non_Pragma (Variant);
245 -- end loop;
247 -- In the first form of the loop, Variant can either be an N_Pragma or an
248 -- N_Variant node. In the second form, Variant can only be N_Variant since
249 -- all pragmas are skipped.
251 ---------------------
252 -- Optional Fields --
253 ---------------------
255 -- Fields which correspond to a section of the syntax enclosed in square
256 -- brackets are generally omitted (and the corresponding field set to Empty
257 -- for a node, or No_List for a list). The documentation of such fields
258 -- notes these cases. One exception to this rule occurs in the case of
259 -- possibly empty statement sequences (such as the sequence of statements
260 -- in an entry call alternative). Such cases appear in the syntax rules as
261 -- [SEQUENCE_OF_STATEMENTS] and the fields corresponding to such optional
262 -- statement sequences always contain an empty list (not No_List) if no
263 -- statements are present.
265 -- Note: the utility program that constructs the body and spec of the Nmake
266 -- package relies on the format of the comments to determine if a field
267 -- should have a default value in the corresponding make routine. The rule
268 -- is that if the first line of the description of the field contains the
269 -- string "(set to xxx if", then a default value of xxx is provided for
270 -- this field in the corresponding Make_yyy routine.
272 -----------------------------------
273 -- Note on Body/Spec Terminology --
274 -----------------------------------
276 -- In informal discussions about Ada, it is customary to refer to package
277 -- and subprogram specs and bodies. However, this is not technically
278 -- correct, what is normally referred to as a spec or specification is in
279 -- fact a package declaration or subprogram declaration. We are careful in
280 -- GNAT to use the correct terminology and in particular, the full word
281 -- specification is never used as an incorrect substitute for declaration.
282 -- The structure and terminology used in the tree also reflects the grammar
283 -- and thus uses declaration and specification in the technically correct
284 -- manner.
286 -- However, there are contexts in which the informal terminology is useful.
287 -- We have the word "body" to refer to the Interp_Etype declared by the
288 -- declaration of a unit body, and in some contexts we need similar term to
289 -- refer to the entity declared by the package or subprogram declaration,
290 -- and simply using declaration can be confusing since the body also has a
291 -- declaration.
293 -- An example of such a context is the link between the package body and
294 -- its declaration. With_Declaration is confusing, since the package body
295 -- itself is a declaration.
297 -- To deal with this problem, we reserve the informal term Spec, i.e. the
298 -- popular abbreviation used in this context, to refer to the entity
299 -- declared by the package or subprogram declaration. So in the above
300 -- example case, the field in the body is called With_Spec.
302 -- Another important context for the use of the word Spec is in error
303 -- messages, where a hyper-correct use of declaration would be confusing to
304 -- a typical Ada programmer, and even for an expert programmer can cause
305 -- confusion since the body has a declaration as well.
307 -- So, to summarize:
309 -- Declaration always refers to the syntactic entity that is called
310 -- a declaration. In particular, subprogram declaration
311 -- and package declaration are used to describe the
312 -- syntactic entity that includes the semicolon.
314 -- Specification always refers to the syntactic entity that is called
315 -- a specification. In particular, the terms procedure
316 -- specification, function specification, package
317 -- specification, subprogram specification always refer
318 -- to the syntactic entity that has no semicolon.
320 -- Spec is an informal term, used to refer to the entity
321 -- that is declared by a task declaration, protected
322 -- declaration, generic declaration, subprogram
323 -- declaration or package declaration.
325 -- This convention is followed throughout the GNAT documentation
326 -- both internal and external, and in all error message text.
328 ------------------------
329 -- Internal Use Nodes --
330 ------------------------
332 -- These are Node_Kind settings used in the internal implementation which
333 -- are not logically part of the specification.
335 -- N_Unused_At_Start
336 -- Completely unused entry at the start of the enumeration type. This
337 -- is inserted so that no legitimate value is zero, which helps to get
338 -- better debugging behavior, since zero is a likely uninitialized value).
340 -- N_Unused_At_End
341 -- Completely unused entry at the end of the enumeration type. This is
342 -- handy so that arrays with Node_Kind as the index type have an extra
343 -- entry at the end (see for example the use of the Pchar_Pos_Array in
344 -- Treepr, where the extra entry provides the limit value when dealing with
345 -- the last used entry in the array).
347 -----------------------------------------
348 -- Note on the settings of Sloc fields --
349 -----------------------------------------
351 -- The Sloc field of nodes that come from the source is set by the parser.
352 -- For internal nodes, and nodes generated during expansion the Sloc is
353 -- usually set in the call to the constructor for the node. In general the
354 -- Sloc value chosen for an internal node is the Sloc of the source node
355 -- whose processing is responsible for the expansion. For example, the Sloc
356 -- of an inherited primitive operation is the Sloc of the corresponding
357 -- derived type declaration.
359 -- For the nodes of a generic instantiation, the Sloc value is encoded to
360 -- represent both the original Sloc in the generic unit, and the Sloc of
361 -- the instantiation itself. See Sinput.ads for details.
363 -- Subprogram instances create two callable entities: one is the visible
364 -- subprogram instance, and the other is an anonymous subprogram nested
365 -- within a wrapper package that contains the renamings for the actuals.
366 -- Both of these entities have the Sloc of the defining entity in the
367 -- instantiation node. This simplified for instance in the past some ASIS
368 -- queries.
370 -----------------------
371 -- Field Definitions --
372 -----------------------
374 -- In the following node definitions, all fields, both syntactic and
375 -- semantic, are documented. The one exception is in the case of entities
376 -- (defining identifiers, character literals, and operator symbols), where
377 -- the usage of the fields depends on the entity kind. Entity fields are
378 -- fully documented in the separate package Einfo.
380 -- In the node definitions, three common sets of fields are abbreviated to
381 -- save both space in the documentation, and also space in the string
382 -- (defined in Tree_Print_Strings) used to print trees. The following
383 -- abbreviations are used:
385 -- "plus fields for binary operator"
386 -- Chars Name_Id for the operator
387 -- Left_Opnd left operand expression
388 -- Right_Opnd right operand expression
389 -- Entity defining entity for operator
390 -- Associated_Node for generic processing
391 -- Do_Overflow_Check set if overflow check needed
392 -- Has_Private_View set in generic units
393 -- Has_Secondary_Private_View set in generic units
395 -- "plus fields for unary operator"
396 -- Chars Name_Id for the operator
397 -- Right_Opnd right operand expression
398 -- Entity defining entity for operator
399 -- Associated_Node for generic processing
400 -- Do_Overflow_Check set if overflow check needed
401 -- Has_Private_View set in generic units
402 -- Has_Secondary_Private_View set in generic units
404 -- "plus fields for expression"
405 -- Paren_Count number of parentheses levels
406 -- Etype type of the expression
407 -- Is_Overloaded >1 type interpretation exists
408 -- Is_Static_Expression set for static expression
409 -- Raises_Constraint_Error evaluation raises CE
410 -- Must_Not_Freeze set if must not freeze
411 -- Do_Range_Check set if a range check needed
412 -- Has_Dynamic_Length_Check set if length check inserted
413 -- Assignment_OK set if modification is OK
414 -- Is_Controlling_Actual set for controlling argument
416 -- Note: see under (EXPRESSION) for further details on the use of
417 -- the Paren_Count field to record the number of parentheses levels.
419 -- Node_Kind is the type used in the Nkind field to indicate the node kind.
420 -- The actual definition of this type is given later (the reason for this
421 -- is that we want the descriptions ordered by logical chapter in the RM,
422 -- but the type definition is reordered to facilitate the definition of
423 -- some subtype ranges. The individual descriptions of the nodes show how
424 -- the various fields are used in each node kind, as well as providing
425 -- logical names for the fields. Functions and procedures are provided for
426 -- accessing and setting these fields using these logical names.
428 -----------------------
429 -- Gigi Restrictions --
430 -----------------------
432 -- The tree passed to Gigi is more restricted than the general tree form.
433 -- For example, as a result of expansion, most of the tasking nodes can
434 -- never appear. For each node to which either a complete or partial
435 -- restriction applies, a note entitled "Gigi restriction" appears which
436 -- documents the restriction.
438 -- Note that most of these restrictions apply only to trees generated when
439 -- code is being generated, since they involve expander actions that
440 -- destroy the tree.
442 ----------------
443 -- Ghost Mode --
444 ----------------
446 -- The SPARK RM 6.9 defines two classes of constructs - Ghost entities and
447 -- Ghost statements. The intent of the feature is to treat Ghost constructs
448 -- as non-existent when Ghost assertion policy Ignore is in effect.
450 -- The corresponding nodes which map to Ghost constructs are:
452 -- Ghost entities
453 -- Declaration nodes
454 -- N_Package_Body
455 -- N_Subprogram_Body
457 -- Ghost statements
458 -- N_Assignment_Statement
459 -- N_Procedure_Call_Statement
460 -- N_Pragma
462 -- In addition, the compiler treats instantiations as Ghost entities
464 -- To achieve the removal of ignored Ghost constructs, the compiler relies
465 -- on global variables Ghost_Mode and Ignored_Ghost_Region, which comprise
466 -- a mechanism called "Ghost regions".
468 -- The values of Ghost_Mode are as follows:
470 -- 1. Check - All static semantics as defined in SPARK RM 6.9 are in
471 -- effect. The Ghost region has mode Check.
473 -- 2. Ignore - Same as Check, ignored Ghost code is not present in ALI
474 -- files, object files, and the final executable. The Ghost region
475 -- has mode Ignore.
477 -- 3. None - No Ghost region is in effect
479 -- The value of Ignored_Ghost_Region captures the node which initiates an
480 -- ignored Ghost region.
482 -- A Ghost region is a compiler operating mode, similar to Check_Syntax,
483 -- however a region is much more finely grained and depends on the policy
484 -- in effect. The region starts prior to the analysis of a Ghost construct
485 -- and ends immediately after its expansion. The region is established as
486 -- follows:
488 -- 1. Declarations - Prior to analysis, if the declaration is subject to
489 -- pragma Ghost.
491 -- 2. Renaming declarations - Same as 1) or when the renamed entity is
492 -- Ghost.
494 -- 3. Completing declarations - Same as 1) or when the declaration is
495 -- partially analyzed and the declaration completes a Ghost entity.
497 -- 4. N_Package_Body, N_Subprogram_Body - Same as 1) or when the body is
498 -- partially analyzed and completes a Ghost entity.
500 -- 5. N_Assignment_Statement - After the left hand side is analyzed and
501 -- references a Ghost entity.
503 -- 6. N_Procedure_Call_Statement - After the name is analyzed and denotes
504 -- a Ghost procedure.
506 -- 7. N_Pragma - During analysis, when the related entity is Ghost or the
507 -- pragma encloses a Ghost entity.
509 -- 8. Instantiations - Save as 1) or when the instantiation is partially
510 -- analyzed and the generic template is Ghost.
512 -- The following routines install a new Ghost region:
514 -- Install_Ghost_Region
515 -- Mark_And_Set_Ghost_xxx
516 -- Set_Ghost_Mode
518 -- The following routine ends a Ghost region:
520 -- Restore_Ghost_Region
522 -- A region may be reinstalled similarly to scopes for decoupled expansion
523 -- such as the generation of dispatch tables or the creation of a predicate
524 -- function.
526 -- If the mode of a Ghost region is Ignore, any newly created nodes as well
527 -- as source entities are marked as ignored Ghost. In addition, the marking
528 -- process signals all enclosing scopes that an ignored Ghost node resides
529 -- within. The compilation unit where the node resides is also added to an
530 -- auxiliary table for post processing.
532 -- After the analysis and expansion of all compilation units takes place
533 -- as well as the instantiation of all inlined [generic] bodies, the GNAT
534 -- driver initiates a separate pass which removes all ignored Ghost nodes
535 -- from all units stored in the auxiliary table.
537 --------------------
538 -- GNATprove Mode --
539 --------------------
541 -- When a file is compiled in GNATprove mode (-gnatd.F), a very light
542 -- expansion is performed and the analysis must generate a tree in a
543 -- form that meets additional requirements.
545 -- This light expansion does two transformations of the tree that cannot
546 -- be postponed till after semantic analysis:
548 -- 1. Replace object renamings by renamed object. This requires the
549 -- introduction of temporaries at the point of the renaming, which
550 -- must be properly analyzed.
552 -- 2. Fully qualify entity names. This is needed to generate suitable
553 -- local effects and call-graphs in ALI files, with the completely
554 -- qualified names (in particular the suffix to distinguish homonyms).
556 -- The tree after this light expansion should be fully analyzed
557 -- semantically, which sometimes requires the insertion of semantic
558 -- preanalysis, for example for subprogram contracts and pragma
559 -- check/assert. In particular, all expressions must have their proper
560 -- type, and semantic links should be set between tree nodes (partial to
561 -- full view, etc.). Some kinds of nodes should be either absent, or can be
562 -- ignored by the formal verification backend:
564 -- N_Object_Renaming_Declaration: can be ignored safely
565 -- N_Expression_Function: absent (rewritten)
566 -- N_Expression_With_Actions: absent (not generated)
568 -- SPARK cross-references are generated from the regular cross-references
569 -- (used for browsing and code understanding) and additional references
570 -- collected during semantic analysis, in particular on all dereferences.
571 -- These SPARK cross-references are output in a separate section of ALI
572 -- files, as described in spark_xrefs.adb. They are the basis for the
573 -- computation of data dependences in GNATprove. This implies that all
574 -- cross-references should be generated in this mode, even those that would
575 -- not make sense from a user point-of-view, and that cross-references that
576 -- do not lead to data dependences for subprograms can be safely ignored.
578 -- GNATprove relies on the following front end behaviors:
580 -- 1. The first declarations in the list of visible declarations of
581 -- a package declaration for a generic instance, up to the first
582 -- declaration which comes from source, should correspond to
583 -- the "mappings nodes" between formal and actual generic parameters.
585 -- 2. In addition pragma Debug statements are removed from the tree
586 -- (rewritten to NULL stmt), since they should be ignored in formal
587 -- verification.
589 -- 3. An error is also issued for missing subunits, similar to the
590 -- warning issued when generating code, to avoid formal verification
591 -- of a partial unit.
593 -- 4. Unconstrained types are not replaced by constrained types whose
594 -- bounds are generated from an expression: Expand_Subtype_From_Expr
595 -- should be a no-op.
597 -- 5. Errors (instead of warnings) are issued on compile-time-known
598 -- constraint errors even though such cases do not correspond to
599 -- illegalities in the Ada RM (this is simply another case where
600 -- GNATprove implements a subset of the full language).
602 -- However, there are a few exceptions to this rule for cases where
603 -- we want to allow the GNATprove analysis to proceed (e.g. range
604 -- checks on empty ranges, which typically appear in deactivated
605 -- code in a particular configuration).
607 -- 6. Subtypes should match in the AST, even after a generic is
608 -- instantiated. In particular, GNATprove relies on the fact that,
609 -- on a selected component, the type of the selected component is
610 -- the type of the corresponding component in the prefix of the
611 -- selected component.
613 -- Note that, in some cases, we know that this rule is broken by the
614 -- frontend. In particular, if the selected component is a packed
615 -- array depending on a discriminant of a unconstrained formal object
616 -- parameter of a generic.
618 ----------------
619 -- SPARK Mode --
620 ----------------
622 -- The SPARK RM 1.6.5 defines a mode of operation called "SPARK mode" which
623 -- starts a scope where the SPARK language semantics are either On, Off, or
624 -- Auto, where Auto leaves the choice to the tools. A SPARK mode may be
625 -- specified by means of an aspect or a pragma.
627 -- The following entities may be subject to a SPARK mode. Entities marked
628 -- with * may possess two different SPARK modes.
630 -- E_Entry
631 -- E_Entry_Family
632 -- E_Function
633 -- E_Generic_Function
634 -- E_Generic_Package *
635 -- E_Generic_Procedure
636 -- E_Operator
637 -- E_Package *
638 -- E_Package_Body *
639 -- E_Procedure
640 -- E_Protected_Body
641 -- E_Protected_Subtype
642 -- E_Protected_Type *
643 -- E_Subprogram_Body
644 -- E_Task_Body
645 -- E_Task_Subtype
646 -- E_Task_Type *
647 -- E_Variable
649 -- In order to manage SPARK scopes, the compiler relies on global variables
650 -- SPARK_Mode and SPARK_Mode_Pragma and a mechanism called "SPARK regions."
651 -- Routines Install_SPARK_Mode and Set_SPARK_Mode create a new SPARK region
652 -- and routine Restore_SPARK_Mode ends a SPARK region. A region may be
653 -- reinstalled similarly to scopes.
655 -----------------------
656 -- Check Flag Fields --
657 -----------------------
659 -- The following flag fields appear in expression nodes:
661 -- Do_Division_Check
662 -- Do_Overflow_Check
663 -- Do_Range_Check
665 -- These three flags are always set by the front end during semantic
666 -- analysis, on expression nodes that may trigger the corresponding
667 -- check. The front end then inserts or not the check during expansion. In
668 -- particular, these flags should also be correctly set in GNATprove mode.
669 -- As a special case, the front end does not insert a Do_Division_Check
670 -- flag on float exponentiation expressions, for the case where the value
671 -- is 0.0 and the exponent is negative, although this case does lead to a
672 -- division check failure. As another special case, the front end does not
673 -- insert a Do_Range_Check on an allocator where the designated type is
674 -- scalar, and the designated type is more constrained than the type of the
675 -- initialized allocator value or the type of the default value for an
676 -- uninitialized allocator.
678 -- Note that the expander always takes care of the Do_Range_Check case, so
679 -- this flag will never be set in the expanded tree passed to the back end.
680 -- For the other two flags, the check can be generated either by the back
681 -- end or by the front end, depending on the setting of a target parameter.
683 -- Note that this accounts for all nodes that trigger the corresponding
684 -- checks, except for range checks on subtype_indications, which may be
685 -- required to check that a range_constraint is compatible with the given
686 -- subtype (RM 3.2.2(11)).
688 -- The following flag fields appear in various nodes:
690 -- Do_Discriminant_Check
691 -- Do_Length_Check
692 -- Do_Storage_Check
694 -- These flags are used in some specific cases by the front end, either
695 -- during semantic analysis or during expansion, and cannot be expected
696 -- to be set on all nodes that trigger the corresponding check.
698 ------------------------
699 -- Common Flag Fields --
700 ------------------------
702 -- The following flag fields appear in all nodes:
704 -- Analyzed
705 -- This flag is used to indicate that a node (and all its children) have
706 -- been analyzed. It is used to avoid reanalysis of a node that has
707 -- already been analyzed, both for efficiency and functional correctness
708 -- reasons.
710 -- Comes_From_Source
711 -- This flag is set if the node comes directly from an explicit construct
712 -- in the source. It is normally on for any nodes built by the scanner or
713 -- parser from the source program, with the exception that in a few cases
714 -- the parser adds nodes to normalize the representation (in particular,
715 -- a null statement is added to a package body if there is no begin/end
716 -- initialization section).
718 -- Most nodes inserted by the analyzer or expander are not considered
719 -- as coming from source, so the flag is off for such nodes. In a few
720 -- cases, the expander constructs nodes closely equivalent to nodes
721 -- from the source program (e.g. the allocator built for build-in-place
722 -- case), and the Comes_From_Source flag is deliberately set.
724 -- Error_Posted
725 -- This flag is used to avoid multiple error messages being posted on or
726 -- referring to the same node. This flag is set if an error message
727 -- refers to a node or is posted on its source location, and has the
728 -- effect of inhibiting further messages involving this same node.
730 -----------------------
731 -- Modify_Tree_For_C --
732 -----------------------
734 -- If the flag Opt.Modify_Tree_For_C is set True, then the tree is modified
735 -- in ways that help match the semantics better with C, easing the task of
736 -- interfacing to C code generators (other than GCC, where the work is done
737 -- in gigi, and there is no point in changing that), and also making life
738 -- easier for Cprint in generating C source code.
740 -- The current modifications implemented are as follows:
742 -- N_Op_Rotate_Left, N_Op_Rotate_Right, N_Shift_Right_Arithmetic nodes
743 -- are eliminated from the tree (since these operations do not exist in
744 -- C), and the operations are rewritten in terms of logical shifts and
745 -- other logical operations that do exist in C. See Exp_Ch4 expansion
746 -- routines for these operators for details of the transformations made.
748 -- The right operand of N_Op_Shift_Right and N_Op_Shift_Left is always
749 -- less than the word size (since other values are not well-defined in
750 -- C). This is done using an explicit test if necessary.
752 -- Min and Max attributes are expanded into equivalent if expressions,
753 -- dealing properly with side effect issues.
755 -- Mod for signed integer types is expanded into equivalent expressions
756 -- using Rem (which is % in C) and other C-available operators.
758 -- Functions returning bounded arrays are transformed into procedures
759 -- with an extra out parameter, and the calls updated accordingly.
761 -- Aggregates are only kept unexpanded for object declarations, otherwise
762 -- they are systematically expanded into loops (for arrays) and
763 -- individual assignments (for records).
765 -- Unconstrained array types are handled by means of fat pointers.
767 -- Postconditions are inlined by the frontend since their body may have
768 -- references to itypes defined in the enclosing subprogram.
770 ------------------------------------
771 -- Description of Semantic Fields --
772 ------------------------------------
774 -- The meaning of the syntactic fields is generally clear from their names
775 -- without any further description, since the names are chosen to
776 -- correspond very closely to the syntax in the reference manual. This
777 -- section describes the usage of the semantic fields, which are used to
778 -- contain additional information determined during semantic analysis.
780 -- Accept_Handler_Records
781 -- This field is present only in an N_Accept_Alternative node. It is used
782 -- to temporarily hold the exception handler records from an accept
783 -- statement in a selective accept. These exception handlers will
784 -- eventually be placed in the Handler_Records list of the procedure
785 -- built for this accept (see Expand_N_Selective_Accept procedure in
786 -- Exp_Ch9 for further details).
788 -- Access_Types_To_Process
789 -- Present in N_Freeze_Entity nodes for Incomplete or private types.
790 -- Contains the list of access types which may require specific treatment
791 -- when the nature of the type completion is completely known. An example
792 -- of such treatment is the generation of the associated_final_chain.
794 -- Actions
795 -- This field contains a sequence of actions that are associated with the
796 -- node holding the field. See the individual node types for details of
797 -- how this field is used, as well as the description of the specific use
798 -- for a particular node type.
800 -- Activation_Chain_Entity
801 -- This is used in tree nodes representing task activators (blocks,
802 -- subprogram bodies, package declarations, and task bodies). It is
803 -- initially Empty, and then gets set to point to the entity for the
804 -- declared Activation_Chain variable when the first task is declared.
805 -- When tasks are declared in the corresponding declarative region this
806 -- entity is located by name (its name is always _Chain) and the declared
807 -- tasks are added to the chain. Note that N_Extended_Return_Statement
808 -- does not have this attribute, although it does have an activation
809 -- chain. This chain is used to store the tasks temporarily, and is not
810 -- used for activating them. On successful completion of the return
811 -- statement, the tasks are moved to the caller's chain, and the caller
812 -- activates them.
814 -- Acts_As_Spec
815 -- A flag set in the N_Subprogram_Body node for a subprogram body which
816 -- is acting as its own spec. In the case of a library-level subprogram
817 -- the flag is set as well on the parent compilation unit node.
819 -- Actual_Designated_Subtype
820 -- Present in N_Free_Statement and N_Explicit_Dereference nodes. If gigi
821 -- needs to know the dynamic constrained subtype of the designated
822 -- object, this attribute is set to that subtype. This is done for
823 -- N_Free_Statements for access-to-classwide types and access-to-
824 -- unconstrained packed array types. For N_Explicit_Dereference,
825 -- this is done in two circumstances: 1) when the designated type is
826 -- an unconstrained packed array and the dereference is the prefix of
827 -- a 'Size attribute reference, or 2) when the dereference node is
828 -- created for the expansion of an allocator with a subtype_indication
829 -- and the designated subtype is an unconstrained composite type.
831 -- Address_Warning_Posted
832 -- Present in N_Attribute_Definition nodes. Set to indicate that we have
833 -- posted a warning for the address clause regarding size or alignment
834 -- issues. Used to inhibit multiple redundant messages.
836 -- Aggregate_Bounds
837 -- Present in array N_Aggregate nodes. If the bounds of the aggregate are
838 -- known at compile time, this field points to an N_Range node with those
839 -- bounds. Otherwise Empty.
841 -- All_Others
842 -- Present in an N_Others_Choice node. This flag is set for an others
843 -- exception where all exceptions are to be caught, even those that are
844 -- not normally handled (in particular the tasking abort signal). This
845 -- is used for translation of the at end handler into a normal exception
846 -- handler.
848 -- Ancestor_Type
849 -- Present in record N_Aggregate nodes. Used to store the first global
850 -- ancestor of the type of the aggregate in a generic context, if any,
851 -- when the type is a derived tagged type. Otherwise Empty.
853 -- Aspect_On_Partial_View
854 -- Present on an N_Aspect_Specification node. For an aspect that applies
855 -- to a type entity, indicates whether the specification appears on the
856 -- partial view of a private type or extension. Undefined for aspects
857 -- that apply to other entities.
859 -- Aspect_Rep_Item
860 -- Present in N_Aspect_Specification nodes. Points to the corresponding
861 -- pragma/attribute definition node used to process the aspect.
863 -- Assignment_OK
864 -- This flag is set in a subexpression node for an object, indicating
865 -- that the associated object can be modified, even if this would not
866 -- normally be permissible (either by direct assignment, or by being
867 -- passed as an out or in-out parameter). This is used by the expander
868 -- for a number of purposes, including initialization of constants and
869 -- limited type objects (such as tasks), setting discriminant fields,
870 -- setting tag values, etc. N_Object_Declaration nodes also have this
871 -- flag defined. Here it is used to indicate that an initialization
872 -- expression is valid, even where it would normally not be allowed
873 -- (e.g. where the type involved is limited). It is also used to stop
874 -- a Force_Evaluation call for an unchecked conversion, but this usage
875 -- is unclear and not documented ???
877 -- Associated_Node
878 -- Present in nodes that can denote an entity: identifiers, character
879 -- literals, operator symbols, expanded names, operator nodes, and
880 -- attribute reference nodes (all these nodes have an Entity field).
881 -- This field is also present in N_Aggregate, N_Selected_Component, and
882 -- N_Extension_Aggregate nodes. This field is used in generic processing
883 -- to create links between the generic template and the generic copy.
884 -- See Sem_Ch12.Get_Associated_Node for full details. Note that this
885 -- field overlaps Entity, which is fine, since, as explained in Sem_Ch12,
886 -- the normal function of Entity is not required at the point where the
887 -- Associated_Node is set. Note also, that in generic templates, this
888 -- means that the Entity field does not necessarily point to an Entity.
889 -- Since the back end is expected to ignore generic templates, this is
890 -- harmless.
892 -- Atomic_Sync_Required
893 -- This flag is set on a node for which atomic synchronization is
894 -- required for the corresponding reference or modification.
896 -- At_End_Proc
897 -- This field is present in N_Handled_Sequence_Of_Statements,
898 -- N_Package_Body, N_Subprogram_Body, N_Task_Body, N_Block_Statement,
899 -- and N_Entry_Body.
900 -- It contains an identifier reference for the cleanup procedure to be
901 -- called. See description of N_Handled_Sequence_Of_Statements node
902 -- for further details.
904 -- Backwards_OK
905 -- A flag present in the N_Assignment_Statement node. It is used only
906 -- if the type being assigned is an array type, and is set if analysis
907 -- determines that it is definitely safe to do the copy backwards, i.e.
908 -- starting at the highest addressed element. This is the case if either
909 -- the operands do not overlap, or they may overlap, but if they do,
910 -- then the left operand is at a higher address than the right operand.
912 -- Note: If neither of the flags Forwards_OK or Backwards_OK is set, it
913 -- means that the front end could not determine that either direction is
914 -- definitely safe, and a runtime check may be required if the backend
915 -- cannot figure it out. If both flags Forwards_OK and Backwards_OK are
916 -- set, it means that the front end can assure no overlap of operands.
918 -- Body_To_Inline
919 -- Present in subprogram declarations. Denotes analyzed but unexpanded
920 -- body of subprogram, to be used when inlining calls. Present when the
921 -- subprogram has an Inline pragma and inlining is enabled. If the
922 -- declaration is completed by a renaming_as_body, and the renamed entity
923 -- is a subprogram, the Body_To_Inline is the name of that entity, which
924 -- is used directly in later calls to the original subprogram.
926 -- Body_Required
927 -- A flag that appears in the N_Compilation_Unit node indicating that
928 -- the corresponding unit requires a body. For the package case, this
929 -- indicates that a completion is required. In Ada 95, if the flag is not
930 -- set for the package case, then a body may not be present. In Ada 83,
931 -- if the flag is not set for the package case, then body is optional.
932 -- For a subprogram declaration, the flag is set except in the case where
933 -- a pragma Import or Interface applies, in which case no body is
934 -- permitted (in Ada 83 or Ada 95).
936 -- Cannot_Be_Superflat
937 -- This flag is present in N_Range nodes. It is set if the range is of a
938 -- discrete type and cannot be superflat, i.e. it is guaranteed that the
939 -- inequality High_Bound >= Low_Bound - 1 is true. At the time of this
940 -- writing, it is only used by the code generator to streamline things.
942 -- Cleanup_Actions
943 -- Present in block statements created for transient blocks, contains
944 -- additional cleanup actions carried over from the transient scope.
946 -- Check_Address_Alignment
947 -- A flag present in N_Attribute_Definition clause for a 'Address
948 -- attribute definition. This flag is set if a dynamic check should be
949 -- generated at the freeze point for the entity to which this address
950 -- clause applies. The reason that we need this flag is that we want to
951 -- check for range checks being suppressed at the point where the
952 -- attribute definition clause is given, rather than testing this at the
953 -- freeze point.
955 -- Comes_From_Check_Or_Contract
956 -- This flag is present in all N_If_Statement nodes and
957 -- gets set when an N_If_Statement is generated as part of
958 -- the expansion of a Check, Assert, or contract-related
959 -- pragma.
961 -- Comes_From_Extended_Return_Statement
962 -- Present in N_Simple_Return_Statement nodes. True if this node was
963 -- constructed as part of the N_Extended_Return_Statement expansion.
965 -- Comes_From_Iterator
966 -- Present in N_Object_Renaming_Declaration nodes. True if this node was
967 -- was constructed as part of the expansion of an iterator
968 -- specification.
970 -- Compare_Type
971 -- Present in N_Op_Compare nodes. Set during resolution to the type of
972 -- the operands. It is used to propagate the type of the operands from
973 -- a N_Op_Compare node in a generic construct to the nodes created from
974 -- it in the various instances, when this type is global to the generic
975 -- construct. Resolution for global types cannot be redone in instances
976 -- because the instantiation can be done out of context, e.g. for bodies,
977 -- and the visibility of global types is incorrect in this case; that is
978 -- why the result of the resolution done in the generic construct needs
979 -- to be available in the instances but, unlike for arithmetic operators,
980 -- the Etype cannot be used to that effect for comparison operators. It
981 -- is also used as the type subject to the Has_Private_View processing on
982 -- the nodes instead of the Etype.
984 -- Compile_Time_Known_Aggregate
985 -- Present in N_Aggregate nodes. Set for aggregates which can be fully
986 -- evaluated at compile time without raising constraint error. Such
987 -- aggregates can be passed as is to the back end without any expansion.
988 -- See Exp_Aggr for specific conditions under which this flag gets set.
990 -- Componentwise_Assignment
991 -- Present in N_Assignment_Statement nodes. Set for a record assignment
992 -- where all that needs doing is to expand it into component-by-component
993 -- assignments. This is used internally for the case of tagged types with
994 -- rep clauses, where we need to avoid recursion (we don't want to try to
995 -- generate a call to the primitive operation, because this is the case
996 -- where we are compiling the primitive operation). Note that when we are
997 -- expanding component assignments in this case, we never assign the _tag
998 -- field, but we recursively assign components of the parent type.
1000 -- Condition_Actions
1001 -- This field appears in else-if nodes and in the iteration scheme node
1002 -- for while loops. This field is only used during semantic processing to
1003 -- temporarily hold actions inserted into the tree. In the tree passed
1004 -- to gigi, the condition actions field is always set to No_List. For
1005 -- details on how this field is used, see the routine Insert_Actions in
1006 -- package Exp_Util, and also the expansion routines for the relevant
1007 -- nodes.
1009 -- Context_Pending
1010 -- This field appears in Compilation_Unit nodes, to indicate that the
1011 -- context of the unit is being compiled. Used to detect circularities
1012 -- that are not otherwise detected by the loading mechanism. Such
1013 -- circularities can occur in the presence of limited and non-limited
1014 -- with_clauses that mention the same units.
1016 -- Controlling_Argument
1017 -- This field is set in procedure and function call nodes if the call
1018 -- is a dispatching call (it is Empty for a non-dispatching call). It
1019 -- indicates the source of the call's controlling tag. For procedure
1020 -- calls, the Controlling_Argument is one of the actuals. For function
1021 -- that has a dispatching result, it is an entity in the context of the
1022 -- call that can provide a tag, or else it is the tag of the root type
1023 -- of the class. It can also specify a tag directly rather than being a
1024 -- tagged object. The latter is needed by the implementations of AI-239
1025 -- and AI-260.
1027 -- Conversion_OK
1028 -- A flag set on type conversion nodes to indicate that the conversion
1029 -- is to be considered as being valid, even though it is the case that
1030 -- the conversion is not valid Ada. This is used for attributes Enum_Rep,
1031 -- Pos, Val, Fixed_Value and Integer_Value, for internal conversions done
1032 -- for fixed-point operations, and for certain conversions for calls to
1033 -- initialization procedures. If Conversion_OK is set, then Etype must be
1034 -- set (the analyzer assumes that Etype has been set). For the case of
1035 -- fixed-point operands, it also indicates that the conversion is to be
1036 -- direct conversion of the underlying integer result, with no regard to
1037 -- the small operand.
1039 -- Corresponding_Aspect
1040 -- Present in N_Pragma node. Used to point back to the source aspect from
1041 -- the corresponding pragma. This field is Empty for source pragmas.
1043 -- Corresponding_Body
1044 -- This field is set in subprogram declarations, package declarations,
1045 -- entry declarations of protected types, and in generic units. It points
1046 -- to the defining entity for the corresponding body (NOT the node for
1047 -- the body itself).
1049 -- Corresponding_Entry_Body
1050 -- Defined in N_Subprogram_Body. Set for subprogram bodies that implement
1051 -- a protected type entry; points to the body for the entry.
1053 -- Corresponding_Formal_Spec
1054 -- This field is set in subprogram renaming declarations, where it points
1055 -- to the defining entity for a formal subprogram in the case where the
1056 -- renaming corresponds to a generic formal subprogram association in an
1057 -- instantiation. The field is Empty if the renaming does not correspond
1058 -- to such a formal association.
1060 -- Corresponding_Generic_Association
1061 -- This field is defined for object declarations and object renaming
1062 -- declarations. It is set for the declarations within an instance that
1063 -- map generic formals to their actuals. If set, the field points either
1064 -- to a copy of a default expression for an actual of mode IN or to a
1065 -- generic_association which is the original parent of the expression or
1066 -- name appearing in the declaration. This simplifies GNATprove queries.
1068 -- Corresponding_Integer_Value
1069 -- This field is set in real literals of fixed-point types (it is not
1070 -- used for floating-point types). It contains the integer value used
1071 -- to represent the fixed-point value. It is also set on the universal
1072 -- real literals used to represent bounds of fixed-point base types
1073 -- and their first named subtypes.
1075 -- Corresponding_Spec
1076 -- This field is set in subprogram, package, task, entry and protected
1077 -- body nodes where it points to the defining entity in the corresponding
1078 -- spec. The attribute is also set in N_With_Clause nodes where it points
1079 -- to the defining entity for the with'ed spec, and in a subprogram
1080 -- renaming declaration when it is a Renaming_As_Body. The field is Empty
1081 -- if there is no corresponding spec, as in the case of a subprogram body
1082 -- that serves as its own spec.
1084 -- In Ada 2012, Corresponding_Spec is set on expression functions that
1085 -- complete a subprogram declaration.
1087 -- Corresponding_Spec_Of_Stub
1088 -- This field is present in subprogram, package, task, and protected body
1089 -- stubs where it points to the corresponding spec of the stub. Due to
1090 -- clashes in the structure of nodes, we cannot use Corresponding_Spec.
1092 -- Corresponding_Stub
1093 -- This field is present in an N_Subunit node. It holds the node in
1094 -- the parent unit that is the stub declaration for the subunit. It is
1095 -- set when analysis of the stub forces loading of the proper body. If
1096 -- expansion of the proper body creates new declarative nodes, they are
1097 -- inserted at the point of the corresponding_stub.
1099 -- Dcheck_Function
1100 -- This field is present in an N_Variant node, It references the entity
1101 -- for the discriminant checking function for the variant.
1103 -- Default_Expression
1104 -- This field is Empty if there is no default expression. If there is a
1105 -- simple default expression (one with no side effects), then this field
1106 -- simply contains a copy of the Expression field (both point to the tree
1107 -- for the default expression). Default_Expression is used for
1108 -- conformance checking.
1110 -- Default_Storage_Pool
1111 -- This field is present in N_Compilation_Unit_Aux nodes. It is set to a
1112 -- copy of Opt.Default_Pool at the end of the compilation unit. See
1113 -- package Opt for details. This is used for inheriting the
1114 -- Default_Storage_Pool in child units.
1116 -- Discr_Check_Funcs_Built
1117 -- This flag is present in N_Full_Type_Declaration nodes. It is set when
1118 -- discriminant checking functions are constructed. The purpose is to
1119 -- avoid attempting to set these functions more than once.
1121 -- Do_Discriminant_Check
1122 -- This flag is set on N_Selected_Component nodes to indicate that a
1123 -- discriminant check is required using the discriminant check routine
1124 -- associated with the selector. The actual check is generated by the
1125 -- expander when processing selected components. In the case of
1126 -- Unchecked_Union, the flag is also set, but no discriminant check
1127 -- routine is associated with the selector, and the expander does not
1128 -- generate a check. This flag is also present in assignment statements
1129 -- (and set if the assignment requires a discriminant check), and in type
1130 -- conversion nodes (and set if the conversion requires a check).
1132 -- Do_Division_Check
1133 -- This flag is set on a division operator (/ mod rem) to indicate that
1134 -- a zero divide check is required. The actual check is either dealt with
1135 -- by the back end if Backend_Divide_Checks is set to true, or by the
1136 -- front end itself if it is set to false.
1138 -- Do_Length_Check
1139 -- This flag is set in an N_Assignment_Statement, N_Op_And, N_Op_Or,
1140 -- N_Op_Xor, or N_Type_Conversion node to indicate that a length check
1141 -- is required. It is not determined who deals with this flag (???).
1143 -- Do_Overflow_Check
1144 -- This flag is set on an operator where an overflow check is required on
1145 -- the operation. The actual check is either dealt with by the back end
1146 -- if Backend_Overflow_Checks is set to true, or by the front end itself
1147 -- if it is set to false. The other cases where this flag is used is on a
1148 -- Type_Conversion node as well on if and case expression nodes.
1149 -- For a type conversion, it means that the conversion is from one base
1150 -- type to another, and the value may not fit in the target base type.
1151 -- See also the description of Do_Range_Check for this case. This flag is
1152 -- also set on if and case expression nodes if we are operating in either
1153 -- MINIMIZED or ELIMINATED overflow checking mode (to make sure that we
1154 -- properly process overflow checking for dependent expressions).
1156 -- Do_Range_Check
1157 -- This flag is set on an expression which appears in a context where a
1158 -- range check is required. The target type is clear from the context.
1159 -- The contexts in which this flag can appear are the following:
1161 -- Right side of an assignment. In this case the target type is taken
1162 -- from the left side of the assignment, which is referenced by the
1163 -- Name of the N_Assignment_Statement node.
1165 -- Subscript expressions in an indexed component. In this case the
1166 -- target type is determined from the type of the array, which is
1167 -- referenced by the Prefix of the N_Indexed_Component node.
1169 -- Argument expression for a parameter, appearing either directly in
1170 -- the Parameter_Associations list of a call or as the Expression of an
1171 -- N_Parameter_Association node that appears in this list. In either
1172 -- case, the check is against the type of the formal. Note that the
1173 -- flag is relevant only in IN and IN OUT parameters, and will be
1174 -- ignored for OUT parameters, where no check is required in the call,
1175 -- and if a check is required on the return, it is generated explicitly
1176 -- with a type conversion.
1178 -- Initialization expression for the initial value in an object
1179 -- declaration. In this case the Do_Range_Check flag is set on
1180 -- the initialization expression, and the check is against the
1181 -- range of the type of the object being declared. This includes the
1182 -- cases of expressions providing default discriminant values, and
1183 -- expressions used to initialize record components.
1185 -- The expression of a type conversion. In this case the range check is
1186 -- against the target type of the conversion. See also the use of
1187 -- Do_Overflow_Check on a type conversion. The distinction is that the
1188 -- overflow check protects against a value that is outside the range of
1189 -- the target base type, whereas a range check checks that the
1190 -- resulting value (which is a value of the base type of the target
1191 -- type), satisfies the range constraint of the target type.
1193 -- Note: when a range check is required in contexts other than those
1194 -- listed above (e.g. in a return statement), an additional type
1195 -- conversion node is introduced to represent the required check.
1197 -- Do_Storage_Check
1198 -- This flag is set in an N_Allocator node to indicate that a storage
1199 -- check is required for the allocation, or in an N_Subprogram_Body node
1200 -- to indicate that a stack check is required in the subprogram prologue.
1201 -- The N_Allocator case is handled by the routine that expands the call
1202 -- to the runtime routine. The N_Subprogram_Body case is handled by the
1203 -- backend, and all the semantics does is set the flag.
1205 -- Elaborate_Present
1206 -- This flag is set in the N_With_Clause node to indicate that pragma
1207 -- Elaborate pragma appears for the with'ed units.
1209 -- Elaborate_All_Desirable
1210 -- This flag is set in the N_With_Clause mode to indicate that the static
1211 -- elaboration processing has determined that an Elaborate_All pragma is
1212 -- desirable for correct elaboration for this unit.
1214 -- Elaborate_All_Present
1215 -- This flag is set in the N_With_Clause node to indicate that a
1216 -- pragma Elaborate_All pragma appears for the with'ed units.
1218 -- Elaborate_Desirable
1219 -- This flag is set in the N_With_Clause mode to indicate that the static
1220 -- elaboration processing has determined that an Elaborate pragma is
1221 -- desirable for correct elaboration for this unit.
1223 -- Else_Actions
1224 -- This field is present in if expression nodes. During code
1225 -- expansion we use the Insert_Actions procedure (in Exp_Util) to insert
1226 -- actions at an appropriate place in the tree to get elaborated at the
1227 -- right time. For if expressions, we have to be sure that the actions
1228 -- for the Else branch are only elaborated if the condition is False.
1229 -- The Else_Actions field is used as a temporary parking place for
1230 -- these actions. The final tree is always rewritten to eliminate the
1231 -- need for this field, so in the tree passed to Gigi, this field is
1232 -- always set to No_List.
1234 -- Enclosing_Variant
1235 -- This field is present in the N_Variant node and identifies the Node_Id
1236 -- corresponding to the immediately enclosing variant when the variant is
1237 -- nested, and N_Empty otherwise. Set during semantic processing of the
1238 -- variant part of a record type.
1240 -- Entity
1241 -- Appears in all direct names (identifiers, character literals, and
1242 -- operator symbols), as well as expanded names, and attributes that
1243 -- denote entities, such as 'Class. Points to entity for corresponding
1244 -- defining occurrence. Set after name resolution. For identifiers in a
1245 -- WITH list, the corresponding defining occurrence is in a separately
1246 -- compiled file, and Entity must be set by the library Load procedure.
1248 -- Note: During name resolution, the value in Entity may be temporarily
1249 -- incorrect (e.g. during overload resolution, Entity is initially set to
1250 -- the first possible correct interpretation, and then later modified if
1251 -- necessary to contain the correct value after resolution).
1253 -- Note: This field overlaps Associated_Node, which is used during
1254 -- generic processing (see Sem_Ch12 for details). Note also that in
1255 -- generic templates, this means that the Entity field does not always
1256 -- point to an Entity. Since the back end is expected to ignore generic
1257 -- templates, this is harmless.
1259 -- Note: This field also appears in N_Attribute_Definition_Clause nodes.
1260 -- It is used only for stream attributes definition clauses. In this
1261 -- case, it denotes a (possibly dummy) subprogram entity that is declared
1262 -- conceptually at the point of the clause. Thus the visibility of the
1263 -- attribute definition clause (in the sense of 8.3(23) as amended by
1264 -- AI-195) can be checked by testing the visibility of that subprogram.
1266 -- Note: Normally the Entity field of an identifier points to the entity
1267 -- for the corresponding defining identifier, and hence the Chars field
1268 -- of an identifier will match the Chars field of the entity. However,
1269 -- there is no requirement that these match, and there are obscure cases
1270 -- of generated code where they do not match.
1272 -- Note: Ada 2012 aspect specifications require additional links between
1273 -- identifiers and various attributes. These attributes can be of
1274 -- arbitrary types, and the entity field of identifiers that denote
1275 -- aspects must be used to store arbitrary expressions for later semantic
1276 -- checks. See section on aspect specifications for details.
1278 -- Entity_Or_Associated_Node
1279 -- A synonym for both Entity and Associated_Node. Used by convention in
1280 -- the code when referencing this field in cases where it is not known
1281 -- whether the field contains an Entity or an Associated_Node.
1283 -- Etype
1284 -- Appears in all expression nodes, all direct names, and all entities.
1285 -- Points to the entity for the related type. Set after type resolution.
1286 -- Normally this is the actual subtype of the expression. However, in
1287 -- certain contexts such as the right side of an assignment, subscripts,
1288 -- arguments to calls, returned value in a function, initial value etc.
1289 -- it is the desired target type. In the event that this is different
1290 -- from the actual type, the Do_Range_Check flag will be set if a range
1291 -- check is required. Note: if the Is_Overloaded flag is set, then Etype
1292 -- points to an essentially arbitrary choice from the possible set of
1293 -- types.
1295 -- Exception_Junk
1296 -- This flag is set in a various nodes appearing in a statement sequence
1297 -- to indicate that the corresponding node is an artifact of the
1298 -- generated code for exception handling, and should be ignored when
1299 -- analyzing the control flow of the relevant sequence of statements
1300 -- (e.g. to check that it does not end with a bad return statement).
1302 -- Exception_Label
1303 -- Appears in N_Push_xxx_Label nodes. Points to the entity of the label
1304 -- to be used for transforming the corresponding exception into a goto,
1305 -- or contains Empty, if this exception is not to be transformed. Also
1306 -- appears in N_Exception_Handler nodes, where, if set, it indicates
1307 -- that there may be a local raise for the handler, so that expansion
1308 -- to allow a goto is required (and this field contains the label for
1309 -- this goto). See Exp_Ch11.Expand_Local_Exception_Handlers for details.
1311 -- Expansion_Delayed
1312 -- Set on aggregates and extension aggregates that need a top-down rather
1313 -- than bottom-up expansion. Typically aggregate expansion happens bottom
1314 -- up. For nested aggregates the expansion is delayed until the enclosing
1315 -- aggregate itself is expanded, e.g. in the context of a declaration. To
1316 -- delay it we set this flag. This is done to avoid creating a temporary
1317 -- for each level of a nested aggregate, and also to prevent the
1318 -- premature generation of constraint checks. This is also a requirement
1319 -- if we want to generate the proper attachment to the internal
1320 -- finalization lists (for record with controlled components). Top down
1321 -- expansion of aggregates is also used for in-place array aggregate
1322 -- assignment or initialization. When the full context is known, the
1323 -- target of the assignment or initialization is used to generate the
1324 -- left-hand side of individual assignment to each subcomponent.
1325 -- Also set on conditional expressions whose dependent expressions are
1326 -- nested aggregates, in order to avoid creating a temporary for them.
1328 -- Expression_Copy
1329 -- Present in N_Pragma_Argument_Association nodes. Contains a copy of the
1330 -- original expression. This field is best used to store pragma-dependent
1331 -- modifications performed on the original expression such as replacement
1332 -- of the current type instance or substitutions of primitives.
1334 -- First_Inlined_Subprogram
1335 -- Present in the N_Compilation_Unit node for the main program. Points
1336 -- to a chain of entities for subprograms that are to be inlined. The
1337 -- Next_Inlined_Subprogram field of these entities is used as a link
1338 -- pointer with Empty marking the end of the list. This field is Empty
1339 -- if there are no inlined subprograms or inlining is not active.
1341 -- First_Named_Actual
1342 -- Present in procedure call statement and function call nodes, and also
1343 -- in Intrinsic nodes. Set during semantic analysis to point to the first
1344 -- named parameter where parameters are ordered by declaration order (as
1345 -- opposed to the actual order in the call which may be different due to
1346 -- named associations). Note: this field points to the explicit actual
1347 -- parameter itself, not the N_Parameter_Association node (its parent).
1349 -- First_Subtype_Link
1350 -- Present in N_Freeze_Entity node for an anonymous base type that is
1351 -- implicitly created by the declaration of a first subtype. It points
1352 -- to the entity for the first subtype.
1354 -- Float_Truncate
1355 -- A flag present in type conversion nodes. It is used for floating-point
1356 -- to fixed-point or integer conversions, where truncation is required
1357 -- rather than rounding.
1359 -- Forwards_OK
1360 -- A flag present in the N_Assignment_Statement node. It is used only
1361 -- if the type being assigned is an array type, and is set if analysis
1362 -- determines that it is definitely safe to do the copy forwards, i.e.
1363 -- starting at the lowest addressed element. This is the case if either
1364 -- the operands do not overlap, or they may overlap, but if they do,
1365 -- then the left operand is at a lower address than the right operand.
1367 -- Note: If neither of the flags Forwards_OK or Backwards_OK is set, it
1368 -- means that the front end could not determine that either direction is
1369 -- definitely safe, and a runtime check may be required if the backend
1370 -- cannot figure it out. If both flags Forwards_OK and Backwards_OK are
1371 -- set, it means that the front end can assure no overlap of operands.
1373 -- For_Special_Return_Object
1374 -- Present in N_Allocator nodes. True if the allocator is generated for
1375 -- the initialization of a special return object.
1377 -- From_Aspect_Specification
1378 -- Processing of aspect specifications typically results in insertion in
1379 -- the tree of corresponding pragma or attribute definition clause nodes.
1380 -- These generated nodes have the From_Aspect_Specification flag set to
1381 -- indicate that they came from aspect specifications originally.
1383 -- From_At_Mod
1384 -- This flag is set on the attribute definition clause node that is
1385 -- generated by a transformation of an at mod phrase in a record
1386 -- representation clause. This is used to give slightly different (Ada 83
1387 -- compatible) semantics to such a clause, namely it is used to specify a
1388 -- minimum acceptable alignment for the base type and all subtypes. In
1389 -- Ada 95 terms, the actual alignment of the base type and all subtypes
1390 -- must be a multiple of the given value, and the representation clause
1391 -- is considered to be type specific instead of subtype specific.
1393 -- From_Conditional_Expression
1394 -- This flag is set on if and case statements generated by the expansion
1395 -- of if and case expressions respectively. The flag is used to suppress
1396 -- any finalization of controlled objects found within these statements.
1398 -- From_Default
1399 -- This flag is set on the subprogram renaming declaration created in an
1400 -- instance for a formal subprogram, when the formal is declared with a
1401 -- box, and there is no explicit actual. If the flag is present, the
1402 -- declaration is treated as an implicit reference to the formal in the
1403 -- ali file.
1405 -- Generalized_Indexing
1406 -- Present in N_Indexed_Component nodes. Set for Indexed_Component nodes
1407 -- that are Ada 2012 container indexing operations. The value of the
1408 -- attribute is a function call (possibly dereferenced) that corresponds
1409 -- to the proper expansion of the source indexing operation. Before
1410 -- expansion, the source node is rewritten as the resolved generalized
1411 -- indexing.
1413 -- Generic_Parent
1414 -- Generic_Parent is defined on declaration nodes that are instances. The
1415 -- value of Generic_Parent is the generic entity from which the instance
1416 -- is obtained.
1418 -- Generic_Parent_Type
1419 -- Generic_Parent_Type is defined on Subtype_Declaration nodes for the
1420 -- actuals of formal private and derived types. Within the instance, the
1421 -- operations on the actual are those inherited from the parent. For a
1422 -- formal private type, the parent type is the generic type itself. The
1423 -- Generic_Parent_Type is also used in an instance to determine whether a
1424 -- private operation overrides an inherited one.
1426 -- Handler_List_Entry
1427 -- This field is present in N_Object_Declaration nodes. It is set only
1428 -- for the Handler_Record entry generated for an exception in zero cost
1429 -- exception handling mode. It references the corresponding item in the
1430 -- handler list, and is used to delete this entry if the corresponding
1431 -- handler is deleted during optimization. For further details on why
1432 -- this is required, see Exp_Ch11.Remove_Handler_Entries.
1434 -- Has_Dereference_Action
1435 -- This flag is present in N_Explicit_Dereference nodes. It is set to
1436 -- indicate that the expansion has aready produced a call to primitive
1437 -- Dereference of a System.Checked_Pools.Checked_Pool implementation.
1438 -- Such dereference actions are produced for debugging purposes.
1440 -- Has_Dynamic_Length_Check
1441 -- This flag is present in all expression nodes. It is set to indicate
1442 -- that one of the routines in unit Checks has generated a length check
1443 -- action which has been inserted at the flagged node. This is used to
1444 -- avoid the generation of duplicate checks.
1446 -- Has_Local_Raise
1447 -- Present in exception handler nodes. Set if the handler can be entered
1448 -- via a local raise that gets transformed to a goto statement. This will
1449 -- always be set if Local_Raise_Statements is non-empty, but can also be
1450 -- set as a result of generation of N_Raise_xxx nodes, or flags set in
1451 -- nodes requiring generation of back end checks.
1453 -- Has_No_Elaboration_Code
1454 -- A flag that appears in the N_Compilation_Unit node to indicate whether
1455 -- or not elaboration code is present for this unit. It is initially set
1456 -- true for subprogram specs and bodies and for all generic units and
1457 -- false for non-generic package specs and bodies. Gigi may set the flag
1458 -- in the non-generic package case if it determines that no elaboration
1459 -- code is generated. Note that this flag is not related to the
1460 -- Is_Preelaborated status, there can be preelaborated packages that
1461 -- generate elaboration code, and non-preelaborated packages which do
1462 -- not generate elaboration code.
1464 -- Has_Pragma_Suppress_All
1465 -- This flag is set in an N_Compilation_Unit node if the Suppress_All
1466 -- pragma appears anywhere in the unit. This accommodates the rather
1467 -- strange placement rules of other compilers (DEC permits it at the
1468 -- end of a unit, and Rational allows it as a program unit pragma). We
1469 -- allow it anywhere at all, and consider it equivalent to a pragma
1470 -- Suppress (All_Checks) appearing at the start of the configuration
1471 -- pragmas for the unit.
1473 -- Has_Private_View
1474 -- A flag present in generic nodes that have an entity, to indicate that
1475 -- the node has a private type. Used to exchange private and full
1476 -- declarations if the visibility at instantiation is different from the
1477 -- visibility at generic definition.
1479 -- Has_Relative_Deadline_Pragma
1480 -- A flag present in N_Subprogram_Body and N_Task_Definition nodes to
1481 -- flag the presence of a pragma Relative_Deadline.
1483 -- Has_Secondary_Private_View
1484 -- A flag present in generic nodes that have an entity, to indicate that
1485 -- the node is either of an access type whose Designated_Type is private
1486 -- or of an array type whose Component_Type is private. Used to exchange
1487 -- private and full declarations if the visibility at instantiation is
1488 -- different from the visibility at generic definition.
1490 -- Has_Self_Reference
1491 -- Present in N_Aggregate and N_Extension_Aggregate. Indicates that one
1492 -- of the expressions contains an access attribute reference to the
1493 -- enclosing type. Such a self-reference can only appear in default-
1494 -- initialized aggregate for a record type.
1496 -- Has_SP_Choice
1497 -- Present in all nodes containing a Discrete_Choices field (N_Variant,
1498 -- N_Case_Expression_Alternative, N_Case_Statement_Alternative). Set to
1499 -- True if the Discrete_Choices list has at least one occurrence of a
1500 -- statically predicated subtype.
1502 -- Has_Storage_Size_Pragma
1503 -- A flag present in an N_Task_Definition node to flag the presence of a
1504 -- Storage_Size pragma.
1506 -- Has_Target_Names
1507 -- Present in assignment statements. Indicates that the RHS contains
1508 -- target names (see AI12-0125-3) and must be expanded accordingly.
1510 -- Has_Wide_Character
1511 -- Present in string literals, set if any wide character (i.e. character
1512 -- code outside the Character range but within Wide_Character range)
1513 -- appears in the string. Used to implement pragma preference rules.
1515 -- Has_Wide_Wide_Character
1516 -- Present in string literals, set if any wide character (i.e. character
1517 -- code outside the Wide_Character range) appears in the string. Used to
1518 -- implement pragma preference rules.
1520 -- Header_Size_Added
1521 -- Present in N_Attribute_Reference nodes, set only for attribute
1522 -- Max_Size_In_Storage_Elements. The flag indicates that the size of the
1523 -- hidden list header used by the runtime finalization support has been
1524 -- added to the size of the prefix. The flag also prevents the infinite
1525 -- expansion of the same attribute in the said context.
1527 -- Hidden_By_Use_Clause
1528 -- An entity list present in use clauses that appear within
1529 -- instantiations. For the resolution of local entities, entities
1530 -- introduced by these use clauses have priority over global ones,
1531 -- and outer entities must be explicitly hidden/restored on exit.
1533 -- Implicit_With
1534 -- Present in N_With_Clause nodes. The flag indicates that the clause
1535 -- does not comes from source and introduces an implicit dependency on
1536 -- a particular unit. Such implicit with clauses are generated by:
1538 -- * ABE mechanism - The static elaboration model of both the default
1539 -- and the legacy ABE mechanism use with clauses to encode implicit
1540 -- Elaborate[_All] pragmas.
1542 -- * Analysis - A with clause for child unit A.B.C is equivalent to
1543 -- a series of clauses that with A, A.B, and A.B.C. Manipulation of
1544 -- contexts utilizes implicit with clauses to emulate the visibility
1545 -- of a particular unit.
1547 -- * RTSfind - The compiler generates code which references entities
1548 -- from the runtime.
1550 -- Import_Interface_Present
1551 -- This flag is set in an Interface or Import pragma if a matching
1552 -- pragma of the other kind is also present. This is used to avoid
1553 -- generating some unwanted error messages.
1555 -- Includes_Infinities
1556 -- This flag is present in N_Range nodes. It is set for the range of
1557 -- unconstrained float types defined in Standard, which include not only
1558 -- the given range of values, but also legitimately can include infinite
1559 -- values. This flag is false for any float type for which an explicit
1560 -- range is given by the programmer, even if that range is identical to
1561 -- the range for Float.
1563 -- Incomplete_View
1564 -- Present in full type declarations that are completions of incomplete
1565 -- type declarations. Denotes the corresponding incomplete view declared
1566 -- by the incomplete declaration.
1568 -- Inherited_Discriminant
1569 -- This flag is present in N_Component_Association nodes. It indicates
1570 -- that a given component association in an extension aggregate is the
1571 -- value obtained from a constraint on an ancestor. Used to prevent
1572 -- double expansion when the aggregate has expansion delayed.
1574 -- Instance_Spec
1575 -- This field is present in generic instantiation nodes, and also in
1576 -- formal package declaration nodes (formal package declarations are
1577 -- treated similarly to package instantiations). It points to the node
1578 -- for the spec of the instance, inserted as part of the semantic
1579 -- processing for instantiations in Sem_Ch12.
1581 -- Is_Abort_Block
1582 -- Present in N_Block_Statement nodes. True if the block protects a list
1583 -- of statements with an Abort_Defer / Abort_Undefer_Direct pair.
1585 -- Is_Accessibility_Actual
1586 -- Present in N_Parameter_Association nodes. True if the parameter is
1587 -- an extra actual that carries the accessibility level of the actual
1588 -- for an access parameter, in a function that dispatches on result and
1589 -- is called in a dispatching context. Used to prevent a formal/actual
1590 -- mismatch when the call is rewritten as a dispatching call.
1592 -- Is_Analyzed_Pragma
1593 -- Present in N_Pragma nodes. Set for delayed pragmas that require a two
1594 -- step analysis. The initial step is performed by routine Analyze_Pragma
1595 -- and verifies the overall legality of the pragma. The second step takes
1596 -- place in the various Analyze_xxx_In_Decl_Part routines which perform
1597 -- full analysis. The flag prevents the reanalysis of a delayed pragma.
1599 -- Is_Asynchronous_Call_Block
1600 -- A flag set in a Block_Statement node to indicate that it is the
1601 -- expansion of an asynchronous entry call. Such a block needs cleanup
1602 -- handler to assure that the call is cancelled.
1604 -- Is_Boolean_Aspect
1605 -- Present in N_Aspect_Specification node. Set if the aspect is for a
1606 -- boolean aspect (i.e. Aspect_Id is in Boolean_Aspect subtype).
1608 -- Is_Checked
1609 -- Present in N_Aspect_Specification and N_Pragma nodes. Set for an
1610 -- assertion aspect or pragma, or check pragma for an assertion, that
1611 -- is to be checked at run time. If either Is_Checked or Is_Ignored
1612 -- is set (they cannot both be set), then this means that the status of
1613 -- the pragma has been checked at the appropriate point and should not
1614 -- be further modified (in some cases these flags are copied when a
1615 -- pragma is rewritten).
1617 -- Is_Checked_Ghost_Pragma
1618 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1619 -- related to a checked Ghost entity or encloses a checked Ghost entity.
1620 -- This flag has no relation to Is_Checked.
1622 -- Is_Component_Left_Opnd
1623 -- Is_Component_Right_Opnd
1624 -- Present in concatenation nodes, to indicate that the corresponding
1625 -- operand is of the component type of the result. Used in resolving
1626 -- concatenation nodes in instances.
1628 -- Is_Controlling_Actual
1629 -- This flag is set on an expression that is a controlling argument in
1630 -- a dispatching call. It is off in all other cases. See Sem_Disp for
1631 -- details of its use.
1633 -- Is_Declaration_Level_Node
1634 -- Present in call marker and instantiation nodes. Set when the constuct
1635 -- appears within the declarations of a block statement, an entry body,
1636 -- a subprogram body, or a task body. The flag aids the ABE Processing
1637 -- phase to catch certain forms of guaranteed ABEs.
1639 -- Is_Delayed_Aspect
1640 -- Present in N_Pragma and N_Attribute_Definition_Clause nodes which
1641 -- come from aspect specifications, where the evaluation of the aspect
1642 -- must be delayed to the freeze point. This flag is also set True in
1643 -- the corresponding N_Aspect_Specification node.
1645 -- Is_Disabled
1646 -- A flag set in an N_Aspect_Specification or N_Pragma node if there was
1647 -- a Check_Policy or Assertion_Policy (or in the case of a Debug_Pragma)
1648 -- a Debug_Policy pragma that resulted in totally disabling the flagged
1649 -- aspect or policy as a result of using the GNAT-defined policy DISABLE.
1650 -- If this flag is set, the aspect or policy is not analyzed for semantic
1651 -- correctness, so any expressions etc will not be marked as analyzed.
1653 -- Is_Dispatching_Call
1654 -- Present in call marker nodes. Set when the related call which prompted
1655 -- the creation of the marker is dispatching.
1657 -- Is_Dynamic_Coextension
1658 -- Present in allocator nodes, to indicate that this is an allocator
1659 -- for an access discriminant of a dynamically allocated object. The
1660 -- coextension must be deallocated and finalized at the same time as
1661 -- the enclosing object. The partner flag Is_Static_Coextension must
1662 -- be cleared before setting this flag to True.
1664 -- Is_Effective_Use_Clause
1665 -- Present in both N_Use_Type_Clause and N_Use_Package_Clause to indicate
1666 -- a use clause is "used" in the current source.
1668 -- Is_Elaboration_Checks_OK_Node
1669 -- Present in the following nodes:
1671 -- assignment statement
1672 -- attribute reference
1673 -- call marker
1674 -- entry call statement
1675 -- expanded name
1676 -- function call
1677 -- function instantiation
1678 -- identifier
1679 -- package instantiation
1680 -- procedure call statement
1681 -- procedure instantiation
1682 -- requeue statement
1683 -- variable reference marker
1685 -- Set when the node appears within a context which allows the generation
1686 -- of run-time ABE checks. This flag determines whether the ABE
1687 -- Processing phase generates conditional ABE checks and guaranteed ABE
1688 -- failures.
1690 -- Is_Elaboration_Code
1691 -- Present in assignment statements. Set for an assignment which updates
1692 -- the elaboration flag of a package or subprogram when the corresponding
1693 -- body is successfully elaborated.
1695 -- Is_Elaboration_Warnings_OK_Node
1696 -- Present in the following nodes:
1698 -- attribute reference
1699 -- call marker
1700 -- entry call statement
1701 -- expanded name
1702 -- function call
1703 -- function instantiation
1704 -- identifier
1705 -- package instantiation
1706 -- procedure call statement
1707 -- procedure instantiation
1708 -- requeue statement
1709 -- variable reference marker
1711 -- Set when the node appears within a context where elaboration warnings
1712 -- are enabled. This flag determines whether the ABE processing phase
1713 -- generates diagnostics on various elaboration issues.
1715 -- Is_Entry_Barrier_Function
1716 -- This flag is set on N_Subprogram_Declaration and N_Subprogram_Body
1717 -- nodes which emulate the barrier function of a protected entry body.
1718 -- The flag is used when checking for incorrect use of Current_Task.
1720 -- Is_Expanded_Build_In_Place_Call
1721 -- This flag is set in an N_Function_Call node to indicate that the extra
1722 -- actuals to support a build-in-place style of call have been added to
1723 -- the call.
1725 -- Is_Generic_Contract_Pragma
1726 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1727 -- a source construct, applies to a generic unit or its body, and denotes
1728 -- one of the following contract-related annotations:
1729 -- Abstract_State
1730 -- Always_Terminates
1731 -- Contract_Cases
1732 -- Depends
1733 -- Exceptional_Cases
1734 -- Extensions_Visible
1735 -- Global
1736 -- Initial_Condition
1737 -- Initializes
1738 -- Post
1739 -- Post_Class
1740 -- Postcondition
1741 -- Pre
1742 -- Pre_Class
1743 -- Precondition
1744 -- Refined_Depends
1745 -- Refined_Global
1746 -- Refined_Post
1747 -- Refined_State
1748 -- Subprogram_Variant
1749 -- Test_Case
1751 -- Is_Homogeneous_Aggregate
1752 -- A flag set on an Ada 2022 aggregate that uses square brackets as
1753 -- delimiters, and thus denotes an array or container aggregate, or
1754 -- the prefix of a reduction attribute.
1756 -- Is_Ignored
1757 -- A flag set in an N_Aspect_Specification or N_Pragma node if there was
1758 -- a Check_Policy or Assertion_Policy (or in the case of a Debug_Pragma)
1759 -- a Debug_Policy pragma that specified a policy of IGNORE, DISABLE, or
1760 -- OFF, for the pragma/aspect. If there was a Policy pragma specifying
1761 -- a Policy of ON or CHECK, then this flag is reset. If no Policy pragma
1762 -- gives a policy for the aspect or pragma, then there are two cases. For
1763 -- an assertion aspect or pragma (one of the assertion kinds allowed in
1764 -- an Assertion_Policy pragma), then Is_Ignored is set if assertions are
1765 -- ignored because of the absence of a -gnata switch. For any other
1766 -- aspects or pragmas, the flag is off. If this flag is set, the
1767 -- aspect/pragma is fully analyzed and checked for other syntactic
1768 -- and semantic errors, but it does not have any semantic effect.
1770 -- Is_Ignored_Ghost_Pragma
1771 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1772 -- related to an ignored Ghost entity or encloses ignored Ghost entity.
1773 -- This flag has no relation to Is_Ignored.
1775 -- Is_In_Discriminant_Check
1776 -- This flag is present in a selected component, and is used to indicate
1777 -- that the reference occurs within a discriminant check. The
1778 -- significance is that optimizations based on assuming that the
1779 -- discriminant check has a correct value cannot be performed in this
1780 -- case (or the discriminant check may be optimized away).
1782 -- Is_Inherited_Pragma
1783 -- This flag is set in an N_Pragma node that appears in a N_Contract node
1784 -- to indicate that the pragma has been inherited from a parent context.
1786 -- Is_Initialization_Block
1787 -- Defined in block nodes. Set when the block statement was created by
1788 -- the finalization machinery to wrap initialization statements. This
1789 -- flag aids the ABE Processing phase to suppress the diagnostics of
1790 -- finalization actions in initialization contexts.
1792 -- Is_Known_Guaranteed_ABE
1793 -- NOTE: this flag is shared between the legacy ABE mechanism and the
1794 -- default ABE mechanism.
1796 -- Present in the following nodes:
1798 -- call marker
1799 -- formal package declaration
1800 -- function call
1801 -- function instantiation
1802 -- package instantiation
1803 -- procedure call statement
1804 -- procedure instantiation
1806 -- Set when the elaboration or evaluation of the scenario results in
1807 -- a guaranteed ABE. The flag is used to suppress the instantiation of
1808 -- generic bodies because gigi cannot handle certain forms of premature
1809 -- instantiation, as well as to prevent the reexamination of the node by
1810 -- the ABE Processing phase.
1812 -- Is_Machine_Number
1813 -- This flag is set in an N_Real_Literal node to indicate that the value
1814 -- is a machine number. This avoids some unnecessary cases of converting
1815 -- real literals to machine numbers.
1817 -- Is_Null_Loop
1818 -- This flag is set in an N_Loop_Statement node if the corresponding loop
1819 -- can be determined to be null at compile time. This is used to remove
1820 -- the loop entirely at expansion time.
1822 -- Is_Overloaded
1823 -- A flag present in all expression nodes. Used temporarily during
1824 -- overloading determination. The setting of this flag is not relevant
1825 -- once overloading analysis is complete.
1827 -- Is_Parenthesis_Aggregate
1828 -- A flag set on an aggregate that uses parentheses as delimiters
1830 -- Is_Power_Of_2_For_Shift
1831 -- A flag present only in N_Op_Expon nodes. It is set when the
1832 -- exponentiation is of the form 2 ** N, where the type of N is an
1833 -- unsigned integral subtype whose size does not exceed the size of
1834 -- Standard_Integer (i.e. a type that can be safely converted to
1835 -- Natural), and the exponentiation appears as the right operand of an
1836 -- integer multiplication or an integer division where the dividend is
1837 -- unsigned. It is also required that overflow checking is off for both
1838 -- the exponentiation and the multiply/divide node. If this set of
1839 -- conditions holds, and the flag is set, then the division or
1840 -- multiplication can be (and is) converted to a shift.
1842 -- Is_Preelaborable_Call
1843 -- Present in call marker nodes. Set when the related call is non-static
1844 -- but preelaborable.
1846 -- Is_Prefixed_Call
1847 -- This flag is set in a selected component within a generic unit, if
1848 -- it resolves to a prefixed call to a primitive operation. The flag
1849 -- is used to prevent accidental overloadings in an instance, when a
1850 -- primitive operation and a private record component may be homographs.
1852 -- Is_Protected_Subprogram_Body
1853 -- A flag set in a Subprogram_Body block to indicate that it is the
1854 -- implementation of a protected subprogram. Such a body needs cleanup
1855 -- handler to make sure that the associated protected object is unlocked
1856 -- when the subprogram completes.
1858 -- Is_Qualified_Universal_Literal
1859 -- Present in N_Qualified_Expression nodes. Set when the qualification is
1860 -- converting a universal literal to a specific type. Such qualifiers aid
1861 -- the resolution of accidental overloading of binary or unary operators
1862 -- which may occur in instances.
1864 -- Is_Read
1865 -- Present in variable reference markers. Set when the original variable
1866 -- reference constitutes a read of the variable.
1868 -- Is_Source_Call
1869 -- Present in call marker nodes. Set when the related call came from
1870 -- source.
1872 -- Is_SPARK_Mode_On_Node
1873 -- Present in the following nodes:
1875 -- assignment statement
1876 -- attribute reference
1877 -- call marker
1878 -- entry call statement
1879 -- expanded name
1880 -- function call
1881 -- function instantiation
1882 -- identifier
1883 -- package instantiation
1884 -- procedure call statement
1885 -- procedure instantiation
1886 -- requeue statement
1887 -- variable reference marker
1889 -- Set when the node appears within a context subject to SPARK_Mode On.
1890 -- This flag determines when the SPARK model of elaboration be activated
1891 -- by the ABE Processing phase.
1893 -- Is_Static_Coextension
1894 -- Present in N_Allocator nodes. Set if the allocator is a coextension
1895 -- of an object allocated on the stack rather than the heap. The partner
1896 -- flag Is_Dynamic_Coextension must be cleared before setting this flag
1897 -- to True.
1899 -- Is_Static_Expression
1900 -- Indicates that an expression is a static expression according to the
1901 -- rules in RM-4.9. See Sem_Eval for details.
1903 -- Is_Subprogram_Descriptor
1904 -- Present in N_Object_Declaration, and set only for the object
1905 -- declaration generated for a subprogram descriptor in fast exception
1906 -- mode. See Exp_Ch11 for details of use.
1908 -- Is_Task_Allocation_Block
1909 -- A flag set in a Block_Statement node to indicate that it is the
1910 -- expansion of a task allocator, or the allocator of an object
1911 -- containing tasks. Such a block requires a cleanup handler to call
1912 -- Expunge_Unactivated_Tasks to complete any tasks that have been
1913 -- allocated but not activated when the allocator completes abnormally.
1915 -- Is_Task_Body_Procedure
1916 -- This flag is set on N_Subprogram_Declaration and N_Subprogram_Body
1917 -- nodes which emulate the body of a task unit.
1919 -- Is_Task_Master
1920 -- A flag set in a Subprogram_Body, Block_Statement, or Task_Body node to
1921 -- indicate that the construct is a task master (i.e. has declared tasks
1922 -- or declares an access to a task type).
1924 -- Is_Write
1925 -- Present in variable reference markers. Set when the original variable
1926 -- reference constitutes a write of the variable.
1928 -- Iterator_Filter
1929 -- Present in N_Loop_Parameter_Specification and N_Iterator_Specification
1930 -- nodes for Ada 2022. It is used to store the condition present in the
1931 -- eponymous Ada 2022 construct.
1933 -- Itype
1934 -- Used in N_Itype_Reference node to reference an itype for which it is
1935 -- important to ensure that it is defined. See description of this node
1936 -- for further details.
1938 -- Kill_Range_Check
1939 -- Used in an N_Unchecked_Type_Conversion node to indicate that the
1940 -- result should not be subjected to range checks. This is used for the
1941 -- implementation of Normalize_Scalars.
1943 -- Label_Construct
1944 -- Used in an N_Implicit_Label_Declaration node. Refers to an N_Label,
1945 -- N_Block_Statement or N_Loop_Statement node to which the label
1946 -- declaration applies. The field is left empty for the special labels
1947 -- generated as part of expanding raise statements with a local exception
1948 -- handler.
1950 -- Library_Unit
1951 -- In a stub node, Library_Unit points to the compilation unit node of
1952 -- the corresponding subunit.
1954 -- In a with clause node, Library_Unit points to the spec of the with'ed
1955 -- unit.
1957 -- In a compilation unit node, the usage depends on the unit type:
1959 -- For a library unit body, Library_Unit points to the compilation unit
1960 -- node of the corresponding spec, unless it's a subprogram body with
1961 -- Acts_As_Spec set, in which case it points to itself.
1963 -- For a spec, Library_Unit points to the compilation unit node of the
1964 -- corresponding body, if present. The body will be present if the spec
1965 -- is or contains generics that we needed to instantiate. Similarly, the
1966 -- body will be present if we needed it for inlining purposes. Thus, if
1967 -- we have a spec/body pair, both of which are present, they point to
1968 -- each other via Library_Unit.
1970 -- For a subunit, Library_Unit points to the compilation unit node of
1971 -- the parent body.
1972 -- ??? not (always) true, in (at least some, maybe all?) cases it points
1973 -- to the corresponding spec for the parent body.
1975 -- Note that this field is not used to hold the parent pointer for child
1976 -- unit (which might in any case need to use it for some other purpose as
1977 -- described above). Instead for a child unit, implicit with's are
1978 -- generated for all parents.
1980 -- Local_Raise_Statements
1981 -- This field is present in exception handler nodes. It is set to
1982 -- No_Elist in the normal case. If there is at least one raise statement
1983 -- which can potentially be handled as a local raise, then this field
1984 -- points to a list of raise nodes, which are calls to a routine to raise
1985 -- an exception. These are raise nodes which can be optimized into gotos
1986 -- if the handler turns out to meet the conditions which permit this
1987 -- transformation. Note that this does NOT include instances of the
1988 -- N_Raise_xxx_Error nodes since the transformation of these nodes is
1989 -- handled by the back end (using the N_Push/N_Pop mechanism).
1991 -- Loop_Actions
1992 -- A list present in Component_Association nodes in array aggregates.
1993 -- Used to collect actions that must be executed within the loop because
1994 -- they may need to be evaluated anew each time through.
1996 -- Limited_View_Installed
1997 -- Present in With_Clauses and in package specifications. If set on
1998 -- with_clause, it indicates that this clause has created the current
1999 -- limited view of the designated package. On a package specification, it
2000 -- indicates that the limited view has already been created because the
2001 -- package is mentioned in a limited_with_clause in the closure of the
2002 -- unit being compiled.
2004 -- Local_Raise_Not_OK
2005 -- Present in N_Exception_Handler nodes. Set if the handler contains
2006 -- a construct (reraise statement, or call to subprogram in package
2007 -- GNAT.Current_Exception) that makes the handler unsuitable as a target
2008 -- for a local raise (one that could otherwise be converted to a goto).
2010 -- Must_Be_Byte_Aligned
2011 -- This flag is present in N_Attribute_Reference nodes. It can be set
2012 -- only for the Address and Unrestricted_Access attributes. If set it
2013 -- means that the object for which the address/access is given must be on
2014 -- a byte (more accurately a storage unit) boundary. If necessary, a copy
2015 -- of the object is to be made before taking the address (this copy is in
2016 -- the current scope on the stack frame). This is used for certain cases
2017 -- of code generated by the expander that passes parameters by address.
2019 -- The reason the copy is not made by the front end is that the back end
2020 -- has more information about type layout and may be able to (but is not
2021 -- guaranteed to) prevent making unnecessary copies.
2023 -- Must_Not_Freeze
2024 -- A flag present in all expression nodes. Normally expressions cause
2025 -- freezing as described in the RM. If this flag is set, then this is
2026 -- inhibited. This is used by the analyzer and expander to label nodes
2027 -- that are created by semantic analysis or expansion and which must not
2028 -- cause freezing even though they normally would. This flag is also
2029 -- present in an N_Subtype_Indication node, since we also use these in
2030 -- calls to Freeze_Expression.
2032 -- Next_Entity
2033 -- Present in defining identifiers, defining character literals, and
2034 -- defining operator symbols (i.e. in all entities). The entities of a
2035 -- scope are chained, and this field is used as the forward pointer for
2036 -- this list. See Einfo for further details.
2038 -- Next_Exit_Statement
2039 -- Present in N_Exit_Statement nodes. The exit statements for a loop are
2040 -- chained (in reverse order of appearance) from the First_Exit_Statement
2041 -- field of the E_Loop entity for the loop. Next_Exit_Statement points to
2042 -- the next entry on this chain (Empty = end of list).
2044 -- Next_Implicit_With
2045 -- Present in N_With_Clause. Part of a chain of with_clauses generated
2046 -- in rtsfind to indicate implicit dependencies on predefined units. Used
2047 -- to prevent multiple with_clauses for the same unit in a given context.
2048 -- A postorder traversal of the tree whose nodes are units and whose
2049 -- links are with_clauses defines the order in which CodePeer must
2050 -- examine a compiled unit and its full context. This ordering ensures
2051 -- that any subprogram call is examined after the subprogram declaration
2052 -- has been seen.
2054 -- Next_Named_Actual
2055 -- Present in parameter association nodes. Set during semantic analysis
2056 -- to point to the next named parameter, where parameters are ordered by
2057 -- declaration order (as opposed to the actual order in the call, which
2058 -- may be different due to named associations). Not that this field
2059 -- points to the explicit actual parameter itself, not to the
2060 -- N_Parameter_Association node (its parent).
2062 -- Next_Pragma
2063 -- Present in N_Pragma nodes. Used to create a linked list of pragma
2064 -- nodes. Currently used for two purposes:
2066 -- Create a list of linked Check_Policy pragmas. The head of this list
2067 -- is stored in Opt.Check_Policy_List (which has further details).
2069 -- Used by processing for Pre/Postcondition pragmas to store a list of
2070 -- pragmas associated with the spec of a subprogram (see Sem_Prag for
2071 -- details).
2073 -- Used by processing for pragma SPARK_Mode to store multiple pragmas
2074 -- the apply to the same construct. These are visible/private mode for
2075 -- a package spec and declarative/statement mode for package body.
2077 -- Next_Rep_Item
2078 -- Present in pragma nodes, attribute definition nodes, enumeration rep
2079 -- clauses, record rep clauses, aspect specification and null statement
2080 -- nodes. Used to link representation items that apply to an entity. See
2081 -- full description of First_Rep_Item field in Einfo for further details.
2083 -- Next_Use_Clause
2084 -- While use clauses are active during semantic processing, they are
2085 -- chained from the scope stack entry, using Next_Use_Clause as a link
2086 -- pointer, with Empty marking the end of the list. The head pointer is
2087 -- in the scope stack entry (First_Use_Clause). At the end of semantic
2088 -- processing (i.e. when Gigi sees the tree, the contents of this field
2089 -- is undefined and should not be read).
2091 -- No_Ctrl_Actions
2092 -- Present in N_Assignment_Statement to indicate that neither Finalize
2093 -- nor Adjust should take place on this assignment even though the LHS
2094 -- and RHS are controlled. Also to indicate that the primitive _assign
2095 -- should not be used for a tagged assignment. This flag is used in init
2096 -- proc and aggregate expansion where the generated assignments are
2097 -- initializations, not real assignments. Note that it also suppresses
2098 -- the creation of transient scopes around the N_Assignment_Statement,
2099 -- in other words it disables all controlled actions for the assignment.
2101 -- No_Elaboration_Check
2102 -- NOTE: this flag is relevant only for the legacy ABE mechanism and
2103 -- should not be used outside of that context.
2105 -- Present in N_Function_Call and N_Procedure_Call_Statement. Indicates
2106 -- that no elaboration check is needed on the call, because it appears in
2107 -- the context of a local Suppress pragma. This is used on calls within
2108 -- task bodies, where the actual elaboration checks are applied after
2109 -- analysis, when the local scope stack is not present.
2111 -- No_Entities_Ref_In_Spec
2112 -- Present in N_With_Clause nodes. Set if the with clause is on the
2113 -- package or subprogram spec where the main unit is the corresponding
2114 -- body, and no entities of the with'ed unit are referenced by the spec
2115 -- (an entity may still be referenced in the body, so this flag is used
2116 -- to generate the proper message (see Sem_Util.Check_Unused_Withs for
2117 -- full details).
2119 -- No_Finalize_Actions
2120 -- Present in N_Assignment_Statement to indicate that no Finalize should
2121 -- take place on this assignment even though the LHS is controlled. Also
2122 -- to indicate that the primitive _assign should not be used for a tagged
2123 -- assignment. This flag is only used in aggregates expansion where the
2124 -- generated assignments are initializations, not real assignments. Note
2125 -- that, unlike the No_Ctrl_Actions flag, it does *not* suppress the
2126 -- creation of transient scopes around the N_Assignment_Statement.
2128 -- No_Initialization
2129 -- Present in N_Object_Declaration and N_Allocator to indicate that the
2130 -- object must not be initialized (by Initialize or call to an init
2131 -- proc). This is needed for controlled aggregates. When the Object
2132 -- declaration has an expression, this flag means that this expression
2133 -- should not be taken into account (needed for in place initialization
2134 -- with aggregates, and for object with an address clause, which are
2135 -- initialized with an assignment at freeze time).
2137 -- No_Minimize_Eliminate
2138 -- This flag is present in membership operator nodes (N_In/N_Not_In).
2139 -- It is used to indicate that processing for extended overflow checking
2140 -- modes is not required (this is used to prevent infinite recursion).
2142 -- No_Truncation
2143 -- Present in N_Unchecked_Type_Conversion node. This flag has an effect
2144 -- only if the RM_Size of the source is greater than the RM_Size of the
2145 -- target for scalar operands. Normally in such a case we truncate some
2146 -- higher order bits of the source, and then sign/zero extend the result
2147 -- to form the output value. But if this flag is set, then we do not do
2148 -- any truncation, so for example, if an 8 bit input is converted to 5
2149 -- bit result which is in fact stored in 8 bits, then the high order
2150 -- three bits of the target result will be copied from the source. This
2151 -- is used for properly setting out of range values for use by pragmas
2152 -- Initialize_Scalars and Normalize_Scalars.
2154 -- Null_Excluding_Subtype
2155 -- Present in N_Access_To_Object_Definition. Indicates that the subtype
2156 -- indication carries a null-exclusion indicator, which is distinct from
2157 -- the null-exclusion indicator that may precede the access keyword.
2159 -- Original_Discriminant
2160 -- Present in identifiers. Used in references to discriminants that
2161 -- appear in generic units. Because the names of the discriminants may be
2162 -- different in an instance, we use this field to recover the position of
2163 -- the discriminant in the original type, and replace it with the
2164 -- discriminant at the same position in the instantiated type.
2166 -- Original_Entity
2167 -- Present in numeric literals. Used to denote the named number that has
2168 -- been constant-folded into the given literal. If literal is from
2169 -- source, or the result of some other constant-folding operation, then
2170 -- Original_Entity is empty. This field is needed to handle properly
2171 -- named numbers in generic units, where the Associated_Node field
2172 -- interferes with the Entity field, making it impossible to preserve the
2173 -- original entity at the point of instantiation.
2175 -- Others_Discrete_Choices
2176 -- When a case statement or variant is analyzed, the semantic checks
2177 -- determine the actual list of choices that correspond to an others
2178 -- choice. This list is materialized for later use by the expander and
2179 -- the Others_Discrete_Choices field of an N_Others_Choice node points to
2180 -- this materialized list of choices, which is in standard format for a
2181 -- list of discrete choices, except that of course it cannot contain an
2182 -- N_Others_Choice entry.
2184 -- Parent_Spec
2185 -- For a library unit that is a child unit spec (package or subprogram
2186 -- declaration, generic declaration or instantiation, or library level
2187 -- rename) this field points to the compilation unit node for the parent
2188 -- package specification. This field is Empty for library bodies (the
2189 -- parent spec in this case can be found from the corresponding spec).
2191 -- Parent_With
2192 -- Present in N_With_Clause nodes. The flag indicates that the clause
2193 -- was generated for an ancestor unit to provide proper visibility. A
2194 -- with clause for child unit A.B.C produces two implicit parent with
2195 -- clauses for A and A.B.
2197 -- Premature_Use
2198 -- Present in N_Incomplete_Type_Declaration node. Used for improved
2199 -- error diagnostics: if there is a premature usage of an incomplete
2200 -- type, a subsequently generated error message indicates the position
2201 -- of its full declaration.
2203 -- Present_Expr
2204 -- Present in an N_Variant node. This has a meaningful value only after
2205 -- Gigi has back annotated the tree with representation information. At
2206 -- this point, it contains a reference to a gcc expression that depends
2207 -- on the values of one or more discriminants. Given a set of
2208 -- discriminant values, this expression evaluates to False (zero) if
2209 -- variant is not present, and True (non-zero) if it is present. See
2210 -- unit Repinfo for further details on gigi back annotation. This field
2211 -- is used during back-annotation processing (for -gnatR -gnatc) to
2212 -- determine if a field is present or not.
2214 -- Prev_Use_Clause
2215 -- Present in both N_Use_Package_Clause and N_Use_Type_Clause. Used in
2216 -- detection of ineffective use clauses by allowing a chain of related
2217 -- clauses together to avoid traversing the current scope stack.
2219 -- Print_In_Hex
2220 -- Set on an N_Integer_Literal node to indicate that the value should be
2221 -- printed in hexadecimal in the sprint listing. Has no effect on
2222 -- legality or semantics of program, only on the displayed output. This
2223 -- is used to clarify output from the packed array cases.
2225 -- Procedure_To_Call
2226 -- Present in N_Allocator, N_Free_Statement, N_Simple_Return_Statement,
2227 -- and N_Extended_Return_Statement nodes. References the entity for the
2228 -- declaration of the procedure to be called to accomplish the required
2229 -- operation (i.e. for the Allocate procedure in the case of N_Allocator
2230 -- and N_Simple_Return_Statement and N_Extended_Return_Statement (for
2231 -- allocating the return value), and for the Deallocate procedure in the
2232 -- case of N_Free_Statement.
2234 -- Raises_Constraint_Error
2235 -- Set on an expression whose evaluation will definitely fail constraint
2236 -- error check. See Sem_Eval for details.
2238 -- Redundant_Use
2239 -- Present in nodes that can appear as an operand in a use clause or use
2240 -- type clause (identifiers, expanded names, attribute references). Set
2241 -- to indicate that a use is redundant (and therefore need not be undone
2242 -- on scope exit).
2244 -- Renaming_Exception
2245 -- Present in N_Exception_Declaration node. Used to point back to the
2246 -- exception renaming for an exception declared within a subprogram.
2247 -- What happens is that an exception declared in a subprogram is moved
2248 -- to the library level with a unique name, and the original exception
2249 -- becomes a renaming. This link from the library level exception to the
2250 -- renaming declaration allows registering of the proper exception name.
2252 -- Return_Statement_Entity
2253 -- Present in N_Simple_Return_Statement and N_Extended_Return_Statement.
2254 -- Points to an E_Return_Statement representing the return statement.
2256 -- Return_Object_Declarations
2257 -- Present in N_Extended_Return_Statement. Points to a list initially
2258 -- containing a single N_Object_Declaration representing the return
2259 -- object. We use a list (instead of just a pointer to the object decl)
2260 -- because Analyze wants to insert extra actions on this list, before the
2261 -- N_Object_Declaration, which always remains last on the list.
2263 -- Rounded_Result
2264 -- Present in N_Type_Conversion, N_Op_Divide, and N_Op_Multiply nodes.
2265 -- Used in the fixed-point cases to indicate that the result must be
2266 -- rounded as a result of the use of the 'Round attribute. Also used for
2267 -- integer N_Op_Divide nodes to indicate that the result should be
2268 -- rounded to the nearest integer (breaking ties away from zero), rather
2269 -- than truncated towards zero as usual. These rounded integer operations
2270 -- are the result of expansion of rounded fixed-point divide, conversion
2271 -- and multiplication operations.
2273 -- Save_Invocation_Graph_Of_Body
2274 -- Present in compilation unit nodes. Set when the elaboration mechanism
2275 -- must record all invocation constructs and invocation relations within
2276 -- the body of the compilation unit.
2278 -- SCIL_Entity
2279 -- Present in SCIL nodes. References the specific tagged type associated
2280 -- with the SCIL node (for an N_SCIL_Dispatching_Call node, this is
2281 -- the controlling type of the call; for an N_SCIL_Membership_Test node
2282 -- generated as part of testing membership in T'Class, this is T; for an
2283 -- N_SCIL_Dispatch_Table_Tag_Init node, this is the type being declared).
2285 -- SCIL_Controlling_Tag
2286 -- Present in N_SCIL_Dispatching_Call nodes. References the controlling
2287 -- tag of a dispatching call. This is usually an N_Selected_Component
2288 -- node (for a _tag component), but may be an N_Object_Declaration or
2289 -- N_Parameter_Specification node in some cases (e.g., for a call to
2290 -- a classwide streaming operation or a call to an instance of
2291 -- Ada.Tags.Generic_Dispatching_Constructor).
2293 -- SCIL_Tag_Value
2294 -- Present in N_SCIL_Membership_Test nodes. Used to reference the tag
2295 -- of the value that is being tested.
2297 -- SCIL_Target_Prim
2298 -- Present in N_SCIL_Dispatching_Call nodes. References the primitive
2299 -- operation named (statically) in a dispatching call.
2301 -- Scope
2302 -- Present in defining identifiers, defining character literals, and
2303 -- defining operator symbols (i.e. in all entities). The entities of a
2304 -- scope all use this field to reference the corresponding scope entity.
2305 -- See Einfo for further details.
2307 -- Shift_Count_OK
2308 -- A flag present in shift nodes to indicate that the shift count is
2309 -- known to be in range, i.e. is in the range from zero to word length
2310 -- minus one. If this flag is not set, then the shift count may be
2311 -- outside this range, i.e. larger than the word length, and the code
2312 -- must ensure that such shift counts give the appropriate result.
2314 -- Source_Type
2315 -- Used in an N_Validate_Unchecked_Conversion node to point to the
2316 -- source type entity for the unchecked conversion instantiation
2317 -- which gigi must do size validation for.
2319 -- Storage_Pool
2320 -- Present in N_Allocator, N_Free_Statement, N_Simple_Return_Statement,
2321 -- and N_Extended_Return_Statement nodes. References the entity for the
2322 -- storage pool to be used for the allocate or free call or for the
2323 -- allocation of the returned value from function. Empty indicates that
2324 -- the global default pool is to be used. Note that in the case
2325 -- of a return statement, this field is set only if the function returns
2326 -- value of a type whose size is not known at compile time on the
2327 -- secondary stack.
2329 -- Suppress_Assignment_Checks
2330 -- Used in generated N_Assignment_Statement nodes to suppress predicate
2331 -- and range checks in cases where the generated code knows that the
2332 -- value being assigned is in range and satisfies any predicate. Also
2333 -- can be set in N_Object_Declaration nodes, to similarly suppress any
2334 -- checks on the initializing value. In assignment statements it also
2335 -- suppresses access checks in the generated code for out- and in-out
2336 -- parameters in entry calls, as well as discriminant and length checks.
2338 -- Suppress_Loop_Warnings
2339 -- Used in N_Loop_Statement node to indicate that warnings within the
2340 -- body of the loop should be suppressed. This is set when the range
2341 -- of a FOR loop is known to be null, or is probably null (loop would
2342 -- only execute if invalid values are present).
2344 -- Target
2345 -- Present in call and variable reference marker nodes. References the
2346 -- entity of the original entity, operator, or subprogram being invoked,
2347 -- or the original variable being read or written.
2349 -- Target_Type
2350 -- Used in an N_Validate_Unchecked_Conversion node to point to the target
2351 -- type entity for the unchecked conversion instantiation which gigi must
2352 -- do size validation for.
2354 -- Then_Actions
2355 -- This field is present in if expression nodes. During code expansion
2356 -- we use the Insert_Actions procedure (in Exp_Util) to insert actions
2357 -- at an appropriate place in the tree to get elaborated at the right
2358 -- time. For if expressions, we have to be sure that the actions for
2359 -- for the Then branch are only elaborated if the condition is True.
2360 -- The Then_Actions field is used as a temporary parking place for
2361 -- these actions. The final tree is always rewritten to eliminate the
2362 -- need for this field, so in the tree passed to Gigi, this field is
2363 -- always set to No_List.
2365 -- TSS_Elist
2366 -- Present in N_Freeze_Entity nodes. Holds an element list containing
2367 -- entries for each TSS (type support subprogram) associated with the
2368 -- frozen type. The elements of the list are the entities for the
2369 -- subprograms (see package Exp_TSS for further details). Set to No_Elist
2370 -- if there are no type support subprograms for the type or if the freeze
2371 -- node is not for a type.
2373 -- Uneval_Old_Accept
2374 -- Present in N_Pragma nodes. Set True if Opt.Uneval_Old is set to 'A'
2375 -- (accept) at the point where the pragma is encountered (including the
2376 -- case of a pragma generated from an aspect specification). It is this
2377 -- setting that is relevant, rather than the setting at the point where
2378 -- a contract is finally analyzed after the delay till the freeze point.
2380 -- Uneval_Old_Warn
2381 -- Present in N_Pragma nodes. Set True if Opt.Uneval_Old is set to 'W'
2382 -- (warn) at the point where the pragma is encountered (including the
2383 -- case of a pragma generated from an aspect specification). It is this
2384 -- setting that is relevant, rather than the setting at the point where
2385 -- a contract is finally analyzed after the delay till the freeze point.
2387 -- Unreferenced_In_Spec
2388 -- Present in N_With_Clause nodes. Set if the with clause is on the
2389 -- package or subprogram spec where the main unit is the corresponding
2390 -- body, and is not referenced by the spec (it may still be referenced by
2391 -- the body, so this flag is used to generate the proper message (see
2392 -- Sem_Util.Check_Unused_Withs for details)
2394 -- Uninitialized_Variable
2395 -- Present in N_Formal_Private_Type_Definition and in N_Private_
2396 -- Extension_Declarations. Indicates that a variable in a generic unit
2397 -- whose type is a formal private or derived type is read without being
2398 -- initialized. Used to warn if the corresponding actual type is not
2399 -- a fully initialized type.
2401 -- Used_Operations
2402 -- Present in N_Use_Type_Clause nodes. Holds the list of operations that
2403 -- are made potentially use-visible by the clause. Simplifies processing
2404 -- on exit from the scope of the use_type_clause, in particular in the
2405 -- case of Use_All_Type, when those operations several scopes.
2407 -- Was_Attribute_Reference
2408 -- Present in N_Subprogram_Body. Set to True if the original source is an
2409 -- attribute reference which is an actual in a generic instantiation. The
2410 -- instantiation prologue renames these attributes, and expansion later
2411 -- converts them into subprogram bodies.
2413 -- Was_Expression_Function
2414 -- Present in N_Subprogram_Body. True if the original source had an
2415 -- N_Expression_Function, which was converted to the N_Subprogram_Body
2416 -- by Analyze_Expression_Function.
2418 -- Was_Originally_Stub
2419 -- This flag is set in the node for a proper body that replaces stub.
2420 -- During the analysis procedure, stubs in some situations get rewritten
2421 -- by the corresponding bodies, and we set this flag to remember that
2422 -- this happened. Note that it is not good enough to rely on the use of
2423 -- Original_Node here because of the case of nested instantiations where
2424 -- the substituted node can be copied.
2426 --------------------------------------------------
2427 -- Note on Use of End_Label and End_Span Fields --
2428 --------------------------------------------------
2430 -- Several constructs have end lines:
2432 -- Loop Statement end loop [loop_IDENTIFIER];
2433 -- Package Specification end [[PARENT_UNIT_NAME .] IDENTIFIER]
2434 -- Task Definition end [task_IDENTIFIER]
2435 -- Protected Definition end [protected_IDENTIFIER]
2436 -- Protected Body end [protected_IDENTIFIER]
2438 -- Block Statement end [block_IDENTIFIER];
2439 -- Subprogram Body end [DESIGNATOR];
2440 -- Package Body end [[PARENT_UNIT_NAME .] IDENTIFIER];
2441 -- Task Body end [task_IDENTIFIER];
2442 -- Accept Statement end [entry_IDENTIFIER]];
2443 -- Entry Body end [entry_IDENTIFIER];
2445 -- If Statement end if;
2446 -- Case Statement end case;
2448 -- Record Definition end record;
2449 -- Enumeration Definition );
2451 -- The End_Label and End_Span fields are used to mark the locations of
2452 -- these lines, and also keep track of the label in the case where a label
2453 -- is present.
2455 -- For the first group above, the End_Label field of the corresponding node
2456 -- is used to point to the label identifier. In the case where there is no
2457 -- label in the source, the parser supplies a dummy identifier (with
2458 -- Comes_From_Source set to False), and the Sloc of this dummy identifier
2459 -- marks the location of the token following the END token.
2461 -- For the second group, the use of End_Label is similar, but the End_Label
2462 -- is found in the N_Handled_Sequence_Of_Statements node. This is done
2463 -- simply because in some cases there is no room in the parent node.
2465 -- For the third group, there is never any label, and instead of using
2466 -- End_Label, we use the End_Span field which gives the location of the
2467 -- token following END, relative to the starting Sloc of the construct,
2468 -- i.e. add Sloc (Node) + End_Span (Node) to get the Sloc of the IF or CASE
2469 -- following the End_Label.
2471 -- The record definition case is handled specially, we treat it as though
2472 -- it required an optional label which is never present, and so the parser
2473 -- always builds a dummy identifier with Comes From Source set False. The
2474 -- reason we do this, rather than using End_Span in this case, is that we
2475 -- want to generate a cross-ref entry for the end of a record, since it
2476 -- represents a scope for name declaration purposes.
2478 -- The enumeration definition case is handled in an exactly similar manner,
2479 -- building a dummy identifier to get a cross-reference.
2481 -- Note: the reason we store the difference as a Uint, instead of storing
2482 -- the Source_Ptr value directly, is that Source_Ptr values cannot be
2483 -- distinguished from other types of values, and we count on all general
2484 -- use fields being self describing. To make things easier for clients,
2485 -- note that we provide function End_Location, and procedure
2486 -- Set_End_Location to allow access to the logical value (which is the
2487 -- Source_Ptr value for the end token).
2489 ---------------------
2490 -- Syntactic Nodes --
2491 ---------------------
2493 ---------------------
2494 -- 2.3 Identifier --
2495 ---------------------
2497 -- IDENTIFIER ::= IDENTIFIER_LETTER {[UNDERLINE] LETTER_OR_DIGIT}
2498 -- LETTER_OR_DIGIT ::= IDENTIFIER_LETTER | DIGIT
2500 -- An IDENTIFIER shall not be a reserved word
2502 -- In the Ada grammar identifiers are the bottom level tokens which have
2503 -- very few semantics. Actual program identifiers are direct names. If
2504 -- we were being 100% honest with the grammar, then we would have a node
2505 -- called N_Direct_Name which would point to an identifier. However,
2506 -- that's too many extra nodes, so we just use the N_Identifier node
2507 -- directly as a direct name, and it contains the expression fields and
2508 -- Entity field that correspond to its use as a direct name. In those
2509 -- few cases where identifiers appear in contexts where they are not
2510 -- direct names (pragmas, pragma argument associations, attribute
2511 -- references and attribute definition clauses), the Chars field of the
2512 -- node contains the Name_Id for the identifier name.
2514 -- Note: in GNAT, a reserved word can be treated as an identifier in two
2515 -- cases. First, an incorrect use of a reserved word as an identifier is
2516 -- diagnosed and then treated as a normal identifier. Second, an
2517 -- attribute designator of the form of a reserved word (access, delta,
2518 -- digits, range) is treated as an identifier.
2520 -- Note: The set of letters that is permitted in an identifier depends
2521 -- on the character set in use. See package Csets for full details.
2523 -- N_Identifier
2524 -- Sloc points to identifier
2525 -- Chars contains the Name_Id for the identifier
2526 -- Entity
2527 -- Associated_Node
2528 -- Original_Discriminant
2529 -- Is_Elaboration_Checks_OK_Node
2530 -- Is_SPARK_Mode_On_Node
2531 -- Is_Elaboration_Warnings_OK_Node
2532 -- Has_Private_View (set in generic units)
2533 -- Has_Secondary_Private_View (set in generic units)
2534 -- Redundant_Use
2535 -- Atomic_Sync_Required
2536 -- plus fields for expression
2538 --------------------------
2539 -- 2.4 Numeric Literal --
2540 --------------------------
2542 -- NUMERIC_LITERAL ::= DECIMAL_LITERAL | BASED_LITERAL
2544 ----------------------------
2545 -- 2.4.1 Decimal Literal --
2546 ----------------------------
2548 -- DECIMAL_LITERAL ::= NUMERAL [.NUMERAL] [EXPONENT]
2550 -- NUMERAL ::= DIGIT {[UNDERLINE] DIGIT}
2552 -- EXPONENT ::= E [+] NUMERAL | E - NUMERAL
2554 -- Decimal literals appear in the tree as either integer literal nodes
2555 -- or real literal nodes, depending on whether a period is present.
2557 -- Note: literal nodes appear as a result of direct use of literals
2558 -- in the source program, and also as the result of evaluating
2559 -- expressions at compile time. In the latter case, it is possible
2560 -- to construct real literals that have no syntactic representation
2561 -- using the standard literal format. Such literals are listed by
2562 -- Sprint using the notation [numerator / denominator].
2564 -- Note: the value of an integer literal node created by the front end
2565 -- is never outside the range of values of the base type. However, it
2566 -- can be the case that the created value is outside the range of the
2567 -- particular subtype. This happens in the case of integer overflows
2568 -- with checks suppressed.
2570 -- N_Integer_Literal
2571 -- Sloc points to literal
2572 -- Original_Entity If not Empty, holds Named_Number that
2573 -- has been constant-folded into its literal value.
2574 -- Intval contains integer value of literal
2575 -- Print_In_Hex
2576 -- plus fields for expression
2578 -- N_Real_Literal
2579 -- Sloc points to literal
2580 -- Original_Entity If not Empty, holds Named_Number that
2581 -- has been constant-folded into its literal value.
2582 -- Realval contains real value of literal
2583 -- Corresponding_Integer_Value
2584 -- Is_Machine_Number
2585 -- plus fields for expression
2587 --------------------------
2588 -- 2.4.2 Based Literal --
2589 --------------------------
2591 -- BASED_LITERAL ::=
2592 -- BASE # BASED_NUMERAL [.BASED_NUMERAL] # [EXPONENT]
2594 -- BASE ::= NUMERAL
2596 -- BASED_NUMERAL ::=
2597 -- EXTENDED_DIGIT {[UNDERLINE] EXTENDED_DIGIT}
2599 -- EXTENDED_DIGIT ::= DIGIT | A | B | C | D | E | F
2601 -- Based literals appear in the tree as either integer literal nodes
2602 -- or real literal nodes, depending on whether a period is present.
2604 ----------------------------
2605 -- 2.5 Character Literal --
2606 ----------------------------
2608 -- CHARACTER_LITERAL ::= ' GRAPHIC_CHARACTER '
2610 -- N_Character_Literal
2611 -- Sloc points to literal
2612 -- Chars contains the Name_Id for the identifier
2613 -- Char_Literal_Value contains the literal value
2614 -- Entity
2615 -- Associated_Node
2616 -- Has_Private_View (set in generic units)
2617 -- Has_Secondary_Private_View (set in generic units)
2618 -- plus fields for expression
2620 -- Note: the Entity field will be missing (set to Empty) for character
2621 -- literals whose type is Standard.Wide_Character or Standard.Character
2622 -- or a type derived from one of these two. In this case the character
2623 -- literal stands for its own coding. The reason we take this irregular
2624 -- short cut is to avoid the need to build lots of junk defining
2625 -- character literal nodes.
2627 -------------------------
2628 -- 2.6 String Literal --
2629 -------------------------
2631 -- STRING LITERAL ::= "{STRING_ELEMENT}"
2633 -- A STRING_ELEMENT is either a pair of quotation marks ("), or a
2634 -- single GRAPHIC_CHARACTER other than a quotation mark.
2636 -- Is_Folded_In_Parser is True if the parser created this literal by
2637 -- folding a sequence of "&" operators. For example, if the source code
2638 -- says "aaa" & "bbb" & "ccc", and this produces "aaabbbccc", the flag
2639 -- is set. This flag is needed because the parser doesn't know about
2640 -- visibility, so the folded result might be wrong, and semantic
2641 -- analysis needs to check for that.
2643 -- N_String_Literal
2644 -- Sloc points to literal
2645 -- Strval contains Id of string value
2646 -- Has_Wide_Character
2647 -- Has_Wide_Wide_Character
2648 -- Is_Folded_In_Parser
2649 -- plus fields for expression
2651 ---------------------------------------
2652 -- 2.6 Interpolated String Literal --
2653 ---------------------------------------
2655 -- INTERPOLATED_STRING_LITERAL ::=
2656 -- '{' "{INTERPOLATED_STRING_ELEMENT}" {
2657 -- "{INTERPOLATED_STRING_ELEMENT}" } '}'
2659 -- INTERPOLATED_STRING_ELEMENT ::=
2660 -- ESCAPED_CHARACTER | INTERPOLATED_EXPRESSION
2661 -- | non_quotation_mark_non_left_brace_GRAPHIC_CHARACTER
2663 -- ESCAPED_CHARACTER ::= '\GRAPHIC_CHARACTER'
2665 -- INTERPOLATED_EXPRESSION ::= '{' EXPRESSION '}'
2667 -- Most of these syntax rules are omitted as tree nodes to simplify
2668 -- semantic processing. The scanner handles escaped characters as part
2669 -- of processing an interpolated string literal, and the parser stores
2670 -- in the Expressions field of this node a list containing the sequence
2671 -- of string literals and the roots of the interpolated expressions.
2673 -- N_Interpolated_String_Literal
2674 -- Sloc points to literal
2675 -- Expressions
2676 -- plus fields for expression
2678 ------------------
2679 -- 2.7 Comment --
2680 ------------------
2682 -- A COMMENT starts with two adjacent hyphens and extends up to the
2683 -- end of the line. A COMMENT may appear on any line of a program.
2685 -- Comments are skipped by the scanner and do not appear in the tree.
2686 -- It is possible to reconstruct the position of comments with respect
2687 -- to the elements of the tree by using the source position (Sloc)
2688 -- pointers that appear in every tree node.
2690 -----------------
2691 -- 2.8 Pragma --
2692 -----------------
2694 -- PRAGMA ::= pragma IDENTIFIER
2695 -- [(PRAGMA_ARGUMENT_ASSOCIATION {, PRAGMA_ARGUMENT_ASSOCIATION})];
2697 -- Note that a pragma may appear in the tree anywhere a declaration
2698 -- or a statement may appear, as well as in some other situations
2699 -- which are explicitly documented.
2701 -- N_Pragma
2702 -- Sloc points to PRAGMA
2703 -- Next_Pragma
2704 -- Pragma_Argument_Associations (set to No_List if none)
2705 -- Corresponding_Aspect (set to Empty if not present)
2706 -- Pragma_Identifier
2707 -- Next_Rep_Item
2708 -- Is_Generic_Contract_Pragma
2709 -- Is_Checked_Ghost_Pragma
2710 -- Is_Inherited_Pragma
2711 -- Is_Analyzed_Pragma
2712 -- Class_Present set if from Aspect with 'Class
2713 -- Uneval_Old_Accept
2714 -- Is_Ignored_Ghost_Pragma
2715 -- Is_Ignored
2716 -- Is_Checked
2717 -- From_Aspect_Specification
2718 -- Is_Delayed_Aspect
2719 -- Is_Disabled
2720 -- Import_Interface_Present
2721 -- Uneval_Old_Warn
2723 -- Note: we should have a section on what pragmas are passed on to
2724 -- the back end to be processed. This section should note that pragma
2725 -- Psect_Object is always converted to Common_Object, but there are
2726 -- undoubtedly many other similar notes required ???
2728 -- Note: utility functions Pragma_Name_Unmapped and Pragma_Name may be
2729 -- applied to pragma nodes to obtain the Chars or its mapped version.
2731 -- Note: if From_Aspect_Specification is set, then Sloc points to the
2732 -- aspect name, as does the Pragma_Identifier. In this case if the
2733 -- pragma has a local name argument (such as pragma Inline), it is
2734 -- resolved to point to the specific entity affected by the pragma.
2736 --------------------------------------
2737 -- 2.8 Pragma Argument Association --
2738 --------------------------------------
2740 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
2741 -- [pragma_argument_IDENTIFIER =>] NAME
2742 -- | [pragma_argument_IDENTIFIER =>] EXPRESSION
2744 -- In Ada 2012, there are two more possibilities:
2746 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
2747 -- [pragma_argument_ASPECT_MARK =>] NAME
2748 -- | [pragma_argument_ASPECT_MARK =>] EXPRESSION
2750 -- where the interesting allowed cases (which do not fit the syntax of
2751 -- the first alternative above) are
2753 -- ASPECT_MARK => Pre'Class |
2754 -- Post'Class |
2755 -- Type_Invariant'Class |
2756 -- Invariant'Class
2758 -- We allow this special usage in all Ada modes, but it would be a
2759 -- pain to allow these aspects to pervade the pragma syntax, and the
2760 -- representation of pragma nodes internally. So what we do is to
2761 -- replace these ASPECT_MARK forms with identifiers whose name is one
2762 -- of the special internal names _Pre, _Post, or _Type_Invariant.
2764 -- We do a similar replacement of these Aspect_Mark forms in the
2765 -- Expression of a pragma argument association for the cases of
2766 -- the first arguments of any Check pragmas and Check_Policy pragmas
2768 -- N_Pragma_Argument_Association
2769 -- Sloc points to first token in association
2770 -- Chars (set to No_Name if no pragma argument identifier)
2771 -- Expression_Copy
2772 -- Expression
2774 ------------------------
2775 -- 2.9 Reserved Word --
2776 ------------------------
2778 -- Reserved words are parsed by the scanner, and returned as the
2779 -- corresponding token types (e.g. PACKAGE is returned as Tok_Package)
2781 ----------------------------
2782 -- 3.1 Basic Declaration --
2783 ----------------------------
2785 -- BASIC_DECLARATION ::=
2786 -- TYPE_DECLARATION | SUBTYPE_DECLARATION
2787 -- | OBJECT_DECLARATION | NUMBER_DECLARATION
2788 -- | SUBPROGRAM_DECLARATION | ABSTRACT_SUBPROGRAM_DECLARATION
2789 -- | PACKAGE_DECLARATION | RENAMING_DECLARATION
2790 -- | EXCEPTION_DECLARATION | GENERIC_DECLARATION
2791 -- | GENERIC_INSTANTIATION
2793 -- Basic declaration also includes IMPLICIT_LABEL_DECLARATION
2794 -- see further description in section on semantic nodes.
2796 -- Also, in the tree that is constructed, a pragma may appear
2797 -- anywhere that a declaration may appear.
2799 ------------------------------
2800 -- 3.1 Defining Identifier --
2801 ------------------------------
2803 -- DEFINING_IDENTIFIER ::= IDENTIFIER
2805 -- A defining identifier is an entity, which has additional fields
2806 -- depending on the setting of the Ekind field. These additional
2807 -- fields are defined (and access subprograms declared) in package
2808 -- Einfo.
2810 -- N_Defining_Identifier
2811 -- Sloc points to identifier
2812 -- Chars contains the Name_Id for the identifier
2813 -- Next_Entity
2814 -- Scope
2815 -- Etype
2817 -----------------------------
2818 -- 3.2.1 Type Declaration --
2819 -----------------------------
2821 -- TYPE_DECLARATION ::=
2822 -- FULL_TYPE_DECLARATION
2823 -- | INCOMPLETE_TYPE_DECLARATION
2824 -- | PRIVATE_TYPE_DECLARATION
2825 -- | PRIVATE_EXTENSION_DECLARATION
2827 ----------------------------------
2828 -- 3.2.1 Full Type Declaration --
2829 ----------------------------------
2831 -- FULL_TYPE_DECLARATION ::=
2832 -- type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
2833 -- is TYPE_DEFINITION
2834 -- [ASPECT_SPECIFICATIONS];
2835 -- | TASK_TYPE_DECLARATION
2836 -- | PROTECTED_TYPE_DECLARATION
2838 -- The full type declaration node is used only for the first case. The
2839 -- second case (concurrent type declaration), is represented directly
2840 -- by a task type declaration or a protected type declaration.
2842 -- N_Full_Type_Declaration
2843 -- Sloc points to TYPE
2844 -- Defining_Identifier
2845 -- Incomplete_View
2846 -- Discriminant_Specifications (set to No_List if none)
2847 -- Type_Definition
2848 -- Discr_Check_Funcs_Built
2850 ----------------------------
2851 -- 3.2.1 Type Definition --
2852 ----------------------------
2854 -- TYPE_DEFINITION ::=
2855 -- ENUMERATION_TYPE_DEFINITION | INTEGER_TYPE_DEFINITION
2856 -- | REAL_TYPE_DEFINITION | ARRAY_TYPE_DEFINITION
2857 -- | RECORD_TYPE_DEFINITION | ACCESS_TYPE_DEFINITION
2858 -- | DERIVED_TYPE_DEFINITION | INTERFACE_TYPE_DEFINITION
2860 --------------------------------
2861 -- 3.2.2 Subtype Declaration --
2862 --------------------------------
2864 -- SUBTYPE_DECLARATION ::=
2865 -- subtype DEFINING_IDENTIFIER is [NULL_EXCLUSION] SUBTYPE_INDICATION
2866 -- [ASPECT_SPECIFICATIONS];
2868 -- The subtype indication field is set to Empty for subtypes
2869 -- declared in package Standard (Positive, Natural).
2871 -- N_Subtype_Declaration
2872 -- Sloc points to SUBTYPE
2873 -- Defining_Identifier
2874 -- Null_Exclusion_Present
2875 -- Subtype_Indication
2876 -- Generic_Parent_Type (for actual of formal private or derived type)
2877 -- Exception_Junk
2879 -------------------------------
2880 -- 3.2.2 Subtype Indication --
2881 -------------------------------
2883 -- SUBTYPE_INDICATION ::= SUBTYPE_MARK [CONSTRAINT]
2885 -- Note: if no constraint is present, the subtype indication appears
2886 -- directly in the tree as a subtype mark. The N_Subtype_Indication
2887 -- node is used only if a constraint is present.
2889 -- Note: [For Ada 2005 (AI-231)]: Because Ada 2005 extends this rule
2890 -- with the null-exclusion part (see AI-231), we had to introduce a new
2891 -- attribute in all the parents of subtype_indication nodes to indicate
2892 -- if the null-exclusion is present.
2894 -- Note: the reason that this node has expression fields is that a
2895 -- subtype indication can appear as an operand of a membership test.
2897 -- N_Subtype_Indication
2898 -- Sloc points to first token of subtype mark
2899 -- Subtype_Mark
2900 -- Constraint
2901 -- Etype
2902 -- Must_Not_Freeze
2904 -- Note: Depending on context, the Etype is either the entity of the
2905 -- Subtype_Mark field, or it is an itype constructed to reify the
2906 -- subtype indication. In particular, such itypes are created for a
2907 -- subtype indication that appears in an array type declaration. This
2908 -- simplifies constraint checking in indexed components.
2910 -- For subtype indications that appear in scalar type and subtype
2911 -- declarations, the Etype is the entity of the subtype mark.
2913 -------------------------
2914 -- 3.2.2 Subtype Mark --
2915 -------------------------
2917 -- SUBTYPE_MARK ::= subtype_NAME
2919 -----------------------
2920 -- 3.2.2 Constraint --
2921 -----------------------
2923 -- CONSTRAINT ::= SCALAR_CONSTRAINT | COMPOSITE_CONSTRAINT
2925 ------------------------------
2926 -- 3.2.2 Scalar Constraint --
2927 ------------------------------
2929 -- SCALAR_CONSTRAINT ::=
2930 -- RANGE_CONSTRAINT | DIGITS_CONSTRAINT | DELTA_CONSTRAINT
2932 ---------------------------------
2933 -- 3.2.2 Composite Constraint --
2934 ---------------------------------
2936 -- COMPOSITE_CONSTRAINT ::=
2937 -- INDEX_CONSTRAINT | DISCRIMINANT_CONSTRAINT
2939 -------------------------------
2940 -- 3.3.1 Object Declaration --
2941 -------------------------------
2943 -- OBJECT_DECLARATION ::=
2944 -- DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2945 -- [NULL_EXCLUSION] SUBTYPE_INDICATION [:= EXPRESSION]
2946 -- [ASPECT_SPECIFICATIONS];
2947 -- | DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2948 -- ACCESS_DEFINITION [:= EXPRESSION]
2949 -- [ASPECT_SPECIFICATIONS];
2950 -- | DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2951 -- ARRAY_TYPE_DEFINITION [:= EXPRESSION]
2952 -- [ASPECT_SPECIFICATIONS];
2953 -- | SINGLE_TASK_DECLARATION
2954 -- | SINGLE_PROTECTED_DECLARATION
2956 -- Note: aliased is not permitted in Ada 83 mode
2958 -- The N_Object_Declaration node is only for the first three cases.
2959 -- Single task declaration is handled by P_Task (9.1)
2960 -- Single protected declaration is handled by P_protected (9.5)
2962 -- Although the syntax allows multiple identifiers in the list, the
2963 -- semantics is as though successive declarations were given with
2964 -- identical type definition and expression components. To simplify
2965 -- semantic processing, the parser represents a multiple declaration
2966 -- case as a sequence of single declarations, using the More_Ids and
2967 -- Prev_Ids flags to preserve the original source form as described
2968 -- in the section on "Handling of Defining Identifier Lists".
2970 -- The flag Has_Init_Expression is set if an initializing expression
2971 -- is present. Normally it is set if and only if Expression contains
2972 -- a non-empty value, but there is an exception to this. When the
2973 -- initializing expression is an aggregate which requires explicit
2974 -- assignments, the Expression field gets set to Empty, but this flag
2975 -- is still set, so we don't forget we had an initializing expression.
2977 -- Note: if a range check is required for the initialization
2978 -- expression then the Do_Range_Check flag is set in the Expression,
2979 -- with the check being done against the type given by the object
2980 -- definition, which is also the Etype of the defining identifier.
2982 -- Note: the contents of the Expression field must be ignored (i.e.
2983 -- treated as though it were Empty) if No_Initialization is set True.
2985 -- Note: the back end places some restrictions on the form of the
2986 -- Expression field. If the object being declared is Atomic, then
2987 -- the Expression may not have the form of an aggregate (since this
2988 -- might cause the back end to generate separate assignments). In this
2989 -- case the front end must generate an extra temporary and initialize
2990 -- this temporary as required (the temporary itself is not atomic).
2992 -- Note: there is no node kind for object definition. Instead, the
2993 -- corresponding field holds a subtype indication, an array type
2994 -- definition, or (Ada 2005, AI-406) an access definition.
2996 -- N_Object_Declaration
2997 -- Sloc points to first identifier
2998 -- Defining_Identifier
2999 -- Aliased_Present
3000 -- Constant_Present set if CONSTANT appears
3001 -- Null_Exclusion_Present
3002 -- Object_Definition subtype indic./array type def./access def.
3003 -- Expression (set to Empty if not present)
3004 -- Handler_List_Entry
3005 -- Corresponding_Generic_Association
3006 -- More_Ids (set to False if no more identifiers in list)
3007 -- Prev_Ids (set to False if no previous identifiers in list)
3008 -- No_Initialization
3009 -- Assignment_OK
3010 -- Exception_Junk
3011 -- Is_Subprogram_Descriptor
3012 -- Has_Init_Expression
3013 -- Suppress_Assignment_Checks
3015 -------------------------------------
3016 -- 3.3.1 Defining Identifier List --
3017 -------------------------------------
3019 -- DEFINING_IDENTIFIER_LIST ::=
3020 -- DEFINING_IDENTIFIER {, DEFINING_IDENTIFIER}
3022 -------------------------------
3023 -- 3.3.2 Number Declaration --
3024 -------------------------------
3026 -- NUMBER_DECLARATION ::=
3027 -- DEFINING_IDENTIFIER_LIST : constant := static_EXPRESSION;
3029 -- Although the syntax allows multiple identifiers in the list, the
3030 -- semantics is as though successive declarations were given with
3031 -- identical expressions. To simplify semantic processing, the parser
3032 -- represents a multiple declaration case as a sequence of single
3033 -- declarations, using the More_Ids and Prev_Ids flags to preserve
3034 -- the original source form as described in the section on "Handling
3035 -- of Defining Identifier Lists".
3037 -- N_Number_Declaration
3038 -- Sloc points to first identifier
3039 -- Defining_Identifier
3040 -- Expression
3041 -- More_Ids (set to False if no more identifiers in list)
3042 -- Prev_Ids (set to False if no previous identifiers in list)
3044 ----------------------------------
3045 -- 3.4 Derived Type Definition --
3046 ----------------------------------
3048 -- DERIVED_TYPE_DEFINITION ::=
3049 -- [abstract] [limited] new [NULL_EXCLUSION] parent_SUBTYPE_INDICATION
3050 -- [[and INTERFACE_LIST] RECORD_EXTENSION_PART]
3052 -- Note: ABSTRACT, LIMITED, and record extension part are not permitted
3053 -- in Ada 83 mode.
3055 -- Note: a record extension part is required if ABSTRACT is present
3057 -- N_Derived_Type_Definition
3058 -- Sloc points to NEW
3059 -- Abstract_Present
3060 -- Null_Exclusion_Present (set to False if not present)
3061 -- Subtype_Indication
3062 -- Record_Extension_Part (set to Empty if not present)
3063 -- Limited_Present
3064 -- Task_Present set in task interfaces
3065 -- Protected_Present set in protected interfaces
3066 -- Synchronized_Present set in interfaces
3067 -- Interface_List (set to No_List if none)
3068 -- Interface_Present set in abstract interfaces
3070 -- Note: Task_Present, Protected_Present, Synchronized_Present,
3071 -- Interface_List, and Interface_Present are used for abstract
3072 -- interfaces (see comments for INTERFACE_TYPE_DEFINITION).
3074 ---------------------------
3075 -- 3.5 Range Constraint --
3076 ---------------------------
3078 -- RANGE_CONSTRAINT ::= range RANGE
3080 -- N_Range_Constraint
3081 -- Sloc points to RANGE
3082 -- Range_Expression
3084 ----------------
3085 -- 3.5 Range --
3086 ----------------
3088 -- RANGE ::=
3089 -- RANGE_ATTRIBUTE_REFERENCE
3090 -- | SIMPLE_EXPRESSION .. SIMPLE_EXPRESSION
3092 -- Note: the case of a range given as a range attribute reference
3093 -- appears directly in the tree as an attribute reference.
3095 -- Note: the field name for a reference to a range is Range_Expression
3096 -- rather than Range, because range is a reserved keyword in Ada.
3098 -- Note: the reason that this node has expression fields is that a
3099 -- range can appear as an operand of a membership test. The Etype
3100 -- field is the type of the range (we do NOT construct an implicit
3101 -- subtype to represent the range exactly).
3103 -- N_Range
3104 -- Sloc points to ..
3105 -- Low_Bound
3106 -- High_Bound
3107 -- Cannot_Be_Superflat
3108 -- Includes_Infinities
3109 -- plus fields for expression
3111 -- Note: if the range appears in a context, such as a subtype
3112 -- declaration, where range checks are required on one or both of
3113 -- the expression fields, then type conversion nodes are inserted
3114 -- to represent the required checks.
3116 ----------------------------------------
3117 -- 3.5.1 Enumeration Type Definition --
3118 ----------------------------------------
3120 -- ENUMERATION_TYPE_DEFINITION ::=
3121 -- (ENUMERATION_LITERAL_SPECIFICATION
3122 -- {, ENUMERATION_LITERAL_SPECIFICATION})
3124 -- Note: the Literals field in the node described below is null for
3125 -- the case of the standard types CHARACTER and WIDE_CHARACTER, for
3126 -- which special processing handles these types as special cases.
3128 -- N_Enumeration_Type_Definition
3129 -- Sloc points to left parenthesis
3130 -- Literals (Empty for CHARACTER or WIDE_CHARACTER)
3131 -- End_Label (set to Empty if internally generated record)
3133 ----------------------------------------------
3134 -- 3.5.1 Enumeration Literal Specification --
3135 ----------------------------------------------
3137 -- ENUMERATION_LITERAL_SPECIFICATION ::=
3138 -- DEFINING_IDENTIFIER | DEFINING_CHARACTER_LITERAL
3140 ---------------------------------------
3141 -- 3.5.1 Defining Character Literal --
3142 ---------------------------------------
3144 -- DEFINING_CHARACTER_LITERAL ::= CHARACTER_LITERAL
3146 -- A defining character literal is an entity, which has additional
3147 -- fields depending on the setting of the Ekind field. These
3148 -- additional fields are defined (and access subprograms declared)
3149 -- in package Einfo.
3151 -- N_Defining_Character_Literal
3152 -- Sloc points to literal
3153 -- Chars contains the Name_Id for the identifier
3154 -- Next_Entity
3155 -- Scope
3156 -- Etype
3158 ------------------------------------
3159 -- 3.5.4 Integer Type Definition --
3160 ------------------------------------
3162 -- Note: there is an error in this rule in the latest version of the
3163 -- grammar, so we have retained the old rule pending clarification.
3165 -- INTEGER_TYPE_DEFINITION ::=
3166 -- SIGNED_INTEGER_TYPE_DEFINITION
3167 -- | MODULAR_TYPE_DEFINITION
3169 -------------------------------------------
3170 -- 3.5.4 Signed Integer Type Definition --
3171 -------------------------------------------
3173 -- SIGNED_INTEGER_TYPE_DEFINITION ::=
3174 -- range static_SIMPLE_EXPRESSION .. static_SIMPLE_EXPRESSION
3176 -- Note: the Low_Bound and High_Bound fields are set to Empty
3177 -- for integer types defined in package Standard.
3179 -- N_Signed_Integer_Type_Definition
3180 -- Sloc points to RANGE
3181 -- Low_Bound
3182 -- High_Bound
3184 ------------------------------------
3185 -- 3.5.4 Modular Type Definition --
3186 ------------------------------------
3188 -- MODULAR_TYPE_DEFINITION ::= mod static_EXPRESSION
3190 -- N_Modular_Type_Definition
3191 -- Sloc points to MOD
3192 -- Expression
3194 ---------------------------------
3195 -- 3.5.6 Real Type Definition --
3196 ---------------------------------
3198 -- REAL_TYPE_DEFINITION ::=
3199 -- FLOATING_POINT_DEFINITION | FIXED_POINT_DEFINITION
3201 --------------------------------------
3202 -- 3.5.7 Floating Point Definition --
3203 --------------------------------------
3205 -- FLOATING_POINT_DEFINITION ::=
3206 -- digits static_SIMPLE_EXPRESSION [REAL_RANGE_SPECIFICATION]
3208 -- Note: The Digits_Expression and Real_Range_Specifications fields
3209 -- are set to Empty for floating-point types declared in Standard.
3211 -- N_Floating_Point_Definition
3212 -- Sloc points to DIGITS
3213 -- Digits_Expression
3214 -- Real_Range_Specification (set to Empty if not present)
3216 -------------------------------------
3217 -- 3.5.7 Real Range Specification --
3218 -------------------------------------
3220 -- REAL_RANGE_SPECIFICATION ::=
3221 -- range static_SIMPLE_EXPRESSION .. static_SIMPLE_EXPRESSION
3223 -- N_Real_Range_Specification
3224 -- Sloc points to RANGE
3225 -- Low_Bound
3226 -- High_Bound
3228 -----------------------------------
3229 -- 3.5.9 Fixed Point Definition --
3230 -----------------------------------
3232 -- FIXED_POINT_DEFINITION ::=
3233 -- ORDINARY_FIXED_POINT_DEFINITION | DECIMAL_FIXED_POINT_DEFINITION
3235 --------------------------------------------
3236 -- 3.5.9 Ordinary Fixed Point Definition --
3237 --------------------------------------------
3239 -- ORDINARY_FIXED_POINT_DEFINITION ::=
3240 -- delta static_EXPRESSION REAL_RANGE_SPECIFICATION
3242 -- Note: In Ada 83, the EXPRESSION must be a SIMPLE_EXPRESSION
3244 -- N_Ordinary_Fixed_Point_Definition
3245 -- Sloc points to DELTA
3246 -- Delta_Expression
3247 -- Real_Range_Specification
3249 -------------------------------------------
3250 -- 3.5.9 Decimal Fixed Point Definition --
3251 -------------------------------------------
3253 -- DECIMAL_FIXED_POINT_DEFINITION ::=
3254 -- delta static_EXPRESSION
3255 -- digits static_EXPRESSION [REAL_RANGE_SPECIFICATION]
3257 -- Note: decimal types are not permitted in Ada 83 mode
3259 -- N_Decimal_Fixed_Point_Definition
3260 -- Sloc points to DELTA
3261 -- Delta_Expression
3262 -- Digits_Expression
3263 -- Real_Range_Specification (set to Empty if not present)
3265 ------------------------------
3266 -- 3.5.9 Digits Constraint --
3267 ------------------------------
3269 -- DIGITS_CONSTRAINT ::=
3270 -- digits static_EXPRESSION [RANGE_CONSTRAINT]
3272 -- Note: in Ada 83, the EXPRESSION must be a SIMPLE_EXPRESSION
3273 -- Note: in Ada 95, reduced accuracy subtypes are obsolescent
3275 -- N_Digits_Constraint
3276 -- Sloc points to DIGITS
3277 -- Digits_Expression
3278 -- Range_Constraint (set to Empty if not present)
3280 --------------------------------
3281 -- 3.6 Array Type Definition --
3282 --------------------------------
3284 -- ARRAY_TYPE_DEFINITION ::=
3285 -- UNCONSTRAINED_ARRAY_DEFINITION | CONSTRAINED_ARRAY_DEFINITION
3287 -----------------------------------------
3288 -- 3.6 Unconstrained Array Definition --
3289 -----------------------------------------
3291 -- UNCONSTRAINED_ARRAY_DEFINITION ::=
3292 -- array (INDEX_SUBTYPE_DEFINITION {, INDEX_SUBTYPE_DEFINITION}) of
3293 -- COMPONENT_DEFINITION
3295 -- Note: dimensionality of array is indicated by number of entries in
3296 -- the Subtype_Marks list, which has one entry for each dimension.
3298 -- N_Unconstrained_Array_Definition
3299 -- Sloc points to ARRAY
3300 -- Subtype_Marks
3301 -- Component_Definition
3303 -----------------------------------
3304 -- 3.6 Index Subtype Definition --
3305 -----------------------------------
3307 -- INDEX_SUBTYPE_DEFINITION ::= SUBTYPE_MARK range <>
3309 -- There is no explicit node in the tree for an index subtype
3310 -- definition since the N_Unconstrained_Array_Definition node
3311 -- incorporates the type marks which appear in this context.
3313 ---------------------------------------
3314 -- 3.6 Constrained Array Definition --
3315 ---------------------------------------
3317 -- CONSTRAINED_ARRAY_DEFINITION ::=
3318 -- array (DISCRETE_SUBTYPE_DEFINITION
3319 -- {, DISCRETE_SUBTYPE_DEFINITION})
3320 -- of COMPONENT_DEFINITION
3322 -- Note: dimensionality of array is indicated by number of entries
3323 -- in the Discrete_Subtype_Definitions list, which has one entry
3324 -- for each dimension.
3326 -- N_Constrained_Array_Definition
3327 -- Sloc points to ARRAY
3328 -- Discrete_Subtype_Definitions
3329 -- Component_Definition
3331 -- Note: although the language allows the full syntax for discrete
3332 -- subtype definitions (i.e. a discrete subtype indication or a range),
3333 -- in the generated tree, we always rewrite these as N_Range nodes.
3335 --------------------------------------
3336 -- 3.6 Discrete Subtype Definition --
3337 --------------------------------------
3339 -- DISCRETE_SUBTYPE_DEFINITION ::=
3340 -- discrete_SUBTYPE_INDICATION | RANGE
3342 -------------------------------
3343 -- 3.6 Component Definition --
3344 -------------------------------
3346 -- COMPONENT_DEFINITION ::=
3347 -- [aliased] [NULL_EXCLUSION] SUBTYPE_INDICATION | ACCESS_DEFINITION
3349 -- Note: although the syntax does not permit a component definition to
3350 -- be an anonymous array (and the parser will diagnose such an attempt
3351 -- with an appropriate message), it is possible for anonymous arrays
3352 -- to appear as component definitions. The semantics and back end handle
3353 -- this case properly, and the expander in fact generates such cases.
3354 -- Access_Definition is an optional field that gives support to
3355 -- Ada 2005 (AI-230). The parser generates nodes that have either the
3356 -- Subtype_Indication field or else the Access_Definition field.
3358 -- N_Component_Definition
3359 -- Sloc points to ALIASED, ACCESS, or to first token of subtype mark
3360 -- Aliased_Present
3361 -- Null_Exclusion_Present
3362 -- Subtype_Indication (set to Empty if not present)
3363 -- Access_Definition (set to Empty if not present)
3365 -----------------------------
3366 -- 3.6.1 Index Constraint --
3367 -----------------------------
3369 -- INDEX_CONSTRAINT ::= (DISCRETE_RANGE {, DISCRETE_RANGE})
3371 -- It is not in general possible to distinguish between discriminant
3372 -- constraints and index constraints at parse time, since a simple
3373 -- name could be either the subtype mark of a discrete range, or an
3374 -- expression in a discriminant association with no name. Either
3375 -- entry appears simply as the name, and the semantic parse must
3376 -- distinguish between the two cases. Thus we use a common tree
3377 -- node format for both of these constraint types.
3379 -- See Discriminant_Constraint for format of node
3381 ---------------------------
3382 -- 3.6.1 Discrete Range --
3383 ---------------------------
3385 -- DISCRETE_RANGE ::= discrete_SUBTYPE_INDICATION | RANGE
3387 ----------------------------
3388 -- 3.7 Discriminant Part --
3389 ----------------------------
3391 -- DISCRIMINANT_PART ::=
3392 -- UNKNOWN_DISCRIMINANT_PART | KNOWN_DISCRIMINANT_PART
3394 ------------------------------------
3395 -- 3.7 Unknown Discriminant Part --
3396 ------------------------------------
3398 -- UNKNOWN_DISCRIMINANT_PART ::= (<>)
3400 -- Note: unknown discriminant parts are not permitted in Ada 83 mode
3402 -- There is no explicit node in the tree for an unknown discriminant
3403 -- part. Instead the Unknown_Discriminants_Present flag is set in the
3404 -- parent node.
3406 ----------------------------------
3407 -- 3.7 Known Discriminant Part --
3408 ----------------------------------
3410 -- KNOWN_DISCRIMINANT_PART ::=
3411 -- (DISCRIMINANT_SPECIFICATION {; DISCRIMINANT_SPECIFICATION})
3413 -------------------------------------
3414 -- 3.7 Discriminant Specification --
3415 -------------------------------------
3417 -- DISCRIMINANT_SPECIFICATION ::=
3418 -- DEFINING_IDENTIFIER_LIST : [NULL_EXCLUSION] SUBTYPE_MARK
3419 -- [:= DEFAULT_EXPRESSION]
3420 -- | DEFINING_IDENTIFIER_LIST : ACCESS_DEFINITION
3421 -- [:= DEFAULT_EXPRESSION]
3423 -- Although the syntax allows multiple identifiers in the list, the
3424 -- semantics is as though successive specifications were given with
3425 -- identical type definition and expression components. To simplify
3426 -- semantic processing, the parser represents a multiple declaration
3427 -- case as a sequence of single specifications, using the More_Ids and
3428 -- Prev_Ids flags to preserve the original source form as described
3429 -- in the section on "Handling of Defining Identifier Lists".
3431 -- N_Discriminant_Specification
3432 -- Sloc points to first identifier
3433 -- Defining_Identifier
3434 -- Null_Exclusion_Present
3435 -- Discriminant_Type subtype mark or access parameter definition
3436 -- Expression (set to Empty if no default expression)
3437 -- More_Ids (set to False if no more identifiers in list)
3438 -- Prev_Ids (set to False if no previous identifiers in list)
3440 -----------------------------
3441 -- 3.7 Default Expression --
3442 -----------------------------
3444 -- DEFAULT_EXPRESSION ::= EXPRESSION
3446 ------------------------------------
3447 -- 3.7.1 Discriminant Constraint --
3448 ------------------------------------
3450 -- DISCRIMINANT_CONSTRAINT ::=
3451 -- (DISCRIMINANT_ASSOCIATION {, DISCRIMINANT_ASSOCIATION})
3453 -- It is not in general possible to distinguish between discriminant
3454 -- constraints and index constraints at parse time, since a simple
3455 -- name could be either the subtype mark of a discrete range, or an
3456 -- expression in a discriminant association with no name. Either
3457 -- entry appears simply as the name, and the semantic parse must
3458 -- distinguish between the two cases. Thus we use a common tree
3459 -- node format for both of these constraint types.
3461 -- N_Index_Or_Discriminant_Constraint
3462 -- Sloc points to left paren
3463 -- Constraints points to list of discrete ranges or
3464 -- discriminant associations
3466 -------------------------------------
3467 -- 3.7.1 Discriminant Association --
3468 -------------------------------------
3470 -- DISCRIMINANT_ASSOCIATION ::=
3471 -- [discriminant_SELECTOR_NAME
3472 -- {| discriminant_SELECTOR_NAME} =>] EXPRESSION
3474 -- Note: a discriminant association that has no selector name list
3475 -- appears directly as an expression in the tree.
3477 -- N_Discriminant_Association
3478 -- Sloc points to first token of discriminant association
3479 -- Selector_Names (always non-empty, since if no selector
3480 -- names are present, this node is not used, see comment above)
3481 -- Expression
3483 ---------------------------------
3484 -- 3.8 Record Type Definition --
3485 ---------------------------------
3487 -- RECORD_TYPE_DEFINITION ::=
3488 -- [[abstract] tagged] [limited] RECORD_DEFINITION
3490 -- Note: ABSTRACT, TAGGED, LIMITED are not permitted in Ada 83 mode
3492 -- There is no explicit node in the tree for a record type definition.
3493 -- Instead the flags for Tagged_Present and Limited_Present appear in
3494 -- the N_Record_Definition node for a record definition appearing in
3495 -- the context of a record type definition.
3497 ----------------------------
3498 -- 3.8 Record Definition --
3499 ----------------------------
3501 -- RECORD_DEFINITION ::=
3502 -- record
3503 -- COMPONENT_LIST
3504 -- end record
3505 -- | null record
3507 -- Note: the Abstract_Present, Tagged_Present, and Limited_Present
3508 -- flags appear only for a record definition appearing in a record
3509 -- type definition.
3511 -- Note: the NULL RECORD case is not permitted in Ada 83
3513 -- N_Record_Definition
3514 -- Sloc points to RECORD or NULL
3515 -- End_Label (set to Empty if internally generated record)
3516 -- Abstract_Present
3517 -- Tagged_Present
3518 -- Limited_Present
3519 -- Component_List empty in null record case
3520 -- Null_Present set in null record case
3521 -- Task_Present set in task interfaces
3522 -- Protected_Present set in protected interfaces
3523 -- Synchronized_Present set in interfaces
3524 -- Interface_Present set in abstract interfaces
3525 -- Interface_List (set to No_List if none)
3527 -- Note: Task_Present, Protected_Present, Synchronized _Present,
3528 -- Interface_List and Interface_Present are used for abstract
3529 -- interfaces (see comments for INTERFACE_TYPE_DEFINITION).
3531 -------------------------
3532 -- 3.8 Component List --
3533 -------------------------
3535 -- COMPONENT_LIST ::=
3536 -- COMPONENT_ITEM {COMPONENT_ITEM}
3537 -- | {COMPONENT_ITEM} VARIANT_PART
3538 -- | null;
3540 -- N_Component_List
3541 -- Sloc points to first token of component list
3542 -- Component_Items
3543 -- Variant_Part (set to Empty if no variant part)
3544 -- Null_Present
3546 -------------------------
3547 -- 3.8 Component Item --
3548 -------------------------
3550 -- COMPONENT_ITEM ::= COMPONENT_DECLARATION | REPRESENTATION_CLAUSE
3552 -- Note: A component item can also be a pragma, and in the tree
3553 -- that is obtained after semantic processing, a component item
3554 -- can be an N_Null node resulting from a non-recognized pragma.
3556 --------------------------------
3557 -- 3.8 Component Declaration --
3558 --------------------------------
3560 -- COMPONENT_DECLARATION ::=
3561 -- DEFINING_IDENTIFIER_LIST : COMPONENT_DEFINITION
3562 -- [:= DEFAULT_EXPRESSION]
3563 -- [ASPECT_SPECIFICATIONS];
3565 -- Note: although the syntax does not permit a component definition to
3566 -- be an anonymous array (and the parser will diagnose such an attempt
3567 -- with an appropriate message), it is possible for anonymous arrays
3568 -- to appear as component definitions. The semantics and back end handle
3569 -- this case properly, and the expander in fact generates such cases.
3571 -- Although the syntax allows multiple identifiers in the list, the
3572 -- semantics is as though successive declarations were given with the
3573 -- same component definition and expression components. To simplify
3574 -- semantic processing, the parser represents a multiple declaration
3575 -- case as a sequence of single declarations, using the More_Ids and
3576 -- Prev_Ids flags to preserve the original source form as described
3577 -- in the section on "Handling of Defining Identifier Lists".
3579 -- N_Component_Declaration
3580 -- Sloc points to first identifier
3581 -- Defining_Identifier
3582 -- Component_Definition
3583 -- Expression (set to Empty if no default expression)
3584 -- More_Ids (set to False if no more identifiers in list)
3585 -- Prev_Ids (set to False if no previous identifiers in list)
3587 -------------------------
3588 -- 3.8.1 Variant Part --
3589 -------------------------
3591 -- VARIANT_PART ::=
3592 -- case discriminant_DIRECT_NAME is
3593 -- VARIANT {VARIANT}
3594 -- end case;
3596 -- Note: the variants list can contain pragmas as well as variants.
3597 -- In a properly formed program there is at least one variant.
3599 -- N_Variant_Part
3600 -- Sloc points to CASE
3601 -- Name
3602 -- Variants
3604 --------------------
3605 -- 3.8.1 Variant --
3606 --------------------
3608 -- VARIANT ::=
3609 -- when DISCRETE_CHOICE_LIST =>
3610 -- COMPONENT_LIST
3612 -- N_Variant
3613 -- Sloc points to WHEN
3614 -- Discrete_Choices
3615 -- Component_List
3616 -- Enclosing_Variant
3617 -- Present_Expr
3618 -- Dcheck_Function
3619 -- Has_SP_Choice
3621 -- Note: in the list of Discrete_Choices, the tree passed to the back
3622 -- end does not have choice entries corresponding to names of statically
3623 -- predicated subtypes. Such entries are always expanded out to the list
3624 -- of equivalent values or ranges.
3626 ---------------------------------
3627 -- 3.8.1 Discrete Choice List --
3628 ---------------------------------
3630 -- DISCRETE_CHOICE_LIST ::= DISCRETE_CHOICE {| DISCRETE_CHOICE}
3632 ----------------------------
3633 -- 3.8.1 Discrete Choice --
3634 ----------------------------
3636 -- DISCRETE_CHOICE ::= EXPRESSION | DISCRETE_RANGE | others
3638 -- Note: in Ada 83 mode, the expression must be a simple expression
3640 -- The only choice that appears explicitly is the OTHERS choice, as
3641 -- defined here. Other cases of discrete choice (expression and
3642 -- discrete range) appear directly. N_Others_Choice is also used
3643 -- in exception handlers and generic formal packages.
3645 -- Note: in accordance with the syntax, the parser does not check that
3646 -- OTHERS appears at the end on its own in a choice list context. This
3647 -- is a semantic check.
3649 -- N_Others_Choice
3650 -- Sloc points to OTHERS
3651 -- Others_Discrete_Choices
3652 -- All_Others
3654 ----------------------------------
3655 -- 3.9.1 Record Extension Part --
3656 ----------------------------------
3658 -- RECORD_EXTENSION_PART ::= with RECORD_DEFINITION
3660 -- Note: record extension parts are not permitted in Ada 83 mode
3662 --------------------------------------
3663 -- 3.9.4 Interface Type Definition --
3664 --------------------------------------
3666 -- INTERFACE_TYPE_DEFINITION ::=
3667 -- [limited | task | protected | synchronized]
3668 -- interface [interface_list]
3670 -- Note: Interfaces are implemented with N_Record_Definition and
3671 -- N_Derived_Type_Definition nodes because most of the support
3672 -- for the analysis of abstract types has been reused to
3673 -- analyze abstract interfaces.
3675 ----------------------------------
3676 -- 3.10 Access Type Definition --
3677 ----------------------------------
3679 -- ACCESS_TYPE_DEFINITION ::=
3680 -- ACCESS_TO_OBJECT_DEFINITION
3681 -- | ACCESS_TO_SUBPROGRAM_DEFINITION
3683 --------------------------
3684 -- 3.10 Null Exclusion --
3685 --------------------------
3687 -- NULL_EXCLUSION ::= not null
3689 ---------------------------------------
3690 -- 3.10 Access To Object Definition --
3691 ---------------------------------------
3693 -- ACCESS_TO_OBJECT_DEFINITION ::=
3694 -- [NULL_EXCLUSION] access [GENERAL_ACCESS_MODIFIER]
3695 -- SUBTYPE_INDICATION
3697 -- N_Access_To_Object_Definition
3698 -- Sloc points to ACCESS
3699 -- All_Present
3700 -- Null_Exclusion_Present
3701 -- Null_Excluding_Subtype
3702 -- Subtype_Indication
3703 -- Constant_Present
3705 -----------------------------------
3706 -- 3.10 General Access Modifier --
3707 -----------------------------------
3709 -- GENERAL_ACCESS_MODIFIER ::= all | constant
3711 -- Note: general access modifiers are not permitted in Ada 83 mode
3713 -- There is no explicit node in the tree for general access modifier.
3714 -- Instead the All_Present or Constant_Present flags are set in the
3715 -- parent node.
3717 -------------------------------------------
3718 -- 3.10 Access To Subprogram Definition --
3719 -------------------------------------------
3721 -- ACCESS_TO_SUBPROGRAM_DEFINITION
3722 -- [NULL_EXCLUSION] access [protected] procedure PARAMETER_PROFILE
3723 -- | [NULL_EXCLUSION] access [protected] function
3724 -- PARAMETER_AND_RESULT_PROFILE
3726 -- Note: access to subprograms are not permitted in Ada 83 mode
3728 -- N_Access_Function_Definition
3729 -- Sloc points to ACCESS
3730 -- Null_Exclusion_Present
3731 -- Null_Exclusion_In_Return_Present
3732 -- Protected_Present
3733 -- Parameter_Specifications (set to No_List if no formal part)
3734 -- Result_Definition result subtype (subtype mark or access def)
3736 -- N_Access_Procedure_Definition
3737 -- Sloc points to ACCESS
3738 -- Null_Exclusion_Present
3739 -- Protected_Present
3740 -- Parameter_Specifications (set to No_List if no formal part)
3742 -----------------------------
3743 -- 3.10 Access Definition --
3744 -----------------------------
3746 -- ACCESS_DEFINITION ::=
3747 -- [NULL_EXCLUSION] access [GENERAL_ACCESS_MODIFIER] SUBTYPE_MARK
3748 -- | ACCESS_TO_SUBPROGRAM_DEFINITION
3750 -- Note: access to subprograms are an Ada 2005 (AI-254) extension
3752 -- N_Access_Definition
3753 -- Sloc points to ACCESS
3754 -- Null_Exclusion_Present
3755 -- All_Present
3756 -- Constant_Present
3757 -- Subtype_Mark
3758 -- Access_To_Subprogram_Definition (set to Empty if not present)
3760 -----------------------------------------
3761 -- 3.10.1 Incomplete Type Declaration --
3762 -----------------------------------------
3764 -- INCOMPLETE_TYPE_DECLARATION ::=
3765 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART] [IS TAGGED];
3767 -- N_Incomplete_Type_Declaration
3768 -- Sloc points to TYPE
3769 -- Defining_Identifier
3770 -- Discriminant_Specifications (set to No_List if no
3771 -- discriminant part, or if the discriminant part is an
3772 -- unknown discriminant part)
3773 -- Premature_Use used for improved diagnostics.
3774 -- Unknown_Discriminants_Present set if (<>) discriminant
3775 -- Tagged_Present
3777 ----------------------------
3778 -- 3.11 Declarative Part --
3779 ----------------------------
3781 -- DECLARATIVE_PART ::= {DECLARATIVE_ITEM}
3783 -- Note: although the parser enforces the syntactic requirement that
3784 -- a declarative part can contain only declarations, the semantic
3785 -- processing may add statements to the list of actions in a
3786 -- declarative part, so the code generator should be prepared
3787 -- to accept a statement in this position.
3789 ----------------------------
3790 -- 3.11 Declarative Item --
3791 ----------------------------
3793 -- DECLARATIVE_ITEM ::= BASIC_DECLARATIVE_ITEM | BODY
3795 ----------------------------------
3796 -- 3.11 Basic Declarative Item --
3797 ----------------------------------
3799 -- BASIC_DECLARATIVE_ITEM ::=
3800 -- BASIC_DECLARATION | REPRESENTATION_CLAUSE | USE_CLAUSE
3802 ----------------
3803 -- 3.11 Body --
3804 ----------------
3806 -- BODY ::= PROPER_BODY | BODY_STUB
3808 -----------------------
3809 -- 3.11 Proper Body --
3810 -----------------------
3812 -- PROPER_BODY ::=
3813 -- SUBPROGRAM_BODY | PACKAGE_BODY | TASK_BODY | PROTECTED_BODY
3815 ---------------
3816 -- 4.1 Name --
3817 ---------------
3819 -- NAME ::=
3820 -- DIRECT_NAME | EXPLICIT_DEREFERENCE
3821 -- | INDEXED_COMPONENT | SLICE
3822 -- | SELECTED_COMPONENT | ATTRIBUTE_REFERENCE
3823 -- | TYPE_CONVERSION | FUNCTION_CALL
3824 -- | CHARACTER_LITERAL
3826 ----------------------
3827 -- 4.1 Direct Name --
3828 ----------------------
3830 -- DIRECT_NAME ::= IDENTIFIER | OPERATOR_SYMBOL
3832 -----------------
3833 -- 4.1 Prefix --
3834 -----------------
3836 -- PREFIX ::= NAME | IMPLICIT_DEREFERENCE
3838 -------------------------------
3839 -- 4.1 Explicit Dereference --
3840 -------------------------------
3842 -- EXPLICIT_DEREFERENCE ::= NAME . all
3844 -- N_Explicit_Dereference
3845 -- Sloc points to ALL
3846 -- Prefix
3847 -- Actual_Designated_Subtype
3848 -- Has_Dereference_Action
3849 -- Atomic_Sync_Required
3850 -- plus fields for expression
3852 -------------------------------
3853 -- 4.1 Implicit Dereference --
3854 -------------------------------
3856 -- IMPLICIT_DEREFERENCE ::= NAME
3858 ------------------------------
3859 -- 4.1.1 Indexed Component --
3860 ------------------------------
3862 -- INDEXED_COMPONENT ::= PREFIX (EXPRESSION {, EXPRESSION})
3864 -- Note: the parser may generate this node in some situations where it
3865 -- should be a function call. The semantic pass must correct this
3866 -- misidentification (which is inevitable at the parser level).
3868 -- N_Indexed_Component
3869 -- Sloc contains a copy of the Sloc value of the Prefix
3870 -- Prefix
3871 -- Expressions
3872 -- Generalized_Indexing
3873 -- Atomic_Sync_Required
3874 -- plus fields for expression
3876 -- Note: if any of the subscripts requires a range check, then the
3877 -- Do_Range_Check flag is set on the corresponding expression, with
3878 -- the index type being determined from the type of the Prefix, which
3879 -- references the array being indexed.
3881 -- Note: in a fully analyzed and expanded indexed component node, and
3882 -- hence in any such node that gigi sees, if the prefix is an access
3883 -- type, then an explicit dereference operation has been inserted.
3885 ------------------
3886 -- 4.1.2 Slice --
3887 ------------------
3889 -- SLICE ::= PREFIX (DISCRETE_RANGE)
3891 -- Note: an implicit subtype is created to describe the resulting
3892 -- type, so that the bounds of this type are the bounds of the slice.
3894 -- N_Slice
3895 -- Sloc points to first token of prefix
3896 -- Prefix
3897 -- Discrete_Range
3898 -- plus fields for expression
3900 -------------------------------
3901 -- 4.1.3 Selected Component --
3902 -------------------------------
3904 -- SELECTED_COMPONENT ::= PREFIX . SELECTOR_NAME
3906 -- Note: selected components that are semantically expanded names get
3907 -- changed during semantic processing into the separate N_Expanded_Name
3908 -- node. See description of this node in the section on semantic nodes.
3910 -- N_Selected_Component
3911 -- Sloc points to the period
3912 -- Prefix
3913 -- Selector_Name
3914 -- Associated_Node
3915 -- Do_Discriminant_Check
3916 -- Is_In_Discriminant_Check
3917 -- Atomic_Sync_Required
3918 -- Is_Prefixed_Call
3919 -- plus fields for expression
3921 --------------------------
3922 -- 4.1.3 Selector Name --
3923 --------------------------
3925 -- SELECTOR_NAME ::= IDENTIFIER | CHARACTER_LITERAL | OPERATOR_SYMBOL
3927 --------------------------------
3928 -- 4.1.4 Attribute Reference --
3929 --------------------------------
3931 -- ATTRIBUTE_REFERENCE ::= PREFIX ' ATTRIBUTE_DESIGNATOR
3933 -- Note: the syntax is quite ambiguous at this point. Consider:
3935 -- A'Length (X) X is part of the attribute designator
3936 -- A'Pos (X) X is an explicit actual parameter of function A'Pos
3937 -- A'Class (X) X is the expression of a type conversion
3939 -- It would be possible for the parser to distinguish these cases
3940 -- by looking at the attribute identifier. However, that would mean
3941 -- more work in introducing new implementation defined attributes,
3942 -- and also it would mean that special processing for attributes
3943 -- would be scattered around, instead of being centralized in the
3944 -- semantic routine that handles an N_Attribute_Reference node.
3945 -- Consequently, the parser in all the above cases stores the
3946 -- expression (X in these examples) as a single element list in
3947 -- in the Expressions field of the N_Attribute_Reference node.
3949 -- Similarly, for attributes like Max which take two arguments,
3950 -- we store the two arguments as a two element list in the
3951 -- Expressions field. Of course it is clear at parse time that
3952 -- this case is really a function call with an attribute as the
3953 -- prefix, but it turns out to be convenient to handle the two
3954 -- argument case in a similar manner to the one argument case,
3955 -- and indeed in general the parser will accept any number of
3956 -- expressions in this position and store them as a list in the
3957 -- attribute reference node. This allows for future addition of
3958 -- attributes that take more than two arguments.
3960 -- Note: named associates are not permitted in function calls where
3961 -- the function is an attribute (see RM 6.4(3)) so it is legitimate
3962 -- to skip the normal subprogram argument processing.
3964 -- Note: for the attributes whose designators are technically keywords,
3965 -- i.e. digits, access, delta, range, the Attribute_Name field contains
3966 -- the corresponding name, even though no identifier is involved.
3968 -- Note: the generated code may contain stream attributes applied to
3969 -- limited types for which no stream routines exist officially. In such
3970 -- case, the result is to use the stream attribute for the underlying
3971 -- full type, or in the case of a protected type, the components
3972 -- (including any discriminants) are merely streamed in order.
3974 -- See Exp_Attr for a complete description of which attributes are
3975 -- passed onto Gigi, and which are handled entirely by the front end.
3977 -- Gigi restriction: For the Pos attribute, the prefix cannot be
3978 -- a non-standard enumeration type or a nonzero/zero semantics
3979 -- boolean type, so the value is simply the stored representation.
3981 -- Gigi requirement: For the Mechanism_Code attribute, if the prefix
3982 -- references a subprogram that is a renaming, then the front end must
3983 -- rewrite the attribute to refer directly to the renamed entity.
3985 -- Note: syntactically the prefix of an attribute reference must be a
3986 -- name, and this (somewhat artificial) requirement is enforced by the
3987 -- parser. However, for many attributes, such as 'Valid, it is quite
3988 -- reasonable to apply the attribute to any value, and hence to any
3989 -- expression. Internally in the tree, the prefix is an expression which
3990 -- does not have to be a name, and this is handled fine by the semantic
3991 -- analysis and expansion, and back ends. This arises for the case of
3992 -- attribute references built by the expander (e.g. 'Valid for the case
3993 -- of an implicit validity check).
3995 -- Note: In generated code, the Address and Unrestricted_Access
3996 -- attributes can be applied to any expression, and the meaning is
3997 -- to create an object containing the value (the object is in the
3998 -- current stack frame), and pass the address of this value. If the
3999 -- Must_Be_Byte_Aligned flag is set, then the object whose address
4000 -- is taken must be on a byte (storage unit) boundary, and if it is
4001 -- not (or may not be), then the generated code must create a copy
4002 -- that is byte aligned, and pass the address of this copy.
4004 -- N_Attribute_Reference
4005 -- Sloc points to apostrophe
4006 -- Prefix (general expression, see note above)
4007 -- Attribute_Name identifier name from attribute designator
4008 -- Expressions (set to No_List if no associated expressions)
4009 -- Entity used if the attribute yields a type
4010 -- Associated_Node
4011 -- Is_Elaboration_Checks_OK_Node
4012 -- Is_SPARK_Mode_On_Node
4013 -- Is_Elaboration_Warnings_OK_Node
4014 -- Header_Size_Added
4015 -- Redundant_Use
4016 -- Must_Be_Byte_Aligned
4017 -- plus fields for expression
4019 -- Note: in Modify_Tree_For_C mode, Max and Min attributes are expanded
4020 -- into equivalent if expressions, properly taking care of side effects.
4022 ---------------------------------
4023 -- 4.1.4 Attribute Designator --
4024 ---------------------------------
4026 -- ATTRIBUTE_DESIGNATOR ::=
4027 -- IDENTIFIER [(static_EXPRESSION)]
4028 -- | access | delta | digits
4030 -- There is no explicit node in the tree for an attribute designator.
4031 -- Instead the Attribute_Name and Expressions fields of the parent
4032 -- node (N_Attribute_Reference node) hold the information.
4034 -- Note: if ACCESS, DELTA, or DIGITS appears in an attribute
4035 -- designator, then they are treated as identifiers internally
4036 -- rather than the keywords of the same name.
4038 --------------------------------------
4039 -- 4.1.4 Range Attribute Reference --
4040 --------------------------------------
4042 -- RANGE_ATTRIBUTE_REFERENCE ::= PREFIX ' RANGE_ATTRIBUTE_DESIGNATOR
4044 -- A range attribute reference is represented in the tree using the
4045 -- normal N_Attribute_Reference node.
4047 ---------------------------------------
4048 -- 4.1.4 Range Attribute Designator --
4049 ---------------------------------------
4051 -- RANGE_ATTRIBUTE_DESIGNATOR ::= Range [(static_EXPRESSION)]
4053 -- A range attribute designator is represented in the tree using the
4054 -- normal N_Attribute_Reference node.
4056 --------------------
4057 -- 4.3 Aggregate --
4058 --------------------
4060 -- AGGREGATE ::=
4061 -- RECORD_AGGREGATE | EXTENSION_AGGREGATE | ARRAY_AGGREGATE
4063 -----------------------------
4064 -- 4.3.1 Record Aggregate --
4065 -----------------------------
4067 -- RECORD_AGGREGATE ::= (RECORD_COMPONENT_ASSOCIATION_LIST)
4069 -- N_Aggregate
4070 -- Sloc points to left parenthesis
4071 -- Expressions (set to No_List if none or null record case)
4072 -- Component_Associations (set to No_List if none)
4073 -- Null_Record_Present
4074 -- Aggregate_Bounds (array) or Ancestor_Type (record)
4075 -- Associated_Node
4076 -- Compile_Time_Known_Aggregate
4077 -- Expansion_Delayed
4078 -- Has_Self_Reference
4079 -- Is_Homogeneous_Aggregate
4080 -- Is_Parenthesis_Aggregate
4081 -- plus fields for expression
4083 -- Note: this structure is used for both record and array aggregates
4084 -- since the two cases are not separable by the parser. The parser
4085 -- makes no attempt to enforce consistency here, so it is up to the
4086 -- semantic phase to make sure that the aggregate is consistent (i.e.
4087 -- that it is not a "half-and-half" case that mixes record and array
4088 -- syntax). In particular, for a record aggregate, the expressions
4089 -- field will be set if there are positional associations.
4091 -- Note: N_Aggregate is not used for all aggregates; in particular,
4092 -- there is a separate node kind for extension aggregates.
4094 -- Note: gigi/gcc can handle array aggregates correctly providing that
4095 -- they are entirely positional, and the array subtype involved has a
4096 -- known at compile time length and is not bit packed, or a convention
4097 -- Fortran array with more than one dimension. If these conditions
4098 -- are not met, then the front end must translate the aggregate into
4099 -- an appropriate set of assignments into a temporary.
4101 -- Note: for the record aggregate case, gigi/gcc can handle most cases
4102 -- of record aggregates, including those for packed, and rep-claused
4103 -- records, and also variant records, providing that there are no
4104 -- variable length fields whose size is not known at compile time,
4105 -- and providing that the aggregate is presented in fully named form.
4107 -- The other situation in which array aggregates and record aggregates
4108 -- cannot be passed to the back end is if assignment to one or more
4109 -- components itself needs expansion, e.g. in the case of an assignment
4110 -- of an object of a controlled type. In such cases, the front end
4111 -- must expand the aggregate to a series of assignments, and apply
4112 -- the required expansion to the individual assignment statements.
4114 ----------------------------------------------
4115 -- 4.3.1 Record Component Association List --
4116 ----------------------------------------------
4118 -- RECORD_COMPONENT_ASSOCIATION_LIST ::=
4119 -- RECORD_COMPONENT_ASSOCIATION {, RECORD_COMPONENT_ASSOCIATION}
4120 -- | null record
4122 -- There is no explicit node in the tree for a record component
4123 -- association list. Instead the Null_Record_Present flag is set in
4124 -- the parent node for the NULL RECORD case.
4126 ------------------------------------------------------
4127 -- 4.3.1 Record Component Association (also 4.3.3) --
4128 ------------------------------------------------------
4130 -- RECORD_COMPONENT_ASSOCIATION ::=
4131 -- [COMPONENT_CHOICE_LIST =>] EXPRESSION
4133 -- N_Component_Association
4134 -- Sloc points to first selector name
4135 -- Choices
4136 -- Expression (empty if Box_Present)
4137 -- Loop_Actions
4138 -- Box_Present
4139 -- Inherited_Discriminant
4140 -- Binding_Chars
4142 -- Note: this structure is used for both record component associations
4143 -- and array component associations, since the two cases aren't always
4144 -- separable by the parser. The choices list may represent either a
4145 -- list of selector names in the record aggregate case, or a list of
4146 -- discrete choices in the array aggregate case or an N_Others_Choice
4147 -- node (which appears as a singleton list). Box_Present gives support
4148 -- to Ada 2005 (AI-287). Binding_Chars is only set if GNAT extensions
4149 -- are enabled and the given component association occurs within a
4150 -- choice_expression; in this case, it is the Name_Id, if any, specified
4151 -- via either of two syntactic forms: "Foo => Bar is Abc" or
4152 -- "Foo => <Abc>".
4154 ----------------------------------
4155 -- 4.3.1 Component Choice List --
4156 ----------------------------------
4158 -- COMPONENT_CHOICE_LIST ::=
4159 -- component_SELECTOR_NAME {| component_SELECTOR_NAME}
4160 -- | others
4162 -- The entries of a component choice list appear in the Choices list of
4163 -- the associated N_Component_Association, as either selector names, or
4164 -- as an N_Others_Choice node.
4166 --------------------------------
4167 -- 4.3.2 Extension Aggregate --
4168 --------------------------------
4170 -- EXTENSION_AGGREGATE ::=
4171 -- (ANCESTOR_PART with RECORD_COMPONENT_ASSOCIATION_LIST)
4173 -- Note: extension aggregates are not permitted in Ada 83 mode
4175 -- N_Extension_Aggregate
4176 -- Sloc points to left parenthesis
4177 -- Ancestor_Part
4178 -- Associated_Node
4179 -- Expressions (set to No_List if none or null record case)
4180 -- Component_Associations (set to No_List if none)
4181 -- Null_Record_Present
4182 -- Expansion_Delayed
4183 -- Has_Self_Reference
4184 -- plus fields for expression
4186 --------------------------
4187 -- 4.3.2 Ancestor Part --
4188 --------------------------
4190 -- ANCESTOR_PART ::= EXPRESSION | SUBTYPE_MARK
4192 ----------------------------
4193 -- 4.3.3 Array Aggregate --
4194 ----------------------------
4196 -- ARRAY_AGGREGATE ::=
4197 -- POSITIONAL_ARRAY_AGGREGATE | NAMED_ARRAY_AGGREGATE
4199 ---------------------------------------
4200 -- 4.3.3 Positional Array Aggregate --
4201 ---------------------------------------
4203 -- POSITIONAL_ARRAY_AGGREGATE ::=
4204 -- (EXPRESSION, EXPRESSION {, EXPRESSION})
4205 -- | (EXPRESSION {, EXPRESSION}, others => EXPRESSION)
4207 -- See Record_Aggregate (4.3.1) for node structure
4209 ----------------------------------
4210 -- 4.3.3 Named Array Aggregate --
4211 ----------------------------------
4213 -- NAMED_ARRAY_AGGREGATE ::=
4214 -- (ARRAY_COMPONENT_ASSOCIATION {, ARRAY_COMPONENT_ASSOCIATION})
4216 -- See Record_Aggregate (4.3.1) for node structure
4218 ----------------------------------------
4219 -- 4.3.3 Array Component Association --
4220 ----------------------------------------
4222 -- ARRAY_COMPONENT_ASSOCIATION ::=
4223 -- DISCRETE_CHOICE_LIST => EXPRESSION
4224 -- | ITERATED_COMPONENT_ASSOCIATION
4226 -- See Record_Component_Association (4.3.1) for node structure
4227 -- The iterated_component_association is introduced into the
4228 -- Corrigendum of Ada_2012 by AI12-061.
4230 ------------------------------------------
4231 -- 4.3.3 Iterated component Association --
4232 ------------------------------------------
4234 -- ITERATED_COMPONENT_ASSOCIATION ::=
4235 -- for DEFINING_IDENTIFIER in DISCRETE_CHOICE_LIST => EXPRESSION
4236 -- for ITERATOR_SPECIFICATION => EXPRESSION
4238 -- At most one of (Defining_Identifier, Iterator_Specification)
4239 -- is present at a time, in which case the other one is empty.
4241 -- N_Iterated_Component_Association
4242 -- Sloc points to FOR
4243 -- Defining_Identifier
4244 -- Iterator_Specification
4245 -- Expression
4246 -- Discrete_Choices
4247 -- Loop_Actions
4248 -- Box_Present
4250 -- Note that Box_Present is always False, but it is intentionally added
4251 -- for completeness.
4253 ----------------------------
4254 -- 4.3.4 Delta Aggregate --
4255 ----------------------------
4257 -- N_Delta_Aggregate
4258 -- Sloc points to left parenthesis
4259 -- Expression
4260 -- Component_Associations
4261 -- Etype
4263 ---------------------------------
4264 -- 4.3.5 Container_Aggregates --
4265 ---------------------------------
4267 -- ITERATED_ELEMENT_ASSOCIATION ::=
4268 -- for LOOP_PARAMETER_SPECIFICATION[ use KEY_EXPRESSION] => EXPRESSION
4269 -- | for ITERATOR_SPECIFICATION[ use KEY_EXPRESSION] => EXPRESSION
4271 -- N_Iterated_Element_Association
4272 -- Key_Expression
4273 -- Iterator_Specification
4274 -- Expression
4275 -- Loop_Parameter_Specification
4276 -- Loop_Actions
4277 -- Box_Present
4279 -- Exactly one of Iterator_Specification or Loop_Parameter_
4280 -- specification is present. If the Key_Expression is absent,
4281 -- the construct is parsed as an Iterated_Component_Association,
4282 -- and legality checks are performed during semantic analysis.
4284 -- Both iterated associations are Ada 2022 features that are
4285 -- expanded during aggregate construction, and do not appear in
4286 -- expanded code.
4288 --------------------------------------------------
4289 -- 4.4 Expression/Relation/Term/Factor/Primary --
4290 --------------------------------------------------
4292 -- EXPRESSION ::=
4293 -- RELATION {LOGICAL_OPERATOR RELATION}
4295 -- CHOICE_EXPRESSION ::=
4296 -- CHOICE_RELATION {LOGICAL_OPERATOR CHOICE_RELATION}
4298 -- CHOICE_RELATION ::=
4299 -- SIMPLE_EXPRESSION [RELATIONAL_OPERATOR SIMPLE_EXPRESSION]
4301 -- RELATION ::=
4302 -- SIMPLE_EXPRESSION [not] in MEMBERSHIP_CHOICE_LIST
4303 -- | RAISE_EXPRESSION
4305 -- MEMBERSHIP_CHOICE_LIST ::=
4306 -- MEMBERSHIP_CHOICE {'|' MEMBERSHIP CHOICE}
4308 -- MEMBERSHIP_CHOICE ::=
4309 -- CHOICE_EXPRESSION | RANGE | SUBTYPE_MARK
4311 -- LOGICAL_OPERATOR ::= and | and then | or | or else | xor
4313 -- SIMPLE_EXPRESSION ::=
4314 -- [UNARY_ADDING_OPERATOR] TERM {BINARY_ADDING_OPERATOR TERM}
4316 -- TERM ::= FACTOR {MULTIPLYING_OPERATOR FACTOR}
4318 -- FACTOR ::= PRIMARY [** PRIMARY] | abs PRIMARY | not PRIMARY
4320 -- No nodes are generated for any of these constructs. Instead, the
4321 -- node for the operator appears directly. When we refer to an
4322 -- expression in this description, we mean any of the possible
4323 -- constituent components of an expression (e.g. identifier is
4324 -- an example of an expression).
4326 -- Note: the above syntax is that Ada 2012 syntax which restricts
4327 -- choice relations to simple expressions to avoid ambiguities in
4328 -- some contexts with set membership notation. It has been decided
4329 -- that in retrospect, the Ada 95 change allowing general expressions
4330 -- in this context was a mistake, so we have reverted to the above
4331 -- syntax in Ada 95 and Ada 2005 modes (the restriction to simple
4332 -- expressions was there in Ada 83 from the start).
4334 ------------------
4335 -- 4.4 Primary --
4336 ------------------
4338 -- PRIMARY ::=
4339 -- NUMERIC_LITERAL | null
4340 -- | STRING_LITERAL | AGGREGATE
4341 -- | NAME | QUALIFIED_EXPRESSION
4342 -- | ALLOCATOR | (EXPRESSION)
4344 -- Usually there is no explicit node in the tree for primary. Instead
4345 -- the constituent (e.g. AGGREGATE) appears directly. There are two
4346 -- exceptions. First, there is an explicit node for a null primary.
4348 -- N_Null
4349 -- Sloc points to NULL
4350 -- plus fields for expression
4352 -- Second, the case of (EXPRESSION) is handled specially. Ada requires
4353 -- that the parser keep track of which subexpressions are enclosed
4354 -- in parentheses, and how many levels of parentheses are used. This
4355 -- information is required for optimization purposes, and also for
4356 -- some semantic checks (e.g. (((1))) in a procedure spec does not
4357 -- conform with ((((1)))) in the body).
4359 -- The parentheses are recorded by keeping a Paren_Count field in every
4360 -- subexpression node (it is actually present in all nodes, but only
4361 -- used in subexpression nodes). This count records the number of
4362 -- levels of parentheses. If the number of levels in the source exceeds
4363 -- the maximum accommodated by this count, then the count is simply left
4364 -- at the maximum value. This means that there are some pathological
4365 -- cases of failure to detect conformance failures (e.g. an expression
4366 -- with 500 levels of parens will conform with one with 501 levels),
4367 -- but we do not need to lose sleep over this.
4369 -- Historical note: in versions of GNAT prior to 1.75, there was a node
4370 -- type N_Parenthesized_Expression used to accurately record unlimited
4371 -- numbers of levels of parentheses. However, it turned out to be a
4372 -- real nuisance to have to take into account the possible presence of
4373 -- this node during semantic analysis, since basically parentheses have
4374 -- zero relevance to semantic analysis.
4376 -- Note: the level of parentheses always present in things like
4377 -- aggregates does not count, only the parentheses in the primary
4378 -- (EXPRESSION) affect the setting of the Paren_Count field.
4380 -- 2nd Note: the contents of the Expression field must be ignored (i.e.
4381 -- treated as though it were Empty) if No_Initialization is set True.
4383 --------------------------------------
4384 -- 4.5 Short-Circuit Control Forms --
4385 --------------------------------------
4387 -- EXPRESSION ::=
4388 -- RELATION {and then RELATION} | RELATION {or else RELATION}
4390 -- Gigi restriction: For both these control forms, the operand and
4391 -- result types are always Standard.Boolean. The expander inserts the
4392 -- required conversion operations where needed to ensure this is the
4393 -- case.
4395 -- N_And_Then
4396 -- Sloc points to AND of AND THEN
4397 -- Left_Opnd
4398 -- Right_Opnd
4399 -- Actions
4400 -- plus fields for expression
4402 -- N_Or_Else
4403 -- Sloc points to OR of OR ELSE
4404 -- Left_Opnd
4405 -- Right_Opnd
4406 -- Actions
4407 -- plus fields for expression
4409 -- Note: The Actions field is used to hold actions associated with
4410 -- the right hand operand. These have to be treated specially since
4411 -- they are not unconditionally executed. See Insert_Actions for a
4412 -- more detailed description of how these actions are handled.
4414 ---------------------------
4415 -- 4.5 Membership Tests --
4416 ---------------------------
4418 -- RELATION ::=
4419 -- SIMPLE_EXPRESSION [not] in MEMBERSHIP_CHOICE_LIST
4421 -- MEMBERSHIP_CHOICE_LIST ::=
4422 -- MEMBERSHIP_CHOICE {'|' MEMBERSHIP CHOICE}
4424 -- MEMBERSHIP_CHOICE ::=
4425 -- CHOICE_EXPRESSION | RANGE | SUBTYPE_MARK
4427 -- Note: although the grammar above allows only a range or a subtype
4428 -- mark, the parser in fact will accept any simple expression in place
4429 -- of a subtype mark. This means that the semantic analyzer must be able
4430 -- to deal with, and diagnose a simple expression other than a name for
4431 -- the right operand. This simplifies error recovery in the parser.
4433 -- The Alternatives field below is present only if there is more than
4434 -- one Membership_Choice present (which is legitimate only in Ada 2012
4435 -- mode) in which case Right_Opnd is Empty, and Alternatives contains
4436 -- the list of choices. In the tree passed to the back end, Alternatives
4437 -- is always No_List, and Right_Opnd is set (i.e. the expansion circuit
4438 -- expands out the complex set membership case using simple membership
4439 -- and equality operations).
4441 -- Should we rename Alternatives here to Membership_Choices ???
4443 -- N_In
4444 -- Sloc points to IN
4445 -- Left_Opnd
4446 -- Right_Opnd
4447 -- Alternatives (set to No_List if only one set alternative)
4448 -- No_Minimize_Eliminate
4449 -- plus fields for expression
4451 -- N_Not_In
4452 -- Sloc points to NOT of NOT IN
4453 -- Left_Opnd
4454 -- Right_Opnd
4455 -- Alternatives (set to No_List if only one set alternative)
4456 -- No_Minimize_Eliminate
4457 -- plus fields for expression
4459 --------------------
4460 -- 4.5 Operators --
4461 --------------------
4463 -- LOGICAL_OPERATOR ::= and | or | xor
4465 -- RELATIONAL_OPERATOR ::= = | /= | < | <= | > | >=
4467 -- BINARY_ADDING_OPERATOR ::= + | - | &
4469 -- UNARY_ADDING_OPERATOR ::= + | -
4471 -- MULTIPLYING_OPERATOR ::= * | / | mod | rem
4473 -- HIGHEST_PRECEDENCE_OPERATOR ::= ** | abs | not
4475 -- Gigi restriction: Gigi will never be given * / mod rem nodes with
4476 -- fixed-point operands. All handling of smalls for multiplication and
4477 -- division is handled by the front end (mod and rem result only from
4478 -- expansion). Gigi thus never needs to worry about small values (for
4479 -- other operators operating on fixed-point, e.g. addition, the small
4480 -- value does not have any semantic effect anyway, these are always
4481 -- integer operations).
4483 -- Gigi restriction: For all operators taking Boolean operands, the
4484 -- type is always Standard.Boolean. The expander inserts the required
4485 -- conversion operations where needed to ensure this is the case.
4487 -- N_Op_And
4488 -- Sloc points to AND
4489 -- Do_Length_Check
4490 -- plus fields for binary operator
4491 -- plus fields for expression
4493 -- N_Op_Or
4494 -- Sloc points to OR
4495 -- Do_Length_Check
4496 -- plus fields for binary operator
4497 -- plus fields for expression
4499 -- N_Op_Xor
4500 -- Sloc points to XOR
4501 -- Do_Length_Check
4502 -- plus fields for binary operator
4503 -- plus fields for expression
4505 -- N_Op_Eq
4506 -- Sloc points to =
4507 -- Compare_Type
4508 -- plus fields for binary operator
4509 -- plus fields for expression
4511 -- N_Op_Ne
4512 -- Sloc points to /=
4513 -- Compare_Type
4514 -- plus fields for binary operator
4515 -- plus fields for expression
4517 -- N_Op_Lt
4518 -- Sloc points to <
4519 -- Compare_Type
4520 -- plus fields for binary operator
4521 -- plus fields for expression
4523 -- N_Op_Le
4524 -- Sloc points to <=
4525 -- Compare_Type
4526 -- plus fields for binary operator
4527 -- plus fields for expression
4529 -- N_Op_Gt
4530 -- Sloc points to >
4531 -- Compare_Type
4532 -- plus fields for binary operator
4533 -- plus fields for expression
4535 -- N_Op_Ge
4536 -- Sloc points to >=
4537 -- Compare_Type
4538 -- plus fields for binary operator
4539 -- plus fields for expression
4541 -- N_Op_Add
4542 -- Sloc points to + (binary)
4543 -- plus fields for binary operator
4544 -- plus fields for expression
4546 -- N_Op_Subtract
4547 -- Sloc points to - (binary)
4548 -- plus fields for binary operator
4549 -- plus fields for expression
4551 -- N_Op_Concat
4552 -- Sloc points to &
4553 -- Is_Component_Left_Opnd
4554 -- Is_Component_Right_Opnd
4555 -- plus fields for binary operator
4556 -- plus fields for expression
4558 -- N_Op_Multiply
4559 -- Sloc points to *
4560 -- Rounded_Result
4561 -- plus fields for binary operator
4562 -- plus fields for expression
4564 -- N_Op_Divide
4565 -- Sloc points to /
4566 -- Do_Division_Check
4567 -- Rounded_Result
4568 -- plus fields for binary operator
4569 -- plus fields for expression
4571 -- N_Op_Mod
4572 -- Sloc points to MOD
4573 -- Do_Division_Check
4574 -- plus fields for binary operator
4575 -- plus fields for expression
4577 -- N_Op_Rem
4578 -- Sloc points to REM
4579 -- Do_Division_Check
4580 -- plus fields for binary operator
4581 -- plus fields for expression
4583 -- N_Op_Expon
4584 -- Sloc points to **
4585 -- Is_Power_Of_2_For_Shift
4586 -- plus fields for binary operator
4587 -- plus fields for expression
4589 -- N_Op_Plus
4590 -- Sloc points to + (unary)
4591 -- plus fields for unary operator
4592 -- plus fields for expression
4594 -- N_Op_Minus
4595 -- Sloc points to - (unary)
4596 -- plus fields for unary operator
4597 -- plus fields for expression
4599 -- N_Op_Abs
4600 -- Sloc points to ABS
4601 -- plus fields for unary operator
4602 -- plus fields for expression
4604 -- N_Op_Not
4605 -- Sloc points to NOT
4606 -- plus fields for unary operator
4607 -- plus fields for expression
4609 -- See also shift operators in section B.2
4611 -- Note on fixed-point operations passed to Gigi: For adding operators,
4612 -- the semantics is to treat these simply as integer operations, with
4613 -- the small values being ignored (the bounds are already stored in
4614 -- units of small, so that constraint checking works as usual). For the
4615 -- case of multiply/divide/rem/mod operations, Gigi will never see them.
4617 -- Note on equality/inequality tests for records. In the expanded tree,
4618 -- record comparisons are always expanded to be a series of component
4619 -- comparisons, so the back end will never see an equality or inequality
4620 -- operation with operands of a record type.
4622 -- Note on overflow handling: When the overflow checking mode is set to
4623 -- MINIMIZED or ELIMINATED, nodes for signed arithmetic operations may
4624 -- be modified to use a larger type for the operands and result. In
4625 -- the case where the computed range exceeds that of Long_Long_Integer,
4626 -- and we are running in ELIMINATED mode, the operator node will be
4627 -- changed to be a call to the appropriate routine in System.Bignums.
4629 -- Note: In Modify_Tree_For_C mode, we do not generate an N_Op_Mod node
4630 -- for signed integer types (since there is no equivalent operator in
4631 -- C). Instead we rewrite such an operation in terms of REM (which is
4632 -- % in C) and other C-available operators.
4634 ------------------------------------
4635 -- 4.5.7 Conditional Expressions --
4636 ------------------------------------
4638 -- CONDITIONAL_EXPRESSION ::= IF_EXPRESSION | CASE_EXPRESSION
4640 --------------------------
4641 -- 4.5.7 If Expression --
4642 --------------------------
4644 -- IF_EXPRESSION ::=
4645 -- if CONDITION then DEPENDENT_EXPRESSION
4646 -- {elsif CONDITION then DEPENDENT_EXPRESSION}
4647 -- [else DEPENDENT_EXPRESSION]
4649 -- DEPENDENT_EXPRESSION ::= EXPRESSION
4651 -- Note: if we have (IF x1 THEN x2 ELSIF x3 THEN x4 ELSE x5) then it
4652 -- is represented as (IF x1 THEN x2 ELSE (IF x3 THEN x4 ELSE x5)) and
4653 -- the Is_Elsif flag is set on the inner if expression.
4655 -- N_If_Expression
4656 -- Sloc points to IF or ELSIF keyword
4657 -- Expressions
4658 -- Then_Actions
4659 -- Else_Actions
4660 -- Is_Elsif (set if comes from ELSIF)
4661 -- Do_Overflow_Check
4662 -- Expansion_Delayed
4663 -- plus fields for expression
4665 -- Expressions here is a three-element list, whose first element is the
4666 -- condition, the second element is the dependent expression after THEN
4667 -- and the third element is the dependent expression after the ELSE
4668 -- (explicitly set to True if missing).
4670 -- Note: the Then_Actions and Else_Actions fields are always set to
4671 -- No_List in the tree passed to the back end. These are used only
4672 -- for temporary processing purposes in the expander. Even though they
4673 -- are semantic fields, their parent pointers are set because analysis
4674 -- of actions nodes in those lists may generate additional actions that
4675 -- need to know their insertion point (for example for the creation of
4676 -- transient scopes).
4678 -- Note: in the tree passed to the back end, if the result type is
4679 -- an unconstrained array, the if expression can only appears in the
4680 -- initializing expression of an object declaration (this avoids the
4681 -- back end having to create a variable length temporary on the fly).
4683 ----------------------------
4684 -- 4.5.7 Case Expression --
4685 ----------------------------
4687 -- CASE_EXPRESSION ::=
4688 -- case SELECTING_EXPRESSION is
4689 -- CASE_EXPRESSION_ALTERNATIVE
4690 -- {,CASE_EXPRESSION_ALTERNATIVE}
4692 -- Note that the Alternatives cannot include pragmas (this contrasts
4693 -- with the situation of case statements where pragmas are allowed).
4695 -- N_Case_Expression
4696 -- Sloc points to CASE
4697 -- Expression (the selecting expression)
4698 -- Alternatives (the case expression alternatives)
4699 -- Etype
4700 -- Do_Overflow_Check
4701 -- Expansion_Delayed
4703 ----------------------------------------
4704 -- 4.5.7 Case Expression Alternative --
4705 ----------------------------------------
4707 -- CASE_EXPRESSION_ALTERNATIVE ::=
4708 -- when DISCRETE_CHOICE_LIST =>
4709 -- DEPENDENT_EXPRESSION
4711 -- N_Case_Expression_Alternative
4712 -- Sloc points to WHEN
4713 -- Actions
4714 -- Discrete_Choices
4715 -- Expression
4716 -- Has_SP_Choice
4718 -- Note: The Actions field temporarily holds any actions associated with
4719 -- evaluation of the Expression. During expansion of the case expression
4720 -- these actions are wrapped into an N_Expression_With_Actions node
4721 -- replacing the original expression.
4723 -- Note: this node never appears in the tree passed to the back end,
4724 -- since the expander converts case expressions into case statements.
4726 ---------------------------------
4727 -- 4.5.8 Quantified Expression --
4728 ---------------------------------
4730 -- QUANTIFIED_EXPRESSION ::=
4731 -- for QUANTIFIER LOOP_PARAMETER_SPECIFICATION => PREDICATE
4732 -- | for QUANTIFIER ITERATOR_SPECIFICATION => PREDICATE
4734 -- QUANTIFIER ::= all | some
4736 -- At most one of (Iterator_Specification, Loop_Parameter_Specification)
4737 -- is present at a time, in which case the other one is empty.
4739 -- N_Quantified_Expression
4740 -- Sloc points to FOR
4741 -- Iterator_Specification
4742 -- Loop_Parameter_Specification
4743 -- Condition
4744 -- All_Present
4746 --------------------------
4747 -- 4.6 Type Conversion --
4748 --------------------------
4750 -- TYPE_CONVERSION ::=
4751 -- SUBTYPE_MARK (EXPRESSION) | SUBTYPE_MARK (NAME)
4753 -- In the (NAME) case, the name is stored as the expression
4755 -- Note: the parser never generates a type conversion node, since it
4756 -- looks like an indexed component which is generated by preference.
4757 -- The semantic pass must correct this misidentification.
4759 -- Gigi handles conversions that involve no change in the root type,
4760 -- and also all conversions from integer to floating-point types.
4761 -- Conversions from floating-point to integer are only handled in
4762 -- the case where Float_Truncate flag set. Other conversions from
4763 -- floating-point to integer (involving rounding) and all conversions
4764 -- involving fixed-point types are handled by the expander, unless the
4765 -- Conversion_OK flag is set.
4767 -- Sprint syntax if Float_Truncate set: X^(Y)
4768 -- Sprint syntax if Conversion_OK set X?(Y)
4769 -- Sprint syntax if both flags set X?^(Y)
4771 -- Note: If either the operand or result type is fixed-point, Gigi will
4772 -- only see a type conversion node with Conversion_OK set. The front end
4773 -- takes care of all handling of small's for fixed-point conversions.
4775 -- N_Type_Conversion
4776 -- Sloc points to first token of subtype mark
4777 -- Subtype_Mark
4778 -- Expression
4779 -- Do_Discriminant_Check
4780 -- Do_Length_Check
4781 -- Float_Truncate
4782 -- Conversion_OK
4783 -- Do_Overflow_Check
4784 -- Rounded_Result
4785 -- plus fields for expression
4787 -- Note: if a range check is required, then the Do_Range_Check flag
4788 -- is set in the Expression with the check being done against the
4789 -- target type range (after the base type conversion, if any).
4791 -------------------------------
4792 -- 4.7 Qualified Expression --
4793 -------------------------------
4795 -- QUALIFIED_EXPRESSION ::=
4796 -- SUBTYPE_MARK ' (EXPRESSION) | SUBTYPE_MARK ' AGGREGATE
4798 -- Note: the parentheses in the (EXPRESSION) case are deemed to enclose
4799 -- the expression, so the Expression field of this node always points
4800 -- to a parenthesized expression in this case (i.e. Paren_Count will
4801 -- always be non-zero for the referenced expression if it is not an
4802 -- aggregate).
4804 -- N_Qualified_Expression
4805 -- Sloc points to apostrophe
4806 -- Subtype_Mark
4807 -- Expression expression or aggregate
4808 -- Is_Qualified_Universal_Literal
4809 -- plus fields for expression
4811 --------------------
4812 -- 4.8 Allocator --
4813 --------------------
4815 -- ALLOCATOR ::=
4816 -- new [SUBPOOL_SPECIFICATION] SUBTYPE_INDICATION
4817 -- | new [SUBPOOL_SPECIFICATION] QUALIFIED_EXPRESSION
4819 -- SUBPOOL_SPECIFICATION ::= (subpool_handle_NAME)
4821 -- Sprint syntax (when storage pool present)
4822 -- new xxx (storage_pool = pool)
4823 -- or
4824 -- new (subpool) xxx (storage_pool = pool)
4826 -- N_Allocator
4827 -- Sloc points to NEW
4828 -- Expression subtype indication or qualified expression
4829 -- Subpool_Handle_Name (set to Empty if not present)
4830 -- Storage_Pool
4831 -- Procedure_To_Call
4832 -- For_Special_Return_Object
4833 -- Null_Exclusion_Present
4834 -- No_Initialization
4835 -- Is_Static_Coextension
4836 -- Do_Storage_Check
4837 -- Is_Dynamic_Coextension
4838 -- plus fields for expression
4840 -- Note: like all nodes, the N_Allocator has the Comes_From_Source flag.
4841 -- This flag has a special function in conjunction with the restriction
4842 -- No_Implicit_Heap_Allocations, which will be triggered if this flag
4843 -- is not set. This means that if a source allocator is replaced with
4844 -- a constructed allocator, the Comes_From_Source flag should be copied
4845 -- to the newly created allocator.
4847 ---------------------------------
4848 -- 5.1 Sequence Of Statements --
4849 ---------------------------------
4851 -- SEQUENCE_OF_STATEMENTS ::= STATEMENT {STATEMENT}
4853 -- Note: Although the parser will not accept a declaration as a
4854 -- statement, the semantic analyzer may insert declarations (e.g.
4855 -- declarations of implicit types needed for execution of other
4856 -- statements) into a sequence of statements, so the code generator
4857 -- should be prepared to accept a declaration where a statement is
4858 -- expected. Note also that pragmas can appear as statements.
4860 --------------------
4861 -- 5.1 Statement --
4862 --------------------
4864 -- STATEMENT ::=
4865 -- {LABEL} SIMPLE_STATEMENT | {LABEL} COMPOUND_STATEMENT
4867 -- There is no explicit node in the tree for a statement. Instead, the
4868 -- individual statement appears directly. Labels are treated as a
4869 -- kind of statement, i.e. they are linked into a statement list at
4870 -- the point they appear, so the labeled statement appears following
4871 -- the label or labels in the statement list.
4873 ---------------------------
4874 -- 5.1 Simple Statement --
4875 ---------------------------
4877 -- SIMPLE_STATEMENT ::= NULL_STATEMENT
4878 -- | ASSIGNMENT_STATEMENT | EXIT_STATEMENT
4879 -- | GOTO_STATEMENT | PROCEDURE_CALL_STATEMENT
4880 -- | SIMPLE_RETURN_STATEMENT | ENTRY_CALL_STATEMENT
4881 -- | REQUEUE_STATEMENT | DELAY_STATEMENT
4882 -- | ABORT_STATEMENT | RAISE_STATEMENT
4883 -- | CODE_STATEMENT
4885 -----------------------------
4886 -- 5.1 Compound Statement --
4887 -----------------------------
4889 -- COMPOUND_STATEMENT ::=
4890 -- IF_STATEMENT | CASE_STATEMENT
4891 -- | LOOP_STATEMENT | BLOCK_STATEMENT
4892 -- | EXTENDED_RETURN_STATEMENT
4893 -- | ACCEPT_STATEMENT | SELECT_STATEMENT
4895 -------------------------
4896 -- 5.1 Null Statement --
4897 -------------------------
4899 -- NULL_STATEMENT ::= null;
4901 -- N_Null_Statement
4902 -- Sloc points to NULL
4903 -- Next_Rep_Item
4905 ----------------
4906 -- 5.1 Label --
4907 ----------------
4909 -- LABEL ::= <<label_STATEMENT_IDENTIFIER>>
4911 -- Note that the occurrence of a label is not a defining identifier,
4912 -- but rather a referencing occurrence. The defining occurrence is
4913 -- in the implicit label declaration which occurs in the innermost
4914 -- enclosing block.
4916 -- N_Label
4917 -- Sloc points to <<
4918 -- Identifier direct name of statement identifier
4919 -- Exception_Junk
4921 -- Note: Before Ada 2012, a label is always followed by a statement,
4922 -- and this is true in the tree even in Ada 2012 mode (the parser
4923 -- inserts a null statement marked with Comes_From_Source False).
4925 -------------------------------
4926 -- 5.1 Statement Identifier --
4927 -------------------------------
4929 -- STATEMENT_IDENTIFIER ::= DIRECT_NAME
4931 -- The IDENTIFIER of a STATEMENT_IDENTIFIER shall be an identifier
4932 -- (not an OPERATOR_SYMBOL)
4934 -------------------------------
4935 -- 5.2 Assignment Statement --
4936 -------------------------------
4938 -- ASSIGNMENT_STATEMENT ::=
4939 -- variable_NAME := EXPRESSION;
4941 -- N_Assignment_Statement
4942 -- Sloc points to :=
4943 -- Name
4944 -- Expression
4945 -- Is_Elaboration_Checks_OK_Node
4946 -- Is_SPARK_Mode_On_Node
4947 -- Do_Discriminant_Check
4948 -- Do_Length_Check
4949 -- Forwards_OK
4950 -- Backwards_OK
4951 -- No_Ctrl_Actions
4952 -- No_Finalize_Actions
4953 -- Has_Target_Names
4954 -- Is_Elaboration_Code
4955 -- Componentwise_Assignment
4956 -- Suppress_Assignment_Checks
4958 -- Note: if a range check is required, then the Do_Range_Check flag
4959 -- is set in the Expression (right hand side), with the check being
4960 -- done against the type of the Name (left hand side).
4962 -- Note: the back end places some restrictions on the form of the
4963 -- Expression field. If the object being assigned to is Atomic, then
4964 -- the Expression may not have the form of an aggregate (since this
4965 -- might cause the back end to generate separate assignments). In this
4966 -- case the front end must generate an extra temporary and initialize
4967 -- this temporary as required (the temporary itself is not atomic).
4969 ------------------
4970 -- Target_Name --
4971 ------------------
4973 -- N_Target_Name
4974 -- Sloc points to @
4975 -- Etype
4977 -- Note (Ada 2022): node is used during analysis as a placeholder for
4978 -- the value of the LHS of the enclosing assignment statement. Node is
4979 -- eventually rewritten together with enclosing assignment, and backends
4980 -- are not aware of it.
4982 -----------------------
4983 -- 5.3 If Statement --
4984 -----------------------
4986 -- IF_STATEMENT ::=
4987 -- if CONDITION then
4988 -- SEQUENCE_OF_STATEMENTS
4989 -- {elsif CONDITION then
4990 -- SEQUENCE_OF_STATEMENTS}
4991 -- [else
4992 -- SEQUENCE_OF_STATEMENTS]
4993 -- end if;
4995 -- Gigi restriction: This expander ensures that the type of the
4996 -- Condition fields is always Standard.Boolean, even if the type
4997 -- in the source is some non-standard boolean type.
4999 -- N_If_Statement
5000 -- Sloc points to IF
5001 -- Condition
5002 -- Then_Statements
5003 -- Elsif_Parts (set to No_List if none present)
5004 -- Else_Statements (set to No_List if no else part present)
5005 -- End_Span (set to Uint_0 if expander generated)
5006 -- From_Conditional_Expression
5008 -- N_Elsif_Part
5009 -- Sloc points to ELSIF
5010 -- Condition
5011 -- Then_Statements
5012 -- Condition_Actions
5014 --------------------
5015 -- 5.3 Condition --
5016 --------------------
5018 -- CONDITION ::= boolean_EXPRESSION
5020 -------------------------
5021 -- 5.4 Case Statement --
5022 -------------------------
5024 -- CASE_STATEMENT ::=
5025 -- case EXPRESSION is
5026 -- CASE_STATEMENT_ALTERNATIVE
5027 -- {CASE_STATEMENT_ALTERNATIVE}
5028 -- end case;
5030 -- Note: the Alternatives can contain pragmas. These only occur at
5031 -- the start of the list, since any pragmas occurring after the first
5032 -- alternative are absorbed into the corresponding statement sequence.
5034 -- N_Case_Statement
5035 -- Sloc points to CASE
5036 -- Expression
5037 -- Alternatives
5038 -- End_Span (set to Uint_0 if expander generated)
5039 -- From_Conditional_Expression
5041 -- Note: Before Ada 2012, a pragma in a statement sequence is always
5042 -- followed by a statement, and this is true in the tree even in Ada
5043 -- 2012 mode (the parser inserts a null statement marked with the flag
5044 -- Comes_From_Source False).
5046 -------------------------------------
5047 -- 5.4 Case Statement Alternative --
5048 -------------------------------------
5050 -- CASE_STATEMENT_ALTERNATIVE ::=
5051 -- when DISCRETE_CHOICE_LIST =>
5052 -- SEQUENCE_OF_STATEMENTS
5054 -- N_Case_Statement_Alternative
5055 -- Sloc points to WHEN
5056 -- Discrete_Choices
5057 -- Statements
5058 -- Has_SP_Choice
5059 -- Multidefined_Bindings
5061 -- Note: in the list of Discrete_Choices, the tree passed to the back
5062 -- end does not have choice entries corresponding to names of statically
5063 -- predicated subtypes. Such entries are always expanded out to the list
5064 -- of equivalent values or ranges. Multidefined_Bindings is True iff
5065 -- more than one choice is present and each choice contains
5066 -- at least one component association having a non-null Binding_Chars
5067 -- attribute; this can only occur if GNAT extensions are enabled
5068 -- and the type of the case selector is composite.
5070 -------------------------
5071 -- 5.5 Loop Statement --
5072 -------------------------
5074 -- LOOP_STATEMENT ::=
5075 -- [loop_STATEMENT_IDENTIFIER :]
5076 -- [ITERATION_SCHEME] loop
5077 -- SEQUENCE_OF_STATEMENTS
5078 -- end loop [loop_IDENTIFIER];
5080 -- Note: The occurrence of a loop label is not a defining identifier
5081 -- but rather a referencing occurrence. The defining occurrence is in
5082 -- the implicit label declaration which occurs in the innermost
5083 -- enclosing block.
5085 -- Note: there is always a loop statement identifier present in the
5086 -- tree, even if none was given in the source. In the case where no loop
5087 -- identifier is given in the source, the parser creates a name of the
5088 -- form _Loop_n, where n is a decimal integer (the two underlines ensure
5089 -- that the loop names created in this manner do not conflict with any
5090 -- user defined identifiers), and the flag Has_Created_Identifier is set
5091 -- to True. The only exception to the rule that all loop statement nodes
5092 -- have identifiers occurs for loops constructed by the expander, and
5093 -- the semantic analyzer will create and supply dummy loop identifiers
5094 -- in these cases.
5096 -- N_Loop_Statement
5097 -- Sloc points to LOOP
5098 -- Identifier loop identifier (set to Empty if no identifier)
5099 -- Iteration_Scheme (set to Empty if no iteration scheme)
5100 -- Statements
5101 -- End_Label
5102 -- Has_Created_Identifier
5103 -- Is_Null_Loop
5104 -- Suppress_Loop_Warnings
5106 -- Note: the parser fills in the Identifier field if there is an
5107 -- explicit loop identifier. Otherwise the parser leaves this field
5108 -- set to Empty, and then the semantic processing for a loop statement
5109 -- creates an identifier, setting the Has_Created_Identifier flag to
5110 -- True. So after semantic analysis, the Identifier is always set,
5111 -- referencing an identifier whose entity has an Ekind of E_Loop.
5113 ---------------------------
5114 -- 5.5 Iteration Scheme --
5115 ---------------------------
5117 -- ITERATION_SCHEME ::=
5118 -- while CONDITION
5119 -- | for LOOP_PARAMETER_SPECIFICATION
5120 -- | for ITERATOR_SPECIFICATION
5122 -- At most one of (Iterator_Specification, Loop_Parameter_Specification)
5123 -- is present at a time, in which case the other one is empty. Both are
5124 -- empty in the case of a WHILE loop.
5126 -- Gigi restriction: The expander ensures that the type of the Condition
5127 -- field is always Standard.Boolean, even if the type in the source is
5128 -- some non-standard boolean type.
5130 -- N_Iteration_Scheme
5131 -- Sloc points to WHILE or FOR
5132 -- Condition (set to Empty if FOR case)
5133 -- Condition_Actions
5134 -- Iterator_Specification (set to Empty if WHILE case)
5135 -- Loop_Parameter_Specification (set to Empty if WHILE case)
5137 ---------------------------------------
5138 -- 5.5 Loop Parameter Specification --
5139 ---------------------------------------
5141 -- LOOP_PARAMETER_SPECIFICATION ::=
5142 -- DEFINING_IDENTIFIER in [reverse] DISCRETE_SUBTYPE_DEFINITION
5143 -- [Iterator_Filter]
5145 -- Note: the optional Iterator_Filter is an Ada 2022 construct.
5147 -- N_Loop_Parameter_Specification
5148 -- Sloc points to first identifier
5149 -- Defining_Identifier
5150 -- Reverse_Present
5151 -- Iterator_Filter (set to Empty if not present)
5152 -- Discrete_Subtype_Definition
5154 -----------------------------------
5155 -- 5.5.1 Iterator Specification --
5156 -----------------------------------
5158 -- ITERATOR_SPECIFICATION ::=
5159 -- DEFINING_IDENTIFIER in [reverse] NAME
5160 -- | DEFINING_IDENTIFIER [: SUBTYPE_INDICATION] of [reverse] NAME
5162 -- N_Iterator_Specification
5163 -- Sloc points to defining identifier
5164 -- Defining_Identifier
5165 -- Name
5166 -- Reverse_Present
5167 -- Of_Present
5168 -- Iterator_Filter (set to Empty if not present)
5169 -- Subtype_Indication
5171 -- Note: The Of_Present flag distinguishes the two forms
5173 --------------------------
5174 -- 5.6 Block Statement --
5175 --------------------------
5177 -- BLOCK_STATEMENT ::=
5178 -- [block_STATEMENT_IDENTIFIER:]
5179 -- [declare
5180 -- DECLARATIVE_PART]
5181 -- begin
5182 -- HANDLED_SEQUENCE_OF_STATEMENTS
5183 -- end [block_IDENTIFIER];
5185 -- Note that the occurrence of a block identifier is not a defining
5186 -- identifier, but rather a referencing occurrence. The defining
5187 -- occurrence is an E_Block entity declared by the implicit label
5188 -- declaration which occurs in the innermost enclosing block statement
5189 -- or body; the block identifier denotes that E_Block.
5191 -- For block statements that come from source code, there is always a
5192 -- block statement identifier present in the tree, denoting an E_Block.
5193 -- In the case where no block identifier is given in the source,
5194 -- the parser creates a name of the form B_n, where n is a decimal
5195 -- integer, and the flag Has_Created_Identifier is set to True. Blocks
5196 -- constructed by the expander usually have no identifier, and no
5197 -- corresponding entity.
5199 -- Note: the block statement created for an extended return statement
5200 -- has an entity, and this entity is an E_Return_Statement, rather than
5201 -- the usual E_Block.
5203 -- Note: Exception_Junk is set for the wrapping blocks created during
5204 -- local raise optimization (Exp_Ch11.Expand_Local_Exception_Handlers).
5206 -- Note: from a control flow viewpoint, a block statement defines an
5207 -- extended basic block, i.e. the entry of the block dominates every
5208 -- statement in the sequence. When generating new statements with
5209 -- exception handlers in the expander at the end of a sequence that
5210 -- comes from source code, it can be necessary to wrap them all in a
5211 -- block statement in order to expose the implicit control flow to
5212 -- gigi and thus prevent it from issuing bogus control flow warnings.
5214 -- N_Block_Statement
5215 -- Sloc points to DECLARE or BEGIN
5216 -- Identifier block direct name (set to Empty if not present)
5217 -- Declarations (set to No_List if no DECLARE part)
5218 -- Handled_Statement_Sequence
5219 -- Activation_Chain_Entity
5220 -- Cleanup_Actions
5221 -- Has_Created_Identifier
5222 -- Is_Asynchronous_Call_Block
5223 -- Is_Task_Allocation_Block
5224 -- Exception_Junk
5225 -- Is_Abort_Block
5226 -- Is_Initialization_Block
5227 -- Is_Task_Master
5228 -- At_End_Proc (set to Empty if no clean up procedure)
5230 -------------------------
5231 -- 5.7 Exit Statement --
5232 -------------------------
5234 -- EXIT_STATEMENT ::= exit [loop_NAME] [when CONDITION];
5236 -- Gigi restriction: The expander ensures that the type of the Condition
5237 -- field is always Standard.Boolean, even if the type in the source is
5238 -- some non-standard boolean type.
5240 -- N_Exit_Statement
5241 -- Sloc points to EXIT
5242 -- Name (set to Empty if no loop name present)
5243 -- Condition (set to Empty if no WHEN part present)
5244 -- Next_Exit_Statement : Next exit on chain
5246 -------------------------
5247 -- 5.9 Goto Statement --
5248 -------------------------
5250 -- GOTO_STATEMENT ::= goto label_NAME;
5252 -- N_Goto_Statement
5253 -- Sloc points to GOTO
5254 -- Name
5255 -- Exception_Junk
5257 ---------------------------------
5258 -- 6.1 Subprogram Declaration --
5259 ---------------------------------
5261 -- SUBPROGRAM_DECLARATION ::=
5262 -- SUBPROGRAM_SPECIFICATION
5263 -- [ASPECT_SPECIFICATIONS];
5265 -- N_Subprogram_Declaration
5266 -- Sloc points to FUNCTION or PROCEDURE
5267 -- Specification
5268 -- Body_To_Inline
5269 -- Corresponding_Body
5270 -- Parent_Spec
5271 -- Is_Entry_Barrier_Function
5272 -- Is_Task_Body_Procedure
5274 ------------------------------------------
5275 -- 6.1 Abstract Subprogram Declaration --
5276 ------------------------------------------
5278 -- ABSTRACT_SUBPROGRAM_DECLARATION ::=
5279 -- SUBPROGRAM_SPECIFICATION is abstract
5280 -- [ASPECT_SPECIFICATIONS];
5282 -- N_Abstract_Subprogram_Declaration
5283 -- Sloc points to ABSTRACT
5284 -- Specification
5286 -----------------------------------
5287 -- 6.1 Subprogram Specification --
5288 -----------------------------------
5290 -- SUBPROGRAM_SPECIFICATION ::=
5291 -- [[not] overriding]
5292 -- procedure DEFINING_PROGRAM_UNIT_NAME PARAMETER_PROFILE
5293 -- | [[not] overriding]
5294 -- function DEFINING_DESIGNATOR PARAMETER_AND_RESULT_PROFILE
5296 -- Note: there are no separate nodes for the profiles, instead the
5297 -- information appears directly in the following nodes.
5299 -- N_Function_Specification
5300 -- Sloc points to FUNCTION
5301 -- Defining_Unit_Name (the designator)
5302 -- Parameter_Specifications (set to No_List if no formal part)
5303 -- Null_Exclusion_Present
5304 -- Result_Definition for result subtype
5305 -- Generic_Parent
5306 -- Must_Override set if overriding indicator present
5307 -- Must_Not_Override set if not_overriding indicator present
5309 -- N_Procedure_Specification
5310 -- Sloc points to PROCEDURE
5311 -- Defining_Unit_Name
5312 -- Null_Statement NULL statement for body, if Null_Present
5313 -- Parameter_Specifications (set to No_List if no formal part)
5314 -- Generic_Parent
5315 -- Null_Present set for null procedure case (Ada 2005 feature)
5316 -- Must_Override set if overriding indicator present
5317 -- Must_Not_Override set if not_overriding indicator present
5319 -- Note: overriding indicator is an Ada 2005 feature
5321 ---------------------
5322 -- 6.1 Designator --
5323 ---------------------
5325 -- DESIGNATOR ::=
5326 -- [PARENT_UNIT_NAME .] IDENTIFIER | OPERATOR_SYMBOL
5328 -- Designators that are simply identifiers or operator symbols appear
5329 -- directly in the tree in this form. The following node is used only
5330 -- in the case where the designator has a parent unit name component.
5332 -- N_Designator
5333 -- Sloc points to period
5334 -- Name holds the parent unit name
5335 -- Identifier
5337 -- Note: Name is always non-Empty, since this node is only used for the
5338 -- case where a parent library unit package name is present.
5340 -- Note that the identifier can also be an operator symbol here
5342 ------------------------------
5343 -- 6.1 Defining Designator --
5344 ------------------------------
5346 -- DEFINING_DESIGNATOR ::=
5347 -- DEFINING_PROGRAM_UNIT_NAME | DEFINING_OPERATOR_SYMBOL
5349 -------------------------------------
5350 -- 6.1 Defining Program Unit Name --
5351 -------------------------------------
5353 -- DEFINING_PROGRAM_UNIT_NAME ::=
5354 -- [PARENT_UNIT_NAME .] DEFINING_IDENTIFIER
5356 -- The parent unit name is present only in the case of a child unit name
5357 -- (permissible only for Ada 95 for a library level unit, i.e. a unit
5358 -- at scope level one). If no such name is present, the defining program
5359 -- unit name is represented simply as the defining identifier. In the
5360 -- child unit case, the following node is used to represent the child
5361 -- unit name.
5363 -- N_Defining_Program_Unit_Name
5364 -- Sloc points to period
5365 -- Name holds the parent unit name
5366 -- Defining_Identifier
5368 -- Note: Name is always non-Empty, since this node is only used for the
5369 -- case where a parent unit name is present.
5371 --------------------------
5372 -- 6.1 Operator Symbol --
5373 --------------------------
5375 -- OPERATOR_SYMBOL ::= STRING_LITERAL
5377 -- Note: the fields of the N_Operator_Symbol node are laid out to match
5378 -- the corresponding fields of an N_Character_Literal node. This allows
5379 -- easy conversion of the operator symbol node into a character literal
5380 -- node in the case where a string constant of the form of an operator
5381 -- symbol is scanned out as such, but turns out semantically to be a
5382 -- string literal that is not an operator. For details see Sinfo.CN.
5383 -- Change_Operator_Symbol_To_String_Literal.
5385 -- N_Operator_Symbol
5386 -- Sloc points to literal
5387 -- Chars contains the Name_Id for the operator symbol
5388 -- Strval Id of string value. This is used if the operator
5389 -- symbol turns out to be a normal string after all.
5390 -- Entity
5391 -- Associated_Node Note this is shared with Entity
5392 -- Etype
5393 -- Has_Private_View (set in generic units)
5394 -- Has_Secondary_Private_View (set in generic units)
5396 -- Note: the Strval field may be set to No_String for generated
5397 -- operator symbols that are known not to be string literals
5398 -- semantically.
5400 -----------------------------------
5401 -- 6.1 Defining Operator Symbol --
5402 -----------------------------------
5404 -- DEFINING_OPERATOR_SYMBOL ::= OPERATOR_SYMBOL
5406 -- A defining operator symbol is an entity, which has additional
5407 -- fields depending on the setting of the Ekind field. These
5408 -- additional fields are defined (and access subprograms declared)
5409 -- in package Einfo.
5411 -- N_Defining_Operator_Symbol
5412 -- Sloc points to literal
5413 -- Chars contains the Name_Id for the operator symbol
5414 -- Next_Entity
5415 -- Scope
5416 -- Etype
5418 ----------------------------
5419 -- 6.1 Parameter Profile --
5420 ----------------------------
5422 -- PARAMETER_PROFILE ::= [FORMAL_PART]
5424 ---------------------------------------
5425 -- 6.1 Parameter and Result Profile --
5426 ---------------------------------------
5428 -- PARAMETER_AND_RESULT_PROFILE ::=
5429 -- [FORMAL_PART] return [NULL_EXCLUSION] SUBTYPE_MARK
5430 -- | [FORMAL_PART] return ACCESS_DEFINITION
5432 -- There is no explicit node in the tree for a parameter and result
5433 -- profile. Instead the information appears directly in the parent.
5435 ----------------------
5436 -- 6.1 Formal Part --
5437 ----------------------
5439 -- FORMAL_PART ::=
5440 -- (PARAMETER_SPECIFICATION {; PARAMETER_SPECIFICATION})
5442 ----------------------------------
5443 -- 6.1 Parameter Specification --
5444 ----------------------------------
5446 -- PARAMETER_SPECIFICATION ::=
5447 -- DEFINING_IDENTIFIER_LIST : [ALIASED] MODE [NULL_EXCLUSION]
5448 -- SUBTYPE_MARK [:= DEFAULT_EXPRESSION] [ASPECT_SPECIFICATIONS]
5449 -- | DEFINING_IDENTIFIER_LIST : ACCESS_DEFINITION
5450 -- [:= DEFAULT_EXPRESSION] [ASPECT_SPECIFICATIONS]
5452 -- Although the syntax allows multiple identifiers in the list, the
5453 -- semantics is as though successive specifications were given with
5454 -- identical type definition and expression components. To simplify
5455 -- semantic processing, the parser represents a multiple declaration
5456 -- case as a sequence of single Specifications, using the More_Ids and
5457 -- Prev_Ids flags to preserve the original source form as described
5458 -- in the section on "Handling of Defining Identifier Lists".
5460 -- ALIASED can only be present in Ada 2012 mode
5462 -- N_Parameter_Specification
5463 -- Sloc points to first identifier
5464 -- Defining_Identifier
5465 -- Aliased_Present
5466 -- In_Present
5467 -- Out_Present
5468 -- Null_Exclusion_Present
5469 -- Parameter_Type subtype mark or access definition
5470 -- Expression (set to Empty if no default expression present)
5471 -- More_Ids (set to False if no more identifiers in list)
5472 -- Prev_Ids (set to False if no previous identifiers in list)
5473 -- Default_Expression
5475 ---------------
5476 -- 6.1 Mode --
5477 ---------------
5479 -- MODE ::= [in] | in out | out
5481 -- There is no explicit node in the tree for the Mode. Instead the
5482 -- In_Present and Out_Present flags are set in the parent node to
5483 -- record the presence of keywords specifying the mode.
5485 --------------------------
5486 -- 6.3 Subprogram Body --
5487 --------------------------
5489 -- SUBPROGRAM_BODY ::=
5490 -- SUBPROGRAM_SPECIFICATION [ASPECT_SPECIFICATIONS] is
5491 -- DECLARATIVE_PART
5492 -- begin
5493 -- HANDLED_SEQUENCE_OF_STATEMENTS
5494 -- end [DESIGNATOR];
5496 -- N_Subprogram_Body
5497 -- Sloc points to FUNCTION or PROCEDURE
5498 -- Specification
5499 -- Declarations
5500 -- Handled_Statement_Sequence
5501 -- Activation_Chain_Entity
5502 -- Corresponding_Spec
5503 -- Acts_As_Spec
5504 -- Bad_Is_Detected used only by parser
5505 -- Do_Storage_Check
5506 -- Has_Relative_Deadline_Pragma
5507 -- Is_Entry_Barrier_Function
5508 -- Is_Protected_Subprogram_Body
5509 -- Is_Task_Body_Procedure
5510 -- Is_Task_Master
5511 -- Was_Attribute_Reference
5512 -- Was_Expression_Function
5513 -- Was_Originally_Stub
5515 -----------------------------------
5516 -- 6.4 Procedure Call Statement --
5517 -----------------------------------
5519 -- PROCEDURE_CALL_STATEMENT ::=
5520 -- procedure_NAME; | procedure_PREFIX ACTUAL_PARAMETER_PART;
5522 -- Note: the reason that a procedure call has expression fields is that
5523 -- it semantically resembles an expression, e.g. overloading is allowed
5524 -- and a type is concocted for semantic processing purposes. Certain of
5525 -- these fields, such as Parens are not relevant, but it is easier to
5526 -- just supply all of them together.
5528 -- N_Procedure_Call_Statement
5529 -- Sloc points to first token of name or prefix
5530 -- Name stores name or prefix
5531 -- Parameter_Associations (set to No_List if no
5532 -- actual parameter part)
5533 -- First_Named_Actual
5534 -- Controlling_Argument (set to Empty if not dispatching)
5535 -- Is_Elaboration_Checks_OK_Node
5536 -- Is_SPARK_Mode_On_Node
5537 -- Is_Elaboration_Warnings_OK_Node
5538 -- No_Elaboration_Check
5539 -- Is_Known_Guaranteed_ABE
5540 -- plus fields for expression
5542 -- If any IN parameter requires a range check, then the corresponding
5543 -- argument expression has the Do_Range_Check flag set, and the range
5544 -- check is done against the formal type. Note that this argument
5545 -- expression may appear directly in the Parameter_Associations list,
5546 -- or may be a descendant of an N_Parameter_Association node that
5547 -- appears in this list.
5549 ------------------------
5550 -- 6.4 Function Call --
5551 ------------------------
5553 -- FUNCTION_CALL ::=
5554 -- function_NAME | function_PREFIX ACTUAL_PARAMETER_PART
5556 -- Note: the parser may generate an indexed component node or simply
5557 -- a name node instead of a function call node. The semantic pass must
5558 -- correct this misidentification.
5560 -- N_Function_Call
5561 -- Sloc points to first token of name or prefix
5562 -- Name stores name or prefix
5563 -- Parameter_Associations (set to No_List if no
5564 -- actual parameter part)
5565 -- First_Named_Actual
5566 -- Controlling_Argument (set to Empty if not dispatching)
5567 -- Is_Elaboration_Checks_OK_Node
5568 -- Is_SPARK_Mode_On_Node
5569 -- Is_Elaboration_Warnings_OK_Node
5570 -- No_Elaboration_Check
5571 -- Is_Expanded_Build_In_Place_Call
5572 -- Is_Known_Guaranteed_ABE
5573 -- plus fields for expression
5575 --------------------------------
5576 -- 6.4 Actual Parameter Part --
5577 --------------------------------
5579 -- ACTUAL_PARAMETER_PART ::=
5580 -- (PARAMETER_ASSOCIATION {,PARAMETER_ASSOCIATION})
5582 --------------------------------
5583 -- 6.4 Parameter Association --
5584 --------------------------------
5586 -- PARAMETER_ASSOCIATION ::=
5587 -- [formal_parameter_SELECTOR_NAME =>] EXPLICIT_ACTUAL_PARAMETER
5589 -- Note: the N_Parameter_Association node is built only if a formal
5590 -- parameter selector name is present, otherwise the parameter
5591 -- association appears in the tree simply as the node for the
5592 -- explicit actual parameter.
5594 -- N_Parameter_Association
5595 -- Sloc points to formal parameter
5596 -- Selector_Name (always non-Empty)
5597 -- Explicit_Actual_Parameter
5598 -- Next_Named_Actual
5599 -- Is_Accessibility_Actual
5601 ---------------------------
5602 -- 6.4 Actual Parameter --
5603 ---------------------------
5605 -- EXPLICIT_ACTUAL_PARAMETER ::=
5606 -- EXPRESSION | variable_NAME | REDUCTION_EXPRESSION_PARAMETER
5608 ---------------------------
5609 -- 6.5 Return Statement --
5610 ---------------------------
5612 -- SIMPLE_RETURN_STATEMENT ::= return [EXPRESSION];
5614 -- EXTENDED_RETURN_STATEMENT ::=
5615 -- return DEFINING_IDENTIFIER : [aliased] RETURN_SUBTYPE_INDICATION
5616 -- [:= EXPRESSION] [do
5617 -- HANDLED_SEQUENCE_OF_STATEMENTS
5618 -- end return];
5620 -- RETURN_SUBTYPE_INDICATION ::= SUBTYPE_INDICATION | ACCESS_DEFINITION
5622 -- The term "return statement" is defined in 6.5 to mean either a
5623 -- SIMPLE_RETURN_STATEMENT or an EXTENDED_RETURN_STATEMENT. We avoid
5624 -- the use of this term, since it used to mean something else in earlier
5625 -- versions of Ada.
5627 -- N_Simple_Return_Statement
5628 -- Sloc points to RETURN
5629 -- Return_Statement_Entity
5630 -- Expression (set to Empty if no expression present)
5631 -- Storage_Pool
5632 -- Procedure_To_Call
5633 -- Comes_From_Extended_Return_Statement
5635 -- Note: Return_Statement_Entity points to an E_Return_Statement
5637 -- If a range check is required, then Do_Range_Check is set on the
5638 -- Expression. The check is against the return subtype of the function.
5640 -- N_Extended_Return_Statement
5641 -- Sloc points to RETURN
5642 -- Return_Statement_Entity
5643 -- Return_Object_Declarations
5644 -- Handled_Statement_Sequence (set to Empty if not present)
5645 -- Storage_Pool
5646 -- Procedure_To_Call
5648 -- Note: Return_Statement_Entity points to an E_Return_Statement.
5650 -- Note that Return_Object_Declarations is a list containing the
5651 -- N_Object_Declaration -- see comment on this field above.
5653 -- The declared object will have Is_Return_Object = True.
5655 -- There is no such syntactic category as return_object_declaration
5656 -- in the RM. Return_Object_Declarations represents this portion of
5657 -- the syntax for EXTENDED_RETURN_STATEMENT:
5658 -- DEFINING_IDENTIFIER : [aliased] RETURN_SUBTYPE_INDICATION
5659 -- [:= EXPRESSION]
5661 -- There are two entities associated with an extended_return_statement:
5662 -- the Return_Statement_Entity represents the statement itself,
5663 -- and the Defining_Identifier of the Object_Declaration in
5664 -- Return_Object_Declarations represents the object being
5665 -- returned. N_Simple_Return_Statement has only the former.
5667 ------------------------------
5668 -- 6.8 Expression Function --
5669 ------------------------------
5671 -- EXPRESSION_FUNCTION ::=
5672 -- FUNCTION SPECIFICATION IS (EXPRESSION)
5673 -- [ASPECT_SPECIFICATIONS];
5675 -- N_Expression_Function
5676 -- Sloc points to FUNCTION
5677 -- Specification
5678 -- Expression
5679 -- Corresponding_Spec
5681 ------------------------------
5682 -- 7.1 Package Declaration --
5683 ------------------------------
5685 -- PACKAGE_DECLARATION ::=
5686 -- PACKAGE_SPECIFICATION;
5688 -- Note: the activation chain entity for a package spec is used for
5689 -- all tasks declared in the package spec, or in the package body.
5691 -- N_Package_Declaration
5692 -- Sloc points to PACKAGE
5693 -- Specification
5694 -- Corresponding_Body
5695 -- Parent_Spec
5696 -- Activation_Chain_Entity
5698 --------------------------------
5699 -- 7.1 Package Specification --
5700 --------------------------------
5702 -- PACKAGE_SPECIFICATION ::=
5703 -- package DEFINING_PROGRAM_UNIT_NAME
5704 -- [ASPECT_SPECIFICATIONS]
5705 -- is
5706 -- {BASIC_DECLARATIVE_ITEM}
5707 -- [private
5708 -- {BASIC_DECLARATIVE_ITEM}]
5709 -- end [[PARENT_UNIT_NAME .] IDENTIFIER]
5711 -- N_Package_Specification
5712 -- Sloc points to PACKAGE
5713 -- Defining_Unit_Name
5714 -- Visible_Declarations
5715 -- Private_Declarations (set to No_List if no private
5716 -- part present)
5717 -- End_Label
5718 -- Generic_Parent
5719 -- Limited_View_Installed
5721 -----------------------
5722 -- 7.1 Package Body --
5723 -----------------------
5725 -- PACKAGE_BODY ::=
5726 -- package body DEFINING_PROGRAM_UNIT_NAME
5727 -- [ASPECT_SPECIFICATIONS]
5728 -- is
5729 -- DECLARATIVE_PART
5730 -- [begin
5731 -- HANDLED_SEQUENCE_OF_STATEMENTS]
5732 -- end [[PARENT_UNIT_NAME .] IDENTIFIER];
5734 -- N_Package_Body
5735 -- Sloc points to PACKAGE
5736 -- Defining_Unit_Name
5737 -- Declarations
5738 -- Handled_Statement_Sequence (set to Empty if no HSS present)
5739 -- Corresponding_Spec
5740 -- Was_Originally_Stub
5741 -- At_End_Proc (set to Empty if no clean up procedure)
5743 -- Note: if a source level package does not contain a handled sequence
5744 -- of statements, then the parser supplies a dummy one with a null
5745 -- sequence of statements. Comes_From_Source will be False in this
5746 -- constructed sequence. The reason we need this is for the End_Label
5747 -- field in the HSS.
5749 -----------------------------------
5750 -- 7.4 Private Type Declaration --
5751 -----------------------------------
5753 -- PRIVATE_TYPE_DECLARATION ::=
5754 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART]
5755 -- is [[abstract] tagged] [limited] private
5756 -- [ASPECT_SPECIFICATIONS];
5758 -- Note: TAGGED is not permitted in Ada 83 mode
5760 -- N_Private_Type_Declaration
5761 -- Sloc points to TYPE
5762 -- Defining_Identifier
5763 -- Discriminant_Specifications (set to No_List if no
5764 -- discriminant part)
5765 -- Unknown_Discriminants_Present set if (<>) discriminant
5766 -- Abstract_Present
5767 -- Tagged_Present
5768 -- Limited_Present
5770 ----------------------------------------
5771 -- 7.4 Private Extension Declaration --
5772 ----------------------------------------
5774 -- PRIVATE_EXTENSION_DECLARATION ::=
5775 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART] is
5776 -- [abstract] [limited | synchronized]
5777 -- new ancestor_SUBTYPE_INDICATION [and INTERFACE_LIST]
5778 -- with private [ASPECT_SPECIFICATIONS];
5780 -- Note: LIMITED, and private extension declarations are not allowed
5781 -- in Ada 83 mode.
5783 -- N_Private_Extension_Declaration
5784 -- Sloc points to TYPE
5785 -- Defining_Identifier
5786 -- Uninitialized_Variable
5787 -- Discriminant_Specifications (set to No_List if no
5788 -- discriminant part)
5789 -- Unknown_Discriminants_Present set if (<>) discriminant
5790 -- Abstract_Present
5791 -- Limited_Present
5792 -- Synchronized_Present
5793 -- Subtype_Indication
5794 -- Interface_List (set to No_List if none)
5796 ---------------------
5797 -- 8.4 Use Clause --
5798 ---------------------
5800 -- USE_CLAUSE ::= USE_PACKAGE_CLAUSE | USE_TYPE_CLAUSE
5802 -----------------------------
5803 -- 8.4 Use Package Clause --
5804 -----------------------------
5806 -- USE_PACKAGE_CLAUSE ::= use package_NAME {, package_NAME};
5808 -- N_Use_Package_Clause
5809 -- Sloc points to USE
5810 -- Prev_Use_Clause
5811 -- Name
5812 -- Next_Use_Clause
5813 -- Associated_Node
5814 -- Hidden_By_Use_Clause
5815 -- Is_Effective_Use_Clause
5816 -- More_Ids (set to False if no more identifiers in list)
5817 -- Prev_Ids (set to False if no previous identifiers in list)
5819 --------------------------
5820 -- 8.4 Use Type Clause --
5821 --------------------------
5823 -- USE_TYPE_CLAUSE ::= use [ALL] type SUBTYPE_MARK {, SUBTYPE_MARK};
5825 -- Note: use type clause is not permitted in Ada 83 mode
5827 -- Note: the ALL keyword can appear only in Ada 2012 mode
5829 -- N_Use_Type_Clause
5830 -- Sloc points to USE
5831 -- Prev_Use_Clause
5832 -- Used_Operations
5833 -- Next_Use_Clause
5834 -- Subtype_Mark
5835 -- Hidden_By_Use_Clause
5836 -- Is_Effective_Use_Clause
5837 -- More_Ids (set to False if no more identifiers in list)
5838 -- Prev_Ids (set to False if no previous identifiers in list)
5839 -- All_Present
5841 -------------------------------
5842 -- 8.5 Renaming Declaration --
5843 -------------------------------
5845 -- RENAMING_DECLARATION ::=
5846 -- OBJECT_RENAMING_DECLARATION
5847 -- | EXCEPTION_RENAMING_DECLARATION
5848 -- | PACKAGE_RENAMING_DECLARATION
5849 -- | SUBPROGRAM_RENAMING_DECLARATION
5850 -- | GENERIC_RENAMING_DECLARATION
5852 --------------------------------------
5853 -- 8.5 Object Renaming Declaration --
5854 --------------------------------------
5856 -- OBJECT_RENAMING_DECLARATION ::=
5857 -- DEFINING_IDENTIFIER :
5858 -- [NULL_EXCLUSION] SUBTYPE_MARK renames object_NAME
5859 -- [ASPECT_SPECIFICATIONS];
5860 -- | DEFINING_IDENTIFIER :
5861 -- ACCESS_DEFINITION renames object_NAME
5862 -- [ASPECT_SPECIFICATIONS];
5864 -- Note: Access_Definition is an optional field that gives support to
5865 -- Ada 2005 (AI-230). The parser generates nodes that have either the
5866 -- Subtype_Indication field or else the Access_Definition field.
5868 -- N_Object_Renaming_Declaration
5869 -- Sloc points to first identifier
5870 -- Defining_Identifier
5871 -- Null_Exclusion_Present (set to False if not present)
5872 -- Subtype_Mark (set to Empty if not present)
5873 -- Access_Definition (set to Empty if not present)
5874 -- Name
5875 -- Corresponding_Generic_Association
5877 -----------------------------------------
5878 -- 8.5 Exception Renaming Declaration --
5879 -----------------------------------------
5881 -- EXCEPTION_RENAMING_DECLARATION ::=
5882 -- DEFINING_IDENTIFIER : exception renames exception_NAME
5883 -- [ASPECT_SPECIFICATIONS];
5885 -- N_Exception_Renaming_Declaration
5886 -- Sloc points to first identifier
5887 -- Defining_Identifier
5888 -- Name
5890 ---------------------------------------
5891 -- 8.5 Package Renaming Declaration --
5892 ---------------------------------------
5894 -- PACKAGE_RENAMING_DECLARATION ::=
5895 -- package DEFINING_PROGRAM_UNIT_NAME renames package_NAME
5896 -- [ASPECT_SPECIFICATIONS];
5898 -- N_Package_Renaming_Declaration
5899 -- Sloc points to PACKAGE
5900 -- Defining_Unit_Name
5901 -- Name
5902 -- Parent_Spec
5904 ------------------------------------------
5905 -- 8.5 Subprogram Renaming Declaration --
5906 ------------------------------------------
5908 -- SUBPROGRAM_RENAMING_DECLARATION ::=
5909 -- SUBPROGRAM_SPECIFICATION renames callable_entity_NAME
5910 -- [ASPECT_SPECIFICATIONS];
5912 -- N_Subprogram_Renaming_Declaration
5913 -- Sloc points to RENAMES
5914 -- Specification
5915 -- Name
5916 -- Parent_Spec
5917 -- Corresponding_Spec
5918 -- Corresponding_Formal_Spec
5919 -- From_Default
5921 -----------------------------------------
5922 -- 8.5.5 Generic Renaming Declaration --
5923 -----------------------------------------
5925 -- GENERIC_RENAMING_DECLARATION ::=
5926 -- generic package DEFINING_PROGRAM_UNIT_NAME
5927 -- renames generic_package_NAME
5928 -- [ASPECT_SPECIFICATIONS];
5929 -- | generic procedure DEFINING_PROGRAM_UNIT_NAME
5930 -- renames generic_procedure_NAME
5931 -- [ASPECT_SPECIFICATIONS];
5932 -- | generic function DEFINING_PROGRAM_UNIT_NAME
5933 -- renames generic_function_NAME
5934 -- [ASPECT_SPECIFICATIONS];
5936 -- N_Generic_Package_Renaming_Declaration
5937 -- Sloc points to GENERIC
5938 -- Defining_Unit_Name
5939 -- Name
5940 -- Parent_Spec
5942 -- N_Generic_Procedure_Renaming_Declaration
5943 -- Sloc points to GENERIC
5944 -- Defining_Unit_Name
5945 -- Name
5946 -- Parent_Spec
5948 -- N_Generic_Function_Renaming_Declaration
5949 -- Sloc points to GENERIC
5950 -- Defining_Unit_Name
5951 -- Name
5952 -- Parent_Spec
5954 --------------------------------
5955 -- 9.1 Task Type Declaration --
5956 --------------------------------
5958 -- TASK_TYPE_DECLARATION ::=
5959 -- task type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
5960 -- [ASPECT_SPECIFICATIONS]
5961 -- [is [new INTERFACE_LIST with] TASK_DEFINITION];
5963 -- N_Task_Type_Declaration
5964 -- Sloc points to TASK
5965 -- Defining_Identifier
5966 -- Discriminant_Specifications (set to No_List if no
5967 -- discriminant part)
5968 -- Interface_List (set to No_List if none)
5969 -- Task_Definition (set to Empty if not present)
5970 -- Corresponding_Body
5972 ----------------------------------
5973 -- 9.1 Single Task Declaration --
5974 ----------------------------------
5976 -- SINGLE_TASK_DECLARATION ::=
5977 -- task DEFINING_IDENTIFIER
5978 -- [ASPECT_SPECIFICATIONS]
5979 -- [is [new INTERFACE_LIST with] TASK_DEFINITION];
5981 -- N_Single_Task_Declaration
5982 -- Sloc points to TASK
5983 -- Defining_Identifier
5984 -- Interface_List (set to No_List if none)
5985 -- Task_Definition (set to Empty if not present)
5987 --------------------------
5988 -- 9.1 Task Definition --
5989 --------------------------
5991 -- TASK_DEFINITION ::=
5992 -- {TASK_ITEM}
5993 -- [private
5994 -- {TASK_ITEM}]
5995 -- end [task_IDENTIFIER]
5997 -- Note: as a result of semantic analysis, the list of task items can
5998 -- include implicit type declarations resulting from entry families.
6000 -- N_Task_Definition
6001 -- Sloc points to first token of task definition
6002 -- Visible_Declarations
6003 -- Private_Declarations (set to No_List if no private part)
6004 -- End_Label
6005 -- Has_Storage_Size_Pragma
6006 -- Has_Relative_Deadline_Pragma
6008 --------------------
6009 -- 9.1 Task Item --
6010 --------------------
6012 -- TASK_ITEM ::= ENTRY_DECLARATION | REPRESENTATION_CLAUSE
6014 --------------------
6015 -- 9.1 Task Body --
6016 --------------------
6018 -- TASK_BODY ::=
6019 -- task body task_DEFINING_IDENTIFIER
6020 -- [ASPECT_SPECIFICATIONS]
6021 -- is
6022 -- DECLARATIVE_PART
6023 -- begin
6024 -- HANDLED_SEQUENCE_OF_STATEMENTS
6025 -- end [task_IDENTIFIER];
6027 -- Gigi restriction: This node never appears
6029 -- N_Task_Body
6030 -- Sloc points to TASK
6031 -- Defining_Identifier
6032 -- Declarations
6033 -- Handled_Statement_Sequence
6034 -- Is_Task_Master
6035 -- Activation_Chain_Entity
6036 -- Corresponding_Spec
6037 -- Was_Originally_Stub
6039 -------------------------------------
6040 -- 9.4 Protected Type Declaration --
6041 -------------------------------------
6043 -- PROTECTED_TYPE_DECLARATION ::=
6044 -- protected type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
6045 -- [ASPECT_SPECIFICATIONS]
6046 -- is [new INTERFACE_LIST with] PROTECTED_DEFINITION;
6048 -- Note: protected type declarations are not permitted in Ada 83 mode
6050 -- N_Protected_Type_Declaration
6051 -- Sloc points to PROTECTED
6052 -- Defining_Identifier
6053 -- Discriminant_Specifications (set to No_List if no
6054 -- discriminant part)
6055 -- Interface_List (set to No_List if none)
6056 -- Protected_Definition
6057 -- Corresponding_Body
6059 ---------------------------------------
6060 -- 9.4 Single Protected Declaration --
6061 ---------------------------------------
6063 -- SINGLE_PROTECTED_DECLARATION ::=
6064 -- protected DEFINING_IDENTIFIER
6065 -- [ASPECT_SPECIFICATIONS]
6066 -- is [new INTERFACE_LIST with] PROTECTED_DEFINITION;
6068 -- Note: single protected declarations are not allowed in Ada 83 mode
6070 -- N_Single_Protected_Declaration
6071 -- Sloc points to PROTECTED
6072 -- Defining_Identifier
6073 -- Interface_List (set to No_List if none)
6074 -- Protected_Definition
6076 -------------------------------
6077 -- 9.4 Protected Definition --
6078 -------------------------------
6080 -- PROTECTED_DEFINITION ::=
6081 -- {PROTECTED_OPERATION_DECLARATION}
6082 -- [private
6083 -- {PROTECTED_ELEMENT_DECLARATION}]
6084 -- end [protected_IDENTIFIER]
6086 -- N_Protected_Definition
6087 -- Sloc points to first token of protected definition
6088 -- Visible_Declarations
6089 -- Private_Declarations (set to No_List if no private part)
6090 -- End_Label
6092 ------------------------------------------
6093 -- 9.4 Protected Operation Declaration --
6094 ------------------------------------------
6096 -- PROTECTED_OPERATION_DECLARATION ::=
6097 -- SUBPROGRAM_DECLARATION
6098 -- | ENTRY_DECLARATION
6099 -- | REPRESENTATION_CLAUSE
6101 ----------------------------------------
6102 -- 9.4 Protected Element Declaration --
6103 ----------------------------------------
6105 -- PROTECTED_ELEMENT_DECLARATION ::=
6106 -- PROTECTED_OPERATION_DECLARATION | COMPONENT_DECLARATION
6108 -------------------------
6109 -- 9.4 Protected Body --
6110 -------------------------
6112 -- PROTECTED_BODY ::=
6113 -- protected body DEFINING_IDENTIFIER
6114 -- [ASPECT_SPECIFICATIONS];
6115 -- is
6116 -- {PROTECTED_OPERATION_ITEM}
6117 -- end [protected_IDENTIFIER];
6119 -- Note: protected bodies are not allowed in Ada 83 mode
6121 -- Gigi restriction: This node never appears
6123 -- N_Protected_Body
6124 -- Sloc points to PROTECTED
6125 -- Defining_Identifier
6126 -- Declarations protected operation items (and pragmas)
6127 -- End_Label
6128 -- Corresponding_Spec
6129 -- Was_Originally_Stub
6131 -----------------------------------
6132 -- 9.4 Protected Operation Item --
6133 -----------------------------------
6135 -- PROTECTED_OPERATION_ITEM ::=
6136 -- SUBPROGRAM_DECLARATION
6137 -- | SUBPROGRAM_BODY
6138 -- | ENTRY_BODY
6139 -- | REPRESENTATION_CLAUSE
6141 ------------------------------
6142 -- 9.5.2 Entry Declaration --
6143 ------------------------------
6145 -- ENTRY_DECLARATION ::=
6146 -- [[not] overriding]
6147 -- entry DEFINING_IDENTIFIER
6148 -- [(DISCRETE_SUBTYPE_DEFINITION)] PARAMETER_PROFILE
6149 -- [ASPECT_SPECIFICATIONS];
6151 -- N_Entry_Declaration
6152 -- Sloc points to ENTRY
6153 -- Defining_Identifier
6154 -- Discrete_Subtype_Definition (set to Empty if not present)
6155 -- Parameter_Specifications (set to No_List if no formal part)
6156 -- Corresponding_Body
6157 -- Must_Override set if overriding indicator present
6158 -- Must_Not_Override set if not_overriding indicator present
6160 -- Note: overriding indicator is an Ada 2005 feature
6162 -----------------------------
6163 -- 9.5.2 Accept statement --
6164 -----------------------------
6166 -- ACCEPT_STATEMENT ::=
6167 -- accept entry_DIRECT_NAME
6168 -- [(ENTRY_INDEX)] PARAMETER_PROFILE [do
6169 -- HANDLED_SEQUENCE_OF_STATEMENTS
6170 -- end [entry_IDENTIFIER]];
6172 -- Gigi restriction: This node never appears
6174 -- Note: there are no explicit declarations allowed in an accept
6175 -- statement. However, the implicit declarations for any statement
6176 -- identifiers (labels and block/loop identifiers) are declarations
6177 -- that belong logically to the accept statement, and that is why
6178 -- there is a Declarations field in this node.
6180 -- N_Accept_Statement
6181 -- Sloc points to ACCEPT
6182 -- Entry_Direct_Name
6183 -- Entry_Index (set to Empty if not present)
6184 -- Parameter_Specifications (set to No_List if no formal part)
6185 -- Handled_Statement_Sequence
6186 -- Declarations (set to No_List if no declarations)
6188 ------------------------
6189 -- 9.5.2 Entry Index --
6190 ------------------------
6192 -- ENTRY_INDEX ::= EXPRESSION
6194 -----------------------
6195 -- 9.5.2 Entry Body --
6196 -----------------------
6198 -- ENTRY_BODY ::=
6199 -- entry DEFINING_IDENTIFIER ENTRY_BODY_FORMAL_PART ENTRY_BARRIER is
6200 -- DECLARATIVE_PART
6201 -- begin
6202 -- HANDLED_SEQUENCE_OF_STATEMENTS
6203 -- end [entry_IDENTIFIER];
6205 -- ENTRY_BARRIER ::= when CONDITION
6207 -- Note: we store the CONDITION of the ENTRY_BARRIER in the node for
6208 -- the ENTRY_BODY_FORMAL_PART to avoid the N_Entry_Body node getting
6209 -- too full (it would otherwise have too many fields)
6211 -- Gigi restriction: This node never appears
6213 -- N_Entry_Body
6214 -- Sloc points to ENTRY
6215 -- Defining_Identifier
6216 -- Entry_Body_Formal_Part
6217 -- Declarations
6218 -- Handled_Statement_Sequence
6219 -- Activation_Chain_Entity
6220 -- Corresponding_Spec
6221 -- At_End_Proc (set to Empty if no clean up procedure)
6223 -----------------------------------
6224 -- 9.5.2 Entry Body Formal Part --
6225 -----------------------------------
6227 -- ENTRY_BODY_FORMAL_PART ::=
6228 -- [(ENTRY_INDEX_SPECIFICATION)] PARAMETER_PROFILE
6230 -- Note that an entry body formal part node is present even if it is
6231 -- empty. This reflects the grammar, in which it is the components of
6232 -- the entry body formal part that are optional, not the entry body
6233 -- formal part itself. Also this means that the barrier condition
6234 -- always has somewhere to be stored.
6236 -- Gigi restriction: This node never appears
6238 -- N_Entry_Body_Formal_Part
6239 -- Sloc points to first token
6240 -- Entry_Index_Specification (set to Empty if not present)
6241 -- Parameter_Specifications (set to No_List if no formal part)
6242 -- Condition from entry barrier of entry body
6244 --------------------------
6245 -- 9.5.2 Entry Barrier --
6246 --------------------------
6248 -- ENTRY_BARRIER ::= when CONDITION
6250 --------------------------------------
6251 -- 9.5.2 Entry Index Specification --
6252 --------------------------------------
6254 -- ENTRY_INDEX_SPECIFICATION ::=
6255 -- for DEFINING_IDENTIFIER in DISCRETE_SUBTYPE_DEFINITION
6257 -- Gigi restriction: This node never appears
6259 -- N_Entry_Index_Specification
6260 -- Sloc points to FOR
6261 -- Defining_Identifier
6262 -- Discrete_Subtype_Definition
6264 ---------------------------------
6265 -- 9.5.3 Entry Call Statement --
6266 ---------------------------------
6268 -- ENTRY_CALL_STATEMENT ::= entry_NAME [ACTUAL_PARAMETER_PART];
6270 -- The parser may generate a procedure call for this construct. The
6271 -- semantic pass must correct this misidentification where needed.
6273 -- Gigi restriction: This node never appears
6275 -- N_Entry_Call_Statement
6276 -- Sloc points to first token of name
6277 -- Name
6278 -- Parameter_Associations (set to No_List if no
6279 -- actual parameter part)
6280 -- First_Named_Actual
6281 -- Is_Elaboration_Checks_OK_Node
6282 -- Is_SPARK_Mode_On_Node
6283 -- Is_Elaboration_Warnings_OK_Node
6285 ------------------------------
6286 -- 9.5.4 Requeue Statement --
6287 ------------------------------
6289 -- REQUEUE_STATEMENT ::= requeue entry_NAME [with abort];
6291 -- Note: requeue statements are not permitted in Ada 83 mode
6293 -- Gigi restriction: This node never appears
6295 -- N_Requeue_Statement
6296 -- Sloc points to REQUEUE
6297 -- Name
6298 -- Abort_Present
6299 -- Is_Elaboration_Checks_OK_Node
6300 -- Is_SPARK_Mode_On_Node
6301 -- Is_Elaboration_Warnings_OK_Node
6303 --------------------------
6304 -- 9.6 Delay Statement --
6305 --------------------------
6307 -- DELAY_STATEMENT ::=
6308 -- DELAY_UNTIL_STATEMENT
6309 -- | DELAY_RELATIVE_STATEMENT
6311 --------------------------------
6312 -- 9.6 Delay Until Statement --
6313 --------------------------------
6315 -- DELAY_UNTIL_STATEMENT ::= delay until delay_EXPRESSION;
6317 -- Note: delay until statements are not permitted in Ada 83 mode
6319 -- Gigi restriction: This node never appears
6321 -- N_Delay_Until_Statement
6322 -- Sloc points to DELAY
6323 -- Expression
6325 -----------------------------------
6326 -- 9.6 Delay Relative Statement --
6327 -----------------------------------
6329 -- DELAY_RELATIVE_STATEMENT ::= delay delay_EXPRESSION;
6331 -- Gigi restriction: This node never appears
6333 -- N_Delay_Relative_Statement
6334 -- Sloc points to DELAY
6335 -- Expression
6337 ---------------------------
6338 -- 9.7 Select Statement --
6339 ---------------------------
6341 -- SELECT_STATEMENT ::=
6342 -- SELECTIVE_ACCEPT
6343 -- | TIMED_ENTRY_CALL
6344 -- | CONDITIONAL_ENTRY_CALL
6345 -- | ASYNCHRONOUS_SELECT
6347 -----------------------------
6348 -- 9.7.1 Selective Accept --
6349 -----------------------------
6351 -- SELECTIVE_ACCEPT ::=
6352 -- select
6353 -- [GUARD]
6354 -- SELECT_ALTERNATIVE
6355 -- {or
6356 -- [GUARD]
6357 -- SELECT_ALTERNATIVE}
6358 -- [else
6359 -- SEQUENCE_OF_STATEMENTS]
6360 -- end select;
6362 -- Gigi restriction: This node never appears
6364 -- Note: the guard expression, if present, appears in the node for
6365 -- the select alternative.
6367 -- N_Selective_Accept
6368 -- Sloc points to SELECT
6369 -- Select_Alternatives
6370 -- Else_Statements (set to No_List if no else part)
6372 ------------------
6373 -- 9.7.1 Guard --
6374 ------------------
6376 -- GUARD ::= when CONDITION =>
6378 -- As noted above, the CONDITION that is part of a GUARD is included
6379 -- in the node for the select alternative for convenience.
6381 -------------------------------
6382 -- 9.7.1 Select Alternative --
6383 -------------------------------
6385 -- SELECT_ALTERNATIVE ::=
6386 -- ACCEPT_ALTERNATIVE
6387 -- | DELAY_ALTERNATIVE
6388 -- | TERMINATE_ALTERNATIVE
6390 -------------------------------
6391 -- 9.7.1 Accept Alternative --
6392 -------------------------------
6394 -- ACCEPT_ALTERNATIVE ::=
6395 -- ACCEPT_STATEMENT [SEQUENCE_OF_STATEMENTS]
6397 -- Gigi restriction: This node never appears
6399 -- N_Accept_Alternative
6400 -- Sloc points to ACCEPT
6401 -- Accept_Statement
6402 -- Condition from the guard (set to Empty if no guard present)
6403 -- Statements (set to Empty_List if no statements)
6404 -- Pragmas_Before pragmas before alt (set to No_List if none)
6405 -- Accept_Handler_Records
6407 ------------------------------
6408 -- 9.7.1 Delay Alternative --
6409 ------------------------------
6411 -- DELAY_ALTERNATIVE ::=
6412 -- DELAY_STATEMENT [SEQUENCE_OF_STATEMENTS]
6414 -- Gigi restriction: This node never appears
6416 -- N_Delay_Alternative
6417 -- Sloc points to DELAY
6418 -- Delay_Statement
6419 -- Condition from the guard (set to Empty if no guard present)
6420 -- Statements (set to Empty_List if no statements)
6421 -- Pragmas_Before pragmas before alt (set to No_List if none)
6423 ----------------------------------
6424 -- 9.7.1 Terminate Alternative --
6425 ----------------------------------
6427 -- TERMINATE_ALTERNATIVE ::= terminate;
6429 -- Gigi restriction: This node never appears
6431 -- N_Terminate_Alternative
6432 -- Sloc points to TERMINATE
6433 -- Condition from the guard (set to Empty if no guard present)
6434 -- Pragmas_Before pragmas before alt (set to No_List if none)
6435 -- Pragmas_After pragmas after alt (set to No_List if none)
6437 -----------------------------
6438 -- 9.7.2 Timed Entry Call --
6439 -----------------------------
6441 -- TIMED_ENTRY_CALL ::=
6442 -- select
6443 -- ENTRY_CALL_ALTERNATIVE
6444 -- or
6445 -- DELAY_ALTERNATIVE
6446 -- end select;
6448 -- Gigi restriction: This node never appears
6450 -- N_Timed_Entry_Call
6451 -- Sloc points to SELECT
6452 -- Entry_Call_Alternative
6453 -- Delay_Alternative
6455 -----------------------------------
6456 -- 9.7.2 Entry Call Alternative --
6457 -----------------------------------
6459 -- ENTRY_CALL_ALTERNATIVE ::=
6460 -- PROCEDURE_OR_ENTRY_CALL [SEQUENCE_OF_STATEMENTS]
6462 -- PROCEDURE_OR_ENTRY_CALL ::=
6463 -- PROCEDURE_CALL_STATEMENT | ENTRY_CALL_STATEMENT
6465 -- Gigi restriction: This node never appears
6467 -- N_Entry_Call_Alternative
6468 -- Sloc points to first token of entry call statement
6469 -- Entry_Call_Statement
6470 -- Statements (set to Empty_List if no statements)
6471 -- Pragmas_Before pragmas before alt (set to No_List if none)
6473 -----------------------------------
6474 -- 9.7.3 Conditional Entry Call --
6475 -----------------------------------
6477 -- CONDITIONAL_ENTRY_CALL ::=
6478 -- select
6479 -- ENTRY_CALL_ALTERNATIVE
6480 -- else
6481 -- SEQUENCE_OF_STATEMENTS
6482 -- end select;
6484 -- Gigi restriction: This node never appears
6486 -- N_Conditional_Entry_Call
6487 -- Sloc points to SELECT
6488 -- Entry_Call_Alternative
6489 -- Else_Statements
6491 --------------------------------
6492 -- 9.7.4 Asynchronous Select --
6493 --------------------------------
6495 -- ASYNCHRONOUS_SELECT ::=
6496 -- select
6497 -- TRIGGERING_ALTERNATIVE
6498 -- then abort
6499 -- ABORTABLE_PART
6500 -- end select;
6502 -- Note: asynchronous select is not permitted in Ada 83 mode
6504 -- Gigi restriction: This node never appears
6506 -- N_Asynchronous_Select
6507 -- Sloc points to SELECT
6508 -- Triggering_Alternative
6509 -- Abortable_Part
6511 -----------------------------------
6512 -- 9.7.4 Triggering Alternative --
6513 -----------------------------------
6515 -- TRIGGERING_ALTERNATIVE ::=
6516 -- TRIGGERING_STATEMENT [SEQUENCE_OF_STATEMENTS]
6518 -- Gigi restriction: This node never appears
6520 -- N_Triggering_Alternative
6521 -- Sloc points to first token of triggering statement
6522 -- Triggering_Statement
6523 -- Statements (set to Empty_List if no statements)
6524 -- Pragmas_Before pragmas before alt (set to No_List if none)
6526 ---------------------------------
6527 -- 9.7.4 Triggering Statement --
6528 ---------------------------------
6530 -- TRIGGERING_STATEMENT ::= PROCEDURE_OR_ENTRY_CALL | DELAY_STATEMENT
6532 ---------------------------
6533 -- 9.7.4 Abortable Part --
6534 ---------------------------
6536 -- ABORTABLE_PART ::= SEQUENCE_OF_STATEMENTS
6538 -- Gigi restriction: This node never appears
6540 -- N_Abortable_Part
6541 -- Sloc points to ABORT
6542 -- Statements
6544 --------------------------
6545 -- 9.8 Abort Statement --
6546 --------------------------
6548 -- ABORT_STATEMENT ::= abort task_NAME {, task_NAME};
6550 -- Gigi restriction: This node never appears
6552 -- N_Abort_Statement
6553 -- Sloc points to ABORT
6554 -- Names
6556 -------------------------
6557 -- 10.1.1 Compilation --
6558 -------------------------
6560 -- COMPILATION ::= {COMPILATION_UNIT}
6562 -- There is no explicit node in the tree for a compilation, since in
6563 -- general the compiler is processing only a single compilation unit
6564 -- at a time. It is possible to parse multiple units in syntax check
6565 -- only mode, but the trees are discarded in that case.
6567 ------------------------------
6568 -- 10.1.1 Compilation Unit --
6569 ------------------------------
6571 -- COMPILATION_UNIT ::=
6572 -- CONTEXT_CLAUSE LIBRARY_ITEM
6573 -- | CONTEXT_CLAUSE SUBUNIT
6575 -- The N_Compilation_Unit node itself represents the above syntax.
6576 -- However, there are two additional items not reflected in the above
6577 -- syntax. First we have the global declarations that are added by the
6578 -- code generator. These are outer level declarations (so they cannot
6579 -- be represented as being inside the units). An example is the wrapper
6580 -- subprograms that are created to do ABE checking. As always a list of
6581 -- declarations can contain actions as well (i.e. statements), and such
6582 -- statements are executed as part of the elaboration of the unit. Note
6583 -- that all such declarations are elaborated before the library unit.
6585 -- Similarly, certain actions need to be elaborated at the completion
6586 -- of elaboration of the library unit (notably the statement that sets
6587 -- the Boolean flag indicating that elaboration is complete).
6589 -- The third item not reflected in the syntax is pragmas that appear
6590 -- after the compilation unit. As always pragmas are a problem since
6591 -- they are not part of the formal syntax, but can be stuck into the
6592 -- source following a set of ad hoc rules, and we have to find an ad
6593 -- hoc way of sticking them into the tree. For pragmas that appear
6594 -- before the library unit, we just consider them to be part of the
6595 -- context clause, and pragmas can appear in the Context_Items list
6596 -- of the compilation unit. However, pragmas can also appear after
6597 -- the library item.
6599 -- To deal with all these problems, we create an auxiliary node for
6600 -- a compilation unit, referenced from the N_Compilation_Unit node,
6601 -- that contains these items.
6603 -- N_Compilation_Unit
6604 -- Sloc points to first token of defining unit name
6605 -- Context_Items context items and pragmas preceding unit
6606 -- Private_Present set if library unit has private keyword
6607 -- Unit library item or subunit
6608 -- Aux_Decls_Node points to the N_Compilation_Unit_Aux node
6609 -- First_Inlined_Subprogram
6610 -- Library_Unit corresponding/parent spec/body
6611 -- Save_Invocation_Graph_Of_Body
6612 -- Acts_As_Spec flag for subprogram body with no spec
6613 -- Body_Required set for spec if body is required
6614 -- Has_Pragma_Suppress_All
6615 -- Context_Pending
6616 -- Has_No_Elaboration_Code
6618 -- N_Compilation_Unit_Aux
6619 -- Sloc is a copy of the Sloc from the N_Compilation_Unit node
6620 -- Declarations (set to No_List if no global declarations)
6621 -- Actions (set to No_List if no actions)
6622 -- Pragmas_After pragmas after unit (set to No_List if none)
6623 -- Config_Pragmas config pragmas (set to Empty_List if none)
6624 -- Default_Storage_Pool
6626 --------------------------
6627 -- 10.1.1 Library Item --
6628 --------------------------
6630 -- LIBRARY_ITEM ::=
6631 -- [private] LIBRARY_UNIT_DECLARATION
6632 -- | LIBRARY_UNIT_BODY
6633 -- | [private] LIBRARY_UNIT_RENAMING_DECLARATION
6635 -- Note: PRIVATE is not allowed in Ada 83 mode
6637 -- There is no explicit node in the tree for library item, instead
6638 -- the declaration or body, and the flag for private if present,
6639 -- appear in the N_Compilation_Unit node.
6641 --------------------------------------
6642 -- 10.1.1 Library Unit Declaration --
6643 --------------------------------------
6645 -- LIBRARY_UNIT_DECLARATION ::=
6646 -- SUBPROGRAM_DECLARATION | PACKAGE_DECLARATION
6647 -- | GENERIC_DECLARATION | GENERIC_INSTANTIATION
6649 -----------------------------------------------
6650 -- 10.1.1 Library Unit Renaming Declaration --
6651 -----------------------------------------------
6653 -- LIBRARY_UNIT_RENAMING_DECLARATION ::=
6654 -- PACKAGE_RENAMING_DECLARATION
6655 -- | GENERIC_RENAMING_DECLARATION
6656 -- | SUBPROGRAM_RENAMING_DECLARATION
6658 -------------------------------
6659 -- 10.1.1 Library unit body --
6660 -------------------------------
6662 -- LIBRARY_UNIT_BODY ::= SUBPROGRAM_BODY | PACKAGE_BODY
6664 ------------------------------
6665 -- 10.1.1 Parent Unit Name --
6666 ------------------------------
6668 -- PARENT_UNIT_NAME ::= NAME
6670 ----------------------------
6671 -- 10.1.2 Context clause --
6672 ----------------------------
6674 -- CONTEXT_CLAUSE ::= {CONTEXT_ITEM}
6676 -- The context clause can include pragmas, and any pragmas that appear
6677 -- before the context clause proper (i.e. all configuration pragmas,
6678 -- also appear at the front of this list).
6680 --------------------------
6681 -- 10.1.2 Context_Item --
6682 --------------------------
6684 -- CONTEXT_ITEM ::= WITH_CLAUSE | USE_CLAUSE | WITH_TYPE_CLAUSE
6686 -------------------------
6687 -- 10.1.2 With clause --
6688 -------------------------
6690 -- WITH_CLAUSE ::=
6691 -- with library_unit_NAME {,library_unit_NAME};
6693 -- A separate With clause is built for each name, so that we have
6694 -- a Corresponding_Spec field for each with'ed spec. The flags
6695 -- First_Name and Last_Name are used to reconstruct the exact
6696 -- source form. When a list of names appears in one with clause,
6697 -- the first name in the list has First_Name set, and the last
6698 -- has Last_Name set. If the with clause has only one name, then
6699 -- both of the flags First_Name and Last_Name are set in this name.
6701 -- Note: in the case of implicit with's that are installed by the
6702 -- Rtsfind routine, Implicit_With is set, and the Sloc is typically
6703 -- set to Standard_Location, but it is incorrect to test the Sloc
6704 -- to find out if a with clause is implicit, test the flag instead.
6706 -- N_With_Clause
6707 -- Sloc points to first token of library unit name
6708 -- Name
6709 -- Private_Present set if with_clause has private keyword
6710 -- Limited_Present set if LIMITED is present
6711 -- Next_Implicit_With
6712 -- Library_Unit
6713 -- Corresponding_Spec
6714 -- First_Name (set to True if first name or only one name)
6715 -- Last_Name (set to True if last name or only one name)
6716 -- Context_Installed
6717 -- Elaborate_Present
6718 -- Elaborate_All_Present
6719 -- Elaborate_All_Desirable
6720 -- Elaborate_Desirable
6721 -- Implicit_With
6722 -- Limited_View_Installed
6723 -- Parent_With
6724 -- Unreferenced_In_Spec
6725 -- No_Entities_Ref_In_Spec
6727 -- Note: Limited_Present and Limited_View_Installed are used to support
6728 -- the implementation of Ada 2005 (AI-50217).
6730 -- Similarly, Private_Present is used to support the implementation of
6731 -- Ada 2005 (AI-50262).
6733 -- Note: if the WITH clause refers to a standard library unit, then a
6734 -- limited with clause is changed into a normal with clause, because we
6735 -- are not prepared to deal with limited with in the context of Rtsfind.
6736 -- So in this case, the Limited_Present flag will be False in the final
6737 -- tree.
6739 ----------------------
6740 -- With_Type clause --
6741 ----------------------
6743 -- This is a GNAT extension, used to implement mutually recursive
6744 -- types declared in different packages.
6746 -- Note: this is now obsolete. The functionality of this construct
6747 -- is now implemented by the Ada 2005 limited_with_clause.
6749 ---------------------
6750 -- 10.2 Body stub --
6751 ---------------------
6753 -- BODY_STUB ::=
6754 -- SUBPROGRAM_BODY_STUB
6755 -- | PACKAGE_BODY_STUB
6756 -- | TASK_BODY_STUB
6757 -- | PROTECTED_BODY_STUB
6759 ----------------------------------
6760 -- 10.1.3 Subprogram Body Stub --
6761 ----------------------------------
6763 -- SUBPROGRAM_BODY_STUB ::=
6764 -- SUBPROGRAM_SPECIFICATION is separate
6765 -- [ASPECT_SPECIFICATION];
6767 -- N_Subprogram_Body_Stub
6768 -- Sloc points to FUNCTION or PROCEDURE
6769 -- Specification
6770 -- Corresponding_Spec_Of_Stub
6771 -- Library_Unit points to the subunit
6772 -- Corresponding_Body
6773 -- At_End_Proc (set to Empty if no clean up procedure)
6775 -------------------------------
6776 -- 10.1.3 Package Body Stub --
6777 -------------------------------
6779 -- PACKAGE_BODY_STUB ::=
6780 -- package body DEFINING_IDENTIFIER is separate
6781 -- [ASPECT_SPECIFICATION];
6783 -- N_Package_Body_Stub
6784 -- Sloc points to PACKAGE
6785 -- Defining_Identifier
6786 -- Corresponding_Spec_Of_Stub
6787 -- Library_Unit points to the subunit
6788 -- Corresponding_Body
6790 ----------------------------
6791 -- 10.1.3 Task Body Stub --
6792 ----------------------------
6794 -- TASK_BODY_STUB ::=
6795 -- task body DEFINING_IDENTIFIER is separate
6796 -- [ASPECT_SPECIFICATION];
6798 -- N_Task_Body_Stub
6799 -- Sloc points to TASK
6800 -- Defining_Identifier
6801 -- Corresponding_Spec_Of_Stub
6802 -- Library_Unit points to the subunit
6803 -- Corresponding_Body
6804 -- At_End_Proc (set to Empty if no clean up procedure)
6806 ---------------------------------
6807 -- 10.1.3 Protected Body Stub --
6808 ---------------------------------
6810 -- PROTECTED_BODY_STUB ::=
6811 -- protected body DEFINING_IDENTIFIER is separate
6812 -- [ASPECT_SPECIFICATION];
6814 -- Note: protected body stubs are not allowed in Ada 83 mode
6816 -- N_Protected_Body_Stub
6817 -- Sloc points to PROTECTED
6818 -- Defining_Identifier
6819 -- Corresponding_Spec_Of_Stub
6820 -- Library_Unit points to the subunit
6821 -- Corresponding_Body
6823 ---------------------
6824 -- 10.1.3 Subunit --
6825 ---------------------
6827 -- SUBUNIT ::= separate (PARENT_UNIT_NAME) PROPER_BODY
6829 -- N_Subunit
6830 -- Sloc points to SEPARATE
6831 -- Name is the name of the parent unit
6832 -- Proper_Body is the subunit body
6833 -- Corresponding_Stub is the stub declaration for the unit.
6835 ---------------------------------
6836 -- 11.1 Exception Declaration --
6837 ---------------------------------
6839 -- EXCEPTION_DECLARATION ::= DEFINING_IDENTIFIER_LIST : exception
6840 -- [ASPECT_SPECIFICATIONS];
6842 -- For consistency with object declarations etc., the parser converts
6843 -- the case of multiple identifiers being declared to a series of
6844 -- declarations in which the expression is copied, using the More_Ids
6845 -- and Prev_Ids flags to remember the source form as described in the
6846 -- section on "Handling of Defining Identifier Lists".
6848 -- N_Exception_Declaration
6849 -- Sloc points to EXCEPTION
6850 -- Defining_Identifier
6851 -- Expression
6852 -- Renaming_Exception
6853 -- More_Ids (set to False if no more identifiers in list)
6854 -- Prev_Ids (set to False if no previous identifiers in list)
6856 ------------------------------------------
6857 -- 11.2 Handled Sequence Of Statements --
6858 ------------------------------------------
6860 -- HANDLED_SEQUENCE_OF_STATEMENTS ::=
6861 -- SEQUENCE_OF_STATEMENTS
6862 -- [exception
6863 -- EXCEPTION_HANDLER
6864 -- {EXCEPTION_HANDLER}]
6865 -- [at end
6866 -- cleanup_procedure_call (param, param, param, ...);]
6868 -- The AT END phrase is a GNAT extension to provide for cleanups. It is
6869 -- used only internally currently, but is considered to be syntactic.
6870 -- At the moment, the only cleanup action allowed is a single call to a
6871 -- parameterless procedure; this restriction could be lifted if we make
6872 -- some changes in gigi. The At_End_Proc field is an N_Identifier node
6873 -- that denotes the procedure to be called. The cleanup action occurs
6874 -- whenever the sequence of statements is left for any reason. The
6875 -- possible reasons are:
6877 -- 1. reaching the end of the sequence
6878 -- 2. exit, return, or goto
6879 -- 3. exception or abort
6881 -- The cleanup action also occurs whenever the exception handlers are
6882 -- left.
6884 -- The AT END cleanup handler protects only the sequence of statements
6885 -- and the exception handlers (not the associated declarations of
6886 -- the parent), just like exception handlers do not protect the
6887 -- declarations. The big difference is that the cleanup actions occur
6888 -- on either a normal or an abnormal exit from the statement sequence.
6890 -- At_End_Proc is also a field of various nodes that can contain
6891 -- both Declarations and Handled_Statement_Sequence, such as subprogram
6892 -- bodies and block statements. In that case, the At_End_Proc
6893 -- protects the Declarations as well as the Handled_Statement_Sequence.
6895 -- Note: the list of Exception_Handlers can contain pragmas as well
6896 -- as actual handlers. In practice these pragmas can only occur at
6897 -- the start of the list, since any pragmas occurring later on will
6898 -- be included in the statement list of the corresponding handler.
6900 -- Note: although in the Ada syntax, the sequence of statements in
6901 -- a handled sequence of statements can only contain statements, we
6902 -- allow free mixing of declarations and statements in the resulting
6903 -- expanded tree. This is for example used to deal with the case of
6904 -- a cleanup procedure that must handle declarations as well as the
6905 -- statements of a block.
6907 -- Note: the cleanup_procedure_call does not go through the common
6908 -- processing for calls, which in particular means that it will not be
6909 -- automatically inlined in all cases, even though the procedure to be
6910 -- called is marked inline. More specifically, if the procedure comes
6911 -- from another unit than the main source unit, for example a run-time
6912 -- unit, then it needs to be manually added to the list of bodies to be
6913 -- inlined by invoking Add_Inlined_Body on it.
6915 -- N_Handled_Sequence_Of_Statements
6916 -- Sloc points to first token of first statement
6917 -- Statements
6918 -- End_Label (set to Empty if expander generated)
6919 -- Exception_Handlers (set to No_List if none present)
6920 -- At_End_Proc (set to Empty if no clean up procedure)
6922 -- Note: A Handled_Sequence_Of_Statements can contain both
6923 -- Exception_Handlers and an At_End_Proc.
6925 -- Note: the parent always contains a Declarations field which contains
6926 -- declarations associated with the handled sequence of statements. This
6927 -- is true even in the case of an accept statement (see description of
6928 -- the N_Accept_Statement node).
6930 -- End_Label refers to the containing construct
6932 -----------------------------
6933 -- 11.2 Exception Handler --
6934 -----------------------------
6936 -- EXCEPTION_HANDLER ::=
6937 -- when [CHOICE_PARAMETER_SPECIFICATION :]
6938 -- EXCEPTION_CHOICE {| EXCEPTION_CHOICE} =>
6939 -- SEQUENCE_OF_STATEMENTS
6941 -- Note: choice parameter specification is not allowed in Ada 83 mode
6943 -- N_Exception_Handler
6944 -- Sloc points to WHEN
6945 -- Choice_Parameter (set to Empty if not present)
6946 -- Exception_Choices
6947 -- Statements
6948 -- Exception_Label (set to Empty if not present)
6949 -- Local_Raise_Statements (set to No_Elist if not present)
6950 -- Local_Raise_Not_OK
6951 -- Has_Local_Raise
6953 ------------------------------------------
6954 -- 11.2 Choice parameter specification --
6955 ------------------------------------------
6957 -- CHOICE_PARAMETER_SPECIFICATION ::= DEFINING_IDENTIFIER
6959 ----------------------------
6960 -- 11.2 Exception Choice --
6961 ----------------------------
6963 -- EXCEPTION_CHOICE ::= exception_NAME | others
6965 -- Except in the case of OTHERS, no explicit node appears in the tree
6966 -- for exception choice. Instead the exception name appears directly.
6967 -- An OTHERS choice is represented by a N_Others_Choice node (see
6968 -- section 3.8.1.
6970 -- Note: for the exception choice created for an at end handler, the
6971 -- exception choice is an N_Others_Choice node with All_Others set.
6973 ---------------------------
6974 -- 11.3 Raise Statement --
6975 ---------------------------
6977 -- RAISE_STATEMENT ::= raise [exception_NAME];
6979 -- In Ada 2005, we have
6981 -- RAISE_STATEMENT ::=
6982 -- raise; | raise exception_NAME [with string_EXPRESSION];
6984 -- N_Raise_Statement
6985 -- Sloc points to RAISE
6986 -- Name (set to Empty if no exception name present)
6987 -- Expression (set to Empty if no expression present)
6989 ----------------------------
6990 -- 11.3 Raise Expression --
6991 ----------------------------
6993 -- RAISE_EXPRESSION ::= raise exception_NAME [with string_EXPRESSION]
6995 -- N_Raise_Expression
6996 -- Sloc points to RAISE
6997 -- Name (always present)
6998 -- Expression (set to Empty if no expression present)
6999 -- plus fields for expression
7001 -------------------------------
7002 -- 12.1 Generic Declaration --
7003 -------------------------------
7005 -- GENERIC_DECLARATION ::=
7006 -- GENERIC_SUBPROGRAM_DECLARATION | GENERIC_PACKAGE_DECLARATION
7008 ------------------------------------------
7009 -- 12.1 Generic Subprogram Declaration --
7010 ------------------------------------------
7012 -- GENERIC_SUBPROGRAM_DECLARATION ::=
7013 -- GENERIC_FORMAL_PART SUBPROGRAM_SPECIFICATION
7014 -- [ASPECT_SPECIFICATIONS];
7016 -- Note: Generic_Formal_Declarations can include pragmas
7018 -- N_Generic_Subprogram_Declaration
7019 -- Sloc points to GENERIC
7020 -- Specification subprogram specification
7021 -- Corresponding_Body
7022 -- Generic_Formal_Declarations from generic formal part
7023 -- Parent_Spec
7025 ---------------------------------------
7026 -- 12.1 Generic Package Declaration --
7027 ---------------------------------------
7029 -- GENERIC_PACKAGE_DECLARATION ::=
7030 -- GENERIC_FORMAL_PART PACKAGE_SPECIFICATION
7031 -- [ASPECT_SPECIFICATIONS];
7033 -- Note: when we do generics right, the Activation_Chain_Entity entry
7034 -- for this node can be removed (since the expander won't see generic
7035 -- units any more)???.
7037 -- Note: Generic_Formal_Declarations can include pragmas
7039 -- N_Generic_Package_Declaration
7040 -- Sloc points to GENERIC
7041 -- Specification package specification
7042 -- Corresponding_Body
7043 -- Generic_Formal_Declarations from generic formal part
7044 -- Parent_Spec
7045 -- Activation_Chain_Entity
7047 -------------------------------
7048 -- 12.1 Generic Formal Part --
7049 -------------------------------
7051 -- GENERIC_FORMAL_PART ::=
7052 -- generic {GENERIC_FORMAL_PARAMETER_DECLARATION | USE_CLAUSE}
7054 ------------------------------------------------
7055 -- 12.1 Generic Formal Parameter Declaration --
7056 ------------------------------------------------
7058 -- GENERIC_FORMAL_PARAMETER_DECLARATION ::=
7059 -- FORMAL_OBJECT_DECLARATION
7060 -- | FORMAL_TYPE_DECLARATION
7061 -- | FORMAL_SUBPROGRAM_DECLARATION
7062 -- | FORMAL_PACKAGE_DECLARATION
7064 ---------------------------------
7065 -- 12.3 Generic Instantiation --
7066 ---------------------------------
7068 -- GENERIC_INSTANTIATION ::=
7069 -- package DEFINING_PROGRAM_UNIT_NAME is
7070 -- new generic_package_NAME [GENERIC_ACTUAL_PART]
7071 -- [ASPECT_SPECIFICATIONS];
7072 -- | [[not] overriding]
7073 -- procedure DEFINING_PROGRAM_UNIT_NAME is
7074 -- new generic_procedure_NAME [GENERIC_ACTUAL_PART]
7075 -- [ASPECT_SPECIFICATIONS];
7076 -- | [[not] overriding]
7077 -- function DEFINING_DESIGNATOR is
7078 -- new generic_function_NAME [GENERIC_ACTUAL_PART]
7079 -- [ASPECT_SPECIFICATIONS];
7081 -- N_Package_Instantiation
7082 -- Sloc points to PACKAGE
7083 -- Defining_Unit_Name
7084 -- Name
7085 -- Generic_Associations (set to No_List if no
7086 -- generic actual part)
7087 -- Parent_Spec
7088 -- Instance_Spec
7089 -- Is_Elaboration_Checks_OK_Node
7090 -- Is_SPARK_Mode_On_Node
7091 -- Is_Elaboration_Warnings_OK_Node
7092 -- Is_Declaration_Level_Node
7093 -- Is_Known_Guaranteed_ABE
7095 -- N_Procedure_Instantiation
7096 -- Sloc points to PROCEDURE
7097 -- Defining_Unit_Name
7098 -- Name
7099 -- Parent_Spec
7100 -- Generic_Associations (set to No_List if no
7101 -- generic actual part)
7102 -- Instance_Spec
7103 -- Is_Elaboration_Checks_OK_Node
7104 -- Is_SPARK_Mode_On_Node
7105 -- Is_Elaboration_Warnings_OK_Node
7106 -- Is_Declaration_Level_Node
7107 -- Must_Override set if overriding indicator present
7108 -- Must_Not_Override set if not_overriding indicator present
7109 -- Is_Known_Guaranteed_ABE
7111 -- N_Function_Instantiation
7112 -- Sloc points to FUNCTION
7113 -- Defining_Unit_Name
7114 -- Name
7115 -- Generic_Associations (set to No_List if no
7116 -- generic actual part)
7117 -- Parent_Spec
7118 -- Instance_Spec
7119 -- Is_Elaboration_Checks_OK_Node
7120 -- Is_SPARK_Mode_On_Node
7121 -- Is_Elaboration_Warnings_OK_Node
7122 -- Is_Declaration_Level_Node
7123 -- Must_Override set if overriding indicator present
7124 -- Must_Not_Override set if not_overriding indicator present
7125 -- Is_Known_Guaranteed_ABE
7127 -- Note: overriding indicator is an Ada 2005 feature
7129 -------------------------------
7130 -- 12.3 Generic Actual Part --
7131 -------------------------------
7133 -- GENERIC_ACTUAL_PART ::=
7134 -- (GENERIC_ASSOCIATION {, GENERIC_ASSOCIATION})
7136 -------------------------------
7137 -- 12.3 Generic Association --
7138 -------------------------------
7140 -- GENERIC_ASSOCIATION ::=
7141 -- [generic_formal_parameter_SELECTOR_NAME =>]
7142 -- EXPLICIT_GENERIC_ACTUAL_PARAMETER
7144 -- Note: unlike the procedure call case, a generic association node
7145 -- is generated for every association, even if no formal parameter
7146 -- selector name is present. In this case the parser will leave the
7147 -- Selector_Name field set to Empty, to be filled in later by the
7148 -- semantic pass.
7150 -- In Ada 2005, a formal may be associated with a box, if the
7151 -- association is part of the list of actuals for a formal package.
7152 -- If the association is given by OTHERS => <>, the association is
7153 -- an N_Others_Choice (not an N_Generic_Association whose Selector_Name
7154 -- is an N_Others_Choice).
7156 -- N_Generic_Association
7157 -- Sloc points to first token of generic association
7158 -- Selector_Name (set to Empty if no formal
7159 -- parameter selector name)
7160 -- Explicit_Generic_Actual_Parameter (Empty if box present)
7161 -- Box_Present (for formal_package associations with a box)
7163 ---------------------------------------------
7164 -- 12.3 Explicit Generic Actual Parameter --
7165 ---------------------------------------------
7167 -- EXPLICIT_GENERIC_ACTUAL_PARAMETER ::=
7168 -- EXPRESSION | variable_NAME | subprogram_NAME
7169 -- | entry_NAME | SUBTYPE_MARK | package_instance_NAME
7171 -------------------------------------
7172 -- 12.4 Formal Object Declaration --
7173 -------------------------------------
7175 -- FORMAL_OBJECT_DECLARATION ::=
7176 -- DEFINING_IDENTIFIER_LIST :
7177 -- MODE [NULL_EXCLUSION] SUBTYPE_MARK [:= DEFAULT_EXPRESSION]
7178 -- [ASPECT_SPECIFICATIONS];
7179 -- | DEFINING_IDENTIFIER_LIST :
7180 -- MODE ACCESS_DEFINITION [:= DEFAULT_EXPRESSION]
7181 -- [ASPECT_SPECIFICATIONS];
7183 -- Although the syntax allows multiple identifiers in the list, the
7184 -- semantics is as though successive declarations were given with
7185 -- identical type definition and expression components. To simplify
7186 -- semantic processing, the parser represents a multiple declaration
7187 -- case as a sequence of single declarations, using the More_Ids and
7188 -- Prev_Ids flags to preserve the original source form as described
7189 -- in the section on "Handling of Defining Identifier Lists".
7191 -- N_Formal_Object_Declaration
7192 -- Sloc points to first identifier
7193 -- Defining_Identifier
7194 -- In_Present
7195 -- Out_Present
7196 -- Null_Exclusion_Present (set to False if not present)
7197 -- Subtype_Mark (set to Empty if not present)
7198 -- Access_Definition (set to Empty if not present)
7199 -- Default_Expression (set to Empty if no default expression)
7200 -- More_Ids (set to False if no more identifiers in list)
7201 -- Prev_Ids (set to False if no previous identifiers in list)
7203 -----------------------------------
7204 -- 12.5 Formal Type Declaration --
7205 -----------------------------------
7207 -- FORMAL_TYPE_DECLARATION ::=
7208 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART]
7209 -- is FORMAL_TYPE_DEFINITION
7210 -- [ASPECT_SPECIFICATIONS];
7211 -- | type DEFINING_IDENTIFIER [DISCRIMINANT_PART] [is tagged]
7213 -- N_Formal_Type_Declaration
7214 -- Sloc points to TYPE
7215 -- Defining_Identifier
7216 -- Formal_Type_Definition
7217 -- Discriminant_Specifications (set to No_List if no
7218 -- discriminant part)
7219 -- Unknown_Discriminants_Present set if (<>) discriminant
7220 -- Default_Subtype_Mark
7222 ----------------------------------
7223 -- 12.5 Formal type definition --
7224 ----------------------------------
7226 -- FORMAL_TYPE_DEFINITION ::=
7227 -- FORMAL_PRIVATE_TYPE_DEFINITION
7228 -- | FORMAL_DERIVED_TYPE_DEFINITION
7229 -- | FORMAL_DISCRETE_TYPE_DEFINITION
7230 -- | FORMAL_SIGNED_INTEGER_TYPE_DEFINITION
7231 -- | FORMAL_MODULAR_TYPE_DEFINITION
7232 -- | FORMAL_FLOATING_POINT_DEFINITION
7233 -- | FORMAL_ORDINARY_FIXED_POINT_DEFINITION
7234 -- | FORMAL_DECIMAL_FIXED_POINT_DEFINITION
7235 -- | FORMAL_ARRAY_TYPE_DEFINITION
7236 -- | FORMAL_ACCESS_TYPE_DEFINITION
7237 -- | FORMAL_INTERFACE_TYPE_DEFINITION
7238 -- | FORMAL_INCOMPLETE_TYPE_DEFINITION
7240 -- The Ada 2012 syntax introduces two new non-terminals:
7241 -- Formal_{Complete,Incomplete}_Type_Declaration just to introduce
7242 -- the latter category. Here we introduce an incomplete type definition
7243 -- in order to preserve as much as possible the existing structure.
7245 ---------------------------------------------
7246 -- 12.5.1 Formal Private Type Definition --
7247 ---------------------------------------------
7249 -- FORMAL_PRIVATE_TYPE_DEFINITION ::=
7250 -- [[abstract] tagged] [limited] private
7252 -- Note: TAGGED is not allowed in Ada 83 mode
7254 -- N_Formal_Private_Type_Definition
7255 -- Sloc points to PRIVATE
7256 -- Uninitialized_Variable
7257 -- Abstract_Present
7258 -- Tagged_Present
7259 -- Limited_Present
7261 --------------------------------------------
7262 -- 12.5.1 Formal Derived Type Definition --
7263 --------------------------------------------
7265 -- FORMAL_DERIVED_TYPE_DEFINITION ::=
7266 -- [abstract] [limited | synchronized]
7267 -- new SUBTYPE_MARK [[and INTERFACE_LIST] with private]
7268 -- Note: this construct is not allowed in Ada 83 mode
7270 -- N_Formal_Derived_Type_Definition
7271 -- Sloc points to NEW
7272 -- Subtype_Mark
7273 -- Private_Present
7274 -- Abstract_Present
7275 -- Limited_Present
7276 -- Synchronized_Present
7277 -- Interface_List (set to No_List if none)
7279 -----------------------------------------------
7280 -- 12.5.1 Formal Incomplete Type Definition --
7281 -----------------------------------------------
7283 -- FORMAL_INCOMPLETE_TYPE_DEFINITION ::= [tagged]
7285 -- N_Formal_Incomplete_Type_Definition
7286 -- Sloc points to identifier of parent
7287 -- Tagged_Present
7289 ---------------------------------------------
7290 -- 12.5.2 Formal Discrete Type Definition --
7291 ---------------------------------------------
7293 -- FORMAL_DISCRETE_TYPE_DEFINITION ::= (<>)
7295 -- N_Formal_Discrete_Type_Definition
7296 -- Sloc points to (
7298 ---------------------------------------------------
7299 -- 12.5.2 Formal Signed Integer Type Definition --
7300 ---------------------------------------------------
7302 -- FORMAL_SIGNED_INTEGER_TYPE_DEFINITION ::= range <>
7304 -- N_Formal_Signed_Integer_Type_Definition
7305 -- Sloc points to RANGE
7307 --------------------------------------------
7308 -- 12.5.2 Formal Modular Type Definition --
7309 --------------------------------------------
7311 -- FORMAL_MODULAR_TYPE_DEFINITION ::= mod <>
7313 -- N_Formal_Modular_Type_Definition
7314 -- Sloc points to MOD
7316 ----------------------------------------------
7317 -- 12.5.2 Formal Floating Point Definition --
7318 ----------------------------------------------
7320 -- FORMAL_FLOATING_POINT_DEFINITION ::= digits <>
7322 -- N_Formal_Floating_Point_Definition
7323 -- Sloc points to DIGITS
7325 ----------------------------------------------------
7326 -- 12.5.2 Formal Ordinary Fixed Point Definition --
7327 ----------------------------------------------------
7329 -- FORMAL_ORDINARY_FIXED_POINT_DEFINITION ::= delta <>
7331 -- N_Formal_Ordinary_Fixed_Point_Definition
7332 -- Sloc points to DELTA
7334 ---------------------------------------------------
7335 -- 12.5.2 Formal Decimal Fixed Point Definition --
7336 ---------------------------------------------------
7338 -- FORMAL_DECIMAL_FIXED_POINT_DEFINITION ::= delta <> digits <>
7340 -- Note: formal decimal fixed point definition not allowed in Ada 83
7342 -- N_Formal_Decimal_Fixed_Point_Definition
7343 -- Sloc points to DELTA
7345 ------------------------------------------
7346 -- 12.5.3 Formal Array Type Definition --
7347 ------------------------------------------
7349 -- FORMAL_ARRAY_TYPE_DEFINITION ::= ARRAY_TYPE_DEFINITION
7351 -------------------------------------------
7352 -- 12.5.4 Formal Access Type Definition --
7353 -------------------------------------------
7355 -- FORMAL_ACCESS_TYPE_DEFINITION ::= ACCESS_TYPE_DEFINITION
7357 ----------------------------------------------
7358 -- 12.5.5 Formal Interface Type Definition --
7359 ----------------------------------------------
7361 -- FORMAL_INTERFACE_TYPE_DEFINITION ::= INTERFACE_TYPE_DEFINITION
7363 -----------------------------------------
7364 -- 12.6 Formal Subprogram Declaration --
7365 -----------------------------------------
7367 -- FORMAL_SUBPROGRAM_DECLARATION ::=
7368 -- FORMAL_CONCRETE_SUBPROGRAM_DECLARATION
7369 -- | FORMAL_ABSTRACT_SUBPROGRAM_DECLARATION
7371 --------------------------------------------------
7372 -- 12.6 Formal Concrete Subprogram Declaration --
7373 --------------------------------------------------
7375 -- FORMAL_CONCRETE_SUBPROGRAM_DECLARATION ::=
7376 -- with SUBPROGRAM_SPECIFICATION [is SUBPROGRAM_DEFAULT]
7377 -- [ASPECT_SPECIFICATIONS];
7379 -- N_Formal_Concrete_Subprogram_Declaration
7380 -- Sloc points to WITH
7381 -- Specification
7382 -- Default_Name (set to Empty if no subprogram default)
7383 -- Box_Present
7384 -- Expression (set to Empty if no expression present)
7386 -- Note: If no subprogram default is present, then Name is set
7387 -- to Empty, and Box_Present is False.
7389 -- Note: The Expression field is only used for the GNAT extension
7390 -- that allows a FORMAL_CONCRETE_SUBPROGRAM_DECLARATION to specify
7391 -- an expression default for generic formal functions.
7393 --------------------------------------------------
7394 -- 12.6 Formal Abstract Subprogram Declaration --
7395 --------------------------------------------------
7397 -- FORMAL_ABSTRACT_SUBPROGRAM_DECLARATION ::=
7398 -- with SUBPROGRAM_SPECIFICATION is abstract [SUBPROGRAM_DEFAULT]
7399 -- [ASPECT_SPECIFICATIONS];
7401 -- N_Formal_Abstract_Subprogram_Declaration
7402 -- Sloc points to WITH
7403 -- Specification
7404 -- Default_Name (set to Empty if no subprogram default)
7405 -- Box_Present
7407 -- Note: if no subprogram default is present, then Name is set
7408 -- to Empty, and Box_Present is False.
7410 ------------------------------
7411 -- 12.6 Subprogram Default --
7412 ------------------------------
7414 -- SUBPROGRAM_DEFAULT ::= DEFAULT_NAME | <> | (EXPRESSION)
7416 -- There is no separate node in the tree for a subprogram default.
7417 -- Instead the parent (N_Formal_Concrete_Subprogram_Declaration
7418 -- or N_Formal_Abstract_Subprogram_Declaration) node contains the
7419 -- default name or box indication, as needed.
7421 -- Note: The syntax "(EXPRESSION)" is a GNAT extension, and allows
7422 -- a FORMAL_CONCRETE_SUBPROGRAM_DECLARATION to specify an expression
7423 -- default for formal functions, in analogy with expression_functions.
7425 ------------------------
7426 -- 12.6 Default Name --
7427 ------------------------
7429 -- DEFAULT_NAME ::= NAME
7431 --------------------------------------
7432 -- 12.7 Formal Package Declaration --
7433 --------------------------------------
7435 -- FORMAL_PACKAGE_DECLARATION ::=
7436 -- with package DEFINING_IDENTIFIER
7437 -- is new generic_package_NAME FORMAL_PACKAGE_ACTUAL_PART
7438 -- [ASPECT_SPECIFICATIONS];
7440 -- Note: formal package declarations not allowed in Ada 83 mode
7442 -- N_Formal_Package_Declaration
7443 -- Sloc points to WITH
7444 -- Defining_Identifier
7445 -- Name
7446 -- Generic_Associations (set to No_List if (<>) case or
7447 -- empty formal package actual part)
7448 -- Box_Present
7449 -- Instance_Spec
7450 -- Is_Known_Guaranteed_ABE
7452 --------------------------------------
7453 -- 12.7 Formal Package Actual Part --
7454 --------------------------------------
7456 -- FORMAL_PACKAGE_ACTUAL_PART ::=
7457 -- ([OTHERS =>] <>)
7458 -- | [GENERIC_ACTUAL_PART]
7459 -- | (FORMAL_PACKAGE_ASSOCIATION {, FORMAL_PACKAGE_ASSOCIATION}
7460 -- [, OTHERS => <>])
7462 -- FORMAL_PACKAGE_ASSOCIATION ::=
7463 -- GENERIC_ASSOCIATION
7464 -- | GENERIC_FORMAL_PARAMETER_SELECTOR_NAME => <>
7466 -- There is no explicit node in the tree for a formal package actual
7467 -- part, nor for a formal package association. A formal package
7468 -- association is represented as a generic association, possibly with
7469 -- Box_Present.
7471 -- The "others => <>" syntax (both cases) is represented as an
7472 -- N_Others_Choice (not an N_Generic_Association whose Selector_Name
7473 -- is an N_Others_Choice). This admittedly odd representation does not
7474 -- lose information, because "others" cannot be followed by anything
7475 -- other than "=> <>". Thus:
7477 -- "... is new G;"
7478 -- The N_Formal_Package_Declaration has empty Generic_Associations,
7479 -- and Box_Present = False.
7481 -- "... is new G(<>);"
7482 -- The N_Formal_Package_Declaration has empty Generic_Associations,
7483 -- and Box_Present = True.
7485 -- "... is new G(others => <>);"
7486 -- The N_Formal_Package_Declaration has Generic_Associations with a
7487 -- single element, which is an N_Others_Choice.
7488 -- The N_Formal_Package_Declaration has Box_Present = False.
7490 -- "... is new G(X, F => Y, others => <>);"
7491 -- The N_Formal_Package_Declaration has Generic_Associations with
7492 -- three elements, the last of which is an N_Others_Choice.
7493 -- The N_Formal_Package_Declaration has Box_Present = False.
7495 -- "... is new G(F1 => X, F2 => <>, others => <>);"
7496 -- The N_Formal_Package_Declaration has Generic_Associations with
7497 -- three elements. The first is an N_Generic_Association with
7498 -- Box_Present = False. The second is an N_Generic_Association with
7499 -- Box_Present = True. The last is an N_Others_Choice.
7500 -- The N_Formal_Package_Declaration has Box_Present = False.
7502 ---------------------------------
7503 -- 13.1 Representation clause --
7504 ---------------------------------
7506 -- REPRESENTATION_CLAUSE ::=
7507 -- ATTRIBUTE_DEFINITION_CLAUSE
7508 -- | ENUMERATION_REPRESENTATION_CLAUSE
7509 -- | RECORD_REPRESENTATION_CLAUSE
7510 -- | AT_CLAUSE
7512 ----------------------
7513 -- 13.1 Local Name --
7514 ----------------------
7516 -- LOCAL_NAME :=
7517 -- DIRECT_NAME
7518 -- | DIRECT_NAME'ATTRIBUTE_DESIGNATOR
7519 -- | library_unit_NAME
7521 -- The construct DIRECT_NAME'ATTRIBUTE_DESIGNATOR appears in the tree
7522 -- as an attribute reference, which has essentially the same form.
7524 ---------------------------------------
7525 -- 13.3 Attribute definition clause --
7526 ---------------------------------------
7528 -- ATTRIBUTE_DEFINITION_CLAUSE ::=
7529 -- for LOCAL_NAME'ATTRIBUTE_DESIGNATOR use EXPRESSION;
7530 -- | for LOCAL_NAME'ATTRIBUTE_DESIGNATOR use NAME;
7532 -- In Ada 83, the expression must be a simple expression and the
7533 -- local name must be a direct name.
7535 -- Note: the only attribute definition clause that is processed by
7536 -- gigi is an address clause. For all other cases, the information
7537 -- is extracted by the front end and either results in setting entity
7538 -- information, e.g. Esize for the Size clause, or in appropriate
7539 -- expansion actions (e.g. in the case of Storage_Size).
7541 -- For an address clause, Gigi constructs the appropriate addressing
7542 -- code. It also ensures that no aliasing optimizations are made
7543 -- for the object for which the address clause appears.
7545 -- Note: for an address clause used to achieve an overlay:
7547 -- A : Integer;
7548 -- B : Integer;
7549 -- for B'Address use A'Address;
7551 -- the above rule means that Gigi will ensure that no optimizations
7552 -- will be made for B that would violate the implementation advice
7553 -- of RM 13.3(19). However, this advice applies only to B and not
7554 -- to A, which seems unfortunate. The GNAT front end will mark the
7555 -- object A as volatile to also prevent unwanted optimization
7556 -- assumptions based on no aliasing being made for B.
7558 -- N_Attribute_Definition_Clause
7559 -- Sloc points to FOR
7560 -- Name the local name
7561 -- Chars the identifier name from the attribute designator
7562 -- Expression the expression or name
7563 -- Entity
7564 -- Next_Rep_Item
7565 -- From_At_Mod
7566 -- Check_Address_Alignment
7567 -- From_Aspect_Specification
7568 -- Is_Delayed_Aspect
7569 -- Address_Warning_Posted
7571 -- Note: if From_Aspect_Specification is set, then Sloc points to the
7572 -- aspect name, and Entity is resolved already to reference the entity
7573 -- to which the aspect applies.
7575 -----------------------------------
7576 -- 13.3.1 Aspect Specifications --
7577 -----------------------------------
7579 -- We modify the RM grammar here, the RM grammar is:
7581 -- ASPECT_SPECIFICATION ::=
7582 -- with ASPECT_MARK [=> ASPECT_DEFINITION] {,
7583 -- ASPECT_MARK [=> ASPECT_DEFINITION] }
7585 -- ASPECT_MARK ::= aspect_IDENTIFIER['Class]
7587 -- ASPECT_DEFINITION ::= NAME | EXPRESSION
7589 -- That's inconvenient, since there is no non-terminal name for a single
7590 -- entry in the list of aspects. So we use this grammar instead:
7592 -- ASPECT_SPECIFICATIONS ::=
7593 -- with ASPECT_SPECIFICATION {, ASPECT_SPECIFICATION}
7595 -- ASPECT_SPECIFICATION =>
7596 -- ASPECT_MARK [=> ASPECT_DEFINITION]
7598 -- ASPECT_MARK ::= aspect_IDENTIFIER['Class]
7600 -- ASPECT_DEFINITION ::= NAME | EXPRESSION
7602 -- Note that for Annotate, the ASPECT_DEFINITION is a pure positional
7603 -- aggregate with the elements of the aggregate corresponding to the
7604 -- successive arguments of the corresponding pragma.
7606 -- See separate package Aspects for details on the incorporation of
7607 -- these nodes into the tree, and how aspect specifications for a given
7608 -- declaration node are associated with that node.
7610 -- N_Aspect_Specification
7611 -- Sloc points to aspect identifier
7612 -- Identifier aspect identifier
7613 -- Aspect_Rep_Item
7614 -- Expression (set to Empty if none)
7615 -- Entity entity to which the aspect applies
7616 -- Next_Rep_Item
7617 -- Class_Present Set if 'Class present
7618 -- Is_Ignored
7619 -- Is_Checked
7620 -- Is_Delayed_Aspect
7621 -- Is_Disabled
7622 -- Is_Boolean_Aspect
7623 -- Aspect_On_Partial_View
7625 -- Note: Aspect_Specification is an Ada 2012 feature
7627 -- Note: The Identifier serves to identify the aspect involved (it
7628 -- is the aspect whose name corresponds to the Chars field). This
7629 -- means that the other fields of this identifier are unused, and
7630 -- in particular we use the Entity field of this identifier to save
7631 -- a copy of the expression for visibility analysis, see spec of
7632 -- Sem_Ch13 for full details of this usage.
7634 -- In the case of aspects of the form xxx'Class, the aspect identifier
7635 -- is for xxx, and Class_Present is set to True.
7637 ---------------------------------------------
7638 -- 13.4 Enumeration representation clause --
7639 ---------------------------------------------
7641 -- ENUMERATION_REPRESENTATION_CLAUSE ::=
7642 -- for first_subtype_LOCAL_NAME use ENUMERATION_AGGREGATE;
7644 -- In Ada 83, the name must be a direct name
7646 -- N_Enumeration_Representation_Clause
7647 -- Sloc points to FOR
7648 -- Identifier direct name
7649 -- Array_Aggregate
7650 -- Next_Rep_Item
7652 ---------------------------------
7653 -- 13.4 Enumeration aggregate --
7654 ---------------------------------
7656 -- ENUMERATION_AGGREGATE ::= ARRAY_AGGREGATE
7658 ------------------------------------------
7659 -- 13.5.1 Record representation clause --
7660 ------------------------------------------
7662 -- RECORD_REPRESENTATION_CLAUSE ::=
7663 -- for first_subtype_LOCAL_NAME use
7664 -- record [MOD_CLAUSE]
7665 -- {COMPONENT_CLAUSE}
7666 -- end record;
7668 -- Gigi restriction: Mod_Clause is always Empty (if present it is
7669 -- replaced by a corresponding Alignment attribute definition clause).
7671 -- Note: Component_Clauses can include pragmas
7673 -- N_Record_Representation_Clause
7674 -- Sloc points to FOR
7675 -- Identifier direct name
7676 -- Mod_Clause (set to Empty if no mod clause present)
7677 -- Component_Clauses
7678 -- Next_Rep_Item
7680 ------------------------------
7681 -- 13.5.1 Component clause --
7682 ------------------------------
7684 -- COMPONENT_CLAUSE ::=
7685 -- component_LOCAL_NAME at POSITION
7686 -- range FIRST_BIT .. LAST_BIT;
7688 -- N_Component_Clause
7689 -- Sloc points to AT
7690 -- Component_Name points to Name or Attribute_Reference
7691 -- Position
7692 -- First_Bit
7693 -- Last_Bit
7695 ----------------------
7696 -- 13.5.1 Position --
7697 ----------------------
7699 -- POSITION ::= static_EXPRESSION
7701 -----------------------
7702 -- 13.5.1 First_Bit --
7703 -----------------------
7705 -- FIRST_BIT ::= static_SIMPLE_EXPRESSION
7707 ----------------------
7708 -- 13.5.1 Last_Bit --
7709 ----------------------
7711 -- LAST_BIT ::= static_SIMPLE_EXPRESSION
7713 --------------------------
7714 -- 13.8 Code statement --
7715 --------------------------
7717 -- CODE_STATEMENT ::= QUALIFIED_EXPRESSION;
7719 -- Note: in GNAT, the qualified expression has the form
7721 -- Asm_Insn'(Asm (...));
7723 -- See package System.Machine_Code in file s-maccod.ads for details on
7724 -- the allowed parameters to Asm. There are two ways this node can
7725 -- arise, as a code statement, in which case the expression is the
7726 -- qualified expression, or as a result of the expansion of an intrinsic
7727 -- call to the Asm or Asm_Input procedure.
7729 -- N_Code_Statement
7730 -- Sloc points to first token of the expression
7731 -- Expression
7733 -- Note: package Exp_Code contains an abstract functional interface
7734 -- for use by Gigi in accessing the data from N_Code_Statement nodes.
7736 ------------------------
7737 -- 13.12 Restriction --
7738 ------------------------
7740 -- RESTRICTION ::=
7741 -- restriction_IDENTIFIER
7742 -- | restriction_parameter_IDENTIFIER => EXPRESSION
7744 -- There is no explicit node for restrictions. Instead the restriction
7745 -- appears in normal pragma syntax as a pragma argument association,
7746 -- which has the same syntactic form.
7748 --------------------------
7749 -- B.2 Shift Operators --
7750 --------------------------
7752 -- Calls to the intrinsic shift functions are converted to one of
7753 -- the following shift nodes, which have the form of normal binary
7754 -- operator names. Note that for a given shift operation, one node
7755 -- covers all possible types, as for normal operators.
7757 -- Note: it is perfectly permissible for the expander to generate
7758 -- shift operation nodes directly, in which case they will be analyzed
7759 -- and parsed in the usual manner.
7761 -- Sprint syntax: shift-function-name!(expr, count)
7763 -- Note: the Left_Opnd field holds the first argument (the value to
7764 -- be shifted). The Right_Opnd field holds the second argument (the
7765 -- shift count). The Chars field is the name of the intrinsic function.
7767 -- N_Op_Rotate_Left
7768 -- Sloc points to the function name
7769 -- plus fields for binary operator
7770 -- plus fields for expression
7771 -- Shift_Count_OK
7773 -- N_Op_Rotate_Right
7774 -- Sloc points to the function name
7775 -- plus fields for binary operator
7776 -- plus fields for expression
7777 -- Shift_Count_OK
7779 -- N_Op_Shift_Left
7780 -- Sloc points to the function name
7781 -- plus fields for binary operator
7782 -- plus fields for expression
7783 -- Shift_Count_OK
7785 -- N_Op_Shift_Right_Arithmetic
7786 -- Sloc points to the function name
7787 -- plus fields for binary operator
7788 -- plus fields for expression
7789 -- Shift_Count_OK
7791 -- N_Op_Shift_Right
7792 -- Sloc points to the function name
7793 -- plus fields for binary operator
7794 -- plus fields for expression
7795 -- Shift_Count_OK
7797 -- Note: N_Op_Rotate_Left, N_Op_Rotate_Right, N_Shift_Right_Arithmetic
7798 -- never appear in the expanded tree if Modify_Tree_For_C mode is set.
7800 -- Note: For N_Op_Shift_Left and N_Op_Shift_Right, the right operand is
7801 -- always less than the word size if Modify_Tree_For_C mode is set.
7803 --------------------------
7804 -- Obsolescent Features --
7805 --------------------------
7807 -- The syntax descriptions and tree nodes for obsolescent features are
7808 -- grouped together, corresponding to their location in appendix I in
7809 -- the RM. However, parsing and semantic analysis for these constructs
7810 -- is located in an appropriate chapter (see individual notes).
7812 ---------------------------
7813 -- J.3 Delta Constraint --
7814 ---------------------------
7816 -- Note: the parse routine for this construct is located in section
7817 -- 3.5.9 of Par-Ch3, and semantic analysis is in Sem_Ch3, which is
7818 -- where delta constraint logically belongs.
7820 -- DELTA_CONSTRAINT ::= DELTA static_EXPRESSION [RANGE_CONSTRAINT]
7822 -- N_Delta_Constraint
7823 -- Sloc points to DELTA
7824 -- Delta_Expression
7825 -- Range_Constraint (set to Empty if not present)
7827 --------------------
7828 -- J.7 At Clause --
7829 --------------------
7831 -- AT_CLAUSE ::= for DIRECT_NAME use at EXPRESSION;
7833 -- Note: the parse routine for this construct is located in Par-Ch13,
7834 -- and the semantic analysis is in Sem_Ch13, where at clause logically
7835 -- belongs if it were not obsolescent.
7837 -- Note: in Ada 83 the expression must be a simple expression
7839 -- Gigi restriction: This node never appears, it is rewritten as an
7840 -- address attribute definition clause.
7842 -- N_At_Clause
7843 -- Sloc points to FOR
7844 -- Identifier
7845 -- Expression
7847 ---------------------
7848 -- J.8 Mod clause --
7849 ---------------------
7851 -- MOD_CLAUSE ::= at mod static_EXPRESSION;
7853 -- Note: the parse routine for this construct is located in Par-Ch13,
7854 -- and the semantic analysis is in Sem_Ch13, where mod clause logically
7855 -- belongs if it were not obsolescent.
7857 -- Note: in Ada 83, the expression must be a simple expression
7859 -- Gigi restriction: this node never appears. It is replaced
7860 -- by a corresponding Alignment attribute definition clause.
7862 -- Note: pragmas can appear before and after the MOD_CLAUSE since
7863 -- its name has "clause" in it. This is rather strange, but is quite
7864 -- definitely specified. The pragmas before are collected in the
7865 -- Pragmas_Before field of the mod clause node itself, and pragmas
7866 -- after are simply swallowed up in the list of component clauses.
7868 -- N_Mod_Clause
7869 -- Sloc points to AT
7870 -- Expression
7871 -- Pragmas_Before Pragmas before mod clause (No_List if none)
7873 --------------------
7874 -- Semantic Nodes --
7875 --------------------
7877 -- These semantic nodes are used to hold additional semantic information.
7878 -- They are inserted into the tree as a result of semantic processing.
7879 -- Although there are no legitimate source syntax constructions that
7880 -- correspond directly to these nodes, we need a source syntax for the
7881 -- reconstructed tree printed by Sprint, and the node descriptions here
7882 -- show this syntax.
7884 -----------------
7885 -- Call_Marker --
7886 -----------------
7888 -- This node is created during the analysis/resolution of entry calls,
7889 -- requeues, and subprogram calls. It performs several functions:
7891 -- * Call markers provide a uniform model for handling calls by the
7892 -- ABE mechanism, regardless of whether expansion took place.
7894 -- * The call marker captures the target of the related call along
7895 -- with other attributes which are either unavailable or expensive
7896 -- to recompute once analysis, resolution, and expansion are over.
7898 -- * The call marker aids the ABE Processing phase by signaling the
7899 -- presence of a call in case the original call was transformed by
7900 -- expansion.
7902 -- * The call marker acts as a reference point for the insertion of
7903 -- run-time conditional ABE checks or guaranteed ABE failures.
7905 -- Sprint syntax: #target#
7907 -- The Sprint syntax shown above is not enabled by default
7909 -- N_Call_Marker
7910 -- Sloc points to Sloc of original call
7911 -- Target
7912 -- Is_Elaboration_Checks_OK_Node
7913 -- Is_SPARK_Mode_On_Node
7914 -- Is_Elaboration_Warnings_OK_Node
7915 -- Is_Source_Call
7916 -- Is_Declaration_Level_Node
7917 -- Is_Dispatching_Call
7918 -- Is_Preelaborable_Call
7919 -- Is_Known_Guaranteed_ABE
7921 ------------------------
7922 -- Compound Statement --
7923 ------------------------
7925 -- This node is created by the analyzer/expander to handle some
7926 -- expansion cases where a sequence of actions needs to be captured
7927 -- within a single node (which acts as a container and allows the
7928 -- entire list of actions to be moved around as a whole) appearing
7929 -- in a sequence of statements.
7931 -- This is the statement counterpart to the expression node
7932 -- N_Expression_With_Actions.
7934 -- The required semantics is that the set of actions is executed in
7935 -- the order in which it appears, as though they appeared by themselves
7936 -- in the enclosing list of declarations or statements. Unlike what
7937 -- happens when using an N_Block_Statement, no new scope is introduced.
7939 -- Note: for the time being, this is used only as a transient
7940 -- representation during expansion, and all compound statement nodes
7941 -- must be exploded back to their constituent statements before handing
7942 -- the tree to the back end.
7944 -- Sprint syntax: do
7945 -- action;
7946 -- action;
7947 -- ...
7948 -- action;
7949 -- end;
7951 -- N_Compound_Statement
7952 -- Actions
7954 --------------
7955 -- Contract --
7956 --------------
7958 -- This node is used to hold the various parts of an entry, subprogram
7959 -- [body] or package [body] contract, in particular:
7960 -- Abstract states declared by a package declaration
7961 -- Contract cases that apply to a subprogram
7962 -- Dependency relations of inputs and output of a subprogram
7963 -- Global annotations classifying data as input or output
7964 -- Initialization sequences for a package declaration
7965 -- Pre- and postconditions that apply to a subprogram
7967 -- The node appears in an entry and [generic] subprogram [body] entity.
7969 -- Sprint syntax: <none> as the node should not appear in the tree, but
7970 -- only attached to an entry or [generic] subprogram
7971 -- entity.
7973 -- N_Contract
7974 -- Sloc points to the subprogram's name
7975 -- Pre_Post_Conditions (set to Empty if none)
7976 -- Contract_Test_Cases (set to Empty if none)
7977 -- Classifications (set to Empty if none)
7979 -- Pre_Post_Conditions contains a collection of pragmas that correspond
7980 -- to pre- and postconditions associated with an entry or a subprogram
7981 -- [body or stub]. The pragmas can either come from source or be the
7982 -- byproduct of aspect expansion. Currently the following pragmas appear
7983 -- in this list:
7984 -- Post
7985 -- Postcondition
7986 -- Pre
7987 -- Precondition
7988 -- Refined_Post
7989 -- The ordering in the list is in LIFO fashion.
7991 -- Note that there might be multiple preconditions or postconditions
7992 -- in this list, because they come from separate pragmas in the source.
7994 -- In GNATprove mode, the inherited classwide pre- and postconditions
7995 -- (suitably specialized for the specific type of the overriding
7996 -- operation) are also in this list.
7998 -- Contract_Test_Cases contains a collection of pragmas that correspond
7999 -- to aspects/pragmas Contract_Cases, Exceptional_Cases, Test_Case and
8000 -- Subprogram_Variant. The ordering in the list is in LIFO fashion.
8002 -- Classifications contains pragmas that either declare, categorize, or
8003 -- establish dependencies between subprogram or package inputs and
8004 -- outputs. Currently the following pragmas appear in this list:
8005 -- Abstract_States
8006 -- Always_Terminates
8007 -- Async_Readers
8008 -- Async_Writers
8009 -- Constant_After_Elaboration
8010 -- Depends
8011 -- Effective_Reads
8012 -- Effective_Writes
8013 -- Extensions_Visible
8014 -- Global
8015 -- Initial_Condition
8016 -- Initializes
8017 -- Part_Of
8018 -- Refined_Depends
8019 -- Refined_Global
8020 -- Refined_States
8021 -- Volatile_Function
8022 -- The ordering is in LIFO fashion.
8024 -------------------
8025 -- Expanded Name --
8026 -------------------
8028 -- The N_Expanded_Name node is used to represent a selected component
8029 -- name that has been resolved to an expanded name. The semantic phase
8030 -- replaces N_Selected_Component nodes that represent names by the use
8031 -- of this node, leaving the N_Selected_Component node used only when
8032 -- the prefix is a record or protected type.
8034 -- The fields of the N_Expanded_Name node are laid out identically
8035 -- to those of the N_Selected_Component node, allowing conversion of
8036 -- an expanded name node to a selected component node to be done
8037 -- easily, see Sinfo.CN.Change_Selected_Component_To_Expanded_Name.
8039 -- There is no special sprint syntax for an expanded name
8041 -- N_Expanded_Name
8042 -- Sloc points to the period
8043 -- Chars copy of Chars field of selector name
8044 -- Prefix
8045 -- Selector_Name
8046 -- Entity
8047 -- Associated_Node
8048 -- Is_Elaboration_Checks_OK_Node
8049 -- Is_SPARK_Mode_On_Node
8050 -- Is_Elaboration_Warnings_OK_Node
8051 -- Has_Private_View (set in generic units)
8052 -- Has_Secondary_Private_View (set in generic units)
8053 -- Redundant_Use
8054 -- Atomic_Sync_Required
8055 -- plus fields for expression
8057 -----------------------------
8058 -- Expression With Actions --
8059 -----------------------------
8061 -- This node is created by the analyzer/expander to handle some
8062 -- expansion cases, notably short-circuit forms where there are
8063 -- actions associated with the right-hand side operand.
8065 -- The N_Expression_With_Actions node represents an expression with
8066 -- an associated set of actions (which are executable statements and
8067 -- declarations, as might occur in a handled statement sequence).
8069 -- The required semantics is that the set of actions is executed in
8070 -- the order in which it appears just before the expression is
8071 -- evaluated (and these actions must only be executed if the value
8072 -- of the expression is evaluated). The node is considered to be
8073 -- a subexpression, whose value is the value of the Expression after
8074 -- executing all the actions.
8076 -- If the actions contain declarations, then these declarations may
8077 -- be referenced within the expression.
8079 -- (AI12-0236-1): In Ada 2022, for a declare_expression, the parser
8080 -- generates an N_Expression_With_Actions. Declare_expressions have
8081 -- various restrictions, which we do not enforce on
8082 -- N_Expression_With_Actions nodes that are generated by the
8083 -- expander. The two cases can be distinguished by looking at
8084 -- Comes_From_Source.
8086 -- ???Perhaps we should change the name of this node to
8087 -- N_Declare_Expression, and perhaps we should change the Sprint syntax
8088 -- to match the RM syntax for declare_expression.
8090 -- Sprint syntax: do
8091 -- action;
8092 -- action;
8093 -- ...
8094 -- action;
8095 -- in expression end
8097 -- N_Expression_With_Actions
8098 -- Actions
8099 -- Expression
8100 -- plus fields for expression
8102 -- Note: In the final generated tree presented to the code generator,
8103 -- the actions list is always non-null, since there is no point in this
8104 -- node if the actions are Empty. During semantic analysis there are
8105 -- cases where it is convenient to temporarily generate an empty actions
8106 -- list. This arises in cases where we create such an empty actions
8107 -- list, and it may or may not end up being a place where additional
8108 -- actions are inserted. The expander removes such empty cases after
8109 -- the expression of the node is fully analyzed and expanded, at which
8110 -- point it is safe to remove it, since no more actions can be inserted.
8112 -- Note: In Modify_Tree_For_C, we never generate any declarations in
8113 -- the action list, which can contain only non-declarative statements.
8115 --------------------
8116 -- Free Statement --
8117 --------------------
8119 -- The N_Free_Statement node is generated as a result of a call to an
8120 -- instantiation of Unchecked_Deallocation. The instantiation of this
8121 -- generic is handled specially and generates this node directly.
8123 -- Sprint syntax: free expression
8125 -- N_Free_Statement
8126 -- Sloc is copied from the unchecked deallocation call
8127 -- Expression argument to unchecked deallocation call
8128 -- Storage_Pool
8129 -- Procedure_To_Call
8130 -- Actual_Designated_Subtype
8132 -- Note: in the case where a debug source file is generated, the Sloc
8133 -- for this node points to the FREE keyword in the Sprint file output.
8135 -------------------
8136 -- Freeze Entity --
8137 -------------------
8139 -- This node marks the point in a declarative part at which an entity
8140 -- declared therein becomes frozen. The expander places initialization
8141 -- procedures for types at those points. Gigi uses the freezing point
8142 -- to elaborate entities that may depend on previous private types.
8144 -- See the section in Einfo "Delayed Freezing and Elaboration" for
8145 -- a full description of the use of this node.
8147 -- The Entity field points back to the entity for the type (whose
8148 -- Freeze_Node field points back to this freeze node).
8150 -- The Actions field contains a list of declarations and statements
8151 -- generated by the expander which are associated with the freeze
8152 -- node, and are elaborated as though the freeze node were replaced
8153 -- by this sequence of actions.
8155 -- Note: the Sloc field in the freeze node references a construct
8156 -- associated with the freezing point. This is used for posting
8157 -- messages in some error/warning situations, e.g. the case where
8158 -- a primitive operation of a tagged type is declared too late.
8160 -- Sprint syntax: freeze entity-name [
8161 -- freeze actions
8162 -- ]
8164 -- N_Freeze_Entity
8165 -- Sloc points near freeze point (see above special note)
8166 -- Entity
8167 -- Access_Types_To_Process (set to No_Elist if none)
8168 -- TSS_Elist (set to No_Elist if no associated TSS's)
8169 -- Actions (set to No_List if no freeze actions)
8170 -- First_Subtype_Link (set to Empty if no link)
8172 -- The Actions field holds actions associated with the freeze. These
8173 -- actions are elaborated at the point where the type is frozen.
8175 -- Note: in the case where a debug source file is generated, the Sloc
8176 -- for this node points to the FREEZE keyword in the Sprint file output.
8178 ---------------------------
8179 -- Freeze Generic Entity --
8180 ---------------------------
8182 -- The freeze point of an entity indicates the point at which the
8183 -- information needed to generate code for the entity is complete.
8184 -- The freeze node for an entity triggers expander activities, such as
8185 -- build initialization procedures, and backend activities, such as
8186 -- completing the elaboration of packages.
8188 -- For entities declared within a generic unit, for which no code is
8189 -- generated, the freeze point is not equally meaningful. However, in
8190 -- Ada 2012 several semantic checks on declarations must be delayed to
8191 -- the freeze point, and we need to include such a mark in the tree to
8192 -- trigger these checks. The Freeze_Generic_Entity node plays no other
8193 -- role, and is ignored by the expander and the back-end.
8195 -- Sprint syntax: freeze_generic entity-name
8197 -- N_Freeze_Generic_Entity
8198 -- Sloc points near freeze point
8199 -- Entity
8201 --------------------------------
8202 -- Implicit Label Declaration --
8203 --------------------------------
8205 -- An implicit label declaration is created for every occurrence of a
8206 -- label on a statement or a label on a block or loop. It is chained
8207 -- in the declarations of the innermost enclosing block as specified
8208 -- in RM section 5.1 (3).
8210 -- The Defining_Identifier is the actual identifier for the statement
8211 -- identifier. Note that the occurrence of the label is a reference, NOT
8212 -- the defining occurrence. The defining occurrence occurs at the head
8213 -- of the innermost enclosing block, and is represented by this node.
8215 -- Note: from the grammar, this might better be called an implicit
8216 -- statement identifier declaration, but the term we choose seems
8217 -- friendlier, since at least informally statement identifiers are
8218 -- called labels in both cases (i.e. when used in labels, and when
8219 -- used as the identifiers of blocks and loops).
8221 -- Note: although this is logically a semantic node, since it does not
8222 -- correspond directly to a source syntax construction, these nodes are
8223 -- actually created by the parser in a post pass done just after parsing
8224 -- is complete, before semantic analysis is started (see Par.Labl).
8226 -- Sprint syntax: labelname : label;
8228 -- N_Implicit_Label_Declaration
8229 -- Sloc points to the << token for a statement identifier, or to the
8230 -- LOOP, DECLARE, or BEGIN token for a loop or block identifier
8231 -- Defining_Identifier
8232 -- Label_Construct
8234 -- Note: in the case where a debug source file is generated, the Sloc
8235 -- for this node points to the label name in the generated declaration.
8237 ---------------------
8238 -- Itype Reference --
8239 ---------------------
8241 -- This node is used to create a reference to an Itype. The only purpose
8242 -- is to make sure the Itype is defined if this is the first reference.
8244 -- A typical use of this node is when an Itype is to be referenced in
8245 -- two branches of an IF statement. In this case it is important that
8246 -- the first use of the Itype not be inside the conditional, since then
8247 -- it might not be defined if the other branch of the IF is taken, in
8248 -- the case where the definition generates elaboration code.
8250 -- The Itype field points to the referenced Itype
8252 -- Sprint syntax: reference itype-name
8254 -- N_Itype_Reference
8255 -- Sloc points to the node generating the reference
8256 -- Itype
8258 -- Note: in the case where a debug source file is generated, the Sloc
8259 -- for this node points to the REFERENCE keyword in the file output.
8261 ---------------------
8262 -- Raise xxx Error --
8263 ---------------------
8265 -- One of these nodes is created during semantic analysis to replace
8266 -- a node for an expression that is determined to definitely raise
8267 -- the corresponding exception.
8269 -- The N_Raise_xxx_Error node may also stand alone in place
8270 -- of a declaration or statement, in which case it simply causes
8271 -- the exception to be raised (i.e. it is equivalent to a raise
8272 -- statement that raises the corresponding exception). This use
8273 -- is distinguished by the fact that the Etype in this case is
8274 -- Standard_Void_Type; in the subexpression case, the Etype is the
8275 -- same as the type of the subexpression which it replaces.
8277 -- If Condition is empty, then the raise is unconditional. If the
8278 -- Condition field is non-empty, it is a boolean expression which is
8279 -- first evaluated, and the exception is raised only if the value of the
8280 -- expression is True. In the unconditional case, the creation of this
8281 -- node is usually accompanied by a warning message (unless it appears
8282 -- within the right operand of a short-circuit form whose left argument
8283 -- is static and decisively eliminates elaboration of the raise
8284 -- operation). The condition field can ONLY be present when the node is
8285 -- used as a statement form; it must NOT be present in the case where
8286 -- the node appears within an expression.
8288 -- The exception is generated with a message that contains the
8289 -- file name and line number, and then appended text. The Reason
8290 -- code shows the text to be added. The Reason code is an element
8291 -- of the type Types.RT_Exception_Code, and indicates both the
8292 -- message to be added, and the exception to be raised (which must
8293 -- match the node type). The value is stored by storing a Uint which
8294 -- is the Pos value of the enumeration element in this type.
8296 -- Gigi restriction: This expander ensures that the type of the
8297 -- Condition field is always Standard.Boolean, even if the type
8298 -- in the source is some non-standard boolean type.
8300 -- Sprint syntax: [xxx_error "msg"]
8301 -- or: [xxx_error when condition "msg"]
8303 -- N_Raise_Constraint_Error
8304 -- Sloc references related construct
8305 -- Condition (set to Empty if no condition)
8306 -- Reason
8307 -- plus fields for expression
8309 -- N_Raise_Program_Error
8310 -- Sloc references related construct
8311 -- Condition (set to Empty if no condition)
8312 -- Reason
8313 -- plus fields for expression
8315 -- N_Raise_Storage_Error
8316 -- Sloc references related construct
8317 -- Condition (set to Empty if no condition)
8318 -- Reason
8319 -- plus fields for expression
8321 -- Note: Sloc is copied from the expression generating the exception.
8322 -- In the case where a debug source file is generated, the Sloc for
8323 -- this node points to the left bracket in the Sprint file output.
8325 -- Note: the back end may be required to translate these nodes into
8326 -- appropriate goto statements. See description of N_Push/Pop_xxx_Label.
8328 ---------------------------------------------
8329 -- Optimization of Exception Raise to Goto --
8330 ---------------------------------------------
8332 -- In some cases, the front end will determine that any exception raised
8333 -- by the back end for a certain exception should be transformed into a
8334 -- goto statement.
8336 -- There are three kinds of exceptions raised by the back end (note that
8337 -- for this purpose we consider gigi to be part of the back end in the
8338 -- gcc case):
8340 -- 1. Exceptions resulting from N_Raise_xxx_Error nodes
8341 -- 2. Exceptions from checks triggered by Do_xxx_Check flags
8342 -- 3. Other cases not specifically marked by the front end
8344 -- Normally all such exceptions are translated into calls to the proper
8345 -- Rcheck_xx procedure, where xx encodes both the exception to be raised
8346 -- and the exception message.
8348 -- The front end may determine that for a particular sequence of code,
8349 -- exceptions in any of these three categories for a particular builtin
8350 -- exception should result in a goto, rather than a call to Rcheck_xx.
8351 -- The exact sequence to be generated is:
8353 -- Local_Raise (exception'Identity);
8354 -- goto Label
8356 -- The front end marks such a sequence of code by bracketing it with
8357 -- push and pop nodes:
8359 -- N_Push_xxx_Label (referencing the label)
8360 -- ...
8361 -- (code where transformation is expected for exception xxx)
8362 -- ...
8363 -- N_Pop_xxx_Label
8365 -- The use of push/pop reflects the fact that such regions can properly
8366 -- nest, and one special case is a subregion in which no transformation
8367 -- is allowed. Such a region is marked by a N_Push_xxx_Label node whose
8368 -- Exception_Label field is Empty.
8370 -- N_Push_Constraint_Error_Label
8371 -- Sloc references first statement in region covered
8372 -- Exception_Label
8374 -- N_Push_Program_Error_Label
8375 -- Sloc references first statement in region covered
8376 -- Exception_Label
8378 -- N_Push_Storage_Error_Label
8379 -- Sloc references first statement in region covered
8380 -- Exception_Label
8382 -- N_Pop_Constraint_Error_Label
8383 -- Sloc references last statement in region covered
8385 -- N_Pop_Program_Error_Label
8386 -- Sloc references last statement in region covered
8388 -- N_Pop_Storage_Error_Label
8389 -- Sloc references last statement in region covered
8391 ---------------
8392 -- Reference --
8393 ---------------
8395 -- For a number of purposes, we need to construct references to objects.
8396 -- These references are subsequently treated as normal access values.
8397 -- An example is the construction of the parameter block passed to a
8398 -- task entry. The N_Reference node is provided for this purpose. It is
8399 -- similar in effect to the use of the Unrestricted_Access attribute,
8400 -- and like Unrestricted_Access can be applied to objects which would
8401 -- not be valid prefixes for the Unchecked_Access attribute (e.g.
8402 -- objects which are not aliased, and slices). In addition it can be
8403 -- applied to composite type values as well as objects, including string
8404 -- values and aggregates.
8406 -- Note: we use the Prefix field for this expression so that the
8407 -- resulting node can be treated using common code with the attribute
8408 -- nodes for the 'Access and related attributes. Logically it would make
8409 -- more sense to call it an Expression field, but then we would have to
8410 -- special case the treatment of the N_Reference node.
8412 -- Note: evaluating a N_Reference node is guaranteed to yield a non-null
8413 -- value at run time. Therefore, it is valid to set Is_Known_Non_Null on
8414 -- a temporary initialized to a N_Reference node in order to eliminate
8415 -- superfluous access checks.
8417 -- Sprint syntax: prefix'reference
8419 -- N_Reference
8420 -- Sloc is copied from the expression
8421 -- Prefix
8422 -- plus fields for expression
8424 -- Note: in the case where a debug source file is generated, the Sloc
8425 -- for this node points to the quote in the Sprint file output.
8427 ----------------
8428 -- SCIL Nodes --
8429 ----------------
8431 -- SCIL nodes are special nodes added to the tree when the CodePeer mode
8432 -- is active. They are only generated if SCIL generation is enabled.
8433 -- A standard tree-walk will not encounter these nodes even if they
8434 -- are present; these nodes are only accessible via the function
8435 -- SCIL_LL.Get_SCIL_Node. These nodes have no associated dynamic
8436 -- semantics.
8438 -- Sprint syntax: [ <node kind> ]
8439 -- No semantic field values are displayed.
8441 -- N_SCIL_Dispatch_Table_Tag_Init
8442 -- Sloc references a node for a tag initialization
8443 -- SCIL_Entity
8445 -- An N_SCIL_Dispatch_Table_Tag_Init node may be associated (via
8446 -- Get_SCIL_Node) with the N_Object_Declaration node corresponding to
8447 -- the declaration of the dispatch table for a tagged type.
8449 -- N_SCIL_Dispatching_Call
8450 -- Sloc references the node of a dispatching call
8451 -- SCIL_Target_Prim
8452 -- SCIL_Entity
8453 -- SCIL_Controlling_Tag
8455 -- An N_Scil_Dispatching call node may be associated (via Get_SCIL_Node)
8456 -- with the N_Procedure_Call_Statement or N_Function_Call node (or a
8457 -- rewriting thereof) corresponding to a dispatching call.
8459 -- N_SCIL_Membership_Test
8460 -- Sloc references the node of a membership test
8461 -- SCIL_Tag_Value
8462 -- SCIL_Entity
8464 -- An N_Scil_Membership_Test node may be associated (via Get_SCIL_Node)
8465 -- with the N_In node (or a rewriting thereof) corresponding to a
8466 -- classwide membership test.
8468 --------------------------
8469 -- Unchecked Expression --
8470 --------------------------
8472 -- An unchecked expression is one that must be analyzed and resolved
8473 -- with all checks off, regardless of the current setting of scope
8474 -- suppress flags.
8476 -- Sprint syntax: `(expression)
8478 -- Note: this node is always removed from the tree (and replaced by
8479 -- its constituent expression) on completion of analysis, so it only
8480 -- appears in intermediate trees, and will never be seen by Gigi.
8482 -- N_Unchecked_Expression
8483 -- Sloc is a copy of the Sloc of the expression
8484 -- Expression
8485 -- plus fields for expression
8487 -- Note: in the case where a debug source file is generated, the Sloc
8488 -- for this node points to the back quote in the Sprint file output.
8490 -------------------------------
8491 -- Unchecked Type Conversion --
8492 -------------------------------
8494 -- An unchecked type conversion node represents the semantic action
8495 -- corresponding to a call to an instantiation of Unchecked_Conversion.
8496 -- It is generated as a result of actual use of Unchecked_Conversion
8497 -- and also by the expander.
8499 -- Unchecked type conversion nodes should be created by calling
8500 -- Tbuild.Unchecked_Convert_To, rather than by directly calling
8501 -- Nmake.Make_Unchecked_Type_Conversion.
8503 -- Note: an unchecked type conversion is a variable as far as the
8504 -- semantics are concerned, which is convenient for the expander.
8505 -- This does not change what Ada source programs are legal, since
8506 -- clearly a function call to an instantiation of Unchecked_Conversion
8507 -- is not a variable in any case.
8509 -- Sprint syntax: subtype-mark!(expression)
8511 -- N_Unchecked_Type_Conversion
8512 -- Sloc points to related node in source
8513 -- Subtype_Mark
8514 -- Expression
8515 -- Kill_Range_Check
8516 -- No_Truncation
8517 -- plus fields for expression
8519 -- Note: in the case where a debug source file is generated, the Sloc
8520 -- for this node points to the exclamation in the Sprint file output.
8522 -----------------------------------
8523 -- Validate_Unchecked_Conversion --
8524 -----------------------------------
8526 -- The front end does most of the validation of unchecked conversion,
8527 -- including checking sizes (this is done after the back end is called
8528 -- to take advantage of back-annotation of calculated sizes).
8530 -- The front end also deals with specific cases that are not allowed
8531 -- e.g. involving unconstrained array types.
8533 -- For the case of the standard gigi backend, this means that all
8534 -- checks are done in the front end.
8536 -- However, in the case of specialized back-ends, in particular the JVM
8537 -- backend in the past, additional requirements and restrictions may
8538 -- apply to unchecked conversion, and these are most conveniently
8539 -- performed in the specialized back-end.
8541 -- To accommodate this requirement, for such back ends, the following
8542 -- special node is generated recording an unchecked conversion that
8543 -- needs to be validated. The back end should post an appropriate
8544 -- error message if the unchecked conversion is invalid or warrants
8545 -- a special warning message.
8547 -- Source_Type and Target_Type point to the entities for the two
8548 -- types involved in the unchecked conversion instantiation that
8549 -- is to be validated.
8551 -- Sprint syntax: validate Unchecked_Conversion (source, target);
8553 -- N_Validate_Unchecked_Conversion
8554 -- Sloc points to instantiation (location for warning message)
8555 -- Source_Type
8556 -- Target_Type
8558 -- Note: in the case where a debug source file is generated, the Sloc
8559 -- for this node points to the VALIDATE keyword in the file output.
8561 -------------------------------
8562 -- Variable_Reference_Marker --
8563 -------------------------------
8565 -- This node is created during the analysis of direct or expanded names,
8566 -- and the resolution of entry and subprogram calls. It performs several
8567 -- functions:
8569 -- * Variable reference markers provide a uniform model for handling
8570 -- variable references by the ABE mechanism, regardless of whether
8571 -- expansion took place.
8573 -- * The variable reference marker captures the entity of the variable
8574 -- being read or written.
8576 -- * The variable reference markers aid the ABE Processing phase by
8577 -- signaling the presence of a call in case the original variable
8578 -- reference was transformed by expansion.
8580 -- Sprint syntax: r#target# -- for a read
8581 -- rw#target# -- for a read/write
8582 -- w#target# -- for a write
8584 -- The Sprint syntax shown above is not enabled by default
8586 -- N_Variable_Reference_Marker
8587 -- Sloc points to Sloc of original variable reference
8588 -- Target
8589 -- Is_Elaboration_Checks_OK_Node
8590 -- Is_SPARK_Mode_On_Node
8591 -- Is_Elaboration_Warnings_OK_Node
8592 -- Is_Read
8593 -- Is_Write
8595 -----------
8596 -- Empty --
8597 -----------
8599 -- Used as the contents of the Nkind field of the dummy Empty node and in
8600 -- some other situations to indicate an uninitialized value.
8602 -- N_Empty
8603 -- Chars is set to No_Name
8605 -----------
8606 -- Error --
8607 -----------
8609 -- Used as the contents of the Nkind field of the dummy Error node.
8610 -- Has an Etype field, which gets set to Any_Type later on, to help
8611 -- error recovery (Error_Posted is also set in the Error node).
8613 -- N_Error
8614 -- Chars is set to Error_Name
8615 -- Etype
8617 end Sinfo;