RISC-V: Add RISC-V into vect_cmdline_needed
[official-gcc.git] / gcc / ada / sinfo.ads
blob8f9626019853e543d2d260f531c48263e0ed45b6
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S I N F O --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2023, 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 -- Aspect_On_Partial_View
849 -- Present on an N_Aspect_Specification node. For an aspect that applies
850 -- to a type entity, indicates whether the specification appears on the
851 -- partial view of a private type or extension. Undefined for aspects
852 -- that apply to other entities.
854 -- Aspect_Rep_Item
855 -- Present in N_Aspect_Specification nodes. Points to the corresponding
856 -- pragma/attribute definition node used to process the aspect.
858 -- Assignment_OK
859 -- This flag is set in a subexpression node for an object, indicating
860 -- that the associated object can be modified, even if this would not
861 -- normally be permissible (either by direct assignment, or by being
862 -- passed as an out or in-out parameter). This is used by the expander
863 -- for a number of purposes, including initialization of constants and
864 -- limited type objects (such as tasks), setting discriminant fields,
865 -- setting tag values, etc. N_Object_Declaration nodes also have this
866 -- flag defined. Here it is used to indicate that an initialization
867 -- expression is valid, even where it would normally not be allowed
868 -- (e.g. where the type involved is limited). It is also used to stop
869 -- a Force_Evaluation call for an unchecked conversion, but this usage
870 -- is unclear and not documented ???
872 -- Associated_Node
873 -- Present in nodes that can denote an entity: identifiers, character
874 -- literals, operator symbols, expanded names, operator nodes, and
875 -- attribute reference nodes (all these nodes have an Entity field).
876 -- This field is also present in N_Aggregate, N_Selected_Component, and
877 -- N_Extension_Aggregate nodes. This field is used in generic processing
878 -- to create links between the generic template and the generic copy.
879 -- See Sem_Ch12.Get_Associated_Node for full details. Note that this
880 -- field overlaps Entity, which is fine, since, as explained in Sem_Ch12,
881 -- the normal function of Entity is not required at the point where the
882 -- Associated_Node is set. Note also, that in generic templates, this
883 -- means that the Entity field does not necessarily point to an Entity.
884 -- Since the back end is expected to ignore generic templates, this is
885 -- harmless.
887 -- Atomic_Sync_Required
888 -- This flag is set on a node for which atomic synchronization is
889 -- required for the corresponding reference or modification.
891 -- At_End_Proc
892 -- This field is present in N_Handled_Sequence_Of_Statements,
893 -- N_Package_Body, N_Subprogram_Body, N_Task_Body, N_Block_Statement,
894 -- and N_Entry_Body.
895 -- It contains an identifier reference for the cleanup procedure to be
896 -- called. See description of N_Handled_Sequence_Of_Statements node
897 -- for further details.
899 -- Backwards_OK
900 -- A flag present in the N_Assignment_Statement node. It is used only
901 -- if the type being assigned is an array type, and is set if analysis
902 -- determines that it is definitely safe to do the copy backwards, i.e.
903 -- starting at the highest addressed element. This is the case if either
904 -- the operands do not overlap, or they may overlap, but if they do,
905 -- then the left operand is at a higher address than the right operand.
907 -- Note: If neither of the flags Forwards_OK or Backwards_OK is set, it
908 -- means that the front end could not determine that either direction is
909 -- definitely safe, and a runtime check may be required if the backend
910 -- cannot figure it out. If both flags Forwards_OK and Backwards_OK are
911 -- set, it means that the front end can assure no overlap of operands.
913 -- Body_To_Inline
914 -- Present in subprogram declarations. Denotes analyzed but unexpanded
915 -- body of subprogram, to be used when inlining calls. Present when the
916 -- subprogram has an Inline pragma and inlining is enabled. If the
917 -- declaration is completed by a renaming_as_body, and the renamed entity
918 -- is a subprogram, the Body_To_Inline is the name of that entity, which
919 -- is used directly in later calls to the original subprogram.
921 -- Body_Required
922 -- A flag that appears in the N_Compilation_Unit node indicating that
923 -- the corresponding unit requires a body. For the package case, this
924 -- indicates that a completion is required. In Ada 95, if the flag is not
925 -- set for the package case, then a body may not be present. In Ada 83,
926 -- if the flag is not set for the package case, then body is optional.
927 -- For a subprogram declaration, the flag is set except in the case where
928 -- a pragma Import or Interface applies, in which case no body is
929 -- permitted (in Ada 83 or Ada 95).
931 -- Cannot_Be_Superflat
932 -- This flag is present in N_Range nodes. It is set if the range is of a
933 -- discrete type and cannot be superflat, i.e. it is guaranteed that the
934 -- inequality High_Bound >= Low_Bound - 1 is true. At the time of this
935 -- writing, it is only used by the code generator to streamline things.
937 -- Cleanup_Actions
938 -- Present in block statements created for transient blocks, contains
939 -- additional cleanup actions carried over from the transient scope.
941 -- Check_Address_Alignment
942 -- A flag present in N_Attribute_Definition clause for a 'Address
943 -- attribute definition. This flag is set if a dynamic check should be
944 -- generated at the freeze point for the entity to which this address
945 -- clause applies. The reason that we need this flag is that we want to
946 -- check for range checks being suppressed at the point where the
947 -- attribute definition clause is given, rather than testing this at the
948 -- freeze point.
950 -- Comes_From_Check_Or_Contract
951 -- This flag is present in all N_If_Statement nodes and
952 -- gets set when an N_If_Statement is generated as part of
953 -- the expansion of a Check, Assert, or contract-related
954 -- pragma.
956 -- Comes_From_Extended_Return_Statement
957 -- Present in N_Simple_Return_Statement nodes. True if this node was
958 -- constructed as part of the N_Extended_Return_Statement expansion.
960 -- Comes_From_Iterator
961 -- Present in N_Object_Renaming_Declaration nodes. True if this node was
962 -- was constructed as part of the expansion of an iterator
963 -- specification.
965 -- Compare_Type
966 -- Present in N_Op_Compare nodes. Set during resolution to the type of
967 -- the operands. It is used to propagate the type of the operands from
968 -- a N_Op_Compare node in a generic construct to the nodes created from
969 -- it in the various instances, when this type is global to the generic
970 -- construct. Resolution for global types cannot be redone in instances
971 -- because the instantiation can be done out of context, e.g. for bodies,
972 -- and the visibility of global types is incorrect in this case; that is
973 -- why the result of the resolution done in the generic construct needs
974 -- to be available in the instances but, unlike for arithmetic operators,
975 -- the Etype cannot be used to that effect for comparison operators. It
976 -- is also used as the type subject to the Has_Private_View processing on
977 -- the nodes instead of the Etype.
979 -- Compile_Time_Known_Aggregate
980 -- Present in N_Aggregate nodes. Set for aggregates which can be fully
981 -- evaluated at compile time without raising constraint error. Such
982 -- aggregates can be passed as is to the back end without any expansion.
983 -- See Exp_Aggr for specific conditions under which this flag gets set.
985 -- Componentwise_Assignment
986 -- Present in N_Assignment_Statement nodes. Set for a record assignment
987 -- where all that needs doing is to expand it into component-by-component
988 -- assignments. This is used internally for the case of tagged types with
989 -- rep clauses, where we need to avoid recursion (we don't want to try to
990 -- generate a call to the primitive operation, because this is the case
991 -- where we are compiling the primitive operation). Note that when we are
992 -- expanding component assignments in this case, we never assign the _tag
993 -- field, but we recursively assign components of the parent type.
995 -- Condition_Actions
996 -- This field appears in else-if nodes and in the iteration scheme node
997 -- for while loops. This field is only used during semantic processing to
998 -- temporarily hold actions inserted into the tree. In the tree passed
999 -- to gigi, the condition actions field is always set to No_List. For
1000 -- details on how this field is used, see the routine Insert_Actions in
1001 -- package Exp_Util, and also the expansion routines for the relevant
1002 -- nodes.
1004 -- Context_Pending
1005 -- This field appears in Compilation_Unit nodes, to indicate that the
1006 -- context of the unit is being compiled. Used to detect circularities
1007 -- that are not otherwise detected by the loading mechanism. Such
1008 -- circularities can occur in the presence of limited and non-limited
1009 -- with_clauses that mention the same units.
1011 -- Controlling_Argument
1012 -- This field is set in procedure and function call nodes if the call
1013 -- is a dispatching call (it is Empty for a non-dispatching call). It
1014 -- indicates the source of the call's controlling tag. For procedure
1015 -- calls, the Controlling_Argument is one of the actuals. For function
1016 -- that has a dispatching result, it is an entity in the context of the
1017 -- call that can provide a tag, or else it is the tag of the root type
1018 -- of the class. It can also specify a tag directly rather than being a
1019 -- tagged object. The latter is needed by the implementations of AI-239
1020 -- and AI-260.
1022 -- Conversion_OK
1023 -- A flag set on type conversion nodes to indicate that the conversion
1024 -- is to be considered as being valid, even though it is the case that
1025 -- the conversion is not valid Ada. This is used for attributes Enum_Rep,
1026 -- Pos, Val, Fixed_Value and Integer_Value, for internal conversions done
1027 -- for fixed-point operations, and for certain conversions for calls to
1028 -- initialization procedures. If Conversion_OK is set, then Etype must be
1029 -- set (the analyzer assumes that Etype has been set). For the case of
1030 -- fixed-point operands, it also indicates that the conversion is to be
1031 -- direct conversion of the underlying integer result, with no regard to
1032 -- the small operand.
1034 -- Corresponding_Aspect
1035 -- Present in N_Pragma node. Used to point back to the source aspect from
1036 -- the corresponding pragma. This field is Empty for source pragmas.
1038 -- Corresponding_Body
1039 -- This field is set in subprogram declarations, package declarations,
1040 -- entry declarations of protected types, and in generic units. It points
1041 -- to the defining entity for the corresponding body (NOT the node for
1042 -- the body itself).
1044 -- Corresponding_Entry_Body
1045 -- Defined in N_Subprogram_Body. Set for subprogram bodies that implement
1046 -- a protected type entry; points to the body for the entry.
1048 -- Corresponding_Formal_Spec
1049 -- This field is set in subprogram renaming declarations, where it points
1050 -- to the defining entity for a formal subprogram in the case where the
1051 -- renaming corresponds to a generic formal subprogram association in an
1052 -- instantiation. The field is Empty if the renaming does not correspond
1053 -- to such a formal association.
1055 -- Corresponding_Generic_Association
1056 -- This field is defined for object declarations and object renaming
1057 -- declarations. It is set for the declarations within an instance that
1058 -- map generic formals to their actuals. If set, the field points either
1059 -- to a copy of a default expression for an actual of mode IN or to a
1060 -- generic_association which is the original parent of the expression or
1061 -- name appearing in the declaration. This simplifies GNATprove queries.
1063 -- Corresponding_Integer_Value
1064 -- This field is set in real literals of fixed-point types (it is not
1065 -- used for floating-point types). It contains the integer value used
1066 -- to represent the fixed-point value. It is also set on the universal
1067 -- real literals used to represent bounds of fixed-point base types
1068 -- and their first named subtypes.
1070 -- Corresponding_Spec
1071 -- This field is set in subprogram, package, task, entry and protected
1072 -- body nodes where it points to the defining entity in the corresponding
1073 -- spec. The attribute is also set in N_With_Clause nodes where it points
1074 -- to the defining entity for the with'ed spec, and in a subprogram
1075 -- renaming declaration when it is a Renaming_As_Body. The field is Empty
1076 -- if there is no corresponding spec, as in the case of a subprogram body
1077 -- that serves as its own spec.
1079 -- In Ada 2012, Corresponding_Spec is set on expression functions that
1080 -- complete a subprogram declaration.
1082 -- Corresponding_Spec_Of_Stub
1083 -- This field is present in subprogram, package, task, and protected body
1084 -- stubs where it points to the corresponding spec of the stub. Due to
1085 -- clashes in the structure of nodes, we cannot use Corresponding_Spec.
1087 -- Corresponding_Stub
1088 -- This field is present in an N_Subunit node. It holds the node in
1089 -- the parent unit that is the stub declaration for the subunit. It is
1090 -- set when analysis of the stub forces loading of the proper body. If
1091 -- expansion of the proper body creates new declarative nodes, they are
1092 -- inserted at the point of the corresponding_stub.
1094 -- Dcheck_Function
1095 -- This field is present in an N_Variant node, It references the entity
1096 -- for the discriminant checking function for the variant.
1098 -- Default_Expression
1099 -- This field is Empty if there is no default expression. If there is a
1100 -- simple default expression (one with no side effects), then this field
1101 -- simply contains a copy of the Expression field (both point to the tree
1102 -- for the default expression). Default_Expression is used for
1103 -- conformance checking.
1105 -- Default_Storage_Pool
1106 -- This field is present in N_Compilation_Unit_Aux nodes. It is set to a
1107 -- copy of Opt.Default_Pool at the end of the compilation unit. See
1108 -- package Opt for details. This is used for inheriting the
1109 -- Default_Storage_Pool in child units.
1111 -- Discr_Check_Funcs_Built
1112 -- This flag is present in N_Full_Type_Declaration nodes. It is set when
1113 -- discriminant checking functions are constructed. The purpose is to
1114 -- avoid attempting to set these functions more than once.
1116 -- Do_Discriminant_Check
1117 -- This flag is set on N_Selected_Component nodes to indicate that a
1118 -- discriminant check is required using the discriminant check routine
1119 -- associated with the selector. The actual check is generated by the
1120 -- expander when processing selected components. In the case of
1121 -- Unchecked_Union, the flag is also set, but no discriminant check
1122 -- routine is associated with the selector, and the expander does not
1123 -- generate a check. This flag is also present in assignment statements
1124 -- (and set if the assignment requires a discriminant check), and in type
1125 -- conversion nodes (and set if the conversion requires a check).
1127 -- Do_Division_Check
1128 -- This flag is set on a division operator (/ mod rem) to indicate that
1129 -- a zero divide check is required. The actual check is either dealt with
1130 -- by the back end if Backend_Divide_Checks is set to true, or by the
1131 -- front end itself if it is set to false.
1133 -- Do_Length_Check
1134 -- This flag is set in an N_Assignment_Statement, N_Op_And, N_Op_Or,
1135 -- N_Op_Xor, or N_Type_Conversion node to indicate that a length check
1136 -- is required. It is not determined who deals with this flag (???).
1138 -- Do_Overflow_Check
1139 -- This flag is set on an operator where an overflow check is required on
1140 -- the operation. The actual check is either dealt with by the back end
1141 -- if Backend_Overflow_Checks is set to true, or by the front end itself
1142 -- if it is set to false. The other cases where this flag is used is on a
1143 -- Type_Conversion node as well on if and case expression nodes.
1144 -- For a type conversion, it means that the conversion is from one base
1145 -- type to another, and the value may not fit in the target base type.
1146 -- See also the description of Do_Range_Check for this case. This flag is
1147 -- also set on if and case expression nodes if we are operating in either
1148 -- MINIMIZED or ELIMINATED overflow checking mode (to make sure that we
1149 -- properly process overflow checking for dependent expressions).
1151 -- Do_Range_Check
1152 -- This flag is set on an expression which appears in a context where a
1153 -- range check is required. The target type is clear from the context.
1154 -- The contexts in which this flag can appear are the following:
1156 -- Right side of an assignment. In this case the target type is taken
1157 -- from the left side of the assignment, which is referenced by the
1158 -- Name of the N_Assignment_Statement node.
1160 -- Subscript expressions in an indexed component. In this case the
1161 -- target type is determined from the type of the array, which is
1162 -- referenced by the Prefix of the N_Indexed_Component node.
1164 -- Argument expression for a parameter, appearing either directly in
1165 -- the Parameter_Associations list of a call or as the Expression of an
1166 -- N_Parameter_Association node that appears in this list. In either
1167 -- case, the check is against the type of the formal. Note that the
1168 -- flag is relevant only in IN and IN OUT parameters, and will be
1169 -- ignored for OUT parameters, where no check is required in the call,
1170 -- and if a check is required on the return, it is generated explicitly
1171 -- with a type conversion.
1173 -- Initialization expression for the initial value in an object
1174 -- declaration. In this case the Do_Range_Check flag is set on
1175 -- the initialization expression, and the check is against the
1176 -- range of the type of the object being declared. This includes the
1177 -- cases of expressions providing default discriminant values, and
1178 -- expressions used to initialize record components.
1180 -- The expression of a type conversion. In this case the range check is
1181 -- against the target type of the conversion. See also the use of
1182 -- Do_Overflow_Check on a type conversion. The distinction is that the
1183 -- overflow check protects against a value that is outside the range of
1184 -- the target base type, whereas a range check checks that the
1185 -- resulting value (which is a value of the base type of the target
1186 -- type), satisfies the range constraint of the target type.
1188 -- Note: when a range check is required in contexts other than those
1189 -- listed above (e.g. in a return statement), an additional type
1190 -- conversion node is introduced to represent the required check.
1192 -- Do_Storage_Check
1193 -- This flag is set in an N_Allocator node to indicate that a storage
1194 -- check is required for the allocation, or in an N_Subprogram_Body node
1195 -- to indicate that a stack check is required in the subprogram prologue.
1196 -- The N_Allocator case is handled by the routine that expands the call
1197 -- to the runtime routine. The N_Subprogram_Body case is handled by the
1198 -- backend, and all the semantics does is set the flag.
1200 -- Elaborate_Present
1201 -- This flag is set in the N_With_Clause node to indicate that pragma
1202 -- Elaborate pragma appears for the with'ed units.
1204 -- Elaborate_All_Desirable
1205 -- This flag is set in the N_With_Clause mode to indicate that the static
1206 -- elaboration processing has determined that an Elaborate_All pragma is
1207 -- desirable for correct elaboration for this unit.
1209 -- Elaborate_All_Present
1210 -- This flag is set in the N_With_Clause node to indicate that a
1211 -- pragma Elaborate_All pragma appears for the with'ed units.
1213 -- Elaborate_Desirable
1214 -- This flag is set in the N_With_Clause mode to indicate that the static
1215 -- elaboration processing has determined that an Elaborate pragma is
1216 -- desirable for correct elaboration for this unit.
1218 -- Else_Actions
1219 -- This field is present in if expression nodes. During code
1220 -- expansion we use the Insert_Actions procedure (in Exp_Util) to insert
1221 -- actions at an appropriate place in the tree to get elaborated at the
1222 -- right time. For if expressions, we have to be sure that the actions
1223 -- for the Else branch are only elaborated if the condition is False.
1224 -- The Else_Actions field is used as a temporary parking place for
1225 -- these actions. The final tree is always rewritten to eliminate the
1226 -- need for this field, so in the tree passed to Gigi, this field is
1227 -- always set to No_List.
1229 -- Enclosing_Variant
1230 -- This field is present in the N_Variant node and identifies the Node_Id
1231 -- corresponding to the immediately enclosing variant when the variant is
1232 -- nested, and N_Empty otherwise. Set during semantic processing of the
1233 -- variant part of a record type.
1235 -- Entity
1236 -- Appears in all direct names (identifiers, character literals, and
1237 -- operator symbols), as well as expanded names, and attributes that
1238 -- denote entities, such as 'Class. Points to entity for corresponding
1239 -- defining occurrence. Set after name resolution. For identifiers in a
1240 -- WITH list, the corresponding defining occurrence is in a separately
1241 -- compiled file, and Entity must be set by the library Load procedure.
1243 -- Note: During name resolution, the value in Entity may be temporarily
1244 -- incorrect (e.g. during overload resolution, Entity is initially set to
1245 -- the first possible correct interpretation, and then later modified if
1246 -- necessary to contain the correct value after resolution).
1248 -- Note: This field overlaps Associated_Node, which is used during
1249 -- generic processing (see Sem_Ch12 for details). Note also that in
1250 -- generic templates, this means that the Entity field does not always
1251 -- point to an Entity. Since the back end is expected to ignore generic
1252 -- templates, this is harmless.
1254 -- Note: This field also appears in N_Attribute_Definition_Clause nodes.
1255 -- It is used only for stream attributes definition clauses. In this
1256 -- case, it denotes a (possibly dummy) subprogram entity that is declared
1257 -- conceptually at the point of the clause. Thus the visibility of the
1258 -- attribute definition clause (in the sense of 8.3(23) as amended by
1259 -- AI-195) can be checked by testing the visibility of that subprogram.
1261 -- Note: Normally the Entity field of an identifier points to the entity
1262 -- for the corresponding defining identifier, and hence the Chars field
1263 -- of an identifier will match the Chars field of the entity. However,
1264 -- there is no requirement that these match, and there are obscure cases
1265 -- of generated code where they do not match.
1267 -- Note: Ada 2012 aspect specifications require additional links between
1268 -- identifiers and various attributes. These attributes can be of
1269 -- arbitrary types, and the entity field of identifiers that denote
1270 -- aspects must be used to store arbitrary expressions for later semantic
1271 -- checks. See section on aspect specifications for details.
1273 -- Entity_Or_Associated_Node
1274 -- A synonym for both Entity and Associated_Node. Used by convention in
1275 -- the code when referencing this field in cases where it is not known
1276 -- whether the field contains an Entity or an Associated_Node.
1278 -- Etype
1279 -- Appears in all expression nodes, all direct names, and all entities.
1280 -- Points to the entity for the related type. Set after type resolution.
1281 -- Normally this is the actual subtype of the expression. However, in
1282 -- certain contexts such as the right side of an assignment, subscripts,
1283 -- arguments to calls, returned value in a function, initial value etc.
1284 -- it is the desired target type. In the event that this is different
1285 -- from the actual type, the Do_Range_Check flag will be set if a range
1286 -- check is required. Note: if the Is_Overloaded flag is set, then Etype
1287 -- points to an essentially arbitrary choice from the possible set of
1288 -- types.
1290 -- Exception_Junk
1291 -- This flag is set in a various nodes appearing in a statement sequence
1292 -- to indicate that the corresponding node is an artifact of the
1293 -- generated code for exception handling, and should be ignored when
1294 -- analyzing the control flow of the relevant sequence of statements
1295 -- (e.g. to check that it does not end with a bad return statement).
1297 -- Exception_Label
1298 -- Appears in N_Push_xxx_Label nodes. Points to the entity of the label
1299 -- to be used for transforming the corresponding exception into a goto,
1300 -- or contains Empty, if this exception is not to be transformed. Also
1301 -- appears in N_Exception_Handler nodes, where, if set, it indicates
1302 -- that there may be a local raise for the handler, so that expansion
1303 -- to allow a goto is required (and this field contains the label for
1304 -- this goto). See Exp_Ch11.Expand_Local_Exception_Handlers for details.
1306 -- Expansion_Delayed
1307 -- Set on aggregates and extension aggregates that need a top-down rather
1308 -- than bottom-up expansion. Typically aggregate expansion happens bottom
1309 -- up. For nested aggregates the expansion is delayed until the enclosing
1310 -- aggregate itself is expanded, e.g. in the context of a declaration. To
1311 -- delay it we set this flag. This is done to avoid creating a temporary
1312 -- for each level of a nested aggregate, and also to prevent the
1313 -- premature generation of constraint checks. This is also a requirement
1314 -- if we want to generate the proper attachment to the internal
1315 -- finalization lists (for record with controlled components). Top down
1316 -- expansion of aggregates is also used for in-place array aggregate
1317 -- assignment or initialization. When the full context is known, the
1318 -- target of the assignment or initialization is used to generate the
1319 -- left-hand side of individual assignment to each subcomponent.
1321 -- Expression_Copy
1322 -- Present in N_Pragma_Argument_Association nodes. Contains a copy of the
1323 -- original expression. This field is best used to store pragma-dependent
1324 -- modifications performed on the original expression such as replacement
1325 -- of the current type instance or substitutions of primitives.
1327 -- First_Inlined_Subprogram
1328 -- Present in the N_Compilation_Unit node for the main program. Points
1329 -- to a chain of entities for subprograms that are to be inlined. The
1330 -- Next_Inlined_Subprogram field of these entities is used as a link
1331 -- pointer with Empty marking the end of the list. This field is Empty
1332 -- if there are no inlined subprograms or inlining is not active.
1334 -- First_Named_Actual
1335 -- Present in procedure call statement and function call nodes, and also
1336 -- in Intrinsic nodes. Set during semantic analysis to point to the first
1337 -- named parameter where parameters are ordered by declaration order (as
1338 -- opposed to the actual order in the call which may be different due to
1339 -- named associations). Note: this field points to the explicit actual
1340 -- parameter itself, not the N_Parameter_Association node (its parent).
1342 -- First_Subtype_Link
1343 -- Present in N_Freeze_Entity node for an anonymous base type that is
1344 -- implicitly created by the declaration of a first subtype. It points
1345 -- to the entity for the first subtype.
1347 -- Float_Truncate
1348 -- A flag present in type conversion nodes. It is used for floating-point
1349 -- to fixed-point or integer conversions, where truncation is required
1350 -- rather than rounding.
1352 -- Forwards_OK
1353 -- A flag present in the N_Assignment_Statement node. It is used only
1354 -- if the type being assigned is an array type, and is set if analysis
1355 -- determines that it is definitely safe to do the copy forwards, i.e.
1356 -- starting at the lowest addressed element. This is the case if either
1357 -- the operands do not overlap, or they may overlap, but if they do,
1358 -- then the left operand is at a lower address than the right operand.
1360 -- Note: If neither of the flags Forwards_OK or Backwards_OK is set, it
1361 -- means that the front end could not determine that either direction is
1362 -- definitely safe, and a runtime check may be required if the backend
1363 -- cannot figure it out. If both flags Forwards_OK and Backwards_OK are
1364 -- set, it means that the front end can assure no overlap of operands.
1366 -- For_Special_Return_Object
1367 -- Present in N_Allocator nodes. True if the allocator is generated for
1368 -- the initialization of a special return object.
1370 -- From_Aspect_Specification
1371 -- Processing of aspect specifications typically results in insertion in
1372 -- the tree of corresponding pragma or attribute definition clause nodes.
1373 -- These generated nodes have the From_Aspect_Specification flag set to
1374 -- indicate that they came from aspect specifications originally.
1376 -- From_At_Mod
1377 -- This flag is set on the attribute definition clause node that is
1378 -- generated by a transformation of an at mod phrase in a record
1379 -- representation clause. This is used to give slightly different (Ada 83
1380 -- compatible) semantics to such a clause, namely it is used to specify a
1381 -- minimum acceptable alignment for the base type and all subtypes. In
1382 -- Ada 95 terms, the actual alignment of the base type and all subtypes
1383 -- must be a multiple of the given value, and the representation clause
1384 -- is considered to be type specific instead of subtype specific.
1386 -- From_Conditional_Expression
1387 -- This flag is set on if and case statements generated by the expansion
1388 -- of if and case expressions respectively. The flag is used to suppress
1389 -- any finalization of controlled objects found within these statements.
1391 -- From_Default
1392 -- This flag is set on the subprogram renaming declaration created in an
1393 -- instance for a formal subprogram, when the formal is declared with a
1394 -- box, and there is no explicit actual. If the flag is present, the
1395 -- declaration is treated as an implicit reference to the formal in the
1396 -- ali file.
1398 -- Generalized_Indexing
1399 -- Present in N_Indexed_Component nodes. Set for Indexed_Component nodes
1400 -- that are Ada 2012 container indexing operations. The value of the
1401 -- attribute is a function call (possibly dereferenced) that corresponds
1402 -- to the proper expansion of the source indexing operation. Before
1403 -- expansion, the source node is rewritten as the resolved generalized
1404 -- indexing.
1406 -- Generic_Parent
1407 -- Generic_Parent is defined on declaration nodes that are instances. The
1408 -- value of Generic_Parent is the generic entity from which the instance
1409 -- is obtained.
1411 -- Generic_Parent_Type
1412 -- Generic_Parent_Type is defined on Subtype_Declaration nodes for the
1413 -- actuals of formal private and derived types. Within the instance, the
1414 -- operations on the actual are those inherited from the parent. For a
1415 -- formal private type, the parent type is the generic type itself. The
1416 -- Generic_Parent_Type is also used in an instance to determine whether a
1417 -- private operation overrides an inherited one.
1419 -- Handler_List_Entry
1420 -- This field is present in N_Object_Declaration nodes. It is set only
1421 -- for the Handler_Record entry generated for an exception in zero cost
1422 -- exception handling mode. It references the corresponding item in the
1423 -- handler list, and is used to delete this entry if the corresponding
1424 -- handler is deleted during optimization. For further details on why
1425 -- this is required, see Exp_Ch11.Remove_Handler_Entries.
1427 -- Has_Dereference_Action
1428 -- This flag is present in N_Explicit_Dereference nodes. It is set to
1429 -- indicate that the expansion has aready produced a call to primitive
1430 -- Dereference of a System.Checked_Pools.Checked_Pool implementation.
1431 -- Such dereference actions are produced for debugging purposes.
1433 -- Has_Dynamic_Length_Check
1434 -- This flag is present in all expression nodes. It is set to indicate
1435 -- that one of the routines in unit Checks has generated a length check
1436 -- action which has been inserted at the flagged node. This is used to
1437 -- avoid the generation of duplicate checks.
1439 -- Has_Local_Raise
1440 -- Present in exception handler nodes. Set if the handler can be entered
1441 -- via a local raise that gets transformed to a goto statement. This will
1442 -- always be set if Local_Raise_Statements is non-empty, but can also be
1443 -- set as a result of generation of N_Raise_xxx nodes, or flags set in
1444 -- nodes requiring generation of back end checks.
1446 -- Has_No_Elaboration_Code
1447 -- A flag that appears in the N_Compilation_Unit node to indicate whether
1448 -- or not elaboration code is present for this unit. It is initially set
1449 -- true for subprogram specs and bodies and for all generic units and
1450 -- false for non-generic package specs and bodies. Gigi may set the flag
1451 -- in the non-generic package case if it determines that no elaboration
1452 -- code is generated. Note that this flag is not related to the
1453 -- Is_Preelaborated status, there can be preelaborated packages that
1454 -- generate elaboration code, and non-preelaborated packages which do
1455 -- not generate elaboration code.
1457 -- Has_Pragma_Suppress_All
1458 -- This flag is set in an N_Compilation_Unit node if the Suppress_All
1459 -- pragma appears anywhere in the unit. This accommodates the rather
1460 -- strange placement rules of other compilers (DEC permits it at the
1461 -- end of a unit, and Rational allows it as a program unit pragma). We
1462 -- allow it anywhere at all, and consider it equivalent to a pragma
1463 -- Suppress (All_Checks) appearing at the start of the configuration
1464 -- pragmas for the unit.
1466 -- Has_Private_View
1467 -- A flag present in generic nodes that have an entity, to indicate that
1468 -- the node has a private type. Used to exchange private and full
1469 -- declarations if the visibility at instantiation is different from the
1470 -- visibility at generic definition.
1472 -- Has_Relative_Deadline_Pragma
1473 -- A flag present in N_Subprogram_Body and N_Task_Definition nodes to
1474 -- flag the presence of a pragma Relative_Deadline.
1476 -- Has_Secondary_Private_View
1477 -- A flag present in generic nodes that have an entity, to indicate that
1478 -- the node is either of an access type whose Designated_Type is private
1479 -- or of an array type whose Component_Type is private. Used to exchange
1480 -- private and full declarations if the visibility at instantiation is
1481 -- different from the visibility at generic definition.
1483 -- Has_Self_Reference
1484 -- Present in N_Aggregate and N_Extension_Aggregate. Indicates that one
1485 -- of the expressions contains an access attribute reference to the
1486 -- enclosing type. Such a self-reference can only appear in default-
1487 -- initialized aggregate for a record type.
1489 -- Has_SP_Choice
1490 -- Present in all nodes containing a Discrete_Choices field (N_Variant,
1491 -- N_Case_Expression_Alternative, N_Case_Statement_Alternative). Set to
1492 -- True if the Discrete_Choices list has at least one occurrence of a
1493 -- statically predicated subtype.
1495 -- Has_Storage_Size_Pragma
1496 -- A flag present in an N_Task_Definition node to flag the presence of a
1497 -- Storage_Size pragma.
1499 -- Has_Target_Names
1500 -- Present in assignment statements. Indicates that the RHS contains
1501 -- target names (see AI12-0125-3) and must be expanded accordingly.
1503 -- Has_Wide_Character
1504 -- Present in string literals, set if any wide character (i.e. character
1505 -- code outside the Character range but within Wide_Character range)
1506 -- appears in the string. Used to implement pragma preference rules.
1508 -- Has_Wide_Wide_Character
1509 -- Present in string literals, set if any wide character (i.e. character
1510 -- code outside the Wide_Character range) appears in the string. Used to
1511 -- implement pragma preference rules.
1513 -- Header_Size_Added
1514 -- Present in N_Attribute_Reference nodes, set only for attribute
1515 -- Max_Size_In_Storage_Elements. The flag indicates that the size of the
1516 -- hidden list header used by the runtime finalization support has been
1517 -- added to the size of the prefix. The flag also prevents the infinite
1518 -- expansion of the same attribute in the said context.
1520 -- Hidden_By_Use_Clause
1521 -- An entity list present in use clauses that appear within
1522 -- instantiations. For the resolution of local entities, entities
1523 -- introduced by these use clauses have priority over global ones,
1524 -- and outer entities must be explicitly hidden/restored on exit.
1526 -- Implicit_With
1527 -- Present in N_With_Clause nodes. The flag indicates that the clause
1528 -- does not comes from source and introduces an implicit dependency on
1529 -- a particular unit. Such implicit with clauses are generated by:
1531 -- * ABE mechanism - The static elaboration model of both the default
1532 -- and the legacy ABE mechanism use with clauses to encode implicit
1533 -- Elaborate[_All] pragmas.
1535 -- * Analysis - A with clause for child unit A.B.C is equivalent to
1536 -- a series of clauses that with A, A.B, and A.B.C. Manipulation of
1537 -- contexts utilizes implicit with clauses to emulate the visibility
1538 -- of a particular unit.
1540 -- * RTSfind - The compiler generates code which references entities
1541 -- from the runtime.
1543 -- Import_Interface_Present
1544 -- This flag is set in an Interface or Import pragma if a matching
1545 -- pragma of the other kind is also present. This is used to avoid
1546 -- generating some unwanted error messages.
1548 -- Includes_Infinities
1549 -- This flag is present in N_Range nodes. It is set for the range of
1550 -- unconstrained float types defined in Standard, which include not only
1551 -- the given range of values, but also legitimately can include infinite
1552 -- values. This flag is false for any float type for which an explicit
1553 -- range is given by the programmer, even if that range is identical to
1554 -- the range for Float.
1556 -- Incomplete_View
1557 -- Present in full type declarations that are completions of incomplete
1558 -- type declarations. Denotes the corresponding incomplete view declared
1559 -- by the incomplete declaration.
1561 -- Inherited_Discriminant
1562 -- This flag is present in N_Component_Association nodes. It indicates
1563 -- that a given component association in an extension aggregate is the
1564 -- value obtained from a constraint on an ancestor. Used to prevent
1565 -- double expansion when the aggregate has expansion delayed.
1567 -- Instance_Spec
1568 -- This field is present in generic instantiation nodes, and also in
1569 -- formal package declaration nodes (formal package declarations are
1570 -- treated in a manner very similar to package instantiations). It points
1571 -- to the node for the spec of the instance, inserted as part of the
1572 -- semantic processing for instantiations in Sem_Ch12.
1574 -- Is_Abort_Block
1575 -- Present in N_Block_Statement nodes. True if the block protects a list
1576 -- of statements with an Abort_Defer / Abort_Undefer_Direct pair.
1578 -- Is_Accessibility_Actual
1579 -- Present in N_Parameter_Association nodes. True if the parameter is
1580 -- an extra actual that carries the accessibility level of the actual
1581 -- for an access parameter, in a function that dispatches on result and
1582 -- is called in a dispatching context. Used to prevent a formal/actual
1583 -- mismatch when the call is rewritten as a dispatching call.
1585 -- Is_Analyzed_Pragma
1586 -- Present in N_Pragma nodes. Set for delayed pragmas that require a two
1587 -- step analysis. The initial step is performed by routine Analyze_Pragma
1588 -- and verifies the overall legality of the pragma. The second step takes
1589 -- place in the various Analyze_xxx_In_Decl_Part routines which perform
1590 -- full analysis. The flag prevents the reanalysis of a delayed pragma.
1592 -- Is_Asynchronous_Call_Block
1593 -- A flag set in a Block_Statement node to indicate that it is the
1594 -- expansion of an asynchronous entry call. Such a block needs cleanup
1595 -- handler to assure that the call is cancelled.
1597 -- Is_Boolean_Aspect
1598 -- Present in N_Aspect_Specification node. Set if the aspect is for a
1599 -- boolean aspect (i.e. Aspect_Id is in Boolean_Aspect subtype).
1601 -- Is_Checked
1602 -- Present in N_Aspect_Specification and N_Pragma nodes. Set for an
1603 -- assertion aspect or pragma, or check pragma for an assertion, that
1604 -- is to be checked at run time. If either Is_Checked or Is_Ignored
1605 -- is set (they cannot both be set), then this means that the status of
1606 -- the pragma has been checked at the appropriate point and should not
1607 -- be further modified (in some cases these flags are copied when a
1608 -- pragma is rewritten).
1610 -- Is_Checked_Ghost_Pragma
1611 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1612 -- related to a checked Ghost entity or encloses a checked Ghost entity.
1613 -- This flag has no relation to Is_Checked.
1615 -- Is_Component_Left_Opnd
1616 -- Is_Component_Right_Opnd
1617 -- Present in concatenation nodes, to indicate that the corresponding
1618 -- operand is of the component type of the result. Used in resolving
1619 -- concatenation nodes in instances.
1621 -- Is_Controlling_Actual
1622 -- This flag is set on an expression that is a controlling argument in
1623 -- a dispatching call. It is off in all other cases. See Sem_Disp for
1624 -- details of its use.
1626 -- Is_Declaration_Level_Node
1627 -- Present in call marker and instantiation nodes. Set when the constuct
1628 -- appears within the declarations of a block statement, an entry body,
1629 -- a subprogram body, or a task body. The flag aids the ABE Processing
1630 -- phase to catch certain forms of guaranteed ABEs.
1632 -- Is_Delayed_Aspect
1633 -- Present in N_Pragma and N_Attribute_Definition_Clause nodes which
1634 -- come from aspect specifications, where the evaluation of the aspect
1635 -- must be delayed to the freeze point. This flag is also set True in
1636 -- the corresponding N_Aspect_Specification node.
1638 -- Is_Disabled
1639 -- A flag set in an N_Aspect_Specification or N_Pragma node if there was
1640 -- a Check_Policy or Assertion_Policy (or in the case of a Debug_Pragma)
1641 -- a Debug_Policy pragma that resulted in totally disabling the flagged
1642 -- aspect or policy as a result of using the GNAT-defined policy DISABLE.
1643 -- If this flag is set, the aspect or policy is not analyzed for semantic
1644 -- correctness, so any expressions etc will not be marked as analyzed.
1646 -- Is_Dispatching_Call
1647 -- Present in call marker nodes. Set when the related call which prompted
1648 -- the creation of the marker is dispatching.
1650 -- Is_Dynamic_Coextension
1651 -- Present in allocator nodes, to indicate that this is an allocator
1652 -- for an access discriminant of a dynamically allocated object. The
1653 -- coextension must be deallocated and finalized at the same time as
1654 -- the enclosing object. The partner flag Is_Static_Coextension must
1655 -- be cleared before setting this flag to True.
1657 -- Is_Effective_Use_Clause
1658 -- Present in both N_Use_Type_Clause and N_Use_Package_Clause to indicate
1659 -- a use clause is "used" in the current source.
1661 -- Is_Elaboration_Checks_OK_Node
1662 -- Present in the following nodes:
1664 -- assignment statement
1665 -- attribute reference
1666 -- call marker
1667 -- entry call statement
1668 -- expanded name
1669 -- function call
1670 -- function instantiation
1671 -- identifier
1672 -- package instantiation
1673 -- procedure call statement
1674 -- procedure instantiation
1675 -- requeue statement
1676 -- variable reference marker
1678 -- Set when the node appears within a context which allows the generation
1679 -- of run-time ABE checks. This flag determines whether the ABE
1680 -- Processing phase generates conditional ABE checks and guaranteed ABE
1681 -- failures.
1683 -- Is_Elaboration_Code
1684 -- Present in assignment statements. Set for an assignment which updates
1685 -- the elaboration flag of a package or subprogram when the corresponding
1686 -- body is successfully elaborated.
1688 -- Is_Elaboration_Warnings_OK_Node
1689 -- Present in the following nodes:
1691 -- attribute reference
1692 -- call marker
1693 -- entry call statement
1694 -- expanded name
1695 -- function call
1696 -- function instantiation
1697 -- identifier
1698 -- package instantiation
1699 -- procedure call statement
1700 -- procedure instantiation
1701 -- requeue statement
1702 -- variable reference marker
1704 -- Set when the node appears within a context where elaboration warnings
1705 -- are enabled. This flag determines whether the ABE processing phase
1706 -- generates diagnostics on various elaboration issues.
1708 -- Is_Entry_Barrier_Function
1709 -- This flag is set on N_Subprogram_Declaration and N_Subprogram_Body
1710 -- nodes which emulate the barrier function of a protected entry body.
1711 -- The flag is used when checking for incorrect use of Current_Task.
1713 -- Is_Enum_Array_Aggregate
1714 -- A flag set on an aggregate created internally while building the
1715 -- images tables for enumerations.
1717 -- Is_Expanded_Build_In_Place_Call
1718 -- This flag is set in an N_Function_Call node to indicate that the extra
1719 -- actuals to support a build-in-place style of call have been added to
1720 -- the call.
1722 -- Is_Expanded_Contract
1723 -- Present in N_Contract nodes. Set if the contract has already undergone
1724 -- expansion activities.
1726 -- Is_Finalization_Wrapper
1727 -- This flag is present in N_Block_Statement nodes. It is set when the
1728 -- block acts as a wrapper of a handled construct which has controlled
1729 -- objects. The wrapper prevents interference between exception handlers
1730 -- and At_End handlers.
1732 -- Is_Generic_Contract_Pragma
1733 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1734 -- a source construct, applies to a generic unit or its body, and denotes
1735 -- one of the following contract-related annotations:
1736 -- Abstract_State
1737 -- Always_Terminates
1738 -- Contract_Cases
1739 -- Depends
1740 -- Exceptional_Cases
1741 -- Extensions_Visible
1742 -- Global
1743 -- Initial_Condition
1744 -- Initializes
1745 -- Post
1746 -- Post_Class
1747 -- Postcondition
1748 -- Pre
1749 -- Pre_Class
1750 -- Precondition
1751 -- Refined_Depends
1752 -- Refined_Global
1753 -- Refined_Post
1754 -- Refined_State
1755 -- Subprogram_Variant
1756 -- Test_Case
1758 -- Is_Homogeneous_Aggregate
1759 -- A flag set on an Ada 2022 aggregate that uses square brackets as
1760 -- delimiters, and thus denotes an array or container aggregate, or
1761 -- the prefix of a reduction attribute.
1763 -- Is_Ignored
1764 -- A flag set in an N_Aspect_Specification or N_Pragma node if there was
1765 -- a Check_Policy or Assertion_Policy (or in the case of a Debug_Pragma)
1766 -- a Debug_Policy pragma that specified a policy of IGNORE, DISABLE, or
1767 -- OFF, for the pragma/aspect. If there was a Policy pragma specifying
1768 -- a Policy of ON or CHECK, then this flag is reset. If no Policy pragma
1769 -- gives a policy for the aspect or pragma, then there are two cases. For
1770 -- an assertion aspect or pragma (one of the assertion kinds allowed in
1771 -- an Assertion_Policy pragma), then Is_Ignored is set if assertions are
1772 -- ignored because of the absence of a -gnata switch. For any other
1773 -- aspects or pragmas, the flag is off. If this flag is set, the
1774 -- aspect/pragma is fully analyzed and checked for other syntactic
1775 -- and semantic errors, but it does not have any semantic effect.
1777 -- Is_Ignored_Ghost_Pragma
1778 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1779 -- related to an ignored Ghost entity or encloses ignored Ghost entity.
1780 -- This flag has no relation to Is_Ignored.
1782 -- Is_In_Discriminant_Check
1783 -- This flag is present in a selected component, and is used to indicate
1784 -- that the reference occurs within a discriminant check. The
1785 -- significance is that optimizations based on assuming that the
1786 -- discriminant check has a correct value cannot be performed in this
1787 -- case (or the discriminant check may be optimized away).
1789 -- Is_Inherited_Pragma
1790 -- This flag is set in an N_Pragma node that appears in a N_Contract node
1791 -- to indicate that the pragma has been inherited from a parent context.
1793 -- Is_Initialization_Block
1794 -- Defined in block nodes. Set when the block statement was created by
1795 -- the finalization machinery to wrap initialization statements. This
1796 -- flag aids the ABE Processing phase to suppress the diagnostics of
1797 -- finalization actions in initialization contexts.
1799 -- Is_Known_Guaranteed_ABE
1800 -- NOTE: this flag is shared between the legacy ABE mechanism and the
1801 -- default ABE mechanism.
1803 -- Present in the following nodes:
1805 -- call marker
1806 -- formal package declaration
1807 -- function call
1808 -- function instantiation
1809 -- package instantiation
1810 -- procedure call statement
1811 -- procedure instantiation
1813 -- Set when the elaboration or evaluation of the scenario results in
1814 -- a guaranteed ABE. The flag is used to suppress the instantiation of
1815 -- generic bodies because gigi cannot handle certain forms of premature
1816 -- instantiation, as well as to prevent the reexamination of the node by
1817 -- the ABE Processing phase.
1819 -- Is_Machine_Number
1820 -- This flag is set in an N_Real_Literal node to indicate that the value
1821 -- is a machine number. This avoids some unnecessary cases of converting
1822 -- real literals to machine numbers.
1824 -- Is_Null_Loop
1825 -- This flag is set in an N_Loop_Statement node if the corresponding loop
1826 -- can be determined to be null at compile time. This is used to remove
1827 -- the loop entirely at expansion time.
1829 -- Is_Overloaded
1830 -- A flag present in all expression nodes. Used temporarily during
1831 -- overloading determination. The setting of this flag is not relevant
1832 -- once overloading analysis is complete.
1834 -- Is_Parenthesis_Aggregate
1835 -- A flag set on an aggregate that uses parentheses as delimiters
1837 -- Is_Power_Of_2_For_Shift
1838 -- A flag present only in N_Op_Expon nodes. It is set when the
1839 -- exponentiation is of the form 2 ** N, where the type of N is an
1840 -- unsigned integral subtype whose size does not exceed the size of
1841 -- Standard_Integer (i.e. a type that can be safely converted to
1842 -- Natural), and the exponentiation appears as the right operand of an
1843 -- integer multiplication or an integer division where the dividend is
1844 -- unsigned. It is also required that overflow checking is off for both
1845 -- the exponentiation and the multiply/divide node. If this set of
1846 -- conditions holds, and the flag is set, then the division or
1847 -- multiplication can be (and is) converted to a shift.
1849 -- Is_Preelaborable_Call
1850 -- Present in call marker nodes. Set when the related call is non-static
1851 -- but preelaborable.
1853 -- Is_Prefixed_Call
1854 -- This flag is set in a selected component within a generic unit, if
1855 -- it resolves to a prefixed call to a primitive operation. The flag
1856 -- is used to prevent accidental overloadings in an instance, when a
1857 -- primitive operation and a private record component may be homographs.
1859 -- Is_Protected_Subprogram_Body
1860 -- A flag set in a Subprogram_Body block to indicate that it is the
1861 -- implementation of a protected subprogram. Such a body needs cleanup
1862 -- handler to make sure that the associated protected object is unlocked
1863 -- when the subprogram completes.
1865 -- Is_Qualified_Universal_Literal
1866 -- Present in N_Qualified_Expression nodes. Set when the qualification is
1867 -- converting a universal literal to a specific type. Such qualifiers aid
1868 -- the resolution of accidental overloading of binary or unary operators
1869 -- which may occur in instances.
1871 -- Is_Read
1872 -- Present in variable reference markers. Set when the original variable
1873 -- reference constitutes a read of the variable.
1875 -- Is_Source_Call
1876 -- Present in call marker nodes. Set when the related call came from
1877 -- source.
1879 -- Is_SPARK_Mode_On_Node
1880 -- Present in the following nodes:
1882 -- assignment statement
1883 -- attribute reference
1884 -- call marker
1885 -- entry call statement
1886 -- expanded name
1887 -- function call
1888 -- function instantiation
1889 -- identifier
1890 -- package instantiation
1891 -- procedure call statement
1892 -- procedure instantiation
1893 -- requeue statement
1894 -- variable reference marker
1896 -- Set when the node appears within a context subject to SPARK_Mode On.
1897 -- This flag determines when the SPARK model of elaboration be activated
1898 -- by the ABE Processing phase.
1900 -- Is_Static_Coextension
1901 -- Present in N_Allocator nodes. Set if the allocator is a coextension
1902 -- of an object allocated on the stack rather than the heap. The partner
1903 -- flag Is_Dynamic_Coextension must be cleared before setting this flag
1904 -- to True.
1906 -- Is_Static_Expression
1907 -- Indicates that an expression is a static expression according to the
1908 -- rules in RM-4.9. See Sem_Eval for details.
1910 -- Is_Subprogram_Descriptor
1911 -- Present in N_Object_Declaration, and set only for the object
1912 -- declaration generated for a subprogram descriptor in fast exception
1913 -- mode. See Exp_Ch11 for details of use.
1915 -- Is_Task_Allocation_Block
1916 -- A flag set in a Block_Statement node to indicate that it is the
1917 -- expansion of a task allocator, or the allocator of an object
1918 -- containing tasks. Such a block requires a cleanup handler to call
1919 -- Expunge_Unactivated_Tasks to complete any tasks that have been
1920 -- allocated but not activated when the allocator completes abnormally.
1922 -- Is_Task_Body_Procedure
1923 -- This flag is set on N_Subprogram_Declaration and N_Subprogram_Body
1924 -- nodes which emulate the body of a task unit.
1926 -- Is_Task_Master
1927 -- A flag set in a Subprogram_Body, Block_Statement, or Task_Body node to
1928 -- indicate that the construct is a task master (i.e. has declared tasks
1929 -- or declares an access to a task type).
1931 -- Is_Write
1932 -- Present in variable reference markers. Set when the original variable
1933 -- reference constitutes a write of the variable.
1935 -- Iterator_Filter
1936 -- Present in N_Loop_Parameter_Specification and N_Iterator_Specification
1937 -- nodes for Ada 2022. It is used to store the condition present in the
1938 -- eponymous Ada 2022 construct.
1940 -- Itype
1941 -- Used in N_Itype_Reference node to reference an itype for which it is
1942 -- important to ensure that it is defined. See description of this node
1943 -- for further details.
1945 -- Kill_Range_Check
1946 -- Used in an N_Unchecked_Type_Conversion node to indicate that the
1947 -- result should not be subjected to range checks. This is used for the
1948 -- implementation of Normalize_Scalars.
1950 -- Label_Construct
1951 -- Used in an N_Implicit_Label_Declaration node. Refers to an N_Label,
1952 -- N_Block_Statement or N_Loop_Statement node to which the label
1953 -- declaration applies. The field is left empty for the special labels
1954 -- generated as part of expanding raise statements with a local exception
1955 -- handler.
1957 -- Library_Unit
1958 -- In a stub node, Library_Unit points to the compilation unit node of
1959 -- the corresponding subunit.
1961 -- In a with clause node, Library_Unit points to the spec of the with'ed
1962 -- unit.
1964 -- In a compilation unit node, the usage depends on the unit type:
1966 -- For a library unit body, Library_Unit points to the compilation unit
1967 -- node of the corresponding spec, unless it's a subprogram body with
1968 -- Acts_As_Spec set, in which case it points to itself.
1970 -- For a spec, Library_Unit points to the compilation unit node of the
1971 -- corresponding body, if present. The body will be present if the spec
1972 -- is or contains generics that we needed to instantiate. Similarly, the
1973 -- body will be present if we needed it for inlining purposes. Thus, if
1974 -- we have a spec/body pair, both of which are present, they point to
1975 -- each other via Library_Unit.
1977 -- For a subunit, Library_Unit points to the compilation unit node of
1978 -- the parent body.
1979 -- ??? not (always) true, in (at least some, maybe all?) cases it points
1980 -- to the corresponding spec for the parent body.
1982 -- Note that this field is not used to hold the parent pointer for child
1983 -- unit (which might in any case need to use it for some other purpose as
1984 -- described above). Instead for a child unit, implicit with's are
1985 -- generated for all parents.
1987 -- Local_Raise_Statements
1988 -- This field is present in exception handler nodes. It is set to
1989 -- No_Elist in the normal case. If there is at least one raise statement
1990 -- which can potentially be handled as a local raise, then this field
1991 -- points to a list of raise nodes, which are calls to a routine to raise
1992 -- an exception. These are raise nodes which can be optimized into gotos
1993 -- if the handler turns out to meet the conditions which permit this
1994 -- transformation. Note that this does NOT include instances of the
1995 -- N_Raise_xxx_Error nodes since the transformation of these nodes is
1996 -- handled by the back end (using the N_Push/N_Pop mechanism).
1998 -- Loop_Actions
1999 -- A list present in Component_Association nodes in array aggregates.
2000 -- Used to collect actions that must be executed within the loop because
2001 -- they may need to be evaluated anew each time through.
2003 -- Limited_View_Installed
2004 -- Present in With_Clauses and in package specifications. If set on
2005 -- with_clause, it indicates that this clause has created the current
2006 -- limited view of the designated package. On a package specification, it
2007 -- indicates that the limited view has already been created because the
2008 -- package is mentioned in a limited_with_clause in the closure of the
2009 -- unit being compiled.
2011 -- Local_Raise_Not_OK
2012 -- Present in N_Exception_Handler nodes. Set if the handler contains
2013 -- a construct (reraise statement, or call to subprogram in package
2014 -- GNAT.Current_Exception) that makes the handler unsuitable as a target
2015 -- for a local raise (one that could otherwise be converted to a goto).
2017 -- Must_Be_Byte_Aligned
2018 -- This flag is present in N_Attribute_Reference nodes. It can be set
2019 -- only for the Address and Unrestricted_Access attributes. If set it
2020 -- means that the object for which the address/access is given must be on
2021 -- a byte (more accurately a storage unit) boundary. If necessary, a copy
2022 -- of the object is to be made before taking the address (this copy is in
2023 -- the current scope on the stack frame). This is used for certain cases
2024 -- of code generated by the expander that passes parameters by address.
2026 -- The reason the copy is not made by the front end is that the back end
2027 -- has more information about type layout and may be able to (but is not
2028 -- guaranteed to) prevent making unnecessary copies.
2030 -- Must_Not_Freeze
2031 -- A flag present in all expression nodes. Normally expressions cause
2032 -- freezing as described in the RM. If this flag is set, then this is
2033 -- inhibited. This is used by the analyzer and expander to label nodes
2034 -- that are created by semantic analysis or expansion and which must not
2035 -- cause freezing even though they normally would. This flag is also
2036 -- present in an N_Subtype_Indication node, since we also use these in
2037 -- calls to Freeze_Expression.
2039 -- Next_Entity
2040 -- Present in defining identifiers, defining character literals, and
2041 -- defining operator symbols (i.e. in all entities). The entities of a
2042 -- scope are chained, and this field is used as the forward pointer for
2043 -- this list. See Einfo for further details.
2045 -- Next_Exit_Statement
2046 -- Present in N_Exit_Statement nodes. The exit statements for a loop are
2047 -- chained (in reverse order of appearance) from the First_Exit_Statement
2048 -- field of the E_Loop entity for the loop. Next_Exit_Statement points to
2049 -- the next entry on this chain (Empty = end of list).
2051 -- Next_Implicit_With
2052 -- Present in N_With_Clause. Part of a chain of with_clauses generated
2053 -- in rtsfind to indicate implicit dependencies on predefined units. Used
2054 -- to prevent multiple with_clauses for the same unit in a given context.
2055 -- A postorder traversal of the tree whose nodes are units and whose
2056 -- links are with_clauses defines the order in which CodePeer must
2057 -- examine a compiled unit and its full context. This ordering ensures
2058 -- that any subprogram call is examined after the subprogram declaration
2059 -- has been seen.
2061 -- Next_Named_Actual
2062 -- Present in parameter association nodes. Set during semantic analysis
2063 -- to point to the next named parameter, where parameters are ordered by
2064 -- declaration order (as opposed to the actual order in the call, which
2065 -- may be different due to named associations). Not that this field
2066 -- points to the explicit actual parameter itself, not to the
2067 -- N_Parameter_Association node (its parent).
2069 -- Next_Pragma
2070 -- Present in N_Pragma nodes. Used to create a linked list of pragma
2071 -- nodes. Currently used for two purposes:
2073 -- Create a list of linked Check_Policy pragmas. The head of this list
2074 -- is stored in Opt.Check_Policy_List (which has further details).
2076 -- Used by processing for Pre/Postcondition pragmas to store a list of
2077 -- pragmas associated with the spec of a subprogram (see Sem_Prag for
2078 -- details).
2080 -- Used by processing for pragma SPARK_Mode to store multiple pragmas
2081 -- the apply to the same construct. These are visible/private mode for
2082 -- a package spec and declarative/statement mode for package body.
2084 -- Next_Rep_Item
2085 -- Present in pragma nodes, attribute definition nodes, enumeration rep
2086 -- clauses, record rep clauses, aspect specification and null statement
2087 -- nodes. Used to link representation items that apply to an entity. See
2088 -- full description of First_Rep_Item field in Einfo for further details.
2090 -- Next_Use_Clause
2091 -- While use clauses are active during semantic processing, they are
2092 -- chained from the scope stack entry, using Next_Use_Clause as a link
2093 -- pointer, with Empty marking the end of the list. The head pointer is
2094 -- in the scope stack entry (First_Use_Clause). At the end of semantic
2095 -- processing (i.e. when Gigi sees the tree, the contents of this field
2096 -- is undefined and should not be read).
2098 -- No_Ctrl_Actions
2099 -- Present in N_Assignment_Statement to indicate that neither Finalize
2100 -- nor Adjust should take place on this assignment even though the LHS
2101 -- and RHS are controlled. Also to indicate that the primitive _assign
2102 -- should not be used for a tagged assignment. This flag is used in init
2103 -- proc and aggregate expansion where the generated assignments are
2104 -- initializations, not real assignments. Note that it also suppresses
2105 -- the creation of transient scopes around the N_Assignment_Statement,
2106 -- in other words it disables all controlled actions for the assignment.
2108 -- No_Elaboration_Check
2109 -- NOTE: this flag is relevant only for the legacy ABE mechanism and
2110 -- should not be used outside of that context.
2112 -- Present in N_Function_Call and N_Procedure_Call_Statement. Indicates
2113 -- that no elaboration check is needed on the call, because it appears in
2114 -- the context of a local Suppress pragma. This is used on calls within
2115 -- task bodies, where the actual elaboration checks are applied after
2116 -- analysis, when the local scope stack is not present.
2118 -- No_Entities_Ref_In_Spec
2119 -- Present in N_With_Clause nodes. Set if the with clause is on the
2120 -- package or subprogram spec where the main unit is the corresponding
2121 -- body, and no entities of the with'ed unit are referenced by the spec
2122 -- (an entity may still be referenced in the body, so this flag is used
2123 -- to generate the proper message (see Sem_Util.Check_Unused_Withs for
2124 -- full details).
2126 -- No_Finalize_Actions
2127 -- Present in N_Assignment_Statement to indicate that no Finalize should
2128 -- take place on this assignment even though the LHS is controlled. Also
2129 -- to indicate that the primitive _assign should not be used for a tagged
2130 -- assignment. This flag is only used in aggregates expansion where the
2131 -- generated assignments are initializations, not real assignments. Note
2132 -- that, unlike the No_Ctrl_Actions flag, it does *not* suppress the
2133 -- creation of transient scopes around the N_Assignment_Statement.
2135 -- No_Initialization
2136 -- Present in N_Object_Declaration and N_Allocator to indicate that the
2137 -- object must not be initialized (by Initialize or call to an init
2138 -- proc). This is needed for controlled aggregates. When the Object
2139 -- declaration has an expression, this flag means that this expression
2140 -- should not be taken into account (needed for in place initialization
2141 -- with aggregates, and for object with an address clause, which are
2142 -- initialized with an assignment at freeze time).
2144 -- No_Minimize_Eliminate
2145 -- This flag is present in membership operator nodes (N_In/N_Not_In).
2146 -- It is used to indicate that processing for extended overflow checking
2147 -- modes is not required (this is used to prevent infinite recursion).
2149 -- No_Truncation
2150 -- Present in N_Unchecked_Type_Conversion node. This flag has an effect
2151 -- only if the RM_Size of the source is greater than the RM_Size of the
2152 -- target for scalar operands. Normally in such a case we truncate some
2153 -- higher order bits of the source, and then sign/zero extend the result
2154 -- to form the output value. But if this flag is set, then we do not do
2155 -- any truncation, so for example, if an 8 bit input is converted to 5
2156 -- bit result which is in fact stored in 8 bits, then the high order
2157 -- three bits of the target result will be copied from the source. This
2158 -- is used for properly setting out of range values for use by pragmas
2159 -- Initialize_Scalars and Normalize_Scalars.
2161 -- Null_Excluding_Subtype
2162 -- Present in N_Access_To_Object_Definition. Indicates that the subtype
2163 -- indication carries a null-exclusion indicator, which is distinct from
2164 -- the null-exclusion indicator that may precede the access keyword.
2166 -- Original_Discriminant
2167 -- Present in identifiers. Used in references to discriminants that
2168 -- appear in generic units. Because the names of the discriminants may be
2169 -- different in an instance, we use this field to recover the position of
2170 -- the discriminant in the original type, and replace it with the
2171 -- discriminant at the same position in the instantiated type.
2173 -- Original_Entity
2174 -- Present in numeric literals. Used to denote the named number that has
2175 -- been constant-folded into the given literal. If literal is from
2176 -- source, or the result of some other constant-folding operation, then
2177 -- Original_Entity is empty. This field is needed to handle properly
2178 -- named numbers in generic units, where the Associated_Node field
2179 -- interferes with the Entity field, making it impossible to preserve the
2180 -- original entity at the point of instantiation.
2182 -- Others_Discrete_Choices
2183 -- When a case statement or variant is analyzed, the semantic checks
2184 -- determine the actual list of choices that correspond to an others
2185 -- choice. This list is materialized for later use by the expander and
2186 -- the Others_Discrete_Choices field of an N_Others_Choice node points to
2187 -- this materialized list of choices, which is in standard format for a
2188 -- list of discrete choices, except that of course it cannot contain an
2189 -- N_Others_Choice entry.
2191 -- Parent_Spec
2192 -- For a library unit that is a child unit spec (package or subprogram
2193 -- declaration, generic declaration or instantiation, or library level
2194 -- rename) this field points to the compilation unit node for the parent
2195 -- package specification. This field is Empty for library bodies (the
2196 -- parent spec in this case can be found from the corresponding spec).
2198 -- Parent_With
2199 -- Present in N_With_Clause nodes. The flag indicates that the clause
2200 -- was generated for an ancestor unit to provide proper visibility. A
2201 -- with clause for child unit A.B.C produces two implicit parent with
2202 -- clauses for A and A.B.
2204 -- Premature_Use
2205 -- Present in N_Incomplete_Type_Declaration node. Used for improved
2206 -- error diagnostics: if there is a premature usage of an incomplete
2207 -- type, a subsequently generated error message indicates the position
2208 -- of its full declaration.
2210 -- Present_Expr
2211 -- Present in an N_Variant node. This has a meaningful value only after
2212 -- Gigi has back annotated the tree with representation information. At
2213 -- this point, it contains a reference to a gcc expression that depends
2214 -- on the values of one or more discriminants. Given a set of
2215 -- discriminant values, this expression evaluates to False (zero) if
2216 -- variant is not present, and True (non-zero) if it is present. See
2217 -- unit Repinfo for further details on gigi back annotation. This field
2218 -- is used during back-annotation processing (for -gnatR -gnatc) to
2219 -- determine if a field is present or not.
2221 -- Prev_Use_Clause
2222 -- Present in both N_Use_Package_Clause and N_Use_Type_Clause. Used in
2223 -- detection of ineffective use clauses by allowing a chain of related
2224 -- clauses together to avoid traversing the current scope stack.
2226 -- Print_In_Hex
2227 -- Set on an N_Integer_Literal node to indicate that the value should be
2228 -- printed in hexadecimal in the sprint listing. Has no effect on
2229 -- legality or semantics of program, only on the displayed output. This
2230 -- is used to clarify output from the packed array cases.
2232 -- Procedure_To_Call
2233 -- Present in N_Allocator, N_Free_Statement, N_Simple_Return_Statement,
2234 -- and N_Extended_Return_Statement nodes. References the entity for the
2235 -- declaration of the procedure to be called to accomplish the required
2236 -- operation (i.e. for the Allocate procedure in the case of N_Allocator
2237 -- and N_Simple_Return_Statement and N_Extended_Return_Statement (for
2238 -- allocating the return value), and for the Deallocate procedure in the
2239 -- case of N_Free_Statement.
2241 -- Raises_Constraint_Error
2242 -- Set on an expression whose evaluation will definitely fail constraint
2243 -- error check. See Sem_Eval for details.
2245 -- Redundant_Use
2246 -- Present in nodes that can appear as an operand in a use clause or use
2247 -- type clause (identifiers, expanded names, attribute references). Set
2248 -- to indicate that a use is redundant (and therefore need not be undone
2249 -- on scope exit).
2251 -- Renaming_Exception
2252 -- Present in N_Exception_Declaration node. Used to point back to the
2253 -- exception renaming for an exception declared within a subprogram.
2254 -- What happens is that an exception declared in a subprogram is moved
2255 -- to the library level with a unique name, and the original exception
2256 -- becomes a renaming. This link from the library level exception to the
2257 -- renaming declaration allows registering of the proper exception name.
2259 -- Return_Statement_Entity
2260 -- Present in N_Simple_Return_Statement and N_Extended_Return_Statement.
2261 -- Points to an E_Return_Statement representing the return statement.
2263 -- Return_Object_Declarations
2264 -- Present in N_Extended_Return_Statement. Points to a list initially
2265 -- containing a single N_Object_Declaration representing the return
2266 -- object. We use a list (instead of just a pointer to the object decl)
2267 -- because Analyze wants to insert extra actions on this list, before the
2268 -- N_Object_Declaration, which always remains last on the list.
2270 -- Rounded_Result
2271 -- Present in N_Type_Conversion, N_Op_Divide, and N_Op_Multiply nodes.
2272 -- Used in the fixed-point cases to indicate that the result must be
2273 -- rounded as a result of the use of the 'Round attribute. Also used for
2274 -- integer N_Op_Divide nodes to indicate that the result should be
2275 -- rounded to the nearest integer (breaking ties away from zero), rather
2276 -- than truncated towards zero as usual. These rounded integer operations
2277 -- are the result of expansion of rounded fixed-point divide, conversion
2278 -- and multiplication operations.
2280 -- Save_Invocation_Graph_Of_Body
2281 -- Present in compilation unit nodes. Set when the elaboration mechanism
2282 -- must record all invocation constructs and invocation relations within
2283 -- the body of the compilation unit.
2285 -- SCIL_Entity
2286 -- Present in SCIL nodes. References the specific tagged type associated
2287 -- with the SCIL node (for an N_SCIL_Dispatching_Call node, this is
2288 -- the controlling type of the call; for an N_SCIL_Membership_Test node
2289 -- generated as part of testing membership in T'Class, this is T; for an
2290 -- N_SCIL_Dispatch_Table_Tag_Init node, this is the type being declared).
2292 -- SCIL_Controlling_Tag
2293 -- Present in N_SCIL_Dispatching_Call nodes. References the controlling
2294 -- tag of a dispatching call. This is usually an N_Selected_Component
2295 -- node (for a _tag component), but may be an N_Object_Declaration or
2296 -- N_Parameter_Specification node in some cases (e.g., for a call to
2297 -- a classwide streaming operation or a call to an instance of
2298 -- Ada.Tags.Generic_Dispatching_Constructor).
2300 -- SCIL_Tag_Value
2301 -- Present in N_SCIL_Membership_Test nodes. Used to reference the tag
2302 -- of the value that is being tested.
2304 -- SCIL_Target_Prim
2305 -- Present in N_SCIL_Dispatching_Call nodes. References the primitive
2306 -- operation named (statically) in a dispatching call.
2308 -- Scope
2309 -- Present in defining identifiers, defining character literals, and
2310 -- defining operator symbols (i.e. in all entities). The entities of a
2311 -- scope all use this field to reference the corresponding scope entity.
2312 -- See Einfo for further details.
2314 -- Shift_Count_OK
2315 -- A flag present in shift nodes to indicate that the shift count is
2316 -- known to be in range, i.e. is in the range from zero to word length
2317 -- minus one. If this flag is not set, then the shift count may be
2318 -- outside this range, i.e. larger than the word length, and the code
2319 -- must ensure that such shift counts give the appropriate result.
2321 -- Source_Type
2322 -- Used in an N_Validate_Unchecked_Conversion node to point to the
2323 -- source type entity for the unchecked conversion instantiation
2324 -- which gigi must do size validation for.
2326 -- Split_PPC
2327 -- When a Pre or Post aspect specification is processed, it is broken
2328 -- into AND THEN sections. The leftmost section has Split_PPC set to
2329 -- False, indicating that it is the original specification (e.g. for
2330 -- posting errors). For other sections, Split_PPC is set to True.
2331 -- This flag is set in both the N_Aspect_Specification node itself,
2332 -- and in the pragma which is generated from this node.
2334 -- Storage_Pool
2335 -- Present in N_Allocator, N_Free_Statement, N_Simple_Return_Statement,
2336 -- and N_Extended_Return_Statement nodes. References the entity for the
2337 -- storage pool to be used for the allocate or free call or for the
2338 -- allocation of the returned value from function. Empty indicates that
2339 -- the global default pool is to be used. Note that in the case
2340 -- of a return statement, this field is set only if the function returns
2341 -- value of a type whose size is not known at compile time on the
2342 -- secondary stack.
2344 -- Suppress_Assignment_Checks
2345 -- Used in generated N_Assignment_Statement nodes to suppress predicate
2346 -- and range checks in cases where the generated code knows that the
2347 -- value being assigned is in range and satisfies any predicate. Also
2348 -- can be set in N_Object_Declaration nodes, to similarly suppress any
2349 -- checks on the initializing value. In assignment statements it also
2350 -- suppresses access checks in the generated code for out- and in-out
2351 -- parameters in entry calls, as well as discriminant and length checks.
2353 -- Suppress_Loop_Warnings
2354 -- Used in N_Loop_Statement node to indicate that warnings within the
2355 -- body of the loop should be suppressed. This is set when the range
2356 -- of a FOR loop is known to be null, or is probably null (loop would
2357 -- only execute if invalid values are present).
2359 -- Target
2360 -- Present in call and variable reference marker nodes. References the
2361 -- entity of the original entity, operator, or subprogram being invoked,
2362 -- or the original variable being read or written.
2364 -- Target_Type
2365 -- Used in an N_Validate_Unchecked_Conversion node to point to the target
2366 -- type entity for the unchecked conversion instantiation which gigi must
2367 -- do size validation for.
2369 -- Then_Actions
2370 -- This field is present in if expression nodes. During code expansion
2371 -- we use the Insert_Actions procedure (in Exp_Util) to insert actions
2372 -- at an appropriate place in the tree to get elaborated at the right
2373 -- time. For if expressions, we have to be sure that the actions for
2374 -- for the Then branch are only elaborated if the condition is True.
2375 -- The Then_Actions field is used as a temporary parking place for
2376 -- these actions. The final tree is always rewritten to eliminate the
2377 -- need for this field, so in the tree passed to Gigi, this field is
2378 -- always set to No_List.
2380 -- TSS_Elist
2381 -- Present in N_Freeze_Entity nodes. Holds an element list containing
2382 -- entries for each TSS (type support subprogram) associated with the
2383 -- frozen type. The elements of the list are the entities for the
2384 -- subprograms (see package Exp_TSS for further details). Set to No_Elist
2385 -- if there are no type support subprograms for the type or if the freeze
2386 -- node is not for a type.
2388 -- Uneval_Old_Accept
2389 -- Present in N_Pragma nodes. Set True if Opt.Uneval_Old is set to 'A'
2390 -- (accept) at the point where the pragma is encountered (including the
2391 -- case of a pragma generated from an aspect specification). It is this
2392 -- setting that is relevant, rather than the setting at the point where
2393 -- a contract is finally analyzed after the delay till the freeze point.
2395 -- Uneval_Old_Warn
2396 -- Present in N_Pragma nodes. Set True if Opt.Uneval_Old is set to 'W'
2397 -- (warn) at the point where the pragma is encountered (including the
2398 -- case of a pragma generated from an aspect specification). It is this
2399 -- setting that is relevant, rather than the setting at the point where
2400 -- a contract is finally analyzed after the delay till the freeze point.
2402 -- Unreferenced_In_Spec
2403 -- Present in N_With_Clause nodes. Set if the with clause is on the
2404 -- package or subprogram spec where the main unit is the corresponding
2405 -- body, and is not referenced by the spec (it may still be referenced by
2406 -- the body, so this flag is used to generate the proper message (see
2407 -- Sem_Util.Check_Unused_Withs for details)
2409 -- Uninitialized_Variable
2410 -- Present in N_Formal_Private_Type_Definition and in N_Private_
2411 -- Extension_Declarations. Indicates that a variable in a generic unit
2412 -- whose type is a formal private or derived type is read without being
2413 -- initialized. Used to warn if the corresponding actual type is not
2414 -- a fully initialized type.
2416 -- Used_Operations
2417 -- Present in N_Use_Type_Clause nodes. Holds the list of operations that
2418 -- are made potentially use-visible by the clause. Simplifies processing
2419 -- on exit from the scope of the use_type_clause, in particular in the
2420 -- case of Use_All_Type, when those operations several scopes.
2422 -- Was_Attribute_Reference
2423 -- Present in N_Subprogram_Body. Set to True if the original source is an
2424 -- attribute reference which is an actual in a generic instantiation. The
2425 -- instantiation prologue renames these attributes, and expansion later
2426 -- converts them into subprogram bodies.
2428 -- Was_Expression_Function
2429 -- Present in N_Subprogram_Body. True if the original source had an
2430 -- N_Expression_Function, which was converted to the N_Subprogram_Body
2431 -- by Analyze_Expression_Function.
2433 -- Was_Originally_Stub
2434 -- This flag is set in the node for a proper body that replaces stub.
2435 -- During the analysis procedure, stubs in some situations get rewritten
2436 -- by the corresponding bodies, and we set this flag to remember that
2437 -- this happened. Note that it is not good enough to rely on the use of
2438 -- Original_Node here because of the case of nested instantiations where
2439 -- the substituted node can be copied.
2441 --------------------------------------------------
2442 -- Note on Use of End_Label and End_Span Fields --
2443 --------------------------------------------------
2445 -- Several constructs have end lines:
2447 -- Loop Statement end loop [loop_IDENTIFIER];
2448 -- Package Specification end [[PARENT_UNIT_NAME .] IDENTIFIER]
2449 -- Task Definition end [task_IDENTIFIER]
2450 -- Protected Definition end [protected_IDENTIFIER]
2451 -- Protected Body end [protected_IDENTIFIER]
2453 -- Block Statement end [block_IDENTIFIER];
2454 -- Subprogram Body end [DESIGNATOR];
2455 -- Package Body end [[PARENT_UNIT_NAME .] IDENTIFIER];
2456 -- Task Body end [task_IDENTIFIER];
2457 -- Accept Statement end [entry_IDENTIFIER]];
2458 -- Entry Body end [entry_IDENTIFIER];
2460 -- If Statement end if;
2461 -- Case Statement end case;
2463 -- Record Definition end record;
2464 -- Enumeration Definition );
2466 -- The End_Label and End_Span fields are used to mark the locations of
2467 -- these lines, and also keep track of the label in the case where a label
2468 -- is present.
2470 -- For the first group above, the End_Label field of the corresponding node
2471 -- is used to point to the label identifier. In the case where there is no
2472 -- label in the source, the parser supplies a dummy identifier (with
2473 -- Comes_From_Source set to False), and the Sloc of this dummy identifier
2474 -- marks the location of the token following the END token.
2476 -- For the second group, the use of End_Label is similar, but the End_Label
2477 -- is found in the N_Handled_Sequence_Of_Statements node. This is done
2478 -- simply because in some cases there is no room in the parent node.
2480 -- For the third group, there is never any label, and instead of using
2481 -- End_Label, we use the End_Span field which gives the location of the
2482 -- token following END, relative to the starting Sloc of the construct,
2483 -- i.e. add Sloc (Node) + End_Span (Node) to get the Sloc of the IF or CASE
2484 -- following the End_Label.
2486 -- The record definition case is handled specially, we treat it as though
2487 -- it required an optional label which is never present, and so the parser
2488 -- always builds a dummy identifier with Comes From Source set False. The
2489 -- reason we do this, rather than using End_Span in this case, is that we
2490 -- want to generate a cross-ref entry for the end of a record, since it
2491 -- represents a scope for name declaration purposes.
2493 -- The enumeration definition case is handled in an exactly similar manner,
2494 -- building a dummy identifier to get a cross-reference.
2496 -- Note: the reason we store the difference as a Uint, instead of storing
2497 -- the Source_Ptr value directly, is that Source_Ptr values cannot be
2498 -- distinguished from other types of values, and we count on all general
2499 -- use fields being self describing. To make things easier for clients,
2500 -- note that we provide function End_Location, and procedure
2501 -- Set_End_Location to allow access to the logical value (which is the
2502 -- Source_Ptr value for the end token).
2504 ---------------------
2505 -- Syntactic Nodes --
2506 ---------------------
2508 ---------------------
2509 -- 2.3 Identifier --
2510 ---------------------
2512 -- IDENTIFIER ::= IDENTIFIER_LETTER {[UNDERLINE] LETTER_OR_DIGIT}
2513 -- LETTER_OR_DIGIT ::= IDENTIFIER_LETTER | DIGIT
2515 -- An IDENTIFIER shall not be a reserved word
2517 -- In the Ada grammar identifiers are the bottom level tokens which have
2518 -- very few semantics. Actual program identifiers are direct names. If
2519 -- we were being 100% honest with the grammar, then we would have a node
2520 -- called N_Direct_Name which would point to an identifier. However,
2521 -- that's too many extra nodes, so we just use the N_Identifier node
2522 -- directly as a direct name, and it contains the expression fields and
2523 -- Entity field that correspond to its use as a direct name. In those
2524 -- few cases where identifiers appear in contexts where they are not
2525 -- direct names (pragmas, pragma argument associations, attribute
2526 -- references and attribute definition clauses), the Chars field of the
2527 -- node contains the Name_Id for the identifier name.
2529 -- Note: in GNAT, a reserved word can be treated as an identifier in two
2530 -- cases. First, an incorrect use of a reserved word as an identifier is
2531 -- diagnosed and then treated as a normal identifier. Second, an
2532 -- attribute designator of the form of a reserved word (access, delta,
2533 -- digits, range) is treated as an identifier.
2535 -- Note: The set of letters that is permitted in an identifier depends
2536 -- on the character set in use. See package Csets for full details.
2538 -- N_Identifier
2539 -- Sloc points to identifier
2540 -- Chars contains the Name_Id for the identifier
2541 -- Entity
2542 -- Associated_Node
2543 -- Original_Discriminant
2544 -- Is_Elaboration_Checks_OK_Node
2545 -- Is_SPARK_Mode_On_Node
2546 -- Is_Elaboration_Warnings_OK_Node
2547 -- Has_Private_View (set in generic units)
2548 -- Has_Secondary_Private_View (set in generic units)
2549 -- Redundant_Use
2550 -- Atomic_Sync_Required
2551 -- plus fields for expression
2553 --------------------------
2554 -- 2.4 Numeric Literal --
2555 --------------------------
2557 -- NUMERIC_LITERAL ::= DECIMAL_LITERAL | BASED_LITERAL
2559 ----------------------------
2560 -- 2.4.1 Decimal Literal --
2561 ----------------------------
2563 -- DECIMAL_LITERAL ::= NUMERAL [.NUMERAL] [EXPONENT]
2565 -- NUMERAL ::= DIGIT {[UNDERLINE] DIGIT}
2567 -- EXPONENT ::= E [+] NUMERAL | E - NUMERAL
2569 -- Decimal literals appear in the tree as either integer literal nodes
2570 -- or real literal nodes, depending on whether a period is present.
2572 -- Note: literal nodes appear as a result of direct use of literals
2573 -- in the source program, and also as the result of evaluating
2574 -- expressions at compile time. In the latter case, it is possible
2575 -- to construct real literals that have no syntactic representation
2576 -- using the standard literal format. Such literals are listed by
2577 -- Sprint using the notation [numerator / denominator].
2579 -- Note: the value of an integer literal node created by the front end
2580 -- is never outside the range of values of the base type. However, it
2581 -- can be the case that the created value is outside the range of the
2582 -- particular subtype. This happens in the case of integer overflows
2583 -- with checks suppressed.
2585 -- N_Integer_Literal
2586 -- Sloc points to literal
2587 -- Original_Entity If not Empty, holds Named_Number that
2588 -- has been constant-folded into its literal value.
2589 -- Intval contains integer value of literal
2590 -- Print_In_Hex
2591 -- plus fields for expression
2593 -- N_Real_Literal
2594 -- Sloc points to literal
2595 -- Original_Entity If not Empty, holds Named_Number that
2596 -- has been constant-folded into its literal value.
2597 -- Realval contains real value of literal
2598 -- Corresponding_Integer_Value
2599 -- Is_Machine_Number
2600 -- plus fields for expression
2602 --------------------------
2603 -- 2.4.2 Based Literal --
2604 --------------------------
2606 -- BASED_LITERAL ::=
2607 -- BASE # BASED_NUMERAL [.BASED_NUMERAL] # [EXPONENT]
2609 -- BASE ::= NUMERAL
2611 -- BASED_NUMERAL ::=
2612 -- EXTENDED_DIGIT {[UNDERLINE] EXTENDED_DIGIT}
2614 -- EXTENDED_DIGIT ::= DIGIT | A | B | C | D | E | F
2616 -- Based literals appear in the tree as either integer literal nodes
2617 -- or real literal nodes, depending on whether a period is present.
2619 ----------------------------
2620 -- 2.5 Character Literal --
2621 ----------------------------
2623 -- CHARACTER_LITERAL ::= ' GRAPHIC_CHARACTER '
2625 -- N_Character_Literal
2626 -- Sloc points to literal
2627 -- Chars contains the Name_Id for the identifier
2628 -- Char_Literal_Value contains the literal value
2629 -- Entity
2630 -- Associated_Node
2631 -- Has_Private_View (set in generic units)
2632 -- Has_Secondary_Private_View (set in generic units)
2633 -- plus fields for expression
2635 -- Note: the Entity field will be missing (set to Empty) for character
2636 -- literals whose type is Standard.Wide_Character or Standard.Character
2637 -- or a type derived from one of these two. In this case the character
2638 -- literal stands for its own coding. The reason we take this irregular
2639 -- short cut is to avoid the need to build lots of junk defining
2640 -- character literal nodes.
2642 -------------------------
2643 -- 2.6 String Literal --
2644 -------------------------
2646 -- STRING LITERAL ::= "{STRING_ELEMENT}"
2648 -- A STRING_ELEMENT is either a pair of quotation marks ("), or a
2649 -- single GRAPHIC_CHARACTER other than a quotation mark.
2651 -- Is_Folded_In_Parser is True if the parser created this literal by
2652 -- folding a sequence of "&" operators. For example, if the source code
2653 -- says "aaa" & "bbb" & "ccc", and this produces "aaabbbccc", the flag
2654 -- is set. This flag is needed because the parser doesn't know about
2655 -- visibility, so the folded result might be wrong, and semantic
2656 -- analysis needs to check for that.
2658 -- N_String_Literal
2659 -- Sloc points to literal
2660 -- Strval contains Id of string value
2661 -- Has_Wide_Character
2662 -- Has_Wide_Wide_Character
2663 -- Is_Folded_In_Parser
2664 -- plus fields for expression
2666 ---------------------------------------
2667 -- 2.6 Interpolated String Literal --
2668 ---------------------------------------
2670 -- INTERPOLATED_STRING_LITERAL ::=
2671 -- '{' "{INTERPOLATED_STRING_ELEMENT}" {
2672 -- "{INTERPOLATED_STRING_ELEMENT}" } '}'
2674 -- INTERPOLATED_STRING_ELEMENT ::=
2675 -- ESCAPED_CHARACTER | INTERPOLATED_EXPRESSION
2676 -- | non_quotation_mark_non_left_brace_GRAPHIC_CHARACTER
2678 -- ESCAPED_CHARACTER ::= '\GRAPHIC_CHARACTER'
2680 -- INTERPOLATED_EXPRESSION ::= '{' EXPRESSION '}'
2682 -- Most of these syntax rules are omitted as tree nodes to simplify
2683 -- semantic processing. The scanner handles escaped characters as part
2684 -- of processing an interpolated string literal, and the parser stores
2685 -- in the Expressions field of this node a list containing the sequence
2686 -- of string literals and the roots of the interpolated expressions.
2688 -- N_Interpolated_String_Literal
2689 -- Sloc points to literal
2690 -- Expressions
2691 -- plus fields for expression
2693 ------------------
2694 -- 2.7 Comment --
2695 ------------------
2697 -- A COMMENT starts with two adjacent hyphens and extends up to the
2698 -- end of the line. A COMMENT may appear on any line of a program.
2700 -- Comments are skipped by the scanner and do not appear in the tree.
2701 -- It is possible to reconstruct the position of comments with respect
2702 -- to the elements of the tree by using the source position (Sloc)
2703 -- pointers that appear in every tree node.
2705 -----------------
2706 -- 2.8 Pragma --
2707 -----------------
2709 -- PRAGMA ::= pragma IDENTIFIER
2710 -- [(PRAGMA_ARGUMENT_ASSOCIATION {, PRAGMA_ARGUMENT_ASSOCIATION})];
2712 -- Note that a pragma may appear in the tree anywhere a declaration
2713 -- or a statement may appear, as well as in some other situations
2714 -- which are explicitly documented.
2716 -- N_Pragma
2717 -- Sloc points to PRAGMA
2718 -- Next_Pragma
2719 -- Pragma_Argument_Associations (set to No_List if none)
2720 -- Corresponding_Aspect (set to Empty if not present)
2721 -- Pragma_Identifier
2722 -- Next_Rep_Item
2723 -- Is_Generic_Contract_Pragma
2724 -- Is_Checked_Ghost_Pragma
2725 -- Is_Inherited_Pragma
2726 -- Is_Analyzed_Pragma
2727 -- Class_Present set if from Aspect with 'Class
2728 -- Uneval_Old_Accept
2729 -- Is_Ignored_Ghost_Pragma
2730 -- Is_Ignored
2731 -- Is_Checked
2732 -- From_Aspect_Specification
2733 -- Is_Delayed_Aspect
2734 -- Is_Disabled
2735 -- Import_Interface_Present
2736 -- Split_PPC set if corresponding aspect had Split_PPC set
2737 -- Uneval_Old_Warn
2739 -- Note: we should have a section on what pragmas are passed on to
2740 -- the back end to be processed. This section should note that pragma
2741 -- Psect_Object is always converted to Common_Object, but there are
2742 -- undoubtedly many other similar notes required ???
2744 -- Note: utility functions Pragma_Name_Unmapped and Pragma_Name may be
2745 -- applied to pragma nodes to obtain the Chars or its mapped version.
2747 -- Note: if From_Aspect_Specification is set, then Sloc points to the
2748 -- aspect name, as does the Pragma_Identifier. In this case if the
2749 -- pragma has a local name argument (such as pragma Inline), it is
2750 -- resolved to point to the specific entity affected by the pragma.
2752 --------------------------------------
2753 -- 2.8 Pragma Argument Association --
2754 --------------------------------------
2756 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
2757 -- [pragma_argument_IDENTIFIER =>] NAME
2758 -- | [pragma_argument_IDENTIFIER =>] EXPRESSION
2760 -- In Ada 2012, there are two more possibilities:
2762 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
2763 -- [pragma_argument_ASPECT_MARK =>] NAME
2764 -- | [pragma_argument_ASPECT_MARK =>] EXPRESSION
2766 -- where the interesting allowed cases (which do not fit the syntax of
2767 -- the first alternative above) are
2769 -- ASPECT_MARK => Pre'Class |
2770 -- Post'Class |
2771 -- Type_Invariant'Class |
2772 -- Invariant'Class
2774 -- We allow this special usage in all Ada modes, but it would be a
2775 -- pain to allow these aspects to pervade the pragma syntax, and the
2776 -- representation of pragma nodes internally. So what we do is to
2777 -- replace these ASPECT_MARK forms with identifiers whose name is one
2778 -- of the special internal names _Pre, _Post, or _Type_Invariant.
2780 -- We do a similar replacement of these Aspect_Mark forms in the
2781 -- Expression of a pragma argument association for the cases of
2782 -- the first arguments of any Check pragmas and Check_Policy pragmas
2784 -- N_Pragma_Argument_Association
2785 -- Sloc points to first token in association
2786 -- Chars (set to No_Name if no pragma argument identifier)
2787 -- Expression_Copy
2788 -- Expression
2790 ------------------------
2791 -- 2.9 Reserved Word --
2792 ------------------------
2794 -- Reserved words are parsed by the scanner, and returned as the
2795 -- corresponding token types (e.g. PACKAGE is returned as Tok_Package)
2797 ----------------------------
2798 -- 3.1 Basic Declaration --
2799 ----------------------------
2801 -- BASIC_DECLARATION ::=
2802 -- TYPE_DECLARATION | SUBTYPE_DECLARATION
2803 -- | OBJECT_DECLARATION | NUMBER_DECLARATION
2804 -- | SUBPROGRAM_DECLARATION | ABSTRACT_SUBPROGRAM_DECLARATION
2805 -- | PACKAGE_DECLARATION | RENAMING_DECLARATION
2806 -- | EXCEPTION_DECLARATION | GENERIC_DECLARATION
2807 -- | GENERIC_INSTANTIATION
2809 -- Basic declaration also includes IMPLICIT_LABEL_DECLARATION
2810 -- see further description in section on semantic nodes.
2812 -- Also, in the tree that is constructed, a pragma may appear
2813 -- anywhere that a declaration may appear.
2815 ------------------------------
2816 -- 3.1 Defining Identifier --
2817 ------------------------------
2819 -- DEFINING_IDENTIFIER ::= IDENTIFIER
2821 -- A defining identifier is an entity, which has additional fields
2822 -- depending on the setting of the Ekind field. These additional
2823 -- fields are defined (and access subprograms declared) in package
2824 -- Einfo.
2826 -- N_Defining_Identifier
2827 -- Sloc points to identifier
2828 -- Chars contains the Name_Id for the identifier
2829 -- Next_Entity
2830 -- Scope
2831 -- Etype
2833 -----------------------------
2834 -- 3.2.1 Type Declaration --
2835 -----------------------------
2837 -- TYPE_DECLARATION ::=
2838 -- FULL_TYPE_DECLARATION
2839 -- | INCOMPLETE_TYPE_DECLARATION
2840 -- | PRIVATE_TYPE_DECLARATION
2841 -- | PRIVATE_EXTENSION_DECLARATION
2843 ----------------------------------
2844 -- 3.2.1 Full Type Declaration --
2845 ----------------------------------
2847 -- FULL_TYPE_DECLARATION ::=
2848 -- type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
2849 -- is TYPE_DEFINITION
2850 -- [ASPECT_SPECIFICATIONS];
2851 -- | TASK_TYPE_DECLARATION
2852 -- | PROTECTED_TYPE_DECLARATION
2854 -- The full type declaration node is used only for the first case. The
2855 -- second case (concurrent type declaration), is represented directly
2856 -- by a task type declaration or a protected type declaration.
2858 -- N_Full_Type_Declaration
2859 -- Sloc points to TYPE
2860 -- Defining_Identifier
2861 -- Incomplete_View
2862 -- Discriminant_Specifications (set to No_List if none)
2863 -- Type_Definition
2864 -- Discr_Check_Funcs_Built
2866 ----------------------------
2867 -- 3.2.1 Type Definition --
2868 ----------------------------
2870 -- TYPE_DEFINITION ::=
2871 -- ENUMERATION_TYPE_DEFINITION | INTEGER_TYPE_DEFINITION
2872 -- | REAL_TYPE_DEFINITION | ARRAY_TYPE_DEFINITION
2873 -- | RECORD_TYPE_DEFINITION | ACCESS_TYPE_DEFINITION
2874 -- | DERIVED_TYPE_DEFINITION | INTERFACE_TYPE_DEFINITION
2876 --------------------------------
2877 -- 3.2.2 Subtype Declaration --
2878 --------------------------------
2880 -- SUBTYPE_DECLARATION ::=
2881 -- subtype DEFINING_IDENTIFIER is [NULL_EXCLUSION] SUBTYPE_INDICATION
2882 -- [ASPECT_SPECIFICATIONS];
2884 -- The subtype indication field is set to Empty for subtypes
2885 -- declared in package Standard (Positive, Natural).
2887 -- N_Subtype_Declaration
2888 -- Sloc points to SUBTYPE
2889 -- Defining_Identifier
2890 -- Null_Exclusion_Present
2891 -- Subtype_Indication
2892 -- Generic_Parent_Type (for actual of formal private or derived type)
2893 -- Exception_Junk
2895 -------------------------------
2896 -- 3.2.2 Subtype Indication --
2897 -------------------------------
2899 -- SUBTYPE_INDICATION ::= SUBTYPE_MARK [CONSTRAINT]
2901 -- Note: if no constraint is present, the subtype indication appears
2902 -- directly in the tree as a subtype mark. The N_Subtype_Indication
2903 -- node is used only if a constraint is present.
2905 -- Note: [For Ada 2005 (AI-231)]: Because Ada 2005 extends this rule
2906 -- with the null-exclusion part (see AI-231), we had to introduce a new
2907 -- attribute in all the parents of subtype_indication nodes to indicate
2908 -- if the null-exclusion is present.
2910 -- Note: the reason that this node has expression fields is that a
2911 -- subtype indication can appear as an operand of a membership test.
2913 -- N_Subtype_Indication
2914 -- Sloc points to first token of subtype mark
2915 -- Subtype_Mark
2916 -- Constraint
2917 -- Etype
2918 -- Must_Not_Freeze
2920 -- Note: Depending on context, the Etype is either the entity of the
2921 -- Subtype_Mark field, or it is an itype constructed to reify the
2922 -- subtype indication. In particular, such itypes are created for a
2923 -- subtype indication that appears in an array type declaration. This
2924 -- simplifies constraint checking in indexed components.
2926 -- For subtype indications that appear in scalar type and subtype
2927 -- declarations, the Etype is the entity of the subtype mark.
2929 -------------------------
2930 -- 3.2.2 Subtype Mark --
2931 -------------------------
2933 -- SUBTYPE_MARK ::= subtype_NAME
2935 -----------------------
2936 -- 3.2.2 Constraint --
2937 -----------------------
2939 -- CONSTRAINT ::= SCALAR_CONSTRAINT | COMPOSITE_CONSTRAINT
2941 ------------------------------
2942 -- 3.2.2 Scalar Constraint --
2943 ------------------------------
2945 -- SCALAR_CONSTRAINT ::=
2946 -- RANGE_CONSTRAINT | DIGITS_CONSTRAINT | DELTA_CONSTRAINT
2948 ---------------------------------
2949 -- 3.2.2 Composite Constraint --
2950 ---------------------------------
2952 -- COMPOSITE_CONSTRAINT ::=
2953 -- INDEX_CONSTRAINT | DISCRIMINANT_CONSTRAINT
2955 -------------------------------
2956 -- 3.3.1 Object Declaration --
2957 -------------------------------
2959 -- OBJECT_DECLARATION ::=
2960 -- DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2961 -- [NULL_EXCLUSION] SUBTYPE_INDICATION [:= EXPRESSION]
2962 -- [ASPECT_SPECIFICATIONS];
2963 -- | DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2964 -- ACCESS_DEFINITION [:= EXPRESSION]
2965 -- [ASPECT_SPECIFICATIONS];
2966 -- | DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2967 -- ARRAY_TYPE_DEFINITION [:= EXPRESSION]
2968 -- [ASPECT_SPECIFICATIONS];
2969 -- | SINGLE_TASK_DECLARATION
2970 -- | SINGLE_PROTECTED_DECLARATION
2972 -- Note: aliased is not permitted in Ada 83 mode
2974 -- The N_Object_Declaration node is only for the first three cases.
2975 -- Single task declaration is handled by P_Task (9.1)
2976 -- Single protected declaration is handled by P_protected (9.5)
2978 -- Although the syntax allows multiple identifiers in the list, the
2979 -- semantics is as though successive declarations were given with
2980 -- identical type definition and expression components. To simplify
2981 -- semantic processing, the parser represents a multiple declaration
2982 -- case as a sequence of single declarations, using the More_Ids and
2983 -- Prev_Ids flags to preserve the original source form as described
2984 -- in the section on "Handling of Defining Identifier Lists".
2986 -- The flag Has_Init_Expression is set if an initializing expression
2987 -- is present. Normally it is set if and only if Expression contains
2988 -- a non-empty value, but there is an exception to this. When the
2989 -- initializing expression is an aggregate which requires explicit
2990 -- assignments, the Expression field gets set to Empty, but this flag
2991 -- is still set, so we don't forget we had an initializing expression.
2993 -- Note: if a range check is required for the initialization
2994 -- expression then the Do_Range_Check flag is set in the Expression,
2995 -- with the check being done against the type given by the object
2996 -- definition, which is also the Etype of the defining identifier.
2998 -- Note: the contents of the Expression field must be ignored (i.e.
2999 -- treated as though it were Empty) if No_Initialization is set True.
3001 -- Note: the back end places some restrictions on the form of the
3002 -- Expression field. If the object being declared is Atomic, then
3003 -- the Expression may not have the form of an aggregate (since this
3004 -- might cause the back end to generate separate assignments). In this
3005 -- case the front end must generate an extra temporary and initialize
3006 -- this temporary as required (the temporary itself is not atomic).
3008 -- Note: there is no node kind for object definition. Instead, the
3009 -- corresponding field holds a subtype indication, an array type
3010 -- definition, or (Ada 2005, AI-406) an access definition.
3012 -- N_Object_Declaration
3013 -- Sloc points to first identifier
3014 -- Defining_Identifier
3015 -- Aliased_Present
3016 -- Constant_Present set if CONSTANT appears
3017 -- Null_Exclusion_Present
3018 -- Object_Definition subtype indic./array type def./access def.
3019 -- Expression (set to Empty if not present)
3020 -- Handler_List_Entry
3021 -- Corresponding_Generic_Association
3022 -- More_Ids (set to False if no more identifiers in list)
3023 -- Prev_Ids (set to False if no previous identifiers in list)
3024 -- No_Initialization
3025 -- Assignment_OK
3026 -- Exception_Junk
3027 -- Is_Subprogram_Descriptor
3028 -- Has_Init_Expression
3029 -- Suppress_Assignment_Checks
3031 -------------------------------------
3032 -- 3.3.1 Defining Identifier List --
3033 -------------------------------------
3035 -- DEFINING_IDENTIFIER_LIST ::=
3036 -- DEFINING_IDENTIFIER {, DEFINING_IDENTIFIER}
3038 -------------------------------
3039 -- 3.3.2 Number Declaration --
3040 -------------------------------
3042 -- NUMBER_DECLARATION ::=
3043 -- DEFINING_IDENTIFIER_LIST : constant := static_EXPRESSION;
3045 -- Although the syntax allows multiple identifiers in the list, the
3046 -- semantics is as though successive declarations were given with
3047 -- identical expressions. To simplify semantic processing, the parser
3048 -- represents a multiple declaration case as a sequence of single
3049 -- declarations, using the More_Ids and Prev_Ids flags to preserve
3050 -- the original source form as described in the section on "Handling
3051 -- of Defining Identifier Lists".
3053 -- N_Number_Declaration
3054 -- Sloc points to first identifier
3055 -- Defining_Identifier
3056 -- Expression
3057 -- More_Ids (set to False if no more identifiers in list)
3058 -- Prev_Ids (set to False if no previous identifiers in list)
3060 ----------------------------------
3061 -- 3.4 Derived Type Definition --
3062 ----------------------------------
3064 -- DERIVED_TYPE_DEFINITION ::=
3065 -- [abstract] [limited] new [NULL_EXCLUSION] parent_SUBTYPE_INDICATION
3066 -- [[and INTERFACE_LIST] RECORD_EXTENSION_PART]
3068 -- Note: ABSTRACT, LIMITED, and record extension part are not permitted
3069 -- in Ada 83 mode.
3071 -- Note: a record extension part is required if ABSTRACT is present
3073 -- N_Derived_Type_Definition
3074 -- Sloc points to NEW
3075 -- Abstract_Present
3076 -- Null_Exclusion_Present (set to False if not present)
3077 -- Subtype_Indication
3078 -- Record_Extension_Part (set to Empty if not present)
3079 -- Limited_Present
3080 -- Task_Present set in task interfaces
3081 -- Protected_Present set in protected interfaces
3082 -- Synchronized_Present set in interfaces
3083 -- Interface_List (set to No_List if none)
3084 -- Interface_Present set in abstract interfaces
3086 -- Note: Task_Present, Protected_Present, Synchronized_Present,
3087 -- Interface_List, and Interface_Present are used for abstract
3088 -- interfaces (see comments for INTERFACE_TYPE_DEFINITION).
3090 ---------------------------
3091 -- 3.5 Range Constraint --
3092 ---------------------------
3094 -- RANGE_CONSTRAINT ::= range RANGE
3096 -- N_Range_Constraint
3097 -- Sloc points to RANGE
3098 -- Range_Expression
3100 ----------------
3101 -- 3.5 Range --
3102 ----------------
3104 -- RANGE ::=
3105 -- RANGE_ATTRIBUTE_REFERENCE
3106 -- | SIMPLE_EXPRESSION .. SIMPLE_EXPRESSION
3108 -- Note: the case of a range given as a range attribute reference
3109 -- appears directly in the tree as an attribute reference.
3111 -- Note: the field name for a reference to a range is Range_Expression
3112 -- rather than Range, because range is a reserved keyword in Ada.
3114 -- Note: the reason that this node has expression fields is that a
3115 -- range can appear as an operand of a membership test. The Etype
3116 -- field is the type of the range (we do NOT construct an implicit
3117 -- subtype to represent the range exactly).
3119 -- N_Range
3120 -- Sloc points to ..
3121 -- Low_Bound
3122 -- High_Bound
3123 -- Cannot_Be_Superflat
3124 -- Includes_Infinities
3125 -- plus fields for expression
3127 -- Note: if the range appears in a context, such as a subtype
3128 -- declaration, where range checks are required on one or both of
3129 -- the expression fields, then type conversion nodes are inserted
3130 -- to represent the required checks.
3132 ----------------------------------------
3133 -- 3.5.1 Enumeration Type Definition --
3134 ----------------------------------------
3136 -- ENUMERATION_TYPE_DEFINITION ::=
3137 -- (ENUMERATION_LITERAL_SPECIFICATION
3138 -- {, ENUMERATION_LITERAL_SPECIFICATION})
3140 -- Note: the Literals field in the node described below is null for
3141 -- the case of the standard types CHARACTER and WIDE_CHARACTER, for
3142 -- which special processing handles these types as special cases.
3144 -- N_Enumeration_Type_Definition
3145 -- Sloc points to left parenthesis
3146 -- Literals (Empty for CHARACTER or WIDE_CHARACTER)
3147 -- End_Label (set to Empty if internally generated record)
3149 ----------------------------------------------
3150 -- 3.5.1 Enumeration Literal Specification --
3151 ----------------------------------------------
3153 -- ENUMERATION_LITERAL_SPECIFICATION ::=
3154 -- DEFINING_IDENTIFIER | DEFINING_CHARACTER_LITERAL
3156 ---------------------------------------
3157 -- 3.5.1 Defining Character Literal --
3158 ---------------------------------------
3160 -- DEFINING_CHARACTER_LITERAL ::= CHARACTER_LITERAL
3162 -- A defining character literal is an entity, which has additional
3163 -- fields depending on the setting of the Ekind field. These
3164 -- additional fields are defined (and access subprograms declared)
3165 -- in package Einfo.
3167 -- N_Defining_Character_Literal
3168 -- Sloc points to literal
3169 -- Chars contains the Name_Id for the identifier
3170 -- Next_Entity
3171 -- Scope
3172 -- Etype
3174 ------------------------------------
3175 -- 3.5.4 Integer Type Definition --
3176 ------------------------------------
3178 -- Note: there is an error in this rule in the latest version of the
3179 -- grammar, so we have retained the old rule pending clarification.
3181 -- INTEGER_TYPE_DEFINITION ::=
3182 -- SIGNED_INTEGER_TYPE_DEFINITION
3183 -- | MODULAR_TYPE_DEFINITION
3185 -------------------------------------------
3186 -- 3.5.4 Signed Integer Type Definition --
3187 -------------------------------------------
3189 -- SIGNED_INTEGER_TYPE_DEFINITION ::=
3190 -- range static_SIMPLE_EXPRESSION .. static_SIMPLE_EXPRESSION
3192 -- Note: the Low_Bound and High_Bound fields are set to Empty
3193 -- for integer types defined in package Standard.
3195 -- N_Signed_Integer_Type_Definition
3196 -- Sloc points to RANGE
3197 -- Low_Bound
3198 -- High_Bound
3200 ------------------------------------
3201 -- 3.5.4 Modular Type Definition --
3202 ------------------------------------
3204 -- MODULAR_TYPE_DEFINITION ::= mod static_EXPRESSION
3206 -- N_Modular_Type_Definition
3207 -- Sloc points to MOD
3208 -- Expression
3210 ---------------------------------
3211 -- 3.5.6 Real Type Definition --
3212 ---------------------------------
3214 -- REAL_TYPE_DEFINITION ::=
3215 -- FLOATING_POINT_DEFINITION | FIXED_POINT_DEFINITION
3217 --------------------------------------
3218 -- 3.5.7 Floating Point Definition --
3219 --------------------------------------
3221 -- FLOATING_POINT_DEFINITION ::=
3222 -- digits static_SIMPLE_EXPRESSION [REAL_RANGE_SPECIFICATION]
3224 -- Note: The Digits_Expression and Real_Range_Specifications fields
3225 -- are set to Empty for floating-point types declared in Standard.
3227 -- N_Floating_Point_Definition
3228 -- Sloc points to DIGITS
3229 -- Digits_Expression
3230 -- Real_Range_Specification (set to Empty if not present)
3232 -------------------------------------
3233 -- 3.5.7 Real Range Specification --
3234 -------------------------------------
3236 -- REAL_RANGE_SPECIFICATION ::=
3237 -- range static_SIMPLE_EXPRESSION .. static_SIMPLE_EXPRESSION
3239 -- N_Real_Range_Specification
3240 -- Sloc points to RANGE
3241 -- Low_Bound
3242 -- High_Bound
3244 -----------------------------------
3245 -- 3.5.9 Fixed Point Definition --
3246 -----------------------------------
3248 -- FIXED_POINT_DEFINITION ::=
3249 -- ORDINARY_FIXED_POINT_DEFINITION | DECIMAL_FIXED_POINT_DEFINITION
3251 --------------------------------------------
3252 -- 3.5.9 Ordinary Fixed Point Definition --
3253 --------------------------------------------
3255 -- ORDINARY_FIXED_POINT_DEFINITION ::=
3256 -- delta static_EXPRESSION REAL_RANGE_SPECIFICATION
3258 -- Note: In Ada 83, the EXPRESSION must be a SIMPLE_EXPRESSION
3260 -- N_Ordinary_Fixed_Point_Definition
3261 -- Sloc points to DELTA
3262 -- Delta_Expression
3263 -- Real_Range_Specification
3265 -------------------------------------------
3266 -- 3.5.9 Decimal Fixed Point Definition --
3267 -------------------------------------------
3269 -- DECIMAL_FIXED_POINT_DEFINITION ::=
3270 -- delta static_EXPRESSION
3271 -- digits static_EXPRESSION [REAL_RANGE_SPECIFICATION]
3273 -- Note: decimal types are not permitted in Ada 83 mode
3275 -- N_Decimal_Fixed_Point_Definition
3276 -- Sloc points to DELTA
3277 -- Delta_Expression
3278 -- Digits_Expression
3279 -- Real_Range_Specification (set to Empty if not present)
3281 ------------------------------
3282 -- 3.5.9 Digits Constraint --
3283 ------------------------------
3285 -- DIGITS_CONSTRAINT ::=
3286 -- digits static_EXPRESSION [RANGE_CONSTRAINT]
3288 -- Note: in Ada 83, the EXPRESSION must be a SIMPLE_EXPRESSION
3289 -- Note: in Ada 95, reduced accuracy subtypes are obsolescent
3291 -- N_Digits_Constraint
3292 -- Sloc points to DIGITS
3293 -- Digits_Expression
3294 -- Range_Constraint (set to Empty if not present)
3296 --------------------------------
3297 -- 3.6 Array Type Definition --
3298 --------------------------------
3300 -- ARRAY_TYPE_DEFINITION ::=
3301 -- UNCONSTRAINED_ARRAY_DEFINITION | CONSTRAINED_ARRAY_DEFINITION
3303 -----------------------------------------
3304 -- 3.6 Unconstrained Array Definition --
3305 -----------------------------------------
3307 -- UNCONSTRAINED_ARRAY_DEFINITION ::=
3308 -- array (INDEX_SUBTYPE_DEFINITION {, INDEX_SUBTYPE_DEFINITION}) of
3309 -- COMPONENT_DEFINITION
3311 -- Note: dimensionality of array is indicated by number of entries in
3312 -- the Subtype_Marks list, which has one entry for each dimension.
3314 -- N_Unconstrained_Array_Definition
3315 -- Sloc points to ARRAY
3316 -- Subtype_Marks
3317 -- Component_Definition
3319 -----------------------------------
3320 -- 3.6 Index Subtype Definition --
3321 -----------------------------------
3323 -- INDEX_SUBTYPE_DEFINITION ::= SUBTYPE_MARK range <>
3325 -- There is no explicit node in the tree for an index subtype
3326 -- definition since the N_Unconstrained_Array_Definition node
3327 -- incorporates the type marks which appear in this context.
3329 ---------------------------------------
3330 -- 3.6 Constrained Array Definition --
3331 ---------------------------------------
3333 -- CONSTRAINED_ARRAY_DEFINITION ::=
3334 -- array (DISCRETE_SUBTYPE_DEFINITION
3335 -- {, DISCRETE_SUBTYPE_DEFINITION})
3336 -- of COMPONENT_DEFINITION
3338 -- Note: dimensionality of array is indicated by number of entries
3339 -- in the Discrete_Subtype_Definitions list, which has one entry
3340 -- for each dimension.
3342 -- N_Constrained_Array_Definition
3343 -- Sloc points to ARRAY
3344 -- Discrete_Subtype_Definitions
3345 -- Component_Definition
3347 -- Note: although the language allows the full syntax for discrete
3348 -- subtype definitions (i.e. a discrete subtype indication or a range),
3349 -- in the generated tree, we always rewrite these as N_Range nodes.
3351 --------------------------------------
3352 -- 3.6 Discrete Subtype Definition --
3353 --------------------------------------
3355 -- DISCRETE_SUBTYPE_DEFINITION ::=
3356 -- discrete_SUBTYPE_INDICATION | RANGE
3358 -------------------------------
3359 -- 3.6 Component Definition --
3360 -------------------------------
3362 -- COMPONENT_DEFINITION ::=
3363 -- [aliased] [NULL_EXCLUSION] SUBTYPE_INDICATION | ACCESS_DEFINITION
3365 -- Note: although the syntax does not permit a component definition to
3366 -- be an anonymous array (and the parser will diagnose such an attempt
3367 -- with an appropriate message), it is possible for anonymous arrays
3368 -- to appear as component definitions. The semantics and back end handle
3369 -- this case properly, and the expander in fact generates such cases.
3370 -- Access_Definition is an optional field that gives support to
3371 -- Ada 2005 (AI-230). The parser generates nodes that have either the
3372 -- Subtype_Indication field or else the Access_Definition field.
3374 -- N_Component_Definition
3375 -- Sloc points to ALIASED, ACCESS, or to first token of subtype mark
3376 -- Aliased_Present
3377 -- Null_Exclusion_Present
3378 -- Subtype_Indication (set to Empty if not present)
3379 -- Access_Definition (set to Empty if not present)
3381 -----------------------------
3382 -- 3.6.1 Index Constraint --
3383 -----------------------------
3385 -- INDEX_CONSTRAINT ::= (DISCRETE_RANGE {, DISCRETE_RANGE})
3387 -- It is not in general possible to distinguish between discriminant
3388 -- constraints and index constraints at parse time, since a simple
3389 -- name could be either the subtype mark of a discrete range, or an
3390 -- expression in a discriminant association with no name. Either
3391 -- entry appears simply as the name, and the semantic parse must
3392 -- distinguish between the two cases. Thus we use a common tree
3393 -- node format for both of these constraint types.
3395 -- See Discriminant_Constraint for format of node
3397 ---------------------------
3398 -- 3.6.1 Discrete Range --
3399 ---------------------------
3401 -- DISCRETE_RANGE ::= discrete_SUBTYPE_INDICATION | RANGE
3403 ----------------------------
3404 -- 3.7 Discriminant Part --
3405 ----------------------------
3407 -- DISCRIMINANT_PART ::=
3408 -- UNKNOWN_DISCRIMINANT_PART | KNOWN_DISCRIMINANT_PART
3410 ------------------------------------
3411 -- 3.7 Unknown Discriminant Part --
3412 ------------------------------------
3414 -- UNKNOWN_DISCRIMINANT_PART ::= (<>)
3416 -- Note: unknown discriminant parts are not permitted in Ada 83 mode
3418 -- There is no explicit node in the tree for an unknown discriminant
3419 -- part. Instead the Unknown_Discriminants_Present flag is set in the
3420 -- parent node.
3422 ----------------------------------
3423 -- 3.7 Known Discriminant Part --
3424 ----------------------------------
3426 -- KNOWN_DISCRIMINANT_PART ::=
3427 -- (DISCRIMINANT_SPECIFICATION {; DISCRIMINANT_SPECIFICATION})
3429 -------------------------------------
3430 -- 3.7 Discriminant Specification --
3431 -------------------------------------
3433 -- DISCRIMINANT_SPECIFICATION ::=
3434 -- DEFINING_IDENTIFIER_LIST : [NULL_EXCLUSION] SUBTYPE_MARK
3435 -- [:= DEFAULT_EXPRESSION]
3436 -- | DEFINING_IDENTIFIER_LIST : ACCESS_DEFINITION
3437 -- [:= DEFAULT_EXPRESSION]
3439 -- Although the syntax allows multiple identifiers in the list, the
3440 -- semantics is as though successive specifications were given with
3441 -- identical type definition and expression components. To simplify
3442 -- semantic processing, the parser represents a multiple declaration
3443 -- case as a sequence of single specifications, using the More_Ids and
3444 -- Prev_Ids flags to preserve the original source form as described
3445 -- in the section on "Handling of Defining Identifier Lists".
3447 -- N_Discriminant_Specification
3448 -- Sloc points to first identifier
3449 -- Defining_Identifier
3450 -- Null_Exclusion_Present
3451 -- Discriminant_Type subtype mark or access parameter definition
3452 -- Expression (set to Empty if no default expression)
3453 -- More_Ids (set to False if no more identifiers in list)
3454 -- Prev_Ids (set to False if no previous identifiers in list)
3456 -----------------------------
3457 -- 3.7 Default Expression --
3458 -----------------------------
3460 -- DEFAULT_EXPRESSION ::= EXPRESSION
3462 ------------------------------------
3463 -- 3.7.1 Discriminant Constraint --
3464 ------------------------------------
3466 -- DISCRIMINANT_CONSTRAINT ::=
3467 -- (DISCRIMINANT_ASSOCIATION {, DISCRIMINANT_ASSOCIATION})
3469 -- It is not in general possible to distinguish between discriminant
3470 -- constraints and index constraints at parse time, since a simple
3471 -- name could be either the subtype mark of a discrete range, or an
3472 -- expression in a discriminant association with no name. Either
3473 -- entry appears simply as the name, and the semantic parse must
3474 -- distinguish between the two cases. Thus we use a common tree
3475 -- node format for both of these constraint types.
3477 -- N_Index_Or_Discriminant_Constraint
3478 -- Sloc points to left paren
3479 -- Constraints points to list of discrete ranges or
3480 -- discriminant associations
3482 -------------------------------------
3483 -- 3.7.1 Discriminant Association --
3484 -------------------------------------
3486 -- DISCRIMINANT_ASSOCIATION ::=
3487 -- [discriminant_SELECTOR_NAME
3488 -- {| discriminant_SELECTOR_NAME} =>] EXPRESSION
3490 -- Note: a discriminant association that has no selector name list
3491 -- appears directly as an expression in the tree.
3493 -- N_Discriminant_Association
3494 -- Sloc points to first token of discriminant association
3495 -- Selector_Names (always non-empty, since if no selector
3496 -- names are present, this node is not used, see comment above)
3497 -- Expression
3499 ---------------------------------
3500 -- 3.8 Record Type Definition --
3501 ---------------------------------
3503 -- RECORD_TYPE_DEFINITION ::=
3504 -- [[abstract] tagged] [limited] RECORD_DEFINITION
3506 -- Note: ABSTRACT, TAGGED, LIMITED are not permitted in Ada 83 mode
3508 -- There is no explicit node in the tree for a record type definition.
3509 -- Instead the flags for Tagged_Present and Limited_Present appear in
3510 -- the N_Record_Definition node for a record definition appearing in
3511 -- the context of a record type definition.
3513 ----------------------------
3514 -- 3.8 Record Definition --
3515 ----------------------------
3517 -- RECORD_DEFINITION ::=
3518 -- record
3519 -- COMPONENT_LIST
3520 -- end record
3521 -- | null record
3523 -- Note: the Abstract_Present, Tagged_Present, and Limited_Present
3524 -- flags appear only for a record definition appearing in a record
3525 -- type definition.
3527 -- Note: the NULL RECORD case is not permitted in Ada 83
3529 -- N_Record_Definition
3530 -- Sloc points to RECORD or NULL
3531 -- End_Label (set to Empty if internally generated record)
3532 -- Abstract_Present
3533 -- Tagged_Present
3534 -- Limited_Present
3535 -- Component_List empty in null record case
3536 -- Null_Present set in null record case
3537 -- Task_Present set in task interfaces
3538 -- Protected_Present set in protected interfaces
3539 -- Synchronized_Present set in interfaces
3540 -- Interface_Present set in abstract interfaces
3541 -- Interface_List (set to No_List if none)
3543 -- Note: Task_Present, Protected_Present, Synchronized _Present,
3544 -- Interface_List and Interface_Present are used for abstract
3545 -- interfaces (see comments for INTERFACE_TYPE_DEFINITION).
3547 -------------------------
3548 -- 3.8 Component List --
3549 -------------------------
3551 -- COMPONENT_LIST ::=
3552 -- COMPONENT_ITEM {COMPONENT_ITEM}
3553 -- | {COMPONENT_ITEM} VARIANT_PART
3554 -- | null;
3556 -- N_Component_List
3557 -- Sloc points to first token of component list
3558 -- Component_Items
3559 -- Variant_Part (set to Empty if no variant part)
3560 -- Null_Present
3562 -------------------------
3563 -- 3.8 Component Item --
3564 -------------------------
3566 -- COMPONENT_ITEM ::= COMPONENT_DECLARATION | REPRESENTATION_CLAUSE
3568 -- Note: A component item can also be a pragma, and in the tree
3569 -- that is obtained after semantic processing, a component item
3570 -- can be an N_Null node resulting from a non-recognized pragma.
3572 --------------------------------
3573 -- 3.8 Component Declaration --
3574 --------------------------------
3576 -- COMPONENT_DECLARATION ::=
3577 -- DEFINING_IDENTIFIER_LIST : COMPONENT_DEFINITION
3578 -- [:= DEFAULT_EXPRESSION]
3579 -- [ASPECT_SPECIFICATIONS];
3581 -- Note: although the syntax does not permit a component definition to
3582 -- be an anonymous array (and the parser will diagnose such an attempt
3583 -- with an appropriate message), it is possible for anonymous arrays
3584 -- to appear as component definitions. The semantics and back end handle
3585 -- this case properly, and the expander in fact generates such cases.
3587 -- Although the syntax allows multiple identifiers in the list, the
3588 -- semantics is as though successive declarations were given with the
3589 -- same component definition and expression components. To simplify
3590 -- semantic processing, the parser represents a multiple declaration
3591 -- case as a sequence of single declarations, using the More_Ids and
3592 -- Prev_Ids flags to preserve the original source form as described
3593 -- in the section on "Handling of Defining Identifier Lists".
3595 -- N_Component_Declaration
3596 -- Sloc points to first identifier
3597 -- Defining_Identifier
3598 -- Component_Definition
3599 -- Expression (set to Empty if no default expression)
3600 -- More_Ids (set to False if no more identifiers in list)
3601 -- Prev_Ids (set to False if no previous identifiers in list)
3603 -------------------------
3604 -- 3.8.1 Variant Part --
3605 -------------------------
3607 -- VARIANT_PART ::=
3608 -- case discriminant_DIRECT_NAME is
3609 -- VARIANT {VARIANT}
3610 -- end case;
3612 -- Note: the variants list can contain pragmas as well as variants.
3613 -- In a properly formed program there is at least one variant.
3615 -- N_Variant_Part
3616 -- Sloc points to CASE
3617 -- Name
3618 -- Variants
3620 --------------------
3621 -- 3.8.1 Variant --
3622 --------------------
3624 -- VARIANT ::=
3625 -- when DISCRETE_CHOICE_LIST =>
3626 -- COMPONENT_LIST
3628 -- N_Variant
3629 -- Sloc points to WHEN
3630 -- Discrete_Choices
3631 -- Component_List
3632 -- Enclosing_Variant
3633 -- Present_Expr
3634 -- Dcheck_Function
3635 -- Has_SP_Choice
3637 -- Note: in the list of Discrete_Choices, the tree passed to the back
3638 -- end does not have choice entries corresponding to names of statically
3639 -- predicated subtypes. Such entries are always expanded out to the list
3640 -- of equivalent values or ranges.
3642 ---------------------------------
3643 -- 3.8.1 Discrete Choice List --
3644 ---------------------------------
3646 -- DISCRETE_CHOICE_LIST ::= DISCRETE_CHOICE {| DISCRETE_CHOICE}
3648 ----------------------------
3649 -- 3.8.1 Discrete Choice --
3650 ----------------------------
3652 -- DISCRETE_CHOICE ::= EXPRESSION | DISCRETE_RANGE | others
3654 -- Note: in Ada 83 mode, the expression must be a simple expression
3656 -- The only choice that appears explicitly is the OTHERS choice, as
3657 -- defined here. Other cases of discrete choice (expression and
3658 -- discrete range) appear directly. This production is also used
3659 -- for the OTHERS possibility of an exception choice.
3661 -- Note: in accordance with the syntax, the parser does not check that
3662 -- OTHERS appears at the end on its own in a choice list context. This
3663 -- is a semantic check.
3665 -- N_Others_Choice
3666 -- Sloc points to OTHERS
3667 -- Others_Discrete_Choices
3668 -- All_Others
3670 ----------------------------------
3671 -- 3.9.1 Record Extension Part --
3672 ----------------------------------
3674 -- RECORD_EXTENSION_PART ::= with RECORD_DEFINITION
3676 -- Note: record extension parts are not permitted in Ada 83 mode
3678 --------------------------------------
3679 -- 3.9.4 Interface Type Definition --
3680 --------------------------------------
3682 -- INTERFACE_TYPE_DEFINITION ::=
3683 -- [limited | task | protected | synchronized]
3684 -- interface [interface_list]
3686 -- Note: Interfaces are implemented with N_Record_Definition and
3687 -- N_Derived_Type_Definition nodes because most of the support
3688 -- for the analysis of abstract types has been reused to
3689 -- analyze abstract interfaces.
3691 ----------------------------------
3692 -- 3.10 Access Type Definition --
3693 ----------------------------------
3695 -- ACCESS_TYPE_DEFINITION ::=
3696 -- ACCESS_TO_OBJECT_DEFINITION
3697 -- | ACCESS_TO_SUBPROGRAM_DEFINITION
3699 --------------------------
3700 -- 3.10 Null Exclusion --
3701 --------------------------
3703 -- NULL_EXCLUSION ::= not null
3705 ---------------------------------------
3706 -- 3.10 Access To Object Definition --
3707 ---------------------------------------
3709 -- ACCESS_TO_OBJECT_DEFINITION ::=
3710 -- [NULL_EXCLUSION] access [GENERAL_ACCESS_MODIFIER]
3711 -- SUBTYPE_INDICATION
3713 -- N_Access_To_Object_Definition
3714 -- Sloc points to ACCESS
3715 -- All_Present
3716 -- Null_Exclusion_Present
3717 -- Null_Excluding_Subtype
3718 -- Subtype_Indication
3719 -- Constant_Present
3721 -----------------------------------
3722 -- 3.10 General Access Modifier --
3723 -----------------------------------
3725 -- GENERAL_ACCESS_MODIFIER ::= all | constant
3727 -- Note: general access modifiers are not permitted in Ada 83 mode
3729 -- There is no explicit node in the tree for general access modifier.
3730 -- Instead the All_Present or Constant_Present flags are set in the
3731 -- parent node.
3733 -------------------------------------------
3734 -- 3.10 Access To Subprogram Definition --
3735 -------------------------------------------
3737 -- ACCESS_TO_SUBPROGRAM_DEFINITION
3738 -- [NULL_EXCLUSION] access [protected] procedure PARAMETER_PROFILE
3739 -- | [NULL_EXCLUSION] access [protected] function
3740 -- PARAMETER_AND_RESULT_PROFILE
3742 -- Note: access to subprograms are not permitted in Ada 83 mode
3744 -- N_Access_Function_Definition
3745 -- Sloc points to ACCESS
3746 -- Null_Exclusion_Present
3747 -- Null_Exclusion_In_Return_Present
3748 -- Protected_Present
3749 -- Parameter_Specifications (set to No_List if no formal part)
3750 -- Result_Definition result subtype (subtype mark or access def)
3752 -- N_Access_Procedure_Definition
3753 -- Sloc points to ACCESS
3754 -- Null_Exclusion_Present
3755 -- Protected_Present
3756 -- Parameter_Specifications (set to No_List if no formal part)
3758 -----------------------------
3759 -- 3.10 Access Definition --
3760 -----------------------------
3762 -- ACCESS_DEFINITION ::=
3763 -- [NULL_EXCLUSION] access [GENERAL_ACCESS_MODIFIER] SUBTYPE_MARK
3764 -- | ACCESS_TO_SUBPROGRAM_DEFINITION
3766 -- Note: access to subprograms are an Ada 2005 (AI-254) extension
3768 -- N_Access_Definition
3769 -- Sloc points to ACCESS
3770 -- Null_Exclusion_Present
3771 -- All_Present
3772 -- Constant_Present
3773 -- Subtype_Mark
3774 -- Access_To_Subprogram_Definition (set to Empty if not present)
3776 -----------------------------------------
3777 -- 3.10.1 Incomplete Type Declaration --
3778 -----------------------------------------
3780 -- INCOMPLETE_TYPE_DECLARATION ::=
3781 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART] [IS TAGGED];
3783 -- N_Incomplete_Type_Declaration
3784 -- Sloc points to TYPE
3785 -- Defining_Identifier
3786 -- Discriminant_Specifications (set to No_List if no
3787 -- discriminant part, or if the discriminant part is an
3788 -- unknown discriminant part)
3789 -- Premature_Use used for improved diagnostics.
3790 -- Unknown_Discriminants_Present set if (<>) discriminant
3791 -- Tagged_Present
3793 ----------------------------
3794 -- 3.11 Declarative Part --
3795 ----------------------------
3797 -- DECLARATIVE_PART ::= {DECLARATIVE_ITEM}
3799 -- Note: although the parser enforces the syntactic requirement that
3800 -- a declarative part can contain only declarations, the semantic
3801 -- processing may add statements to the list of actions in a
3802 -- declarative part, so the code generator should be prepared
3803 -- to accept a statement in this position.
3805 ----------------------------
3806 -- 3.11 Declarative Item --
3807 ----------------------------
3809 -- DECLARATIVE_ITEM ::= BASIC_DECLARATIVE_ITEM | BODY
3811 ----------------------------------
3812 -- 3.11 Basic Declarative Item --
3813 ----------------------------------
3815 -- BASIC_DECLARATIVE_ITEM ::=
3816 -- BASIC_DECLARATION | REPRESENTATION_CLAUSE | USE_CLAUSE
3818 ----------------
3819 -- 3.11 Body --
3820 ----------------
3822 -- BODY ::= PROPER_BODY | BODY_STUB
3824 -----------------------
3825 -- 3.11 Proper Body --
3826 -----------------------
3828 -- PROPER_BODY ::=
3829 -- SUBPROGRAM_BODY | PACKAGE_BODY | TASK_BODY | PROTECTED_BODY
3831 ---------------
3832 -- 4.1 Name --
3833 ---------------
3835 -- NAME ::=
3836 -- DIRECT_NAME | EXPLICIT_DEREFERENCE
3837 -- | INDEXED_COMPONENT | SLICE
3838 -- | SELECTED_COMPONENT | ATTRIBUTE_REFERENCE
3839 -- | TYPE_CONVERSION | FUNCTION_CALL
3840 -- | CHARACTER_LITERAL
3842 ----------------------
3843 -- 4.1 Direct Name --
3844 ----------------------
3846 -- DIRECT_NAME ::= IDENTIFIER | OPERATOR_SYMBOL
3848 -----------------
3849 -- 4.1 Prefix --
3850 -----------------
3852 -- PREFIX ::= NAME | IMPLICIT_DEREFERENCE
3854 -------------------------------
3855 -- 4.1 Explicit Dereference --
3856 -------------------------------
3858 -- EXPLICIT_DEREFERENCE ::= NAME . all
3860 -- N_Explicit_Dereference
3861 -- Sloc points to ALL
3862 -- Prefix
3863 -- Actual_Designated_Subtype
3864 -- Has_Dereference_Action
3865 -- Atomic_Sync_Required
3866 -- plus fields for expression
3868 -------------------------------
3869 -- 4.1 Implicit Dereference --
3870 -------------------------------
3872 -- IMPLICIT_DEREFERENCE ::= NAME
3874 ------------------------------
3875 -- 4.1.1 Indexed Component --
3876 ------------------------------
3878 -- INDEXED_COMPONENT ::= PREFIX (EXPRESSION {, EXPRESSION})
3880 -- Note: the parser may generate this node in some situations where it
3881 -- should be a function call. The semantic pass must correct this
3882 -- misidentification (which is inevitable at the parser level).
3884 -- N_Indexed_Component
3885 -- Sloc contains a copy of the Sloc value of the Prefix
3886 -- Prefix
3887 -- Expressions
3888 -- Generalized_Indexing
3889 -- Atomic_Sync_Required
3890 -- plus fields for expression
3892 -- Note: if any of the subscripts requires a range check, then the
3893 -- Do_Range_Check flag is set on the corresponding expression, with
3894 -- the index type being determined from the type of the Prefix, which
3895 -- references the array being indexed.
3897 -- Note: in a fully analyzed and expanded indexed component node, and
3898 -- hence in any such node that gigi sees, if the prefix is an access
3899 -- type, then an explicit dereference operation has been inserted.
3901 ------------------
3902 -- 4.1.2 Slice --
3903 ------------------
3905 -- SLICE ::= PREFIX (DISCRETE_RANGE)
3907 -- Note: an implicit subtype is created to describe the resulting
3908 -- type, so that the bounds of this type are the bounds of the slice.
3910 -- N_Slice
3911 -- Sloc points to first token of prefix
3912 -- Prefix
3913 -- Discrete_Range
3914 -- plus fields for expression
3916 -------------------------------
3917 -- 4.1.3 Selected Component --
3918 -------------------------------
3920 -- SELECTED_COMPONENT ::= PREFIX . SELECTOR_NAME
3922 -- Note: selected components that are semantically expanded names get
3923 -- changed during semantic processing into the separate N_Expanded_Name
3924 -- node. See description of this node in the section on semantic nodes.
3926 -- N_Selected_Component
3927 -- Sloc points to the period
3928 -- Prefix
3929 -- Selector_Name
3930 -- Associated_Node
3931 -- Do_Discriminant_Check
3932 -- Is_In_Discriminant_Check
3933 -- Atomic_Sync_Required
3934 -- Is_Prefixed_Call
3935 -- plus fields for expression
3937 --------------------------
3938 -- 4.1.3 Selector Name --
3939 --------------------------
3941 -- SELECTOR_NAME ::= IDENTIFIER | CHARACTER_LITERAL | OPERATOR_SYMBOL
3943 --------------------------------
3944 -- 4.1.4 Attribute Reference --
3945 --------------------------------
3947 -- ATTRIBUTE_REFERENCE ::= PREFIX ' ATTRIBUTE_DESIGNATOR
3949 -- Note: the syntax is quite ambiguous at this point. Consider:
3951 -- A'Length (X) X is part of the attribute designator
3952 -- A'Pos (X) X is an explicit actual parameter of function A'Pos
3953 -- A'Class (X) X is the expression of a type conversion
3955 -- It would be possible for the parser to distinguish these cases
3956 -- by looking at the attribute identifier. However, that would mean
3957 -- more work in introducing new implementation defined attributes,
3958 -- and also it would mean that special processing for attributes
3959 -- would be scattered around, instead of being centralized in the
3960 -- semantic routine that handles an N_Attribute_Reference node.
3961 -- Consequently, the parser in all the above cases stores the
3962 -- expression (X in these examples) as a single element list in
3963 -- in the Expressions field of the N_Attribute_Reference node.
3965 -- Similarly, for attributes like Max which take two arguments,
3966 -- we store the two arguments as a two element list in the
3967 -- Expressions field. Of course it is clear at parse time that
3968 -- this case is really a function call with an attribute as the
3969 -- prefix, but it turns out to be convenient to handle the two
3970 -- argument case in a similar manner to the one argument case,
3971 -- and indeed in general the parser will accept any number of
3972 -- expressions in this position and store them as a list in the
3973 -- attribute reference node. This allows for future addition of
3974 -- attributes that take more than two arguments.
3976 -- Note: named associates are not permitted in function calls where
3977 -- the function is an attribute (see RM 6.4(3)) so it is legitimate
3978 -- to skip the normal subprogram argument processing.
3980 -- Note: for the attributes whose designators are technically keywords,
3981 -- i.e. digits, access, delta, range, the Attribute_Name field contains
3982 -- the corresponding name, even though no identifier is involved.
3984 -- Note: the generated code may contain stream attributes applied to
3985 -- limited types for which no stream routines exist officially. In such
3986 -- case, the result is to use the stream attribute for the underlying
3987 -- full type, or in the case of a protected type, the components
3988 -- (including any discriminants) are merely streamed in order.
3990 -- See Exp_Attr for a complete description of which attributes are
3991 -- passed onto Gigi, and which are handled entirely by the front end.
3993 -- Gigi restriction: For the Pos attribute, the prefix cannot be
3994 -- a non-standard enumeration type or a nonzero/zero semantics
3995 -- boolean type, so the value is simply the stored representation.
3997 -- Gigi requirement: For the Mechanism_Code attribute, if the prefix
3998 -- references a subprogram that is a renaming, then the front end must
3999 -- rewrite the attribute to refer directly to the renamed entity.
4001 -- Note: syntactically the prefix of an attribute reference must be a
4002 -- name, and this (somewhat artificial) requirement is enforced by the
4003 -- parser. However, for many attributes, such as 'Valid, it is quite
4004 -- reasonable to apply the attribute to any value, and hence to any
4005 -- expression. Internally in the tree, the prefix is an expression which
4006 -- does not have to be a name, and this is handled fine by the semantic
4007 -- analysis and expansion, and back ends. This arises for the case of
4008 -- attribute references built by the expander (e.g. 'Valid for the case
4009 -- of an implicit validity check).
4011 -- Note: In generated code, the Address and Unrestricted_Access
4012 -- attributes can be applied to any expression, and the meaning is
4013 -- to create an object containing the value (the object is in the
4014 -- current stack frame), and pass the address of this value. If the
4015 -- Must_Be_Byte_Aligned flag is set, then the object whose address
4016 -- is taken must be on a byte (storage unit) boundary, and if it is
4017 -- not (or may not be), then the generated code must create a copy
4018 -- that is byte aligned, and pass the address of this copy.
4020 -- N_Attribute_Reference
4021 -- Sloc points to apostrophe
4022 -- Prefix (general expression, see note above)
4023 -- Attribute_Name identifier name from attribute designator
4024 -- Expressions (set to No_List if no associated expressions)
4025 -- Entity used if the attribute yields a type
4026 -- Associated_Node
4027 -- Is_Elaboration_Checks_OK_Node
4028 -- Is_SPARK_Mode_On_Node
4029 -- Is_Elaboration_Warnings_OK_Node
4030 -- Header_Size_Added
4031 -- Redundant_Use
4032 -- Must_Be_Byte_Aligned
4033 -- plus fields for expression
4035 -- Note: in Modify_Tree_For_C mode, Max and Min attributes are expanded
4036 -- into equivalent if expressions, properly taking care of side effects.
4038 ---------------------------------
4039 -- 4.1.4 Attribute Designator --
4040 ---------------------------------
4042 -- ATTRIBUTE_DESIGNATOR ::=
4043 -- IDENTIFIER [(static_EXPRESSION)]
4044 -- | access | delta | digits
4046 -- There is no explicit node in the tree for an attribute designator.
4047 -- Instead the Attribute_Name and Expressions fields of the parent
4048 -- node (N_Attribute_Reference node) hold the information.
4050 -- Note: if ACCESS, DELTA, or DIGITS appears in an attribute
4051 -- designator, then they are treated as identifiers internally
4052 -- rather than the keywords of the same name.
4054 --------------------------------------
4055 -- 4.1.4 Range Attribute Reference --
4056 --------------------------------------
4058 -- RANGE_ATTRIBUTE_REFERENCE ::= PREFIX ' RANGE_ATTRIBUTE_DESIGNATOR
4060 -- A range attribute reference is represented in the tree using the
4061 -- normal N_Attribute_Reference node.
4063 ---------------------------------------
4064 -- 4.1.4 Range Attribute Designator --
4065 ---------------------------------------
4067 -- RANGE_ATTRIBUTE_DESIGNATOR ::= Range [(static_EXPRESSION)]
4069 -- A range attribute designator is represented in the tree using the
4070 -- normal N_Attribute_Reference node.
4072 --------------------
4073 -- 4.3 Aggregate --
4074 --------------------
4076 -- AGGREGATE ::=
4077 -- RECORD_AGGREGATE | EXTENSION_AGGREGATE | ARRAY_AGGREGATE
4079 -----------------------------
4080 -- 4.3.1 Record Aggregate --
4081 -----------------------------
4083 -- RECORD_AGGREGATE ::= (RECORD_COMPONENT_ASSOCIATION_LIST)
4085 -- N_Aggregate
4086 -- Sloc points to left parenthesis
4087 -- Expressions (set to No_List if none or null record case)
4088 -- Component_Associations (set to No_List if none)
4089 -- Null_Record_Present
4090 -- Aggregate_Bounds
4091 -- Associated_Node
4092 -- Compile_Time_Known_Aggregate
4093 -- Expansion_Delayed
4094 -- Has_Self_Reference
4095 -- Is_Enum_Array_Aggregate
4096 -- Is_Homogeneous_Aggregate
4097 -- Is_Parenthesis_Aggregate
4098 -- plus fields for expression
4100 -- Note: this structure is used for both record and array aggregates
4101 -- since the two cases are not separable by the parser. The parser
4102 -- makes no attempt to enforce consistency here, so it is up to the
4103 -- semantic phase to make sure that the aggregate is consistent (i.e.
4104 -- that it is not a "half-and-half" case that mixes record and array
4105 -- syntax). In particular, for a record aggregate, the expressions
4106 -- field will be set if there are positional associations.
4108 -- Note: N_Aggregate is not used for all aggregates; in particular,
4109 -- there is a separate node kind for extension aggregates.
4111 -- Note: gigi/gcc can handle array aggregates correctly providing that
4112 -- they are entirely positional, and the array subtype involved has a
4113 -- known at compile time length and is not bit packed, or a convention
4114 -- Fortran array with more than one dimension. If these conditions
4115 -- are not met, then the front end must translate the aggregate into
4116 -- an appropriate set of assignments into a temporary.
4118 -- Note: for the record aggregate case, gigi/gcc can handle most cases
4119 -- of record aggregates, including those for packed, and rep-claused
4120 -- records, and also variant records, providing that there are no
4121 -- variable length fields whose size is not known at compile time,
4122 -- and providing that the aggregate is presented in fully named form.
4124 -- The other situation in which array aggregates and record aggregates
4125 -- cannot be passed to the back end is if assignment to one or more
4126 -- components itself needs expansion, e.g. in the case of an assignment
4127 -- of an object of a controlled type. In such cases, the front end
4128 -- must expand the aggregate to a series of assignments, and apply
4129 -- the required expansion to the individual assignment statements.
4131 ----------------------------------------------
4132 -- 4.3.1 Record Component Association List --
4133 ----------------------------------------------
4135 -- RECORD_COMPONENT_ASSOCIATION_LIST ::=
4136 -- RECORD_COMPONENT_ASSOCIATION {, RECORD_COMPONENT_ASSOCIATION}
4137 -- | null record
4139 -- There is no explicit node in the tree for a record component
4140 -- association list. Instead the Null_Record_Present flag is set in
4141 -- the parent node for the NULL RECORD case.
4143 ------------------------------------------------------
4144 -- 4.3.1 Record Component Association (also 4.3.3) --
4145 ------------------------------------------------------
4147 -- RECORD_COMPONENT_ASSOCIATION ::=
4148 -- [COMPONENT_CHOICE_LIST =>] EXPRESSION
4150 -- N_Component_Association
4151 -- Sloc points to first selector name
4152 -- Choices
4153 -- Expression (empty if Box_Present)
4154 -- Loop_Actions
4155 -- Box_Present
4156 -- Inherited_Discriminant
4157 -- Binding_Chars
4159 -- Note: this structure is used for both record component associations
4160 -- and array component associations, since the two cases aren't always
4161 -- separable by the parser. The choices list may represent either a
4162 -- list of selector names in the record aggregate case, or a list of
4163 -- discrete choices in the array aggregate case or an N_Others_Choice
4164 -- node (which appears as a singleton list). Box_Present gives support
4165 -- to Ada 2005 (AI-287). Binding_Chars is only set if GNAT extensions
4166 -- are enabled and the given component association occurs within a
4167 -- choice_expression; in this case, it is the Name_Id, if any, specified
4168 -- via either of two syntactic forms: "Foo => Bar is Abc" or
4169 -- "Foo => <Abc>".
4171 ----------------------------------
4172 -- 4.3.1 Component Choice List --
4173 ----------------------------------
4175 -- COMPONENT_CHOICE_LIST ::=
4176 -- component_SELECTOR_NAME {| component_SELECTOR_NAME}
4177 -- | others
4179 -- The entries of a component choice list appear in the Choices list of
4180 -- the associated N_Component_Association, as either selector names, or
4181 -- as an N_Others_Choice node.
4183 --------------------------------
4184 -- 4.3.2 Extension Aggregate --
4185 --------------------------------
4187 -- EXTENSION_AGGREGATE ::=
4188 -- (ANCESTOR_PART with RECORD_COMPONENT_ASSOCIATION_LIST)
4190 -- Note: extension aggregates are not permitted in Ada 83 mode
4192 -- N_Extension_Aggregate
4193 -- Sloc points to left parenthesis
4194 -- Ancestor_Part
4195 -- Associated_Node
4196 -- Expressions (set to No_List if none or null record case)
4197 -- Component_Associations (set to No_List if none)
4198 -- Null_Record_Present
4199 -- Expansion_Delayed
4200 -- Has_Self_Reference
4201 -- plus fields for expression
4203 --------------------------
4204 -- 4.3.2 Ancestor Part --
4205 --------------------------
4207 -- ANCESTOR_PART ::= EXPRESSION | SUBTYPE_MARK
4209 ----------------------------
4210 -- 4.3.3 Array Aggregate --
4211 ----------------------------
4213 -- ARRAY_AGGREGATE ::=
4214 -- POSITIONAL_ARRAY_AGGREGATE | NAMED_ARRAY_AGGREGATE
4216 ---------------------------------------
4217 -- 4.3.3 Positional Array Aggregate --
4218 ---------------------------------------
4220 -- POSITIONAL_ARRAY_AGGREGATE ::=
4221 -- (EXPRESSION, EXPRESSION {, EXPRESSION})
4222 -- | (EXPRESSION {, EXPRESSION}, others => EXPRESSION)
4224 -- See Record_Aggregate (4.3.1) for node structure
4226 ----------------------------------
4227 -- 4.3.3 Named Array Aggregate --
4228 ----------------------------------
4230 -- NAMED_ARRAY_AGGREGATE ::=
4231 -- (ARRAY_COMPONENT_ASSOCIATION {, ARRAY_COMPONENT_ASSOCIATION})
4233 -- See Record_Aggregate (4.3.1) for node structure
4235 ----------------------------------------
4236 -- 4.3.3 Array Component Association --
4237 ----------------------------------------
4239 -- ARRAY_COMPONENT_ASSOCIATION ::=
4240 -- DISCRETE_CHOICE_LIST => EXPRESSION
4241 -- | ITERATED_COMPONENT_ASSOCIATION
4243 -- See Record_Component_Association (4.3.1) for node structure
4244 -- The iterated_component_association is introduced into the
4245 -- Corrigendum of Ada_2012 by AI12-061.
4247 ------------------------------------------
4248 -- 4.3.3 Iterated component Association --
4249 ------------------------------------------
4251 -- ITERATED_COMPONENT_ASSOCIATION ::=
4252 -- for DEFINING_IDENTIFIER in DISCRETE_CHOICE_LIST => EXPRESSION
4253 -- for ITERATOR_SPECIFICATION => EXPRESSION
4255 -- At most one of (Defining_Identifier, Iterator_Specification)
4256 -- is present at a time, in which case the other one is empty.
4258 -- N_Iterated_Component_Association
4259 -- Sloc points to FOR
4260 -- Defining_Identifier
4261 -- Iterator_Specification
4262 -- Expression
4263 -- Discrete_Choices
4264 -- Loop_Actions
4265 -- Box_Present
4267 -- Note that Box_Present is always False, but it is intentionally added
4268 -- for completeness.
4270 ----------------------------
4271 -- 4.3.4 Delta Aggregate --
4272 ----------------------------
4274 -- N_Delta_Aggregate
4275 -- Sloc points to left parenthesis
4276 -- Expression
4277 -- Component_Associations
4278 -- Etype
4280 ---------------------------------
4281 -- 3.4.5 Container_Aggregates --
4282 ---------------------------------
4284 -- ITERATED_ELEMENT_ASSOCIATION ::=
4285 -- for LOOP_PARAMETER_SPECIFICATION[ use KEY_EXPRESSION] => EXPRESSION
4286 -- | for ITERATOR_SPECIFICATION[ use KEY_EXPRESSION] => EXPRESSION
4288 -- N_Iterated_Element_Association
4289 -- Key_Expression
4290 -- Iterator_Specification
4291 -- Expression
4292 -- Loop_Parameter_Specification
4293 -- Loop_Actions
4294 -- Box_Present
4296 -- Exactly one of Iterator_Specification or Loop_Parameter_
4297 -- specification is present. If the Key_Expression is absent,
4298 -- the construct is parsed as an Iterated_Component_Association,
4299 -- and legality checks are performed during semantic analysis.
4301 -- Both iterated associations are Ada 2022 features that are
4302 -- expanded during aggregate construction, and do not appear in
4303 -- expanded code.
4305 --------------------------------------------------
4306 -- 4.4 Expression/Relation/Term/Factor/Primary --
4307 --------------------------------------------------
4309 -- EXPRESSION ::=
4310 -- RELATION {LOGICAL_OPERATOR RELATION}
4312 -- CHOICE_EXPRESSION ::=
4313 -- CHOICE_RELATION {LOGICAL_OPERATOR CHOICE_RELATION}
4315 -- CHOICE_RELATION ::=
4316 -- SIMPLE_EXPRESSION [RELATIONAL_OPERATOR SIMPLE_EXPRESSION]
4318 -- RELATION ::=
4319 -- SIMPLE_EXPRESSION [not] in MEMBERSHIP_CHOICE_LIST
4320 -- | RAISE_EXPRESSION
4322 -- MEMBERSHIP_CHOICE_LIST ::=
4323 -- MEMBERSHIP_CHOICE {'|' MEMBERSHIP CHOICE}
4325 -- MEMBERSHIP_CHOICE ::=
4326 -- CHOICE_EXPRESSION | RANGE | SUBTYPE_MARK
4328 -- LOGICAL_OPERATOR ::= and | and then | or | or else | xor
4330 -- SIMPLE_EXPRESSION ::=
4331 -- [UNARY_ADDING_OPERATOR] TERM {BINARY_ADDING_OPERATOR TERM}
4333 -- TERM ::= FACTOR {MULTIPLYING_OPERATOR FACTOR}
4335 -- FACTOR ::= PRIMARY [** PRIMARY] | abs PRIMARY | not PRIMARY
4337 -- No nodes are generated for any of these constructs. Instead, the
4338 -- node for the operator appears directly. When we refer to an
4339 -- expression in this description, we mean any of the possible
4340 -- constituent components of an expression (e.g. identifier is
4341 -- an example of an expression).
4343 -- Note: the above syntax is that Ada 2012 syntax which restricts
4344 -- choice relations to simple expressions to avoid ambiguities in
4345 -- some contexts with set membership notation. It has been decided
4346 -- that in retrospect, the Ada 95 change allowing general expressions
4347 -- in this context was a mistake, so we have reverted to the above
4348 -- syntax in Ada 95 and Ada 2005 modes (the restriction to simple
4349 -- expressions was there in Ada 83 from the start).
4351 ------------------
4352 -- 4.4 Primary --
4353 ------------------
4355 -- PRIMARY ::=
4356 -- NUMERIC_LITERAL | null
4357 -- | STRING_LITERAL | AGGREGATE
4358 -- | NAME | QUALIFIED_EXPRESSION
4359 -- | ALLOCATOR | (EXPRESSION)
4361 -- Usually there is no explicit node in the tree for primary. Instead
4362 -- the constituent (e.g. AGGREGATE) appears directly. There are two
4363 -- exceptions. First, there is an explicit node for a null primary.
4365 -- N_Null
4366 -- Sloc points to NULL
4367 -- plus fields for expression
4369 -- Second, the case of (EXPRESSION) is handled specially. Ada requires
4370 -- that the parser keep track of which subexpressions are enclosed
4371 -- in parentheses, and how many levels of parentheses are used. This
4372 -- information is required for optimization purposes, and also for
4373 -- some semantic checks (e.g. (((1))) in a procedure spec does not
4374 -- conform with ((((1)))) in the body).
4376 -- The parentheses are recorded by keeping a Paren_Count field in every
4377 -- subexpression node (it is actually present in all nodes, but only
4378 -- used in subexpression nodes). This count records the number of
4379 -- levels of parentheses. If the number of levels in the source exceeds
4380 -- the maximum accommodated by this count, then the count is simply left
4381 -- at the maximum value. This means that there are some pathological
4382 -- cases of failure to detect conformance failures (e.g. an expression
4383 -- with 500 levels of parens will conform with one with 501 levels),
4384 -- but we do not need to lose sleep over this.
4386 -- Historical note: in versions of GNAT prior to 1.75, there was a node
4387 -- type N_Parenthesized_Expression used to accurately record unlimited
4388 -- numbers of levels of parentheses. However, it turned out to be a
4389 -- real nuisance to have to take into account the possible presence of
4390 -- this node during semantic analysis, since basically parentheses have
4391 -- zero relevance to semantic analysis.
4393 -- Note: the level of parentheses always present in things like
4394 -- aggregates does not count, only the parentheses in the primary
4395 -- (EXPRESSION) affect the setting of the Paren_Count field.
4397 -- 2nd Note: the contents of the Expression field must be ignored (i.e.
4398 -- treated as though it were Empty) if No_Initialization is set True.
4400 --------------------------------------
4401 -- 4.5 Short-Circuit Control Forms --
4402 --------------------------------------
4404 -- EXPRESSION ::=
4405 -- RELATION {and then RELATION} | RELATION {or else RELATION}
4407 -- Gigi restriction: For both these control forms, the operand and
4408 -- result types are always Standard.Boolean. The expander inserts the
4409 -- required conversion operations where needed to ensure this is the
4410 -- case.
4412 -- N_And_Then
4413 -- Sloc points to AND of AND THEN
4414 -- Left_Opnd
4415 -- Right_Opnd
4416 -- Actions
4417 -- plus fields for expression
4419 -- N_Or_Else
4420 -- Sloc points to OR of OR ELSE
4421 -- Left_Opnd
4422 -- Right_Opnd
4423 -- Actions
4424 -- plus fields for expression
4426 -- Note: The Actions field is used to hold actions associated with
4427 -- the right hand operand. These have to be treated specially since
4428 -- they are not unconditionally executed. See Insert_Actions for a
4429 -- more detailed description of how these actions are handled.
4431 ---------------------------
4432 -- 4.5 Membership Tests --
4433 ---------------------------
4435 -- RELATION ::=
4436 -- SIMPLE_EXPRESSION [not] in MEMBERSHIP_CHOICE_LIST
4438 -- MEMBERSHIP_CHOICE_LIST ::=
4439 -- MEMBERSHIP_CHOICE {'|' MEMBERSHIP CHOICE}
4441 -- MEMBERSHIP_CHOICE ::=
4442 -- CHOICE_EXPRESSION | RANGE | SUBTYPE_MARK
4444 -- Note: although the grammar above allows only a range or a subtype
4445 -- mark, the parser in fact will accept any simple expression in place
4446 -- of a subtype mark. This means that the semantic analyzer must be able
4447 -- to deal with, and diagnose a simple expression other than a name for
4448 -- the right operand. This simplifies error recovery in the parser.
4450 -- The Alternatives field below is present only if there is more than
4451 -- one Membership_Choice present (which is legitimate only in Ada 2012
4452 -- mode) in which case Right_Opnd is Empty, and Alternatives contains
4453 -- the list of choices. In the tree passed to the back end, Alternatives
4454 -- is always No_List, and Right_Opnd is set (i.e. the expansion circuit
4455 -- expands out the complex set membership case using simple membership
4456 -- and equality operations).
4458 -- Should we rename Alternatives here to Membership_Choices ???
4460 -- N_In
4461 -- Sloc points to IN
4462 -- Left_Opnd
4463 -- Right_Opnd
4464 -- Alternatives (set to No_List if only one set alternative)
4465 -- No_Minimize_Eliminate
4466 -- plus fields for expression
4468 -- N_Not_In
4469 -- Sloc points to NOT of NOT IN
4470 -- Left_Opnd
4471 -- Right_Opnd
4472 -- Alternatives (set to No_List if only one set alternative)
4473 -- No_Minimize_Eliminate
4474 -- plus fields for expression
4476 --------------------
4477 -- 4.5 Operators --
4478 --------------------
4480 -- LOGICAL_OPERATOR ::= and | or | xor
4482 -- RELATIONAL_OPERATOR ::= = | /= | < | <= | > | >=
4484 -- BINARY_ADDING_OPERATOR ::= + | - | &
4486 -- UNARY_ADDING_OPERATOR ::= + | -
4488 -- MULTIPLYING_OPERATOR ::= * | / | mod | rem
4490 -- HIGHEST_PRECEDENCE_OPERATOR ::= ** | abs | not
4492 -- Gigi restriction: Gigi will never be given * / mod rem nodes with
4493 -- fixed-point operands. All handling of smalls for multiplication and
4494 -- division is handled by the front end (mod and rem result only from
4495 -- expansion). Gigi thus never needs to worry about small values (for
4496 -- other operators operating on fixed-point, e.g. addition, the small
4497 -- value does not have any semantic effect anyway, these are always
4498 -- integer operations).
4500 -- Gigi restriction: For all operators taking Boolean operands, the
4501 -- type is always Standard.Boolean. The expander inserts the required
4502 -- conversion operations where needed to ensure this is the case.
4504 -- N_Op_And
4505 -- Sloc points to AND
4506 -- Do_Length_Check
4507 -- plus fields for binary operator
4508 -- plus fields for expression
4510 -- N_Op_Or
4511 -- Sloc points to OR
4512 -- Do_Length_Check
4513 -- plus fields for binary operator
4514 -- plus fields for expression
4516 -- N_Op_Xor
4517 -- Sloc points to XOR
4518 -- Do_Length_Check
4519 -- plus fields for binary operator
4520 -- plus fields for expression
4522 -- N_Op_Eq
4523 -- Sloc points to =
4524 -- Compare_Type
4525 -- plus fields for binary operator
4526 -- plus fields for expression
4528 -- N_Op_Ne
4529 -- Sloc points to /=
4530 -- Compare_Type
4531 -- plus fields for binary operator
4532 -- plus fields for expression
4534 -- N_Op_Lt
4535 -- Sloc points to <
4536 -- Compare_Type
4537 -- plus fields for binary operator
4538 -- plus fields for expression
4540 -- N_Op_Le
4541 -- Sloc points to <=
4542 -- Compare_Type
4543 -- plus fields for binary operator
4544 -- plus fields for expression
4546 -- N_Op_Gt
4547 -- Sloc points to >
4548 -- Compare_Type
4549 -- plus fields for binary operator
4550 -- plus fields for expression
4552 -- N_Op_Ge
4553 -- Sloc points to >=
4554 -- Compare_Type
4555 -- plus fields for binary operator
4556 -- plus fields for expression
4558 -- N_Op_Add
4559 -- Sloc points to + (binary)
4560 -- plus fields for binary operator
4561 -- plus fields for expression
4563 -- N_Op_Subtract
4564 -- Sloc points to - (binary)
4565 -- plus fields for binary operator
4566 -- plus fields for expression
4568 -- N_Op_Concat
4569 -- Sloc points to &
4570 -- Is_Component_Left_Opnd
4571 -- Is_Component_Right_Opnd
4572 -- plus fields for binary operator
4573 -- plus fields for expression
4575 -- N_Op_Multiply
4576 -- Sloc points to *
4577 -- Rounded_Result
4578 -- plus fields for binary operator
4579 -- plus fields for expression
4581 -- N_Op_Divide
4582 -- Sloc points to /
4583 -- Do_Division_Check
4584 -- Rounded_Result
4585 -- plus fields for binary operator
4586 -- plus fields for expression
4588 -- N_Op_Mod
4589 -- Sloc points to MOD
4590 -- Do_Division_Check
4591 -- plus fields for binary operator
4592 -- plus fields for expression
4594 -- N_Op_Rem
4595 -- Sloc points to REM
4596 -- Do_Division_Check
4597 -- plus fields for binary operator
4598 -- plus fields for expression
4600 -- N_Op_Expon
4601 -- Sloc points to **
4602 -- Is_Power_Of_2_For_Shift
4603 -- plus fields for binary operator
4604 -- plus fields for expression
4606 -- N_Op_Plus
4607 -- Sloc points to + (unary)
4608 -- plus fields for unary operator
4609 -- plus fields for expression
4611 -- N_Op_Minus
4612 -- Sloc points to - (unary)
4613 -- plus fields for unary operator
4614 -- plus fields for expression
4616 -- N_Op_Abs
4617 -- Sloc points to ABS
4618 -- plus fields for unary operator
4619 -- plus fields for expression
4621 -- N_Op_Not
4622 -- Sloc points to NOT
4623 -- plus fields for unary operator
4624 -- plus fields for expression
4626 -- See also shift operators in section B.2
4628 -- Note on fixed-point operations passed to Gigi: For adding operators,
4629 -- the semantics is to treat these simply as integer operations, with
4630 -- the small values being ignored (the bounds are already stored in
4631 -- units of small, so that constraint checking works as usual). For the
4632 -- case of multiply/divide/rem/mod operations, Gigi will never see them.
4634 -- Note on equality/inequality tests for records. In the expanded tree,
4635 -- record comparisons are always expanded to be a series of component
4636 -- comparisons, so the back end will never see an equality or inequality
4637 -- operation with operands of a record type.
4639 -- Note on overflow handling: When the overflow checking mode is set to
4640 -- MINIMIZED or ELIMINATED, nodes for signed arithmetic operations may
4641 -- be modified to use a larger type for the operands and result. In
4642 -- the case where the computed range exceeds that of Long_Long_Integer,
4643 -- and we are running in ELIMINATED mode, the operator node will be
4644 -- changed to be a call to the appropriate routine in System.Bignums.
4646 -- Note: In Modify_Tree_For_C mode, we do not generate an N_Op_Mod node
4647 -- for signed integer types (since there is no equivalent operator in
4648 -- C). Instead we rewrite such an operation in terms of REM (which is
4649 -- % in C) and other C-available operators.
4651 ------------------------------------
4652 -- 4.5.7 Conditional Expressions --
4653 ------------------------------------
4655 -- CONDITIONAL_EXPRESSION ::= IF_EXPRESSION | CASE_EXPRESSION
4657 --------------------------
4658 -- 4.5.7 If Expression --
4659 --------------------------
4661 -- IF_EXPRESSION ::=
4662 -- if CONDITION then DEPENDENT_EXPRESSION
4663 -- {elsif CONDITION then DEPENDENT_EXPRESSION}
4664 -- [else DEPENDENT_EXPRESSION]
4666 -- DEPENDENT_EXPRESSION ::= EXPRESSION
4668 -- Note: if we have (IF x1 THEN x2 ELSIF x3 THEN x4 ELSE x5) then it
4669 -- is represented as (IF x1 THEN x2 ELSE (IF x3 THEN x4 ELSE x5)) and
4670 -- the Is_Elsif flag is set on the inner if expression.
4672 -- N_If_Expression
4673 -- Sloc points to IF or ELSIF keyword
4674 -- Expressions
4675 -- Then_Actions
4676 -- Else_Actions
4677 -- Is_Elsif (set if comes from ELSIF)
4678 -- Do_Overflow_Check
4679 -- plus fields for expression
4681 -- Expressions here is a three-element list, whose first element is the
4682 -- condition, the second element is the dependent expression after THEN
4683 -- and the third element is the dependent expression after the ELSE
4684 -- (explicitly set to True if missing).
4686 -- Note: the Then_Actions and Else_Actions fields are always set to
4687 -- No_List in the tree passed to the back end. These are used only
4688 -- for temporary processing purposes in the expander. Even though they
4689 -- are semantic fields, their parent pointers are set because analysis
4690 -- of actions nodes in those lists may generate additional actions that
4691 -- need to know their insertion point (for example for the creation of
4692 -- transient scopes).
4694 -- Note: in the tree passed to the back end, if the result type is
4695 -- an unconstrained array, the if expression can only appears in the
4696 -- initializing expression of an object declaration (this avoids the
4697 -- back end having to create a variable length temporary on the fly).
4699 ----------------------------
4700 -- 4.5.7 Case Expression --
4701 ----------------------------
4703 -- CASE_EXPRESSION ::=
4704 -- case SELECTING_EXPRESSION is
4705 -- CASE_EXPRESSION_ALTERNATIVE
4706 -- {,CASE_EXPRESSION_ALTERNATIVE}
4708 -- Note that the Alternatives cannot include pragmas (this contrasts
4709 -- with the situation of case statements where pragmas are allowed).
4711 -- N_Case_Expression
4712 -- Sloc points to CASE
4713 -- Expression (the selecting expression)
4714 -- Alternatives (the case expression alternatives)
4715 -- Etype
4716 -- Do_Overflow_Check
4718 ----------------------------------------
4719 -- 4.5.7 Case Expression Alternative --
4720 ----------------------------------------
4722 -- CASE_EXPRESSION_ALTERNATIVE ::=
4723 -- when DISCRETE_CHOICE_LIST =>
4724 -- DEPENDENT_EXPRESSION
4726 -- N_Case_Expression_Alternative
4727 -- Sloc points to WHEN
4728 -- Actions
4729 -- Discrete_Choices
4730 -- Expression
4731 -- Has_SP_Choice
4733 -- Note: The Actions field temporarily holds any actions associated with
4734 -- evaluation of the Expression. During expansion of the case expression
4735 -- these actions are wrapped into an N_Expression_With_Actions node
4736 -- replacing the original expression.
4738 -- Note: this node never appears in the tree passed to the back end,
4739 -- since the expander converts case expressions into case statements.
4741 ---------------------------------
4742 -- 4.5.8 Quantified Expression --
4743 ---------------------------------
4745 -- QUANTIFIED_EXPRESSION ::=
4746 -- for QUANTIFIER LOOP_PARAMETER_SPECIFICATION => PREDICATE
4747 -- | for QUANTIFIER ITERATOR_SPECIFICATION => PREDICATE
4749 -- QUANTIFIER ::= all | some
4751 -- At most one of (Iterator_Specification, Loop_Parameter_Specification)
4752 -- is present at a time, in which case the other one is empty.
4754 -- N_Quantified_Expression
4755 -- Sloc points to FOR
4756 -- Iterator_Specification
4757 -- Loop_Parameter_Specification
4758 -- Condition
4759 -- All_Present
4761 --------------------------
4762 -- 4.6 Type Conversion --
4763 --------------------------
4765 -- TYPE_CONVERSION ::=
4766 -- SUBTYPE_MARK (EXPRESSION) | SUBTYPE_MARK (NAME)
4768 -- In the (NAME) case, the name is stored as the expression
4770 -- Note: the parser never generates a type conversion node, since it
4771 -- looks like an indexed component which is generated by preference.
4772 -- The semantic pass must correct this misidentification.
4774 -- Gigi handles conversions that involve no change in the root type,
4775 -- and also all conversions from integer to floating-point types.
4776 -- Conversions from floating-point to integer are only handled in
4777 -- the case where Float_Truncate flag set. Other conversions from
4778 -- floating-point to integer (involving rounding) and all conversions
4779 -- involving fixed-point types are handled by the expander, unless the
4780 -- Conversion_OK flag is set.
4782 -- Sprint syntax if Float_Truncate set: X^(Y)
4783 -- Sprint syntax if Conversion_OK set X?(Y)
4784 -- Sprint syntax if both flags set X?^(Y)
4786 -- Note: If either the operand or result type is fixed-point, Gigi will
4787 -- only see a type conversion node with Conversion_OK set. The front end
4788 -- takes care of all handling of small's for fixed-point conversions.
4790 -- N_Type_Conversion
4791 -- Sloc points to first token of subtype mark
4792 -- Subtype_Mark
4793 -- Expression
4794 -- Do_Discriminant_Check
4795 -- Do_Length_Check
4796 -- Float_Truncate
4797 -- Conversion_OK
4798 -- Do_Overflow_Check
4799 -- Rounded_Result
4800 -- plus fields for expression
4802 -- Note: if a range check is required, then the Do_Range_Check flag
4803 -- is set in the Expression with the check being done against the
4804 -- target type range (after the base type conversion, if any).
4806 -------------------------------
4807 -- 4.7 Qualified Expression --
4808 -------------------------------
4810 -- QUALIFIED_EXPRESSION ::=
4811 -- SUBTYPE_MARK ' (EXPRESSION) | SUBTYPE_MARK ' AGGREGATE
4813 -- Note: the parentheses in the (EXPRESSION) case are deemed to enclose
4814 -- the expression, so the Expression field of this node always points
4815 -- to a parenthesized expression in this case (i.e. Paren_Count will
4816 -- always be non-zero for the referenced expression if it is not an
4817 -- aggregate).
4819 -- N_Qualified_Expression
4820 -- Sloc points to apostrophe
4821 -- Subtype_Mark
4822 -- Expression expression or aggregate
4823 -- Is_Qualified_Universal_Literal
4824 -- plus fields for expression
4826 --------------------
4827 -- 4.8 Allocator --
4828 --------------------
4830 -- ALLOCATOR ::=
4831 -- new [SUBPOOL_SPECIFICATION] SUBTYPE_INDICATION
4832 -- | new [SUBPOOL_SPECIFICATION] QUALIFIED_EXPRESSION
4834 -- SUBPOOL_SPECIFICATION ::= (subpool_handle_NAME)
4836 -- Sprint syntax (when storage pool present)
4837 -- new xxx (storage_pool = pool)
4838 -- or
4839 -- new (subpool) xxx (storage_pool = pool)
4841 -- N_Allocator
4842 -- Sloc points to NEW
4843 -- Expression subtype indication or qualified expression
4844 -- Subpool_Handle_Name (set to Empty if not present)
4845 -- Storage_Pool
4846 -- Procedure_To_Call
4847 -- For_Special_Return_Object
4848 -- Null_Exclusion_Present
4849 -- No_Initialization
4850 -- Is_Static_Coextension
4851 -- Do_Storage_Check
4852 -- Is_Dynamic_Coextension
4853 -- plus fields for expression
4855 -- Note: like all nodes, the N_Allocator has the Comes_From_Source flag.
4856 -- This flag has a special function in conjunction with the restriction
4857 -- No_Implicit_Heap_Allocations, which will be triggered if this flag
4858 -- is not set. This means that if a source allocator is replaced with
4859 -- a constructed allocator, the Comes_From_Source flag should be copied
4860 -- to the newly created allocator.
4862 ---------------------------------
4863 -- 5.1 Sequence Of Statements --
4864 ---------------------------------
4866 -- SEQUENCE_OF_STATEMENTS ::= STATEMENT {STATEMENT}
4868 -- Note: Although the parser will not accept a declaration as a
4869 -- statement, the semantic analyzer may insert declarations (e.g.
4870 -- declarations of implicit types needed for execution of other
4871 -- statements) into a sequence of statements, so the code generator
4872 -- should be prepared to accept a declaration where a statement is
4873 -- expected. Note also that pragmas can appear as statements.
4875 --------------------
4876 -- 5.1 Statement --
4877 --------------------
4879 -- STATEMENT ::=
4880 -- {LABEL} SIMPLE_STATEMENT | {LABEL} COMPOUND_STATEMENT
4882 -- There is no explicit node in the tree for a statement. Instead, the
4883 -- individual statement appears directly. Labels are treated as a
4884 -- kind of statement, i.e. they are linked into a statement list at
4885 -- the point they appear, so the labeled statement appears following
4886 -- the label or labels in the statement list.
4888 ---------------------------
4889 -- 5.1 Simple Statement --
4890 ---------------------------
4892 -- SIMPLE_STATEMENT ::= NULL_STATEMENT
4893 -- | ASSIGNMENT_STATEMENT | EXIT_STATEMENT
4894 -- | GOTO_STATEMENT | PROCEDURE_CALL_STATEMENT
4895 -- | SIMPLE_RETURN_STATEMENT | ENTRY_CALL_STATEMENT
4896 -- | REQUEUE_STATEMENT | DELAY_STATEMENT
4897 -- | ABORT_STATEMENT | RAISE_STATEMENT
4898 -- | CODE_STATEMENT
4900 -----------------------------
4901 -- 5.1 Compound Statement --
4902 -----------------------------
4904 -- COMPOUND_STATEMENT ::=
4905 -- IF_STATEMENT | CASE_STATEMENT
4906 -- | LOOP_STATEMENT | BLOCK_STATEMENT
4907 -- | EXTENDED_RETURN_STATEMENT
4908 -- | ACCEPT_STATEMENT | SELECT_STATEMENT
4910 -------------------------
4911 -- 5.1 Null Statement --
4912 -------------------------
4914 -- NULL_STATEMENT ::= null;
4916 -- N_Null_Statement
4917 -- Sloc points to NULL
4918 -- Next_Rep_Item
4920 ----------------
4921 -- 5.1 Label --
4922 ----------------
4924 -- LABEL ::= <<label_STATEMENT_IDENTIFIER>>
4926 -- Note that the occurrence of a label is not a defining identifier,
4927 -- but rather a referencing occurrence. The defining occurrence is
4928 -- in the implicit label declaration which occurs in the innermost
4929 -- enclosing block.
4931 -- N_Label
4932 -- Sloc points to <<
4933 -- Identifier direct name of statement identifier
4934 -- Exception_Junk
4936 -- Note: Before Ada 2012, a label is always followed by a statement,
4937 -- and this is true in the tree even in Ada 2012 mode (the parser
4938 -- inserts a null statement marked with Comes_From_Source False).
4940 -------------------------------
4941 -- 5.1 Statement Identifier --
4942 -------------------------------
4944 -- STATEMENT_IDENTIFIER ::= DIRECT_NAME
4946 -- The IDENTIFIER of a STATEMENT_IDENTIFIER shall be an identifier
4947 -- (not an OPERATOR_SYMBOL)
4949 -------------------------------
4950 -- 5.2 Assignment Statement --
4951 -------------------------------
4953 -- ASSIGNMENT_STATEMENT ::=
4954 -- variable_NAME := EXPRESSION;
4956 -- N_Assignment_Statement
4957 -- Sloc points to :=
4958 -- Name
4959 -- Expression
4960 -- Is_Elaboration_Checks_OK_Node
4961 -- Is_SPARK_Mode_On_Node
4962 -- Do_Discriminant_Check
4963 -- Do_Length_Check
4964 -- Forwards_OK
4965 -- Backwards_OK
4966 -- No_Ctrl_Actions
4967 -- No_Finalize_Actions
4968 -- Has_Target_Names
4969 -- Is_Elaboration_Code
4970 -- Componentwise_Assignment
4971 -- Suppress_Assignment_Checks
4973 -- Note: if a range check is required, then the Do_Range_Check flag
4974 -- is set in the Expression (right hand side), with the check being
4975 -- done against the type of the Name (left hand side).
4977 -- Note: the back end places some restrictions on the form of the
4978 -- Expression field. If the object being assigned to is Atomic, then
4979 -- the Expression may not have the form of an aggregate (since this
4980 -- might cause the back end to generate separate assignments). In this
4981 -- case the front end must generate an extra temporary and initialize
4982 -- this temporary as required (the temporary itself is not atomic).
4984 ------------------
4985 -- Target_Name --
4986 ------------------
4988 -- N_Target_Name
4989 -- Sloc points to @
4990 -- Etype
4992 -- Note (Ada 2022): node is used during analysis as a placeholder for
4993 -- the value of the LHS of the enclosing assignment statement. Node is
4994 -- eventually rewritten together with enclosing assignment, and backends
4995 -- are not aware of it.
4997 -----------------------
4998 -- 5.3 If Statement --
4999 -----------------------
5001 -- IF_STATEMENT ::=
5002 -- if CONDITION then
5003 -- SEQUENCE_OF_STATEMENTS
5004 -- {elsif CONDITION then
5005 -- SEQUENCE_OF_STATEMENTS}
5006 -- [else
5007 -- SEQUENCE_OF_STATEMENTS]
5008 -- end if;
5010 -- Gigi restriction: This expander ensures that the type of the
5011 -- Condition fields is always Standard.Boolean, even if the type
5012 -- in the source is some non-standard boolean type.
5014 -- N_If_Statement
5015 -- Sloc points to IF
5016 -- Condition
5017 -- Then_Statements
5018 -- Elsif_Parts (set to No_List if none present)
5019 -- Else_Statements (set to No_List if no else part present)
5020 -- End_Span (set to Uint_0 if expander generated)
5021 -- From_Conditional_Expression
5023 -- N_Elsif_Part
5024 -- Sloc points to ELSIF
5025 -- Condition
5026 -- Then_Statements
5027 -- Condition_Actions
5029 --------------------
5030 -- 5.3 Condition --
5031 --------------------
5033 -- CONDITION ::= boolean_EXPRESSION
5035 -------------------------
5036 -- 5.4 Case Statement --
5037 -------------------------
5039 -- CASE_STATEMENT ::=
5040 -- case EXPRESSION is
5041 -- CASE_STATEMENT_ALTERNATIVE
5042 -- {CASE_STATEMENT_ALTERNATIVE}
5043 -- end case;
5045 -- Note: the Alternatives can contain pragmas. These only occur at
5046 -- the start of the list, since any pragmas occurring after the first
5047 -- alternative are absorbed into the corresponding statement sequence.
5049 -- N_Case_Statement
5050 -- Sloc points to CASE
5051 -- Expression
5052 -- Alternatives
5053 -- End_Span (set to Uint_0 if expander generated)
5054 -- From_Conditional_Expression
5056 -- Note: Before Ada 2012, a pragma in a statement sequence is always
5057 -- followed by a statement, and this is true in the tree even in Ada
5058 -- 2012 mode (the parser inserts a null statement marked with the flag
5059 -- Comes_From_Source False).
5061 -------------------------------------
5062 -- 5.4 Case Statement Alternative --
5063 -------------------------------------
5065 -- CASE_STATEMENT_ALTERNATIVE ::=
5066 -- when DISCRETE_CHOICE_LIST =>
5067 -- SEQUENCE_OF_STATEMENTS
5069 -- N_Case_Statement_Alternative
5070 -- Sloc points to WHEN
5071 -- Discrete_Choices
5072 -- Statements
5073 -- Has_SP_Choice
5074 -- Multidefined_Bindings
5076 -- Note: in the list of Discrete_Choices, the tree passed to the back
5077 -- end does not have choice entries corresponding to names of statically
5078 -- predicated subtypes. Such entries are always expanded out to the list
5079 -- of equivalent values or ranges. Multidefined_Bindings is True iff
5080 -- more than one choice is present and each choice contains
5081 -- at least one component association having a non-null Binding_Chars
5082 -- attribute; this can only occur if GNAT extensions are enabled
5083 -- and the type of the case selector is composite.
5085 -------------------------
5086 -- 5.5 Loop Statement --
5087 -------------------------
5089 -- LOOP_STATEMENT ::=
5090 -- [loop_STATEMENT_IDENTIFIER :]
5091 -- [ITERATION_SCHEME] loop
5092 -- SEQUENCE_OF_STATEMENTS
5093 -- end loop [loop_IDENTIFIER];
5095 -- Note: The occurrence of a loop label is not a defining identifier
5096 -- but rather a referencing occurrence. The defining occurrence is in
5097 -- the implicit label declaration which occurs in the innermost
5098 -- enclosing block.
5100 -- Note: there is always a loop statement identifier present in the
5101 -- tree, even if none was given in the source. In the case where no loop
5102 -- identifier is given in the source, the parser creates a name of the
5103 -- form _Loop_n, where n is a decimal integer (the two underlines ensure
5104 -- that the loop names created in this manner do not conflict with any
5105 -- user defined identifiers), and the flag Has_Created_Identifier is set
5106 -- to True. The only exception to the rule that all loop statement nodes
5107 -- have identifiers occurs for loops constructed by the expander, and
5108 -- the semantic analyzer will create and supply dummy loop identifiers
5109 -- in these cases.
5111 -- N_Loop_Statement
5112 -- Sloc points to LOOP
5113 -- Identifier loop identifier (set to Empty if no identifier)
5114 -- Iteration_Scheme (set to Empty if no iteration scheme)
5115 -- Statements
5116 -- End_Label
5117 -- Has_Created_Identifier
5118 -- Is_Null_Loop
5119 -- Suppress_Loop_Warnings
5121 -- Note: the parser fills in the Identifier field if there is an
5122 -- explicit loop identifier. Otherwise the parser leaves this field
5123 -- set to Empty, and then the semantic processing for a loop statement
5124 -- creates an identifier, setting the Has_Created_Identifier flag to
5125 -- True. So after semantic analysis, the Identifier is always set,
5126 -- referencing an identifier whose entity has an Ekind of E_Loop.
5128 ---------------------------
5129 -- 5.5 Iteration Scheme --
5130 ---------------------------
5132 -- ITERATION_SCHEME ::=
5133 -- while CONDITION
5134 -- | for LOOP_PARAMETER_SPECIFICATION
5135 -- | for ITERATOR_SPECIFICATION
5137 -- At most one of (Iterator_Specification, Loop_Parameter_Specification)
5138 -- is present at a time, in which case the other one is empty. Both are
5139 -- empty in the case of a WHILE loop.
5141 -- Gigi restriction: The expander ensures that the type of the Condition
5142 -- field is always Standard.Boolean, even if the type in the source is
5143 -- some non-standard boolean type.
5145 -- N_Iteration_Scheme
5146 -- Sloc points to WHILE or FOR
5147 -- Condition (set to Empty if FOR case)
5148 -- Condition_Actions
5149 -- Iterator_Specification (set to Empty if WHILE case)
5150 -- Loop_Parameter_Specification (set to Empty if WHILE case)
5152 ---------------------------------------
5153 -- 5.5 Loop Parameter Specification --
5154 ---------------------------------------
5156 -- LOOP_PARAMETER_SPECIFICATION ::=
5157 -- DEFINING_IDENTIFIER in [reverse] DISCRETE_SUBTYPE_DEFINITION
5158 -- [Iterator_Filter]
5160 -- Note: the optional Iterator_Filter is an Ada 2022 construct.
5162 -- N_Loop_Parameter_Specification
5163 -- Sloc points to first identifier
5164 -- Defining_Identifier
5165 -- Reverse_Present
5166 -- Iterator_Filter (set to Empty if not present)
5167 -- Discrete_Subtype_Definition
5169 -----------------------------------
5170 -- 5.5.1 Iterator Specification --
5171 -----------------------------------
5173 -- ITERATOR_SPECIFICATION ::=
5174 -- DEFINING_IDENTIFIER in [reverse] NAME
5175 -- | DEFINING_IDENTIFIER [: SUBTYPE_INDICATION] of [reverse] NAME
5177 -- N_Iterator_Specification
5178 -- Sloc points to defining identifier
5179 -- Defining_Identifier
5180 -- Name
5181 -- Reverse_Present
5182 -- Of_Present
5183 -- Iterator_Filter (set to Empty if not present)
5184 -- Subtype_Indication
5186 -- Note: The Of_Present flag distinguishes the two forms
5188 --------------------------
5189 -- 5.6 Block Statement --
5190 --------------------------
5192 -- BLOCK_STATEMENT ::=
5193 -- [block_STATEMENT_IDENTIFIER:]
5194 -- [declare
5195 -- DECLARATIVE_PART]
5196 -- begin
5197 -- HANDLED_SEQUENCE_OF_STATEMENTS
5198 -- end [block_IDENTIFIER];
5200 -- Note that the occurrence of a block identifier is not a defining
5201 -- identifier, but rather a referencing occurrence. The defining
5202 -- occurrence is an E_Block entity declared by the implicit label
5203 -- declaration which occurs in the innermost enclosing block statement
5204 -- or body; the block identifier denotes that E_Block.
5206 -- For block statements that come from source code, there is always a
5207 -- block statement identifier present in the tree, denoting an E_Block.
5208 -- In the case where no block identifier is given in the source,
5209 -- the parser creates a name of the form B_n, where n is a decimal
5210 -- integer, and the flag Has_Created_Identifier is set to True. Blocks
5211 -- constructed by the expander usually have no identifier, and no
5212 -- corresponding entity.
5214 -- Note: the block statement created for an extended return statement
5215 -- has an entity, and this entity is an E_Return_Statement, rather than
5216 -- the usual E_Block.
5218 -- Note: Exception_Junk is set for the wrapping blocks created during
5219 -- local raise optimization (Exp_Ch11.Expand_Local_Exception_Handlers).
5221 -- Note: from a control flow viewpoint, a block statement defines an
5222 -- extended basic block, i.e. the entry of the block dominates every
5223 -- statement in the sequence. When generating new statements with
5224 -- exception handlers in the expander at the end of a sequence that
5225 -- comes from source code, it can be necessary to wrap them all in a
5226 -- block statement in order to expose the implicit control flow to
5227 -- gigi and thus prevent it from issuing bogus control flow warnings.
5229 -- N_Block_Statement
5230 -- Sloc points to DECLARE or BEGIN
5231 -- Identifier block direct name (set to Empty if not present)
5232 -- Declarations (set to No_List if no DECLARE part)
5233 -- Handled_Statement_Sequence
5234 -- Activation_Chain_Entity
5235 -- Cleanup_Actions
5236 -- Has_Created_Identifier
5237 -- Is_Asynchronous_Call_Block
5238 -- Is_Task_Allocation_Block
5239 -- Exception_Junk
5240 -- Is_Abort_Block
5241 -- Is_Finalization_Wrapper
5242 -- Is_Initialization_Block
5243 -- Is_Task_Master
5244 -- At_End_Proc (set to Empty if no clean up procedure)
5246 -------------------------
5247 -- 5.7 Exit Statement --
5248 -------------------------
5250 -- EXIT_STATEMENT ::= exit [loop_NAME] [when CONDITION];
5252 -- Gigi restriction: The expander ensures that the type of the Condition
5253 -- field is always Standard.Boolean, even if the type in the source is
5254 -- some non-standard boolean type.
5256 -- N_Exit_Statement
5257 -- Sloc points to EXIT
5258 -- Name (set to Empty if no loop name present)
5259 -- Condition (set to Empty if no WHEN part present)
5260 -- Next_Exit_Statement : Next exit on chain
5262 -------------------------
5263 -- 5.9 Goto Statement --
5264 -------------------------
5266 -- GOTO_STATEMENT ::= goto label_NAME;
5268 -- N_Goto_Statement
5269 -- Sloc points to GOTO
5270 -- Name
5271 -- Exception_Junk
5273 ---------------------------------
5274 -- 6.1 Subprogram Declaration --
5275 ---------------------------------
5277 -- SUBPROGRAM_DECLARATION ::=
5278 -- SUBPROGRAM_SPECIFICATION
5279 -- [ASPECT_SPECIFICATIONS];
5281 -- N_Subprogram_Declaration
5282 -- Sloc points to FUNCTION or PROCEDURE
5283 -- Specification
5284 -- Body_To_Inline
5285 -- Corresponding_Body
5286 -- Parent_Spec
5287 -- Is_Entry_Barrier_Function
5288 -- Is_Task_Body_Procedure
5290 ------------------------------------------
5291 -- 6.1 Abstract Subprogram Declaration --
5292 ------------------------------------------
5294 -- ABSTRACT_SUBPROGRAM_DECLARATION ::=
5295 -- SUBPROGRAM_SPECIFICATION is abstract
5296 -- [ASPECT_SPECIFICATIONS];
5298 -- N_Abstract_Subprogram_Declaration
5299 -- Sloc points to ABSTRACT
5300 -- Specification
5302 -----------------------------------
5303 -- 6.1 Subprogram Specification --
5304 -----------------------------------
5306 -- SUBPROGRAM_SPECIFICATION ::=
5307 -- [[not] overriding]
5308 -- procedure DEFINING_PROGRAM_UNIT_NAME PARAMETER_PROFILE
5309 -- | [[not] overriding]
5310 -- function DEFINING_DESIGNATOR PARAMETER_AND_RESULT_PROFILE
5312 -- Note: there are no separate nodes for the profiles, instead the
5313 -- information appears directly in the following nodes.
5315 -- N_Function_Specification
5316 -- Sloc points to FUNCTION
5317 -- Defining_Unit_Name (the designator)
5318 -- Parameter_Specifications (set to No_List if no formal part)
5319 -- Null_Exclusion_Present
5320 -- Result_Definition for result subtype
5321 -- Generic_Parent
5322 -- Must_Override set if overriding indicator present
5323 -- Must_Not_Override set if not_overriding indicator present
5325 -- N_Procedure_Specification
5326 -- Sloc points to PROCEDURE
5327 -- Defining_Unit_Name
5328 -- Null_Statement NULL statement for body, if Null_Present
5329 -- Parameter_Specifications (set to No_List if no formal part)
5330 -- Generic_Parent
5331 -- Null_Present set for null procedure case (Ada 2005 feature)
5332 -- Must_Override set if overriding indicator present
5333 -- Must_Not_Override set if not_overriding indicator present
5335 -- Note: overriding indicator is an Ada 2005 feature
5337 ---------------------
5338 -- 6.1 Designator --
5339 ---------------------
5341 -- DESIGNATOR ::=
5342 -- [PARENT_UNIT_NAME .] IDENTIFIER | OPERATOR_SYMBOL
5344 -- Designators that are simply identifiers or operator symbols appear
5345 -- directly in the tree in this form. The following node is used only
5346 -- in the case where the designator has a parent unit name component.
5348 -- N_Designator
5349 -- Sloc points to period
5350 -- Name holds the parent unit name
5351 -- Identifier
5353 -- Note: Name is always non-Empty, since this node is only used for the
5354 -- case where a parent library unit package name is present.
5356 -- Note that the identifier can also be an operator symbol here
5358 ------------------------------
5359 -- 6.1 Defining Designator --
5360 ------------------------------
5362 -- DEFINING_DESIGNATOR ::=
5363 -- DEFINING_PROGRAM_UNIT_NAME | DEFINING_OPERATOR_SYMBOL
5365 -------------------------------------
5366 -- 6.1 Defining Program Unit Name --
5367 -------------------------------------
5369 -- DEFINING_PROGRAM_UNIT_NAME ::=
5370 -- [PARENT_UNIT_NAME .] DEFINING_IDENTIFIER
5372 -- The parent unit name is present only in the case of a child unit name
5373 -- (permissible only for Ada 95 for a library level unit, i.e. a unit
5374 -- at scope level one). If no such name is present, the defining program
5375 -- unit name is represented simply as the defining identifier. In the
5376 -- child unit case, the following node is used to represent the child
5377 -- unit name.
5379 -- N_Defining_Program_Unit_Name
5380 -- Sloc points to period
5381 -- Name holds the parent unit name
5382 -- Defining_Identifier
5384 -- Note: Name is always non-Empty, since this node is only used for the
5385 -- case where a parent unit name is present.
5387 --------------------------
5388 -- 6.1 Operator Symbol --
5389 --------------------------
5391 -- OPERATOR_SYMBOL ::= STRING_LITERAL
5393 -- Note: the fields of the N_Operator_Symbol node are laid out to match
5394 -- the corresponding fields of an N_Character_Literal node. This allows
5395 -- easy conversion of the operator symbol node into a character literal
5396 -- node in the case where a string constant of the form of an operator
5397 -- symbol is scanned out as such, but turns out semantically to be a
5398 -- string literal that is not an operator. For details see Sinfo.CN.
5399 -- Change_Operator_Symbol_To_String_Literal.
5401 -- N_Operator_Symbol
5402 -- Sloc points to literal
5403 -- Chars contains the Name_Id for the operator symbol
5404 -- Strval Id of string value. This is used if the operator
5405 -- symbol turns out to be a normal string after all.
5406 -- Entity
5407 -- Associated_Node Note this is shared with Entity
5408 -- Etype
5409 -- Has_Private_View (set in generic units)
5410 -- Has_Secondary_Private_View (set in generic units)
5412 -- Note: the Strval field may be set to No_String for generated
5413 -- operator symbols that are known not to be string literals
5414 -- semantically.
5416 -----------------------------------
5417 -- 6.1 Defining Operator Symbol --
5418 -----------------------------------
5420 -- DEFINING_OPERATOR_SYMBOL ::= OPERATOR_SYMBOL
5422 -- A defining operator symbol is an entity, which has additional
5423 -- fields depending on the setting of the Ekind field. These
5424 -- additional fields are defined (and access subprograms declared)
5425 -- in package Einfo.
5427 -- N_Defining_Operator_Symbol
5428 -- Sloc points to literal
5429 -- Chars contains the Name_Id for the operator symbol
5430 -- Next_Entity
5431 -- Scope
5432 -- Etype
5434 ----------------------------
5435 -- 6.1 Parameter Profile --
5436 ----------------------------
5438 -- PARAMETER_PROFILE ::= [FORMAL_PART]
5440 ---------------------------------------
5441 -- 6.1 Parameter and Result Profile --
5442 ---------------------------------------
5444 -- PARAMETER_AND_RESULT_PROFILE ::=
5445 -- [FORMAL_PART] return [NULL_EXCLUSION] SUBTYPE_MARK
5446 -- | [FORMAL_PART] return ACCESS_DEFINITION
5448 -- There is no explicit node in the tree for a parameter and result
5449 -- profile. Instead the information appears directly in the parent.
5451 ----------------------
5452 -- 6.1 Formal Part --
5453 ----------------------
5455 -- FORMAL_PART ::=
5456 -- (PARAMETER_SPECIFICATION {; PARAMETER_SPECIFICATION})
5458 ----------------------------------
5459 -- 6.1 Parameter Specification --
5460 ----------------------------------
5462 -- PARAMETER_SPECIFICATION ::=
5463 -- DEFINING_IDENTIFIER_LIST : [ALIASED] MODE [NULL_EXCLUSION]
5464 -- SUBTYPE_MARK [:= DEFAULT_EXPRESSION] [ASPECT_SPECIFICATIONS]
5465 -- | DEFINING_IDENTIFIER_LIST : ACCESS_DEFINITION
5466 -- [:= DEFAULT_EXPRESSION] [ASPECT_SPECIFICATIONS]
5468 -- Although the syntax allows multiple identifiers in the list, the
5469 -- semantics is as though successive specifications were given with
5470 -- identical type definition and expression components. To simplify
5471 -- semantic processing, the parser represents a multiple declaration
5472 -- case as a sequence of single Specifications, using the More_Ids and
5473 -- Prev_Ids flags to preserve the original source form as described
5474 -- in the section on "Handling of Defining Identifier Lists".
5476 -- ALIASED can only be present in Ada 2012 mode
5478 -- N_Parameter_Specification
5479 -- Sloc points to first identifier
5480 -- Defining_Identifier
5481 -- Aliased_Present
5482 -- In_Present
5483 -- Out_Present
5484 -- Null_Exclusion_Present
5485 -- Parameter_Type subtype mark or access definition
5486 -- Expression (set to Empty if no default expression present)
5487 -- More_Ids (set to False if no more identifiers in list)
5488 -- Prev_Ids (set to False if no previous identifiers in list)
5489 -- Default_Expression
5491 ---------------
5492 -- 6.1 Mode --
5493 ---------------
5495 -- MODE ::= [in] | in out | out
5497 -- There is no explicit node in the tree for the Mode. Instead the
5498 -- In_Present and Out_Present flags are set in the parent node to
5499 -- record the presence of keywords specifying the mode.
5501 --------------------------
5502 -- 6.3 Subprogram Body --
5503 --------------------------
5505 -- SUBPROGRAM_BODY ::=
5506 -- SUBPROGRAM_SPECIFICATION [ASPECT_SPECIFICATIONS] is
5507 -- DECLARATIVE_PART
5508 -- begin
5509 -- HANDLED_SEQUENCE_OF_STATEMENTS
5510 -- end [DESIGNATOR];
5512 -- N_Subprogram_Body
5513 -- Sloc points to FUNCTION or PROCEDURE
5514 -- Specification
5515 -- Declarations
5516 -- Handled_Statement_Sequence
5517 -- Activation_Chain_Entity
5518 -- Corresponding_Spec
5519 -- Acts_As_Spec
5520 -- Bad_Is_Detected used only by parser
5521 -- Do_Storage_Check
5522 -- Has_Relative_Deadline_Pragma
5523 -- Is_Entry_Barrier_Function
5524 -- Is_Protected_Subprogram_Body
5525 -- Is_Task_Body_Procedure
5526 -- Is_Task_Master
5527 -- Was_Attribute_Reference
5528 -- Was_Expression_Function
5529 -- Was_Originally_Stub
5531 -----------------------------------
5532 -- 6.4 Procedure Call Statement --
5533 -----------------------------------
5535 -- PROCEDURE_CALL_STATEMENT ::=
5536 -- procedure_NAME; | procedure_PREFIX ACTUAL_PARAMETER_PART;
5538 -- Note: the reason that a procedure call has expression fields is that
5539 -- it semantically resembles an expression, e.g. overloading is allowed
5540 -- and a type is concocted for semantic processing purposes. Certain of
5541 -- these fields, such as Parens are not relevant, but it is easier to
5542 -- just supply all of them together.
5544 -- N_Procedure_Call_Statement
5545 -- Sloc points to first token of name or prefix
5546 -- Name stores name or prefix
5547 -- Parameter_Associations (set to No_List if no
5548 -- actual parameter part)
5549 -- First_Named_Actual
5550 -- Controlling_Argument (set to Empty if not dispatching)
5551 -- Is_Elaboration_Checks_OK_Node
5552 -- Is_SPARK_Mode_On_Node
5553 -- Is_Elaboration_Warnings_OK_Node
5554 -- No_Elaboration_Check
5555 -- Is_Known_Guaranteed_ABE
5556 -- plus fields for expression
5558 -- If any IN parameter requires a range check, then the corresponding
5559 -- argument expression has the Do_Range_Check flag set, and the range
5560 -- check is done against the formal type. Note that this argument
5561 -- expression may appear directly in the Parameter_Associations list,
5562 -- or may be a descendant of an N_Parameter_Association node that
5563 -- appears in this list.
5565 ------------------------
5566 -- 6.4 Function Call --
5567 ------------------------
5569 -- FUNCTION_CALL ::=
5570 -- function_NAME | function_PREFIX ACTUAL_PARAMETER_PART
5572 -- Note: the parser may generate an indexed component node or simply
5573 -- a name node instead of a function call node. The semantic pass must
5574 -- correct this misidentification.
5576 -- N_Function_Call
5577 -- Sloc points to first token of name or prefix
5578 -- Name stores name or prefix
5579 -- Parameter_Associations (set to No_List if no
5580 -- actual parameter part)
5581 -- First_Named_Actual
5582 -- Controlling_Argument (set to Empty if not dispatching)
5583 -- Is_Elaboration_Checks_OK_Node
5584 -- Is_SPARK_Mode_On_Node
5585 -- Is_Elaboration_Warnings_OK_Node
5586 -- No_Elaboration_Check
5587 -- Is_Expanded_Build_In_Place_Call
5588 -- Is_Known_Guaranteed_ABE
5589 -- plus fields for expression
5591 --------------------------------
5592 -- 6.4 Actual Parameter Part --
5593 --------------------------------
5595 -- ACTUAL_PARAMETER_PART ::=
5596 -- (PARAMETER_ASSOCIATION {,PARAMETER_ASSOCIATION})
5598 --------------------------------
5599 -- 6.4 Parameter Association --
5600 --------------------------------
5602 -- PARAMETER_ASSOCIATION ::=
5603 -- [formal_parameter_SELECTOR_NAME =>] EXPLICIT_ACTUAL_PARAMETER
5605 -- Note: the N_Parameter_Association node is built only if a formal
5606 -- parameter selector name is present, otherwise the parameter
5607 -- association appears in the tree simply as the node for the
5608 -- explicit actual parameter.
5610 -- N_Parameter_Association
5611 -- Sloc points to formal parameter
5612 -- Selector_Name (always non-Empty)
5613 -- Explicit_Actual_Parameter
5614 -- Next_Named_Actual
5615 -- Is_Accessibility_Actual
5617 ---------------------------
5618 -- 6.4 Actual Parameter --
5619 ---------------------------
5621 -- EXPLICIT_ACTUAL_PARAMETER ::=
5622 -- EXPRESSION | variable_NAME | REDUCTION_EXPRESSION_PARAMETER
5624 ---------------------------
5625 -- 6.5 Return Statement --
5626 ---------------------------
5628 -- SIMPLE_RETURN_STATEMENT ::= return [EXPRESSION];
5630 -- EXTENDED_RETURN_STATEMENT ::=
5631 -- return DEFINING_IDENTIFIER : [aliased] RETURN_SUBTYPE_INDICATION
5632 -- [:= EXPRESSION] [do
5633 -- HANDLED_SEQUENCE_OF_STATEMENTS
5634 -- end return];
5636 -- RETURN_SUBTYPE_INDICATION ::= SUBTYPE_INDICATION | ACCESS_DEFINITION
5638 -- The term "return statement" is defined in 6.5 to mean either a
5639 -- SIMPLE_RETURN_STATEMENT or an EXTENDED_RETURN_STATEMENT. We avoid
5640 -- the use of this term, since it used to mean something else in earlier
5641 -- versions of Ada.
5643 -- N_Simple_Return_Statement
5644 -- Sloc points to RETURN
5645 -- Return_Statement_Entity
5646 -- Expression (set to Empty if no expression present)
5647 -- Storage_Pool
5648 -- Procedure_To_Call
5649 -- Comes_From_Extended_Return_Statement
5651 -- Note: Return_Statement_Entity points to an E_Return_Statement
5653 -- If a range check is required, then Do_Range_Check is set on the
5654 -- Expression. The check is against the return subtype of the function.
5656 -- N_Extended_Return_Statement
5657 -- Sloc points to RETURN
5658 -- Return_Statement_Entity
5659 -- Return_Object_Declarations
5660 -- Handled_Statement_Sequence (set to Empty if not present)
5661 -- Storage_Pool
5662 -- Procedure_To_Call
5664 -- Note: Return_Statement_Entity points to an E_Return_Statement.
5666 -- Note that Return_Object_Declarations is a list containing the
5667 -- N_Object_Declaration -- see comment on this field above.
5669 -- The declared object will have Is_Return_Object = True.
5671 -- There is no such syntactic category as return_object_declaration
5672 -- in the RM. Return_Object_Declarations represents this portion of
5673 -- the syntax for EXTENDED_RETURN_STATEMENT:
5674 -- DEFINING_IDENTIFIER : [aliased] RETURN_SUBTYPE_INDICATION
5675 -- [:= EXPRESSION]
5677 -- There are two entities associated with an extended_return_statement:
5678 -- the Return_Statement_Entity represents the statement itself,
5679 -- and the Defining_Identifier of the Object_Declaration in
5680 -- Return_Object_Declarations represents the object being
5681 -- returned. N_Simple_Return_Statement has only the former.
5683 ------------------------------
5684 -- 6.8 Expression Function --
5685 ------------------------------
5687 -- EXPRESSION_FUNCTION ::=
5688 -- FUNCTION SPECIFICATION IS (EXPRESSION)
5689 -- [ASPECT_SPECIFICATIONS];
5691 -- N_Expression_Function
5692 -- Sloc points to FUNCTION
5693 -- Specification
5694 -- Expression
5695 -- Corresponding_Spec
5697 ------------------------------
5698 -- 7.1 Package Declaration --
5699 ------------------------------
5701 -- PACKAGE_DECLARATION ::=
5702 -- PACKAGE_SPECIFICATION;
5704 -- Note: the activation chain entity for a package spec is used for
5705 -- all tasks declared in the package spec, or in the package body.
5707 -- N_Package_Declaration
5708 -- Sloc points to PACKAGE
5709 -- Specification
5710 -- Corresponding_Body
5711 -- Parent_Spec
5712 -- Activation_Chain_Entity
5714 --------------------------------
5715 -- 7.1 Package Specification --
5716 --------------------------------
5718 -- PACKAGE_SPECIFICATION ::=
5719 -- package DEFINING_PROGRAM_UNIT_NAME
5720 -- [ASPECT_SPECIFICATIONS]
5721 -- is
5722 -- {BASIC_DECLARATIVE_ITEM}
5723 -- [private
5724 -- {BASIC_DECLARATIVE_ITEM}]
5725 -- end [[PARENT_UNIT_NAME .] IDENTIFIER]
5727 -- N_Package_Specification
5728 -- Sloc points to PACKAGE
5729 -- Defining_Unit_Name
5730 -- Visible_Declarations
5731 -- Private_Declarations (set to No_List if no private
5732 -- part present)
5733 -- End_Label
5734 -- Generic_Parent
5735 -- Limited_View_Installed
5737 -----------------------
5738 -- 7.1 Package Body --
5739 -----------------------
5741 -- PACKAGE_BODY ::=
5742 -- package body DEFINING_PROGRAM_UNIT_NAME
5743 -- [ASPECT_SPECIFICATIONS]
5744 -- is
5745 -- DECLARATIVE_PART
5746 -- [begin
5747 -- HANDLED_SEQUENCE_OF_STATEMENTS]
5748 -- end [[PARENT_UNIT_NAME .] IDENTIFIER];
5750 -- N_Package_Body
5751 -- Sloc points to PACKAGE
5752 -- Defining_Unit_Name
5753 -- Declarations
5754 -- Handled_Statement_Sequence (set to Empty if no HSS present)
5755 -- Corresponding_Spec
5756 -- Was_Originally_Stub
5757 -- At_End_Proc (set to Empty if no clean up procedure)
5759 -- Note: if a source level package does not contain a handled sequence
5760 -- of statements, then the parser supplies a dummy one with a null
5761 -- sequence of statements. Comes_From_Source will be False in this
5762 -- constructed sequence. The reason we need this is for the End_Label
5763 -- field in the HSS.
5765 -----------------------------------
5766 -- 7.4 Private Type Declaration --
5767 -----------------------------------
5769 -- PRIVATE_TYPE_DECLARATION ::=
5770 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART]
5771 -- is [[abstract] tagged] [limited] private
5772 -- [ASPECT_SPECIFICATIONS];
5774 -- Note: TAGGED is not permitted in Ada 83 mode
5776 -- N_Private_Type_Declaration
5777 -- Sloc points to TYPE
5778 -- Defining_Identifier
5779 -- Discriminant_Specifications (set to No_List if no
5780 -- discriminant part)
5781 -- Unknown_Discriminants_Present set if (<>) discriminant
5782 -- Abstract_Present
5783 -- Tagged_Present
5784 -- Limited_Present
5786 ----------------------------------------
5787 -- 7.4 Private Extension Declaration --
5788 ----------------------------------------
5790 -- PRIVATE_EXTENSION_DECLARATION ::=
5791 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART] is
5792 -- [abstract] [limited | synchronized]
5793 -- new ancestor_SUBTYPE_INDICATION [and INTERFACE_LIST]
5794 -- with private [ASPECT_SPECIFICATIONS];
5796 -- Note: LIMITED, and private extension declarations are not allowed
5797 -- in Ada 83 mode.
5799 -- N_Private_Extension_Declaration
5800 -- Sloc points to TYPE
5801 -- Defining_Identifier
5802 -- Uninitialized_Variable
5803 -- Discriminant_Specifications (set to No_List if no
5804 -- discriminant part)
5805 -- Unknown_Discriminants_Present set if (<>) discriminant
5806 -- Abstract_Present
5807 -- Limited_Present
5808 -- Synchronized_Present
5809 -- Subtype_Indication
5810 -- Interface_List (set to No_List if none)
5812 ---------------------
5813 -- 8.4 Use Clause --
5814 ---------------------
5816 -- USE_CLAUSE ::= USE_PACKAGE_CLAUSE | USE_TYPE_CLAUSE
5818 -----------------------------
5819 -- 8.4 Use Package Clause --
5820 -----------------------------
5822 -- USE_PACKAGE_CLAUSE ::= use package_NAME {, package_NAME};
5824 -- N_Use_Package_Clause
5825 -- Sloc points to USE
5826 -- Prev_Use_Clause
5827 -- Name
5828 -- Next_Use_Clause
5829 -- Associated_Node
5830 -- Hidden_By_Use_Clause
5831 -- Is_Effective_Use_Clause
5832 -- More_Ids (set to False if no more identifiers in list)
5833 -- Prev_Ids (set to False if no previous identifiers in list)
5835 --------------------------
5836 -- 8.4 Use Type Clause --
5837 --------------------------
5839 -- USE_TYPE_CLAUSE ::= use [ALL] type SUBTYPE_MARK {, SUBTYPE_MARK};
5841 -- Note: use type clause is not permitted in Ada 83 mode
5843 -- Note: the ALL keyword can appear only in Ada 2012 mode
5845 -- N_Use_Type_Clause
5846 -- Sloc points to USE
5847 -- Prev_Use_Clause
5848 -- Used_Operations
5849 -- Next_Use_Clause
5850 -- Subtype_Mark
5851 -- Hidden_By_Use_Clause
5852 -- Is_Effective_Use_Clause
5853 -- More_Ids (set to False if no more identifiers in list)
5854 -- Prev_Ids (set to False if no previous identifiers in list)
5855 -- All_Present
5857 -------------------------------
5858 -- 8.5 Renaming Declaration --
5859 -------------------------------
5861 -- RENAMING_DECLARATION ::=
5862 -- OBJECT_RENAMING_DECLARATION
5863 -- | EXCEPTION_RENAMING_DECLARATION
5864 -- | PACKAGE_RENAMING_DECLARATION
5865 -- | SUBPROGRAM_RENAMING_DECLARATION
5866 -- | GENERIC_RENAMING_DECLARATION
5868 --------------------------------------
5869 -- 8.5 Object Renaming Declaration --
5870 --------------------------------------
5872 -- OBJECT_RENAMING_DECLARATION ::=
5873 -- DEFINING_IDENTIFIER :
5874 -- [NULL_EXCLUSION] SUBTYPE_MARK renames object_NAME
5875 -- [ASPECT_SPECIFICATIONS];
5876 -- | DEFINING_IDENTIFIER :
5877 -- ACCESS_DEFINITION renames object_NAME
5878 -- [ASPECT_SPECIFICATIONS];
5880 -- Note: Access_Definition is an optional field that gives support to
5881 -- Ada 2005 (AI-230). The parser generates nodes that have either the
5882 -- Subtype_Indication field or else the Access_Definition field.
5884 -- N_Object_Renaming_Declaration
5885 -- Sloc points to first identifier
5886 -- Defining_Identifier
5887 -- Null_Exclusion_Present (set to False if not present)
5888 -- Subtype_Mark (set to Empty if not present)
5889 -- Access_Definition (set to Empty if not present)
5890 -- Name
5891 -- Corresponding_Generic_Association
5893 -----------------------------------------
5894 -- 8.5 Exception Renaming Declaration --
5895 -----------------------------------------
5897 -- EXCEPTION_RENAMING_DECLARATION ::=
5898 -- DEFINING_IDENTIFIER : exception renames exception_NAME
5899 -- [ASPECT_SPECIFICATIONS];
5901 -- N_Exception_Renaming_Declaration
5902 -- Sloc points to first identifier
5903 -- Defining_Identifier
5904 -- Name
5906 ---------------------------------------
5907 -- 8.5 Package Renaming Declaration --
5908 ---------------------------------------
5910 -- PACKAGE_RENAMING_DECLARATION ::=
5911 -- package DEFINING_PROGRAM_UNIT_NAME renames package_NAME
5912 -- [ASPECT_SPECIFICATIONS];
5914 -- N_Package_Renaming_Declaration
5915 -- Sloc points to PACKAGE
5916 -- Defining_Unit_Name
5917 -- Name
5918 -- Parent_Spec
5920 ------------------------------------------
5921 -- 8.5 Subprogram Renaming Declaration --
5922 ------------------------------------------
5924 -- SUBPROGRAM_RENAMING_DECLARATION ::=
5925 -- SUBPROGRAM_SPECIFICATION renames callable_entity_NAME
5926 -- [ASPECT_SPECIFICATIONS];
5928 -- N_Subprogram_Renaming_Declaration
5929 -- Sloc points to RENAMES
5930 -- Specification
5931 -- Name
5932 -- Parent_Spec
5933 -- Corresponding_Spec
5934 -- Corresponding_Formal_Spec
5935 -- From_Default
5937 -----------------------------------------
5938 -- 8.5.5 Generic Renaming Declaration --
5939 -----------------------------------------
5941 -- GENERIC_RENAMING_DECLARATION ::=
5942 -- generic package DEFINING_PROGRAM_UNIT_NAME
5943 -- renames generic_package_NAME
5944 -- [ASPECT_SPECIFICATIONS];
5945 -- | generic procedure DEFINING_PROGRAM_UNIT_NAME
5946 -- renames generic_procedure_NAME
5947 -- [ASPECT_SPECIFICATIONS];
5948 -- | generic function DEFINING_PROGRAM_UNIT_NAME
5949 -- renames generic_function_NAME
5950 -- [ASPECT_SPECIFICATIONS];
5952 -- N_Generic_Package_Renaming_Declaration
5953 -- Sloc points to GENERIC
5954 -- Defining_Unit_Name
5955 -- Name
5956 -- Parent_Spec
5958 -- N_Generic_Procedure_Renaming_Declaration
5959 -- Sloc points to GENERIC
5960 -- Defining_Unit_Name
5961 -- Name
5962 -- Parent_Spec
5964 -- N_Generic_Function_Renaming_Declaration
5965 -- Sloc points to GENERIC
5966 -- Defining_Unit_Name
5967 -- Name
5968 -- Parent_Spec
5970 --------------------------------
5971 -- 9.1 Task Type Declaration --
5972 --------------------------------
5974 -- TASK_TYPE_DECLARATION ::=
5975 -- task type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
5976 -- [ASPECT_SPECIFICATIONS]
5977 -- [is [new INTERFACE_LIST with] TASK_DEFINITION];
5979 -- N_Task_Type_Declaration
5980 -- Sloc points to TASK
5981 -- Defining_Identifier
5982 -- Discriminant_Specifications (set to No_List if no
5983 -- discriminant part)
5984 -- Interface_List (set to No_List if none)
5985 -- Task_Definition (set to Empty if not present)
5986 -- Corresponding_Body
5988 ----------------------------------
5989 -- 9.1 Single Task Declaration --
5990 ----------------------------------
5992 -- SINGLE_TASK_DECLARATION ::=
5993 -- task DEFINING_IDENTIFIER
5994 -- [ASPECT_SPECIFICATIONS]
5995 -- [is [new INTERFACE_LIST with] TASK_DEFINITION];
5997 -- N_Single_Task_Declaration
5998 -- Sloc points to TASK
5999 -- Defining_Identifier
6000 -- Interface_List (set to No_List if none)
6001 -- Task_Definition (set to Empty if not present)
6003 --------------------------
6004 -- 9.1 Task Definition --
6005 --------------------------
6007 -- TASK_DEFINITION ::=
6008 -- {TASK_ITEM}
6009 -- [private
6010 -- {TASK_ITEM}]
6011 -- end [task_IDENTIFIER]
6013 -- Note: as a result of semantic analysis, the list of task items can
6014 -- include implicit type declarations resulting from entry families.
6016 -- N_Task_Definition
6017 -- Sloc points to first token of task definition
6018 -- Visible_Declarations
6019 -- Private_Declarations (set to No_List if no private part)
6020 -- End_Label
6021 -- Has_Storage_Size_Pragma
6022 -- Has_Relative_Deadline_Pragma
6024 --------------------
6025 -- 9.1 Task Item --
6026 --------------------
6028 -- TASK_ITEM ::= ENTRY_DECLARATION | REPRESENTATION_CLAUSE
6030 --------------------
6031 -- 9.1 Task Body --
6032 --------------------
6034 -- TASK_BODY ::=
6035 -- task body task_DEFINING_IDENTIFIER
6036 -- [ASPECT_SPECIFICATIONS]
6037 -- is
6038 -- DECLARATIVE_PART
6039 -- begin
6040 -- HANDLED_SEQUENCE_OF_STATEMENTS
6041 -- end [task_IDENTIFIER];
6043 -- Gigi restriction: This node never appears
6045 -- N_Task_Body
6046 -- Sloc points to TASK
6047 -- Defining_Identifier
6048 -- Declarations
6049 -- Handled_Statement_Sequence
6050 -- Is_Task_Master
6051 -- Activation_Chain_Entity
6052 -- Corresponding_Spec
6053 -- Was_Originally_Stub
6055 -------------------------------------
6056 -- 9.4 Protected Type Declaration --
6057 -------------------------------------
6059 -- PROTECTED_TYPE_DECLARATION ::=
6060 -- protected type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
6061 -- [ASPECT_SPECIFICATIONS]
6062 -- is [new INTERFACE_LIST with] PROTECTED_DEFINITION;
6064 -- Note: protected type declarations are not permitted in Ada 83 mode
6066 -- N_Protected_Type_Declaration
6067 -- Sloc points to PROTECTED
6068 -- Defining_Identifier
6069 -- Discriminant_Specifications (set to No_List if no
6070 -- discriminant part)
6071 -- Interface_List (set to No_List if none)
6072 -- Protected_Definition
6073 -- Corresponding_Body
6075 ---------------------------------------
6076 -- 9.4 Single Protected Declaration --
6077 ---------------------------------------
6079 -- SINGLE_PROTECTED_DECLARATION ::=
6080 -- protected DEFINING_IDENTIFIER
6081 -- [ASPECT_SPECIFICATIONS]
6082 -- is [new INTERFACE_LIST with] PROTECTED_DEFINITION;
6084 -- Note: single protected declarations are not allowed in Ada 83 mode
6086 -- N_Single_Protected_Declaration
6087 -- Sloc points to PROTECTED
6088 -- Defining_Identifier
6089 -- Interface_List (set to No_List if none)
6090 -- Protected_Definition
6092 -------------------------------
6093 -- 9.4 Protected Definition --
6094 -------------------------------
6096 -- PROTECTED_DEFINITION ::=
6097 -- {PROTECTED_OPERATION_DECLARATION}
6098 -- [private
6099 -- {PROTECTED_ELEMENT_DECLARATION}]
6100 -- end [protected_IDENTIFIER]
6102 -- N_Protected_Definition
6103 -- Sloc points to first token of protected definition
6104 -- Visible_Declarations
6105 -- Private_Declarations (set to No_List if no private part)
6106 -- End_Label
6108 ------------------------------------------
6109 -- 9.4 Protected Operation Declaration --
6110 ------------------------------------------
6112 -- PROTECTED_OPERATION_DECLARATION ::=
6113 -- SUBPROGRAM_DECLARATION
6114 -- | ENTRY_DECLARATION
6115 -- | REPRESENTATION_CLAUSE
6117 ----------------------------------------
6118 -- 9.4 Protected Element Declaration --
6119 ----------------------------------------
6121 -- PROTECTED_ELEMENT_DECLARATION ::=
6122 -- PROTECTED_OPERATION_DECLARATION | COMPONENT_DECLARATION
6124 -------------------------
6125 -- 9.4 Protected Body --
6126 -------------------------
6128 -- PROTECTED_BODY ::=
6129 -- protected body DEFINING_IDENTIFIER
6130 -- [ASPECT_SPECIFICATIONS];
6131 -- is
6132 -- {PROTECTED_OPERATION_ITEM}
6133 -- end [protected_IDENTIFIER];
6135 -- Note: protected bodies are not allowed in Ada 83 mode
6137 -- Gigi restriction: This node never appears
6139 -- N_Protected_Body
6140 -- Sloc points to PROTECTED
6141 -- Defining_Identifier
6142 -- Declarations protected operation items (and pragmas)
6143 -- End_Label
6144 -- Corresponding_Spec
6145 -- Was_Originally_Stub
6147 -----------------------------------
6148 -- 9.4 Protected Operation Item --
6149 -----------------------------------
6151 -- PROTECTED_OPERATION_ITEM ::=
6152 -- SUBPROGRAM_DECLARATION
6153 -- | SUBPROGRAM_BODY
6154 -- | ENTRY_BODY
6155 -- | REPRESENTATION_CLAUSE
6157 ------------------------------
6158 -- 9.5.2 Entry Declaration --
6159 ------------------------------
6161 -- ENTRY_DECLARATION ::=
6162 -- [[not] overriding]
6163 -- entry DEFINING_IDENTIFIER
6164 -- [(DISCRETE_SUBTYPE_DEFINITION)] PARAMETER_PROFILE
6165 -- [ASPECT_SPECIFICATIONS];
6167 -- N_Entry_Declaration
6168 -- Sloc points to ENTRY
6169 -- Defining_Identifier
6170 -- Discrete_Subtype_Definition (set to Empty if not present)
6171 -- Parameter_Specifications (set to No_List if no formal part)
6172 -- Corresponding_Body
6173 -- Must_Override set if overriding indicator present
6174 -- Must_Not_Override set if not_overriding indicator present
6176 -- Note: overriding indicator is an Ada 2005 feature
6178 -----------------------------
6179 -- 9.5.2 Accept statement --
6180 -----------------------------
6182 -- ACCEPT_STATEMENT ::=
6183 -- accept entry_DIRECT_NAME
6184 -- [(ENTRY_INDEX)] PARAMETER_PROFILE [do
6185 -- HANDLED_SEQUENCE_OF_STATEMENTS
6186 -- end [entry_IDENTIFIER]];
6188 -- Gigi restriction: This node never appears
6190 -- Note: there are no explicit declarations allowed in an accept
6191 -- statement. However, the implicit declarations for any statement
6192 -- identifiers (labels and block/loop identifiers) are declarations
6193 -- that belong logically to the accept statement, and that is why
6194 -- there is a Declarations field in this node.
6196 -- N_Accept_Statement
6197 -- Sloc points to ACCEPT
6198 -- Entry_Direct_Name
6199 -- Entry_Index (set to Empty if not present)
6200 -- Parameter_Specifications (set to No_List if no formal part)
6201 -- Handled_Statement_Sequence
6202 -- Declarations (set to No_List if no declarations)
6204 ------------------------
6205 -- 9.5.2 Entry Index --
6206 ------------------------
6208 -- ENTRY_INDEX ::= EXPRESSION
6210 -----------------------
6211 -- 9.5.2 Entry Body --
6212 -----------------------
6214 -- ENTRY_BODY ::=
6215 -- entry DEFINING_IDENTIFIER ENTRY_BODY_FORMAL_PART ENTRY_BARRIER is
6216 -- DECLARATIVE_PART
6217 -- begin
6218 -- HANDLED_SEQUENCE_OF_STATEMENTS
6219 -- end [entry_IDENTIFIER];
6221 -- ENTRY_BARRIER ::= when CONDITION
6223 -- Note: we store the CONDITION of the ENTRY_BARRIER in the node for
6224 -- the ENTRY_BODY_FORMAL_PART to avoid the N_Entry_Body node getting
6225 -- too full (it would otherwise have too many fields)
6227 -- Gigi restriction: This node never appears
6229 -- N_Entry_Body
6230 -- Sloc points to ENTRY
6231 -- Defining_Identifier
6232 -- Entry_Body_Formal_Part
6233 -- Declarations
6234 -- Handled_Statement_Sequence
6235 -- Activation_Chain_Entity
6236 -- Corresponding_Spec
6237 -- At_End_Proc (set to Empty if no clean up procedure)
6239 -----------------------------------
6240 -- 9.5.2 Entry Body Formal Part --
6241 -----------------------------------
6243 -- ENTRY_BODY_FORMAL_PART ::=
6244 -- [(ENTRY_INDEX_SPECIFICATION)] PARAMETER_PROFILE
6246 -- Note that an entry body formal part node is present even if it is
6247 -- empty. This reflects the grammar, in which it is the components of
6248 -- the entry body formal part that are optional, not the entry body
6249 -- formal part itself. Also this means that the barrier condition
6250 -- always has somewhere to be stored.
6252 -- Gigi restriction: This node never appears
6254 -- N_Entry_Body_Formal_Part
6255 -- Sloc points to first token
6256 -- Entry_Index_Specification (set to Empty if not present)
6257 -- Parameter_Specifications (set to No_List if no formal part)
6258 -- Condition from entry barrier of entry body
6260 --------------------------
6261 -- 9.5.2 Entry Barrier --
6262 --------------------------
6264 -- ENTRY_BARRIER ::= when CONDITION
6266 --------------------------------------
6267 -- 9.5.2 Entry Index Specification --
6268 --------------------------------------
6270 -- ENTRY_INDEX_SPECIFICATION ::=
6271 -- for DEFINING_IDENTIFIER in DISCRETE_SUBTYPE_DEFINITION
6273 -- Gigi restriction: This node never appears
6275 -- N_Entry_Index_Specification
6276 -- Sloc points to FOR
6277 -- Defining_Identifier
6278 -- Discrete_Subtype_Definition
6280 ---------------------------------
6281 -- 9.5.3 Entry Call Statement --
6282 ---------------------------------
6284 -- ENTRY_CALL_STATEMENT ::= entry_NAME [ACTUAL_PARAMETER_PART];
6286 -- The parser may generate a procedure call for this construct. The
6287 -- semantic pass must correct this misidentification where needed.
6289 -- Gigi restriction: This node never appears
6291 -- N_Entry_Call_Statement
6292 -- Sloc points to first token of name
6293 -- Name
6294 -- Parameter_Associations (set to No_List if no
6295 -- actual parameter part)
6296 -- First_Named_Actual
6297 -- Is_Elaboration_Checks_OK_Node
6298 -- Is_SPARK_Mode_On_Node
6299 -- Is_Elaboration_Warnings_OK_Node
6301 ------------------------------
6302 -- 9.5.4 Requeue Statement --
6303 ------------------------------
6305 -- REQUEUE_STATEMENT ::= requeue entry_NAME [with abort];
6307 -- Note: requeue statements are not permitted in Ada 83 mode
6309 -- Gigi restriction: This node never appears
6311 -- N_Requeue_Statement
6312 -- Sloc points to REQUEUE
6313 -- Name
6314 -- Abort_Present
6315 -- Is_Elaboration_Checks_OK_Node
6316 -- Is_SPARK_Mode_On_Node
6317 -- Is_Elaboration_Warnings_OK_Node
6319 --------------------------
6320 -- 9.6 Delay Statement --
6321 --------------------------
6323 -- DELAY_STATEMENT ::=
6324 -- DELAY_UNTIL_STATEMENT
6325 -- | DELAY_RELATIVE_STATEMENT
6327 --------------------------------
6328 -- 9.6 Delay Until Statement --
6329 --------------------------------
6331 -- DELAY_UNTIL_STATEMENT ::= delay until delay_EXPRESSION;
6333 -- Note: delay until statements are not permitted in Ada 83 mode
6335 -- Gigi restriction: This node never appears
6337 -- N_Delay_Until_Statement
6338 -- Sloc points to DELAY
6339 -- Expression
6341 -----------------------------------
6342 -- 9.6 Delay Relative Statement --
6343 -----------------------------------
6345 -- DELAY_RELATIVE_STATEMENT ::= delay delay_EXPRESSION;
6347 -- Gigi restriction: This node never appears
6349 -- N_Delay_Relative_Statement
6350 -- Sloc points to DELAY
6351 -- Expression
6353 ---------------------------
6354 -- 9.7 Select Statement --
6355 ---------------------------
6357 -- SELECT_STATEMENT ::=
6358 -- SELECTIVE_ACCEPT
6359 -- | TIMED_ENTRY_CALL
6360 -- | CONDITIONAL_ENTRY_CALL
6361 -- | ASYNCHRONOUS_SELECT
6363 -----------------------------
6364 -- 9.7.1 Selective Accept --
6365 -----------------------------
6367 -- SELECTIVE_ACCEPT ::=
6368 -- select
6369 -- [GUARD]
6370 -- SELECT_ALTERNATIVE
6371 -- {or
6372 -- [GUARD]
6373 -- SELECT_ALTERNATIVE}
6374 -- [else
6375 -- SEQUENCE_OF_STATEMENTS]
6376 -- end select;
6378 -- Gigi restriction: This node never appears
6380 -- Note: the guard expression, if present, appears in the node for
6381 -- the select alternative.
6383 -- N_Selective_Accept
6384 -- Sloc points to SELECT
6385 -- Select_Alternatives
6386 -- Else_Statements (set to No_List if no else part)
6388 ------------------
6389 -- 9.7.1 Guard --
6390 ------------------
6392 -- GUARD ::= when CONDITION =>
6394 -- As noted above, the CONDITION that is part of a GUARD is included
6395 -- in the node for the select alternative for convenience.
6397 -------------------------------
6398 -- 9.7.1 Select Alternative --
6399 -------------------------------
6401 -- SELECT_ALTERNATIVE ::=
6402 -- ACCEPT_ALTERNATIVE
6403 -- | DELAY_ALTERNATIVE
6404 -- | TERMINATE_ALTERNATIVE
6406 -------------------------------
6407 -- 9.7.1 Accept Alternative --
6408 -------------------------------
6410 -- ACCEPT_ALTERNATIVE ::=
6411 -- ACCEPT_STATEMENT [SEQUENCE_OF_STATEMENTS]
6413 -- Gigi restriction: This node never appears
6415 -- N_Accept_Alternative
6416 -- Sloc points to ACCEPT
6417 -- Accept_Statement
6418 -- Condition from the guard (set to Empty if no guard present)
6419 -- Statements (set to Empty_List if no statements)
6420 -- Pragmas_Before pragmas before alt (set to No_List if none)
6421 -- Accept_Handler_Records
6423 ------------------------------
6424 -- 9.7.1 Delay Alternative --
6425 ------------------------------
6427 -- DELAY_ALTERNATIVE ::=
6428 -- DELAY_STATEMENT [SEQUENCE_OF_STATEMENTS]
6430 -- Gigi restriction: This node never appears
6432 -- N_Delay_Alternative
6433 -- Sloc points to DELAY
6434 -- Delay_Statement
6435 -- Condition from the guard (set to Empty if no guard present)
6436 -- Statements (set to Empty_List if no statements)
6437 -- Pragmas_Before pragmas before alt (set to No_List if none)
6439 ----------------------------------
6440 -- 9.7.1 Terminate Alternative --
6441 ----------------------------------
6443 -- TERMINATE_ALTERNATIVE ::= terminate;
6445 -- Gigi restriction: This node never appears
6447 -- N_Terminate_Alternative
6448 -- Sloc points to TERMINATE
6449 -- Condition from the guard (set to Empty if no guard present)
6450 -- Pragmas_Before pragmas before alt (set to No_List if none)
6451 -- Pragmas_After pragmas after alt (set to No_List if none)
6453 -----------------------------
6454 -- 9.7.2 Timed Entry Call --
6455 -----------------------------
6457 -- TIMED_ENTRY_CALL ::=
6458 -- select
6459 -- ENTRY_CALL_ALTERNATIVE
6460 -- or
6461 -- DELAY_ALTERNATIVE
6462 -- end select;
6464 -- Gigi restriction: This node never appears
6466 -- N_Timed_Entry_Call
6467 -- Sloc points to SELECT
6468 -- Entry_Call_Alternative
6469 -- Delay_Alternative
6471 -----------------------------------
6472 -- 9.7.2 Entry Call Alternative --
6473 -----------------------------------
6475 -- ENTRY_CALL_ALTERNATIVE ::=
6476 -- PROCEDURE_OR_ENTRY_CALL [SEQUENCE_OF_STATEMENTS]
6478 -- PROCEDURE_OR_ENTRY_CALL ::=
6479 -- PROCEDURE_CALL_STATEMENT | ENTRY_CALL_STATEMENT
6481 -- Gigi restriction: This node never appears
6483 -- N_Entry_Call_Alternative
6484 -- Sloc points to first token of entry call statement
6485 -- Entry_Call_Statement
6486 -- Statements (set to Empty_List if no statements)
6487 -- Pragmas_Before pragmas before alt (set to No_List if none)
6489 -----------------------------------
6490 -- 9.7.3 Conditional Entry Call --
6491 -----------------------------------
6493 -- CONDITIONAL_ENTRY_CALL ::=
6494 -- select
6495 -- ENTRY_CALL_ALTERNATIVE
6496 -- else
6497 -- SEQUENCE_OF_STATEMENTS
6498 -- end select;
6500 -- Gigi restriction: This node never appears
6502 -- N_Conditional_Entry_Call
6503 -- Sloc points to SELECT
6504 -- Entry_Call_Alternative
6505 -- Else_Statements
6507 --------------------------------
6508 -- 9.7.4 Asynchronous Select --
6509 --------------------------------
6511 -- ASYNCHRONOUS_SELECT ::=
6512 -- select
6513 -- TRIGGERING_ALTERNATIVE
6514 -- then abort
6515 -- ABORTABLE_PART
6516 -- end select;
6518 -- Note: asynchronous select is not permitted in Ada 83 mode
6520 -- Gigi restriction: This node never appears
6522 -- N_Asynchronous_Select
6523 -- Sloc points to SELECT
6524 -- Triggering_Alternative
6525 -- Abortable_Part
6527 -----------------------------------
6528 -- 9.7.4 Triggering Alternative --
6529 -----------------------------------
6531 -- TRIGGERING_ALTERNATIVE ::=
6532 -- TRIGGERING_STATEMENT [SEQUENCE_OF_STATEMENTS]
6534 -- Gigi restriction: This node never appears
6536 -- N_Triggering_Alternative
6537 -- Sloc points to first token of triggering statement
6538 -- Triggering_Statement
6539 -- Statements (set to Empty_List if no statements)
6540 -- Pragmas_Before pragmas before alt (set to No_List if none)
6542 ---------------------------------
6543 -- 9.7.4 Triggering Statement --
6544 ---------------------------------
6546 -- TRIGGERING_STATEMENT ::= PROCEDURE_OR_ENTRY_CALL | DELAY_STATEMENT
6548 ---------------------------
6549 -- 9.7.4 Abortable Part --
6550 ---------------------------
6552 -- ABORTABLE_PART ::= SEQUENCE_OF_STATEMENTS
6554 -- Gigi restriction: This node never appears
6556 -- N_Abortable_Part
6557 -- Sloc points to ABORT
6558 -- Statements
6560 --------------------------
6561 -- 9.8 Abort Statement --
6562 --------------------------
6564 -- ABORT_STATEMENT ::= abort task_NAME {, task_NAME};
6566 -- Gigi restriction: This node never appears
6568 -- N_Abort_Statement
6569 -- Sloc points to ABORT
6570 -- Names
6572 -------------------------
6573 -- 10.1.1 Compilation --
6574 -------------------------
6576 -- COMPILATION ::= {COMPILATION_UNIT}
6578 -- There is no explicit node in the tree for a compilation, since in
6579 -- general the compiler is processing only a single compilation unit
6580 -- at a time. It is possible to parse multiple units in syntax check
6581 -- only mode, but the trees are discarded in that case.
6583 ------------------------------
6584 -- 10.1.1 Compilation Unit --
6585 ------------------------------
6587 -- COMPILATION_UNIT ::=
6588 -- CONTEXT_CLAUSE LIBRARY_ITEM
6589 -- | CONTEXT_CLAUSE SUBUNIT
6591 -- The N_Compilation_Unit node itself represents the above syntax.
6592 -- However, there are two additional items not reflected in the above
6593 -- syntax. First we have the global declarations that are added by the
6594 -- code generator. These are outer level declarations (so they cannot
6595 -- be represented as being inside the units). An example is the wrapper
6596 -- subprograms that are created to do ABE checking. As always a list of
6597 -- declarations can contain actions as well (i.e. statements), and such
6598 -- statements are executed as part of the elaboration of the unit. Note
6599 -- that all such declarations are elaborated before the library unit.
6601 -- Similarly, certain actions need to be elaborated at the completion
6602 -- of elaboration of the library unit (notably the statement that sets
6603 -- the Boolean flag indicating that elaboration is complete).
6605 -- The third item not reflected in the syntax is pragmas that appear
6606 -- after the compilation unit. As always pragmas are a problem since
6607 -- they are not part of the formal syntax, but can be stuck into the
6608 -- source following a set of ad hoc rules, and we have to find an ad
6609 -- hoc way of sticking them into the tree. For pragmas that appear
6610 -- before the library unit, we just consider them to be part of the
6611 -- context clause, and pragmas can appear in the Context_Items list
6612 -- of the compilation unit. However, pragmas can also appear after
6613 -- the library item.
6615 -- To deal with all these problems, we create an auxiliary node for
6616 -- a compilation unit, referenced from the N_Compilation_Unit node,
6617 -- that contains these items.
6619 -- N_Compilation_Unit
6620 -- Sloc points to first token of defining unit name
6621 -- Context_Items context items and pragmas preceding unit
6622 -- Private_Present set if library unit has private keyword
6623 -- Unit library item or subunit
6624 -- Aux_Decls_Node points to the N_Compilation_Unit_Aux node
6625 -- First_Inlined_Subprogram
6626 -- Library_Unit corresponding/parent spec/body
6627 -- Save_Invocation_Graph_Of_Body
6628 -- Acts_As_Spec flag for subprogram body with no spec
6629 -- Body_Required set for spec if body is required
6630 -- Has_Pragma_Suppress_All
6631 -- Context_Pending
6632 -- Has_No_Elaboration_Code
6634 -- N_Compilation_Unit_Aux
6635 -- Sloc is a copy of the Sloc from the N_Compilation_Unit node
6636 -- Declarations (set to No_List if no global declarations)
6637 -- Actions (set to No_List if no actions)
6638 -- Pragmas_After pragmas after unit (set to No_List if none)
6639 -- Config_Pragmas config pragmas (set to Empty_List if none)
6640 -- Default_Storage_Pool
6642 --------------------------
6643 -- 10.1.1 Library Item --
6644 --------------------------
6646 -- LIBRARY_ITEM ::=
6647 -- [private] LIBRARY_UNIT_DECLARATION
6648 -- | LIBRARY_UNIT_BODY
6649 -- | [private] LIBRARY_UNIT_RENAMING_DECLARATION
6651 -- Note: PRIVATE is not allowed in Ada 83 mode
6653 -- There is no explicit node in the tree for library item, instead
6654 -- the declaration or body, and the flag for private if present,
6655 -- appear in the N_Compilation_Unit node.
6657 --------------------------------------
6658 -- 10.1.1 Library Unit Declaration --
6659 --------------------------------------
6661 -- LIBRARY_UNIT_DECLARATION ::=
6662 -- SUBPROGRAM_DECLARATION | PACKAGE_DECLARATION
6663 -- | GENERIC_DECLARATION | GENERIC_INSTANTIATION
6665 -----------------------------------------------
6666 -- 10.1.1 Library Unit Renaming Declaration --
6667 -----------------------------------------------
6669 -- LIBRARY_UNIT_RENAMING_DECLARATION ::=
6670 -- PACKAGE_RENAMING_DECLARATION
6671 -- | GENERIC_RENAMING_DECLARATION
6672 -- | SUBPROGRAM_RENAMING_DECLARATION
6674 -------------------------------
6675 -- 10.1.1 Library unit body --
6676 -------------------------------
6678 -- LIBRARY_UNIT_BODY ::= SUBPROGRAM_BODY | PACKAGE_BODY
6680 ------------------------------
6681 -- 10.1.1 Parent Unit Name --
6682 ------------------------------
6684 -- PARENT_UNIT_NAME ::= NAME
6686 ----------------------------
6687 -- 10.1.2 Context clause --
6688 ----------------------------
6690 -- CONTEXT_CLAUSE ::= {CONTEXT_ITEM}
6692 -- The context clause can include pragmas, and any pragmas that appear
6693 -- before the context clause proper (i.e. all configuration pragmas,
6694 -- also appear at the front of this list).
6696 --------------------------
6697 -- 10.1.2 Context_Item --
6698 --------------------------
6700 -- CONTEXT_ITEM ::= WITH_CLAUSE | USE_CLAUSE | WITH_TYPE_CLAUSE
6702 -------------------------
6703 -- 10.1.2 With clause --
6704 -------------------------
6706 -- WITH_CLAUSE ::=
6707 -- with library_unit_NAME {,library_unit_NAME};
6709 -- A separate With clause is built for each name, so that we have
6710 -- a Corresponding_Spec field for each with'ed spec. The flags
6711 -- First_Name and Last_Name are used to reconstruct the exact
6712 -- source form. When a list of names appears in one with clause,
6713 -- the first name in the list has First_Name set, and the last
6714 -- has Last_Name set. If the with clause has only one name, then
6715 -- both of the flags First_Name and Last_Name are set in this name.
6717 -- Note: in the case of implicit with's that are installed by the
6718 -- Rtsfind routine, Implicit_With is set, and the Sloc is typically
6719 -- set to Standard_Location, but it is incorrect to test the Sloc
6720 -- to find out if a with clause is implicit, test the flag instead.
6722 -- N_With_Clause
6723 -- Sloc points to first token of library unit name
6724 -- Name
6725 -- Private_Present set if with_clause has private keyword
6726 -- Limited_Present set if LIMITED is present
6727 -- Next_Implicit_With
6728 -- Library_Unit
6729 -- Corresponding_Spec
6730 -- First_Name (set to True if first name or only one name)
6731 -- Last_Name (set to True if last name or only one name)
6732 -- Context_Installed
6733 -- Elaborate_Present
6734 -- Elaborate_All_Present
6735 -- Elaborate_All_Desirable
6736 -- Elaborate_Desirable
6737 -- Implicit_With
6738 -- Limited_View_Installed
6739 -- Parent_With
6740 -- Unreferenced_In_Spec
6741 -- No_Entities_Ref_In_Spec
6743 -- Note: Limited_Present and Limited_View_Installed are used to support
6744 -- the implementation of Ada 2005 (AI-50217).
6746 -- Similarly, Private_Present is used to support the implementation of
6747 -- Ada 2005 (AI-50262).
6749 -- Note: if the WITH clause refers to a standard library unit, then a
6750 -- limited with clause is changed into a normal with clause, because we
6751 -- are not prepared to deal with limited with in the context of Rtsfind.
6752 -- So in this case, the Limited_Present flag will be False in the final
6753 -- tree.
6755 ----------------------
6756 -- With_Type clause --
6757 ----------------------
6759 -- This is a GNAT extension, used to implement mutually recursive
6760 -- types declared in different packages.
6762 -- Note: this is now obsolete. The functionality of this construct
6763 -- is now implemented by the Ada 2005 limited_with_clause.
6765 ---------------------
6766 -- 10.2 Body stub --
6767 ---------------------
6769 -- BODY_STUB ::=
6770 -- SUBPROGRAM_BODY_STUB
6771 -- | PACKAGE_BODY_STUB
6772 -- | TASK_BODY_STUB
6773 -- | PROTECTED_BODY_STUB
6775 ----------------------------------
6776 -- 10.1.3 Subprogram Body Stub --
6777 ----------------------------------
6779 -- SUBPROGRAM_BODY_STUB ::=
6780 -- SUBPROGRAM_SPECIFICATION is separate
6781 -- [ASPECT_SPECIFICATION];
6783 -- N_Subprogram_Body_Stub
6784 -- Sloc points to FUNCTION or PROCEDURE
6785 -- Specification
6786 -- Corresponding_Spec_Of_Stub
6787 -- Library_Unit points to the subunit
6788 -- Corresponding_Body
6789 -- At_End_Proc (set to Empty if no clean up procedure)
6791 -------------------------------
6792 -- 10.1.3 Package Body Stub --
6793 -------------------------------
6795 -- PACKAGE_BODY_STUB ::=
6796 -- package body DEFINING_IDENTIFIER is separate
6797 -- [ASPECT_SPECIFICATION];
6799 -- N_Package_Body_Stub
6800 -- Sloc points to PACKAGE
6801 -- Defining_Identifier
6802 -- Corresponding_Spec_Of_Stub
6803 -- Library_Unit points to the subunit
6804 -- Corresponding_Body
6806 ----------------------------
6807 -- 10.1.3 Task Body Stub --
6808 ----------------------------
6810 -- TASK_BODY_STUB ::=
6811 -- task body DEFINING_IDENTIFIER is separate
6812 -- [ASPECT_SPECIFICATION];
6814 -- N_Task_Body_Stub
6815 -- Sloc points to TASK
6816 -- Defining_Identifier
6817 -- Corresponding_Spec_Of_Stub
6818 -- Library_Unit points to the subunit
6819 -- Corresponding_Body
6820 -- At_End_Proc (set to Empty if no clean up procedure)
6822 ---------------------------------
6823 -- 10.1.3 Protected Body Stub --
6824 ---------------------------------
6826 -- PROTECTED_BODY_STUB ::=
6827 -- protected body DEFINING_IDENTIFIER is separate
6828 -- [ASPECT_SPECIFICATION];
6830 -- Note: protected body stubs are not allowed in Ada 83 mode
6832 -- N_Protected_Body_Stub
6833 -- Sloc points to PROTECTED
6834 -- Defining_Identifier
6835 -- Corresponding_Spec_Of_Stub
6836 -- Library_Unit points to the subunit
6837 -- Corresponding_Body
6839 ---------------------
6840 -- 10.1.3 Subunit --
6841 ---------------------
6843 -- SUBUNIT ::= separate (PARENT_UNIT_NAME) PROPER_BODY
6845 -- N_Subunit
6846 -- Sloc points to SEPARATE
6847 -- Name is the name of the parent unit
6848 -- Proper_Body is the subunit body
6849 -- Corresponding_Stub is the stub declaration for the unit.
6851 ---------------------------------
6852 -- 11.1 Exception Declaration --
6853 ---------------------------------
6855 -- EXCEPTION_DECLARATION ::= DEFINING_IDENTIFIER_LIST : exception
6856 -- [ASPECT_SPECIFICATIONS];
6858 -- For consistency with object declarations etc., the parser converts
6859 -- the case of multiple identifiers being declared to a series of
6860 -- declarations in which the expression is copied, using the More_Ids
6861 -- and Prev_Ids flags to remember the source form as described in the
6862 -- section on "Handling of Defining Identifier Lists".
6864 -- N_Exception_Declaration
6865 -- Sloc points to EXCEPTION
6866 -- Defining_Identifier
6867 -- Expression
6868 -- Renaming_Exception
6869 -- More_Ids (set to False if no more identifiers in list)
6870 -- Prev_Ids (set to False if no previous identifiers in list)
6872 ------------------------------------------
6873 -- 11.2 Handled Sequence Of Statements --
6874 ------------------------------------------
6876 -- HANDLED_SEQUENCE_OF_STATEMENTS ::=
6877 -- SEQUENCE_OF_STATEMENTS
6878 -- [exception
6879 -- EXCEPTION_HANDLER
6880 -- {EXCEPTION_HANDLER}]
6881 -- [at end
6882 -- cleanup_procedure_call (param, param, param, ...);]
6884 -- The AT END phrase is a GNAT extension to provide for cleanups. It is
6885 -- used only internally currently, but is considered to be syntactic.
6886 -- At the moment, the only cleanup action allowed is a single call to a
6887 -- parameterless procedure; this restriction could be lifted if we make
6888 -- some changes in gigi. The At_End_Proc field is an N_Identifier node
6889 -- that denotes the procedure to be called. The cleanup action occurs
6890 -- whenever the sequence of statements is left for any reason. The
6891 -- possible reasons are:
6893 -- 1. reaching the end of the sequence
6894 -- 2. exit, return, or goto
6895 -- 3. exception or abort
6897 -- The cleanup action also occurs whenever the exception handlers are
6898 -- left.
6900 -- The AT END cleanup handler protects only the sequence of statements
6901 -- and the exception handlers (not the associated declarations of
6902 -- the parent), just like exception handlers do not protect the
6903 -- declarations. The big difference is that the cleanup actions occur
6904 -- on either a normal or an abnormal exit from the statement sequence.
6906 -- At_End_Proc is also a field of various nodes that can contain
6907 -- both Declarations and Handled_Statement_Sequence, such as subprogram
6908 -- bodies and block statements. In that case, the At_End_Proc
6909 -- protects the Declarations as well as the Handled_Statement_Sequence.
6911 -- Note: the list of Exception_Handlers can contain pragmas as well
6912 -- as actual handlers. In practice these pragmas can only occur at
6913 -- the start of the list, since any pragmas occurring later on will
6914 -- be included in the statement list of the corresponding handler.
6916 -- Note: although in the Ada syntax, the sequence of statements in
6917 -- a handled sequence of statements can only contain statements, we
6918 -- allow free mixing of declarations and statements in the resulting
6919 -- expanded tree. This is for example used to deal with the case of
6920 -- a cleanup procedure that must handle declarations as well as the
6921 -- statements of a block.
6923 -- Note: the cleanup_procedure_call does not go through the common
6924 -- processing for calls, which in particular means that it will not be
6925 -- automatically inlined in all cases, even though the procedure to be
6926 -- called is marked inline. More specifically, if the procedure comes
6927 -- from another unit than the main source unit, for example a run-time
6928 -- unit, then it needs to be manually added to the list of bodies to be
6929 -- inlined by invoking Add_Inlined_Body on it.
6931 -- N_Handled_Sequence_Of_Statements
6932 -- Sloc points to first token of first statement
6933 -- Statements
6934 -- End_Label (set to Empty if expander generated)
6935 -- Exception_Handlers (set to No_List if none present)
6936 -- At_End_Proc (set to Empty if no clean up procedure)
6938 -- Note: A Handled_Sequence_Of_Statements can contain both
6939 -- Exception_Handlers and an At_End_Proc.
6941 -- Note: the parent always contains a Declarations field which contains
6942 -- declarations associated with the handled sequence of statements. This
6943 -- is true even in the case of an accept statement (see description of
6944 -- the N_Accept_Statement node).
6946 -- End_Label refers to the containing construct
6948 -----------------------------
6949 -- 11.2 Exception Handler --
6950 -----------------------------
6952 -- EXCEPTION_HANDLER ::=
6953 -- when [CHOICE_PARAMETER_SPECIFICATION :]
6954 -- EXCEPTION_CHOICE {| EXCEPTION_CHOICE} =>
6955 -- SEQUENCE_OF_STATEMENTS
6957 -- Note: choice parameter specification is not allowed in Ada 83 mode
6959 -- N_Exception_Handler
6960 -- Sloc points to WHEN
6961 -- Choice_Parameter (set to Empty if not present)
6962 -- Exception_Choices
6963 -- Statements
6964 -- Exception_Label (set to Empty if not present)
6965 -- Local_Raise_Statements (set to No_Elist if not present)
6966 -- Local_Raise_Not_OK
6967 -- Has_Local_Raise
6969 ------------------------------------------
6970 -- 11.2 Choice parameter specification --
6971 ------------------------------------------
6973 -- CHOICE_PARAMETER_SPECIFICATION ::= DEFINING_IDENTIFIER
6975 ----------------------------
6976 -- 11.2 Exception Choice --
6977 ----------------------------
6979 -- EXCEPTION_CHOICE ::= exception_NAME | others
6981 -- Except in the case of OTHERS, no explicit node appears in the tree
6982 -- for exception choice. Instead the exception name appears directly.
6983 -- An OTHERS choice is represented by a N_Others_Choice node (see
6984 -- section 3.8.1.
6986 -- Note: for the exception choice created for an at end handler, the
6987 -- exception choice is an N_Others_Choice node with All_Others set.
6989 ---------------------------
6990 -- 11.3 Raise Statement --
6991 ---------------------------
6993 -- RAISE_STATEMENT ::= raise [exception_NAME];
6995 -- In Ada 2005, we have
6997 -- RAISE_STATEMENT ::=
6998 -- raise; | raise exception_NAME [with string_EXPRESSION];
7000 -- N_Raise_Statement
7001 -- Sloc points to RAISE
7002 -- Name (set to Empty if no exception name present)
7003 -- Expression (set to Empty if no expression present)
7005 ----------------------------
7006 -- 11.3 Raise Expression --
7007 ----------------------------
7009 -- RAISE_EXPRESSION ::= raise exception_NAME [with string_EXPRESSION]
7011 -- N_Raise_Expression
7012 -- Sloc points to RAISE
7013 -- Name (always present)
7014 -- Expression (set to Empty if no expression present)
7015 -- plus fields for expression
7017 -------------------------------
7018 -- 12.1 Generic Declaration --
7019 -------------------------------
7021 -- GENERIC_DECLARATION ::=
7022 -- GENERIC_SUBPROGRAM_DECLARATION | GENERIC_PACKAGE_DECLARATION
7024 ------------------------------------------
7025 -- 12.1 Generic Subprogram Declaration --
7026 ------------------------------------------
7028 -- GENERIC_SUBPROGRAM_DECLARATION ::=
7029 -- GENERIC_FORMAL_PART SUBPROGRAM_SPECIFICATION
7030 -- [ASPECT_SPECIFICATIONS];
7032 -- Note: Generic_Formal_Declarations can include pragmas
7034 -- N_Generic_Subprogram_Declaration
7035 -- Sloc points to GENERIC
7036 -- Specification subprogram specification
7037 -- Corresponding_Body
7038 -- Generic_Formal_Declarations from generic formal part
7039 -- Parent_Spec
7041 ---------------------------------------
7042 -- 12.1 Generic Package Declaration --
7043 ---------------------------------------
7045 -- GENERIC_PACKAGE_DECLARATION ::=
7046 -- GENERIC_FORMAL_PART PACKAGE_SPECIFICATION
7047 -- [ASPECT_SPECIFICATIONS];
7049 -- Note: when we do generics right, the Activation_Chain_Entity entry
7050 -- for this node can be removed (since the expander won't see generic
7051 -- units any more)???.
7053 -- Note: Generic_Formal_Declarations can include pragmas
7055 -- N_Generic_Package_Declaration
7056 -- Sloc points to GENERIC
7057 -- Specification package specification
7058 -- Corresponding_Body
7059 -- Generic_Formal_Declarations from generic formal part
7060 -- Parent_Spec
7061 -- Activation_Chain_Entity
7063 -------------------------------
7064 -- 12.1 Generic Formal Part --
7065 -------------------------------
7067 -- GENERIC_FORMAL_PART ::=
7068 -- generic {GENERIC_FORMAL_PARAMETER_DECLARATION | USE_CLAUSE}
7070 ------------------------------------------------
7071 -- 12.1 Generic Formal Parameter Declaration --
7072 ------------------------------------------------
7074 -- GENERIC_FORMAL_PARAMETER_DECLARATION ::=
7075 -- FORMAL_OBJECT_DECLARATION
7076 -- | FORMAL_TYPE_DECLARATION
7077 -- | FORMAL_SUBPROGRAM_DECLARATION
7078 -- | FORMAL_PACKAGE_DECLARATION
7080 ---------------------------------
7081 -- 12.3 Generic Instantiation --
7082 ---------------------------------
7084 -- GENERIC_INSTANTIATION ::=
7085 -- package DEFINING_PROGRAM_UNIT_NAME is
7086 -- new generic_package_NAME [GENERIC_ACTUAL_PART]
7087 -- [ASPECT_SPECIFICATIONS];
7088 -- | [[not] overriding]
7089 -- procedure DEFINING_PROGRAM_UNIT_NAME is
7090 -- new generic_procedure_NAME [GENERIC_ACTUAL_PART]
7091 -- [ASPECT_SPECIFICATIONS];
7092 -- | [[not] overriding]
7093 -- function DEFINING_DESIGNATOR is
7094 -- new generic_function_NAME [GENERIC_ACTUAL_PART]
7095 -- [ASPECT_SPECIFICATIONS];
7097 -- N_Package_Instantiation
7098 -- Sloc points to PACKAGE
7099 -- Defining_Unit_Name
7100 -- Name
7101 -- Generic_Associations (set to No_List if no
7102 -- generic actual part)
7103 -- Parent_Spec
7104 -- Instance_Spec
7105 -- Is_Elaboration_Checks_OK_Node
7106 -- Is_SPARK_Mode_On_Node
7107 -- Is_Elaboration_Warnings_OK_Node
7108 -- Is_Declaration_Level_Node
7109 -- Is_Known_Guaranteed_ABE
7111 -- N_Procedure_Instantiation
7112 -- Sloc points to PROCEDURE
7113 -- Defining_Unit_Name
7114 -- Name
7115 -- Parent_Spec
7116 -- Generic_Associations (set to No_List if no
7117 -- generic actual part)
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 -- N_Function_Instantiation
7128 -- Sloc points to FUNCTION
7129 -- Defining_Unit_Name
7130 -- Name
7131 -- Generic_Associations (set to No_List if no
7132 -- generic actual part)
7133 -- Parent_Spec
7134 -- Instance_Spec
7135 -- Is_Elaboration_Checks_OK_Node
7136 -- Is_SPARK_Mode_On_Node
7137 -- Is_Elaboration_Warnings_OK_Node
7138 -- Is_Declaration_Level_Node
7139 -- Must_Override set if overriding indicator present
7140 -- Must_Not_Override set if not_overriding indicator present
7141 -- Is_Known_Guaranteed_ABE
7143 -- Note: overriding indicator is an Ada 2005 feature
7145 -------------------------------
7146 -- 12.3 Generic Actual Part --
7147 -------------------------------
7149 -- GENERIC_ACTUAL_PART ::=
7150 -- (GENERIC_ASSOCIATION {, GENERIC_ASSOCIATION})
7152 -------------------------------
7153 -- 12.3 Generic Association --
7154 -------------------------------
7156 -- GENERIC_ASSOCIATION ::=
7157 -- [generic_formal_parameter_SELECTOR_NAME =>]
7159 -- Note: unlike the procedure call case, a generic association node
7160 -- is generated for every association, even if no formal parameter
7161 -- selector name is present. In this case the parser will leave the
7162 -- Selector_Name field set to Empty, to be filled in later by the
7163 -- semantic pass.
7165 -- In Ada 2005, a formal may be associated with a box, if the
7166 -- association is part of the list of actuals for a formal package.
7167 -- If the association is given by OTHERS => <>, the association is
7168 -- an N_Others_Choice.
7170 -- N_Generic_Association
7171 -- Sloc points to first token of generic association
7172 -- Selector_Name (set to Empty if no formal
7173 -- parameter selector name)
7174 -- Explicit_Generic_Actual_Parameter (Empty if box present)
7175 -- Box_Present (for formal_package associations with a box)
7177 ---------------------------------------------
7178 -- 12.3 Explicit Generic Actual Parameter --
7179 ---------------------------------------------
7181 -- EXPLICIT_GENERIC_ACTUAL_PARAMETER ::=
7182 -- EXPRESSION | variable_NAME | subprogram_NAME
7183 -- | entry_NAME | SUBTYPE_MARK | package_instance_NAME
7185 -------------------------------------
7186 -- 12.4 Formal Object Declaration --
7187 -------------------------------------
7189 -- FORMAL_OBJECT_DECLARATION ::=
7190 -- DEFINING_IDENTIFIER_LIST :
7191 -- MODE [NULL_EXCLUSION] SUBTYPE_MARK [:= DEFAULT_EXPRESSION]
7192 -- [ASPECT_SPECIFICATIONS];
7193 -- | DEFINING_IDENTIFIER_LIST :
7194 -- MODE ACCESS_DEFINITION [:= DEFAULT_EXPRESSION]
7195 -- [ASPECT_SPECIFICATIONS];
7197 -- Although the syntax allows multiple identifiers in the list, the
7198 -- semantics is as though successive declarations were given with
7199 -- identical type definition and expression components. To simplify
7200 -- semantic processing, the parser represents a multiple declaration
7201 -- case as a sequence of single declarations, using the More_Ids and
7202 -- Prev_Ids flags to preserve the original source form as described
7203 -- in the section on "Handling of Defining Identifier Lists".
7205 -- N_Formal_Object_Declaration
7206 -- Sloc points to first identifier
7207 -- Defining_Identifier
7208 -- In_Present
7209 -- Out_Present
7210 -- Null_Exclusion_Present (set to False if not present)
7211 -- Subtype_Mark (set to Empty if not present)
7212 -- Access_Definition (set to Empty if not present)
7213 -- Default_Expression (set to Empty if no default expression)
7214 -- More_Ids (set to False if no more identifiers in list)
7215 -- Prev_Ids (set to False if no previous identifiers in list)
7217 -----------------------------------
7218 -- 12.5 Formal Type Declaration --
7219 -----------------------------------
7221 -- FORMAL_TYPE_DECLARATION ::=
7222 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART]
7223 -- is FORMAL_TYPE_DEFINITION
7224 -- [ASPECT_SPECIFICATIONS];
7225 -- | type DEFINING_IDENTIFIER [DISCRIMINANT_PART] [is tagged]
7227 -- N_Formal_Type_Declaration
7228 -- Sloc points to TYPE
7229 -- Defining_Identifier
7230 -- Formal_Type_Definition
7231 -- Discriminant_Specifications (set to No_List if no
7232 -- discriminant part)
7233 -- Unknown_Discriminants_Present set if (<>) discriminant
7234 -- Default_Subtype_Mark
7236 ----------------------------------
7237 -- 12.5 Formal type definition --
7238 ----------------------------------
7240 -- FORMAL_TYPE_DEFINITION ::=
7241 -- FORMAL_PRIVATE_TYPE_DEFINITION
7242 -- | FORMAL_DERIVED_TYPE_DEFINITION
7243 -- | FORMAL_DISCRETE_TYPE_DEFINITION
7244 -- | FORMAL_SIGNED_INTEGER_TYPE_DEFINITION
7245 -- | FORMAL_MODULAR_TYPE_DEFINITION
7246 -- | FORMAL_FLOATING_POINT_DEFINITION
7247 -- | FORMAL_ORDINARY_FIXED_POINT_DEFINITION
7248 -- | FORMAL_DECIMAL_FIXED_POINT_DEFINITION
7249 -- | FORMAL_ARRAY_TYPE_DEFINITION
7250 -- | FORMAL_ACCESS_TYPE_DEFINITION
7251 -- | FORMAL_INTERFACE_TYPE_DEFINITION
7252 -- | FORMAL_INCOMPLETE_TYPE_DEFINITION
7254 -- The Ada 2012 syntax introduces two new non-terminals:
7255 -- Formal_{Complete,Incomplete}_Type_Declaration just to introduce
7256 -- the latter category. Here we introduce an incomplete type definition
7257 -- in order to preserve as much as possible the existing structure.
7259 ---------------------------------------------
7260 -- 12.5.1 Formal Private Type Definition --
7261 ---------------------------------------------
7263 -- FORMAL_PRIVATE_TYPE_DEFINITION ::=
7264 -- [[abstract] tagged] [limited] private
7266 -- Note: TAGGED is not allowed in Ada 83 mode
7268 -- N_Formal_Private_Type_Definition
7269 -- Sloc points to PRIVATE
7270 -- Uninitialized_Variable
7271 -- Abstract_Present
7272 -- Tagged_Present
7273 -- Limited_Present
7275 --------------------------------------------
7276 -- 12.5.1 Formal Derived Type Definition --
7277 --------------------------------------------
7279 -- FORMAL_DERIVED_TYPE_DEFINITION ::=
7280 -- [abstract] [limited | synchronized]
7281 -- new SUBTYPE_MARK [[and INTERFACE_LIST] with private]
7282 -- Note: this construct is not allowed in Ada 83 mode
7284 -- N_Formal_Derived_Type_Definition
7285 -- Sloc points to NEW
7286 -- Subtype_Mark
7287 -- Private_Present
7288 -- Abstract_Present
7289 -- Limited_Present
7290 -- Synchronized_Present
7291 -- Interface_List (set to No_List if none)
7293 -----------------------------------------------
7294 -- 12.5.1 Formal Incomplete Type Definition --
7295 -----------------------------------------------
7297 -- FORMAL_INCOMPLETE_TYPE_DEFINITION ::= [tagged]
7299 -- N_Formal_Incomplete_Type_Definition
7300 -- Sloc points to identifier of parent
7301 -- Tagged_Present
7303 ---------------------------------------------
7304 -- 12.5.2 Formal Discrete Type Definition --
7305 ---------------------------------------------
7307 -- FORMAL_DISCRETE_TYPE_DEFINITION ::= (<>)
7309 -- N_Formal_Discrete_Type_Definition
7310 -- Sloc points to (
7312 ---------------------------------------------------
7313 -- 12.5.2 Formal Signed Integer Type Definition --
7314 ---------------------------------------------------
7316 -- FORMAL_SIGNED_INTEGER_TYPE_DEFINITION ::= range <>
7318 -- N_Formal_Signed_Integer_Type_Definition
7319 -- Sloc points to RANGE
7321 --------------------------------------------
7322 -- 12.5.2 Formal Modular Type Definition --
7323 --------------------------------------------
7325 -- FORMAL_MODULAR_TYPE_DEFINITION ::= mod <>
7327 -- N_Formal_Modular_Type_Definition
7328 -- Sloc points to MOD
7330 ----------------------------------------------
7331 -- 12.5.2 Formal Floating Point Definition --
7332 ----------------------------------------------
7334 -- FORMAL_FLOATING_POINT_DEFINITION ::= digits <>
7336 -- N_Formal_Floating_Point_Definition
7337 -- Sloc points to DIGITS
7339 ----------------------------------------------------
7340 -- 12.5.2 Formal Ordinary Fixed Point Definition --
7341 ----------------------------------------------------
7343 -- FORMAL_ORDINARY_FIXED_POINT_DEFINITION ::= delta <>
7345 -- N_Formal_Ordinary_Fixed_Point_Definition
7346 -- Sloc points to DELTA
7348 ---------------------------------------------------
7349 -- 12.5.2 Formal Decimal Fixed Point Definition --
7350 ---------------------------------------------------
7352 -- FORMAL_DECIMAL_FIXED_POINT_DEFINITION ::= delta <> digits <>
7354 -- Note: formal decimal fixed point definition not allowed in Ada 83
7356 -- N_Formal_Decimal_Fixed_Point_Definition
7357 -- Sloc points to DELTA
7359 ------------------------------------------
7360 -- 12.5.3 Formal Array Type Definition --
7361 ------------------------------------------
7363 -- FORMAL_ARRAY_TYPE_DEFINITION ::= ARRAY_TYPE_DEFINITION
7365 -------------------------------------------
7366 -- 12.5.4 Formal Access Type Definition --
7367 -------------------------------------------
7369 -- FORMAL_ACCESS_TYPE_DEFINITION ::= ACCESS_TYPE_DEFINITION
7371 ----------------------------------------------
7372 -- 12.5.5 Formal Interface Type Definition --
7373 ----------------------------------------------
7375 -- FORMAL_INTERFACE_TYPE_DEFINITION ::= INTERFACE_TYPE_DEFINITION
7377 -----------------------------------------
7378 -- 12.6 Formal Subprogram Declaration --
7379 -----------------------------------------
7381 -- FORMAL_SUBPROGRAM_DECLARATION ::=
7382 -- FORMAL_CONCRETE_SUBPROGRAM_DECLARATION
7383 -- | FORMAL_ABSTRACT_SUBPROGRAM_DECLARATION
7385 --------------------------------------------------
7386 -- 12.6 Formal Concrete Subprogram Declaration --
7387 --------------------------------------------------
7389 -- FORMAL_CONCRETE_SUBPROGRAM_DECLARATION ::=
7390 -- with SUBPROGRAM_SPECIFICATION [is SUBPROGRAM_DEFAULT]
7391 -- [ASPECT_SPECIFICATIONS];
7393 -- N_Formal_Concrete_Subprogram_Declaration
7394 -- Sloc points to WITH
7395 -- Specification
7396 -- Default_Name (set to Empty if no subprogram default)
7397 -- Box_Present
7398 -- Expression (set to Empty if no expression present)
7400 -- Note: If no subprogram default is present, then Name is set
7401 -- to Empty, and Box_Present is False.
7403 -- Note: The Expression field is only used for the GNAT extension
7404 -- that allows a FORMAL_CONCRETE_SUBPROGRAM_DECLARATION to specify
7405 -- an expression default for generic formal functions.
7407 --------------------------------------------------
7408 -- 12.6 Formal Abstract Subprogram Declaration --
7409 --------------------------------------------------
7411 -- FORMAL_ABSTRACT_SUBPROGRAM_DECLARATION ::=
7412 -- with SUBPROGRAM_SPECIFICATION is abstract [SUBPROGRAM_DEFAULT]
7413 -- [ASPECT_SPECIFICATIONS];
7415 -- N_Formal_Abstract_Subprogram_Declaration
7416 -- Sloc points to WITH
7417 -- Specification
7418 -- Default_Name (set to Empty if no subprogram default)
7419 -- Box_Present
7421 -- Note: if no subprogram default is present, then Name is set
7422 -- to Empty, and Box_Present is False.
7424 ------------------------------
7425 -- 12.6 Subprogram Default --
7426 ------------------------------
7428 -- SUBPROGRAM_DEFAULT ::= DEFAULT_NAME | <> | (EXPRESSION)
7430 -- There is no separate node in the tree for a subprogram default.
7431 -- Instead the parent (N_Formal_Concrete_Subprogram_Declaration
7432 -- or N_Formal_Abstract_Subprogram_Declaration) node contains the
7433 -- default name or box indication, as needed.
7435 -- Note: The syntax "(EXPRESSION)" is a GNAT extension, and allows
7436 -- a FORMAL_CONCRETE_SUBPROGRAM_DECLARATION to specify an expression
7437 -- default for formal functions, in analogy with expression_functions.
7439 ------------------------
7440 -- 12.6 Default Name --
7441 ------------------------
7443 -- DEFAULT_NAME ::= NAME
7445 --------------------------------------
7446 -- 12.7 Formal Package Declaration --
7447 --------------------------------------
7449 -- FORMAL_PACKAGE_DECLARATION ::=
7450 -- with package DEFINING_IDENTIFIER
7451 -- is new generic_package_NAME FORMAL_PACKAGE_ACTUAL_PART
7452 -- [ASPECT_SPECIFICATIONS];
7454 -- Note: formal package declarations not allowed in Ada 83 mode
7456 -- N_Formal_Package_Declaration
7457 -- Sloc points to WITH
7458 -- Defining_Identifier
7459 -- Name
7460 -- Generic_Associations (set to No_List if (<>) case or
7461 -- empty generic actual part)
7462 -- Box_Present
7463 -- Instance_Spec
7464 -- Is_Known_Guaranteed_ABE
7466 --------------------------------------
7467 -- 12.7 Formal Package Actual Part --
7468 --------------------------------------
7470 -- FORMAL_PACKAGE_ACTUAL_PART ::=
7471 -- ([OTHERS] => <>)
7472 -- | [GENERIC_ACTUAL_PART]
7473 -- (FORMAL_PACKAGE_ASSOCIATION {. FORMAL_PACKAGE_ASSOCIATION}
7475 -- FORMAL_PACKAGE_ASSOCIATION ::=
7476 -- GENERIC_ASSOCIATION
7477 -- | GENERIC_FORMAL_PARAMETER_SELECTOR_NAME => <>
7479 -- There is no explicit node in the tree for a formal package actual
7480 -- part. Instead the information appears in the parent node (i.e. the
7481 -- formal package declaration node itself).
7483 -- There is no explicit node for a formal package association. All of
7484 -- them are represented either by a generic association, possibly with
7485 -- Box_Present, or by an N_Others_Choice.
7487 ---------------------------------
7488 -- 13.1 Representation clause --
7489 ---------------------------------
7491 -- REPRESENTATION_CLAUSE ::=
7492 -- ATTRIBUTE_DEFINITION_CLAUSE
7493 -- | ENUMERATION_REPRESENTATION_CLAUSE
7494 -- | RECORD_REPRESENTATION_CLAUSE
7495 -- | AT_CLAUSE
7497 ----------------------
7498 -- 13.1 Local Name --
7499 ----------------------
7501 -- LOCAL_NAME :=
7502 -- DIRECT_NAME
7503 -- | DIRECT_NAME'ATTRIBUTE_DESIGNATOR
7504 -- | library_unit_NAME
7506 -- The construct DIRECT_NAME'ATTRIBUTE_DESIGNATOR appears in the tree
7507 -- as an attribute reference, which has essentially the same form.
7509 ---------------------------------------
7510 -- 13.3 Attribute definition clause --
7511 ---------------------------------------
7513 -- ATTRIBUTE_DEFINITION_CLAUSE ::=
7514 -- for LOCAL_NAME'ATTRIBUTE_DESIGNATOR use EXPRESSION;
7515 -- | for LOCAL_NAME'ATTRIBUTE_DESIGNATOR use NAME;
7517 -- In Ada 83, the expression must be a simple expression and the
7518 -- local name must be a direct name.
7520 -- Note: the only attribute definition clause that is processed by
7521 -- gigi is an address clause. For all other cases, the information
7522 -- is extracted by the front end and either results in setting entity
7523 -- information, e.g. Esize for the Size clause, or in appropriate
7524 -- expansion actions (e.g. in the case of Storage_Size).
7526 -- For an address clause, Gigi constructs the appropriate addressing
7527 -- code. It also ensures that no aliasing optimizations are made
7528 -- for the object for which the address clause appears.
7530 -- Note: for an address clause used to achieve an overlay:
7532 -- A : Integer;
7533 -- B : Integer;
7534 -- for B'Address use A'Address;
7536 -- the above rule means that Gigi will ensure that no optimizations
7537 -- will be made for B that would violate the implementation advice
7538 -- of RM 13.3(19). However, this advice applies only to B and not
7539 -- to A, which seems unfortunate. The GNAT front end will mark the
7540 -- object A as volatile to also prevent unwanted optimization
7541 -- assumptions based on no aliasing being made for B.
7543 -- N_Attribute_Definition_Clause
7544 -- Sloc points to FOR
7545 -- Name the local name
7546 -- Chars the identifier name from the attribute designator
7547 -- Expression the expression or name
7548 -- Entity
7549 -- Next_Rep_Item
7550 -- From_At_Mod
7551 -- Check_Address_Alignment
7552 -- From_Aspect_Specification
7553 -- Is_Delayed_Aspect
7554 -- Address_Warning_Posted
7556 -- Note: if From_Aspect_Specification is set, then Sloc points to the
7557 -- aspect name, and Entity is resolved already to reference the entity
7558 -- to which the aspect applies.
7560 -----------------------------------
7561 -- 13.3.1 Aspect Specifications --
7562 -----------------------------------
7564 -- We modify the RM grammar here, the RM grammar is:
7566 -- ASPECT_SPECIFICATION ::=
7567 -- with ASPECT_MARK [=> ASPECT_DEFINITION] {,
7568 -- ASPECT_MARK [=> ASPECT_DEFINITION] }
7570 -- ASPECT_MARK ::= aspect_IDENTIFIER['Class]
7572 -- ASPECT_DEFINITION ::= NAME | EXPRESSION
7574 -- That's inconvenient, since there is no non-terminal name for a single
7575 -- entry in the list of aspects. So we use this grammar instead:
7577 -- ASPECT_SPECIFICATIONS ::=
7578 -- with ASPECT_SPECIFICATION {, ASPECT_SPECIFICATION}
7580 -- ASPECT_SPECIFICATION =>
7581 -- ASPECT_MARK [=> ASPECT_DEFINITION]
7583 -- ASPECT_MARK ::= aspect_IDENTIFIER['Class]
7585 -- ASPECT_DEFINITION ::= NAME | EXPRESSION
7587 -- Note that for Annotate, the ASPECT_DEFINITION is a pure positional
7588 -- aggregate with the elements of the aggregate corresponding to the
7589 -- successive arguments of the corresponding pragma.
7591 -- See separate package Aspects for details on the incorporation of
7592 -- these nodes into the tree, and how aspect specifications for a given
7593 -- declaration node are associated with that node.
7595 -- N_Aspect_Specification
7596 -- Sloc points to aspect identifier
7597 -- Identifier aspect identifier
7598 -- Aspect_Rep_Item
7599 -- Expression (set to Empty if none)
7600 -- Entity entity to which the aspect applies
7601 -- Next_Rep_Item
7602 -- Class_Present Set if 'Class present
7603 -- Is_Ignored
7604 -- Is_Checked
7605 -- Is_Delayed_Aspect
7606 -- Is_Disabled
7607 -- Is_Boolean_Aspect
7608 -- Split_PPC Set if split pre/post attribute
7609 -- Aspect_On_Partial_View
7611 -- Note: Aspect_Specification is an Ada 2012 feature
7613 -- Note: The Identifier serves to identify the aspect involved (it
7614 -- is the aspect whose name corresponds to the Chars field). This
7615 -- means that the other fields of this identifier are unused, and
7616 -- in particular we use the Entity field of this identifier to save
7617 -- a copy of the expression for visibility analysis, see spec of
7618 -- Sem_Ch13 for full details of this usage.
7620 -- In the case of aspects of the form xxx'Class, the aspect identifier
7621 -- is for xxx, and Class_Present is set to True.
7623 -- Note: When a Pre or Post aspect specification is processed, it is
7624 -- broken into AND THEN sections. The left most section has Split_PPC
7625 -- set to False, indicating that it is the original specification (e.g.
7626 -- for posting errors). For the other sections, Split_PPC is set True.
7628 ---------------------------------------------
7629 -- 13.4 Enumeration representation clause --
7630 ---------------------------------------------
7632 -- ENUMERATION_REPRESENTATION_CLAUSE ::=
7633 -- for first_subtype_LOCAL_NAME use ENUMERATION_AGGREGATE;
7635 -- In Ada 83, the name must be a direct name
7637 -- N_Enumeration_Representation_Clause
7638 -- Sloc points to FOR
7639 -- Identifier direct name
7640 -- Array_Aggregate
7641 -- Next_Rep_Item
7643 ---------------------------------
7644 -- 13.4 Enumeration aggregate --
7645 ---------------------------------
7647 -- ENUMERATION_AGGREGATE ::= ARRAY_AGGREGATE
7649 ------------------------------------------
7650 -- 13.5.1 Record representation clause --
7651 ------------------------------------------
7653 -- RECORD_REPRESENTATION_CLAUSE ::=
7654 -- for first_subtype_LOCAL_NAME use
7655 -- record [MOD_CLAUSE]
7656 -- {COMPONENT_CLAUSE}
7657 -- end record;
7659 -- Gigi restriction: Mod_Clause is always Empty (if present it is
7660 -- replaced by a corresponding Alignment attribute definition clause).
7662 -- Note: Component_Clauses can include pragmas
7664 -- N_Record_Representation_Clause
7665 -- Sloc points to FOR
7666 -- Identifier direct name
7667 -- Mod_Clause (set to Empty if no mod clause present)
7668 -- Component_Clauses
7669 -- Next_Rep_Item
7671 ------------------------------
7672 -- 13.5.1 Component clause --
7673 ------------------------------
7675 -- COMPONENT_CLAUSE ::=
7676 -- component_LOCAL_NAME at POSITION
7677 -- range FIRST_BIT .. LAST_BIT;
7679 -- N_Component_Clause
7680 -- Sloc points to AT
7681 -- Component_Name points to Name or Attribute_Reference
7682 -- Position
7683 -- First_Bit
7684 -- Last_Bit
7686 ----------------------
7687 -- 13.5.1 Position --
7688 ----------------------
7690 -- POSITION ::= static_EXPRESSION
7692 -----------------------
7693 -- 13.5.1 First_Bit --
7694 -----------------------
7696 -- FIRST_BIT ::= static_SIMPLE_EXPRESSION
7698 ----------------------
7699 -- 13.5.1 Last_Bit --
7700 ----------------------
7702 -- LAST_BIT ::= static_SIMPLE_EXPRESSION
7704 --------------------------
7705 -- 13.8 Code statement --
7706 --------------------------
7708 -- CODE_STATEMENT ::= QUALIFIED_EXPRESSION;
7710 -- Note: in GNAT, the qualified expression has the form
7712 -- Asm_Insn'(Asm (...));
7714 -- See package System.Machine_Code in file s-maccod.ads for details on
7715 -- the allowed parameters to Asm. There are two ways this node can
7716 -- arise, as a code statement, in which case the expression is the
7717 -- qualified expression, or as a result of the expansion of an intrinsic
7718 -- call to the Asm or Asm_Input procedure.
7720 -- N_Code_Statement
7721 -- Sloc points to first token of the expression
7722 -- Expression
7724 -- Note: package Exp_Code contains an abstract functional interface
7725 -- for use by Gigi in accessing the data from N_Code_Statement nodes.
7727 ------------------------
7728 -- 13.12 Restriction --
7729 ------------------------
7731 -- RESTRICTION ::=
7732 -- restriction_IDENTIFIER
7733 -- | restriction_parameter_IDENTIFIER => EXPRESSION
7735 -- There is no explicit node for restrictions. Instead the restriction
7736 -- appears in normal pragma syntax as a pragma argument association,
7737 -- which has the same syntactic form.
7739 --------------------------
7740 -- B.2 Shift Operators --
7741 --------------------------
7743 -- Calls to the intrinsic shift functions are converted to one of
7744 -- the following shift nodes, which have the form of normal binary
7745 -- operator names. Note that for a given shift operation, one node
7746 -- covers all possible types, as for normal operators.
7748 -- Note: it is perfectly permissible for the expander to generate
7749 -- shift operation nodes directly, in which case they will be analyzed
7750 -- and parsed in the usual manner.
7752 -- Sprint syntax: shift-function-name!(expr, count)
7754 -- Note: the Left_Opnd field holds the first argument (the value to
7755 -- be shifted). The Right_Opnd field holds the second argument (the
7756 -- shift count). The Chars field is the name of the intrinsic function.
7758 -- N_Op_Rotate_Left
7759 -- Sloc points to the function name
7760 -- plus fields for binary operator
7761 -- plus fields for expression
7762 -- Shift_Count_OK
7764 -- N_Op_Rotate_Right
7765 -- Sloc points to the function name
7766 -- plus fields for binary operator
7767 -- plus fields for expression
7768 -- Shift_Count_OK
7770 -- N_Op_Shift_Left
7771 -- Sloc points to the function name
7772 -- plus fields for binary operator
7773 -- plus fields for expression
7774 -- Shift_Count_OK
7776 -- N_Op_Shift_Right_Arithmetic
7777 -- Sloc points to the function name
7778 -- plus fields for binary operator
7779 -- plus fields for expression
7780 -- Shift_Count_OK
7782 -- N_Op_Shift_Right
7783 -- Sloc points to the function name
7784 -- plus fields for binary operator
7785 -- plus fields for expression
7786 -- Shift_Count_OK
7788 -- Note: N_Op_Rotate_Left, N_Op_Rotate_Right, N_Shift_Right_Arithmetic
7789 -- never appear in the expanded tree if Modify_Tree_For_C mode is set.
7791 -- Note: For N_Op_Shift_Left and N_Op_Shift_Right, the right operand is
7792 -- always less than the word size if Modify_Tree_For_C mode is set.
7794 --------------------------
7795 -- Obsolescent Features --
7796 --------------------------
7798 -- The syntax descriptions and tree nodes for obsolescent features are
7799 -- grouped together, corresponding to their location in appendix I in
7800 -- the RM. However, parsing and semantic analysis for these constructs
7801 -- is located in an appropriate chapter (see individual notes).
7803 ---------------------------
7804 -- J.3 Delta Constraint --
7805 ---------------------------
7807 -- Note: the parse routine for this construct is located in section
7808 -- 3.5.9 of Par-Ch3, and semantic analysis is in Sem_Ch3, which is
7809 -- where delta constraint logically belongs.
7811 -- DELTA_CONSTRAINT ::= DELTA static_EXPRESSION [RANGE_CONSTRAINT]
7813 -- N_Delta_Constraint
7814 -- Sloc points to DELTA
7815 -- Delta_Expression
7816 -- Range_Constraint (set to Empty if not present)
7818 --------------------
7819 -- J.7 At Clause --
7820 --------------------
7822 -- AT_CLAUSE ::= for DIRECT_NAME use at EXPRESSION;
7824 -- Note: the parse routine for this construct is located in Par-Ch13,
7825 -- and the semantic analysis is in Sem_Ch13, where at clause logically
7826 -- belongs if it were not obsolescent.
7828 -- Note: in Ada 83 the expression must be a simple expression
7830 -- Gigi restriction: This node never appears, it is rewritten as an
7831 -- address attribute definition clause.
7833 -- N_At_Clause
7834 -- Sloc points to FOR
7835 -- Identifier
7836 -- Expression
7838 ---------------------
7839 -- J.8 Mod clause --
7840 ---------------------
7842 -- MOD_CLAUSE ::= at mod static_EXPRESSION;
7844 -- Note: the parse routine for this construct is located in Par-Ch13,
7845 -- and the semantic analysis is in Sem_Ch13, where mod clause logically
7846 -- belongs if it were not obsolescent.
7848 -- Note: in Ada 83, the expression must be a simple expression
7850 -- Gigi restriction: this node never appears. It is replaced
7851 -- by a corresponding Alignment attribute definition clause.
7853 -- Note: pragmas can appear before and after the MOD_CLAUSE since
7854 -- its name has "clause" in it. This is rather strange, but is quite
7855 -- definitely specified. The pragmas before are collected in the
7856 -- Pragmas_Before field of the mod clause node itself, and pragmas
7857 -- after are simply swallowed up in the list of component clauses.
7859 -- N_Mod_Clause
7860 -- Sloc points to AT
7861 -- Expression
7862 -- Pragmas_Before Pragmas before mod clause (No_List if none)
7864 --------------------
7865 -- Semantic Nodes --
7866 --------------------
7868 -- These semantic nodes are used to hold additional semantic information.
7869 -- They are inserted into the tree as a result of semantic processing.
7870 -- Although there are no legitimate source syntax constructions that
7871 -- correspond directly to these nodes, we need a source syntax for the
7872 -- reconstructed tree printed by Sprint, and the node descriptions here
7873 -- show this syntax.
7875 -----------------
7876 -- Call_Marker --
7877 -----------------
7879 -- This node is created during the analysis/resolution of entry calls,
7880 -- requeues, and subprogram calls. It performs several functions:
7882 -- * Call markers provide a uniform model for handling calls by the
7883 -- ABE mechanism, regardless of whether expansion took place.
7885 -- * The call marker captures the target of the related call along
7886 -- with other attributes which are either unavailable or expensive
7887 -- to recompute once analysis, resolution, and expansion are over.
7889 -- * The call marker aids the ABE Processing phase by signaling the
7890 -- presence of a call in case the original call was transformed by
7891 -- expansion.
7893 -- * The call marker acts as a reference point for the insertion of
7894 -- run-time conditional ABE checks or guaranteed ABE failures.
7896 -- Sprint syntax: #target#
7898 -- The Sprint syntax shown above is not enabled by default
7900 -- N_Call_Marker
7901 -- Sloc points to Sloc of original call
7902 -- Target
7903 -- Is_Elaboration_Checks_OK_Node
7904 -- Is_SPARK_Mode_On_Node
7905 -- Is_Elaboration_Warnings_OK_Node
7906 -- Is_Source_Call
7907 -- Is_Declaration_Level_Node
7908 -- Is_Dispatching_Call
7909 -- Is_Preelaborable_Call
7910 -- Is_Known_Guaranteed_ABE
7912 ------------------------
7913 -- Compound Statement --
7914 ------------------------
7916 -- This node is created by the analyzer/expander to handle some
7917 -- expansion cases where a sequence of actions needs to be captured
7918 -- within a single node (which acts as a container and allows the
7919 -- entire list of actions to be moved around as a whole) appearing
7920 -- in a sequence of statements.
7922 -- This is the statement counterpart to the expression node
7923 -- N_Expression_With_Actions.
7925 -- The required semantics is that the set of actions is executed in
7926 -- the order in which it appears, as though they appeared by themselves
7927 -- in the enclosing list of declarations or statements. Unlike what
7928 -- happens when using an N_Block_Statement, no new scope is introduced.
7930 -- Note: for the time being, this is used only as a transient
7931 -- representation during expansion, and all compound statement nodes
7932 -- must be exploded back to their constituent statements before handing
7933 -- the tree to the back end.
7935 -- Sprint syntax: do
7936 -- action;
7937 -- action;
7938 -- ...
7939 -- action;
7940 -- end;
7942 -- N_Compound_Statement
7943 -- Actions
7945 --------------
7946 -- Contract --
7947 --------------
7949 -- This node is used to hold the various parts of an entry, subprogram
7950 -- [body] or package [body] contract, in particular:
7951 -- Abstract states declared by a package declaration
7952 -- Contract cases that apply to a subprogram
7953 -- Dependency relations of inputs and output of a subprogram
7954 -- Global annotations classifying data as input or output
7955 -- Initialization sequences for a package declaration
7956 -- Pre- and postconditions that apply to a subprogram
7958 -- The node appears in an entry and [generic] subprogram [body] entity.
7960 -- Sprint syntax: <none> as the node should not appear in the tree, but
7961 -- only attached to an entry or [generic] subprogram
7962 -- entity.
7964 -- N_Contract
7965 -- Sloc points to the subprogram's name
7966 -- Pre_Post_Conditions (set to Empty if none)
7967 -- Contract_Test_Cases (set to Empty if none)
7968 -- Classifications (set to Empty if none)
7969 -- Is_Expanded_Contract
7971 -- Pre_Post_Conditions contains a collection of pragmas that correspond
7972 -- to pre- and postconditions associated with an entry or a subprogram
7973 -- [body or stub]. The pragmas can either come from source or be the
7974 -- byproduct of aspect expansion. Currently the following pragmas appear
7975 -- in this list:
7976 -- Post
7977 -- Postcondition
7978 -- Pre
7979 -- Precondition
7980 -- Refined_Post
7981 -- The ordering in the list is in LIFO fashion.
7983 -- Note that there might be multiple preconditions or postconditions
7984 -- in this list, either because they come from separate pragmas in the
7985 -- source, or because a Pre (resp. Post) aspect specification has been
7986 -- broken into AND THEN sections. See Split_PPC for details.
7988 -- In GNATprove mode, the inherited classwide pre- and postconditions
7989 -- (suitably specialized for the specific type of the overriding
7990 -- operation) are also in this list.
7992 -- Contract_Test_Cases contains a collection of pragmas that correspond
7993 -- to aspects/pragmas Contract_Cases, Exceptional_Cases, Test_Case and
7994 -- Subprogram_Variant. The ordering in the list is in LIFO fashion.
7996 -- Classifications contains pragmas that either declare, categorize, or
7997 -- establish dependencies between subprogram or package inputs and
7998 -- outputs. Currently the following pragmas appear in this list:
7999 -- Abstract_States
8000 -- Always_Terminates
8001 -- Async_Readers
8002 -- Async_Writers
8003 -- Constant_After_Elaboration
8004 -- Depends
8005 -- Effective_Reads
8006 -- Effective_Writes
8007 -- Extensions_Visible
8008 -- Global
8009 -- Initial_Condition
8010 -- Initializes
8011 -- Part_Of
8012 -- Refined_Depends
8013 -- Refined_Global
8014 -- Refined_States
8015 -- Volatile_Function
8016 -- The ordering is in LIFO fashion.
8018 -------------------
8019 -- Expanded Name --
8020 -------------------
8022 -- The N_Expanded_Name node is used to represent a selected component
8023 -- name that has been resolved to an expanded name. The semantic phase
8024 -- replaces N_Selected_Component nodes that represent names by the use
8025 -- of this node, leaving the N_Selected_Component node used only when
8026 -- the prefix is a record or protected type.
8028 -- The fields of the N_Expanded_Name node are laid out identically
8029 -- to those of the N_Selected_Component node, allowing conversion of
8030 -- an expanded name node to a selected component node to be done
8031 -- easily, see Sinfo.CN.Change_Selected_Component_To_Expanded_Name.
8033 -- There is no special sprint syntax for an expanded name
8035 -- N_Expanded_Name
8036 -- Sloc points to the period
8037 -- Chars copy of Chars field of selector name
8038 -- Prefix
8039 -- Selector_Name
8040 -- Entity
8041 -- Associated_Node
8042 -- Is_Elaboration_Checks_OK_Node
8043 -- Is_SPARK_Mode_On_Node
8044 -- Is_Elaboration_Warnings_OK_Node
8045 -- Has_Private_View (set in generic units)
8046 -- Has_Secondary_Private_View (set in generic units)
8047 -- Redundant_Use
8048 -- Atomic_Sync_Required
8049 -- plus fields for expression
8051 -----------------------------
8052 -- Expression With Actions --
8053 -----------------------------
8055 -- This node is created by the analyzer/expander to handle some
8056 -- expansion cases, notably short-circuit forms where there are
8057 -- actions associated with the right-hand side operand.
8059 -- The N_Expression_With_Actions node represents an expression with
8060 -- an associated set of actions (which are executable statements and
8061 -- declarations, as might occur in a handled statement sequence).
8063 -- The required semantics is that the set of actions is executed in
8064 -- the order in which it appears just before the expression is
8065 -- evaluated (and these actions must only be executed if the value
8066 -- of the expression is evaluated). The node is considered to be
8067 -- a subexpression, whose value is the value of the Expression after
8068 -- executing all the actions.
8070 -- If the actions contain declarations, then these declarations may
8071 -- be referenced within the expression.
8073 -- (AI12-0236-1): In Ada 2022, for a declare_expression, the parser
8074 -- generates an N_Expression_With_Actions. Declare_expressions have
8075 -- various restrictions, which we do not enforce on
8076 -- N_Expression_With_Actions nodes that are generated by the
8077 -- expander. The two cases can be distinguished by looking at
8078 -- Comes_From_Source.
8080 -- ???Perhaps we should change the name of this node to
8081 -- N_Declare_Expression, and perhaps we should change the Sprint syntax
8082 -- to match the RM syntax for declare_expression.
8084 -- Sprint syntax: do
8085 -- action;
8086 -- action;
8087 -- ...
8088 -- action;
8089 -- in expression end
8091 -- N_Expression_With_Actions
8092 -- Actions
8093 -- Expression
8094 -- plus fields for expression
8096 -- Note: In the final generated tree presented to the code generator,
8097 -- the actions list is always non-null, since there is no point in this
8098 -- node if the actions are Empty. During semantic analysis there are
8099 -- cases where it is convenient to temporarily generate an empty actions
8100 -- list. This arises in cases where we create such an empty actions
8101 -- list, and it may or may not end up being a place where additional
8102 -- actions are inserted. The expander removes such empty cases after
8103 -- the expression of the node is fully analyzed and expanded, at which
8104 -- point it is safe to remove it, since no more actions can be inserted.
8106 -- Note: In Modify_Tree_For_C, we never generate any declarations in
8107 -- the action list, which can contain only non-declarative statements.
8109 --------------------
8110 -- Free Statement --
8111 --------------------
8113 -- The N_Free_Statement node is generated as a result of a call to an
8114 -- instantiation of Unchecked_Deallocation. The instantiation of this
8115 -- generic is handled specially and generates this node directly.
8117 -- Sprint syntax: free expression
8119 -- N_Free_Statement
8120 -- Sloc is copied from the unchecked deallocation call
8121 -- Expression argument to unchecked deallocation call
8122 -- Storage_Pool
8123 -- Procedure_To_Call
8124 -- Actual_Designated_Subtype
8126 -- Note: in the case where a debug source file is generated, the Sloc
8127 -- for this node points to the FREE keyword in the Sprint file output.
8129 -------------------
8130 -- Freeze Entity --
8131 -------------------
8133 -- This node marks the point in a declarative part at which an entity
8134 -- declared therein becomes frozen. The expander places initialization
8135 -- procedures for types at those points. Gigi uses the freezing point
8136 -- to elaborate entities that may depend on previous private types.
8138 -- See the section in Einfo "Delayed Freezing and Elaboration" for
8139 -- a full description of the use of this node.
8141 -- The Entity field points back to the entity for the type (whose
8142 -- Freeze_Node field points back to this freeze node).
8144 -- The Actions field contains a list of declarations and statements
8145 -- generated by the expander which are associated with the freeze
8146 -- node, and are elaborated as though the freeze node were replaced
8147 -- by this sequence of actions.
8149 -- Note: the Sloc field in the freeze node references a construct
8150 -- associated with the freezing point. This is used for posting
8151 -- messages in some error/warning situations, e.g. the case where
8152 -- a primitive operation of a tagged type is declared too late.
8154 -- Sprint syntax: freeze entity-name [
8155 -- freeze actions
8156 -- ]
8158 -- N_Freeze_Entity
8159 -- Sloc points near freeze point (see above special note)
8160 -- Entity
8161 -- Access_Types_To_Process (set to No_Elist if none)
8162 -- TSS_Elist (set to No_Elist if no associated TSS's)
8163 -- Actions (set to No_List if no freeze actions)
8164 -- First_Subtype_Link (set to Empty if no link)
8166 -- The Actions field holds actions associated with the freeze. These
8167 -- actions are elaborated at the point where the type is frozen.
8169 -- Note: in the case where a debug source file is generated, the Sloc
8170 -- for this node points to the FREEZE keyword in the Sprint file output.
8172 ---------------------------
8173 -- Freeze Generic Entity --
8174 ---------------------------
8176 -- The freeze point of an entity indicates the point at which the
8177 -- information needed to generate code for the entity is complete.
8178 -- The freeze node for an entity triggers expander activities, such as
8179 -- build initialization procedures, and backend activities, such as
8180 -- completing the elaboration of packages.
8182 -- For entities declared within a generic unit, for which no code is
8183 -- generated, the freeze point is not equally meaningful. However, in
8184 -- Ada 2012 several semantic checks on declarations must be delayed to
8185 -- the freeze point, and we need to include such a mark in the tree to
8186 -- trigger these checks. The Freeze_Generic_Entity node plays no other
8187 -- role, and is ignored by the expander and the back-end.
8189 -- Sprint syntax: freeze_generic entity-name
8191 -- N_Freeze_Generic_Entity
8192 -- Sloc points near freeze point
8193 -- Entity
8195 --------------------------------
8196 -- Implicit Label Declaration --
8197 --------------------------------
8199 -- An implicit label declaration is created for every occurrence of a
8200 -- label on a statement or a label on a block or loop. It is chained
8201 -- in the declarations of the innermost enclosing block as specified
8202 -- in RM section 5.1 (3).
8204 -- The Defining_Identifier is the actual identifier for the statement
8205 -- identifier. Note that the occurrence of the label is a reference, NOT
8206 -- the defining occurrence. The defining occurrence occurs at the head
8207 -- of the innermost enclosing block, and is represented by this node.
8209 -- Note: from the grammar, this might better be called an implicit
8210 -- statement identifier declaration, but the term we choose seems
8211 -- friendlier, since at least informally statement identifiers are
8212 -- called labels in both cases (i.e. when used in labels, and when
8213 -- used as the identifiers of blocks and loops).
8215 -- Note: although this is logically a semantic node, since it does not
8216 -- correspond directly to a source syntax construction, these nodes are
8217 -- actually created by the parser in a post pass done just after parsing
8218 -- is complete, before semantic analysis is started (see Par.Labl).
8220 -- Sprint syntax: labelname : label;
8222 -- N_Implicit_Label_Declaration
8223 -- Sloc points to the << token for a statement identifier, or to the
8224 -- LOOP, DECLARE, or BEGIN token for a loop or block identifier
8225 -- Defining_Identifier
8226 -- Label_Construct
8228 -- Note: in the case where a debug source file is generated, the Sloc
8229 -- for this node points to the label name in the generated declaration.
8231 ---------------------
8232 -- Itype Reference --
8233 ---------------------
8235 -- This node is used to create a reference to an Itype. The only purpose
8236 -- is to make sure the Itype is defined if this is the first reference.
8238 -- A typical use of this node is when an Itype is to be referenced in
8239 -- two branches of an IF statement. In this case it is important that
8240 -- the first use of the Itype not be inside the conditional, since then
8241 -- it might not be defined if the other branch of the IF is taken, in
8242 -- the case where the definition generates elaboration code.
8244 -- The Itype field points to the referenced Itype
8246 -- Sprint syntax: reference itype-name
8248 -- N_Itype_Reference
8249 -- Sloc points to the node generating the reference
8250 -- Itype
8252 -- Note: in the case where a debug source file is generated, the Sloc
8253 -- for this node points to the REFERENCE keyword in the file output.
8255 ---------------------
8256 -- Raise xxx Error --
8257 ---------------------
8259 -- One of these nodes is created during semantic analysis to replace
8260 -- a node for an expression that is determined to definitely raise
8261 -- the corresponding exception.
8263 -- The N_Raise_xxx_Error node may also stand alone in place
8264 -- of a declaration or statement, in which case it simply causes
8265 -- the exception to be raised (i.e. it is equivalent to a raise
8266 -- statement that raises the corresponding exception). This use
8267 -- is distinguished by the fact that the Etype in this case is
8268 -- Standard_Void_Type; in the subexpression case, the Etype is the
8269 -- same as the type of the subexpression which it replaces.
8271 -- If Condition is empty, then the raise is unconditional. If the
8272 -- Condition field is non-empty, it is a boolean expression which is
8273 -- first evaluated, and the exception is raised only if the value of the
8274 -- expression is True. In the unconditional case, the creation of this
8275 -- node is usually accompanied by a warning message (unless it appears
8276 -- within the right operand of a short-circuit form whose left argument
8277 -- is static and decisively eliminates elaboration of the raise
8278 -- operation). The condition field can ONLY be present when the node is
8279 -- used as a statement form; it must NOT be present in the case where
8280 -- the node appears within an expression.
8282 -- The exception is generated with a message that contains the
8283 -- file name and line number, and then appended text. The Reason
8284 -- code shows the text to be added. The Reason code is an element
8285 -- of the type Types.RT_Exception_Code, and indicates both the
8286 -- message to be added, and the exception to be raised (which must
8287 -- match the node type). The value is stored by storing a Uint which
8288 -- is the Pos value of the enumeration element in this type.
8290 -- Gigi restriction: This expander ensures that the type of the
8291 -- Condition field is always Standard.Boolean, even if the type
8292 -- in the source is some non-standard boolean type.
8294 -- Sprint syntax: [xxx_error "msg"]
8295 -- or: [xxx_error when condition "msg"]
8297 -- N_Raise_Constraint_Error
8298 -- Sloc references related construct
8299 -- Condition (set to Empty if no condition)
8300 -- Reason
8301 -- plus fields for expression
8303 -- N_Raise_Program_Error
8304 -- Sloc references related construct
8305 -- Condition (set to Empty if no condition)
8306 -- Reason
8307 -- plus fields for expression
8309 -- N_Raise_Storage_Error
8310 -- Sloc references related construct
8311 -- Condition (set to Empty if no condition)
8312 -- Reason
8313 -- plus fields for expression
8315 -- Note: Sloc is copied from the expression generating the exception.
8316 -- In the case where a debug source file is generated, the Sloc for
8317 -- this node points to the left bracket in the Sprint file output.
8319 -- Note: the back end may be required to translate these nodes into
8320 -- appropriate goto statements. See description of N_Push/Pop_xxx_Label.
8322 ---------------------------------------------
8323 -- Optimization of Exception Raise to Goto --
8324 ---------------------------------------------
8326 -- In some cases, the front end will determine that any exception raised
8327 -- by the back end for a certain exception should be transformed into a
8328 -- goto statement.
8330 -- There are three kinds of exceptions raised by the back end (note that
8331 -- for this purpose we consider gigi to be part of the back end in the
8332 -- gcc case):
8334 -- 1. Exceptions resulting from N_Raise_xxx_Error nodes
8335 -- 2. Exceptions from checks triggered by Do_xxx_Check flags
8336 -- 3. Other cases not specifically marked by the front end
8338 -- Normally all such exceptions are translated into calls to the proper
8339 -- Rcheck_xx procedure, where xx encodes both the exception to be raised
8340 -- and the exception message.
8342 -- The front end may determine that for a particular sequence of code,
8343 -- exceptions in any of these three categories for a particular builtin
8344 -- exception should result in a goto, rather than a call to Rcheck_xx.
8345 -- The exact sequence to be generated is:
8347 -- Local_Raise (exception'Identity);
8348 -- goto Label
8350 -- The front end marks such a sequence of code by bracketing it with
8351 -- push and pop nodes:
8353 -- N_Push_xxx_Label (referencing the label)
8354 -- ...
8355 -- (code where transformation is expected for exception xxx)
8356 -- ...
8357 -- N_Pop_xxx_Label
8359 -- The use of push/pop reflects the fact that such regions can properly
8360 -- nest, and one special case is a subregion in which no transformation
8361 -- is allowed. Such a region is marked by a N_Push_xxx_Label node whose
8362 -- Exception_Label field is Empty.
8364 -- N_Push_Constraint_Error_Label
8365 -- Sloc references first statement in region covered
8366 -- Exception_Label
8368 -- N_Push_Program_Error_Label
8369 -- Sloc references first statement in region covered
8370 -- Exception_Label
8372 -- N_Push_Storage_Error_Label
8373 -- Sloc references first statement in region covered
8374 -- Exception_Label
8376 -- N_Pop_Constraint_Error_Label
8377 -- Sloc references last statement in region covered
8379 -- N_Pop_Program_Error_Label
8380 -- Sloc references last statement in region covered
8382 -- N_Pop_Storage_Error_Label
8383 -- Sloc references last statement in region covered
8385 ---------------
8386 -- Reference --
8387 ---------------
8389 -- For a number of purposes, we need to construct references to objects.
8390 -- These references are subsequently treated as normal access values.
8391 -- An example is the construction of the parameter block passed to a
8392 -- task entry. The N_Reference node is provided for this purpose. It is
8393 -- similar in effect to the use of the Unrestricted_Access attribute,
8394 -- and like Unrestricted_Access can be applied to objects which would
8395 -- not be valid prefixes for the Unchecked_Access attribute (e.g.
8396 -- objects which are not aliased, and slices). In addition it can be
8397 -- applied to composite type values as well as objects, including string
8398 -- values and aggregates.
8400 -- Note: we use the Prefix field for this expression so that the
8401 -- resulting node can be treated using common code with the attribute
8402 -- nodes for the 'Access and related attributes. Logically it would make
8403 -- more sense to call it an Expression field, but then we would have to
8404 -- special case the treatment of the N_Reference node.
8406 -- Note: evaluating a N_Reference node is guaranteed to yield a non-null
8407 -- value at run time. Therefore, it is valid to set Is_Known_Non_Null on
8408 -- a temporary initialized to a N_Reference node in order to eliminate
8409 -- superfluous access checks.
8411 -- Sprint syntax: prefix'reference
8413 -- N_Reference
8414 -- Sloc is copied from the expression
8415 -- Prefix
8416 -- plus fields for expression
8418 -- Note: in the case where a debug source file is generated, the Sloc
8419 -- for this node points to the quote in the Sprint file output.
8421 ----------------
8422 -- SCIL Nodes --
8423 ----------------
8425 -- SCIL nodes are special nodes added to the tree when the CodePeer mode
8426 -- is active. They are only generated if SCIL generation is enabled.
8427 -- A standard tree-walk will not encounter these nodes even if they
8428 -- are present; these nodes are only accessible via the function
8429 -- SCIL_LL.Get_SCIL_Node. These nodes have no associated dynamic
8430 -- semantics.
8432 -- Sprint syntax: [ <node kind> ]
8433 -- No semantic field values are displayed.
8435 -- N_SCIL_Dispatch_Table_Tag_Init
8436 -- Sloc references a node for a tag initialization
8437 -- SCIL_Entity
8439 -- An N_SCIL_Dispatch_Table_Tag_Init node may be associated (via
8440 -- Get_SCIL_Node) with the N_Object_Declaration node corresponding to
8441 -- the declaration of the dispatch table for a tagged type.
8443 -- N_SCIL_Dispatching_Call
8444 -- Sloc references the node of a dispatching call
8445 -- SCIL_Target_Prim
8446 -- SCIL_Entity
8447 -- SCIL_Controlling_Tag
8449 -- An N_Scil_Dispatching call node may be associated (via Get_SCIL_Node)
8450 -- with the N_Procedure_Call_Statement or N_Function_Call node (or a
8451 -- rewriting thereof) corresponding to a dispatching call.
8453 -- N_SCIL_Membership_Test
8454 -- Sloc references the node of a membership test
8455 -- SCIL_Tag_Value
8456 -- SCIL_Entity
8458 -- An N_Scil_Membership_Test node may be associated (via Get_SCIL_Node)
8459 -- with the N_In node (or a rewriting thereof) corresponding to a
8460 -- classwide membership test.
8462 --------------------------
8463 -- Unchecked Expression --
8464 --------------------------
8466 -- An unchecked expression is one that must be analyzed and resolved
8467 -- with all checks off, regardless of the current setting of scope
8468 -- suppress flags.
8470 -- Sprint syntax: `(expression)
8472 -- Note: this node is always removed from the tree (and replaced by
8473 -- its constituent expression) on completion of analysis, so it only
8474 -- appears in intermediate trees, and will never be seen by Gigi.
8476 -- N_Unchecked_Expression
8477 -- Sloc is a copy of the Sloc of the expression
8478 -- Expression
8479 -- plus fields for expression
8481 -- Note: in the case where a debug source file is generated, the Sloc
8482 -- for this node points to the back quote in the Sprint file output.
8484 -------------------------------
8485 -- Unchecked Type Conversion --
8486 -------------------------------
8488 -- An unchecked type conversion node represents the semantic action
8489 -- corresponding to a call to an instantiation of Unchecked_Conversion.
8490 -- It is generated as a result of actual use of Unchecked_Conversion
8491 -- and also by the expander.
8493 -- Unchecked type conversion nodes should be created by calling
8494 -- Tbuild.Unchecked_Convert_To, rather than by directly calling
8495 -- Nmake.Make_Unchecked_Type_Conversion.
8497 -- Note: an unchecked type conversion is a variable as far as the
8498 -- semantics are concerned, which is convenient for the expander.
8499 -- This does not change what Ada source programs are legal, since
8500 -- clearly a function call to an instantiation of Unchecked_Conversion
8501 -- is not a variable in any case.
8503 -- Sprint syntax: subtype-mark!(expression)
8505 -- N_Unchecked_Type_Conversion
8506 -- Sloc points to related node in source
8507 -- Subtype_Mark
8508 -- Expression
8509 -- Kill_Range_Check
8510 -- No_Truncation
8511 -- plus fields for expression
8513 -- Note: in the case where a debug source file is generated, the Sloc
8514 -- for this node points to the exclamation in the Sprint file output.
8516 -----------------------------------
8517 -- Validate_Unchecked_Conversion --
8518 -----------------------------------
8520 -- The front end does most of the validation of unchecked conversion,
8521 -- including checking sizes (this is done after the back end is called
8522 -- to take advantage of back-annotation of calculated sizes).
8524 -- The front end also deals with specific cases that are not allowed
8525 -- e.g. involving unconstrained array types.
8527 -- For the case of the standard gigi backend, this means that all
8528 -- checks are done in the front end.
8530 -- However, in the case of specialized back-ends, in particular the JVM
8531 -- backend in the past, additional requirements and restrictions may
8532 -- apply to unchecked conversion, and these are most conveniently
8533 -- performed in the specialized back-end.
8535 -- To accommodate this requirement, for such back ends, the following
8536 -- special node is generated recording an unchecked conversion that
8537 -- needs to be validated. The back end should post an appropriate
8538 -- error message if the unchecked conversion is invalid or warrants
8539 -- a special warning message.
8541 -- Source_Type and Target_Type point to the entities for the two
8542 -- types involved in the unchecked conversion instantiation that
8543 -- is to be validated.
8545 -- Sprint syntax: validate Unchecked_Conversion (source, target);
8547 -- N_Validate_Unchecked_Conversion
8548 -- Sloc points to instantiation (location for warning message)
8549 -- Source_Type
8550 -- Target_Type
8552 -- Note: in the case where a debug source file is generated, the Sloc
8553 -- for this node points to the VALIDATE keyword in the file output.
8555 -------------------------------
8556 -- Variable_Reference_Marker --
8557 -------------------------------
8559 -- This node is created during the analysis of direct or expanded names,
8560 -- and the resolution of entry and subprogram calls. It performs several
8561 -- functions:
8563 -- * Variable reference markers provide a uniform model for handling
8564 -- variable references by the ABE mechanism, regardless of whether
8565 -- expansion took place.
8567 -- * The variable reference marker captures the entity of the variable
8568 -- being read or written.
8570 -- * The variable reference markers aid the ABE Processing phase by
8571 -- signaling the presence of a call in case the original variable
8572 -- reference was transformed by expansion.
8574 -- Sprint syntax: r#target# -- for a read
8575 -- rw#target# -- for a read/write
8576 -- w#target# -- for a write
8578 -- The Sprint syntax shown above is not enabled by default
8580 -- N_Variable_Reference_Marker
8581 -- Sloc points to Sloc of original variable reference
8582 -- Target
8583 -- Is_Elaboration_Checks_OK_Node
8584 -- Is_SPARK_Mode_On_Node
8585 -- Is_Elaboration_Warnings_OK_Node
8586 -- Is_Read
8587 -- Is_Write
8589 -----------
8590 -- Empty --
8591 -----------
8593 -- Used as the contents of the Nkind field of the dummy Empty node and in
8594 -- some other situations to indicate an uninitialized value.
8596 -- N_Empty
8597 -- Chars is set to No_Name
8599 -----------
8600 -- Error --
8601 -----------
8603 -- Used as the contents of the Nkind field of the dummy Error node.
8604 -- Has an Etype field, which gets set to Any_Type later on, to help
8605 -- error recovery (Error_Posted is also set in the Error node).
8607 -- N_Error
8608 -- Chars is set to Error_Name
8609 -- Etype
8611 end Sinfo;