]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/ada/einfo.ads
[Ada] Variable-sized node types
[thirdparty/gcc.git] / gcc / ada / einfo.ads
CommitLineData
70482933
RK
1------------------------------------------------------------------------------
2-- --
3-- GNAT COMPILER COMPONENTS --
573e5dd6 4-- --
70482933
RK
5-- E I N F O --
6-- --
7-- S p e c --
8-- --
8d0d46f4 9-- Copyright (C) 1992-2021, Free Software Foundation, Inc. --
975c6896 10-- --
70482933
RK
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- --
748086b7 13-- ware Foundation; either version 3, or (at your option) any later ver- --
70482933
RK
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 --
b740cf28
AC
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. --
70482933
RK
20-- --
21-- GNAT was originally developed by the GNAT team at New York University. --
71ff80dc 22-- Extensive contributions were provided by Ada Core Technologies Inc. --
70482933
RK
23-- --
24------------------------------------------------------------------------------
25
76f9c7f4
BD
26pragma Warnings (Off); -- with/use clauses for children
27with Namet; use Namet;
07fc65c4 28with Snames; use Snames;
76f9c7f4
BD
29with Stand; use Stand;
30with Types; use Types;
31with Uintp; use Uintp;
70482933 32with Urealp; use Urealp;
76f9c7f4 33pragma Warnings (On);
70482933
RK
34
35package Einfo is
36
76f9c7f4
BD
37-- ????Comments below are partly obsolete
38
70482933
RK
39-- This package defines the annotations to the abstract syntax tree that
40-- are needed to support semantic processing of an Ada compilation.
41
82c80734
RD
42-- Note that after editing this spec and the corresponding body it is
43-- required to run ceinfo to check the consistentcy of spec and body.
44-- See ceinfo.adb for more information about the checks made.
45
70482933
RK
46-- These annotations are for the most part attributes of declared entities,
47-- and they correspond to conventional symbol table information. Other
48-- attributes include sets of meanings for overloaded names, possible
49-- types for overloaded expressions, flags to indicate deferred constants,
e95ad7ea
RD
50-- incomplete types, etc. These attributes are stored in available fields in
51-- tree nodes (i.e. fields not used by the parser, as defined by the Sinfo
52-- package specification), and accessed by means of a set of subprograms
53-- which define an abstract interface.
70482933
RK
54
55-- There are two kinds of semantic information
56
57-- First, the tree nodes with the following Nkind values:
58
59-- N_Defining_Identifier
60-- N_Defining_Character_Literal
61-- N_Defining_Operator_Symbol
62
63-- are called Entities, and constitute the information that would often
64-- be stored separately in a symbol table. These nodes are all extended
65-- to provide extra space, and contain fields which depend on the entity
66-- kind, as defined by the contents of the Ekind field. The use of the
67-- Ekind field, and the associated fields in the entity, are defined
68-- in this package, as are the access functions to these fields.
69
70-- Second, in some cases semantic information is stored directly in other
71-- kinds of nodes, e.g. the Etype field, used to indicate the type of an
72-- expression. The access functions to these fields are defined in the
73-- Sinfo package, but their full documentation is to be found in
74-- the Einfo package specification.
75
76-- Declaration processing places information in the nodes of their defining
77-- identifiers. Name resolution places in all other occurrences of an
78-- identifier a pointer to the corresponding defining occurrence.
79
80--------------------------------
81-- The XEINFO Utility Program --
82--------------------------------
83
84-- XEINFO is a utility program which automatically produces a C header file,
e95ad7ea
RD
85-- einfo.h from the spec and body of package Einfo. It reads the input files
86-- einfo.ads and einfo.adb and produces the output file einfo.h. XEINFO is run
87-- automatically by the build scripts when you do a full bootstrap.
70482933
RK
88
89-- In order for this utility program to operate correctly, the form of the
90-- einfo.ads and einfo.adb files must meet certain requirements and be laid
91-- out in a specific manner.
92
93-- The general form of einfo.ads is as follows:
94
95-- type declaration for type Entity_Kind
96-- subtype declarations declaring subranges of Entity_Kind
97-- subtype declarations declaring synonyms for some standard types
98-- function specs for attributes
99-- procedure specs
100-- pragma Inline declarations
101
102-- This order must be observed. There are no restrictions on the procedures,
28bc3323
AC
103-- since the C header file only includes functions (The back end is not
104-- allowed to modify the generated tree). However, functions are required to
105-- have headers that fit on a single line.
70482933
RK
106
107-- XEINFO reads and processes the function specs and the pragma Inlines. For
108-- functions that are declared as inlined, XEINFO reads the corresponding body
6e443c90 109-- from einfo.adb, and processes it into C code. This results in some strict
70482933
RK
110-- restrictions on which functions can be inlined:
111
112-- The function spec must be on a single line
113
a2048d05
EB
114-- There can only be a single return statement, not counting any pragma
115-- Assert statements, possibly followed by a comment.
70482933 116
a2048d05
EB
117-- This single statement must either contain a function call with simple,
118-- single token arguments, or it must contain a membership test of the form
119-- a in b, where a and b are single tokens, or it must contain an equality
120-- or inequality test of single tokens, or it must contain a disjunction of
121-- the preceding constructs.
70482933
RK
122
123-- For functions that are not inlined, there is no restriction on the body,
124-- and XEINFO generates a direct reference in the C header file which allows
4ef36ac7 125-- the C code in the backend to directly call the corresponding Ada body.
70482933
RK
126
127----------------------------------
128-- Handling of Type'Size Values --
129----------------------------------
130
a90bd866 131-- The Ada 95 RM contains some rather peculiar (to us) rules on the value
70482933
RK
132-- of type'Size (see RM 13.3(55)). We have found that attempting to use
133-- these RM Size values generally, and in particular for determining the
00332244 134-- default size of objects, creates chaos, and major incompatibilities in
70482933
RK
135-- existing code.
136
c846eedd
EB
137-- The Ada 2020 RM acknowledges it and adopts GNAT's Object_Size attribute
138-- for determining the default size of objects, but stops short of applying
139-- it universally like GNAT. Indeed the notable exceptions are nonaliased
140-- stand-alone objects, which are not covered by Object_Size in Ada 2020.
141
70482933
RK
142-- We proceed as follows, for discrete and fixed-point subtypes, we have
143-- two separate sizes for each subtype:
144
145-- The Object_Size, which is used for determining the default size of
146-- objects and components. This size value can be referred to using the
147-- Object_Size attribute. The phrase "is used" here means that it is
c846eedd 148-- the basis of the determination of the size. The back end is free to
70482933
RK
149-- pad this up if necessary for efficiency, e.g. an 8-bit stand-alone
150-- character might be stored in 32 bits on a machine with no efficient
151-- byte access instructions such as the Alpha.
152
c846eedd 153-- The default rules for the value of Object_Size are as follows:
70482933
RK
154
155-- The Object_Size for base subtypes reflect the natural hardware
156-- size in bits (see Ttypes and Cstand for integer types). For
d7d99211 157-- enumeration and fixed-point base subtypes have 8, 16, 32, or 64
70482933
RK
158-- bits for this size, depending on the range of values to be stored.
159
160-- The Object_Size of a subtype is the same as the Object_Size of
161-- the subtype from which it is obtained.
162
163-- The Object_Size of a derived base type is copied from the parent
164-- base type, and the Object_Size of a derived first subtype is copied
165-- from the parent first subtype.
166
c846eedd
EB
167-- The Ada 2020 RM defined attribute Object_Size uses this implementation.
168
169-- The Value_Size, which is the number of bits required to store a value
70482933 170-- of the type. This size can be referred to using the Value_Size
c846eedd 171-- attribute. This value is used for determining how tightly to pack
70482933
RK
172-- records or arrays with components of this type, and also affects
173-- the semantics of unchecked conversion (unchecked conversions where
174-- the Value_Size values differ generate a warning, and are potentially
175-- target dependent).
176
db222ead 177-- The default rules for the value of Value_Size are as follows:
70482933
RK
178
179-- The Value_Size for a base subtype is the minimum number of bits
180-- required to store all values of the type (including the sign bit
181-- only if negative values are possible).
182
183-- If a subtype statically matches the first subtype, then it has
184-- by default the same Value_Size as the first subtype. This is a
185-- consequence of RM 13.1(14) ("if two subtypes statically match,
186-- then their subtype-specific aspects are the same".)
187
188-- All other subtypes have a Value_Size corresponding to the minimum
189-- number of bits required to store all values of the subtype. For
190-- dynamic bounds, it is assumed that the value can range down or up
db222ead 191-- to the corresponding bound of the ancestor.
70482933 192
c846eedd 193-- The Ada 95 RM defined attribute Size is identified with Value_Size.
70482933
RK
194
195-- The Size attribute may be defined for a first-named subtype. This sets
196-- the Value_Size of the first-named subtype to the given value, and the
197-- Object_Size of this first-named subtype to the given value padded up
198-- to an appropriate boundary. It is a consequence of the default rules
199-- above that this Object_Size will apply to all further subtypes. On the
5d37ba92 200-- other hand, Value_Size is affected only for the first subtype, any
70482933
RK
201-- dynamic subtypes obtained from it directly, and any statically matching
202-- subtypes. The Value_Size of any other static subtypes is not affected.
203
204-- Value_Size and Object_Size may be explicitly set for any subtype using
c846eedd
EB
205-- an attribute definition clause. Note that the use of such a clause can
206-- cause the RM 13.1(14) rule to be violated, in Ada 95 and 2020 for the
207-- Value_Size attribute, but only in Ada 95 for the Object_Size attribute.
208-- If access types reference aliased objects whose subtypes have differing
209-- Object_Size values as a result of explicit attribute definition clauses,
210-- then it is erroneous to convert from one access subtype to the other.
211
212-- At the implementation level, the Esize field stores the Object_Size
213-- and the RM_Size field stores the Value_Size (hence the value of the
70482933
RK
214-- Size attribute, which, as noted above, is equivalent to Value_Size).
215
216-- To get a feel for the difference, consider the following examples (note
217-- that in each case the base is short_short_integer with a size of 8):
218
219-- Object_Size Value_Size
220
221-- type x1 is range 0..5; 8 3
222
223-- type x2 is range 0..5;
93c3fca7 224-- for x2'size use 12; 16 12
70482933 225
93c3fca7 226-- subtype x3 is x2 range 0 .. 3; 16 2
70482933
RK
227
228-- subtype x4 is x2'base range 0 .. 10; 8 4
229
5389e4ae 230-- dynamic : x2'Base range -64 .. +63;
70482933 231
5389e4ae 232-- subtype x5 is x2 range 0 .. dynamic; 16 3*
70482933 233
5389e4ae
RD
234-- subtype x6 is x2'base range 0 .. dynamic; 8 7*
235
236-- Note: the entries marked * are not actually specified by the Ada 95 RM,
70482933
RK
237-- but it seems in the spirit of the RM rules to allocate the minimum number
238-- of bits known to be large enough to hold the given range of values.
239
240-- So far, so good, but GNAT has to obey the RM rules, so the question is
241-- under what conditions must the RM Size be used. The following is a list
242-- of the occasions on which the RM Size must be used:
243
244-- Component size for packed arrays or records
245-- Value of the attribute Size for a type
246-- Warning about sizes not matching for unchecked conversion
247
248-- The RM_Size field keeps track of the RM Size as needed in these
249-- three situations.
250
4f91a255
AC
251-- For elementary types other than discrete and fixed-point types, the
252-- Object_Size and Value_Size are the same (and equivalent to the RM
f3b57ab0 253-- attribute Size). Only Size may be specified for such types.
4f91a255
AC
254
255-- For composite types, Object_Size and Value_Size are computed from their
256-- respective value for the type of each element as well as the layout.
70482933 257
5d37ba92
ES
258-- All size attributes are stored as Uint values. Negative values are used to
259-- reference GCC expressions for the case of non-static sizes, as explained
260-- in Repinfo.
261
e2534738
AC
262--------------------------------------
263-- Delayed Freezing and Elaboration --
264--------------------------------------
265
266-- The flag Has_Delayed_Freeze indicates that an entity carries an explicit
267-- freeze node, which appears later in the expanded tree.
268
257baf5a 269-- a) The flag is used by the front end to trigger expansion activities which
e2534738
AC
270-- include the generation of that freeze node. Typically this happens at the
271-- end of the current compilation unit, or before the first subprogram body is
257baf5a 272-- encountered in the current unit. See units Freeze and Exp_Ch13 for details
e2534738
AC
273-- on the actions triggered by a freeze node, which include the construction
274-- of initialization procedures and dispatch tables.
275
257baf5a 276-- b) The presence of a freeze node on an entity is used by the back end to
c159409f 277-- defer elaboration of the entity until its freeze node is seen. In the
e2534738
AC
278-- absence of an explicit freeze node, an entity is frozen (and elaborated)
279-- at the point of declaration.
280
281-- For object declarations, the flag is set when an address clause for the
282-- object is encountered. Legality checks on the address expression only take
257baf5a 283-- place at the freeze point of the object. In Ada 2012, the flag is also set
4c1e5395 284-- when an address aspect for the object is encountered.
e2534738
AC
285
286-- Most types have an explicit freeze node, because they cannot be elaborated
287-- until all representation and operational items that apply to them have been
288-- analyzed. Private types and incomplete types have the flag set as well, as
289-- do task and protected types.
290
257baf5a 291-- Implicit base types created for type derivations, as well as class-wide
e2534738
AC
292-- types created for all tagged types, have the flag set.
293
294-- If a subprogram has an access parameter whose designated type is incomplete
295-- the subprogram has the flag set.
296
70482933
RK
297-----------------------
298-- Entity Attributes --
299-----------------------
300
301-- This section contains a complete list of the attributes that are defined
302-- on entities. Some attributes apply to all entities, others only to certain
303-- kinds of entities. In the latter case the attribute should only be set or
304-- accessed if the Ekind field indicates an appropriate entity.
305
306-- There are two kinds of attributes that apply to entities, stored and
307-- synthesized. Stored attributes correspond to a field or flag in the entity
308-- itself. Such attributes are identified in the table below by giving the
309-- field or flag in the attribute that is used to hold the attribute value.
310-- Synthesized attributes are not stored directly, but are rather computed as
311-- needed from other attributes, or from information in the tree. These are
312-- marked "synthesized" in the table below. The stored attributes have both
313-- access functions and set procedures to set the corresponding values, while
314-- synthesized attributes have only access functions.
315
e95ad7ea
RD
316-- Note: in the case of Node, Uint, or Elist fields, there are cases where the
317-- same physical field is used for different purposes in different entities,
318-- so these access functions should only be referenced for the class of
319-- entities in which they are defined as being present. Flags are not
320-- overlapped in this way, but nevertheless as a matter of style and
321-- abstraction (which may or may not be checked by assertions in the
322-- body), this restriction should be observed for flag fields as well.
70482933
RK
323
324-- Note: certain of the attributes on types apply only to base types, and
325-- are so noted by the notation [base type only]. These are cases where the
326-- attribute of any subtype is the same as the attribute of the base type.
327-- The attribute can be referenced on a subtype (and automatically retrieves
07fc65c4
GB
328-- the value from the base type). However, it is an error to try to set the
329-- attribute on other than the base type, and if assertions are enabled,
330-- an attempt to set the attribute on a subtype will raise an assert error.
70482933 331
21d27997 332-- Other attributes are noted as applying to the [implementation base type
64ac53f4 333-- only]. These are representation attributes which must always apply to a
21d27997 334-- full non-private type, and where the attributes are always on the full
91669e7e 335-- type. The attribute can be referenced on a subtype (and automatically
2eda24e9 336-- retrieves the value from the implementation base type). However, it is an
21d27997
RD
337-- error to try to set the attribute on other than the implementation base
338-- type, and if assertions are enabled, an attempt to set the attribute on a
07fc65c4 339-- subtype will raise an assert error.
70482933 340
cf6956bb
AC
341-- Abstract_States (Elist25)
342-- Defined for E_Package entities. Contains a list of all the abstract
343-- states declared by the related package.
344
70482933 345-- Accept_Address (Elist21)
30ebb114 346-- Defined in entries. If an accept has a statement sequence, then an
70482933
RK
347-- address variable is created, which is used to hold the address of the
348-- parameters, as passed by the runtime. Accept_Address holds an element
349-- list which represents a stack of entities for these address variables.
350-- The current entry is the top of the stack, which is the last element
351-- on the list. A stack is required to handle the case of nested select
352-- statements referencing the same entry.
353
3fd9f17c 354-- Access_Disp_Table (Elist16) [implementation base type only]
30ebb114 355-- Defined in E_Record_Type and E_Record_Subtype entities. Set in tagged
0d53d36b
AC
356-- types to point to their dispatch tables. The first two entities are
357-- associated with the primary dispatch table: 1) primary dispatch table
358-- with user-defined primitives 2) primary dispatch table with predefined
359-- primitives. For each interface type covered by the tagged type we also
360-- have: 3) secondary dispatch table with thunks of primitives covering
361-- user-defined interface primitives, 4) secondary dispatch table with
362-- thunks of predefined primitives, 5) secondary dispatch table with user
363-- defined primitives, and 6) secondary dispatch table with predefined
364-- primitives. The last entity of this list is an access type declaration
365-- used to expand dispatching calls through the primary dispatch table.
7c0c194b 366-- For an untagged record, contains No_Elist.
3fd9f17c 367
fe683ef6
AC
368-- Access_Disp_Table_Elab_Flag (Node30) [implementation base type only]
369-- Defined in E_Record_Type and E_Record_Subtype entities. Set in tagged
83b77c5c
AC
370-- types whose dispatch table elaboration must be completed at run time
371-- by the IP routine to point to its pending elaboration flag entity.
372-- This flag is needed when the elaboration of the dispatch table relies
373-- on attribute 'Position applied to an object of the type; it is used by
fe683ef6
AC
374-- the IP routine to avoid performing this elaboration twice.
375
dc419b9f
ES
376-- Access_Subprogram_Wrapper (Node41)
377-- Entity created for access_to_subprogram types that have pre/post
378-- conditions. Wrapper subprogram is created when analyzing corresponding
379-- aspect, and inherits said aspects. Body of subprogram includes code
380-- to check contracts, and a direct call to the designated subprogram.
381-- The body is part of the freeze actions for the type.
382-- The Subprogram_Type created for the Access_To_Subprogram carries the
383-- Access_Subprogram_Wrapper for use in the expansion of indirect calls.
384
3830827c 385-- Activation_Record_Component (Node31)
54e33e5f
ES
386-- Defined for E_Variable, E_Constant, E_Loop_Parameter, and formal
387-- parameter entities. Used in Opt.Unnest_Subprogram_Mode, in which case
388-- a reference to an uplevel entity produces a corresponding component
389-- in the generated ARECnT activation record (Exp_Unst for details).
3830827c 390
70482933 391-- Actual_Subtype (Node17)
30ebb114 392-- Defined in variables, constants, and formal parameters. This is the
70482933
RK
393-- subtype imposed by the value of the object, as opposed to its nominal
394-- subtype, which is imposed by the declaration. The actual subtype
395-- differs from the nominal one when the latter is indefinite (as in the
396-- case of an unconstrained formal parameter, or a variable declared
397-- with an unconstrained type and an initial value). The nominal subtype
398-- is the Etype entry for the entity. The Actual_Subtype field is set
399-- only if the actual subtype differs from the nominal subtype. If the
400-- actual and nominal subtypes are the same, then the Actual_Subtype
401-- field is Empty, and Etype indicates both types.
980f237d 402--
70482933
RK
403-- For objects, the Actual_Subtype is set only if this is a discriminated
404-- type. For arrays, the bounds of the expression are obtained and the
405-- Etype of the object is directly the constrained subtype. This is
406-- rather irregular, and the semantic checks that depend on the nominal
407-- subtype being unconstrained use flag Is_Constr_Subt_For_U_Nominal(qv).
408
70482933
RK
409-- Address_Clause (synthesized)
410-- Applies to entries, objects and subprograms. Set if an address clause
411-- is present which references the object or subprogram and points to
412-- the N_Attribute_Definition_Clause node. Empty if no Address clause.
413-- The expression in the address clause is always a constant that is
414-- defined before the entity to which the address clause applies.
28bc3323 415-- Note: The backend references this field in E_Task_Type entities???
70482933
RK
416
417-- Address_Taken (Flag104)
30ebb114 418-- Defined in all entities. Set if the Address or Unrestricted_Access
70482933 419-- attribute is applied directly to the entity, i.e. the entity is the
7e4680c1
EB
420-- entity of the prefix of the attribute reference. Also set if the
421-- entity is the second argument of an Asm_Input or Asm_Output attribute,
2168d7cc
AC
422-- as the construct may entail taking its address. And also set if the
423-- entity is a subprogram and the Access or Unchecked_Access attribute is
424-- applied. Used by the backend to make sure that the address can be
425-- meaningfully taken, and also in the case of subprograms to control
426-- output of certain warnings.
70482933 427
5087048c 428-- Aft_Value (synthesized)
2015a575
EB
429-- Applies to fixed-point types and subtypes. This yields the value of
430-- the Aft attribute for the type, i.e. the number of decimal digits
431-- needed after the decimal point to accommodate the delta of the type,
432-- unless the delta is greater than 0.1, in which case it is 1.
5087048c 433
70482933 434-- Alias (Node18)
30ebb114 435-- Defined in overloadable entities (literals, subprograms, entries) and
6e443c90 436-- subprograms that cover a primitive operation of an abstract interface
ce2b6ba5
JM
437-- (that is, subprograms with the Interface_Alias attribute). In case of
438-- overloaded entities it points to the parent subprogram of a derived
439-- subprogram. In case of abstract interface subprograms it points to the
440-- subprogram that covers the abstract interface primitive. Also used for
d994a6e2
RD
441-- a subprogram renaming, where it points to the renamed subprogram. For
442-- an inherited operation (of a type extension) that is overridden in a
443-- private part, the Alias is the overriding operation. In this fashion a
444-- call from outside the package ends up executing the new body even if
445-- non-dispatching, and a call from inside calls the overriding operation
446-- because it hides the implicit one. Alias is always empty for entries.
70482933
RK
447
448-- Alignment (Uint14)
30ebb114 449-- Defined in entities for types and also in constants, variables
0a36105d
JM
450-- (including exceptions where it refers to the static data allocated for
451-- an exception), loop parameters, and formal parameters. This indicates
452-- the desired alignment for a type, or the actual alignment for an
453-- object. A value of zero (Uint_0) indicates that the alignment has not
454-- been set yet. The alignment can be set by an explicit alignment
455-- clause, or set by the front-end in package Layout, or set by the
28bc3323 456-- back-end as part of the back-end back-annotation process. The
30ebb114 457-- alignment field is also defined in E_Exception entities, but there it
0a36105d 458-- is used only by the back-end for back annotation.
70482933
RK
459
460-- Alignment_Clause (synthesized)
ba673907 461-- Applies to all entities for types and objects. If an alignment
70482933
RK
462-- attribute definition clause is present for the entity, then this
463-- function returns the N_Attribute_Definition clause that specifies the
464-- alignment. If no alignment clause applies to the type, then the call
465-- to this function returns Empty. Note that the call can return a
466-- non-Empty value even if Has_Alignment_Clause is not set (happens with
467-- subtype and derived type declarations). Note also that a record
468-- definition clause with an (obsolescent) mod clause is converted
469-- into an attribute definition clause for this purpose.
470
5b42c035
AC
471-- Anonymous_Designated_Type (Node35)
472-- Defined in variables which represent anonymous finalization masters.
c9d2e84b 473-- Contains the designated type which is being serviced by the master.
5b42c035
AC
474
475-- Anonymous_Masters (Elist29)
476-- Defined in packages, subprograms, and subprogram bodies. Contains a
477-- list of anonymous finalization masters declared within the related
478-- unit. The list acts as a mapping between a master and a designated
479-- type.
57ae790f 480
75b87c16
AC
481-- Anonymous_Object (Node30)
482-- Present in protected and task type entities. Contains the entity of
483-- the anonymous object created for a single protected or task type.
484
caf07df9
AC
485-- Associated_Entity (Node37)
486-- Defined in all entities. This field is similar to Associated_Node, but
487-- applied to entities. The attribute links an entity from the generic
488-- template with its corresponding entity in the analyzed generic copy.
489-- The global references mechanism relies on the Associated_Entity to
490-- infer the context.
491
70482933 492-- Associated_Formal_Package (Node12)
30ebb114 493-- Defined in packages that are the actuals of formal_packages. Points
70482933
RK
494-- to the entity in the declaration for the formal package.
495
496-- Associated_Node_For_Itype (Node8)
30ebb114 497-- Defined in all type and subtype entities. Set non-Empty only for
70482933
RK
498-- Itypes. Set to point to the associated node for the Itype, i.e.
499-- the node whose elaboration generated the Itype. This is used for
ba673907
JM
500-- copying trees, to determine whether or not to copy an Itype, and
501-- also for accessibility checks on anonymous access types. This
502-- node is typically an object declaration, component declaration,
f9105bfa
AC
503-- type or subtype declaration.
504
505-- For an access discriminant in a type declaration, the associated_
506-- node_for_itype is the corresponding discriminant specification.
507
508-- For an access parameter it is the enclosing subprogram declaration.
509
510-- For an access_to_protected_subprogram parameter it is the declaration
511-- of the corresponding formal parameter.
e42bcfa3
AC
512--
513-- Itypes have no explicit declaration, and therefore are not attached to
514-- the tree: their Parent field is always empty. The Associated_Node_For_
515-- Itype is the only way to determine the construct that leads to the
516-- creation of a given itype entity.
70482933 517
07fc65c4 518-- Associated_Storage_Pool (Node22) [root type only]
30ebb114 519-- Defined in simple and general access type entities. References the
70482933 520-- storage pool to be used for the corresponding collection. A value of
30ebb114 521-- Empty means that the default pool is to be used. This is defined
07fc65c4
GB
522-- only in the root type, since derived types must have the same pool
523-- as the parent type.
70482933 524
70482933 525-- Barrier_Function (Node12)
30ebb114 526-- Defined in protected entries and entry families. This is the
70482933
RK
527-- subprogram declaration for the body of the function that returns
528-- the value of the entry barrier.
529
530-- Base_Type (synthesized)
a01b9df6
AC
531-- Applies to all type and subtype entities. Returns the base type of a
532-- type or subtype. The base type of a type is the type itself. The base
533-- type of a subtype is the type that it constrains (which is always
534-- a type entity, not some other subtype). Note that in the case of a
535-- subtype of a private type, it is possible for the base type attribute
536-- to return a private type, even if the subtype to which it applies is
537-- non-private. See also Implementation_Base_Type. Note: it is allowed to
538-- apply Base_Type to other than a type, in which case it simply returns
539-- the entity unchanged.
70482933
RK
540
541-- Block_Node (Node11)
30ebb114 542-- Defined in block entities. Points to the identifier in the
57568d91 543-- Block_Statement itself. Used when retrieving the block construct
e8bb6ff9 544-- for finalization purposes, the block entity has an implicit label
57568d91 545-- declaration in the enclosing declarative part, and has otherwise
4ba603e2 546-- no direct connection in the tree with the block statement. The
f3d0f304 547-- link is to the identifier (which is an occurrence of the entity)
57568d91
ES
548-- and not to the block_statement itself, because the statement may
549-- be rewritten, e.g. in the process of removing dead code.
70482933
RK
550
551-- Body_Entity (Node19)
30ebb114 552-- Defined in package and generic package entities, points to the
c84700e7 553-- corresponding package body entity if one is present.
70482933 554
fbf5a39b 555-- Body_Needed_For_SAL (Flag40)
30ebb114 556-- Defined in package and subprogram entities that are compilation
fbf5a39b
AC
557-- units. Indicates that the source for the body must be included
558-- when the unit is part of a standalone library.
559
b03d3f73
AC
560-- Body_Needed_For_Inlining (Flag299)
561-- Defined in package entities that are compilation units. Used to
562-- determine whether the body unit needs to be compiled when the
563-- package declaration appears in the list of units to inline. A body
564-- is needed for inline processing if the unit declaration contains
565-- functions that carry pragma Inline or Inline_Always, or if it
566-- contains a generic unit that requires a body.
567--
8a7c0400 568-- Body_References (Elist16)
5627964c
AC
569-- Defined in abstract state entities. Contains an element list of
570-- references (identifiers) that appear in a package body whose spec
571-- defines the related state. If the body refines the said state, all
572-- references on this list are illegal due to the visible refinement.
8a7c0400 573
8c7ff9a0
AC
574-- BIP_Initialization_Call (Node29)
575-- Defined in constants and variables whose corresponding declaration
576-- is wrapped in a transient block and the inital value is provided by
577-- a build-in-place function call. Contains the relocated build-in-place
578-- call after the expansion has decoupled the call from the object. This
579-- attribute is used by the finalization machinery to insert cleanup code
937e9676 580-- for all additional transient objects found in the transient block.
8c7ff9a0 581
70482933 582-- C_Pass_By_Copy (Flag125) [implementation base type only]
30ebb114 583-- Defined in record types. Set if a pragma Convention for the record
70482933
RK
584-- type specifies convention C_Pass_By_Copy. This convention name is
585-- treated as identical in all respects to convention C, except that
586-- if it is specified for a record type, then the C_Pass_By_Copy flag
587-- is set, and if a foreign convention subprogram has a formal of the
588-- corresponding type, then the parameter passing mechanism will be
589-- set to By_Copy (unless specifically overridden by an Import or
590-- Export pragma).
591
fbf5a39b 592-- Can_Never_Be_Null (Flag38)
149604e4
RD
593-- This flag is defined in all entities. It is set in an object which can
594-- never have a null value. Set for constant access values initialized to
595-- a non-null value. This is also set for all access parameters in Ada 83
596-- and Ada 95 modes, and for access parameters that explicitly exclude
ead7594f 597-- null in Ada 2005 mode.
0a36105d
JM
598--
599-- This is used to avoid unnecessary resetting of the Is_Known_Non_Null
600-- flag for such entities. In Ada 2005 mode, this is also used when
601-- determining subtype conformance of subprogram profiles to ensure
602-- that two formals have the same null-exclusion status.
603--
149604e4
RD
604-- This is also set on some access types, e.g. the Etype of the anonymous
605-- access type of a controlling formal.
fbf5a39b 606
df3e68b1 607-- Can_Use_Internal_Rep (Flag229) [base type only]
30ebb114 608-- Defined in Access_Subprogram_Kind nodes. This flag is set by the
28bc3323 609-- front end and used by the backend. False means that the backend
df3e68b1
HK
610-- must represent the type in the same way as Convention-C types (and
611-- other foreign-convention types). On many targets, this means that
28bc3323
AC
612-- the backend will use dynamically generated trampolines for nested
613-- subprograms. True means that the backend can represent the type in
df3e68b1 614-- some internal way. On the aforementioned targets, this means that the
28bc3323 615-- backend will not use dynamically generated trampolines. This flag
df3e68b1
HK
616-- must be False if Has_Foreign_Convention is True; otherwise, the front
617-- end is free to set the policy.
618--
619-- Setting this False in all cases corresponds to the traditional back
620-- end strategy, where all access-to-subprogram types are represented the
ca1ffed0 621-- same way, independent of the Convention. For further details, see also
df3e68b1
HK
622-- Always_Compatible_Rep in Targparm.
623--
624-- Efficiency note: On targets that use dynamically generated
625-- trampolines, False generally favors efficiency of top-level
626-- subprograms, whereas True generally favors efficiency of nested
627-- ones. On other targets, this flag has little or no effect on
628-- efficiency. The front end should take this into account. In
ca1ffed0
AC
629-- particular, pragma Favor_Top_Level gives a hint that the flag
630-- should be False.
df3e68b1
HK
631--
632-- Note: We considered using Convention-C for this purpose, but we need
ca1ffed0 633-- this separate flag, because Convention-C implies that in the case of
df3e68b1
HK
634-- P'[Unrestricted_]Access, P also have convention C. Sometimes we want
635-- to have Can_Use_Internal_Rep False for an access type, but allow P to
636-- have convention Ada.
637
70482933 638-- Chars (Name1)
30ebb114 639-- Defined in all entities. This field contains an entry into the names
70482933
RK
640-- table that has the character string of the identifier, character
641-- literal or operator symbol. See Namet for further details. Note that
642-- throughout the processing of the front end, this name is the simple
28bc3323
AC
643-- unqualified name. However, just before the backend is called, a call
644-- is made to Qualify_All_Entity_Names. This causes entity names to be
645-- qualified using the encoding described in exp_dbug.ads, and from that
646-- point (including post backend steps, e.g. cross-reference generation),
647-- the entities will contain the encoded qualified names.
70482933 648
fbf5a39b 649-- Checks_May_Be_Suppressed (Flag31)
30ebb114 650-- Defined in all entities. Set if a pragma Suppress or Unsuppress
fbf5a39b 651-- mentions the entity specifically in the second argument. If this
16b05213 652-- flag is set the Global_Entity_Suppress and Local_Entity_Suppress
dbf04430 653-- tables must be consulted to determine if there actually is an active
fbf5a39b
AC
654-- Suppress or Unsuppress pragma that applies to the entity.
655
7a71a7c4
AC
656-- Class_Wide_Clone (Node38)
657-- Defined on subprogram entities. Set if the subprogram has a class-wide
658-- ore- or postcondition, and the expression contains calls to other
659-- primitive funtions of the type. Used to implement properly the
660-- semantics of inherited operations whose class-wide condition may
661-- be different from that of the ancestor (See AI012-0195).
635ffc52 662
70482933 663-- Class_Wide_Type (Node9)
30ebb114 664-- Defined in all type entities. For a tagged type or subtype, returns
1bf773bb 665-- the corresponding implicitly declared class-wide type. For a
7c0c194b 666-- class-wide type, returns itself. Set to Empty for untagged types.
70482933
RK
667
668-- Cloned_Subtype (Node16)
30ebb114 669-- Defined in E_Record_Subtype and E_Class_Wide_Subtype entities.
70482933
RK
670-- Each such entity can either have a Discriminant_Constraint, in
671-- which case it represents a distinct type from the base type (and
76fc4a85 672-- will have a list of components and discriminants in the list headed by
70482933
RK
673-- First_Entity) or else no such constraint, in which case it will be a
674-- copy of the base type.
675--
676-- o Each element of the list in First_Entity is copied from the base
677-- type; in that case, this field is Empty.
678--
679-- o The list in First_Entity is shared with the base type; in that
680-- case, this field points to that entity.
681--
682-- A record or classwide subtype may also be a copy of some other
683-- subtype and share the entities in the First_Entity with that subtype.
684-- In that case, this field points to that subtype.
685--
686-- For E_Class_Wide_Subtype, the presence of Equivalent_Type overrides
31fde973
GD
687-- this field. Note that this field ONLY appears in subtype entities, not
688-- in type entities, it is not defined, and it is an error to reference
70482933
RK
689-- Cloned_Subtype in an E_Record_Type or E_Class_Wide_Type entity.
690
691-- Comes_From_Source
692-- This flag appears on all nodes, including entities, and indicates
693-- that the node was created by the scanner or parser from the original
694-- source. Thus for entities, it indicates that the entity is defined
695-- in the original source program.
696
697-- Component_Alignment (special field) [base type only]
30ebb114 698-- Defined in array and record entities. Contains a value of type
70482933
RK
699-- Component_Alignment_Kind indicating the alignment of components.
700-- Set to Calign_Default normally, but can be overridden by use of
701-- the Component_Alignment pragma. Note: this field is currently
702-- stored in a non-standard way, see body for details.
703
704-- Component_Bit_Offset (Uint11)
354ae449
AC
705-- Defined in record components (E_Component, E_Discriminant). First
706-- bit position of given component, computed from the first bit and
707-- position values given in the component clause. A value of No_Uint
708-- means that the value is not yet known. The value can be set by the
709-- appearance of an explicit component clause in a record representation
710-- clause, or it can be set by the front-end in package Layout, or it can
711-- be set by the backend. By the time backend processing is completed,
70482933
RK
712-- this field is always set. A negative value is used to represent
713-- a value which is not known at compile time, and must be computed
714-- at run-time (this happens if fields of a record have variable
715-- lengths). See package Layout for details of these values.
716--
ae65d635
AC
717-- Note: Component_Bit_Offset is redundant with respect to the fields
718-- Normalized_First_Bit and Normalized_Position, and could in principle
719-- be eliminated, but it is convenient in several situations, including
28bc3323 720-- use in the backend, to have this redundant field.
70482933
RK
721
722-- Component_Clause (Node13)
30ebb114 723-- Defined in record components and discriminants. If a record
5132708f
RD
724-- representation clause is present for the corresponding record type a
725-- that specifies a position for the component, then the Component_Clause
726-- field of the E_Component entity points to the N_Component_Clause node.
727-- Set to Empty if no record representation clause was present, or if
728-- there was no specification for this component.
70482933
RK
729
730-- Component_Size (Uint22) [implementation base type only]
30ebb114 731-- Defined in array types. It contains the component size value for
82c80734 732-- the array. A value of No_Uint means that the value is not yet set.
70482933
RK
733-- The value can be set by the use of a component size clause, or
734-- by the front end in package Layout, or by the backend. A negative
735-- value is used to represent a value which is not known at compile
736-- time, and must be computed at run-time (this happens if the type
737-- of the component has a variable length size). See package Layout
738-- for details of these values.
739
740-- Component_Type (Node20) [implementation base type only]
30ebb114 741-- Defined in array types and string types. References component type.
70482933 742
8636f52f
HK
743-- Contains_Ignored_Ghost_Code (Flag279)
744-- Defined in blocks, packages and their bodies, subprograms and their
745-- bodies. Set if the entity contains any ignored Ghost code in the form
746-- of declaration, procedure call, assignment statement or pragma.
747
02886c2e 748-- Contract (Node34)
f99ff327 749-- Defined in constant, entry, entry family, operator, [generic] package,
4127ebec
SB
750-- package body, protected unit, [generic] subprogram, subprogram body,
751-- variable, task unit, and type entities. Points to the contract of the
752-- entity, holding various assertion items and data classifiers.
02886c2e 753
8a0183fd
HK
754-- Contract_Wrapper (Node25)
755-- Defined in entry and entry family entities. Set only when the entry
756-- [family] has contract cases, preconditions, and/or postconditions.
757-- Contains the entity of a wrapper procedure which encapsulates the
758-- original entry and implements precondition/postcondition semantics.
759
70482933 760-- Corresponding_Concurrent_Type (Node18)
30ebb114 761-- Defined in record types that are constructed by the expander to
70482933 762-- represent task and protected types (Is_Concurrent_Record_Type flag
124092ee 763-- set). Points to the entity for the corresponding task type or the
70482933
RK
764-- protected type.
765
766-- Corresponding_Discriminant (Node19)
30ebb114 767-- Defined in discriminants of a derived type, when the discriminant is
70482933
RK
768-- used to constrain a discriminant of the parent type. Points to the
769-- corresponding discriminant in the parent type. Otherwise it is Empty.
770
477cfc5b 771-- Corresponding_Equality (Node30)
30ebb114 772-- Defined in function entities for implicit inequality operators.
70482933
RK
773-- Denotes the explicit or derived equality operation that creates
774-- the implicit inequality. Note that this field is not present in
775-- other function entities, only in implicit inequality routines,
776-- where Comes_From_Source is always False.
777
888be6b1
AC
778-- Corresponding_Function (Node32)
779-- Defined on procedures internally built with an extra out parameter
780-- to return a constrained array type, when Modify_Tree_For_C is set.
781-- Denotes the function that returns the constrained array type for
782-- which this procedure was built.
783
784-- Corresponding_Procedure (Node32)
785-- Defined on functions that return a constrained array type, when
786-- Modify_Tree_For_C is set. Denotes the internally built procedure
787-- with an extra out parameter created for it.
788
5042f726 789-- Corresponding_Protected_Entry (Node18)
30ebb114 790-- Defined in subprogram bodies. Set for subprogram bodies that implement
bd29d519 791-- a protected type entry to point to the entity for the entry.
5042f726 792
05dbb83f
AC
793-- Corresponding_Record_Component (Node21)
794-- Defined in components of a derived untagged record type, including
795-- discriminants. For a regular component or a girder discriminant,
796-- points to the corresponding component in the parent type. Set to
797-- Empty for a non-girder discriminant. It is used by the back end to
798-- ensure the layout of the derived type matches that of the parent
799-- type when there is no representation clause on the derived type.
800
70482933 801-- Corresponding_Record_Type (Node18)
30ebb114 802-- Defined in protected and task types and subtypes. References the
70482933
RK
803-- entity for the corresponding record type constructed by the expander
804-- (see Exp_Ch9). This type is used to represent values of the task type.
805
806-- Corresponding_Remote_Type (Node22)
30ebb114 807-- Defined in record types that describe the fat pointer structure for
308e6f3a 808-- Remote_Access_To_Subprogram types. References the original access
d67f5bbb 809-- to subprogram type.
70482933
RK
810
811-- CR_Discriminant (Node23)
30ebb114 812-- Defined in discriminants of concurrent types. Denotes the homologous
6e443c90
RD
813-- discriminant of the corresponding record type. The CR_Discriminant is
814-- created at the same time as the discriminal, and used to replace
815-- occurrences of the discriminant within the type declaration.
70482933 816
21d27997 817-- Current_Use_Clause (Node27)
30ebb114 818-- Defined in packages and in types. For packages, denotes the use
21d27997
RD
819-- package clause currently in scope that makes the package use_visible.
820-- For types, it denotes the use_type clause that makes the operators of
821-- the type visible. Used for more precise warning messages on redundant
822-- use clauses.
f4d379b8 823
fbf5a39b 824-- Current_Value (Node9)
30ebb114 825-- Defined in all object entities. Set in E_Variable, E_Constant, formal
6e443c90
RD
826-- parameters and E_Loop_Parameter entities if we have trackable current
827-- values. Set non-Empty if the (constant) current value of the variable
8e334288 828-- is known. This value is valid only for references from the same
6e443c90
RD
829-- sequential scope as the entity. The sequential scope of an entity
830-- includes the immediate scope and any contained scopes that are package
831-- specs, package bodies, blocks (at any nesting level) or statement
832-- sequences in IF or loop statements.
fbf5a39b 833--
6e443c90
RD
834-- Another related use of this field is to record information about the
835-- value obtained from an IF or WHILE statement condition. If the IF or
836-- ELSIF or WHILE condition has the form "NOT {,NOT] OBJ RELOP VAL ",
837-- or OBJ [AND [THEN]] expr, where OBJ refers to an entity with a
838-- Current_Value field, RELOP is one of the six relational operators, and
839-- VAL is a compile-time known value then the Current_Value field of OBJ
840-- points to the N_If_Statement, N_Elsif_Part, or N_Iteration_Scheme node
841-- of the relevant construct, and the Condition field of this can be
842-- consulted to give information about the value of OBJ. For more details
843-- on this usage, see the procedure Exp_Util.Get_Current_Value_Condition.
fbf5a39b 844
70482933 845-- Debug_Info_Off (Flag166)
30ebb114 846-- Defined in all entities. Set if a pragma Suppress_Debug_Info applies
70482933 847-- to the entity, or if internal processing in the compiler determines
fbf5a39b
AC
848-- that suppression of debug information is desirable. Note that this
849-- flag is only for use by the front end as part of the processing for
28bc3323 850-- determining if Needs_Debug_Info should be set. The backend should
fbf5a39b 851-- always test Needs_Debug_Info, it should never test Debug_Info_Off.
70482933 852
4c8e94ab
GD
853-- Debug_Renaming_Link (Node25)
854-- Used to link the variable associated with a debug renaming declaration
70482933
RK
855-- to the renamed entity. See Exp_Dbug.Debug_Renaming_Declaration for
856-- details of the use of this field.
857
858-- Declaration_Node (synthesized)
ea034236
AC
859-- Applies to all entities. Returns the tree node for the construct that
860-- declared the entity. Normally this is just the Parent of the entity.
861-- One exception arises with child units, where the parent of the entity
862-- is a selected component/defining program unit name. Another exception
b98e2969
AC
863-- is that if the entity is an incomplete type that has been completed or
864-- a private type, then we obtain the declaration node denoted by the
865-- full type, i.e. the full type declaration node. Also note that for
866-- subprograms, this returns the {function,procedure}_specification, not
867-- the subprogram_declaration.
70482933 868
688a9b51 869-- Default_Aspect_Component_Value (Node19) [base type only]
30ebb114 870-- Defined in array types. Holds the static value specified in a
27fd9ad8
ES
871-- Default_Component_Value aspect specification for the array type,
872-- or inherited on derivation.
37da997b 873
688a9b51 874-- Default_Aspect_Value (Node19) [base type only]
30ebb114 875-- Defined in scalar types. Holds the static value specified in a
27fd9ad8
ES
876-- Default_Value aspect specification for the type, or inherited
877-- on derivation.
37da997b 878
70482933 879-- Default_Expr_Function (Node21)
30ebb114 880-- Defined in parameters. It holds the entity of the parameterless
70482933
RK
881-- function that is built to evaluate the default expression if it is
882-- more complex than a simple identifier or literal. For the latter
883-- simple cases or if there is no default value, this field is Empty.
884
885-- Default_Expressions_Processed (Flag108)
886-- A flag in subprograms (functions, operators, procedures) and in
887-- entries and entry families used to indicate that default expressions
888-- have been processed and to avoid multiple calls to process the
889-- default expressions (see Freeze.Process_Default_Expressions), which
890-- would not only waste time, but also generate false error messages.
891
892-- Default_Value (Node20)
30ebb114 893-- Defined in formal parameters. Points to the node representing the
70482933
RK
894-- expression for the default value for the parameter. Empty if the
895-- parameter has no default value (which is always the case for OUT
896-- and IN OUT parameters in the absence of errors).
897
898-- Delay_Cleanups (Flag114)
30ebb114 899-- Defined in entities that have finalization lists (subprograms
70482933
RK
900-- blocks, and tasks). Set if there are pending generic body
901-- instantiations for the corresponding entity. If this flag is
902-- set, then generation of cleanup actions for the corresponding
903-- entity must be delayed, since the insertion of the generic body
904-- may affect cleanup generation (see Inline for further details).
905
906-- Delay_Subprogram_Descriptors (Flag50)
30ebb114 907-- Defined in entities for which exception subprogram descriptors
70482933 908-- are generated (subprograms, package declarations and package
30ebb114 909-- bodies). Defined if there are pending generic body instantiations
70482933
RK
910-- for the corresponding entity. If this flag is set, then generation
911-- of the subprogram descriptor for the corresponding enities must
912-- be delayed, since the insertion of the generic body may add entries
913-- to the list of handlers.
914--
915-- Note: for subprograms, Delay_Subprogram_Descriptors is set if and
916-- only if Delay_Cleanups is set. But Delay_Cleanups can be set for a
917-- a block (in which case Delay_Subprogram_Descriptors is set for the
918-- containing subprogram). In addition Delay_Subprogram_Descriptors is
919-- set for a library level package declaration or body which contains
920-- delayed instantiations (in this case the descriptor refers to the
921-- enclosing elaboration procedure).
922
923-- Delta_Value (Ureal18)
30ebb114 924-- Defined in fixed and decimal types. Points to a universal real
70482933
RK
925-- that holds value of delta for the type, as given in the declaration
926-- or as inherited by a subtype or derived type.
927
928-- Dependent_Instances (Elist8)
30ebb114 929-- Defined in packages that are instances. Holds list of instances
70482933
RK
930-- of inner generics. Used to place freeze nodes for those instances
931-- after that of the current one, i.e. after the corresponding generic
932-- bodies.
933
934-- Depends_On_Private (Flag14)
30ebb114 935-- Defined in all type entities. Set if the type is private or if it
70482933
RK
936-- depends on a private type.
937
ab01e614 938-- Derived_Type_Link (Node31)
31fde973 939-- Defined in all type and subtype entities. Set in a base type if
ab01e614
AC
940-- a derived type declaration is encountered which derives from
941-- this base type or one of its subtypes, and there are already
942-- primitive operations declared. In this case, it references the
943-- entity for the type declared by the derived type declaration.
944-- For example:
945--
946-- type R is ...
947-- subtype RS is R ...
948-- ...
949-- type G is new RS ...
950--
951-- In this case, if primitive operations have been declared for R, at
952-- the point of declaration of G, then the Derived_Type_Link of R is set
cfedf3e5
SB
953-- to point to the entity for G. This is used to generate warnings and
954-- errors for rep clauses that appear later on for R, which might result
955-- in an unexpected (or illegal) implicit conversion operation.
ab01e614
AC
956--
957-- Note: if there is more than one such derived type, the link will point
cfedf3e5 958-- to the last one.
ab01e614 959
70482933 960-- Designated_Type (synthesized)
0c3985a9
AC
961-- Applies to access types. Returns the designated type. Differs from
962-- Directly_Designated_Type in that if the access type refers to an
963-- incomplete type, and the full type is available, then this full type
964-- is returned instead of the incomplete type.
70482933 965
f63d601b
HK
966-- DIC_Procedure (synthesized)
967-- Defined in all type entities. Set for a private type and its full view
968-- when the type is subject to pragma Default_Initial_Condition (DIC), or
969-- when the type inherits a DIC pragma from a parent type. Points to the
970-- entity of a procedure which takes a single argument of the given type
e51102b2 971-- and verifies the assertion expression of the DIC pragma at run time.
f63d601b
HK
972
973-- Note: the reason this is marked as a synthesized attribute is that the
974-- way this is stored is as an element of the Subprograms_For_Type field.
975
70482933 976-- Digits_Value (Uint17)
30ebb114 977-- Defined in floating point types and subtypes and decimal types and
70482933
RK
978-- subtypes. Contains the Digits value specified in the declaration.
979
46202729 980-- Direct_Primitive_Operations (Elist10)
30ebb114 981-- Defined in tagged types and subtypes (including synchronized types),
fab2daeb 982-- in tagged private types and in tagged incomplete types. Element list
30ebb114 983-- of entities for primitive operations of the tagged type. Not defined
fab2daeb
AC
984-- in untagged types. In order to follow the C++ ABI, entities of
985-- primitives that come from source must be stored in this list in the
986-- order of their occurrence in the sources. For incomplete types the
ef2a63ba 987-- list is always empty.
27fd9ad8
ES
988-- When expansion is disabled the corresponding record type of a
989-- synchronized type is not constructed. In that case, such types
65f1ca2e 990-- carry this attribute directly.
ef2a63ba 991
70482933 992-- Directly_Designated_Type (Node20)
30ebb114 993-- Defined in access types. This field points to the type that is
70482933
RK
994-- directly designated by the access type. In the case of an access
995-- type to an incomplete type, this field references the incomplete
ffb35bbf
ES
996-- type. Directly_Designated_Type is typically used in implementing the
997-- static semantics of the language; in implementing dynamic semantics,
998-- we typically want the full view of the designated type. The function
999-- Designated_Type obtains this full type in the case of access to an
1000-- incomplete type.
70482933 1001
76f9c7f4 1002-- Disable_Controlled (Flag253) [base type only]
0cb81445
PMR
1003-- Present in all entities. Set for a controlled type subject to aspect
1004-- Disable_Controlled which evaluates to True. This flag is taken into
1005-- account in synthesized attribute Is_Controlled.
c8593453 1006
70482933 1007-- Discard_Names (Flag88)
30ebb114 1008-- Defined in types and exception entities. Set if pragma Discard_Names
70482933
RK
1009-- applies to the entity. It is also set for declarative regions and
1010-- package specs for which a Discard_Names pragma with zero arguments
1011-- has been encountered. The purpose of setting this flag is to be able
1012-- to set the Discard_Names attribute on enumeration types declared
fbf5a39b
AC
1013-- after the pragma within the same declarative region. This flag is
1014-- set to False if a Keep_Names pragma appears for an enumeration type.
70482933
RK
1015
1016-- Discriminal (Node17)
30ebb114 1017-- Defined in discriminants (Discriminant formal: GNAT's first
70482933 1018-- coinage). The entity used as a formal parameter that corresponds
fbf5a39b
AC
1019-- to a discriminant. See section "Handling of Discriminants" for
1020-- full details of the use of discriminals.
70482933
RK
1021
1022-- Discriminal_Link (Node10)
8398e82e
AC
1023-- Defined in E_In_Parameter or E_Constant entities. For discriminals,
1024-- points back to corresponding discriminant. For other entities, must
1025-- remain Empty.
70482933
RK
1026
1027-- Discriminant_Checking_Func (Node20)
30ebb114 1028-- Defined in components. Points to the defining identifier of the
70482933
RK
1029-- function built by the expander returns a Boolean indicating whether
1030-- the given record component exists for the current discriminant
1031-- values.
1032
1033-- Discriminant_Constraint (Elist21)
30ebb114 1034-- Defined in entities whose Has_Discriminants flag is set (concurrent
70482933
RK
1035-- types, subtypes, record types and subtypes, private types and
1036-- subtypes, limited private types and subtypes and incomplete types).
1037-- It is an error to reference the Discriminant_Constraint field if
fbf5a39b 1038-- Has_Discriminants is False.
70482933
RK
1039--
1040-- If the Is_Constrained flag is set, Discriminant_Constraint points
1041-- to an element list containing the discriminant constraints in the
1042-- same order in which the discriminants are declared.
1043--
1044-- If the Is_Constrained flag is not set but the discriminants of the
1045-- unconstrained type have default initial values then this field
1046-- points to an element list giving these default initial values in
1047-- the same order in which the discriminants are declared. Note that
1048-- in this case the entity cannot be a tagged record type, because
1049-- discriminants in this case cannot have defaults.
1050--
1051-- If the entity is a tagged record implicit type, then this field is
1052-- inherited from the first subtype (so that the itype is subtype
1053-- conformant with its first subtype, which is needed when the first
1054-- subtype overrides primitive operations inherited by the implicit
1055-- base type).
1056--
1057-- In all other cases Discriminant_Constraint contains the empty
52afb186 1058-- Elist (i.e. it is initialized with a call to New_Elmt_List).
70482933
RK
1059
1060-- Discriminant_Default_Value (Node20)
30ebb114 1061-- Defined in discriminants. Points to the node representing the
70482933
RK
1062-- expression for the default value of the discriminant. Set to
1063-- Empty if the discriminant has no default value.
1064
1065-- Discriminant_Number (Uint15)
30ebb114 1066-- Defined in discriminants. Gives the ranking of a discriminant in
70482933 1067-- the list of discriminants of the type, i.e. a sequential integer
a4100e55 1068-- index starting at 1 and ranging up to number of discriminants.
70482933 1069
b16d9747 1070-- Dispatch_Table_Wrappers (Elist26) [implementation base type only]
30ebb114 1071-- Defined in E_Record_Type and E_Record_Subtype entities. Set in library
0d53d36b
AC
1072-- level tagged type entities if we are generating statically allocated
1073-- dispatch tables. Points to the list of dispatch table wrappers
7c0c194b 1074-- associated with the tagged type. For an untagged record, contains
0d53d36b 1075-- No_Elist.
e18d6a15 1076
70482933 1077-- DTC_Entity (Node16)
30ebb114 1078-- Defined in function and procedure entities. Set to Empty unless
70482933 1079-- the subprogram is dispatching in which case it references the
0469274e
TQ
1080-- Dispatch Table pointer Component. For regular Ada tagged this, this
1081-- is the _Tag component. For CPP_Class types and their descendants,
1082-- this points to the component entity in the record that holds the
1083-- Vtable pointer for the Vtable containing the entry referencing the
1084-- subprogram.
70482933
RK
1085
1086-- DT_Entry_Count (Uint15)
30ebb114 1087-- Defined in E_Component entities. Only used for component marked
70482933
RK
1088-- Is_Tag. Store the number of entries in the Vtable (or Dispatch Table)
1089
6e443c90 1090-- DT_Offset_To_Top_Func (Node25)
30ebb114 1091-- Defined in E_Component entities. Only used for component marked
ba673907
JM
1092-- Is_Tag. If present it stores the Offset_To_Top function used to
1093-- provide this value in tagged types whose ancestor has discriminants.
1094
70482933 1095-- DT_Position (Uint15)
30ebb114 1096-- Defined in function and procedure entities which are dispatching
70482933
RK
1097-- (should not be referenced without first checking that flag
1098-- Is_Dispatching_Operation is True). Contains the offset into
1099-- the Vtable for the entry that references the subprogram.
1100
1101-- Ekind (Ekind)
30ebb114 1102-- Defined in all entities. Contains a value of the enumeration type
70482933
RK
1103-- Entity_Kind declared in a subsequent section in this spec.
1104
6e443c90 1105-- Elaborate_Body_Desirable (Flag210)
30ebb114 1106-- Defined in package entities. Set if the elaboration circuitry detects
6e443c90
RD
1107-- a case where there is a package body that modifies one or more visible
1108-- entities in the package spec and there is no explicit Elaborate_Body
1109-- pragma for the package. This information is passed on to the binder,
1110-- which attempts, but does not promise, to elaborate the body as close
1111-- to the spec as possible.
1112
70482933 1113-- Elaboration_Entity (Node13)
3f99a611
HK
1114-- Defined in entry, entry family, [generic] package, and subprogram
1115-- entities. This is a counter associated with the unit that is initially
1116-- set to zero, is incremented when an elaboration request for the unit
1117-- is made, and is decremented when a finalization request for the unit
824e9320
AC
1118-- is made. This is used for three purposes. First, it is used to
1119-- implement access before elaboration checks (the counter must be
1120-- non-zero to call a subprogram at elaboration time). Second, it is
1121-- used to guard against repeated execution of the elaboration code.
1122-- Third, it is used to ensure that the finalization code is executed
1123-- only after all clients have requested it.
70482933 1124--
824e9320 1125-- Note that we always allocate this counter, and set this field, but
70482933 1126-- we do not always actually use it. It is only used if it is needed
824e9320 1127-- for access before elaboration use (see Elaboration_Entity_Required
70482933
RK
1128-- flag) or if either the spec or the body has elaboration code. If
1129-- neither of these two conditions holds, then the entity is still
1130-- allocated (since we don't know early enough whether or not there
1131-- is elaboration code), but is simply not used for any purpose.
1132
1133-- Elaboration_Entity_Required (Flag174)
3f99a611
HK
1134-- Defined in entry, entry family, [generic] package, and subprogram
1135-- entities. Set only if Elaboration_Entity is non-Empty to indicate that
1136-- the counter is required to be non-zero even if there is no other
824e9320
AC
1137-- elaboration code. This occurs when the Elaboration_Entity counter
1138-- is used for access before elaboration checks. If the counter is
1139-- only used to prevent multiple execution of the elaboration code,
1140-- then if there is no other elaboration code, obviously there is no
1141-- need to set the flag.
70482933 1142
caf07df9 1143-- Encapsulating_State (Node32)
75b87c16
AC
1144-- Defined in abstract state, constant and variable entities. Contains
1145-- the entity of an ancestor state or a single concurrent type whose
1146-- refinement utilizes this item as a constituent.
d7af5ea5 1147
70482933 1148-- Enclosing_Scope (Node18)
30ebb114 1149-- Defined in labels. Denotes the innermost enclosing construct that
70482933
RK
1150-- contains the label. Identical to the scope of the label, except for
1151-- labels declared in the body of an accept statement, in which case the
1152-- entry_name is the Enclosing_Scope. Used to validate goto's within
1153-- accept statements.
1154
1155-- Entry_Accepted (Flag152)
30ebb114 1156-- Defined in E_Entry and E_Entry_Family entities. Set if there is
70482933
RK
1157-- at least one accept for this entry in the task body. Used to
1158-- generate warnings for missing accepts.
1159
760804f3 1160-- Entry_Bodies_Array (Node19)
30ebb114 1161-- Defined in protected types for which Has_Entries is true.
70482933
RK
1162-- This is the defining identifier for the array of entry body
1163-- action procedures and barrier functions used by the runtime to
1164-- execute the user code associated with each entry.
1165
1166-- Entry_Cancel_Parameter (Node23)
30ebb114 1167-- Defined in blocks. This only applies to a block statement for
70482933
RK
1168-- which the Is_Asynchronous_Call_Block flag is set. It
1169-- contains the defining identifier of an object that must be
1170-- passed to the Cancel_Task_Entry_Call or Cancel_Protected_Entry_Call
1171-- call in the cleanup handler added to the block by
1172-- Exp_Ch7.Expand_Cleanup_Actions. This parameter is a Boolean
1173-- object for task entry calls and a Communications_Block object
1174-- in the case of protected entry calls. In both cases the objects
1175-- are declared in outer scopes to this block.
1176
1177-- Entry_Component (Node11)
30ebb114 1178-- Defined in formal parameters (in, in out and out parameters). Used
70482933
RK
1179-- only for formals of entries. References the corresponding component
1180-- of the entry parameter record for the entry.
1181
1182-- Entry_Formal (Node16)
30ebb114 1183-- Defined in components of the record built to correspond to entry
70482933
RK
1184-- parameters. This field points from the component to the formal. It
1185-- is the back pointer corresponding to Entry_Component.
1186
1187-- Entry_Index_Constant (Node18)
30ebb114 1188-- Defined in an entry index parameter. This is an identifier that
70482933
RK
1189-- eventually becomes the name of a constant representing the index
1190-- of the entry family member whose entry body is being executed. Used
1191-- to expand references to the entry index specification identifier.
1192
1193-- Entry_Index_Type (synthesized)
1194-- Applies to an entry family. Denotes Etype of the subtype indication
1195-- in the entry declaration. Used to resolve the index expression in an
1196-- accept statement for a member of the family, and in the prefix of
1197-- 'COUNT when it applies to a family member.
1198
442d1abb
AC
1199-- Entry_Max_Queue_Lengths_Array (Node35)
1200-- Defined in protected types for which Has_Entries is true. Contains the
1201-- defining identifier for the array of naturals used by the runtime to
1202-- limit the queue size of each entry individually.
1203
70482933 1204-- Entry_Parameters_Type (Node15)
30ebb114 1205-- Defined in entries. Points to the access-to-record type that is
70482933
RK
1206-- constructed by the expander to hold a reference to the parameter
1207-- values. This reference is manipulated (as an address) by the
1208-- tasking runtime. The designated record represents a packaging
1209-- up of the entry parameters (see Exp_Ch9.Expand_N_Entry_Declaration
1210-- for further details). Entry_Parameters_Type is Empty if the entry
1211-- has no parameters.
1212
1213-- Enumeration_Pos (Uint11)
30ebb114 1214-- Defined in enumeration literals. Contains the position number
70482933
RK
1215-- corresponding to the value of the enumeration literal.
1216
1217-- Enumeration_Rep (Uint12)
30ebb114 1218-- Defined in enumeration literals. Contains the representation that
70482933
RK
1219-- corresponds to the value of the enumeration literal. Note that
1220-- this is normally the same as Enumeration_Pos except in the presence
1221-- of representation clauses, where Pos will still represent the
1222-- position of the literal within the type and Rep will have be the
1223-- value given in the representation clause.
1224
1225-- Enumeration_Rep_Expr (Node22)
30ebb114 1226-- Defined in enumeration literals. Points to the expression in an
70482933
RK
1227-- associated enumeration rep clause that provides the representation
1228-- value for this literal. Empty if no enumeration rep clause for this
1229-- literal (or if rep clause does not have an entry for this literal,
1230-- an error situation). This is also used to catch duplicate entries
1231-- for the same literal.
1232
1233-- Enum_Pos_To_Rep (Node23)
79e267f9
EB
1234-- Defined in enumeration types, but not enumeration subtypes. Set to
1235-- Empty unless the enumeration type has a non-standard representation,
1236-- i.e. at least one literal has a representation value different from
1237-- its position value. In this case, the alternative is the following:
1238-- if the representation is not contiguous, then Enum_Pos_To_Rep is the
1239-- entity for an array constant built when the type is frozen that maps
1240-- Pos values to corresponding Rep values, whose index type is Natural
1241-- and whose component type is the enumeration type itself; or else, if
1242-- the representation is contiguous, then Enum_Pos_To_Rep is the entity
1243-- of the index type defined above.
70482933
RK
1244
1245-- Equivalent_Type (Node18)
30ebb114 1246-- Defined in class wide types and subtypes, access to protected
21d27997 1247-- subprogram types, and in exception types. For a classwide type, it
70482933 1248-- is always Empty. For a class wide subtype, it points to an entity
28bc3323 1249-- created by the expander which gives the backend an understandable
70482933
RK
1250-- equivalent of the class subtype with a known size (given by an
1251-- initial value). See Exp_Util.Expand_Class_Wide_Subtype for further
21d27997 1252-- details. For E_Exception_Type, this points to the record containing
70482933 1253-- the data necessary to represent exceptions (for further details, see
31fde973 1254-- System.Standard_Library). For access to protected subprograms, it
70482933
RK
1255-- denotes a record that holds pointers to the operation and to the
1256-- protected object. For remote Access_To_Subprogram types, it denotes
1257-- the record that is the fat pointer representation of an RAST.
1258
1259-- Esize (Uint12)
30ebb114 1260-- Defined in all types and subtypes, and also for components, constants,
0a36105d
JM
1261-- and variables, including exceptions where it refers to the static data
1262-- allocated for an exception. Contains the Object_Size of the type or of
1263-- the object. A value of zero indicates that the value is not yet known.
70482933
RK
1264--
1265-- For the case of components where a component clause is present, the
1266-- value is the value from the component clause, which must be non-
1267-- negative (but may be zero, which is acceptable for the case of
1268-- a type with only one possible value). It is also possible for Esize
30ebb114 1269-- of a component to be set without a component clause defined, which
70482933
RK
1270-- means that the component size is specified, but not the position.
1271-- See also RM_Size and the section on "Handling of Type'Size Values".
28bc3323
AC
1272-- During backend processing, the value is back annotated for all zero
1273-- values, so that after the call to the backend, the value is set.
70482933
RK
1274
1275-- Etype (Node5)
30ebb114 1276-- Defined in all entities. Represents the type of the entity, which
70482933
RK
1277-- is itself another entity. For a type entity, points to the parent
1278-- type for a derived type, or if the type is not derived, points to
fbf5a39b 1279-- itself. For a subtype entity, Etype points to the base type. For
8c889ae4
AC
1280-- a class wide type, points to the corresponding specific type. For a
1281-- subprogram or subprogram type, Etype has the return type of a function
e4494292
RD
1282-- or is set to Standard_Void_Type to represent a procedure. The Etype
1283-- field of a package is also set to Standard_Void_Type.
fab2daeb
AC
1284--
1285-- Note one obscure case: for pragma Default_Storage_Pool (null), the
1286-- Etype of the N_Null node is Empty.
70482933 1287
70482933 1288-- Extra_Accessibility (Node13)
30ebb114 1289-- Defined in formal parameters in the non-generic case. Normally Empty,
b8a93198
AC
1290-- but if expansion is active, and a parameter is one for which a
1291-- dynamic accessibility check is required, then an extra formal of type
ce0bead3
HK
1292-- Natural is created (see description of field Extra_Formal), and the
1293-- Extra_Accessibility field of the formal parameter points to the entity
30ebb114 1294-- for this extra formal. Also defined in variables when compiling
ce0bead3
HK
1295-- receiving stubs. In this case, a non Empty value means that this
1296-- variable's accessibility depth has been transmitted by the caller and
1297-- must be retrieved through the entity designed by this field instead of
1298-- being computed.
70482933 1299
63585f75 1300-- Extra_Accessibility_Of_Result (Node19)
30ebb114 1301-- Defined in (non-generic) Function, Operator, and Subprogram_Type
b8a93198
AC
1302-- entities. Normally Empty, but if expansion is active, and a function
1303-- is one for which "the accessibility level of the result ... determined
63585f75
SB
1304-- by the point of call" (AI05-0234) is needed, then an extra formal of
1305-- subtype Natural is created (see description of field Extra_Formal),
1306-- and the Extra_Accessibility_Of_Result field of the function points to
1307-- the entity for this extra formal.
1308
70482933 1309-- Extra_Constrained (Node23)
30ebb114 1310-- Defined in formal parameters in the non-generic case. Normally Empty,
b8a93198 1311-- but if expansion is active and a parameter is one for which a dynamic
ce0bead3
HK
1312-- indication of its constrained status is required, then an extra formal
1313-- of type Boolean is created (see description of field Extra_Formal),
1314-- and the Extra_Constrained field of the formal parameter points to the
30ebb114 1315-- entity for this extra formal. Also defined in variables when compiling
ce0bead3
HK
1316-- receiving stubs. In this case, a non empty value means that this
1317-- variable's constrained status has been transmitted by the caller and
1318-- must be retrieved through the entity designed by this field instead of
1319-- being computed.
1320
3830827c
AC
1321-- Extra_Formal (Node15)
1322-- Defined in formal parameters in the non-generic case. Certain
1323-- parameters require extra implicit information to be passed (e.g. the
1324-- flag indicating if an unconstrained variant record argument is
1325-- constrained, and the accessibility level for access parameters). See
1326-- description of Extra_Constrained, Extra_Accessibility fields for
1327-- further details. Extra formal parameters are constructed to represent
1328-- these values, and chained to the end of the list of formals using the
1329-- Extra_Formal field (i.e. the Extra_Formal field of the last "real"
1330-- formal points to the first extra formal, and the Extra_Formal field of
1331-- each extra formal points to the next one, with Empty indicating the
58009744
AC
1332-- end of the list of extra formals). Another case of Extra_Formal arises
1333-- in connection with unnesting of subprograms, where the ARECnF formal
1334-- that represents an activation record pointer is an extra formal.
3830827c
AC
1335
1336-- Extra_Formals (Node28)
e201023c
PMR
1337-- Applies to subprograms, subprogram types, entries, and entry
1338-- families. Returns first extra formal of the subprogram or entry.
1339-- Returns Empty if there are no extra formals.
3830827c 1340
d3f70b35 1341-- Finalization_Master (Node23) [root type only]
30ebb114 1342-- Defined in access-to-controlled or access-to-class-wide types. The
d3f70b35
AC
1343-- field contains the entity of the finalization master which handles
1344-- dynamically allocated controlled objects referenced by the access
1345-- type. Empty for access-to-subprogram types. Empty for access types
1346-- whose designated type does not need finalization actions.
1347
70482933 1348-- Finalize_Storage_Only (Flag158) [base type only]
30ebb114 1349-- Defined in all types. Set on direct controlled types to which a
70482933
RK
1350-- valid Finalize_Storage_Only pragma applies. This flag is also set on
1351-- composite types when they have at least one controlled component and
1352-- all their controlled components are Finalize_Storage_Only. It is also
1353-- inherited by type derivation except for direct controlled types where
1354-- the Finalize_Storage_Only pragma is required at each level of
1355-- derivation.
1356
54e28df2 1357-- Finalizer (Node28)
df3e68b1
HK
1358-- Applies to package declarations and bodies. Contains the entity of the
1359-- library-level program which finalizes all package-level controlled
1360-- objects.
1361
70482933 1362-- First_Component (synthesized)
aafc151a
AC
1363-- Applies to incomplete, private, protected, record and task types.
1364-- Returns the first component by following the chain of declared
1365-- entities for the type a component is found (one with an Ekind of
1366-- E_Component). The discriminants are skipped. If the record is null,
1367-- then Empty is returned.
f937473f
RD
1368
1369-- First_Component_Or_Discriminant (synthesized)
aafc151a
AC
1370-- Similar to First_Component, but discriminants are not skipped, so will
1371-- find the first discriminant if discriminants are present.
70482933 1372
70482933 1373-- First_Entity (Node17)
30ebb114 1374-- Defined in all entities which act as scopes to which a list of
70482933
RK
1375-- associated entities is attached (blocks, class subtypes and types,
1376-- entries, functions, loops, packages, procedures, protected objects,
1377-- record types and subtypes, private types, task types and subtypes).
1378-- Points to a list of associated entities using the Next_Entity field
1379-- as a chain pointer with Empty marking the end of the list.
1380
51bf9bdf 1381-- First_Exit_Statement (Node8)
30ebb114 1382-- Defined in E_Loop entity. The exit statements for a loop are chained
308e6f3a 1383-- (in reverse order of appearance) using this field to point to the
51bf9bdf
AC
1384-- first entry in the chain (last exit statement in the loop). The
1385-- entries are chained through the Next_Exit_Statement field of the
1386-- N_Exit_Statement node with Empty marking the end of the list.
1387
70482933 1388-- First_Formal (synthesized)
3830827c 1389-- Applies to subprograms and subprogram types, and also to entries
70482933
RK
1390-- and entry families. Returns first formal of the subprogram or entry.
1391-- The formals are the first entities declared in a subprogram or in
1392-- a subprogram type (the designated type of an Access_To_Subprogram
1393-- definition) or in an entry.
1394
6e443c90
RD
1395-- First_Formal_With_Extras (synthesized)
1396-- Applies to subprograms and subprogram types, and also in entries
1397-- and entry families. Returns first formal of the subprogram or entry.
1398-- Returns Empty if there are no formals. The list returned includes
1399-- all the extra formals (see description of Extra_Formals field).
1400
70482933 1401-- First_Index (Node17)
f8c79ade
AC
1402-- Defined in array types and subtypes. By introducing implicit subtypes
1403-- for the index constraints, we have the same structure for constrained
1404-- and unconstrained arrays, subtype marks and discrete ranges are
1405-- both represented by a subtype. This function returns the tree node
1406-- corresponding to an occurrence of the first index (NOT the entity for
1407-- the type). Subsequent indices are obtained using Next_Index. Note that
1408-- this field is defined for the case of string literal subtypes, but is
1409-- always Empty.
70482933
RK
1410
1411-- First_Literal (Node17)
30ebb114 1412-- Defined in all enumeration types, including character and boolean
70482933
RK
1413-- types. This field points to the first enumeration literal entity
1414-- for the type (i.e. it is set to First (Literals (N)) where N is
1415-- the enumeration type definition node. A special case occurs with
1416-- standard character and wide character types, where this field is
1417-- Empty, since there are no enumeration literal lists in these cases.
fbf5a39b
AC
1418-- Note that this field is set in enumeration subtypes, but it still
1419-- points to the first literal of the base type in this case.
70482933 1420
70482933 1421-- First_Private_Entity (Node16)
30ebb114 1422-- Defined in all entities containing private parts (packages, protected
ce0bead3
HK
1423-- types and subtypes, task types and subtypes). The entities on the
1424-- entity chain are in order of declaration, so the entries for private
1425-- entities are at the end of the chain. This field points to the first
1426-- entity for the private part. It is Empty if there are no entities
1427-- declared in the private part or if there is no private part.
70482933
RK
1428
1429-- First_Rep_Item (Node6)
30ebb114 1430-- Defined in all entities. If non-empty, points to a linked list of
70482933
RK
1431-- representation pragmas nodes and representation clause nodes that
1432-- apply to the entity, linked using Next_Rep_Item, with Empty marking
1433-- the end of the list. In the case of derived types and subtypes, the
60370fb1
AC
1434-- new entity inherits the chain at the point of declaration. This means
1435-- that it is possible to have multiple instances of the same kind of rep
1436-- item on the chain, in which case it is the first one that applies to
1437-- the entity.
70482933 1438--
ce0bead3
HK
1439-- Note: pragmas that can apply to more than one overloadable entity,
1440-- (Convention, Interface, Inline, Inline_Always, Import, Export,
1441-- External) are never present on this chain when they apply to
1442-- overloadable entities, since it is impossible for a given pragma
1443-- to be on more than one chain at a time.
1444--
70482933 1445-- For most representation items, the representation information is
ce0bead3
HK
1446-- reflected in other fields and flags in the entity. For example if a
1447-- record representation clause is present, the component entities
1448-- reflect the specified information. However, there are some items that
1449-- are only reflected in the chain. These include:
70482933 1450--
70482933
RK
1451-- Machine_Attribute pragma
1452-- Link_Alias pragma
2a1f6a1f
AC
1453-- Linker_Constructor pragma
1454-- Linker_Destructor pragma
70482933 1455-- Weak_External pragma
2a1f6a1f 1456-- Thread_Local_Storage pragma
70482933 1457--
60370fb1 1458-- If any of these items are present, then the flag Has_Gigi_Rep_Item is
28bc3323 1459-- set, indicating that the backend should search the chain.
70482933
RK
1460--
1461-- Other representation items are included in the chain so that error
1462-- messages can easily locate the relevant nodes for posting errors.
30ebb114 1463-- Note in particular that size clauses are defined only for this
70482933
RK
1464-- purpose, and should only be accessed if Has_Size_Clause is set.
1465
76f9c7f4 1466-- Float_Rep (Uint10) [base type only]
30ebb114 1467-- Defined in floating-point entities. Contains a value of type
23c799b1
GB
1468-- Float_Rep_Kind. Together with the Digits_Value uniquely defines
1469-- the floating-point representation to be used.
1470
70482933 1471-- Freeze_Node (Node7)
30ebb114 1472-- Defined in all entities. If there is an associated freeze node for the
60370fb1
AC
1473-- entity, this field references this freeze node. If no freeze node is
1474-- associated with the entity, then this field is Empty. See package
1475-- Freeze for further details.
70482933 1476
7b56a91b 1477-- From_Limited_With (Flag159)
dc726757
HK
1478-- Defined in abtract states, package and type entities. Set to True when
1479-- the related entity is generated by the expansion of a limited with
1480-- clause. Such an entity is said to be a "shadow" - it acts as the
1481-- abstract view of a state or variable or as the incomplete view of a
1482-- type by inheriting relevant attributes from the said entity.
70482933
RK
1483
1484-- Full_View (Node11)
30ebb114 1485-- Defined in all type and subtype entities and in deferred constants.
40f4dbbe
AC
1486-- References the entity for the corresponding full type or constant
1487-- declaration. For all types other than private and incomplete types,
1488-- this field always contains Empty. If an incomplete type E1 is
1489-- completed by a private type E2 whose full type declaration entity is
1490-- E3 then the full view of E1 is E2, and the full view of E2 is E3. See
1491-- also Underlying_Type.
70482933 1492
fbf5a39b 1493-- Generic_Homonym (Node11)
30ebb114 1494-- Defined in generic packages. The generic homonym is the entity of
fbf5a39b
AC
1495-- a renaming declaration inserted in every generic unit. It is used
1496-- to resolve the name of a local entity that is given by a qualified
1497-- name, when the generic entity itself is hidden by a local name.
1498
70482933 1499-- Generic_Renamings (Elist23)
30ebb114 1500-- Defined in package and subprogram instances. Holds mapping that
70482933
RK
1501-- associates generic parameters with the corresponding instances, in
1502-- those cases where the instance is an entity.
1503
70482933 1504-- Handler_Records (List10)
30ebb114 1505-- Defined in subprogram and package entities. Points to a list of
70482933
RK
1506-- identifiers referencing the handler record entities for the
1507-- corresponding unit.
1508
1509-- Has_Aliased_Components (Flag135) [implementation base type only]
30ebb114 1510-- Defined in array type entities. Indicates that the component type
ed05b790
RD
1511-- of the array is aliased. Should this also be set for records to
1512-- indicate that at least one component is aliased (see processing in
1513-- Sem_Prag.Process_Atomic_Independent_Shared_Volatile???)
70482933
RK
1514
1515-- Has_Alignment_Clause (Flag46)
30ebb114 1516-- Defined in all type entities and objects. Indicates if an alignment
70482933
RK
1517-- clause has been given for the entity. If set, then Alignment_Clause
1518-- returns the N_Attribute_Definition node for the alignment attribute
1519-- definition clause. Note that it is possible for this flag to be False
1520-- even when Alignment_Clause returns non_Empty (this happens in the case
1521-- of derived type declarations).
1522
1523-- Has_All_Calls_Remote (Flag79)
124092ee
AC
1524-- Defined in all library unit entities. Set if the library unit has an
1525-- All_Calls_Remote pragma. Note that such entities must also be RCI
1526-- entities, so the flag Is_Remote_Call_Interface will always be set if
1527-- this flag is set.
70482933
RK
1528
1529-- Has_Atomic_Components (Flag86) [implementation base type only]
30ebb114 1530-- Defined in all types and objects. Set only for an array type or
70482933
RK
1531-- an array object if a valid pragma Atomic_Components applies to the
1532-- type or object. Note that in the case of an object, this flag is
1533-- only set on the object if there was an explicit pragma for the
1534-- object. In other words, the proper test for whether an object has
1535-- atomic components is to see if either the object or its base type
1536-- has this flag set. Note that in the case of a type, the pragma will
1537-- be chained to the rep item chain of the first subtype in the usual
1538-- manner.
1539
1540-- Has_Attach_Handler (synthesized)
1541-- Applies to record types that are constructed by the expander to
1542-- represent protected types. Returns True if there is at least one
1543-- Attach_Handler pragma in the corresponding specification.
1544
1545-- Has_Biased_Representation (Flag139)
30ebb114 1546-- Defined in discrete types (where it applies to the type'size value),
70482933
RK
1547-- and to objects (both stand-alone and components), where it applies to
1548-- the size of the object from a size or record component clause. In
1549-- all cases it indicates that the size in question is smaller than
1550-- would normally be required, but that the size requirement can be
1551-- satisfied by using a biased representation, in which stored values
1552-- have the low bound (Expr_Value (Type_Low_Bound (T)) subtracted to
1553-- reduce the required size. For example, a type with a range of 1..2
1554-- takes one bit, using 0 to represent 1 and 1 to represent 2.
1555--
ce0bead3
HK
1556-- Note that in the object and component cases, the flag is only set if
1557-- the type is unbiased, but the object specifies a smaller size than the
1558-- size of the type, forcing biased representation for the object, but
1559-- the subtype is still an unbiased type.
70482933
RK
1560
1561-- Has_Completion (Flag26)
30ebb114 1562-- Defined in all entities that require a completion (functions,
70482933 1563-- procedures, private types, limited private types, incomplete types,
5453d5bd
AC
1564-- constants and packages that require a body). The flag is set if the
1565-- completion has been encountered and analyzed.
70482933
RK
1566
1567-- Has_Completion_In_Body (Flag71)
30ebb114 1568-- Defined in all entities for types and subtypes. Set only in "Taft
6e443c90
RD
1569-- amendment types" (incomplete types whose full declaration appears in
1570-- the package body).
70482933
RK
1571
1572-- Has_Complex_Representation (Flag140) [implementation base type only]
8489c295
AC
1573-- Defined in record types. Set only for a base type to which a valid
1574-- pragma Complex_Representation applies.
70482933
RK
1575
1576-- Has_Component_Size_Clause (Flag68) [implementation base type only]
30ebb114
AC
1577-- Defined in all type entities. Set if a component size clause is
1578-- Defined for the given type. Note that this flag can be False even
70482933
RK
1579-- if Component_Size is non-zero (happens in the case of derived types).
1580
67a3b519 1581-- Has_Constrained_Partial_View (Flag187) [base type only]
30ebb114 1582-- Defined in private type and their completions, when the private
edd63e9b
ES
1583-- type has no discriminants and the full view has discriminants with
1584-- defaults. In Ada 2005 heap-allocated objects of such types are not
1585-- constrained, and can change their discriminants with full assignment.
05c064c1 1586--
5af46aa9
AC
1587-- Ada 2012 has an additional rule (3.3. (23/10.3)) concerning objects
1588-- declared in a generic package body. Objects whose type is an untagged
1589-- generic formal private type are considered to have a constrained
1590-- partial view. The predicate Object_Type_Has_Constrained_Partial_View
1591-- in sem_aux is used to test for this case.
edd63e9b 1592
fbf5a39b 1593-- Has_Contiguous_Rep (Flag181)
3c5fb4f4 1594-- Defined in enumeration types. Set if the type has a representation
fbf5a39b
AC
1595-- clause whose entries are successive integers.
1596
70482933 1597-- Has_Controlled_Component (Flag43) [base type only]
30ebb114 1598-- Defined in all type and subtype entities. Set only for composite type
a01b9df6
AC
1599-- entities which contain a component that either is a controlled type,
1600-- or itself contains controlled component (i.e. either Is_Controlled or
1601-- Has_Controlled_Component is set for at least one component).
70482933 1602
02886c2e
AC
1603-- Has_Controlling_Result (Flag98)
1604-- Defined in E_Function entities. Set if the function is a primitive
1605-- function of a tagged type which can dispatch on result.
1606
70482933 1607-- Has_Convention_Pragma (Flag119)
124092ee
AC
1608-- Defined in all entities. Set for an entity for which a valid pragma
1609-- Convention, Import, or Export has been given. Used to prevent more
1610-- than one such pragma appearing for a given entity (RM B.1(45)).
70482933 1611
e477d718
AC
1612-- Has_Default_Aspect (Flag39) [base type only]
1613-- Defined in entities for types and subtypes, set for scalar types with
1614-- a Default_Value aspect and array types with a Default_Component_Value
27fd9ad8
ES
1615-- aspect. If this flag is set, then a corresponding aspect specification
1616-- node will be present on the rep item chain for the entity. For a
1617-- derived type that inherits a default from its ancestor, the default
1618-- value is set, but it may be overridden by an aspect declaration on
e1d458b0 1619-- type derivation.
e477d718 1620
30ebb114 1621-- Has_Delayed_Aspects (Flag200)
124092ee
AC
1622-- Defined in all entities. Set if the Rep_Item chain for the entity has
1623-- one or more N_Aspect_Definition nodes chained which are not to be
30ebb114
AC
1624-- evaluated till the freeze point. The aspect definition expression
1625-- clause has been preanalyzed to get visibility at the point of use,
1626-- but no other action has been taken.
c159409f 1627
70482933 1628-- Has_Delayed_Freeze (Flag18)
30ebb114 1629-- Defined in all entities. Set to indicate that an explicit freeze
70482933
RK
1630-- node must be generated for the entity at its freezing point. See
1631-- separate section ("Delayed Freezing and Elaboration") for details.
1632
15e934bf 1633-- Has_Delayed_Rep_Aspects (Flag261)
65fe0167 1634-- Defined in all types and subtypes. This flag is set if there is at
15e934bf
AC
1635-- least one aspect for a representation characteristic that has to be
1636-- delayed and is one of the characteristics that may be inherited by
1637-- types derived from this type if not overridden. If this flag is set,
1638-- then types derived from this type have May_Inherit_Delayed_Rep_Aspects
a2667f14 1639-- set, signalling that Freeze.Inherit_Delayed_Rep_Aspects must be called
15e934bf
AC
1640-- at the freeze point of the derived type.
1641
31fde973 1642-- Has_DIC (synthesized)
f63d601b
HK
1643-- Defined in all type entities. Set for a private type and its full view
1644-- when the type is subject to pragma Default_Initial_Condition (DIC), or
1645-- when the type inherits a DIC pragma from a parent type.
1646
70482933 1647-- Has_Discriminants (Flag5)
30ebb114 1648-- Defined in all types and subtypes. For types that are allowed to have
70482933
RK
1649-- discriminants (record types and subtypes, task types and subtypes,
1650-- protected types and subtypes, private types, limited private types,
1651-- and incomplete types), indicates if the corresponding type or subtype
1652-- has a known discriminant part. Always false for all other types.
1653
5d37ba92 1654-- Has_Dispatch_Table (Flag220)
30ebb114 1655-- Defined in E_Record_Types that are tagged. Set to indicate that the
5d37ba92
ES
1656-- corresponding dispatch table is already built. This flag is used to
1657-- avoid duplicate construction of library level dispatch tables (because
1658-- the declaration of library level objects cause premature construction
1659-- of the table); otherwise the code that builds the table is added at
1660-- the end of the list of declarations of the package.
1661
aab45d22
AC
1662-- Has_Dynamic_Predicate_Aspect (Flag258)
1663-- Defined in all types and subtypes. Set if a Dynamic_Predicate aspect
ee4eee0a
AC
1664-- was explicitly applied to the type. Generally we treat predicates as
1665-- static if possible, regardless of whether they are specified using
1666-- Predicate, Static_Predicate, or Dynamic_Predicate. And if a predicate
1667-- can be treated as static (i.e. its expression is predicate-static),
1668-- then the flag Has_Static_Predicate will be set True. But there are
1669-- cases where legality is affected by the presence of an explicit
1670-- Dynamic_Predicate aspect. For example, even if a predicate looks
1671-- static, you can't use it in a case statement if there is an explicit
1672-- Dynamic_Predicate aspect specified. So test Has_Static_Predicate if
1673-- you just want to know if the predicate can be evaluated statically,
1674-- but test Has_Dynamic_Predicate_Aspect to enforce legality rules about
1675-- the use of dynamic predicates.
aab45d22 1676
70482933
RK
1677-- Has_Entries (synthesized)
1678-- Applies to concurrent types. True if any entries are declared
1679-- within the task or protected definition for the type.
1680
1681-- Has_Enumeration_Rep_Clause (Flag66)
30ebb114 1682-- Defined in enumeration types. Set if an enumeration representation
70482933
RK
1683-- clause has been given for this enumeration type. Used to prevent more
1684-- than one enumeration representation clause for a given type. Note
1685-- that this does not imply a representation with holes, since the rep
1686-- clause may merely confirm the default 0..N representation.
1687
70482933 1688-- Has_Exit (Flag47)
30ebb114 1689-- Defined in loop entities. Set if the loop contains an exit statement.
70482933 1690
c9d70ab1
AC
1691-- Has_Expanded_Contract (Flag240)
1692-- Defined in functions, procedures, entries, and entry families. Set
1693-- when a subprogram has a N_Contract node that has been expanded. The
1694-- flag prevents double expansion of a contract when a construct is
1695-- rewritten into something else and subsequently reanalyzed/expanded.
1696
70482933 1697-- Has_Foreign_Convention (synthesized)
148c86d1
EB
1698-- Applies to all entities. Determines if the Convention for the entity
1699-- is a foreign convention, i.e. non-native: other than Convention_Ada,
1700-- Convention_Intrinsic, Convention_Entry, Convention_Protected,
1701-- Convention_Stubbed and Convention_Ada_Pass_By_(Copy,Reference).
70482933
RK
1702
1703-- Has_Forward_Instantiation (Flag175)
124092ee
AC
1704-- Defined in package entities. Set for packages that instantiate local
1705-- generic entities before the corresponding generic body has been seen.
1706-- If a package has a forward instantiation, we cannot inline subprograms
1707-- appearing in the same package because the placement requirements of
4ef36ac7 1708-- the instance will conflict with the linear elaboration of front-end
124092ee 1709-- inlining.
70482933
RK
1710
1711-- Has_Fully_Qualified_Name (Flag173)
124092ee
AC
1712-- Defined in all entities. Set if the name in the Chars field has been
1713-- replaced by the fully qualified name, as used for debug output. See
1714-- Exp_Dbug for a full description of the use of this flag and also the
1715-- related flag Has_Qualified_Name.
70482933
RK
1716
1717-- Has_Gigi_Rep_Item (Flag82)
30ebb114 1718-- Defined in all entities. Set if the rep item chain (referenced by
fdce4bb7 1719-- First_Rep_Item and linked through the Next_Rep_Item chain) contains a
28bc3323
AC
1720-- representation item that needs to be specially processed by the back
1721-- end, i.e. one of the following items:
70482933
RK
1722--
1723-- Machine_Attribute pragma
1724-- Linker_Alias pragma
d9e0a587
EB
1725-- Linker_Constructor pragma
1726-- Linker_Destructor pragma
70482933 1727-- Weak_External pragma
2a1f6a1f 1728-- Thread_Local_Storage pragma
70482933 1729--
28bc3323
AC
1730-- If this flag is set, then the backend should scan the rep item chain
1731-- to process any of these items that appear. At least one such item will
70482933 1732-- be present.
19992053 1733--
70482933 1734-- Has_Homonym (Flag56)
30ebb114 1735-- Defined in all entities. Set if an entity has a homonym in the same
28bc3323 1736-- scope. Used by the backend to generate unique names for all entities.
383e179e 1737
0da80d7d 1738-- Has_Implicit_Dereference (Flag251)
30ebb114 1739-- Defined in types and discriminants. Set if the type has an aspect
0da80d7d
AC
1740-- Implicit_Dereference. Set also on the discriminant named in the aspect
1741-- clause, to simplify type resolution.
1742
28fa5430
AC
1743-- Has_Independent_Components (Flag34) [implementation base type only]
1744-- Defined in all types and objects. Set only for a record type or an
1745-- array type or array object if a valid pragma Independent_Components
1746-- applies to the type or object. Note that in the case of an object,
1747-- this flag is only set on the object if there was an explicit pragma
1748-- for the object. In other words, the proper test for whether an object
1749-- has independent components is to see if either the object or its base
1750-- type has this flag set. Note that in the case of a type, the pragma
1751-- will be chained to the rep item chain of the first subtype in the
a517d6c1
EB
1752-- usual manner. Also set if a pragma Has_Atomic_Components or pragma
1753-- Has_Aliased_Components applies to the type or object.
ca1ffed0 1754
f63d601b 1755-- Has_Inheritable_Invariants (Flag248) [base type only]
3ddfabe3
AC
1756-- Defined in all type entities. Set on private types and interface types
1757-- which define at least one class-wide invariant. Such invariants must
1758-- be inherited by derived types. The flag is also set on the full view
1759-- of a private type for completeness.
ca1ffed0 1760
f63d601b
HK
1761-- Has_Inherited_DIC (Flag133) [base type only]
1762-- Defined in all type entities. Set for a derived type which inherits
1763-- pragma Default_Initial_Condition from a parent type.
e477d718 1764
f63d601b 1765-- Has_Inherited_Invariants (Flag291) [base type only]
3ddfabe3 1766-- Defined in all type entities. Set on private extensions and derived
08f66419 1767-- types which inherit at least one class-wide invariant from a parent or
3ddfabe3
AC
1768-- an interface type. The flag is also set on the full view of a private
1769-- extension for completeness.
1770
5d37ba92 1771-- Has_Initial_Value (Flag219)
30ebb114 1772-- Defined in entities for variables and out parameters. Set if there
5d37ba92
ES
1773-- is an explicit initial value expression in the declaration of the
1774-- variable. Note that this is set only if this initial value is
1775-- explicit, it is not set for the case of implicit initialization
1776-- of access types or controlled types. Always set to False for out
30ebb114 1777-- parameters. Also defined in entities for in and in-out parameters,
5d37ba92 1778-- but always false in these cases.
383e179e 1779
70482933 1780-- Has_Interrupt_Handler (synthesized)
fbf5a39b 1781-- Applies to all protected type entities. Set if the protected type
70482933
RK
1782-- definition contains at least one procedure to which a pragma
1783-- Interrupt_Handler applies.
1784
3ddfabe3
AC
1785-- Has_Invariants (synthesized)
1786-- Defined in all type entities. True if the type defines at least one
1787-- invariant of its own or inherits at least one class-wide invariant
1788-- from a parent type or an interface.
e606088a 1789
b2dea70e
JM
1790-- Has_Limited_View (synth)
1791-- Defined in all entities. True for non-generic package entities that
1792-- are non-instances and their Limited_View attribute is present.
1793
d436b30d
AC
1794-- Has_Loop_Entry_Attributes (Flag260)
1795-- Defined in E_Loop entities. Set when the loop is subject to at least
1796-- one attribute 'Loop_Entry. The flag also implies that the loop has
1797-- already been transformed. See Expand_Loop_Entry_Attribute for details.
1798
70482933 1799-- Has_Machine_Radix_Clause (Flag83)
30ebb114 1800-- Defined in decimal types and subtypes, set if a Machine_Radix
70482933
RK
1801-- representation clause is present. This flag is used to detect
1802-- the error of multiple machine radix clauses for a single type.
1803
1804-- Has_Master_Entity (Flag21)
30ebb114 1805-- Defined in entities that can appear in the scope stack (see spec
70482933
RK
1806-- of Sem). It is set if a task master entity (_master) has been
1807-- declared and initialized in the corresponding scope.
1808
1809-- Has_Missing_Return (Flag142)
30ebb114 1810-- Defined in functions and generic functions. Set if there is one or
70482933
RK
1811-- more missing return statements in the function. This is used to
1812-- control wrapping of the body in Exp_Ch6 to ensure that the program
e51102b2 1813-- error exception is correctly raised in this case at run time.
70482933
RK
1814
1815-- Has_Nested_Block_With_Handler (Flag101)
30ebb114 1816-- Defined in scope entities. Set if there is a nested block within the
70482933
RK
1817-- scope that has an exception handler and the two scopes are in the
1818-- same procedure. This is used by the backend for controlling certain
1819-- optimizations to ensure that they are consistent with exceptions.
28bc3323 1820-- See documentation in backend for further details.
70482933 1821
5a271a7f 1822-- Has_Nested_Subprogram (Flag282)
a7837c08
JM
1823-- Defined in subprogram entities. Set for a subprogram which contains at
1824-- least one nested subprogram.
5a271a7f 1825
47346923
AC
1826-- Has_Non_Limited_View (synth)
1827-- Defined in E_Incomplete_Type, E_Incomplete_Subtype, E_Class_Wide_Type,
1828-- E_Abstract_State entities. True if their Non_Limited_View attribute
1829-- is present.
1830
08f52d9f
AC
1831-- Has_Non_Null_Abstract_State (synth)
1832-- Defined in package entities. True if the package is subject to a non-
1833-- null Abstract_State aspect/pragma.
1834
2f54ef3d
AC
1835-- Has_Non_Null_Visible_Refinement (synth)
1836-- Defined in E_Abstract_State entities. True if the state has a visible
1837-- refinement of at least one variable or state constituent as expressed
1838-- in aspect/pragma Refined_State.
c5c0ce68 1839
70482933 1840-- Has_Non_Standard_Rep (Flag75) [implementation base type only]
30ebb114 1841-- Defined in all type entities. Set when some representation clause
70482933
RK
1842-- or pragma causes the representation of the item to be significantly
1843-- modified. In this category are changes of small or radix for a
1844-- fixed-point type, change of component size for an array, and record
1845-- or enumeration representation clauses, as well as packed pragmas.
1846-- All other representation clauses (e.g. Size and Alignment clauses)
1847-- are not considered to be significant since they do not affect
1848-- stored bit patterns.
1849
39af2bac
AC
1850-- Has_Null_Abstract_State (synth)
1851-- Defined in package entities. True if the package is subject to a null
1852-- Abstract_State aspect/pragma.
1853
2f54ef3d
AC
1854-- Has_Null_Visible_Refinement (synth)
1855-- Defined in E_Abstract_State entities. True if the state has a visible
1856-- null refinement as expressed in aspect/pragma Refined_State.
124092ee 1857
70482933 1858-- Has_Object_Size_Clause (Flag172)
30ebb114 1859-- Defined in entities for types and subtypes. Set if an Object_Size
42e4b796 1860-- clause has been processed for the type. Used to prevent multiple
70482933
RK
1861-- Object_Size clauses for a given entity.
1862
fc999c5d 1863-- Has_Out_Or_In_Out_Parameter (Flag110)
551e1935 1864-- Present in subprograms, generic subprograms, entries, and entry
288cbbbd
JM
1865-- families. Set if they have at least one OUT or IN OUT parameter
1866-- (allowed for functions only in Ada 2012).
fc999c5d 1867
f63d601b
HK
1868-- Has_Own_DIC (Flag3) [base type only]
1869-- Defined in all type entities. Set for a private type and its full view
53ac0963
PT
1870-- (and its underlying full view, if the full view is itself private)
1871-- when the type is subject to pragma Default_Initial_Condition.
f63d601b
HK
1872
1873-- Has_Own_Invariants (Flag232) [base type only]
08f66419 1874-- Defined in all type entities. Set on any type that defines at least
b97813ab
EB
1875-- one invariant of its own.
1876
1877-- Note: this flag is set on both partial and full view of types to which
1878-- an Invariant pragma or aspect applies, and on the underlying full view
1879-- if the full view is private.
3ddfabe3 1880
d89ce432
AC
1881-- Has_Partial_Visible_Refinement (Flag296)
1882-- Defined in E_Abstract_State entities. Set when a state has at least
1883-- one refinement constituent subject to indicator Part_Of, and analysis
1884-- is in the region between the declaration of the first constituent for
1885-- this abstract state (in the private part of the package) and the end
1886-- of the package spec or body with visibility over this private part
1887-- (which includes the package itself and its child packages).
1888
70482933 1889-- Has_Per_Object_Constraint (Flag154)
124092ee
AC
1890-- Defined in E_Component entities. Set if the subtype of the component
1891-- has a per object constraint. Per object constraints result from the
1892-- following situations :
5d09245e
AC
1893--
1894-- 1. N_Attribute_Reference - when the prefix is the enclosing type and
1895-- the attribute is Access.
1896-- 2. N_Discriminant_Association - when the expression uses the
1897-- discriminant of the enclosing type.
1898-- 3. N_Index_Or_Discriminant_Constraint - when at least one of the
1899-- individual constraints is a per object constraint.
1900-- 4. N_Range - when the lower or upper bound uses the discriminant of
1901-- the enclosing type.
1902-- 5. N_Range_Constraint - when the range expression uses the
1903-- discriminant of the enclosing type.
70482933
RK
1904
1905-- Has_Pragma_Controlled (Flag27) [implementation base type only]
30ebb114 1906-- Defined in access type entities. It is set if a pragma Controlled
70482933
RK
1907-- applies to the access type.
1908
1909-- Has_Pragma_Elaborate_Body (Flag150)
30ebb114 1910-- Defined in all entities. Set in compilation unit entities if a
70482933
RK
1911-- pragma Elaborate_Body applies to the compilation unit.
1912
1913-- Has_Pragma_Inline (Flag157)
30ebb114 1914-- Defined in all entities. Set for functions and procedures for which a
ce0bead3
HK
1915-- pragma Inline or Inline_Always applies to the subprogram. Note that
1916-- this flag can be set even if Is_Inlined is not set. This happens for
1917-- pragma Inline (if Inline_Active is False). In other words, the flag
1918-- Has_Pragma_Inline represents the formal semantic status, and is used
1919-- for checking semantic correctness. The flag Is_Inlined indicates
1920-- whether inlining is actually active for the entity.
1921
1922-- Has_Pragma_Inline_Always (Flag230)
30ebb114 1923-- Defined in all entities. Set for functions and procedures for which a
ce0bead3
HK
1924-- pragma Inline_Always applies. Note that if this flag is set, the flag
1925-- Has_Pragma_Inline is also set.
70482933 1926
42ae3870
AC
1927-- Has_Pragma_No_Inline (Flag201)
1928-- Defined in all entities. Set for functions and procedures for which a
1929-- pragma No_Inline applies. Note that if this flag is set, the flag
1930-- Has_Pragma_Inline_Always cannot be set.
1931
bd29d519 1932-- Has_Pragma_Ordered (Flag198) [implementation base type only]
30ebb114 1933-- Defined in entities for enumeration types. If set indicates that a
bd29d519
AC
1934-- valid pragma Ordered was given for the type. This flag is inherited
1935-- by derived enumeration types. We don't need to distinguish the derived
1936-- case since we allow multiple occurrences of this pragma anyway.
1937
70482933 1938-- Has_Pragma_Pack (Flag121) [implementation base type only]
30ebb114 1939-- Defined in array and record type entities. If set, indicates that a
a01b9df6
AC
1940-- valid pragma Pack was given for the type. Note that this flag is not
1941-- inherited by derived type. See also the Is_Packed flag.
70482933 1942
02886c2e
AC
1943-- Has_Pragma_Preelab_Init (Flag221)
1944-- Defined in type and subtype entities. If set indicates that a valid
1945-- pragma Preelaborable_Initialization applies to the type.
1946
ba673907 1947-- Has_Pragma_Pure (Flag203)
30ebb114 1948-- Defined in all entities. If set, indicates that a valid pragma Pure
ba673907
JM
1949-- was given for the entity. In some cases, we need to test whether
1950-- Is_Pure was explicitly set using this pragma.
1951
0839863c 1952-- Has_Pragma_Pure_Function (Flag179)
30ebb114 1953-- Defined in all entities. If set, indicates that a valid pragma
02886c2e
AC
1954-- Pure_Function was given for the entity. In some cases, we need to test
1955-- whether Is_Pure was explicitly set using this pragma. We also set
39231404
AC
1956-- this flag for some internal entities that we know should be treated
1957-- as pure for optimization purposes.
0839863c 1958
4c8a5bb8 1959-- Has_Pragma_Thread_Local_Storage (Flag169)
30ebb114 1960-- Defined in all entities. If set, indicates that a valid pragma
4c8a5bb8
AC
1961-- Thread_Local_Storage was given for the entity.
1962
9d77af56 1963-- Has_Pragma_Unmodified (Flag233)
30ebb114 1964-- Defined in all entities. Can only be set for variables (E_Variable,
9d77af56
RD
1965-- E_Out_Parameter, E_In_Out_Parameter). Set if a valid pragma Unmodified
1966-- applies to the variable, indicating that no warning should be given
0f282086
RD
1967-- if the entity is never modified. Note that clients should generally
1968-- not test this flag directly, but instead use function Has_Unmodified.
9d77af56 1969
07fc65c4 1970-- Has_Pragma_Unreferenced (Flag180)
30ebb114 1971-- Defined in all entities. Set if a valid pragma Unreferenced applies
9d77af56 1972-- to the entity, indicating that no warning should be given if the
07fc65c4 1973-- entity has no references, but a warning should be given if it is
f937473f 1974-- in fact referenced. For private types, this flag is set in both the
0f282086
RD
1975-- private entity and full entity if the pragma applies to either. Note
1976-- that clients should generally not test this flag directly, but instead
1977-- use function Has_Unreferenced.
f937473f 1978
9d1d00ca
JS
1979-- ??? this real description was clobbered
1980
f937473f 1981-- Has_Pragma_Unreferenced_Objects (Flag212)
9d1d00ca
JS
1982-- Defined in all entities. Set if a valid pragma Unused applies to an
1983-- entity, indicating that warnings should be given if the entity is
1984-- modified or referenced. This pragma is equivalent to a pair of
1985-- Unmodified and Unreferenced pragmas.
1986
1987-- Has_Pragma_Unused (Flag294)
31fde973 1988-- Defined in all entities. Set if a valid pragma Unused applies to a
9d1d00ca
JS
1989-- variable or entity, indicating that warnings should not be given if
1990-- it is never modified or referenced. Note: This pragma is exactly
1991-- equivalent Unmodified and Unreference combined.
07fc65c4 1992
fd0ff1cf 1993-- Has_Predicates (Flag250)
fc142f63
AC
1994-- Defined in type and subtype entities. Set if a pragma Predicate or
1995-- Predicate aspect applies to the type or subtype, or if it inherits a
1996-- Predicate aspect from its parent or progenitor types.
1e60643a
AC
1997--
1998-- Note: this flag is set on both partial and full view of types to which
b97813ab
EB
1999-- a Predicate pragma or aspect applies, and on the underlying full view
2000-- if the full view is private.
fd0ff1cf 2001
70482933 2002-- Has_Primitive_Operations (Flag120) [base type only]
30ebb114 2003-- Defined in all type entities. Set if at least one primitive operation
07fc65c4 2004-- is defined for the type.
70482933 2005
87729e5a 2006-- Has_Private_Ancestor (Flag151)
7f1a5156
EB
2007-- Applies to type extensions. True if some ancestor is derived from a
2008-- private type, making some components invisible and aggregates illegal.
2009-- This flag is set at the point of derivation. The legality of the
2010-- aggregate must be rechecked because it also depends on the visibility
316e3a13
RD
2011-- at the point the aggregate is resolved. See sem_aggr.adb. This is part
2012-- of AI05-0115.
70482933
RK
2013
2014-- Has_Private_Declaration (Flag155)
124092ee
AC
2015-- Defined in all entities. Set if it is the defining entity of a private
2016-- type declaration or its corresponding full declaration. This flag is
2017-- thus preserved when the full and the partial views are exchanged, to
2018-- indicate if a full type declaration is a completion. Used for semantic
2019-- checks in E.4(18) and elsewhere.
70482933 2020
48c8c473
AC
2021-- Has_Private_Extension (Flag300)
2022-- Defined in tagged types. Set to indicate that the tagged type has some
2023-- private extension. Used to report a warning on public primitives added
2024-- after defining its private extensions.
2025
96e90ac1
RD
2026-- Has_Protected (Flag271) [base type only]
2027-- Defined in all type entities. Set on protected types themselves, and
2028-- also (recursively) on any composite type which has a component for
fb757f7d
AC
2029-- which Has_Protected is set, unless the protected type is declared in
2030-- the private part of an internal unit. The meaning is that restrictions
2031-- for protected types apply to this type. Note: the flag is not set on
2032-- access types, even if they designate an object that Has_Protected.
96e90ac1 2033
70482933 2034-- Has_Qualified_Name (Flag161)
124092ee
AC
2035-- Defined in all entities. Set if the name in the Chars field has
2036-- been replaced by its qualified name, as used for debug output. See
2037-- Exp_Dbug for a full description of qualification requirements. For
2038-- some entities, the name is the fully qualified name, but there are
2039-- exceptions. In particular, for local variables in procedures, we
2040-- do not include the procedure itself or higher scopes. See also the
2041-- flag Has_Fully_Qualified_Name, which is set if the name does indeed
2042-- include the fully qualified name.
70482933 2043
f937473f 2044-- Has_RACW (Flag214)
30ebb114
AC
2045-- Defined in package spec entities. Set if the spec contains the
2046-- declaration of a remote access-to-classwide type.
f937473f 2047
07fc65c4 2048-- Has_Record_Rep_Clause (Flag65) [implementation base type only]
30ebb114 2049-- Defined in record types. Set if a record representation clause has
70482933
RK
2050-- been given for this record type. Used to prevent more than one such
2051-- clause for a given record type. Note that this is initially cleared
2052-- for a derived type, even though the representation is inherited. See
2053-- also the flag Has_Specified_Layout.
2054
2055-- Has_Recursive_Call (Flag143)
30ebb114 2056-- Defined in procedures. Set if a direct parameterless recursive call
70482933
RK
2057-- is detected while analyzing the body. Used to activate some error
2058-- checks for infinite recursion.
2059
4c51ff88
AC
2060-- Has_Shift_Operator (Flag267) [base type only]
2061-- Defined in integer types. Set in the base type of an integer type for
2062-- which at least one of the shift operators is defined.
2063
70482933 2064-- Has_Size_Clause (Flag29)
30ebb114 2065-- Defined in entities for types and objects. Set if a size clause is
15e934bf 2066-- defined for the entity. Used to prevent multiple Size clauses for a
70482933
RK
2067-- given entity. Note that it is always initially cleared for a derived
2068-- type, even though the Size for such a type is inherited from a Size
2069-- clause given for the parent type.
2070
2071-- Has_Small_Clause (Flag67)
30ebb114 2072-- Defined in ordinary fixed point types (but not subtypes). Indicates
70482933
RK
2073-- that a small clause has been given for the entity. Used to prevent
2074-- multiple Small clauses for a given entity. Note that it is always
2075-- initially cleared for a derived type, even though the Small for such
2076-- a type is inherited from a Small clause given for the parent type.
2077
07fc65c4 2078-- Has_Specified_Layout (Flag100) [implementation base type only]
30ebb114 2079-- Defined in all type entities. Set for a record type or subtype if
70482933
RK
2080-- the record layout has been specified by a record representation
2081-- clause. Note that this differs from the flag Has_Record_Rep_Clause
2082-- in that it is inherited by a derived type. Has_Record_Rep_Clause is
2083-- used to indicate that the type is mentioned explicitly in a record
2084-- representation clause, and thus is not inherited by a derived type.
2085-- This flag is always False for non-record types.
2086
e606088a 2087-- Has_Specified_Stream_Input (Flag190)
edd63e9b 2088-- Has_Specified_Stream_Output (Flag191)
e606088a
AC
2089-- Has_Specified_Stream_Read (Flag192)
2090-- Has_Specified_Stream_Write (Flag193)
30ebb114 2091-- Defined in all type and subtype entities. Set for a given view if the
edd63e9b
ES
2092-- corresponding stream-oriented attribute has been defined by an
2093-- attribute definition clause. When such a clause occurs, a TSS is set
2094-- on the underlying full view; the flags are used to track visibility of
2095-- the attribute definition clause for partial or incomplete views.
383e179e 2096
6e443c90 2097-- Has_Static_Discriminants (Flag211)
30ebb114 2098-- Defined in record subtypes constrained by discriminant values. Set if
6e443c90
RD
2099-- all the discriminant values have static values, meaning that in the
2100-- case of a variant record, the component list can be trimmed down to
2101-- include only the components corresponding to these discriminants.
383e179e 2102
ee4eee0a 2103-- Has_Static_Predicate (Flag269)
edab6088
RD
2104-- Defined in all types and subtypes. Set if the type (which must be a
2105-- scalar type) has a predicate whose expression is predicate-static.
12e4e81e 2106-- This can result from the use of any Predicate, Static_Predicate, or
edab6088
RD
2107-- Dynamic_Predicate aspect. We can distinguish these cases by testing
2108-- Has_Static_Predicate_Aspect and Has_Dynamic_Predicate_Aspect. See
2109-- description of the latter flag for further information on dynamic
2110-- predicates which are also static.
ee4eee0a 2111
aab45d22 2112-- Has_Static_Predicate_Aspect (Flag259)
2c8d828a 2113-- Defined in all types and subtypes. Set if a Static_Predicate aspect
aab45d22 2114-- applies to the type. Note that we can tell if a static predicate is
ee4eee0a
AC
2115-- present by looking at Has_Static_Predicate, but this could have come
2116-- from a Predicate aspect or pragma or even from a Dynamic_Predicate
2117-- aspect. When we need to know the difference (e.g. to know what set of
2118-- check policies apply, use this flag and Has_Dynamic_Predicate_Aspect
c624298a 2119-- to determine which case we have).
aab45d22 2120
70482933 2121-- Has_Storage_Size_Clause (Flag23) [implementation base type only]
30ebb114 2122-- Defined in task types and access types. It is set if a Storage_Size
70482933
RK
2123-- clause is present for the type. Used to prevent multiple clauses for
2124-- one type. Note that this flag is initially cleared for a derived type
2125-- even though the Storage_Size for such a type is inherited from a
2126-- Storage_Size clause given for the parent type. Note that in the case
30ebb114 2127-- of access types, this flag is defined only in the root type, since a
70482933
RK
2128-- storage size clause cannot be given to a derived type.
2129
82c80734 2130-- Has_Stream_Size_Clause (Flag184)
30ebb114 2131-- Defined in all entities. It is set for types which have a Stream_Size
fdce4bb7
JM
2132-- clause attribute. Used to prevent multiple Stream_Size clauses for a
2133-- given entity, and also whether it is necessary to check for a stream
2134-- size clause.
82c80734 2135
70482933 2136-- Has_Task (Flag30) [base type only]
30ebb114 2137-- Defined in all type entities. Set on task types themselves, and also
70482933 2138-- (recursively) on any composite type which has a component for which
f937473f
RD
2139-- Has_Task is set. The meaning is that an allocator or declaration of
2140-- such an object must create the required tasks. Note: the flag is not
2141-- set on access types, even if they designate an object that Has_Task.
70482933 2142
4969efdf
AC
2143-- Has_Timing_Event (Flag289) [base type only]
2144-- Defined in all type entities. Set on language defined type
2145-- Ada.Real_Time.Timing_Events.Timing_Event, and also (recursively) on
2146-- any composite type which has a component for which Has_Timing_Event
2147-- is set. Used for the No_Local_Timing_Event restriction.
2148
ce0bead3
HK
2149-- Has_Thunks (Flag228)
2150-- Applies to E_Constant entities marked Is_Tag. True for secondary tag
2151-- referencing a dispatch table whose contents are pointers to thunks.
2152
70482933 2153-- Has_Unchecked_Union (Flag123) [base type only]
30ebb114 2154-- Defined in all type entities. Set on unchecked unions themselves
70482933
RK
2155-- and (recursively) on any composite type which has a component for
2156-- which Has_Unchecked_Union is set. The meaning is that a comparison
45ec05e1
RD
2157-- operation or 'Valid_Scalars reference for the type is not permitted.
2158-- Note that the flag is not set on access types, even if they designate
2159-- an object that has the flag Has_Unchecked_Union set.
70482933
RK
2160
2161-- Has_Unknown_Discriminants (Flag72)
30ebb114 2162-- Defined in all entities. Set for types with unknown discriminants.
fdce4bb7
JM
2163-- Types can have unknown discriminants either from their declaration or
2164-- through type derivation. The use of this flag exactly meets the spec
2165-- in RM 3.7(26). Note that all class-wide types are considered to have
15e934bf 2166-- unknown discriminants. Note that both flags Has_Discriminants and
fdce4bb7
JM
2167-- Has_Unknown_Discriminants may be true for a type. Class-wide types and
2168-- their subtypes have unknown discriminants and can have declared ones
2169-- as well. Private types declared with unknown discriminants may have a
2170-- full view that has explicit discriminants, and both flag will be set
03a72cd3 2171-- on the partial view, to ensure that discriminants are properly
fdce4bb7 2172-- inherited in certain contexts.
70482933 2173
c5c0ce68
HK
2174-- Has_Visible_Refinement (Flag263)
2175-- Defined in E_Abstract_State entities. Set when a state has at least
2176-- one refinement constituent and analysis is in the region between
2177-- pragma Refined_State and the end of the package body declarations.
2178
70482933 2179-- Has_Volatile_Components (Flag87) [implementation base type only]
30ebb114 2180-- Defined in all types and objects. Set only for an array type or array
ce0bead3
HK
2181-- object if a valid pragma Volatile_Components or a valid pragma
2182-- Atomic_Components applies to the type or object. Note that in the case
2183-- of an object, this flag is only set on the object if there was an
2184-- explicit pragma for the object. In other words, the proper test for
2185-- whether an object has volatile components is to see if either the
2186-- object or its base type has this flag set. Note that in the case of a
2187-- type the pragma will be chained to the rep item chain of the first
2188-- subtype in the usual manner.
70482933 2189
fbf5a39b 2190-- Has_Xref_Entry (Flag182)
30ebb114 2191-- Defined in all entities. Set if an entity has an entry in the Xref
fdce4bb7
JM
2192-- information generated in ali files. This is true for all source
2193-- entities in the extended main source file. It is also true of entities
2194-- in other packages that are referenced directly or indirectly from the
2195-- main source file (indirect reference occurs when the main source file
2196-- references an entity with a type reference. See package Lib.Xref for
2197-- further details).
fbf5a39b 2198
8afbdb8a
JM
2199-- Has_Yield_Aspect (Flag308)
2200-- Defined in subprograms, generic subprograms, entries, entry families.
2201-- Set if the entity has aspect Yield.
2202
70482933 2203-- Hiding_Loop_Variable (Node8)
30ebb114 2204-- Defined in variables. Set only if a variable of a discrete type is
70482933
RK
2205-- hidden by a loop variable in the same local scope, in which case
2206-- the Hiding_Loop_Variable field of the hidden variable points to
fbf5a39b 2207-- the E_Loop_Parameter entity doing the hiding. Used in processing
70482933
RK
2208-- warning messages if the hidden variable turns out to be unused
2209-- or is referenced without being set.
2210
651822ae
ES
2211-- Hidden_In_Formal_Instance (Elist30)
2212-- Defined on actuals for formal packages. Entities on the list are
2213-- formals that are hidden outside of the formal package when this
2214-- package is not declared with a box, or the formal itself is not
2215-- defaulted (see RM 12.7 (10)). Their visibility is restored on exit
2216-- from the current generic, because the actual for the formal package
2217-- may be used subsequently in the current unit.
2218
70482933 2219-- Homonym (Node4)
30ebb114 2220-- Defined in all entities. Link for list of entities that have the
70482933
RK
2221-- same source name and that are declared in the same or enclosing
2222-- scopes. Homonyms in the same scope are overloaded. Used for name
2223-- resolution and for the generation of debugging information.
2224
cf9a473e
AC
2225-- Ignore_SPARK_Mode_Pragmas (Flag301)
2226-- Present in concurrent type, entry, operator, [generic] package,
2227-- package body, [generic] subprogram, and subprogram body entities.
2228-- Set when the entity appears in an instance subject to SPARK_Mode
2229-- "off" and indicates that all SPARK_Mode pragmas found within must
2230-- be ignored.
2231
70482933 2232-- Implementation_Base_Type (synthesized)
ce0bead3
HK
2233-- Applies to all entities. For types, similar to Base_Type, but never
2234-- returns a private type when applied to a non-private type. Instead in
2235-- this case, it always returns the Underlying_Type of the base type, so
2236-- that we still have a concrete type. For entities other than types,
6e443c90 2237-- returns the entity unchanged.
70482933 2238
32bba3c9
AC
2239-- Import_Pragma (Node35)
2240-- Defined in subprogram entities. Set if a valid pragma Import or pragma
e5cabfac 2241-- Import_Function or pragma Import_Procedure applies to the subprogram,
32bba3c9
AC
2242-- in which case this field points to the pragma (we can't use the normal
2243-- Rep_Item chain mechanism, because a single pragma Import can apply
e5cabfac 2244-- to multiple subprogram entities).
32bba3c9 2245
70482933 2246-- In_Package_Body (Flag48)
30ebb114 2247-- Defined in package entities. Set on the entity that denotes the
fdce4bb7
JM
2248-- package (the defining occurrence of the package declaration) while
2249-- analyzing and expanding the package body. Reset on completion of
2250-- analysis/expansion.
70482933
RK
2251
2252-- In_Private_Part (Flag45)
30ebb114 2253-- Defined in all entities. Can be set only in package entities and
6e443c90
RD
2254-- objects. For package entities, this flag is set to indicate that the
2255-- private part of the package is being analyzed. The flag is reset at
2256-- the end of the package declaration. For objects it indicates that the
2257-- declaration of the object occurs in the private part of a package.
70482933 2258
90e491a7
PMR
2259-- Incomplete_Actuals (Elist24)
2260-- Defined on package entities that are instances. Indicates the actuals
2261-- types in the instantiation that are limited views. If this list is
2262-- not empty, the instantiation, which appears in a package declaration,
2263-- is relocated to the corresponding package body, which must have a
2264-- corresponding nonlimited with_clause.
2265
02217452
AC
2266-- Initialization_Statements (Node28)
2267-- Defined in constants and variables. For a composite object initialized
afab03da
AC
2268-- with an aggregate that has been converted to a sequence of
2269-- assignments, points to a compound statement containing the
02217452
AC
2270-- assignments.
2271
70482933 2272-- Inner_Instances (Elist23)
30ebb114 2273-- Defined in generic units. Contains element list of units that are
6e443c90
RD
2274-- instantiated within the given generic. Used to diagnose circular
2275-- instantiations.
70482933 2276
cf6956bb
AC
2277-- Interface_Alias (Node25)
2278-- Defined in subprograms that cover a primitive operation of an abstract
2279-- interface type. Can be set only if the Is_Hidden flag is also set,
2280-- since such entities are always hidden. Points to its associated
2281-- interface subprogram. It is used to register the subprogram in
2282-- secondary dispatch table of the interface (Ada 2005: AI-251).
2283
70482933 2284-- Interface_Name (Node21)
30ebb114 2285-- Defined in constants, variables, exceptions, functions, procedures,
69d8d8b4
AC
2286-- and packages. Set to Empty unless an export, import, or interface name
2287-- pragma has explicitly specified an external name, in which case it
2288-- references an N_String_Literal node for the specified external name.
2289-- Note that if this field is Empty, and Is_Imported or Is_Exported is
2290-- set, then the default interface name is the name of the entity, cased
2291-- in a manner that is appropriate to the system in use. Note that
2292-- Interface_Name is ignored if an address clause is present (since it
2293-- is meaningless in this case).
3fd9f17c 2294
cf6956bb
AC
2295-- Interfaces (Elist25)
2296-- Defined in record types and subtypes. List of abstract interfaces
2297-- implemented by a tagged type that are not already implemented by the
2298-- ancestors (Ada 2005: AI-251).
2299
fd0ff1cf 2300-- Invariant_Procedure (synthesized)
3ddfabe3
AC
2301-- Defined in types and subtypes. Set for private types and their full
2302-- views if one or more [class-wide] invariants apply to the type, or
2303-- when the type inherits class-wide invariants from a parent type or
2304-- an interface, or when the type is an array and its component type is
2305-- subject to an invariant, or when the type is record and contains a
2306-- component subject to an invariant (property is recursive). Points to
2307-- to the entity for a procedure which checks all these invariants. The
2308-- invariant procedure takes a single argument of the given type, and
2309-- returns if the invariant holds, or raises exception Assertion_Error
2310-- with an appropriate message if it does not hold. This attribute is
2311-- defined but always Empty for private subtypes.
2312
fd0ff1cf
RD
2313-- Note: the reason this is marked as a synthesized attribute is that the
2314-- way this is stored is as an element of the Subprograms_For_Type field.
e606088a 2315
70482933 2316-- In_Use (Flag8)
30ebb114 2317-- Defined in packages and types. Set when analyzing a use clause for
70482933
RK
2318-- the corresponding entity. Reset at end of corresponding declarative
2319-- part. The flag on a type is also used to determine the visibility of
2320-- the primitive operators of the type.
2321
f937473f 2322-- Is_Abstract_Subprogram (Flag19)
30ebb114 2323-- Defined in all subprograms and entries. Set for abstract subprograms.
f937473f
RD
2324-- Always False for enumeration literals and entries. See also
2325-- Requires_Overriding.
2326
2327-- Is_Abstract_Type (Flag146)
30ebb114 2328-- Defined in all types. Set for abstract types.
70482933
RK
2329
2330-- Is_Access_Constant (Flag69)
30ebb114 2331-- Defined in access types and subtypes. Indicates that the keyword
70482933
RK
2332-- constant was present in the access type definition.
2333
f937473f
RD
2334-- Is_Access_Protected_Subprogram_Type (synthesized)
2335-- Applies to all types, true for named and anonymous access to
2336-- protected subprograms.
2337
70482933
RK
2338-- Is_Access_Type (synthesized)
2339-- Applies to all entities, true for access types and subtypes
2340
606e70fd
AC
2341-- Is_Access_Object_Type (synthesized)
2342-- Applies to all entities, true for access-to-object types and subtypes
2343
7037d2bb 2344-- Is_Activation_Record (Flag305)
9ea43db6 2345-- Applies to E_In_Parameters generated in Exp_Unst for nested
7037d2bb
ES
2346-- subprograms, to mark the added formal that carries the activation
2347-- record created in the enclosing subprogram.
2348
405b907c
AC
2349-- Is_Actual_Subtype (Flag293)
2350-- Defined on all types, true for the generated constrained subtypes
2351-- that are built for unconstrained composite actuals.
2352
6e443c90 2353-- Is_Ada_2005_Only (Flag185)
30ebb114 2354-- Defined in all entities, true if a valid pragma Ada_05 or Ada_2005
599a7411
AC
2355-- applies to the entity which specifically names the entity, indicating
2356-- that the entity is Ada 2005 only. Note that this flag is not set if
2357-- the entity is part of a unit compiled with the normal no-argument form
2358-- of pragma Ada_05 or Ada_2005.
2359
2360-- Is_Ada_2012_Only (Flag199)
30ebb114 2361-- Defined in all entities, true if a valid pragma Ada_12 or Ada_2012
599a7411
AC
2362-- applies to the entity which specifically names the entity, indicating
2363-- that the entity is Ada 2012 only. Note that this flag is not set if
2364-- the entity is part of a unit compiled with the normal no-argument form
2365-- of pragma Ada_12 or Ada_2012.
82c80734 2366
70482933 2367-- Is_Aliased (Flag15)
30ebb114 2368-- Defined in all entities. Set for objects and types whose declarations
fecbd779
AC
2369-- carry the keyword aliased, and on record components that have the
2370-- keyword. For Ada 2012, also applies to formal parameters.
70482933 2371
02886c2e
AC
2372-- Is_Array_Type (synthesized)
2373-- Applies to all entities, true for array types and subtypes
2374
2375-- Is_Asynchronous (Flag81)
2376-- Defined in all type entities and in procedure entities. Set
2377-- if a pragma Asynchronous applies to the entity.
2378
70482933 2379-- Is_Atomic (Flag85)
088c7e1b 2380-- Defined in all type entities, and also in constants, components, and
70482933
RK
2381-- variables. Set if a pragma Atomic or Shared applies to the entity.
2382-- In the case of private and incomplete types, this flag is set in
2383-- both the partial view and the full view.
2384
b120ca61 2385-- Is_Full_Access (synth)
f280dd8f 2386-- Defined in all type entities, and also in constants, components and
b120ca61
EB
2387-- variables. Set if an aspect/pragma Atomic/Shared, or an aspect/pragma
2388-- Volatile_Full_Access or an Ada 2020 aspect Full_Access_Only applies
2389-- to the entity. In the case of private and incomplete types, the flag
f280dd8f
RD
2390-- applies to both the partial view and the full view.
2391
d347f572 2392-- Is_Base_Type (synthesized)
3ddfabe3 2393-- Applies to type and subtype entities. True if entity is a base type.
d347f572 2394
07fc65c4 2395-- Is_Bit_Packed_Array (Flag122) [implementation base type only]
30ebb114 2396-- Defined in all entities. This flag is set for a packed array type that
607114db 2397-- is bit-packed (i.e. the component size is known by the front end and
6186a6ef 2398-- is in the range 1-63 but not a multiple of 8). Is_Packed is always set
ce0bead3 2399-- if Is_Bit_Packed_Array is set, but it is possible for Is_Packed to be
b3f75672
EB
2400-- set without Is_Bit_Packed_Array if the component size is not known by
2401-- the front-end or for the case of an array having one or more index
2402-- types that are enumeration types with non-standard representation.
70482933
RK
2403
2404-- Is_Boolean_Type (synthesized)
2405-- Applies to all entities, true for boolean types and subtypes,
2406-- i.e. Standard.Boolean and all types ultimately derived from it.
2407
70482933 2408-- Is_Called (Flag102)
4b96d386
EB
2409-- Defined in subprograms and packages. Set if a subprogram is called
2410-- from the unit being compiled or a unit in the closure. Also set for
2411-- a package that contains called subprograms. Used only for inlining.
70482933
RK
2412
2413-- Is_Character_Type (Flag63)
30ebb114 2414-- Defined in all entities. Set for character types and subtypes,
70482933
RK
2415-- i.e. enumeration types that have at least one character literal.
2416
c5cec2fe
AC
2417-- Is_Checked_Ghost_Entity (Flag277)
2418-- Applies to all entities. Set for abstract states, [generic] packages,
2419-- [generic] subprograms, components, discriminants, formal parameters,
2420-- objects, package bodies, subprogram bodies, and [sub]types subject to
2421-- pragma Ghost or inherit "ghostness" from an enclosing construct, and
2422-- subject to Assertion_Policy Ghost => Check.
2423
70482933 2424-- Is_Child_Unit (Flag73)
30ebb114 2425-- Defined in all entities. Set only for defining entities of program
70482933
RK
2426-- units that are child units (but False for subunits).
2427
62d40a7a 2428-- Is_Class_Wide_Clone (Flag290)
7a71a7c4
AC
2429-- Defined on subprogram entities. Set for subprograms built in order
2430-- to implement properly the inheritance of class-wide pre- or post-
2431-- conditions when the condition contains calls to other primitives
2432-- of the ancestor type. Used to implement AI12-0195.
2433
fbf5a39b 2434-- Is_Class_Wide_Equivalent_Type (Flag35)
30ebb114 2435-- Defined in record types and subtypes. Set to True, if the type acts
fbf5a39b
AC
2436-- as a class-wide equivalent type, i.e. the Equivalent_Type field of
2437-- some class-wide subtype entity references this record type.
2438
02886c2e
AC
2439-- Is_Class_Wide_Type (synthesized)
2440-- Applies to all entities, true for class wide types and subtypes
2441
70482933 2442-- Is_Compilation_Unit (Flag149)
30ebb114 2443-- Defined in all entities. Set if the entity is a package or subprogram
70482933
RK
2444-- entity for a compilation unit other than a subunit (since we treat
2445-- subunits as part of the same compilation operation as the ultimate
2446-- parent, we do not consider them to be separate units for this flag).
2447
2448-- Is_Completely_Hidden (Flag103)
b54d1d39 2449-- Defined on discriminants. Only set on girder discriminants of
fdce4bb7
JM
2450-- untagged types. When set, the entity is a girder discriminant of a
2451-- derived untagged type which is not directly visible in the derived
2452-- type because the derived type or one of its ancestors have renamed the
2453-- discriminants in the root type. Note: there are girder discriminants
2454-- which are not Completely_Hidden (e.g. discriminants of a root type).
70482933
RK
2455
2456-- Is_Composite_Type (synthesized)
3ddfabe3
AC
2457-- Applies to all entities, true for all composite types and subtypes.
2458-- Either Is_Composite_Type or Is_Elementary_Type (but not both) is true
2459-- of any type.
70482933
RK
2460
2461-- Is_Concurrent_Record_Type (Flag20)
30ebb114 2462-- Defined in record types and subtypes. Set if the type was created
70482933
RK
2463-- by the expander to represent a task or protected type. For every
2464-- concurrent type, such as record type is constructed, and task and
e51102b2 2465-- protected objects are instances of this record type at run time
28bc3323
AC
2466-- (The backend will replace declarations of the concurrent type using
2467-- the declarations of the corresponding record type). See Exp_Ch9 for
2468-- further details.
70482933
RK
2469
2470-- Is_Concurrent_Type (synthesized)
ce0bead3
HK
2471-- Applies to all entities, true for task types and subtypes and for
2472-- protected types and subtypes.
70482933 2473
21d27997
RD
2474-- Is_Constant_Object (synthesized)
2475-- Applies to all entities, true for E_Constant, E_Loop_Parameter, and
2476-- E_In_Parameter entities.
2477
70482933 2478-- Is_Constrained (Flag12)
30ebb114 2479-- Defined in types or subtypes which may have index, discriminant
70482933
RK
2480-- or range constraint (i.e. array types and subtypes, record types
2481-- and subtypes, string types and subtypes, and all numeric types).
2482-- Set if the type or subtype is constrained.
2483
2484-- Is_Constr_Subt_For_U_Nominal (Flag80)
124092ee 2485-- Defined in all types and subtypes. Set only for the constructed
70482933
RK
2486-- subtype of an object whose nominal subtype is unconstrained. Note
2487-- that the constructed subtype itself will be constrained.
2488
2489-- Is_Constr_Subt_For_UN_Aliased (Flag141)
30ebb114 2490-- Defined in all types and subtypes. This flag can be set only if
fdce4bb7
JM
2491-- Is_Constr_Subt_For_U_Nominal is also set. It indicates that in
2492-- addition the object concerned is aliased. This flag is used by
28bc3323 2493-- the backend to determine whether a template must be constructed.
70482933
RK
2494
2495-- Is_Constructor (Flag76)
30ebb114 2496-- Defined in function and procedure entities. Set if a pragma
70482933
RK
2497-- CPP_Constructor applies to the subprogram.
2498
0cb81445 2499-- Is_Controlled_Active (Flag42) [base type only]
30ebb114 2500-- Defined in all type entities. Indicates that the type is controlled,
70482933
RK
2501-- i.e. is either a descendant of Ada.Finalization.Controlled or of
2502-- Ada.Finalization.Limited_Controlled.
2503
0cb81445
PMR
2504-- Is_Controlled (synth) [base type only]
2505-- Defined in all type entities. Set if Is_Controlled_Active is set for
2506-- the type, and Disable_Controlled is not set.
c8593453 2507
70482933 2508-- Is_Controlling_Formal (Flag97)
30ebb114 2509-- Defined in all Formal_Kind entities. Marks the controlling parameters
70482933
RK
2510-- of dispatching operations.
2511
2512-- Is_CPP_Class (Flag74)
30ebb114 2513-- Defined in all type entities, set only for tagged types to which a
f937473f 2514-- valid pragma Import (CPP, ...) or pragma CPP_Class has been applied.
70482933 2515
ad1bea3a
AC
2516-- Is_CUDA_Kernel (Flag118)
2517-- Defined in function and procedure entities. Set if the subprogram is a
2518-- CUDA kernel.
2519
70482933
RK
2520-- Is_Decimal_Fixed_Point_Type (synthesized)
2521-- Applies to all type entities, true for decimal fixed point
2522-- types and subtypes.
2523
d9d25d04 2524-- Is_Descendant_Of_Address (Flag223)
061828e3
AC
2525-- Defined in all entities. True if the entity is type System.Address,
2526-- or (recursively) a subtype or derived type of System.Address.
d5e96bc6 2527
f63d601b
HK
2528-- Is_DIC_Procedure (Flag132)
2529-- Defined in functions and procedures. Set for a generated procedure
2530-- which verifies the assumption of pragma Default_Initial_Condition at
e51102b2 2531-- run time.
f63d601b 2532
ddc1515a 2533-- Is_Discrete_Or_Fixed_Point_Type (synthesized)
70482933
RK
2534-- Applies to all entities, true for all discrete types and subtypes
2535-- and all fixed-point types and subtypes.
2536
02886c2e
AC
2537-- Is_Discrete_Type (synthesized)
2538-- Applies to all entities, true for all discrete types and subtypes
2539
70482933 2540-- Is_Discrim_SO_Function (Flag176)
30ebb114 2541-- Defined in all entities. Set only in E_Function entities that Layout
70482933
RK
2542-- creates to compute discriminant-dependent dynamic size/offset values.
2543
e2ef0ff6
AC
2544-- Is_Discriminant_Check_Function (Flag264)
2545-- Defined in all entities. Set only in E_Function entities for functions
2546-- created to do discriminant checks.
2547
21d27997
RD
2548-- Is_Discriminal (synthesized)
2549-- Applies to all entities, true for renamings of discriminants. Such
8398e82e 2550-- entities appear as constants or IN parameters.
21d27997
RD
2551
2552-- Is_Dispatch_Table_Entity (Flag234)
2553-- Applies to all entities. Set to indicate to the backend that this
2554-- entity is associated with a dispatch table.
2555
70482933 2556-- Is_Dispatching_Operation (Flag6)
124092ee
AC
2557-- Defined in all entities. Set for procedures, functions, generic
2558-- procedures, and generic functions if the corresponding operation
2559-- is dispatching.
70482933
RK
2560
2561-- Is_Dynamic_Scope (synthesized)
2562-- Applies to all Entities. Returns True if the entity is a dynamic
90e491a7
PMR
2563-- scope (i.e. a block, subprogram, task_type, entry or extended return
2564-- statement).
2565
2566-- Is_Elaboration_Checks_OK_Id (Flag148)
2567-- Defined in elaboration targets (see terminology in Sem_Elab). Set when
2568-- the target appears in a region which is subject to elabled elaboration
2569-- checks. Such targets are allowed to generate run-time conditional ABE
2570-- checks or guaranteed ABE failures.
70482933 2571
48688534
HK
2572-- Is_Elaboration_Target (synthesized)
2573-- Applies to all entities, True only for elaboration targets (see the
2574-- terminology in Sem_Elab).
2575
162ed06f
HK
2576-- Is_Elaboration_Warnings_OK_Id (Flag304)
2577-- Defined in elaboration targets (see terminology in Sem_Elab). Set when
2578-- the target appears in a region with elaboration warnings enabled.
2579
70482933 2580-- Is_Elementary_Type (synthesized)
48688534 2581-- Applies to all entities, True for all elementary types and subtypes.
90e491a7
PMR
2582-- Either Is_Composite_Type or Is_Elementary_Type (but not both) is true
2583-- of any type.
70482933
RK
2584
2585-- Is_Eliminated (Flag124)
30ebb114 2586-- Defined in type entities, subprogram entities, and object entities.
70482933 2587-- Indicates that the corresponding entity has been eliminated by use
07fc65c4
GB
2588-- of pragma Eliminate. Also used to mark subprogram entities whose
2589-- declaration and body are within unreachable code that is removed.
70482933 2590
70482933
RK
2591-- Is_Entry (synthesized)
2592-- Applies to all entities, True only for entry and entry family
2593-- entities and False for all other entity kinds.
2594
2595-- Is_Entry_Formal (Flag52)
124092ee
AC
2596-- Defined in all entities. Set only for entry formals (which can only
2597-- be in, in-out or out parameters). This flag is used to speed up the
2598-- test for the need to replace references in Exp_Ch2.
70482933 2599
5e127570 2600-- Is_Entry_Wrapper (Flag297)
ffa168bc 2601-- Defined on wrappers created for entries that have precondition aspects
5e127570 2602
02886c2e
AC
2603-- Is_Enumeration_Type (synthesized)
2604-- Defined in all entities, true for enumeration types and subtypes
2605
75a957f5
AC
2606-- Is_Exception_Handler (Flag286)
2607-- Defined in blocks. Set if the block serves only as a scope of an
2608-- exception handler with a choice parameter. Such a block does not
2609-- physically appear in the tree.
2610
70482933 2611-- Is_Exported (Flag99)
30ebb114 2612-- Defined in all entities. Set if the entity is exported. For now we
70482933
RK
2613-- only allow the export of constants, exceptions, functions, procedures
2614-- and variables, but that may well change later on. Exceptions can only
535a8637 2615-- be exported in the Java VM implementation of GNAT, which is retired.
70482933 2616
aa500b7a
AC
2617-- Is_External_State (synthesized)
2618-- Applies to all entities, true for abstract states that are subject to
bcc093dc 2619-- option External or Synchronous.
aa500b7a 2620
937e9676
AC
2621-- Is_Finalized_Transient (Flag252)
2622-- Defined in constants, loop parameters of generalized iterators, and
2623-- variables. Set when a transient object has been finalized by one of
2624-- the transient finalization mechanisms. The flag prevents the double
2625-- finalization of the object.
2626
df3e68b1
HK
2627-- Is_Finalizer (synthesized)
2628-- Applies to all entities, true for procedures containing finalization
2629-- code to process local or library level objects.
2630
70482933 2631-- Is_First_Subtype (Flag70)
30ebb114 2632-- Defined in all entities. True for first subtypes (RM 3.2.1(6)),
70482933
RK
2633-- i.e. the entity in the type declaration that introduced the type.
2634-- This may be the base type itself (e.g. for record declarations and
2635-- enumeration type declarations), or it may be the first subtype of
2636-- an anonymous base type (e.g. for integer type declarations or
2637-- constrained array declarations).
2638
2639-- Is_Fixed_Point_Type (synthesized)
2640-- Applies to all entities, true for decimal and ordinary fixed
4ef36ac7 2641-- point types and subtypes.
70482933
RK
2642
2643-- Is_Floating_Point_Type (synthesized)
2644-- Applies to all entities, true for float types and subtypes
2645
2646-- Is_Formal (synthesized)
2647-- Applies to all entities, true for IN, IN OUT and OUT parameters
2648
6e443c90
RD
2649-- Is_Formal_Object (synthesized)
2650-- Applies to all entities, true for generic IN and IN OUT parameters
2651
70482933 2652-- Is_Formal_Subprogram (Flag111)
30ebb114 2653-- Defined in all entities. Set for generic formal subprograms.
70482933 2654
70482933 2655-- Is_Frozen (Flag4)
30ebb114 2656-- Defined in all type and subtype entities. Set if type or subtype has
fdce4bb7 2657-- been frozen.
70482933 2658
fce54763
AC
2659-- Is_Generic_Actual_Subprogram (Flag274)
2660-- Defined on functions and procedures. Set on the entity of the renaming
2661-- declaration created within an instance for an actual subprogram.
2662-- Used to generate constraint checks on calls to these subprograms, even
2663-- within an instance of a predefined run-time unit, in which checks
2664-- are otherwise suppressed.
fce54763 2665
70482933 2666-- Is_Generic_Actual_Type (Flag94)
30ebb114 2667-- Defined in all type and subtype entities. Set in the subtype
fdce4bb7
JM
2668-- declaration that renames the generic formal as a subtype of the
2669-- actual. Guarantees that the subtype is not static within the instance.
aa499784
ES
2670-- Also used during analysis of an instance, to simplify resolution of
2671-- accidental overloading that occurs when different formal types get the
2672-- same actual.
70482933
RK
2673
2674-- Is_Generic_Instance (Flag130)
30ebb114 2675-- Defined in all entities. Set to indicate that the entity is an
6e443c90
RD
2676-- instance of a generic unit, or a formal package (which is an instance
2677-- of the template).
70482933 2678
fbf5a39b
AC
2679-- Is_Generic_Subprogram (synthesized)
2680-- Applies to all entities. Yields True for a generic subprogram
2681-- (generic function, generic subprogram), False for all other entities.
2682
70482933 2683-- Is_Generic_Type (Flag13)
30ebb114 2684-- Defined in all entities. Set for types which are generic formal types.
93c3fca7 2685-- Such types have an Ekind that corresponds to their classification, so
22243c12 2686-- the Ekind cannot be used to identify generic formal types.
70482933
RK
2687
2688-- Is_Generic_Unit (synthesized)
2689-- Applies to all entities. Yields True for a generic unit (generic
2690-- package, generic function, generic procedure), and False for all
2691-- other entities.
2692
95fef24f
AC
2693-- Is_Ghost_Entity (synthesized)
2694-- Applies to all entities. Yields True for abstract states, [generic]
2695-- packages, [generic] subprograms, components, discriminants, formal
2696-- parameters, objects, package bodies, subprogram bodies, and [sub]types
057aa8d8 2697-- subject to pragma Ghost or those that inherit the Ghost property from
95fef24f
AC
2698-- an enclosing construct.
2699
70482933 2700-- Is_Hidden (Flag57)
124092ee 2701-- Defined in all entities. Set for all entities declared in the
70482933
RK
2702-- private part or body of a package. Also marks generic formals of a
2703-- formal package declared without a box. For library level entities,
b7d5e87b
AC
2704-- this flag is set if the entity is not publicly visible. This flag
2705-- is reset when compiling the body of the package where the entity
2706-- is declared, when compiling the private part or body of a public
2707-- child unit, and when compiling a private child unit (see Install_
2708-- Private_Declaration in sem_ch7).
70482933 2709
7b4ebba5 2710-- Is_Hidden_Non_Overridden_Subpgm (Flag2)
79859568
AC
2711-- Defined in all entities. Set for implicitly declared subprograms
2712-- that require overriding or are null procedures, and are hidden by
2713-- a non-fully conformant homograph with the same characteristics
09c954dc
AC
2714-- (Ada RM 8.3 12.3/2).
2715
70482933 2716-- Is_Hidden_Open_Scope (Flag171)
124092ee 2717-- Defined in all entities. Set for a scope that contains the
70482933
RK
2718-- instantiation of a child unit, and whose entities are not visible
2719-- during analysis of the instance.
2720
c5cec2fe
AC
2721-- Is_Ignored_Ghost_Entity (Flag278)
2722-- Applies to all entities. Set for abstract states, [generic] packages,
2723-- [generic] subprograms, components, discriminants, formal parameters,
2724-- objects, package bodies, subprogram bodies, and [sub]types subject to
2725-- pragma Ghost or inherit "ghostness" from an enclosing construct, and
2726-- subject to Assertion_Policy Ghost => Ignore.
2727
937e9676
AC
2728-- Is_Ignored_Transient (Flag295)
2729-- Defined in constants, loop parameters of generalized iterators, and
2730-- variables. Set when a transient object must be processed by one of
2731-- the transient finalization mechanisms. Once marked, a transient is
2732-- intentionally ignored by the general finalization mechanism because
2733-- its clean up actions are context specific.
2734
70482933 2735-- Is_Immediately_Visible (Flag7)
30ebb114 2736-- Defined in all entities. Set if entity is immediately visible, i.e.
70482933
RK
2737-- is defined in some currently open scope (RM 8.3(4)).
2738
df177175 2739-- Is_Implementation_Defined (Flag254)
30ebb114 2740-- Defined in all entities. Set if a pragma Implementation_Defined is
df177175
RD
2741-- applied to the pragma. Used to mark all implementation defined
2742-- identifiers in standard library packages, and to implement the
2743-- restriction No_Implementation_Identifiers.
2744
70482933 2745-- Is_Imported (Flag24)
30ebb114 2746-- Defined in all entities. Set if the entity is imported. For now we
d7cc5f0e
PMR
2747-- only allow the import of exceptions, functions, procedures, packages,
2748-- constants, and variables. Exceptions, packages, and types can only be
2749-- imported in the Java VM implementation, which is retired.
70482933
RK
2750
2751-- Is_Incomplete_Or_Private_Type (synthesized)
2752-- Applies to all entities, true for private and incomplete types
2753
6e443c90
RD
2754-- Is_Incomplete_Type (synthesized)
2755-- Applies to all entities, true for incomplete types and subtypes
2756
40f4dbbe 2757-- Is_Independent (Flag268)
a517d6c1
EB
2758-- Defined in all types and objects. Set if a valid pragma or aspect
2759-- Independent applies to the entity, or for a component if a valid
2760-- pragma or aspect Independent_Components applies to the enclosing
2761-- record type. Also set if a pragma Shared or pragma Atomic applies to
2762-- the entity, or if the declaration of the entity carries the Aliased
2763-- keyword. For Ada 2012, also applies to formal parameters. In the
2764-- case of private and incomplete types, this flag is set in both the
2765-- partial view and the full view.
40f4dbbe 2766
90e491a7
PMR
2767-- Is_Initial_Condition_Procedure (Flag302)
2768-- Defined in functions and procedures. Set for a generated procedure
2769-- which verifies the assumption of pragma Initial_Condition at run time.
2770
70482933 2771-- Is_Inlined (Flag11)
30ebb114 2772-- Defined in all entities. Set for functions and procedures which are
70482933
RK
2773-- to be inlined. For subprograms created during expansion, this flag
2774-- may be set directly by the expander to request inlining. Also set
2775-- for packages that contain inlined subprograms, whose bodies must be
2776-- be compiled. Is_Inlined is also set on generic subprograms and is
2777-- inherited by their instances. It is also set on the body entities
2778-- of inlined subprograms. See also Has_Pragma_Inline.
4bd4bb7f
AC
2779
2780-- Is_Inlined_Always (Flag1)
2781-- Defined in subprograms. Set for functions and procedures which are
2782-- always inlined in GNATprove mode. GNATprove uses this flag to know
2783-- when a body does not need to be analyzed. The value of this flag is
2784-- only meaningful if Body_To_Inline is not Empty for the subprogram.
52c1498c 2785
70482933 2786-- Is_Instantiated (Flag126)
30ebb114 2787-- Defined in generic packages and generic subprograms. Set if the unit
70482933
RK
2788-- is instantiated from somewhere in the extended main source unit. This
2789-- flag is used to control warnings about the unit being uninstantiated.
2790-- Also set in a package that is used as an actual for a generic package
2791-- formal in an instantiation. Also set on a parent instance, in the
2792-- instantiation of a child, which is implicitly declared in the parent.
2793
2794-- Is_Integer_Type (synthesized)
2795-- Applies to all entities, true for integer types and subtypes
2796
a9d8907c 2797-- Is_Interface (Flag186)
30ebb114 2798-- Defined in record types and subtypes. Set to indicate that the current
b2c3160c
AC
2799-- entity corresponds to an abstract interface. Because abstract
2800-- interfaces are conceptually a special kind of abstract tagged type
a9d8907c
JM
2801-- we represent them by means of tagged record types and subtypes
2802-- marked with this attribute. This allows us to reuse most of the
2803-- compiler support for abstract tagged types to implement interfaces
2804-- (Ada 2005: AI-251).
2805
70482933 2806-- Is_Internal (Flag17)
30ebb114 2807-- Defined in all entities. Set to indicate an entity created during
edd63e9b 2808-- semantic processing (e.g. an implicit type, or a temporary). The
ce0bead3
HK
2809-- current uses of this flag are:
2810--
2811-- 1) Internal entities (such as temporaries generated for the result
2812-- of an inlined function call or dummy variables generated for the
2813-- debugger). Set to indicate that they need not be initialized, even
8f8f531f 2814-- when scalars are initialized or normalized.
ce0bead3
HK
2815--
2816-- 2) Predefined primitives of tagged types. Set to mark that they
2817-- have specific properties: first they are primitives even if they
2818-- are not defined in the type scope (the freezing point is not
2819-- necessarily in the same scope), and second the predefined equality
2820-- can be overridden by a user-defined equality, no body will be
2821-- generated in this case.
2822--
2823-- 3) Object declarations generated by the expander that are implicitly
2824-- imported or exported so that they can be marked in Sprint output.
2825--
ce2b6ba5
JM
2826-- 4) Internal entities in the list of primitives of tagged types that
2827-- are used to handle secondary dispatch tables. These entities have
2828-- also the attribute Interface_Alias.
383e179e 2829
70482933 2830-- Is_Interrupt_Handler (Flag89)
30ebb114 2831-- Defined in procedures. Set if a pragma Interrupt_Handler applies
fbf5a39b
AC
2832-- to the procedure. The procedure must be parameterless, and on all
2833-- targets except AAMP it must be a protected procedure.
70482933
RK
2834
2835-- Is_Intrinsic_Subprogram (Flag64)
30ebb114 2836-- Defined in functions and procedures. It is set if a valid pragma
5a527952
AC
2837-- Interface or Import is present for this subprogram specifying
2838-- convention Intrinsic. Valid means that the name and profile of the
2839-- subprogram match the requirements of one of the recognized intrinsic
2840-- subprograms (see package Sem_Intr for details). Note: the value of
2841-- Convention for such an entity will be set to Convention_Intrinsic,
2842-- but it is the setting of Is_Intrinsic_Subprogram, NOT simply having
2843-- convention set to intrinsic, which causes intrinsic code to be
2844-- generated.
70482933 2845
fc142f63 2846-- Is_Invariant_Procedure (Flag257)
00c93ba2 2847-- Defined in functions and procedures. Set for a generated invariant
3ddfabe3
AC
2848-- procedure which verifies the invariants of both the partial and full
2849-- views of a private type or private extension as well as any inherited
2850-- class-wide invariants from parent types or interfaces.
fc142f63 2851
70482933 2852-- Is_Itype (Flag91)
30ebb114 2853-- Defined in all entities. Set to indicate that a type is an Itype,
fdce4bb7 2854-- which means that the declaration for the type does not appear
28bc3323
AC
2855-- explicitly in the tree. Instead the backend will elaborate the type
2856-- when it is first used. Has_Delayed_Freeze can be set for Itypes, and
2857-- the meaning is that the first use (the one which causes the type to be
fdce4bb7
JM
2858-- defined) will be the freeze node. Note that an important restriction
2859-- on Itypes is that the first use of such a type (the one that causes it
2860-- to be defined) must be in the same scope as the type.
70482933 2861
fbf5a39b 2862-- Is_Known_Non_Null (Flag37)
124092ee 2863-- Defined in all entities. Relevant (and can be set) only for
fbf5a39b
AC
2864-- objects of an access type. It is set if the object is currently
2865-- known to have a non-null value (meaning that no access checks
8a36a0cc 2866-- are needed). The indication can for example come from assignment
ba673907 2867-- of an access parameter or an allocator whose value is known non-null.
fbf5a39b
AC
2868--
2869-- Note: this flag is set according to the sequential flow of the
124092ee
AC
2870-- program, watching the current value of the variable. However, this
2871-- processing can miss cases of changing the value of an aliased or
2872-- constant object, so even if this flag is set, it should not be
2873-- believed if the variable is aliased or volatile. It would be a
2874-- little neater to avoid the flag being set in the first place in
2875-- such cases, but that's trickier, and there is only one place that
2876-- tests the value anyway.
fbf5a39b
AC
2877--
2878-- The flag is dynamically set and reset as semantic analysis and
2879-- expansion proceeds. Its value is meaningless once the tree is
2880-- fully constructed, since it simply indicates the last state.
28bc3323 2881-- Thus this flag has no meaning to the backend.
fbf5a39b 2882
ba673907 2883-- Is_Known_Null (Flag204)
124092ee 2884-- Defined in all entities. Relevant (and can be set ) only for
ba673907
JM
2885-- objects of an access type. It is set if the object is currently known
2886-- to have a null value (meaning that a dereference will surely raise
2887-- constraint error exception). The indication can come from an
2888-- assignment or object declaration.
2889--
2890-- The comments above about sequential flow and aliased and volatile for
2891-- the Is_Known_Non_Null flag apply equally to the Is_Known_Null flag.
2892
70482933 2893-- Is_Known_Valid (Flag170)
30ebb114 2894-- Defined in all entities. Relevant for types (and subtype) and
70482933
RK
2895-- for objects (and enumeration literals) of a discrete type.
2896--
2897-- The purpose of this flag is to implement the requirement stated
2898-- in (RM 13.9.1(9-11)) which require that the use of possibly invalid
2899-- values may not cause programs to become erroneous. See the function
47cb314a 2900-- Checks.Expr_Known_Valid for further details. Note that the setting
70482933
RK
2901-- is conservative, in the sense that if the flag is set, it must be
2902-- right. If the flag is not set, nothing is known about the validity.
2903--
2904-- For enumeration literals, the flag is always set, since clearly
2905-- an enumeration literal represents a valid value. Range checks
2906-- where necessary will ensure that this valid value is appropriate.
2907--
2908-- For objects, the flag indicates the state of knowledge about the
2909-- current value of the object. This may be modified during expansion,
28bc3323 2910-- and thus the final value is not relevant to the backend.
70482933
RK
2911--
2912-- For types and subtypes, the flag is set if all possible bit patterns
2913-- of length Object_Size (i.e. Esize of the type) represent valid values
95872381 2914-- of the type. In general for such types, all values are valid, the
70482933
RK
2915-- only exception being the case where an object of the type has an
2916-- explicit size that is greater than Object_Size.
2917--
2918-- For non-discrete objects, the setting of the Is_Known_Valid flag is
2919-- not defined, and is not relevant, since the considerations of the
2920-- requirement in (RM 13.9.1(9-11)) do not apply.
fbf5a39b
AC
2921--
2922-- The flag is dynamically set and reset as semantic analysis and
2923-- expansion proceeds. Its value is meaningless once the tree is
2924-- fully constructed, since it simply indicates the last state.
28bc3323 2925-- Thus this flag has no meaning to the backend.
70482933
RK
2926
2927-- Is_Limited_Composite (Flag106)
30ebb114 2928-- Defined in all entities. Set for composite types that have a limited
c0b11850
AC
2929-- component. Used to enforce the rule that operations on the composite
2930-- type that depend on the full view of the component do not become
2931-- visible until the immediate scope of the composite type itself
2932-- (RM 7.3.1 (5)).
70482933 2933
f4d379b8 2934-- Is_Limited_Interface (Flag197)
30ebb114 2935-- Defined in record types and subtypes. True for interface types, if
0a36105d
JM
2936-- interface is declared limited, task, protected, or synchronized, or
2937-- is derived from a limited interface.
f4d379b8 2938
70482933 2939-- Is_Limited_Record (Flag25)
30ebb114 2940-- Defined in all entities. Set to true for record (sub)types if the
70482933
RK
2941-- record is declared to be limited. Note that this flag is not set
2942-- simply because some components of the record are limited.
2943
ce0bead3 2944-- Is_Local_Anonymous_Access (Flag194)
30ebb114 2945-- Defined in access types. Set for an anonymous access type to indicate
ce0bead3 2946-- that the type is created for a record component with an access
885c4871 2947-- definition, an array component, or (pre-Ada 2012) a standalone object.
d15f9422 2948-- Such anonymous types have an accessibility level equal to that of the
ce0bead3 2949-- declaration in which they appear, unlike the anonymous access types
d15f9422 2950-- that are created for access parameters, access discriminants, and
885c4871 2951-- (as of Ada 2012) stand-alone objects.
ce0bead3 2952
5a0c86bd
BD
2953-- Is_Loop_Parameter (Flag307)
2954-- Applies to all entities. Certain loops, in particular "for ... of"
2955-- loops, get transformed so that the loop parameter is declared by a
2956-- variable declaration, so the entity is an E_Variable. This is True for
2957-- such E_Variables; False otherwise.
2958
70482933 2959-- Is_Machine_Code_Subprogram (Flag137)
30ebb114 2960-- Defined in subprogram entities. Set to indicate that the subprogram
70482933
RK
2961-- is a machine code subprogram (i.e. its body includes at least one
2962-- code statement). Also indicates that all necessary semantic checks
fbf5a39b
AC
2963-- as required by RM 13.8(3) have been performed.
2964
2965-- Is_Modular_Integer_Type (synthesized)
2966-- Applies to all entities. True if entity is a modular integer type
70482933
RK
2967
2968-- Is_Non_Static_Subtype (Flag109)
30ebb114 2969-- Defined in all type and subtype entities. It is set in some (but not
fdce4bb7
JM
2970-- all) cases in which a subtype is known to be non-static. Before this
2971-- flag was added, the computation of whether a subtype was static was
2972-- entirely synthesized, by looking at the bounds, and the immediate
2973-- subtype parent. However, this method does not work for some Itypes
2974-- that have no parent set (and the only way to find the immediate
3b1d4d82 2975-- subtype parent is to go through the tree). For now, this flag is set
70482933
RK
2976-- conservatively, i.e. if it is set then for sure the subtype is non-
2977-- static, but if it is not set, then the type may or may not be static.
fdce4bb7
JM
2978-- Thus the test for a static subtype is that this flag is clear AND that
2979-- the bounds are static AND that the parent subtype (if available to be
2980-- tested) is static. Eventually we should make sure this flag is always
2981-- set right, at which point, these comments can be removed, and the
2982-- tests for static subtypes greatly simplified.
70482933
RK
2983
2984-- Is_Null_Init_Proc (Flag178)
30ebb114 2985-- Defined in procedure entities. Set for generated init proc procedures
70482933
RK
2986-- (used to initialize composite types), if the code for the procedure
2987-- is null (i.e. is a return and nothing else). Such null initialization
2988-- procedures are generated in case some client is compiled using the
2989-- Initialize_Scalars pragma, generating a call to this null procedure,
2990-- but there is no need to call such procedures within a compilation
2991-- unit, and this flag is used to suppress such calls.
2992
cf6956bb
AC
2993-- Is_Null_State (synthesized)
2994-- Applies to all entities, true for an abstract state declared with
2995-- keyword null.
2996
70482933
RK
2997-- Is_Numeric_Type (synthesized)
2998-- Applies to all entities, true for all numeric types and subtypes
2999-- (integer, fixed, float).
3000
3001-- Is_Object (synthesized)
3002-- Applies to all entities, true for entities representing objects,
3003-- including generic formal parameters.
3004
82c80734 3005-- Is_Obsolescent (Flag153)
d3ef4bd6
AC
3006-- Defined in all entities. Set for any entity to which a valid pragma
3007-- or aspect Obsolescent applies.
82c80734 3008
ce0bead3 3009-- Is_Only_Out_Parameter (Flag226)
30ebb114 3010-- Defined in formal parameter entities. Set if this parameter is the
ce0bead3
HK
3011-- only OUT parameter for this formal part. If there is more than one
3012-- out parameter, or if there is some other IN OUT parameter then this
3013-- flag is not set in any of them. Used in generation of warnings.
3014
70482933 3015-- Is_Ordinary_Fixed_Point_Type (synthesized)
9d77af56
RD
3016-- Applies to all entities, true for ordinary fixed point types and
3017-- subtypes.
70482933 3018
70482933 3019-- Is_Package_Body_Entity (Flag160)
30ebb114 3020-- Defined in all entities. Set for entities defined at the top level
70482933
RK
3021-- of a package body. Used to control externally generated names.
3022
02886c2e
AC
3023-- Is_Package_Or_Generic_Package (synthesized)
3024-- Applies to all entities. True for packages and generic packages.
3025-- False for all other entities.
3026
70482933 3027-- Is_Packed (Flag51) [implementation base type only]
30ebb114 3028-- Defined in all type entities. This flag is set only for record and
b3f75672
EB
3029-- array types which have a packed representation. There are four cases
3030-- which cause packing:
3031--
3032-- 1. Explicit use of pragma Pack to pack a record.
3033-- 2. Explicit use of pragma Pack to pack an array.
3034-- 3. Setting Component_Size of an array to a packable value.
3035-- 4. Indexing an array with a non-standard enumeration type.
3036--
3037-- For records, Is_Packed is always set if Has_Pragma_Pack is set, and
3038-- can also be set on its own in a derived type which inherited its
3039-- packed status.
3040--
3041-- For arrays, Is_Packed is set if either Has_Pragma_Pack is set and the
3042-- component size is either not known at compile time or known but not
3043-- 8/16/32/64 bits, or a Component_Size clause exists and the specified
3044-- value is smaller than 64 bits but not 8/16/32, or if the array has one
3045-- or more index types that are enumeration types with a non-standard
3046-- representation (in GNAT, we store such arrays compactly, using the Pos
3047-- of the enumeration type value). As for the case of records, Is_Packed
3048-- can be set on its own for a derived type.
3049
70482933 3050-- Before an array type is frozen, Is_Packed will always be set if
40f07b4b 3051-- Has_Pragma_Pack is set. Before the freeze point, it is not possible
70482933
RK
3052-- to know the component size, since the component type is not frozen
3053-- until the array type is frozen. Thus Is_Packed for an array type
3054-- before it is frozen means that packed is required. Then if it turns
b3f75672
EB
3055-- out that the component size doesn't require packing, the Is_Packed
3056-- flag gets turned off.
70482933 3057
6186a6ef
EB
3058-- In the bit-packed array case (i.e. the component size is known by the
3059-- front end and is in the range 1-63 but not a multiple of 8), then the
3060-- Is_Bit_Packed_Array flag will be set once the array type is frozen.
b3f75672 3061--
8b034336
AC
3062-- Is_Packed_Array (synth)
3063-- Applies to all entities, true if entity is for a packed array.
3064
8ca597af 3065-- Is_Packed_Array_Impl_Type (Flag138)
30ebb114 3066-- Defined in all entities. This flag is set on the entity for the type
b3f75672 3067-- used to implement a packed array (either a modular type or a subtype
607114db 3068-- of Packed_Bytes{1,2,4} in the bit-packed array case, a regular array
b3f75672 3069-- in the non-standard enumeration index case). It is set if and only
8ca597af 3070-- if the type appears in the Packed_Array_Impl_Type field of some other
b3f75672 3071-- entity. It is used by the back end to activate the special processing
28bc3323 3072-- for such types (unchecked conversions that would not otherwise be
8ca597af
RD
3073-- allowed are allowed for such types). If Is_Packed_Array_Impl_Type is
3074-- set in an entity, then the Original_Array_Type field of this entity
3075-- points to the array type for which this is the Packed_Array_Impl_Type.
70482933 3076
b54d1d39
AC
3077-- Is_Param_Block_Component_Type (Flag215) [base type only]
3078-- Defined in access types. Set to indicate that a type is the type of a
3079-- component of the parameter block record type generated by the compiler
3080-- for an entry or a select statement. Read by CodePeer.
3081
3ddfabe3
AC
3082-- Is_Partial_Invariant_Procedure (Flag292)
3083-- Defined in functions and procedures. Set for a generated invariant
3084-- procedure which verifies the invariants of the partial view of a
3085-- private type or private extension.
3086
70482933 3087-- Is_Potentially_Use_Visible (Flag9)
30ebb114 3088-- Defined in all entities. Set if entity is potentially use visible,
70482933
RK
3089-- i.e. it is defined in a package that appears in a currently active
3090-- use clause (RM 8.4(8)). Note that potentially use visible entities
3091-- are not necessarily use visible (RM 8.4(9-11)).
3092
fc142f63
AC
3093-- Is_Predicate_Function (Flag255)
3094-- Present in functions and procedures. Set for generated predicate
3095-- functions.
3096
3097-- Is_Predicate_Function_M (Flag256)
3098-- Present in functions and procedures. Set for special version of
3099-- predicate function generated for use in membership tests, where
3100-- raise expressions are transformed to return False.
3101
70482933 3102-- Is_Preelaborated (Flag59)
30ebb114 3103-- Defined in all entities, set in E_Package and E_Generic_Package
70482933
RK
3104-- entities to which a pragma Preelaborate is applied, and also in
3105-- all entities within such packages. Note that the fact that this
3106-- flag is set does not necesarily mean that no elaboration code is
3107-- generated for the package.
3108
5d37ba92 3109-- Is_Primitive (Flag218)
30ebb114 3110-- Defined in overloadable entities and in generic subprograms. Set to
9d77af56 3111-- indicate that this is a primitive operation of some type, which may
7c0c194b 3112-- be a tagged type or an untagged type. Used to verify overriding
5d37ba92
ES
3113-- indicators in bodies.
3114
10b93b2e 3115-- Is_Primitive_Wrapper (Flag195)
30ebb114 3116-- Defined in functions and procedures created by the expander to serve
d44202ba
HK
3117-- as an indirection mechanism to overriding primitives of concurrent
3118-- types, entries and protected procedures.
10b93b2e 3119
21d27997
RD
3120-- Is_Prival (synthesized)
3121-- Applies to all entities, true for renamings of private protected
3122-- components. Such entities appear as constants or variables.
3123
70482933 3124-- Is_Private_Composite (Flag107)
30ebb114 3125-- Defined in composite types that have a private component. Used to
70482933 3126-- enforce the rule that operations on the composite type that depend
d9e0a587 3127-- on the full view of the component, do not become visible until the
70482933
RK
3128-- immediate scope of the composite type itself (7.3.1 (5)). Both this
3129-- flag and Is_Limited_Composite are needed.
3130
3131-- Is_Private_Descendant (Flag53)
30ebb114 3132-- Defined in entities that can represent library units (packages,
70482933 3133-- functions, procedures). Set if the library unit is itself a private
d9d25d04 3134-- child unit, or if it is the descendant of a private child unit.
70482933 3135
d44202ba 3136-- Is_Private_Primitive (Flag245)
30ebb114 3137-- Defined in subprograms. Set if the operation is a primitive of a
b7d5e87b
AC
3138-- tagged type (procedure or function dispatching on result) whose
3139-- full view has not been seen. Used in particular for primitive
3140-- subprograms of a synchronized type declared between the two views
3141-- of the type, so that the wrapper built for such a subprogram can
3142-- be given the proper signature.
d44202ba 3143
70482933
RK
3144-- Is_Private_Type (synthesized)
3145-- Applies to all entities, true for private types and subtypes,
4ef36ac7 3146-- as well as for record with private types as subtypes.
70482933 3147
21d27997
RD
3148-- Is_Protected_Component (synthesized)
3149-- Applicable to all entities, true if the entity denotes a private
3150-- component of a protected type.
3151
9e9df9da 3152-- Is_Protected_Interface (synthesized)
30ebb114 3153-- Defined in types that are interfaces. True if interface is declared
f4d379b8
HK
3154-- protected, or is derived from protected interfaces.
3155
02886c2e
AC
3156-- Is_Protected_Record_Type (synthesized)
3157-- Applies to all entities, true if Is_Concurrent_Record_Type is true and
3158-- Corresponding_Concurrent_Type is a protected type.
3159
70482933
RK
3160-- Is_Protected_Type (synthesized)
3161-- Applies to all entities, true for protected types and subtypes
3162
70482933 3163-- Is_Public (Flag10)
30ebb114 3164-- Defined in all entities. Set to indicate that an entity defined in
70482933 3165-- one compilation unit can be referenced from other compilation units.
e0c23ac7 3166-- If this reference causes a reference in the generated code, for
28bc3323
AC
3167-- example in the case of a variable name, then the backend will generate
3168-- an appropriate external name for use by the linker.
70482933 3169
70482933 3170-- Is_Pure (Flag44)
30ebb114 3171-- Defined in all entities. Set in all entities of a unit to which a
3e247e58 3172-- pragma Pure is applied except for non-intrinsic imported subprograms,
2db5b47e
AC
3173-- and also set for the entity of the unit itself. In addition, this
3174-- flag may be set for any other functions or procedures that are known
3175-- to be side effect free, so in the case of subprograms, the Is_Pure
3176-- flag may be used by the optimizer to imply that it can assume freedom
3e752e1f
EB
3177-- from side effects (other than those resulting from assignment to Out
3178-- or In Out parameters, or to objects designated by access parameters).
70482933 3179
edd63e9b 3180-- Is_Pure_Unit_Access_Type (Flag189)
30ebb114 3181-- Defined in access type and subtype entities. Set if the type or
edd63e9b
ES
3182-- subtype appears in a pure unit. Used to give an error message at
3183-- freeze time if the access type has a storage pool.
3184
685094bf 3185-- Is_RACW_Stub_Type (Flag244)
30ebb114 3186-- Defined in all types, true for the stub types generated for remote
685094bf
RD
3187-- access-to-class-wide types.
3188
d5e96bc6 3189-- Is_Raised (Flag224)
30ebb114 3190-- Defined in exception entities. Set if the entity is referenced by a
21d27997 3191-- a raise statement.
d5e96bc6 3192
70482933
RK
3193-- Is_Real_Type (synthesized)
3194-- Applies to all entities, true for real types and subtypes
3195
3196-- Is_Record_Type (synthesized)
3197-- Applies to all entities, true for record types and subtypes,
4ef36ac7 3198-- includes class-wide types and subtypes (which are also records).
70482933 3199
e577151d
PT
3200-- Is_Relaxed_Initialization_State (synthesized)
3201-- Applies to all entities, true for abstract states that are subject to
3202-- option Relaxed_Initialization.
3203
70482933 3204-- Is_Remote_Call_Interface (Flag62)
30ebb114 3205-- Defined in all entities. Set in E_Package and E_Generic_Package
30783513 3206-- entities to which a pragma Remote_Call_Interface is applied, and
685094bf 3207-- also on entities declared in the visible part of such a package.
70482933
RK
3208
3209-- Is_Remote_Types (Flag61)
30ebb114 3210-- Defined in all entities. Set in E_Package and E_Generic_Package
685094bf
RD
3211-- entities to which a pragma Remote_Types is applied, and also on
3212-- entities declared in the visible part of the spec of such a package.
22243c12
RD
3213-- Also set for types which are generic formal types to which the
3214-- pragma Remote_Access_Type applies.
70482933
RK
3215
3216-- Is_Renaming_Of_Object (Flag112)
30ebb114 3217-- Defined in all entities, set only for a variable or constant for
70482933
RK
3218-- which the Renamed_Object field is non-empty and for which the
3219-- renaming is handled by the front end, by macro substitution of
3220-- a copy of the (evaluated) name tree whereever the variable is used.
3221
6e443c90 3222-- Is_Return_Object (Flag209)
30ebb114 3223-- Defined in all object entities. True if the object is the return
6e443c90 3224-- object of an extended_return_statement; False otherwise.
70482933 3225
273adcdf 3226-- Is_Safe_To_Reevaluate (Flag249)
30ebb114 3227-- Defined in all entities. Set in variables that are initialized by
273adcdf
AC
3228-- means of an assignment statement. When initialized their contents
3229-- never change and hence they can be seen by the backend as constants.
3230-- See also Is_True_Constant.
3231
70482933
RK
3232-- Is_Scalar_Type (synthesized)
3233-- Applies to all entities, true for scalar types and subtypes
3234
3235-- Is_Shared_Passive (Flag60)
30ebb114 3236-- Defined in all entities. Set in E_Package and E_Generic_Package
70482933
RK
3237-- entities to which a pragma Shared_Passive is applied, and also in
3238-- all entities within such packages.
3239
21d27997
RD
3240-- Is_Standard_Character_Type (synthesized)
3241-- Applies to all entities, true for types and subtypes whose root type
bc3c2eca 3242-- is one of the standard character types (Character, Wide_Character, or
21d27997
RD
3243-- Wide_Wide_Character).
3244
bc3c2eca
AC
3245-- Is_Standard_String_Type (synthesized)
3246-- Applies to all entities, true for types and subtypes whose root
3247-- type is one of the standard string types (String, Wide_String, or
3248-- Wide_Wide_String).
3249
5a271a7f 3250-- Is_Static_Type (Flag281)
f8dae9bb
AC
3251-- Defined in entities. Only set for (sub)types. If set, indicates that
3252-- the type is known to be a static type (defined as a discrete type with
5a271a7f
RD
3253-- static bounds, a record all of whose component types are static types,
3254-- or an array, all of whose bounds are of a static type, and also have
aaeb3b3a 3255-- a component type that is a static type). See Set_Uplevel_Type for more
535a8637 3256-- information on how this flag is used.
5a271a7f 3257
70482933 3258-- Is_Statically_Allocated (Flag28)
124092ee 3259-- Defined in all entities. This can only be set for exception,
70482933
RK
3260-- variable, constant, and type/subtype entities. If the flag is set,
3261-- then the variable or constant must be allocated statically rather
3262-- than on the local stack frame. For exceptions, the meaning is that
3263-- the exception data should be allocated statically (and indeed this
3264-- flag is always set for exceptions, since exceptions do not have
3265-- local scope). For a type, the meaning is that the type must be
3266-- elaborated at the global level rather than locally. No type marked
3267-- with this flag may depend on a local variable, or on any other type
3268-- which does not also have this flag set to True. For a variable or
3269-- or constant, if the flag is set, then the type of the object must
3270-- either be declared at the library level, or it must also have the
e14c931f 3271-- flag set (since to allocate the object statically, its type must
70482933
RK
3272-- also be elaborated globally).
3273
70482933
RK
3274-- Is_String_Type (synthesized)
3275-- Applies to all type entities. Determines if the given type is a
3276-- string type, i.e. it is directly a string type or string subtype,
3277-- or a string slice type, or an array type with one dimension and a
3278-- component type that is a character type.
3279
21d27997
RD
3280-- Is_Subprogram (synthesized)
3281-- Applies to all entities, true for function, procedure and operator
3282-- entities.
3283
b9696ffb
AC
3284-- Is_Subprogram_Or_Generic_Subprogram
3285-- Applies to all entities, true for function procedure and operator
3286-- entities, and also for the corresponding generic entities.
3287
fa5aa835 3288-- Is_Synchronized_Interface (synthesized)
30ebb114 3289-- Defined in types that are interfaces. True if interface is declared
0a36105d
JM
3290-- synchronized, task, or protected, or is derived from a synchronized
3291-- interface.
f4d379b8 3292
75b87c16
AC
3293-- Is_Synchronized_State (synthesized)
3294-- Applies to all entities, true for abstract states that are subject to
3295-- option Synchronous.
3296
70482933 3297-- Is_Tag (Flag78)
30ebb114 3298-- Defined in E_Component and E_Constant entities. For regular tagged
21d27997
RD
3299-- type this flag is set on the tag component (whose name is Name_uTag).
3300-- For CPP_Class tagged types, this flag marks the pointer to the main
3301-- vtable (i.e. the one to be extended by derivation).
70482933
RK
3302
3303-- Is_Tagged_Type (Flag55)
00c93ba2 3304-- Defined in all entities, set for an entity that is a tagged type
70482933 3305
9e9df9da 3306-- Is_Task_Interface (synthesized)
30ebb114 3307-- Defined in types that are interfaces. True if interface is declared as
21d27997 3308-- a task interface, or if it is derived from task interfaces.
f4d379b8 3309
70482933 3310-- Is_Task_Record_Type (synthesized)
fd40a157 3311-- Applies to all entities, true if Is_Concurrent_Record_Type is true and
70482933
RK
3312-- Corresponding_Concurrent_Type is a task type.
3313
3314-- Is_Task_Type (synthesized)
fdce4bb7
JM
3315-- Applies to all entities. True for task types and subtypes
3316
3317-- Is_Thunk (Flag225)
4b342b91 3318-- Defined in all entities. True for subprograms that are thunks: that is
da1c23dd
AC
3319-- small subprograms built by the expander for tagged types that cover
3320-- interface types. As part of the runtime call to an interface, thunks
3321-- displace the pointer to the object (pointer named "this" in the C++
3322-- terminology) from a secondary dispatch table to the primary dispatch
3323-- table associated with a given tagged type; if the thunk is a function
3324-- that returns an object which covers an interface type then the thunk
3325-- displaces the pointer to the object from the primary dispatch table to
3326-- the secondary dispatch table associated with the interface type. Set
3327-- by Expand_Interface_Thunk and used by Expand_Call to handle extra
3328-- actuals associated with accessibility level.
0f282086
RD
3329
3330-- Is_Trivial_Subprogram (Flag235)
30ebb114 3331-- Defined in all entities. Set in subprograms where either the body
0f282086
RD
3332-- consists of a single null statement, or the first or only statement
3333-- of the body raises an exception. This is used for suppressing certain
3334-- warnings, see Sem_Ch6.Analyze_Subprogram_Body discussion for details.
70482933
RK
3335
3336-- Is_True_Constant (Flag163)
30ebb114 3337-- Defined in all entities for constants and variables. Set in constants
9d77af56
RD
3338-- and variables which have an initial value specified but which are
3339-- never assigned, partially or in the whole. For variables, it means
3340-- that the variable was initialized but never modified, and hence can be
3341-- treated as a constant by the code generator. For a constant, it means
3342-- that the constant was not modified by generated code (e.g. to set a
3343-- discriminant in an init proc). Assignments by user or generated code
273adcdf 3344-- will reset this flag. See also Is_Safe_To_Reevaluate.
70482933
RK
3345
3346-- Is_Type (synthesized)
3347-- Applies to all entities, true for a type entity
3348
ba673907 3349-- Is_Unchecked_Union (Flag117) [implementation base type only]
30ebb114 3350-- Defined in all entities. Set only in record types to which the
70482933
RK
3351-- pragma Unchecked_Union has been validly applied.
3352
ce06d641
AC
3353-- Is_Underlying_Full_View (Flag298)
3354-- Defined in all entities. Set for types which represent the true full
3355-- view of a private type completed by another private type. For further
3356-- details, see attribute Underlying_Full_View.
3357
9013065b 3358-- Is_Underlying_Record_View (Flag246) [base type only]
30ebb114 3359-- Defined in all entities. Set only in record types that represent the
9013065b
AC
3360-- underlying record view. This view is built for derivations of types
3361-- with unknown discriminants; it is a record with the same structure
5987e59c 3362-- as its corresponding record type, but whose parent is the full view
9013065b
AC
3363-- of the parent in the original type extension.
3364
d3ef4bd6
AC
3365-- Is_Unimplemented (Flag284)
3366-- Defined in all entities. Set for any entity to which a valid pragma
3367-- or aspect Unimplemented applies.
3368
70482933 3369-- Is_Unsigned_Type (Flag144)
30ebb114 3370-- Defined in all types, but can be set only for discrete and fixed-point
70482933
RK
3371-- type and subtype entities. This flag is only valid if the entity is
3372-- frozen. If set it indicates that the representation is known to be
3373-- unsigned (i.e. that no negative values appear in the range). This is
3374-- normally just a reflection of the lower bound of the subtype or base
31fde973 3375-- type, but there is one case in which the setting is not obvious,
70482933
RK
3376-- namely the case of an unsigned subtype of a signed type from which
3377-- a further subtype is obtained using variable bounds. This further
3378-- subtype is still unsigned, but this cannot be determined by looking
3379-- at its bounds or the bounds of the corresponding base type.
446ac3e5
ES
3380-- For a subtype indication whose range is statically a null range,
3381-- the flag is set if the lower bound is non-negative, but the flag
3382-- cannot be used to determine the comparison operator to emit in the
3383-- generated code: use the base type.
70482933 3384
f8dae9bb
AC
3385-- Is_Uplevel_Referenced_Entity (Flag283)
3386-- Defined in all entities. Used when unnesting subprograms to indicate
3387-- that an entity is locally defined within a subprogram P, and there is
3388-- a reference to the entity within a subprogram nested within P (at any
89a4fa68
AC
3389-- depth). Set for uplevel referenced objects (variables, constants,
3390-- discriminants and loop parameters), and also for upreferenced dynamic
3391-- types, including the cases where the reference is implicit (e.g. the
3392-- type of an array used for computing the location of an element in an
3393-- array. This is used internally in Exp_Unst, see this package for
3394-- further details.
f8dae9bb 3395
70482933 3396-- Is_Valued_Procedure (Flag127)
30ebb114 3397-- Defined in procedure entities. Set if an Import_Valued_Procedure
70482933
RK
3398-- or Export_Valued_Procedure pragma applies to the procedure entity.
3399
6e443c90 3400-- Is_Visible_Formal (Flag206)
124092ee 3401-- Defined in all entities. Set for instances of the formals of a
b8a93198
AC
3402-- formal package. Indicates that the entity must be made visible in the
3403-- body of the instance, to reproduce the visibility of the generic.
3404-- This simplifies visibility settings in instance bodies.
6e443c90 3405
8398e82e
AC
3406-- Is_Visible_Lib_Unit (Flag116)
3407-- Defined in all (root or child) library unit entities. Once compiled,
3408-- library units remain chained to the entities in the parent scope, and
3409-- a separate flag must be used to indicate whether the names are visible
3410-- by selected notation, or not.
3411
70482933 3412-- Is_Volatile (Flag16)
30ebb114 3413-- Defined in all type entities, and also in constants, components and
70482933
RK
3414-- variables. Set if a pragma Volatile applies to the entity. Also set
3415-- if pragma Shared or pragma Atomic applies to entity. In the case of
3416-- private or incomplete types, this flag is set in both the private
fbf5a39b
AC
3417-- and full view. The flag is not set reliably on private subtypes,
3418-- and is always retrieved from the base type (but this is not a base-
3419-- type-only attribute because it applies to other entities). Note that
28bc3323 3420-- the backend should use Treat_As_Volatile, rather than Is_Volatile
fbf5a39b
AC
3421-- to indicate code generation requirements for volatile variables.
3422-- Similarly, any front end test which is concerned with suppressing
3423-- optimizations on volatile objects should test Treat_As_Volatile
3424-- rather than testing this flag.
76f9c7f4
BD
3425-- ????This has been split into Is_Volatile_Type and Is_Volatile_Object,
3426-- and function Is_Volatile is in Einfo.Utils.
70482933 3427
57abdadd 3428-- Is_Volatile_Full_Access (Flag285)
088c7e1b 3429-- Defined in all type entities, and also in constants, components, and
b120ca61
EB
3430-- variables. Set if an aspect/pragma Volatile_Full_Access or an Ada 2020
3431-- aspect Full_Access_Only applies to the entity. In the case of private
3432-- and incomplete types, this flag is set in both the partial view and
3433-- the full view.
57abdadd 3434
70482933 3435-- Is_Wrapper_Package (synthesized)
30ebb114 3436-- Defined in package entities. Indicates that the package has been
70482933
RK
3437-- created as a wrapper for a subprogram instantiation.
3438
653da906 3439-- Itype_Printed (Flag202)
30ebb114 3440-- Defined in all type and subtype entities. Set in Itypes if the Itype
fdce4bb7
JM
3441-- has been printed by Sprint. This is used to avoid printing an Itype
3442-- more than once.
653da906 3443
fbf5a39b 3444-- Kill_Elaboration_Checks (Flag32)
30ebb114 3445-- Defined in all entities. Set by the expander to kill elaboration
fbf5a39b 3446-- checks which are known not to be needed. Equivalent in effect to
e14c931f 3447-- the use of pragma Suppress (Elaboration_Checks) for that entity
fbf5a39b
AC
3448-- except that the effect is permanent and cannot be undone by a
3449-- subsequent pragma Unsuppress.
3450
3451-- Kill_Range_Checks (Flag33)
30ebb114 3452-- Defined in all entities. Equivalent in effect to the use of pragma
e14c931f 3453-- Suppress (Range_Checks) for that entity except that the result is
6e443c90
RD
3454-- permanent and cannot be undone by a subsequent pragma Unsuppress.
3455-- This is currently only used in one odd situation in Sem_Ch3 for
3456-- record types, and it would be good to get rid of it???
fbf5a39b 3457
fdce4bb7 3458-- Known_To_Have_Preelab_Init (Flag207)
30ebb114 3459-- Defined in all type and subtype entities. If set, then the type is
fdce4bb7
JM
3460-- known to have preelaborable initialization. In the case of a partial
3461-- view of a private type, it is only possible for this to be set if a
3462-- pragma Preelaborable_Initialization is given for the type. For other
3463-- types, it is never set if the type does not have preelaborable
3464-- initialization, it may or may not be set if the type does have
3465-- preelaborable initialization.
3466
4ac2bbbd
AC
3467-- Last_Aggregate_Assignment (Node30)
3468-- Applies to controlled constants and variables initialized by an
3469-- aggregate. Points to the last statement associated with the expansion
3470-- of the aggregate. The attribute is used by the finalization machinery
3471-- when marking an object as successfully initialized.
e2ef0ff6 3472
67ce0d7e 3473-- Last_Assignment (Node26)
30ebb114 3474-- Defined in entities for variables, and OUT or IN OUT formals. Set for
67ce0d7e
RD
3475-- a local variable or formal to point to the left side of an assignment
3476-- statement assigning a value to the variable. Cleared if the value of
3477-- the entity is referenced. Used to warn about dubious assignment
3478-- statements whose value is not used.
6e443c90 3479
70482933 3480-- Last_Entity (Node20)
30ebb114 3481-- Defined in all entities which act as scopes to which a list of
70482933
RK
3482-- associated entities is attached (blocks, class subtypes and types,
3483-- entries, functions, loops, packages, procedures, protected objects,
3484-- record types and subtypes, private types, task types and subtypes).
e14c931f 3485-- Points to the last entry in the list of associated entities chained
70482933
RK
3486-- through the Next_Entity field. Empty if no entities are chained.
3487
ea7f928b
AC
3488-- Last_Formal (synthesized)
3489-- Applies to subprograms and subprogram types, and also in entries
3490-- and entry families. Returns last formal of the subprogram or entry.
3491-- The formals are the first entities declared in a subprogram or in
3492-- a subprogram type (the designated type of an Access_To_Subprogram
3493-- definition) or in an entry.
3494
0fb2ea01 3495-- Limited_View (Node23)
30ebb114 3496-- Defined in non-generic package entities that are not instances. Bona
0fb2ea01
AC
3497-- fide package with the limited-view list through the first_entity and
3498-- first_private attributes. The elements of this list are the shadow
3499-- entities created for the types and local packages that are declared
19992053
AC
3500-- in a package appearing in a limited_with clause (Ada 2005: AI-50217).
3501
3502-- Linker_Section_Pragma (Node33)
3503-- Present in constant, variable, type and subprogram entities. Points
3504-- to a linker section pragma that applies to the entity, or is Empty if
3505-- no such pragma applies. Note that for constants and variables, this
3506-- field may be set as a result of a linker section pragma applied to the
3507-- type of the object.
fbf5a39b 3508
c11207d3
PT
3509-- Lit_Hash (Node21)
3510-- Defined in enumeration types and subtypes. Non-empty only for the
3511-- case of an enumeration root type, where it contains the entity for
3512-- the generated hash function. See unit Exp_Imgv for full details of
3513-- the nature and use of this entity for implementing the Value
3514-- attribute for the enumeration type in question.
3515
760804f3 3516-- Lit_Indexes (Node18)
30ebb114 3517-- Defined in enumeration types and subtypes. Non-empty only for the
70482933
RK
3518-- case of an enumeration root type, where it contains the entity for
3519-- the generated indexes entity. See unit Exp_Imgv for full details of
e14c931f 3520-- the nature and use of this entity for implementing the Image and
70482933 3521-- Value attributes for the enumeration type in question.
383e179e 3522
70482933 3523-- Lit_Strings (Node16)
30ebb114 3524-- Defined in enumeration types and subtypes. Non-empty only for the
70482933
RK
3525-- case of an enumeration root type, where it contains the entity for
3526-- the literals string entity. See unit Exp_Imgv for full details of
3527-- the nature and use of this entity for implementing the Image and
3528-- Value attributes for the enumeration type in question.
3529
fad0600d 3530-- Low_Bound_Tested (Flag205)
124092ee
AC
3531-- Defined in all entities. Currently this can only be set for formal
3532-- parameter entries of a standard unconstrained one-dimensional array
3533-- or string type. Indicates that an explicit test of the low bound of
3534-- the formal appeared in the code, e.g. in a pragma Assert. If this
fad0600d
AC
3535-- flag is set, warnings about assuming the index low bound to be one
3536-- are suppressed.
6e443c90 3537
70482933 3538-- Machine_Radix_10 (Flag84)
30ebb114 3539-- Defined in decimal types and subtypes, set if the Machine_Radix is 10,
e917aec2
RD
3540-- as the result of the specification of a machine radix representation
3541-- clause. Note that it is possible for this flag to be set without
3542-- having Has_Machine_Radix_Clause True. This happens when a type is
3543-- derived from a type with a clause present.
70482933
RK
3544
3545-- Master_Id (Node17)
203876fc
AC
3546-- Defined in access types and subtypes. Empty unless Has_Task is set for
3547-- the designated type, in which case it points to the entity for the
3548-- Master_Id for the access type master. Also set for access-to-limited-
3549-- class-wide types whose root may be extended with task components, and
3550-- for access-to-limited-interfaces because they can be used to reference
3551-- tasks implementing such interface.
70482933
RK
3552
3553-- Materialize_Entity (Flag168)
30ebb114 3554-- Defined in all entities. Set only for renamed obects which should be
e526d0c7
AC
3555-- materialized for debugging purposes. This means that a memory location
3556-- containing the renamed address should be allocated. This is needed so
3557-- that the debugger can find the entity.
70482933 3558
15e934bf
AC
3559-- May_Inherit_Delayed_Rep_Aspects (Flag262)
3560-- Defined in all entities for types and subtypes. Set if the type is
3561-- derived from a type which has delayed rep aspects (marked by the flag
3562-- Has_Delayed_Rep_Aspects being set). In this case, at the freeze point
3563-- for the derived type we know that the parent type is frozen, and if
3564-- a given attribute has not been set for the derived type, we copy the
3565-- value from the parent type. See Freeze.Inherit_Delayed_Rep_Aspects.
3566
70482933 3567-- Mechanism (Uint8) (returned as Mechanism_Type)
30ebb114 3568-- Defined in functions and non-generic formal parameters. Indicates
70482933 3569-- the mechanism to be used for the function return or for the formal
28e18b4f
AC
3570-- parameter. See full description in the spec of Sem_Mech. This field
3571-- is also set (to the default value of zero = Default_Mechanism) in a
3572-- subprogram body entity but not used in this context.
70482933 3573
43b26411
JS
3574-- Minimum_Accessibility (Node24)
3575-- Defined in formal parameters in the non-generic case. Normally Empty,
3576-- but if expansion is active, and a parameter exists for which a
3577-- dynamic accessibility check is required, then an object is generated
3578-- within such a subprogram representing the accessibility level of the
3579-- subprogram or the formal's Extra_Accessibility - whichever one is
3580-- lesser. The Minimum_Accessibility field then points to this object.
3581
70482933 3582-- Modulus (Uint17) [base type only]
30ebb114 3583-- Defined in modular types. Contains the modulus. For the binary case,
e917aec2
RD
3584-- this will be a power of 2, but if Non_Binary_Modulus is set, then it
3585-- will not be a power of 2.
70482933 3586
0da2c8ac 3587-- Must_Be_On_Byte_Boundary (Flag183)
30ebb114 3588-- Defined in entities for types and subtypes. Set if objects of the type
e917aec2
RD
3589-- must always be allocated on a byte boundary (more accurately a storage
3590-- unit boundary). The front end checks that component clauses respect
28bc3323 3591-- this rule, and the backend ensures that record packing does not
e917aec2
RD
3592-- violate this rule. Currently the flag is set only for packed arrays
3593-- longer than 64 bits where the component size is not a power of 2.
0da2c8ac 3594
6e443c90 3595-- Must_Have_Preelab_Init (Flag208)
30ebb114 3596-- Defined in entities for types and subtypes. Set in the full type of a
6e443c90
RD
3597-- private type or subtype if a pragma Has_Preelaborable_Initialization
3598-- is present for the private type. Used to check that the full type has
3599-- preelaborable initialization at freeze time (this has to be deferred
3600-- to the freeze point because of the rule about overriding Initialize).
3601
c84205cd 3602-- Needs_Activation_Record (Flag306)
54e33e5f 3603-- Defined on generated subprogram types. Indicates that a call through
c84205cd
ES
3604-- a named or anonymous access to subprogram requires an activation
3605-- record when compiling with unnesting for C or LLVM.
3606
70482933 3607-- Needs_Debug_Info (Flag147)
30ebb114 3608-- Defined in all entities. Set if the entity requires normal debugging
0f282086
RD
3609-- information to be generated. This is true of all entities that have
3610-- Comes_From_Source set, and also transitively for entities associated
3611-- with such components (e.g. their types). It is true for all entities
3612-- in Debug_Generated_Code mode (-gnatD switch). This is the flag that
28bc3323 3613-- the backend should check to determine whether or not to generate
0f282086
RD
3614-- debugging information for an entity. Note that callers should always
3615-- use Sem_Util.Set_Debug_Info_Needed, rather than Set_Needs_Debug_Info,
3616-- so that the flag is set properly on subsidiary entities.
70482933
RK
3617
3618-- Needs_No_Actuals (Flag22)
30ebb114 3619-- Defined in callable entities (subprograms, entries, access to
be035558 3620-- subprograms) which can be called without actuals because all of
70482933
RK
3621-- their formals (if any) have default values. This flag simplifies the
3622-- resolution of the syntactic ambiguity involving a call to these
3623-- entities when the return type is an array type, and a call can be
3624-- interpreted as an indexing of the result of the call. It is also
3625-- used to resolve various cases of entry calls.
383e179e 3626
fbf5a39b 3627-- Never_Set_In_Source (Flag115)
30ebb114 3628-- Defined in all entities, but can be set only for variables and
5d37ba92
ES
3629-- parameters. This flag is set if the object is never assigned a value
3630-- in user source code, either by assignment or by being used as an out
3631-- or in out parameter. Note that this flag is not reset from using an
3632-- initial value, so if you want to test for this case as well, test the
3633-- Has_Initial_Value flag also.
3634--
70482933
RK
3635-- This flag is only for the purposes of issuing warnings, it must not
3636-- be used by the code generator to indicate that the variable is in
3637-- fact a constant, since some assignments in generated code do not
fbf5a39b
AC
3638-- count (for example, the call to an init proc to assign some but
3639-- not all of the fields in a partially initialized record). The code
70482933
RK
3640-- generator should instead use the flag Is_True_Constant.
3641--
203876fc
AC
3642-- For the purposes of this warning, the default assignment of access
3643-- variables to null is not considered the assignment of a value (so
3644-- the warning can be given for code that relies on this initial null
3645-- value when no other value is ever set).
fbf5a39b 3646--
70482933
RK
3647-- In variables and out parameters, if this flag is set after full
3648-- processing of the corresponding declarative unit, it indicates that
3649-- the variable or parameter was never set, and a warning message can
3650-- be issued.
3651--
3652-- Note: this flag is initially set, and then cleared on encountering
3653-- any construct that might conceivably legitimately set the value.
3654-- Thus during the analysis of a declarative region and its associated
fbf5a39b
AC
3655-- statement sequence, the meaning of the flag is "not set yet", and
3656-- once this analysis is complete the flag means "never assigned".
70482933 3657
203876fc
AC
3658-- Note: for variables appearing in package declarations, this flag is
3659-- never set. That is because there is no way to tell if some client
3660-- modifies the variable (or, in the case of variables in the private
3661-- part, if some child unit modifies the variables).
70482933
RK
3662
3663-- Note: in the case of renamed objects, the flag must be set in the
3664-- ultimate renamed object. Clients noting a possible modification
3665-- should use the Note_Possible_Modification procedure in Sem_Util
fbf5a39b 3666-- rather than Set_Never_Set_In_Source precisely to deal properly with
70482933
RK
3667-- the renaming possibility.
3668
3669-- Next_Component (synthesized)
f937473f
RD
3670-- Applies to record components. Returns the next component by following
3671-- the chain of declared entities until one is found which corresponds to
3672-- a component (Ekind is E_Component). Any internal types generated from
3673-- the subtype indications of the record components are skipped. Returns
3674-- Empty if no more components.
3675
3676-- Next_Component_Or_Discriminant (synthesized)
3677-- Similar to Next_Component, but includes components and discriminants
3678-- so the input can have either E_Component or E_Discriminant, and the
3679-- same is true for the result. Returns Empty if no more components or
3680-- discriminants in the record.
70482933
RK
3681
3682-- Next_Discriminant (synthesized)
203876fc 3683-- Applies to discriminants returned by First/Next_Discriminant. Returns
fd22e260 3684-- the next language-defined (i.e. perhaps non-girder) discriminant by
203876fc
AC
3685-- following the chain of declared entities as long as the kind of the
3686-- entity corresponds to a discriminant. Note that the discriminants
3687-- might be the only components of the record. Returns Empty if there
3688-- are no more discriminants.
70482933
RK
3689
3690-- Next_Entity (Node2)
30ebb114 3691-- Defined in all entities. The entities of a scope are chained, with
70482933
RK
3692-- the head of the list being in the First_Entity field of the scope
3693-- entity. All entities use the Next_Entity field as a forward pointer
3694-- for this list, with Empty indicating the end of the list. Since this
3695-- field is in the base part of the entity, the access routines for this
3696-- field are in Sinfo.
3697
3698-- Next_Formal (synthesized)
203876fc
AC
3699-- Applies to the entity for a formal parameter. Returns the next formal
3700-- parameter of the subprogram or subprogram type. Returns Empty if there
3701-- are no more formals.
70482933
RK
3702
3703-- Next_Formal_With_Extras (synthesized)
3704-- Applies to the entity for a formal parameter. Returns the next
3705-- formal parameter of the subprogram or subprogram type. Returns
3706-- Empty if there are no more formals. The list returned includes
3707-- all the extra formals (see description of Extra_Formal field)
3708
70482933
RK
3709-- Next_Index (synthesized)
3710-- Applies to array types and subtypes and to string types and
3711-- subtypes. Yields the next index. The first index is obtained by
3712-- using the First_Index attribute, and then subsequent indexes are
3713-- obtained by applying Next_Index to the previous index. Empty is
3714-- returned to indicate that there are no more indexes. Note that
3715-- unlike most attributes in this package, Next_Index applies to
3716-- nodes for the indexes, not to entities.
3717
3718-- Next_Inlined_Subprogram (Node12)
30ebb114 3719-- Defined in subprograms. Used to chain inlined subprograms used in
70482933 3720-- the current compilation, in the order in which they must be compiled
03a72cd3 3721-- by the backend to ensure that all inlinings are performed.
70482933
RK
3722
3723-- Next_Literal (synthesized)
3724-- Applies to enumeration literals, returns the next literal, or
3725-- Empty if applied to the last literal. This is actually a synonym
3726-- for Next, but its use is preferred in this context.
3727
a6282852 3728-- No_Dynamic_Predicate_On_Actual (Flag276)
7a5b62b0
AC
3729-- Defined in discrete types. Set for generic formal types that are used
3730-- in loops and quantified expressions. The corresponing actual cannot
3731-- have dynamic predicates.
a6282852 3732
19fb051c 3733-- No_Pool_Assigned (Flag131) [root type only]
30ebb114 3734-- Defined in access types. Set if a storage size clause applies to the
19fb051c
AC
3735-- variable with a static expression value of zero. This flag is used to
3736-- generate errors if any attempt is made to allocate or free an instance
3737-- of such an access type. This is set only in the root type, since
3738-- derived types must have the same pool.
70482933 3739
a6282852 3740-- No_Predicate_On_Actual (Flag275)
7a5b62b0
AC
3741-- Defined in discrete types. Set for generic formal types that are used
3742-- in the spec of a generic package, in constructs that forbid discrete
3743-- types with predicates.
a6282852 3744
8489c295
AC
3745-- No_Reordering (Flag239) [implementation base type only]
3746-- Defined in record types. Set only for a base type to which a valid
3747-- pragma No_Component_Reordering applies.
3748
70482933 3749-- No_Return (Flag113)
90e97517
EB
3750-- Defined in all entities. Set for subprograms and generic subprograms
3751-- to which a valid aspect or pragma No_Return applies.
70482933 3752
49d41397
RD
3753-- No_Strict_Aliasing (Flag136) [base type only]
3754-- Defined in access types. Set to direct the backend to avoid any
3755-- optimizations based on an assumption about the aliasing status of
3756-- objects designated by the access type. For the case of the gcc
3757-- backend, the effect is as though all references to objects of
3758-- the type were compiled with -fno-strict-aliasing. This flag is
3759-- set if an unchecked conversion with the access type as a target
3760-- type occurs in the same source unit as the declaration of the
3761-- access type, or if an explicit pragma No_Strict_Aliasing applies.
3762
3763-- No_Tagged_Streams_Pragma (Node32)
4ef36ac7 3764-- Present in all subtype and type entities. Set for tagged types and
49d41397
RD
3765-- subtypes (i.e. entities with Is_Tagged_Type set True) if a valid
3766-- pragma/aspect applies to the type.
3767
3768-- Non_Binary_Modulus (Flag58) [base type only]
3769-- Defined in all subtype and type entities. Set for modular integer
3770-- types if the modulus value is other than a power of 2.
3771
47346923 3772-- Non_Limited_View (Node19)
49d41397
RD
3773-- Defined in abstract states and incomplete types that act as shadow
3774-- entities created when analysing a limited with clause (Ada 2005:
3775-- AI-50217). Points to the defining entity of the original declaration.
3776
3777-- Nonzero_Is_True (Flag162) [base type only]
3778-- Defined in enumeration types. Set if any non-zero value is to be
3779-- interpreted as true. Currently this is set for derived Boolean
3780-- types which have a convention of C, C++ or Fortran.
3781
70482933 3782-- Normalized_First_Bit (Uint8)
30ebb114 3783-- Defined in components and discriminants. Indicates the normalized
70482933
RK
3784-- value of First_Bit for the component, i.e. the offset within the
3785-- lowest addressed storage unit containing part or all of the field.
91b1417d 3786-- Set to No_Uint if no first bit position is assigned yet.
70482933 3787
fbf5a39b 3788-- Normalized_Position (Uint14)
30ebb114 3789-- Defined in components and discriminants. Indicates the normalized
70482933
RK
3790-- value of Position for the component, i.e. the offset in storage
3791-- units from the start of the record to the lowest addressed storage
3792-- unit containing part or all of the field.
3793
3794-- Normalized_Position_Max (Uint10)
30ebb114 3795-- Defined in components and discriminants. For almost all cases, this
70482933
RK
3796-- is the same as Normalized_Position. The one exception is for the case
3797-- of a discriminated record containing one or more arrays whose length
3798-- depends on discriminants. In this case, the Normalized_Position_Max
3799-- field represents the maximum possible value of Normalized_Position
3800-- assuming min/max values for discriminant subscripts in all fields.
b5f3c913
AC
3801-- This is used by Layout in front end layout mode to properly compute
3802-- the maximum size of such records (needed for allocation purposes when
70482933
RK
3803-- there are default discriminants, and also for the 'Size value).
3804
3805-- Number_Dimensions (synthesized)
3806-- Applies to array types and subtypes. Returns the number of dimensions
3807-- of the array type or subtype as a value of type Pos.
3808
70482933
RK
3809-- Number_Entries (synthesized)
3810-- Applies to concurrent types. Returns the number of entries that are
3811-- declared within the task or protected definition for the type.
3812
3813-- Number_Formals (synthesized)
3814-- Applies to subprograms and subprogram types. Yields the number of
3815-- formals as a value of type Pos.
3816
42e4b796
EB
3817-- Object_Size_Clause (synthesized)
3818-- Applies to entities for types and subtypes. If an object size clause
3819-- is present in the rep item chain for an entity then the attribute
3820-- definition clause node is returned. Otherwise Object_Size_Clause
3821-- returns Empty if no item is present. Usually this is only meaningful
3822-- if the flag Has_Object_Size_Clause is set. This is because when the
3823-- representation item chain is copied for a derived type, it can inherit
3824-- an object size clause that is not applicable to the entity.
3825
d1f453b7 3826-- OK_To_Rename (Flag247)
30ebb114 3827-- Defined only in entities for variables. If this flag is set, it
d1f453b7
RD
3828-- means that if the entity is used as the initial value of an object
3829-- declaration, the object declaration can be safely converted into a
3830-- renaming to avoid an extra copy. This is set for variables which are
3831-- generated by the expander to hold the result of evaluating some
3832-- expression. Most notably, the local variables used to store the result
3833-- of concatenations are so marked (see Exp_Ch4.Expand_Concatenate). It
3834-- is only worth setting this flag for composites, since for primitive
3835-- types, it is cheaper to do the copy.
3836
21d27997 3837-- Optimize_Alignment_Space (Flag241)
30ebb114 3838-- Defined in type, subtype, variable, and constant entities. This
1f159b86 3839-- flag records that the type or object is to be laid out in a manner
21d27997
RD
3840-- consistent with Optimize_Alignment (Space) mode. The compiler and
3841-- binder ensure a consistent view of any given type or object. If pragma
3842-- Optimize_Alignment (Off) mode applies to the type/object, then neither
3843-- of the flags Optimize_Alignment_Space/Optimize_Alignment_Time is set.
3844
3845-- Optimize_Alignment_Time (Flag242)
30ebb114 3846-- Defined in type, subtype, variable, and constant entities. This
1f159b86 3847-- flag records that the type or object is to be laid out in a manner
21d27997
RD
3848-- consistent with Optimize_Alignment (Time) mode. The compiler and
3849-- binder ensure a consistent view of any given type or object. If pragma
3850-- Optimize_Alignment (Off) mode applies to the type/object, then neither
3851-- of the flags Optimize_Alignment_Space/Optimize_Alignment_Time is set.
82c80734 3852
760804f3 3853-- Original_Access_Type (Node28)
30ebb114 3854-- Defined in E_Access_Subprogram_Type entities. Set only if the access
ded462b0
AC
3855-- type was generated by the expander as part of processing an access-
3856-- to-protected-subprogram type. Points to the access-to-protected-
aa1e353a
AC
3857-- subprogram type.
3858
07fc65c4 3859-- Original_Array_Type (Node21)
8ca597af
RD
3860-- Defined in modular types and array types and subtypes. Set only if
3861-- the Is_Packed_Array_Impl_Type flag is set, indicating that the type
07fc65c4
GB
3862-- is the implementation type for a packed array, and in this case it
3863-- points to the original array type for which this is the packed
3864-- array implementation type.
3865
42f11e4c
AC
3866-- Original_Protected_Subprogram (Node41)
3867-- Defined in functions and procedures. Set only on internally built
3868-- dispatching subprograms of protected types to reference their original
3869-- non-dispatching protected subprogram since their names differ.
3870
70482933 3871-- Original_Record_Component (Node22)
30ebb114 3872-- Defined in components, including discriminants. The usage depends
70482933
RK
3873-- on whether the record is a base type and whether it is tagged.
3874--
3875-- In base tagged types:
3876-- When the component is inherited in a record extension, it points
3877-- to the original component (the entity of the ancestor component
28bc3323
AC
3878-- which is not itself inherited) otherwise it points to itself. The
3879-- backend uses this attribute to implement the automatic dereference
3880-- in the extension and to apply the transformation:
70482933
RK
3881--
3882-- Rec_Ext.Comp -> Rec_Ext.Parent. ... .Parent.Comp
3883--
7c0c194b 3884-- In base untagged types:
70482933
RK
3885-- Always points to itself except for non-girder discriminants, where
3886-- it points to the girder discriminant it renames.
3887--
3888-- In subtypes (tagged and untagged):
3889-- Points to the component in the base type.
3890
21d27997 3891-- Overlays_Constant (Flag243)
c31b57af 3892-- Defined in all entities. Set only for E_Constant or E_Variable for
8a0183fd 3893-- which there is an address clause that causes the entity to overlay
c31b57af 3894-- a constant object.
21d27997 3895
10b93b2e 3896-- Overridden_Operation (Node26)
30ebb114 3897-- Defined in subprograms. For overriding operations, points to the
6320f5e1
AC
3898-- user-defined parent subprogram that is being overridden. Note: this
3899-- attribute uses the same field as Static_Initialization. The latter
3900-- is only defined for internal initialization procedures, for which
3901-- Overridden_Operation is irrelevant. Thus this attribute must not be
3902-- set for init_procs.
10b93b2e 3903
f4d379b8 3904-- Package_Instantiation (Node26)
30ebb114 3905-- Defined in packages and generic packages. When defined, this field
60370fb1 3906-- references an N_Generic_Instantiation node associated with an
f4d379b8
HK
3907-- instantiated package. In the case where the referenced node has
3908-- been rewritten to an N_Package_Specification, the instantiation
3909-- node is available from the Original_Node field of the package spec
3910-- node. This is currently not guaranteed to be set in all cases, but
30522cdb 3911-- when set, the field is used in Get_Unit_Instantiation_Node as
f4d379b8
HK
3912-- one of the means of obtaining the instantiation node. Eventually
3913-- it should be set in all cases, including package entities associated
3914-- with formal packages. ???
3915
8ca597af 3916-- Packed_Array_Impl_Type (Node23)
b3f75672
EB
3917-- Defined in array types and subtypes, except for the string literal
3918-- subtype case, if the corresponding type is packed and implemented
607114db 3919-- specially (either bit-packed or packed to eliminate holes in the
b3f75672
EB
3920-- non-contiguous enumeration index types). References the type used to
3921-- represent the packed array, which is either a modular type for short
607114db 3922-- static arrays or an array of System.Unsigned in the bit-packed case,
02848684 3923-- or a regular array in the non-standard enumeration index case. Note
b3f75672
EB
3924-- that in some situations (internal types and references to fields of
3925-- variant records), it is not always possible to construct this type in
3926-- advance of its use. If this field is empty, then the necessary type
3927-- is declared on the fly for each reference to the array.
70482933
RK
3928
3929-- Parameter_Mode (synthesized)
3930-- Applies to formal parameter entities. This is a synonym for Ekind,
3931-- used when obtaining the formal kind of a formal parameter (the result
4ef36ac7 3932-- is one of E_[In/Out/In_Out]_Parameter).
70482933 3933
6fb4cdde 3934-- Parent_Subtype (Node19) [base type only]
30ebb114 3935-- Defined in E_Record_Type. Set only for derived tagged types, in which
6fb4cdde
AC
3936-- case it points to the subtype of the parent type. This is the type
3937-- that is used as the Etype of the _parent field.
70482933 3938
75b87c16
AC
3939-- Part_Of_Constituents (Elist10)
3940-- Present in abstract state and variable entities. Contains all
3941-- constituents that are subject to indicator Part_Of (both aspect and
3942-- option variants).
d7af5ea5 3943
fdc54be6
AC
3944-- Part_Of_References (Elist11)
3945-- Present in variable entities. Contains all references to the variable
3946-- when it is subject to pragma Part_Of. If the variable is a constituent
3947-- of a single protected/task type, the references are examined as they
3948-- must appear only within the type defintion and the corresponding body.
3949
f7937111
GD
3950-- Partial_DIC_Procedure (synthesized)
3951-- Defined in type entities. Set for a private type and its full view
3952-- when the type is subject to pragma Default_Initial_Condition (DIC), or
3953-- when the type inherits a DIC pragma from a parent type. Points to the
3954-- entity of a procedure that takes a single argument of the given type
3955-- and verifies the assertion expression of the DIC pragma at run time.
3956-- When present, the Partial_DIC_Procedure of a type only checks DICs
3957-- associated with the partial (private) view of the type, and is invoked
3958-- by the full DIC_Procedure (which may check additional DICs associated
3959-- with the full view).
3960
3961-- Note: the reason this is marked as a synthesized attribute is that the
3962-- way this is stored is as an element of the Subprograms_For_Type field.
3963
3ddfabe3
AC
3964-- Partial_Invariant_Procedure (synthesized)
3965-- Defined in types and subtypes. Set for private types when one or more
3966-- [class-wide] type invariants apply to them. Points to the entity for a
3967-- procedure which checks the invariant. This invariant procedure takes a
3968-- single argument of the given type, and returns if the invariant holds,
3969-- or raises exception Assertion_Error with an appropriate message if it
3970-- does not hold. This attribute is defined but always Empty for private
3971-- subtypes. This attribute is also set for the corresponding full type.
3972--
3973-- Note: the reason this is marked as a synthesized attribute is that the
3974-- way this is stored is as an element of the Subprograms_For_Type field.
3975
d89ce432 3976-- Partial_Refinement_Constituents (synthesized)
05f1a543
AC
3977-- Defined in abstract state entities. Returns the constituents that
3978-- refine the state in the current scope, which are allowed in a global
c9d2e84b 3979-- refinement in this scope. These consist of those constituents that are
05f1a543
AC
3980-- abstract states with no or only partial refinement visible, and those
3981-- that are not themselves abstract states.
d89ce432 3982
07a64c02 3983-- Partial_View_Has_Unknown_Discr (Flag280)
dacc3457 3984-- Present in all types. Set to Indicate that the partial view of a type
07a64c02
AC
3985-- has unknown discriminants. A default initialization of an object of
3986-- the type does not require an invariant check (AI12-0133).
3987
760804f3
AC
3988-- Pending_Access_Types (Elist15)
3989-- Defined in all types. Set for incomplete, private, Taft-amendment
3990-- types, and their corresponding full views. This list contains all
3991-- access types, both named and anonymous, declared between the partial
3992-- and the full view. The list is used by the finalization machinery to
3993-- ensure that the finalization masters of all pending access types are
3994-- fully initialized when the full view is frozen.
3995
c9d70ab1
AC
3996-- Postconditions_Proc (Node14)
3997-- Defined in functions, procedures, entries, and entry families. Refers
3998-- to the entity of the _Postconditions procedure used to check contract
3999-- assertions on exit from a subprogram.
7ca78bba 4000
4818e7b9 4001-- Predicate_Function (synthesized)
30ebb114 4002-- Defined in all types. Set for types for which (Has_Predicates is True)
fd0ff1cf 4003-- and for which a predicate procedure has been built that tests that the
4818e7b9
RD
4004-- specified predicates are True. Contains the entity for the function
4005-- which takes a single argument of the given type, and returns True if
4006-- the predicate holds and False if it does not.
fd0ff1cf 4007--
1e60643a
AC
4008-- Note: flag Has_Predicate does not imply that Predicate_Function is set
4009-- to a non-empty entity; this happens, for example, for itypes created
4010-- when instantiating generic units with private types with predicates.
4011-- However, if an explicit pragma Predicate or Predicate aspect is given
4012-- either for private or full type declaration then both Has_Predicates
4013-- and a non-empty Predicate_Function will be set on both the partial and
4014-- full views of the type.
4015--
fd0ff1cf
RD
4016-- Note: the reason this is marked as a synthesized attribute is that the
4017-- way this is stored is as an element of the Subprograms_For_Type field.
4018
fc142f63
AC
4019-- Predicate_Function_M (synthesized)
4020-- Defined in all types. Present only if Predicate_Function is present,
4021-- and only if the predicate function has Raise_Expression nodes. It
4022-- is the special version created for membership tests, where if one of
4023-- these raise expressions is executed, the result is to return False.
4024
3f6d1daa 4025-- Predicated_Parent (Node38)
ffdd5248
ES
4026-- Defined on itypes created by subtype indications, when the parent
4027-- subtype has predicates. The itype shares the Predicate_Function
4028-- of the predicated parent, but this function may not have been built
4029-- at the point the Itype is constructed, so this attribute allows its
4030-- retrieval at the point a predicate check needs to be generated.
4031-- The utility Predicate_Function takes this link into account.
4032
8d4611f7
AC
4033-- Predicates_Ignored (Flag288)
4034-- Defined on all types. Indicates whether the subtype declaration is in
4035-- a context where Assertion_Policy is Ignore, in which case no checks
4036-- (static or dynamic) must be generated for objects of the type.
4037
3f6d1daa
JS
4038-- Prev_Entity (Node36)
4039-- Defined in all entities. The entities of a scope are chained, and this
4040-- field is used as a backward pointer for this entity list - effectivly
4041-- making the entity chain doubly-linked.
4042
68f640f2 4043-- Primitive_Operations (synthesized)
30ebb114 4044-- Defined in concurrent types, tagged record types and subtypes, tagged
68f640f2
AC
4045-- private types and tagged incomplete types. For concurrent types whose
4046-- Corresponding_Record_Type (CRT) is available, returns the list of
4047-- Direct_Primitive_Operations of its CRT; otherwise returns No_Elist.
4048-- For all the other types returns the Direct_Primitive_Operations.
4049
21d27997 4050-- Prival (Node17)
30ebb114 4051-- Defined in private components of protected types. Refers to the entity
21d27997
RD
4052-- of the component renaming declaration generated inside protected
4053-- subprograms, entries or barrier functions.
4054
4055-- Prival_Link (Node20)
30ebb114 4056-- Defined in constants and variables which rename private components of
21d27997
RD
4057-- protected types. Set to the original private component.
4058
70482933 4059-- Private_Dependents (Elist18)
30ebb114 4060-- Defined in private (sub)types. Records the subtypes of the private
ae65d635
AC
4061-- type, derivations from it, and records and arrays with components
4062-- dependent on the type.
70482933 4063--
ae65d635
AC
4064-- The subtypes are traversed when installing and deinstalling (the full
4065-- view of) a private type in order to ensure correct view of the
4066-- subtypes.
70482933
RK
4067--
4068-- Used in similar fashion for incomplete types: holds list of subtypes
4069-- of these incomplete types that have discriminant constraints. The
4070-- full views of these subtypes are constructed when the full view of
4071-- the incomplete type is processed.
4072
4073-- In addition, if the incomplete type is the designated type in an
4074-- access definition for an access parameter, the operation may be
4075-- a dispatching primitive operation, which is only known when the full
4076-- declaration of the type is seen. Subprograms that have such an
4077-- access parameter are also placed in the list of private_dependents.
4078
02886c2e
AC
4079-- Protected_Body_Subprogram (Node11)
4080-- Defined in protected operations. References the entity for the
4081-- subprogram which implements the body of the operation.
4082
70482933 4083-- Protected_Formal (Node22)
30ebb114 4084-- Defined in formal parameters (in, in out and out parameters). Used
70482933
RK
4085-- only for formals of protected operations. References corresponding
4086-- formal parameter in the unprotected version of the operation that
4087-- is created during expansion.
4088
90e491a7
PMR
4089-- Protected_Subprogram (Node39)
4090-- Defined in functions and procedures. Set for the pair of subprograms
4091-- which emulate the runtime semantics of a protected subprogram. Denotes
4092-- the entity of the origial protected subprogram.
4093
21d27997
RD
4094-- Protection_Object (Node23)
4095-- Applies to protected entries, entry families and subprograms. Denotes
4096-- the entity which is used to rename the _object component of protected
4097-- types.
70482933
RK
4098
4099-- Reachable (Flag49)
30ebb114 4100-- Defined in labels. The flag is set over the range of statements in
70482933
RK
4101-- which a goto to that label is legal.
4102
90e491a7
PMR
4103-- Receiving_Entry (Node19)
4104-- Defined in procedures. Set for an internally generated procedure which
4105-- wraps the original statements of an accept alternative. Designates the
4106-- entity of the task entry being accepted.
4107
70482933 4108-- Referenced (Flag156)
30ebb114 4109-- Defined in all entities. Set if the entity is referenced, except for
e14c931f 4110-- the case of an appearance of a simple variable that is not a renaming
ce0bead3 4111-- as the left side of an assignment in which case Referenced_As_LHS is
e14c931f 4112-- set instead, or a similar appearance as an out parameter actual, in
8d12c865 4113-- which case Referenced_As_Out_Parameter is set.
fbf5a39b 4114
5d37ba92 4115-- Referenced_As_LHS (Flag36):
30ebb114 4116-- Defined in all entities. This flag is set instead of Referenced if a
fdce4bb7
JM
4117-- simple variable that is not a renaming appears as the left side of an
4118-- assignment. The reason we distinguish this kind of reference is that
4119-- we have a separate warning for variables that are only assigned and
4120-- never read.
70482933 4121
ce0bead3 4122-- Referenced_As_Out_Parameter (Flag227):
30ebb114 4123-- Defined in all entities. This flag is set instead of Referenced if a
ce0bead3
HK
4124-- simple variable that is not a renaming appears as an actual for an out
4125-- formal. The reason we distinguish this kind of reference is that
4126-- we have a separate warning for variables that are only assigned and
4127-- never read, and out parameters are a special case.
4128
ab8843fa
HK
4129-- Refinement_Constituents (Elist8)
4130-- Present in abstract state entities. Contains all the constituents that
4131-- refine the state, in other words, all the hidden states that appear in
4132-- the constituent_list of aspect/pragma Refined_State.
4133
70482933 4134-- Register_Exception_Call (Node20)
30ebb114 4135-- Defined in exception entities. When an exception is declared,
70482933
RK
4136-- a call is expanded to Register_Exception. This field points to
4137-- the expanded N_Procedure_Call_Statement node for this call. It
4138-- is used for Import/Export_Exception processing to modify the
4139-- register call to make appropriate entries in the special tables
e51102b2 4140-- used for handling these pragmas at run time.
70482933 4141
6d9e03cb 4142-- Related_Array_Object (Node25)
30ebb114 4143-- Defined in array types and subtypes. Used only for the base type
70482933
RK
4144-- and subtype created for an anonymous array object. Set to point
4145-- to the entity of the corresponding array object. Currently used
4146-- only for type-related error messages.
4147
a4941eec 4148-- Related_Expression (Node24)
80a09e02
AC
4149-- Defined in variables, types and functions. When Set for internally
4150-- generated entities, it may be used to denote the source expression
4151-- whose elaboration created the variable declaration. If set, it is used
c2e54001
AC
4152-- for generating clearer messages from CodePeer. It is used on source
4153-- entities that are variables in iterator specifications, to provide
4154-- a link to the container that is the domain of iteration. This allows
4155-- for better cross-reference information when the loop modifies elements
4156-- of the container, and suppresses spurious warnings.
80a09e02
AC
4157-- Finally this node is used on functions specified via the Real_Literal
4158-- aspect, to denote the 2-parameter overloading, if found.
cf49bd32
TQ
4159--
4160-- Shouldn't it also be used for the same purpose in errout? It seems
4161-- odd to have two mechanisms here???
a4941eec 4162
70482933 4163-- Related_Instance (Node15)
30ebb114 4164-- Defined in the wrapper packages created for subprogram instances.
70482933
RK
4165-- The internal subprogram that implements the instance is inside the
4166-- wrapper package, but for debugging purposes its external symbol
4167-- must correspond to the name and scope of the related instance.
4168
cefce34c 4169-- Related_Type (Node27)
30ebb114 4170-- Defined in components, constants and variables. Set when there is an
cefce34c
JM
4171-- associated dispatch table to point to entities containing primary or
4172-- secondary tags. Not set in the _tag component of record types.
0a36105d 4173
760804f3 4174-- Relative_Deadline_Variable (Node28) [implementation base type only]
30ebb114 4175-- Defined in task type entities. This flag is set if a valid and
21d27997
RD
4176-- effective pragma Relative_Deadline applies to the base type. Points
4177-- to the entity for a variable that is created to hold the value given
4178-- in a Relative_Deadline pragma for a task type.
4179
70482933 4180-- Renamed_Entity (Node18)
90e491a7
PMR
4181-- Defined in exception, generic unit, package, and subprogram entities.
4182-- Set when the entity is defined by a renaming declaration. Denotes the
4183-- renamed entity, or transitively the ultimate renamed entity if there
4184-- is a chain of renaming declarations. Empty if no renaming.
70482933 4185
ce0bead3 4186-- Renamed_In_Spec (Flag231)
30ebb114 4187-- Defined in package entities. If a package renaming occurs within
ce0bead3
HK
4188-- a package spec, then this flag is set on the renamed package. The
4189-- purpose is to prevent a warning about unused entities in the renamed
4190-- package. Such a warning would be inappropriate since clients of the
4191-- package can see the entities in the package via the renaming.
4192
70482933 4193-- Renamed_Object (Node18)
a65dcb0d
AC
4194-- Defined in components, constants, discriminants, formal parameters,
4195-- generic formals, loop parameters, and variables. Set to non-Empty if
4196-- the object was declared by a renaming declaration. For constants and
4197-- variables, the attribute references the tree node for the name of the
4198-- renamed object. For formal parameters, the field is used in inlining
4199-- and maps the entities of all formal parameters of a subprogram to the
4200-- entities of the corresponding actuals. For formals of a task entry,
4201-- the attribute denotes the local renaming that replaces the actual
4202-- within an accept statement. For all remaining cases (discriminants,
4203-- loop parameters) the field is Empty.
70482933
RK
4204
4205-- Renaming_Map (Uint9)
30ebb114
AC
4206-- Defined in generic subprograms, generic packages, and their
4207-- instances. Also defined in the instances of the corresponding
70482933 4208-- bodies. Denotes the renaming map (generic entities => instance
578d5941 4209-- entities) used to construct the instance by giving an index into
70482933
RK
4210-- the tables used to represent these maps. See Sem_Ch12 for further
4211-- details. The maps for package instances are also used when the
4212-- instance is the actual corresponding to a formal package.
4213
f937473f 4214-- Requires_Overriding (Flag213)
30ebb114 4215-- Defined in all subprograms and entries. Set for subprograms that
f937473f 4216-- require overriding as defined by RM-2005-3.9.3(6/2). Note that this
a9fdbccb 4217-- is True only for implicitly declared subprograms; it is not set on the
f937473f
RD
4218-- parent type's subprogram. See also Is_Abstract_Subprogram.
4219
6e443c90 4220-- Return_Applies_To (Node8)
30ebb114 4221-- Defined in E_Return_Statement. Points to the entity representing
6e443c90
RD
4222-- the construct to which the return statement applies, as defined in
4223-- RM-6.5(4/2). Note that a (simple) return statement within an
4224-- extended_return_statement applies to the extended_return_statement,
4225-- even though it causes the whole function to return.
c5a913d3
EB
4226-- Also defined in special E_Block entities built as E_Return_Statement
4227-- for extended return statements and attached to the block statement
4228-- by Expand_N_Extended_Return_Statement before being turned into an
4229-- E_Block by semantic analysis.
6e443c90 4230
02886c2e
AC
4231-- Return_Present (Flag54)
4232-- Defined in function and generic function entities. Set if the
4233-- function contains a return statement (used for error checking).
4234-- This flag can also be set in procedure and generic procedure
4235-- entities (for convenience in setting it), but is only tested
4236-- for the function case.
4237
70482933 4238-- Returns_By_Ref (Flag90)
c392a001
GD
4239-- Defined in subprogram type entities and functions. Set if a function
4240-- (or an access-to-function type) returns a result by reference, either
4241-- because its return type is a by-reference-type or because the function
4242-- explicitly uses the secondary stack.
70482933 4243
07fc65c4 4244-- Reverse_Bit_Order (Flag164) [base type only]
30ebb114 4245-- Defined in all record type entities. Set if entity has a Bit_Order
8f66cda7
AC
4246-- aspect (set by an aspect clause or attribute definition clause) that
4247-- has reversed the order of bits from the default value. When this flag
4248-- is set, a component clause must specify a set of bits entirely within
4249-- a single storage unit (Ada 95) or within a single machine scalar (see
4250-- Ada 2005 AI-133), or must occupy an integral number of storage units.
70482933 4251
de94a7e7 4252-- Reverse_Storage_Order (Flag93) [base type only]
30ebb114 4253-- Defined in all record and array type entities. Set if entity has a
de94a7e7
AC
4254-- Scalar_Storage_Order aspect (set by an aspect clause or attribute
4255-- definition clause) that has reversed the order of storage elements
a2c1791d
AC
4256-- from the default value. When this flag is set for a record type,
4257-- the Bit_Order aspect must be set to the same value (either explicitly
4258-- or as the target default value).
de94a7e7 4259
2700b9c1
AC
4260-- Rewritten_For_C (Flag287)
4261-- Defined on functions that return a constrained array type, when
ed11bbfe 4262-- Modify_Tree_For_C is set. Indicates that a procedure with an extra
2700b9c1
AC
4263-- out parameter has been created for it, and calls must be rewritten as
4264-- calls to the new procedure.
4265
70482933 4266-- RM_Size (Uint13)
30ebb114 4267-- Defined in all type and subtype entities. Contains the value of
70482933
RK
4268-- type'Size as defined in the RM. See also the Esize field and
4269-- and the description on "Handling of Type'Size Values". A value
9596236a 4270-- of zero in this field for a non-discrete type means that
70482933
RK
4271-- the front end has not yet determined the size value. For the
4272-- case of a discrete type, this field is always set by the front
4273-- end and zero is a legitimate value for a type with one value.
4274
4275-- Root_Type (synthesized)
596b25f9 4276-- Applies to all type entities. For class-wide types, returns the root
70482933
RK
4277-- type of the class covered by the CW type, otherwise returns the
4278-- ultimate derivation ancestor of the given type. This function
4279-- preserves the view, i.e. the Root_Type of a partial view is the
e14c931f 4280-- partial view of the ultimate ancestor, the Root_Type of a full view
70482933
RK
4281-- is the full view of the ultimate ancestor. Note that this function
4282-- does not correspond exactly to the use of root type in the RM, since
4283-- in the RM root type applies to a class of types, not to a type.
4284
4285-- Scalar_Range (Node20)
30ebb114 4286-- Defined in all scalar types (including modular types, where the
70482933
RK
4287-- bounds are 0 .. modulus - 1). References a node in the tree that
4288-- contains the bounds for the range. Note that this information
4289-- could be obtained by rummaging around the tree, but it is more
4290-- convenient to have it immediately at hand in the entity. The
4291-- contents of Scalar_Range can either be an N_Subtype_Indication
c70f7583
ES
4292-- node (with a constraint), a Range node, or an Integer_Type_Definition,
4293-- but not a simple subtype reference (a subtype is converted into a
4294-- explicit range).
70482933 4295
760804f3 4296-- Scale_Value (Uint16)
2015a575
EB
4297-- Defined in decimal fixed-point types and subtypes. This holds the
4298-- value of the Scale attribute for the type, i.e. the scale of the type
4299-- defined as the integer N such that the delta is equal to 10.0**(-N).
4300-- Note that, if Scale_Value is positive, then it is equal to Aft_Value.
70482933
RK
4301
4302-- Scope (Node3)
30ebb114 4303-- Defined in all entities. Points to the entity for the scope (block,
70482933
RK
4304-- loop, subprogram, package etc.) in which the entity is declared.
4305-- Since this field is in the base part of the entity node, the access
e0c23ac7
AC
4306-- routines for this field are in Sinfo. Note that for a child unit,
4307-- the Scope will be the parent package, and for a root library unit,
ba673907 4308-- the Scope will be Standard.
70482933 4309
9d77af56 4310-- Scope_Depth (synthesized)
7e3f6147
AC
4311-- Applies to program units, blocks, loops, return statements,
4312-- concurrent types, private types and entries, and also to record types,
4313-- i.e. to any entity that can appear on the scope stack. Yields the
4314-- scope depth value, which for those entities other than records is
4315-- simply the scope depth value, for record entities, it is the
4316-- Scope_Depth of the record scope.
70482933
RK
4317
4318-- Scope_Depth_Value (Uint22)
7e3f6147
AC
4319-- Defined in program units, blocks, loops, return statements,
4320-- concurrent types, private types and entries.
e2534738
AC
4321-- Indicates the number of scopes that statically enclose the declaration
4322-- of the unit or type. Library units have a depth of zero. Note that
4323-- record types can act as scopes but do NOT have this field set (see
4ef36ac7 4324-- Scope_Depth above).
70482933
RK
4325
4326-- Scope_Depth_Set (synthesized)
4327-- Applies to a special predicate function that returns a Boolean value
e2534738 4328-- indicating whether or not the Scope_Depth field has been set. It is
a90bd866 4329-- needed, since returns an invalid value in this case.
70482933
RK
4330
4331-- Sec_Stack_Needed_For_Return (Flag167)
f32eb591
AC
4332-- Defined in scope entities (blocks, entries, entry families, functions,
4333-- and procedures). Set to True when secondary stack is used to hold the
4334-- returned value of a function and thus should not be released on scope
4335-- exit.
70482933 4336
685094bf 4337-- Shared_Var_Procs_Instance (Node22)
30ebb114 4338-- Defined in variables. Set non-Empty only if Is_Shared_Passive is
685094bf
RD
4339-- set, in which case this is the entity for the associated instance of
4340-- System.Shared_Storage.Shared_Var_Procs. See Exp_Smem for full details.
70482933 4341
fbf5a39b 4342-- Size_Check_Code (Node19)
30ebb114 4343-- Defined in constants and variables. Normally Empty. Set if code is
fbf5a39b 4344-- generated to check the size of the object. This field is used to
70482933
RK
4345-- suppress this code if a subsequent address clause is encountered.
4346
4347-- Size_Clause (synthesized)
4348-- Applies to all entities. If a size clause is present in the rep
4349-- item chain for an entity then the attribute definition clause node
4350-- for the size clause is returned. Otherwise Size_Clause returns Empty
4351-- if no item is present. Usually this is only meaningful if the flag
4352-- Has_Size_Clause is set. This is because when the representation item
4353-- chain is copied for a derived type, it can inherit a size clause that
4354-- is not applicable to the entity.
4355
4356-- Size_Depends_On_Discriminant (Flag177)
30ebb114 4357-- Defined in all entities for types and subtypes. Indicates that the
70482933 4358-- size of the type depends on the value of one or more discriminants.
e3c4580e
EB
4359-- Currently, this flag is only set for arrays which have one or more
4360-- bounds depending on a discriminant value.
70482933
RK
4361
4362-- Size_Known_At_Compile_Time (Flag92)
30ebb114 4363-- Defined in all entities for types and subtypes. Indicates that the
70482933
RK
4364-- size of objects of the type is known at compile time. This flag is
4365-- used to optimize some generated code sequences, and also to enable
4366-- some error checks (e.g. disallowing component clauses on variable
21d27997 4367-- length objects). It is set conservatively (i.e. if it is True, the
70482933
RK
4368-- size is certainly known at compile time, if it is False, then the
4369-- size may or may not be known at compile time, but the code will
167b47d9
AC
4370-- assume that it is not known). Note that the value may be known only
4371-- to the back end, so the fact that this flag is set does not mean that
4372-- the front end can access the value.
70482933
RK
4373
4374-- Small_Value (Ureal21)
30ebb114 4375-- Defined in fixed point types. Points to the universal real for the
70482933
RK
4376-- Small of the type, either as given in a representation clause, or
4377-- as computed (as a power of two) by the compiler.
4378
877a5a12 4379-- SPARK_Aux_Pragma (Node41)
75b87c16
AC
4380-- Present in concurrent type, [generic] package spec and package body
4381-- entities. For concurrent types and package specs it refers to the
4382-- SPARK mode setting for the private part. This field points to the
4383-- N_Pragma node that either appears in the private part or is inherited
4384-- from the enclosing context. For package bodies, it refers to the SPARK
4385-- mode of the elaboration sequence after the BEGIN. The fields points to
4386-- the N_Pragma node that either appears in the statement sequence or is
877a5a12
AC
4387-- inherited from the enclosing context. In all cases, if the pragma is
4388-- inherited, then the SPARK_Aux_Pragma_Inherited flag is set.
579847c2
AC
4389
4390-- SPARK_Aux_Pragma_Inherited (Flag266)
75b87c16
AC
4391-- Present in concurrent type, [generic] package spec and package body
4392-- entities. Set if the SPARK_Aux_Pragma field points to a pragma that is
877a5a12
AC
4393-- inherited, rather than a local one.
4394
4395-- SPARK_Pragma (Node40)
8dce7371
PMR
4396-- Present in the following entities:
4397--
4398-- abstract states
4399-- constants
4400-- entries
4401-- operators
4402-- [generic] packages
4403-- package bodies
4404-- [generic] subprograms
4405-- subprogram bodies
4406-- variables
4407-- types
4408--
4409-- Points to the N_Pragma node that applies to the initial declaration or
4410-- body. This is either set by a local SPARK_Mode pragma or is inherited
4411-- from the context (from an outer scope for the spec case or from the
4412-- spec for the body case). In the case where the attribute is inherited,
4413-- flag SPARK_Pragma_Inherited is set. Empty if no SPARK_Mode pragma is
4414-- applicable.
579847c2
AC
4415
4416-- SPARK_Pragma_Inherited (Flag265)
8dce7371
PMR
4417-- Present in the following entities:
4418--
4419-- abstract states
4420-- constants
4421-- entries
4422-- operators
4423-- [generic] packages
4424-- package bodies
4425-- [generic] subprograms
4426-- subprogram bodies
4427-- variables
4428-- types
4429--
4430-- Set if the SPARK_Pragma attribute points to an inherited pragma rather
4431-- than a local one.
1c6269d3 4432
70482933 4433-- Spec_Entity (Node19)
30ebb114
AC
4434-- Defined in package body entities. Points to corresponding package
4435-- spec entity. Also defined in subprogram body parameters in the
70482933
RK
4436-- case where there is a separate spec, where this field references
4437-- the corresponding parameter entities in the spec.
4438
220d1fd9
AC
4439-- SSO_Set_High_By_Default (Flag273) [base type only]
4440-- Defined for record and array types. Set in the base type if a pragma
4441-- Default_Scalar_Storage_Order (High_Order_First) was active at the time
4442-- the record or array was declared and therefore applies to it.
4443
4444-- SSO_Set_Low_By_Default (Flag272) [base type only]
4445-- Defined for record and array types. Set in the base type if a pragma
4446-- Default_Scalar_Storage_Order (High_Order_First) was active at the time
4447-- the record or array was declared and therefore applies to it.
4448
60f908dd 4449-- Static_Discrete_Predicate (List25)
ee4eee0a 4450-- Defined in discrete types/subtypes with static predicates (with the
fc3a3f3b 4451-- two flags Has_Predicates and Has_Static_Predicate set). Set if the
ee4eee0a
AC
4452-- type/subtype has a static predicate. Points to a list of expression
4453-- and N_Range nodes that represent the predicate in canonical form. The
4454-- canonical form has entries sorted in ascending order, with duplicates
4455-- eliminated, and adjacent ranges coalesced, so that there is always a
4456-- gap in the values between successive entries. The entries in this list
4457-- are fully analyzed and typed with the base type of the subtype. Note
4458-- that all entries are static and have values within the subtype range.
26df19ce 4459
02886c2e
AC
4460-- Static_Elaboration_Desired (Flag77)
4461-- Defined in library-level packages. Set by the pragma of the same
4462-- name, to indicate that static initialization must be attempted for
4463-- all types declared in the package, and that a warning must be emitted
4464-- for those types to which static initialization is not available.
4465
4466-- Static_Initialization (Node30)
4467-- Defined in initialization procedures for types whose objects can be
4468-- initialized statically. The value of this attribute is a positional
4469-- aggregate whose components are compile-time static values. Used
4470-- when available in object declarations to eliminate the call to the
4471-- initialization procedure, and to minimize elaboration code. Note:
4472-- This attribute uses the same field as Overridden_Operation, which is
4473-- irrelevant in init_procs.
4474
fc3a3f3b
RD
4475-- Static_Real_Or_String_Predicate (Node25)
4476-- Defined in real types/subtypes with static predicates (with the two
4477-- flags Has_Predicates and Has_Static_Predicate set). Set if the type
4478-- or subtype has a static predicate. Points to the return expression
4479-- of the predicate function. This is the original expression given as
4480-- the predicate except that occurrences of the type are replaced by
4481-- occurrences of the formal parameter of the predicate function (note
9b7924dd
AC
4482-- that the spec of this function including this formal parameter name
4483-- is available from the Subprograms_For_Type field; it can be accessed
4484-- as Predicate_Function (typ)). Also, in the case where a predicate is
fc3a3f3b
RD
4485-- inherited, the expression is of the form:
4486--
9bdc432a 4487-- xxxPredicate (typ2 (ent)) AND THEN expression
fc3a3f3b
RD
4488--
4489-- where typ2 is the type from which the predicate is inherited, ent is
4490-- the entity for the current predicate function, and xxxPredicate is the
4491-- inherited predicate (from typ2). Finally for a predicate that inherits
4492-- from another predicate but does not add a predicate of its own, the
4493-- expression may consist of the above xxxPredicate call on its own.
4494
3cebd1c0 4495-- Status_Flag_Or_Transient_Decl (Node15)
6877306f
AC
4496-- Defined in constant, loop, and variable entities. Applies to objects
4497-- that require special treatment by the finalization machinery, such as
4498-- extended return results, IF and CASE expression results, and objects
4499-- inside N_Expression_With_Actions nodes. The attribute contains the
4500-- entity of a flag which specifies particular behavior over a region of
4501-- code or the declaration of a "hook" object.
d2a6bd6b 4502-- In which case is it a flag, or a hook object???
3cebd1c0 4503
760804f3 4504-- Storage_Size_Variable (Node26) [implementation base type only]
50ea6357
AC
4505-- Defined in access types and task type entities. This flag is set
4506-- if a valid and effective pragma Storage_Size applies to the base
4507-- type. Points to the entity for a variable that is created to
4508-- hold the value given in a Storage_Size pragma for an access
4509-- collection or a task type. Note that in the access type case,
4510-- this field is defined only in the root type (since derived types
4511-- share the same storage pool).
4512
fbf5a39b 4513-- Stored_Constraint (Elist23)
30ebb114 4514-- Defined in entities that can have discriminants (concurrent types
fbf5a39b
AC
4515-- subtypes, record types and subtypes, private types and subtypes,
4516-- limited private types and subtypes and incomplete types). Points
4517-- to an element list containing the expressions for each of the
4518-- stored discriminants for the record (sub)type.
4519
50ea6357 4520-- Stores_Attribute_Old_Prefix (Flag270)
a1023434
JS
4521-- Defined in constants, variables, and types which are created during
4522-- expansion in order to save the value of attribute 'Old's prefix.
50ea6357 4523
70482933 4524-- Strict_Alignment (Flag145) [implementation base type only]
a517d6c1
EB
4525-- Defined in all type entities. Indicates that the type is by-reference
4526-- or contains an aliased part. This forbids packing a component of this
4527-- type tighter than the alignment and size of the type, as specified by
4528-- RM 13.2(7) modified by AI12-001 as a Binding Interpretation.
70482933
RK
4529
4530-- String_Literal_Length (Uint16)
30ebb114 4531-- Defined in string literal subtypes (which are created to correspond
70482933
RK
4532-- to string literals in the program). Contains the length of the string
4533-- literal.
4534
760804f3 4535-- String_Literal_Low_Bound (Node18)
30ebb114 4536-- Defined in string literal subtypes (which are created to correspond
70482933
RK
4537-- to string literals in the program). Contains an expression whose
4538-- value represents the low bound of the literal. This is a copy of
4539-- the low bound of the applicable index constraint if there is one,
4540-- or a copy of the low bound of the index base type if not.
4541
3ddfabe3
AC
4542-- Subprograms_For_Type (Elist29)
4543-- Defined in all types. The list may contain the entities of the default
4544-- initial condition procedure, invariant procedure, and the two versions
4545-- of the predicate function.
4546--
4547-- Historical note: This attribute used to be a direct linked list of
4548-- entities rather than an Elist. The Elist allows greater flexibility
4549-- in inheritance of subprograms between views of the same type.
fd0ff1cf 4550
3830827c 4551-- Subps_Index (Uint24)
ee935273
AC
4552-- Present in subprogram entries. Set if the subprogram contains nested
4553-- subprograms, or is a subprogram nested within such a subprogram. Holds
4554-- the index in the Exp_Unst.Subps table for the subprogram. Note that
4555-- for the outer level subprogram, this is the starting index in the Subp
4556-- table for the entries for this subprogram.
3830827c 4557
967947ed
PMR
4558-- Suppress_Elaboration_Warnings (Flag303)
4559-- NOTE: this flag is relevant only for the legacy ABE mechanism and
4560-- should not be used outside of that context.
4561--
4562-- Defined in all entities, can be set only for subprogram entities and
4563-- for variables. If this flag is set then Sem_Elab will not generate
4564-- elaboration warnings for the subprogram or variable. Suppression of
4565-- such warnings is automatic for subprograms for which elaboration
4566-- checks are suppressed (without the need to set this flag), but the
4567-- flag is also set for various internal entities (such as init procs)
4568-- which are known not to generate any possible access before elaboration
4569-- and it is set on variables when a warning is given to avoid multiple
4570-- elaboration warnings for the same variable.
4571
5b1e6aca 4572-- Suppress_Initialization (Flag105)
99425ec3
AC
4573-- Defined in all variable, type and subtype entities. If set for a base
4574-- type, then the generation of initialization procedures is suppressed
6cc85504 4575-- for the type. Any other implicit initialization (e.g. from the use of
99425ec3
AC
4576-- pragma Initialize_Scalars) is also suppressed if this flag is set for
4577-- either the subtype in question, or for the base type. For variables,
4578-- this flag suppresses all implicit initialization for the object, even
4579-- if the type would normally require initialization. Set by use of
4580-- pragma Suppress_Initialization and also for internal entities where
4581-- we know that no initialization is required. For example, enumeration
4582-- image table entities set it.
70482933 4583
70482933 4584-- Suppress_Style_Checks (Flag165)
30ebb114 4585-- Defined in all entities. Suppresses any style checks specifically
70482933
RK
4586-- associated with the given entity if set.
4587
0a36105d 4588-- Suppress_Value_Tracking_On_Call (Flag217)
30ebb114 4589-- Defined in all entities. Set in a scope entity if value tracking is to
0a36105d
JM
4590-- be suppressed on any call within the scope. Used when an access to a
4591-- local subprogram is computed, to deal with the possibility that this
4592-- value may be passed around, and if used, may clobber a local variable.
4593
6e443c90 4594-- Task_Body_Procedure (Node25)
30ebb114 4595-- Defined in task types and subtypes. Points to the entity for the task
cf49bd32
TQ
4596-- task body procedure (as further described in Exp_Ch9, task bodies are
4597-- expanded into procedures). A convenient function to retrieve this
4598-- field is Sem_Util.Get_Task_Body_Procedure.
4599--
4600-- The last sentence is odd??? Why not have Task_Body_Procedure go to the
4601-- Underlying_Type of the Root_Type???
a9d8907c 4602
59fad002
AC
4603-- Thunk_Entity (Node31)
4604-- Defined in functions and procedures which have been classified as
4605-- Is_Thunk. Set to the target entity called by the thunk.
4606
fbf5a39b 4607-- Treat_As_Volatile (Flag41)
30ebb114 4608-- Defined in all type entities, and also in constants, components and
fbf5a39b
AC
4609-- variables. Set if this entity is to be treated as volatile for code
4610-- generation purposes. Always set if Is_Volatile is set, but can also
4611-- be set as a result of situations (such as address overlays) where
4612-- the front end wishes to force volatile handling to inhibit aliasing
4613-- optimization which might be legally ok, but is undesirable. Note
28bc3323 4614-- that the backend always tests this flag rather than Is_Volatile.
fbf5a39b
AC
4615-- The front end tests Is_Volatile if it is concerned with legality
4616-- checks associated with declared volatile variables, but if the test
4617-- is for the purposes of suppressing optimizations, then the front
4618-- end should test Treat_As_Volatile rather than Is_Volatile.
21d27997
RD
4619--
4620-- Note: before testing Treat_As_Volatile, consider whether it would
4621-- be more appropriate to use Exp_Util.Is_Volatile_Reference instead,
4622-- which catches more cases of volatile references.
fbf5a39b 4623
70482933 4624-- Type_High_Bound (synthesized)
6e443c90
RD
4625-- Applies to scalar types. Returns the tree node (Node_Id) that contains
4626-- the high bound of a scalar type. The returned value is literal for a
4627-- base type, but may be an expression in the case of scalar type with
84c54629 4628-- dynamic bounds.
70482933
RK
4629
4630-- Type_Low_Bound (synthesized)
6e443c90
RD
4631-- Applies to scalar types. Returns the tree node (Node_Id) that contains
4632-- the low bound of a scalar type. The returned value is literal for a
4633-- base type, but may be an expression in the case of scalar type with
84c54629 4634-- dynamic bounds.
70482933
RK
4635
4636-- Underlying_Full_View (Node19)
30ebb114 4637-- Defined in private subtypes that are the completion of other private
6e443c90
RD
4638-- types, or in private types that are derived from private subtypes. If
4639-- the full view of a private type T is derived from another private type
4640-- with discriminants Td, the full view of T is also private, and there
4641-- is no way to attach to it a further full view that would convey the
5e9d6f05 4642-- structure of T to the backend. The Underlying_Full_View is an
6e443c90
RD
4643-- attribute of the full view that is a subtype of Td with the same
4644-- constraint as the declaration for T. The declaration for this subtype
4645-- is built at the point of the declaration of T, either as completion,
4646-- or as a subtype declaration where the base type is private and has a
4647-- private completion. If Td is already constrained, then its full view
4648-- can serve directly as the full view of T.
70482933 4649
cf49bd32 4650-- Underlying_Record_View (Node28)
30ebb114 4651-- Defined in record types. Set for record types that are extensions of
9013065b
AC
4652-- types with unknown discriminants, and also set for internally built
4653-- underlying record views to reference its original record type. Record
4654-- types that are extensions of types with unknown discriminants do not
4655-- have a completion, but they cannot be used without having some
4656-- discriminated view at hand. This view is a record type with the same
4657-- structure, whose parent type is the full view of the parent in the
4658-- original type extension.
39f346aa 4659
70482933 4660-- Underlying_Type (synthesized)
6e443c90
RD
4661-- Applies to all entities. This is the identity function except in the
4662-- case where it is applied to an incomplete or private type, in which
4663-- case it is the underlying type of the type declared by the completion,
4664-- or Empty if the completion has not yet been encountered and analyzed.
70482933 4665--
6e443c90
RD
4666-- Note: the reason this attribute applies to all entities, and not just
4667-- types, is to legitimize code where Underlying_Type is applied to an
4668-- entity which may or may not be a type, with the intent that if it is a
4669-- type, its underlying type is taken.
aa611332
AC
4670--
4671-- Note also that the value of this attribute is interesting only after
4672-- the full view of the parent type has been processed. If the parent
4673-- type is declared in an enclosing package, the attribute will be non-
4674-- trivial only after the full view of the type has been analyzed.
70482933 4675
02e4edea 4676-- Universal_Aliasing (Flag216) [implementation base type only]
30ebb114 4677-- Defined in all type entities. Set to direct the back-end to avoid
0a36105d
JM
4678-- any optimizations based on type-based alias analysis for this type.
4679-- Indicates that objects of this type can alias objects of any other
4680-- types, which guarantees that any objects can be referenced through
4681-- access types designating this type safely, whatever the actual type
4682-- of these objects. In other words, the effect is as though access
4683-- types designating this type were subject to No_Strict_Aliasing.
4684
70482933 4685-- Unset_Reference (Node16)
30ebb114 4686-- Defined in variables and out parameters. This is normally Empty. It
6e443c90
RD
4687-- is set to point to an identifier that represents a reference to the
4688-- entity before any value has been set. Only the first such reference
4689-- is identified. This field is used to generate a warning message if
4690-- necessary (see Sem_Warn.Check_Unset_Reference).
70482933 4691
5d37ba92 4692-- Used_As_Generic_Actual (Flag222)
30ebb114 4693-- Defined in all entities, set if the entity is used as an argument to
5b85ad7d
PMR
4694-- a generic instantiation. Used to tune certain warning messages, and
4695-- in checking type conformance within an instantiation that involves
4696-- incomplete formal and actual types.
5d37ba92 4697
88e7531b 4698-- Uses_Lock_Free (Flag188)
30ebb114 4699-- Defined in protected type entities. Set to True when the Lock Free
8489c295 4700-- implementation is used for the protected type. This implementation is
88e7531b
AC
4701-- based on atomic transactions and doesn't require anymore the use of
4702-- Protection object (see System.Tasking.Protected_Objects).
4703
70482933 4704-- Uses_Sec_Stack (Flag95)
f32eb591
AC
4705-- Defined in scope entities (blocks, entries, entry families, functions,
4706-- loops, and procedures). Set to True when the secondary stack is used
4707-- in this scope and must be released on exit unless flag
4708-- Sec_Stack_Needed_For_Return is set.
70482933 4709
3f6d1daa 4710-- Validated_Object (Node38)
89b6c83e
AC
4711-- Defined in variables. Contains the object whose value is captured by
4712-- the variable for validity check purposes.
4713
70482933 4714-- Warnings_Off (Flag96)
30ebb114 4715-- Defined in all entities. Set if a pragma Warnings (Off, entity-name)
70482933 4716-- is used to suppress warnings for a given entity. It is also used by
0f282086
RD
4717-- the compiler in some situations to kill spurious warnings. Note that
4718-- clients should generally not test this flag directly, but instead
4719-- use function Has_Warnings_Off.
4720
4721-- Warnings_Off_Used (Flag236)
30ebb114 4722-- Defined in all entities. Can only be set if Warnings_Off is set. If
0f282086
RD
4723-- set indicates that a warning was suppressed by the Warnings_Off flag,
4724-- and Unmodified/Unreferenced would not have suppressed the warning.
4725
4726-- Warnings_Off_Used_Unmodified (Flag237)
30ebb114 4727-- Defined in all entities. Can only be set if Warnings_Off is set and
0f282086
RD
4728-- Has_Pragma_Unmodified is not set. If set indicates that a warning was
4729-- suppressed by the Warnings_Off status but that pragma Unmodified
4730-- would also have suppressed the warning.
4731
4732-- Warnings_Off_Used_Unreferenced (Flag238)
30ebb114 4733-- Defined in all entities. Can only be set if Warnings_Off is set and
0f282086
RD
4734-- Has_Pragma_Unreferenced is not set. If set indicates that a warning
4735-- was suppressed by the Warnings_Off status but that pragma Unreferenced
4736-- would also have suppressed the warning.
70482933 4737
10b93b2e 4738-- Was_Hidden (Flag196)
30ebb114 4739-- Defined in all entities. Used to save the value of the Is_Hidden
10b93b2e
HK
4740-- attribute when the limited-view is installed (Ada 2005: AI-217).
4741
4742-- Wrapped_Entity (Node27)
30ebb114 4743-- Defined in functions and procedures which have been classified as
df3e68b1
HK
4744-- Is_Primitive_Wrapper. Set to the entity being wrapper.
4745
149604e4 4746---------------------------
2735b82d 4747-- Renaming and Aliasing --
149604e4
RD
4748---------------------------
4749
76f9c7f4
BD
4750-- ???The following comments are not quite right; see Einfo.Utils.
4751
2735b82d
AC
4752-- Several entity attributes relate to renaming constructs, and to the use of
4753-- different names to refer to the same entity. The following is a summary of
149604e4
RD
4754-- these constructs and their prefered uses.
4755
4756-- There are three related attributes:
2735b82d
AC
4757
4758-- Renamed_Entity
4759-- Renamed_Object
4760-- Alias
4761
149604e4 4762-- They all overlap because they are supposed to apply to different entity
2735b82d
AC
4763-- kinds. They are semantically related, and have the following intended uses:
4764
c27a8bce 4765-- a) Renamed_Entity applies to entities in renaming declarations that rename
149604e4
RD
4766-- an entity, so the value of the attribute IS an entity. This applies to
4767-- generic renamings, package renamings, exception renamings, and subprograms
4768-- renamings that rename a subprogram (rather than an attribute, an entry, a
4769-- protected operation, etc).
2735b82d 4770
149604e4 4771-- b) Alias applies to overloadable entities, and the value is an overloadable
31ae1b46 4772-- entity. So this is a subset of the previous one. We use the term Alias to
149604e4 4773-- cover both renamings and inherited operations, because both cases are
31ae1b46 4774-- handled in the same way when expanding a call. Namely the Alias of a given
149604e4
RD
4775-- subprogram is the subprogram that will actually be called.
4776
4777-- Both a) and b) are set transitively, so that in fact it is not necessary to
4778-- traverse chains of renamings when looking for the original entity: it's
4779-- there in one step (this is done when analyzing renaming declarations other
4780-- than object renamings in sem_ch8).
4781
4782-- c) Renamed_Object applies to constants and variables. Given that the name
4783-- in an object renaming declaration is not necessarily an entity name, the
4784-- value of the attribute is the tree for that name, eg AR (1).Comp. The case
4785-- when that name is in fact an entity is not handled specially. This is why
4786-- in a few cases we need to use a loop to trace a chain of object renamings
4787-- where all of them happen to be entities. So:
4788
4789-- X : integer;
4790-- Y : integer renames X; -- renamed object is the identifier X
4791-- Z : integer renames Y; -- renamed object is the identifier Y
4792
4793-- The front-end does not store explicitly the fact that Z renames X.
4794
df3e68b1
HK
4795--------------------------------------
4796-- Delayed Freezing and Elaboration --
4797--------------------------------------
4798
4799-- The flag Has_Delayed_Freeze indicates that an entity carries an explicit
4800-- freeze node, which appears later in the expanded tree.
4801
be035558 4802-- a) The flag is used by the front-end to trigger expansion actions
df3e68b1
HK
4803-- which include the generation of that freeze node. Typically this happens at
4804-- the end of the current compilation unit, or before the first subprogram
4805-- body is encountered in the current unit. See files freeze and exp_ch13 for
4806-- details on the actions triggered by a freeze node, which include the
4807-- construction of initialization procedures and dispatch tables.
4808
4809-- b) The flag is used by the backend to defer elaboration of the entity until
be035558 4810-- its freeze node is seen. In the absence of an explicit freeze node, an
df3e68b1
HK
4811-- entity is frozen (and elaborated) at the point of declaration.
4812
4813-- For object declarations, the flag is set when an address clause for the
4814-- object is encountered. Legality checks on the address expression only
4815-- take place at the freeze point of the object.
4816
4817-- Most types have an explicit freeze node, because they cannot be elaborated
4818-- until all representation and operational items that apply to them have been
4819-- analyzed. Private types and incomplete types have the flag set as well, as
4820-- do task and protected types.
4821
4822-- Implicit base types created for type derivations, as well as classwide
4823-- types created for all tagged types, have the flag set.
4824
4825-- If a subprogram has an access parameter whose designated type is incomplete
4826-- the subprogram has the flag set.
10b93b2e 4827
2735b82d
AC
4828------------------
4829-- Access Kinds --
4830------------------
4831
4832-- The following entity kinds are introduced by the corresponding type
4833-- definitions:
4834
4835-- E_Access_Type,
4836-- E_General_Access_Type,
4837-- E_Access_Subprogram_Type,
4838-- E_Anonymous_Access_Subprogram_Type,
4839-- E_Access_Protected_Subprogram_Type,
4840-- E_Anonymous_Access_Protected_Subprogram_Type
4841-- E_Anonymous_Access_Type.
4842
4843-- E_Access_Subtype is for an access subtype created by a subtype
4844-- declaration.
4845
4846-- In addition, we define the kind E_Allocator_Type to label allocators.
4847-- This is because special resolution rules apply to this construct.
4848-- Eventually the constructs are labeled with the access type imposed by
28bc3323 4849-- the context. The backend should never see types with this Ekind.
2735b82d
AC
4850
4851-- Similarly, the type E_Access_Attribute_Type is used as the initial kind
4852-- associated with an access attribute. After resolution a specific access
4853-- type will be established as determined by the context.
4854
4855-- Finally, the type Any_Access is used to label -null- during type
4856-- resolution. Any_Access is also replaced by the context type after
4857-- resolution.
4858
4859--------------------------------
4860-- Classification of Entities --
4861--------------------------------
76f9c7f4 4862-- ????Some comments here should be retrieved
70482933
RK
4863
4864 --------------------------------------------------------
4865 -- Description of Defined Attributes for Entity_Kinds --
4866 --------------------------------------------------------
4867
4868 -- For each enumeration value defined in Entity_Kind we list all the
4869 -- attributes defined in Einfo which can legally be applied to an entity
4870 -- of that kind. The implementation of the attribute functions (and for
e14c931f 4871 -- non-synthesized attributes, of the corresponding set procedures) are
70482933
RK
4872 -- in the Einfo body.
4873
4b342b91 4874 -- The following attributes are defined in all entities
70482933 4875
f937473f
RD
4876 -- Ekind (Ekind)
4877
4878 -- Chars (Name1)
4879 -- Next_Entity (Node2)
4880 -- Scope (Node3)
4881 -- Homonym (Node4)
4882 -- Etype (Node5)
4883 -- First_Rep_Item (Node6)
4884 -- Freeze_Node (Node7)
3f6d1daa 4885 -- Prev_Entity (Node36)
caf07df9 4886 -- Associated_Entity (Node37)
f937473f
RD
4887
4888 -- Address_Taken (Flag104)
4889 -- Can_Never_Be_Null (Flag38)
4890 -- Checks_May_Be_Suppressed (Flag31)
4891 -- Debug_Info_Off (Flag166)
f937473f 4892 -- Has_Convention_Pragma (Flag119)
c159409f 4893 -- Has_Delayed_Aspects (Flag200)
f937473f
RD
4894 -- Has_Delayed_Freeze (Flag18)
4895 -- Has_Fully_Qualified_Name (Flag173)
4896 -- Has_Gigi_Rep_Item (Flag82)
4897 -- Has_Homonym (Flag56)
f937473f
RD
4898 -- Has_Pragma_Elaborate_Body (Flag150)
4899 -- Has_Pragma_Inline (Flag157)
ce0bead3 4900 -- Has_Pragma_Inline_Always (Flag230)
42ae3870 4901 -- Has_Pragma_No_Inline (Flag201)
f937473f
RD
4902 -- Has_Pragma_Pure (Flag203)
4903 -- Has_Pragma_Pure_Function (Flag179)
4c8a5bb8 4904 -- Has_Pragma_Thread_Local_Storage (Flag169)
9d77af56 4905 -- Has_Pragma_Unmodified (Flag233)
f937473f 4906 -- Has_Pragma_Unreferenced (Flag180)
9d1d00ca 4907 -- Has_Pragma_Unused (Flag294)
f937473f
RD
4908 -- Has_Private_Declaration (Flag155)
4909 -- Has_Qualified_Name (Flag161)
fdce4bb7 4910 -- Has_Stream_Size_Clause (Flag184)
f937473f
RD
4911 -- Has_Unknown_Discriminants (Flag72)
4912 -- Has_Xref_Entry (Flag182)
fdce4bb7 4913 -- In_Private_Part (Flag45)
f937473f 4914 -- Is_Ada_2005_Only (Flag185)
599a7411 4915 -- Is_Ada_2012_Only (Flag199)
f937473f 4916 -- Is_Bit_Packed_Array (Flag122) (base type only)
fecbd779 4917 -- Is_Aliased (Flag15)
fdce4bb7 4918 -- Is_Character_Type (Flag63)
c5cec2fe 4919 -- Is_Checked_Ghost_Entity (Flag277)
f937473f
RD
4920 -- Is_Child_Unit (Flag73)
4921 -- Is_Compilation_Unit (Flag149)
d9d25d04 4922 -- Is_Descendant_Of_Address (Flag223)
f937473f 4923 -- Is_Discrim_SO_Function (Flag176)
e2ef0ff6 4924 -- Is_Discriminant_Check_Function (Flag264)
21d27997 4925 -- Is_Dispatch_Table_Entity (Flag234)
f937473f 4926 -- Is_Dispatching_Operation (Flag6)
fdce4bb7 4927 -- Is_Entry_Formal (Flag52)
f937473f
RD
4928 -- Is_Exported (Flag99)
4929 -- Is_First_Subtype (Flag70)
4930 -- Is_Formal_Subprogram (Flag111)
4931 -- Is_Generic_Instance (Flag130)
93c3fca7 4932 -- Is_Generic_Type (Flag13)
f937473f
RD
4933 -- Is_Hidden (Flag57)
4934 -- Is_Hidden_Open_Scope (Flag171)
c5cec2fe 4935 -- Is_Ignored_Ghost_Entity (Flag278)
f937473f 4936 -- Is_Immediately_Visible (Flag7)
df177175 4937 -- Is_Implementation_Defined (Flag254)
f937473f
RD
4938 -- Is_Imported (Flag24)
4939 -- Is_Inlined (Flag11)
4940 -- Is_Internal (Flag17)
4941 -- Is_Itype (Flag91)
4942 -- Is_Known_Non_Null (Flag37)
4943 -- Is_Known_Null (Flag204)
4944 -- Is_Known_Valid (Flag170)
4945 -- Is_Limited_Composite (Flag106)
4946 -- Is_Limited_Record (Flag25)
5a0c86bd 4947 -- Is_Loop_Parameter (Flag307)
f937473f
RD
4948 -- Is_Obsolescent (Flag153)
4949 -- Is_Package_Body_Entity (Flag160)
8ca597af 4950 -- Is_Packed_Array_Impl_Type (Flag138)
f937473f
RD
4951 -- Is_Potentially_Use_Visible (Flag9)
4952 -- Is_Preelaborated (Flag59)
4953 -- Is_Primitive_Wrapper (Flag195)
4954 -- Is_Public (Flag10)
4955 -- Is_Pure (Flag44)
4956 -- Is_Remote_Call_Interface (Flag62)
4957 -- Is_Remote_Types (Flag61)
fdce4bb7 4958 -- Is_Renaming_Of_Object (Flag112)
f937473f
RD
4959 -- Is_Shared_Passive (Flag60)
4960 -- Is_Statically_Allocated (Flag28)
f8dae9bb 4961 -- Is_Static_Type (Flag281)
fdce4bb7 4962 -- Is_Tagged_Type (Flag55)
4b342b91 4963 -- Is_Thunk (Flag225)
0f282086 4964 -- Is_Trivial_Subprogram (Flag235)
f937473f 4965 -- Is_Unchecked_Union (Flag117)
d3ef4bd6 4966 -- Is_Unimplemented (Flag284)
f937473f 4967 -- Is_Visible_Formal (Flag206)
f937473f
RD
4968 -- Kill_Elaboration_Checks (Flag32)
4969 -- Kill_Range_Checks (Flag33)
fad0600d 4970 -- Low_Bound_Tested (Flag205)
f937473f
RD
4971 -- Materialize_Entity (Flag168)
4972 -- Needs_Debug_Info (Flag147)
fdce4bb7 4973 -- Never_Set_In_Source (Flag115)
f937473f 4974 -- No_Return (Flag113)
21d27997 4975 -- Overlays_Constant (Flag243)
f937473f
RD
4976 -- Referenced (Flag156)
4977 -- Referenced_As_LHS (Flag36)
ce0bead3 4978 -- Referenced_As_Out_Parameter (Flag227)
967947ed 4979 -- Suppress_Elaboration_Warnings (Flag303)
f937473f 4980 -- Suppress_Style_Checks (Flag165)
0a36105d 4981 -- Suppress_Value_Tracking_On_Call (Flag217)
5d37ba92 4982 -- Used_As_Generic_Actual (Flag222)
fdce4bb7 4983 -- Warnings_Off (Flag96)
0f282086
RD
4984 -- Warnings_Off_Used (Flag236)
4985 -- Warnings_Off_Used_Unmodified (Flag237)
4986 -- Warnings_Off_Used_Unreferenced (Flag238)
f937473f
RD
4987 -- Was_Hidden (Flag196)
4988
4989 -- Declaration_Node (synth)
f937473f 4990 -- Has_Foreign_Convention (synth)
f937473f 4991 -- Is_Dynamic_Scope (synth)
95fef24f 4992 -- Is_Ghost_Entity (synth)
21d27997 4993 -- Is_Standard_Character_Type (synth)
bc3c2eca 4994 -- Is_Standard_String_Type (synth)
f937473f
RD
4995 -- Underlying_Type (synth)
4996 -- all classification attributes (synth)
70482933
RK
4997
4998 -- The following list of access functions applies to all entities for
4999 -- types and subtypes. References to this list appear subsequently as
86ec3bfb 5000 -- "(plus type attributes)" for each appropriate Entity_Kind.
70482933 5001
f937473f
RD
5002 -- Associated_Node_For_Itype (Node8)
5003 -- Class_Wide_Type (Node9)
f937473f
RD
5004 -- Full_View (Node11)
5005 -- Esize (Uint12)
5006 -- RM_Size (Uint13)
5007 -- Alignment (Uint14)
760804f3 5008 -- Pending_Access_Types (Elist15)
cf49bd32 5009 -- Related_Expression (Node24)
6c946a9f 5010 -- Current_Use_Clause (Node27)
3ddfabe3 5011 -- Subprograms_For_Type (Elist29)
ab01e614 5012 -- Derived_Type_Link (Node31)
49d41397 5013 -- No_Tagged_Streams_Pragma (Node32)
19992053 5014 -- Linker_Section_Pragma (Node33)
8dce7371 5015 -- SPARK_Pragma (Node40)
f937473f
RD
5016
5017 -- Depends_On_Private (Flag14)
c8593453 5018 -- Disable_Controlled (Flag253)
f937473f
RD
5019 -- Discard_Names (Flag88)
5020 -- Finalize_Storage_Only (Flag158) (base type only)
7b56a91b 5021 -- From_Limited_With (Flag159)
f937473f
RD
5022 -- Has_Aliased_Components (Flag135) (base type only)
5023 -- Has_Alignment_Clause (Flag46)
5024 -- Has_Atomic_Components (Flag86) (base type only)
5025 -- Has_Completion_In_Body (Flag71)
5026 -- Has_Complex_Representation (Flag140) (base type only)
5027 -- Has_Constrained_Partial_View (Flag187)
a01b9df6
AC
5028 -- Has_Controlled_Component (Flag43) (base type only)
5029 -- Has_Default_Aspect (Flag39) (base type only)
15e934bf 5030 -- Has_Delayed_Rep_Aspects (Flag261)
f937473f 5031 -- Has_Discriminants (Flag5)
aab45d22 5032 -- Has_Dynamic_Predicate_Aspect (Flag258)
ca1ffed0 5033 -- Has_Independent_Components (Flag34) (base type only)
3ddfabe3 5034 -- Has_Inheritable_Invariants (Flag248) (base type only)
f63d601b 5035 -- Has_Inherited_DIC (Flag133) (base type only)
3ddfabe3 5036 -- Has_Inherited_Invariants (Flag291) (base type only)
f937473f
RD
5037 -- Has_Non_Standard_Rep (Flag75) (base type only)
5038 -- Has_Object_Size_Clause (Flag172)
f63d601b 5039 -- Has_Own_DIC (Flag3) (base type only)
3ddfabe3 5040 -- Has_Own_Invariants (Flag232) (base type only)
5d37ba92 5041 -- Has_Pragma_Preelab_Init (Flag221)
f937473f 5042 -- Has_Pragma_Unreferenced_Objects (Flag212)
fc142f63 5043 -- Has_Predicates (Flag250)
f937473f 5044 -- Has_Primitive_Operations (Flag120) (base type only)
96e90ac1 5045 -- Has_Protected (Flag271) (base type only)
f937473f
RD
5046 -- Has_Size_Clause (Flag29)
5047 -- Has_Specified_Layout (Flag100) (base type only)
5048 -- Has_Specified_Stream_Input (Flag190)
5049 -- Has_Specified_Stream_Output (Flag191)
5050 -- Has_Specified_Stream_Read (Flag192)
5051 -- Has_Specified_Stream_Write (Flag193)
ee4eee0a 5052 -- Has_Static_Predicate (Flag269)
aab45d22 5053 -- Has_Static_Predicate_Aspect (Flag259)
f937473f 5054 -- Has_Task (Flag30) (base type only)
4969efdf 5055 -- Has_Timing_Event (Flag289) (base type only)
f937473f
RD
5056 -- Has_Unchecked_Union (Flag123) (base type only)
5057 -- Has_Volatile_Components (Flag87) (base type only)
5058 -- In_Use (Flag8)
5059 -- Is_Abstract_Type (Flag146)
5060 -- Is_Asynchronous (Flag81)
5061 -- Is_Atomic (Flag85)
5062 -- Is_Constr_Subt_For_U_Nominal (Flag80)
5063 -- Is_Constr_Subt_For_UN_Aliased (Flag141)
0cb81445 5064 -- Is_Controlled_Active (Flag42) (base type only)
f937473f
RD
5065 -- Is_Eliminated (Flag124)
5066 -- Is_Frozen (Flag4)
5067 -- Is_Generic_Actual_Type (Flag94)
8a52daee 5068 -- Is_Independent (Flag268)
f937473f
RD
5069 -- Is_Non_Static_Subtype (Flag109)
5070 -- Is_Packed (Flag51) (base type only)
5071 -- Is_Private_Composite (Flag107)
c8d3b4ff 5072 -- Is_RACW_Stub_Type (Flag244)
f937473f
RD
5073 -- Is_Unsigned_Type (Flag144)
5074 -- Is_Volatile (Flag16)
57abdadd 5075 -- Is_Volatile_Full_Access (Flag285)
f937473f
RD
5076 -- Itype_Printed (Flag202) (itypes only)
5077 -- Known_To_Have_Preelab_Init (Flag207)
15e934bf 5078 -- May_Inherit_Delayed_Rep_Aspects (Flag262)
f937473f
RD
5079 -- Must_Be_On_Byte_Boundary (Flag183)
5080 -- Must_Have_Preelab_Init (Flag208)
21d27997
RD
5081 -- Optimize_Alignment_Space (Flag241)
5082 -- Optimize_Alignment_Time (Flag242)
07a64c02 5083 -- Partial_View_Has_Unknown_Discr (Flag280)
f937473f
RD
5084 -- Size_Depends_On_Discriminant (Flag177)
5085 -- Size_Known_At_Compile_Time (Flag92)
8dce7371 5086 -- SPARK_Pragma_Inherited (Flag265)
f937473f 5087 -- Strict_Alignment (Flag145) (base type only)
5b1e6aca 5088 -- Suppress_Initialization (Flag105)
f937473f 5089 -- Treat_As_Volatile (Flag41)
02e4edea 5090 -- Universal_Aliasing (Flag216) (impl base type only)
f937473f
RD
5091
5092 -- Alignment_Clause (synth)
f937473f 5093 -- Base_Type (synth)
f63d601b
HK
5094 -- DIC_Procedure (synth)
5095 -- Has_DIC (synth)
3ddfabe3 5096 -- Has_Invariants (synth)
f937473f 5097 -- Implementation_Base_Type (synth)
fd0ff1cf 5098 -- Invariant_Procedure (synth)
f937473f 5099 -- Is_Access_Protected_Subprogram_Type (synth)
b120ca61 5100 -- Is_Full_Access (synth)
0cb81445 5101 -- Is_Controlled (synth)
42e4b796 5102 -- Object_Size_Clause (synth)
f7937111 5103 -- Partial_DIC_Procedure (synth)
3ddfabe3 5104 -- Partial_Invariant_Procedure (synth)
4818e7b9 5105 -- Predicate_Function (synth)
fc142f63 5106 -- Predicate_Function_M (synth)
f937473f
RD
5107 -- Root_Type (synth)
5108 -- Size_Clause (synth)
70482933
RK
5109
5110 ------------------------------------------
5111 -- Applicable attributes by entity kind --
5112 ------------------------------------------
5113
76f9c7f4
BD
5114 -- In the conversion to variable-sized nodes and entities, which is an
5115 -- ongoing project, a number of discrepancies were noticed. At least some
5116 -- of these should be investigated at some point. They are documented in
5117 -- comments, and marked with "$$$???".
5118
cf6956bb 5119 -- E_Abstract_State
ab8843fa 5120 -- Refinement_Constituents (Elist8)
75b87c16 5121 -- Part_Of_Constituents (Elist10)
8a7c0400 5122 -- Body_References (Elist16)
47346923 5123 -- Non_Limited_View (Node19)
caf07df9 5124 -- Encapsulating_State (Node32)
8dce7371 5125 -- SPARK_Pragma (Node40)
dc726757 5126 -- From_Limited_With (Flag159)
d89ce432 5127 -- Has_Partial_Visible_Refinement (Flag296)
c5c0ce68 5128 -- Has_Visible_Refinement (Flag263)
8dce7371 5129 -- SPARK_Pragma_Inherited (Flag265)
76f9c7f4 5130 -- First_Entity $$$???
47346923 5131 -- Has_Non_Limited_View (synth)
2f54ef3d
AC
5132 -- Has_Non_Null_Visible_Refinement (synth)
5133 -- Has_Null_Visible_Refinement (synth)
aa500b7a 5134 -- Is_External_State (synth)
cf6956bb 5135 -- Is_Null_State (synth)
e577151d 5136 -- Is_Relaxed_Initialization_State (synth)
75b87c16 5137 -- Is_Synchronized_State (synth)
d89ce432 5138 -- Partial_Refinement_Constituents (synth)
cf6956bb 5139
70482933 5140 -- E_Access_Protected_Subprogram_Type
f937473f
RD
5141 -- Equivalent_Type (Node18)
5142 -- Directly_Designated_Type (Node20)
f937473f 5143 -- Needs_No_Actuals (Flag22)
ce0bead3 5144 -- Can_Use_Internal_Rep (Flag229)
21d27997 5145 -- (plus type attributes)
70482933
RK
5146
5147 -- E_Access_Subprogram_Type
f937473f
RD
5148 -- Equivalent_Type (Node18) (remote types only)
5149 -- Directly_Designated_Type (Node20)
f937473f 5150 -- Needs_No_Actuals (Flag22)
760804f3 5151 -- Original_Access_Type (Node28)
ce0bead3 5152 -- Can_Use_Internal_Rep (Flag229)
c84205cd 5153 -- Needs_Activation_Record (Flag306)
76f9c7f4
BD
5154 -- Associated_Storage_Pool $$$???
5155 -- Interface_Name $$$???
21d27997 5156 -- (plus type attributes)
70482933
RK
5157
5158 -- E_Access_Type
5159 -- E_Access_Subtype
76f9c7f4 5160 -- Direct_Primitive_Operations $$$??? type
f937473f
RD
5161 -- Master_Id (Node17)
5162 -- Directly_Designated_Type (Node20)
df3e68b1 5163 -- Associated_Storage_Pool (Node22) (base type only)
d3f70b35 5164 -- Finalization_Master (Node23) (base type only)
760804f3 5165 -- Storage_Size_Variable (Node26) (base type only)
f937473f
RD
5166 -- Has_Pragma_Controlled (Flag27) (base type only)
5167 -- Has_Storage_Size_Clause (Flag23) (base type only)
f937473f 5168 -- Is_Access_Constant (Flag69)
ce0bead3 5169 -- Is_Local_Anonymous_Access (Flag194)
f937473f
RD
5170 -- Is_Pure_Unit_Access_Type (Flag189)
5171 -- No_Pool_Assigned (Flag131) (base type only)
5172 -- No_Strict_Aliasing (Flag136) (base type only)
b54d1d39 5173 -- Is_Param_Block_Component_Type (Flag215) (base type only)
70482933
RK
5174 -- (plus type attributes)
5175
5176 -- E_Access_Attribute_Type
76f9c7f4 5177 -- Renamed_Entity $$$???
f937473f 5178 -- Directly_Designated_Type (Node20)
70482933
RK
5179 -- (plus type attributes)
5180
5181 -- E_Allocator_Type
f937473f 5182 -- Directly_Designated_Type (Node20)
76f9c7f4 5183 -- Associated_Storage_Pool $$$???
70482933
RK
5184 -- (plus type attributes)
5185
af4b9434
AC
5186 -- E_Anonymous_Access_Subprogram_Type
5187 -- E_Anonymous_Access_Protected_Subprogram_Type
76f9c7f4 5188 -- Interface_Name $$$??? E_Anonymous_Access_Subprogram_Type
ce0bead3 5189 -- Directly_Designated_Type (Node20)
760804f3 5190 -- Storage_Size_Variable (Node26) ??? is this needed ???
ce0bead3 5191 -- Can_Use_Internal_Rep (Flag229)
c84205cd 5192 -- Needs_Activation_Record (Flag306)
ce0bead3
HK
5193 -- (plus type attributes)
5194
70482933 5195 -- E_Anonymous_Access_Type
f937473f 5196 -- Directly_Designated_Type (Node20)
d3f70b35 5197 -- Finalization_Master (Node23)
760804f3 5198 -- Storage_Size_Variable (Node26) ??? is this needed ???
76f9c7f4 5199 -- Associated_Storage_Pool $$$???
70482933
RK
5200 -- (plus type attributes)
5201
5202 -- E_Array_Type
5203 -- E_Array_Subtype
76f9c7f4
BD
5204 -- First_Entity $$$???
5205 -- Direct_Primitive_Operations $$$??? subtype
5206 -- Renamed_Object $$$??? E_Array_Subtype
f937473f 5207 -- First_Index (Node17)
688a9b51 5208 -- Default_Aspect_Component_Value (Node19) (base type only)
f937473f
RD
5209 -- Component_Type (Node20) (base type only)
5210 -- Original_Array_Type (Node21)
5211 -- Component_Size (Uint22) (base type only)
8ca597af 5212 -- Packed_Array_Impl_Type (Node23)
6d9e03cb 5213 -- Related_Array_Object (Node25)
3f6d1daa 5214 -- Predicated_Parent (Node38) (subtype only)
f937473f
RD
5215 -- Component_Alignment (special) (base type only)
5216 -- Has_Component_Size_Clause (Flag68) (base type only)
a01b9df6 5217 -- Has_Pragma_Pack (Flag121) (impl base type only)
f937473f 5218 -- Is_Constrained (Flag12)
22a83cea 5219 -- Reverse_Storage_Order (Flag93) (base type only)
220d1fd9
AC
5220 -- SSO_Set_High_By_Default (Flag273) (base type only)
5221 -- SSO_Set_Low_By_Default (Flag272) (base type only)
f937473f
RD
5222 -- Next_Index (synth)
5223 -- Number_Dimensions (synth)
fdce4bb7 5224 -- (plus type attributes)
70482933
RK
5225
5226 -- E_Block
76f9c7f4
BD
5227 -- Renamed_Entity $$$???
5228 -- Renamed_Object $$$???
c5a913d3 5229 -- Return_Applies_To (Node8)
f937473f
RD
5230 -- Block_Node (Node11)
5231 -- First_Entity (Node17)
5232 -- Last_Entity (Node20)
f937473f
RD
5233 -- Scope_Depth_Value (Uint22)
5234 -- Entry_Cancel_Parameter (Node23)
8636f52f 5235 -- Contains_Ignored_Ghost_Code (Flag279)
f937473f
RD
5236 -- Delay_Cleanups (Flag114)
5237 -- Discard_Names (Flag88)
5238 -- Has_Master_Entity (Flag21)
5239 -- Has_Nested_Block_With_Handler (Flag101)
75a957f5 5240 -- Is_Exception_Handler (Flag286)
f937473f
RD
5241 -- Sec_Stack_Needed_For_Return (Flag167)
5242 -- Uses_Sec_Stack (Flag95)
5243 -- Scope_Depth (synth)
70482933
RK
5244
5245 -- E_Class_Wide_Type
5246 -- E_Class_Wide_Subtype
46202729 5247 -- Direct_Primitive_Operations (Elist10)
f937473f
RD
5248 -- Cloned_Subtype (Node16) (subtype case only)
5249 -- First_Entity (Node17)
5250 -- Equivalent_Type (Node18) (always Empty for type)
47346923 5251 -- Non_Limited_View (Node19)
32b794c8 5252 -- Last_Entity (Node20)
220d1fd9
AC
5253 -- SSO_Set_High_By_Default (Flag273) (base type only)
5254 -- SSO_Set_Low_By_Default (Flag272) (base type only)
76f9c7f4
BD
5255 -- Corresponding_Remote_Type $$$??? type
5256 -- Renamed_Entity $$$??? type
f937473f
RD
5257 -- First_Component (synth)
5258 -- First_Component_Or_Discriminant (synth)
47346923 5259 -- Has_Non_Limited_View (synth)
a4100e55 5260 -- (plus type attributes)
70482933
RK
5261
5262 -- E_Component
76f9c7f4 5263 -- Linker_Section_Pragma $$$???
f937473f
RD
5264 -- Normalized_First_Bit (Uint8)
5265 -- Current_Value (Node9) (always Empty)
5266 -- Normalized_Position_Max (Uint10)
5267 -- Component_Bit_Offset (Uint11)
5268 -- Esize (Uint12)
5269 -- Component_Clause (Node13)
5270 -- Normalized_Position (Uint14)
5271 -- DT_Entry_Count (Uint15)
5272 -- Entry_Formal (Node16)
5273 -- Prival (Node17)
5274 -- Renamed_Object (Node18) (always Empty)
5275 -- Discriminant_Checking_Func (Node20)
05dbb83f 5276 -- Corresponding_Record_Component (Node21)
f937473f 5277 -- Original_Record_Component (Node22)
f937473f 5278 -- DT_Offset_To_Top_Func (Node25)
cefce34c 5279 -- Related_Type (Node27)
f937473f
RD
5280 -- Has_Biased_Representation (Flag139)
5281 -- Has_Per_Object_Constraint (Flag154)
5282 -- Is_Atomic (Flag85)
40f4dbbe 5283 -- Is_Independent (Flag268)
c8d3b4ff 5284 -- Is_Return_Object (Flag209)
f937473f
RD
5285 -- Is_Tag (Flag78)
5286 -- Is_Volatile (Flag16)
57abdadd 5287 -- Is_Volatile_Full_Access (Flag285)
f937473f 5288 -- Treat_As_Volatile (Flag41)
b120ca61 5289 -- Is_Full_Access (synth)
f937473f
RD
5290 -- Next_Component (synth)
5291 -- Next_Component_Or_Discriminant (synth)
70482933
RK
5292
5293 -- E_Constant
5294 -- E_Loop_Parameter
f937473f 5295 -- Current_Value (Node9) (always Empty)
8398e82e 5296 -- Discriminal_Link (Node10)
f937473f
RD
5297 -- Full_View (Node11)
5298 -- Esize (Uint12)
d15f9422 5299 -- Extra_Accessibility (Node13) (constants only)
f937473f 5300 -- Alignment (Uint14)
6877306f 5301 -- Status_Flag_Or_Transient_Decl (Node15)
f937473f
RD
5302 -- Actual_Subtype (Node17)
5303 -- Renamed_Object (Node18)
76f9c7f4 5304 -- Renamed_Entity $$$???
f937473f 5305 -- Size_Check_Code (Node19) (constants only)
21d27997 5306 -- Prival_Link (Node20) (privals only)
ded8909b 5307 -- Interface_Name (Node21) (constants only)
cefce34c 5308 -- Related_Type (Node27) (constants only)
02217452 5309 -- Initialization_Statements (Node28)
8c7ff9a0 5310 -- BIP_Initialization_Call (Node29)
4ac2bbbd 5311 -- Last_Aggregate_Assignment (Node30)
3830827c 5312 -- Activation_Record_Component (Node31)
caf07df9 5313 -- Encapsulating_State (Node32) (constants only)
19992053 5314 -- Linker_Section_Pragma (Node33)
eb7d283d 5315 -- Contract (Node34) (constants only)
90e491a7 5316 -- SPARK_Pragma (Node40) (constants only)
f937473f
RD
5317 -- Has_Alignment_Clause (Flag46)
5318 -- Has_Atomic_Components (Flag86)
5319 -- Has_Biased_Representation (Flag139)
5320 -- Has_Completion (Flag26) (constants only)
28fa5430 5321 -- Has_Independent_Components (Flag34)
f937473f 5322 -- Has_Size_Clause (Flag29)
8636f52f 5323 -- Has_Thunks (Flag228) (constants only)
f937473f
RD
5324 -- Has_Volatile_Components (Flag87)
5325 -- Is_Atomic (Flag85)
90e491a7 5326 -- Is_Elaboration_Checks_OK_Id (Flag148) (constants only)
162ed06f 5327 -- Is_Elaboration_Warnings_OK_Id (Flag304) (constants only)
f937473f 5328 -- Is_Eliminated (Flag124)
937e9676
AC
5329 -- Is_Finalized_Transient (Flag252)
5330 -- Is_Ignored_Transient (Flag295)
8a52daee 5331 -- Is_Independent (Flag268)
21d27997 5332 -- Is_Return_Object (Flag209)
f937473f 5333 -- Is_True_Constant (Flag163)
f8dae9bb 5334 -- Is_Uplevel_Referenced_Entity (Flag283)
f937473f 5335 -- Is_Volatile (Flag16)
57abdadd 5336 -- Is_Volatile_Full_Access (Flag285)
21d27997
RD
5337 -- Optimize_Alignment_Space (Flag241) (constants only)
5338 -- Optimize_Alignment_Time (Flag242) (constants only)
90e491a7 5339 -- SPARK_Pragma_Inherited (Flag265) (constants only)
c8d3b4ff 5340 -- Stores_Attribute_Old_Prefix (Flag270) (constants only)
f937473f 5341 -- Treat_As_Volatile (Flag41)
f937473f
RD
5342 -- Address_Clause (synth)
5343 -- Alignment_Clause (synth)
48688534 5344 -- Is_Elaboration_Target (synth)
b120ca61 5345 -- Is_Full_Access (synth)
f937473f 5346 -- Size_Clause (synth)
70482933
RK
5347
5348 -- E_Decimal_Fixed_Point_Type
76f9c7f4 5349 -- E_Decimal_Fixed_Subtype$$$???no such thing
760804f3 5350 -- Scale_Value (Uint16)
f937473f
RD
5351 -- Digits_Value (Uint17)
5352 -- Scalar_Range (Node20)
5353 -- Delta_Value (Ureal18)
5354 -- Small_Value (Ureal21)
fc3a3f3b 5355 -- Static_Real_Or_String_Predicate (Node25)
f937473f
RD
5356 -- Has_Machine_Radix_Clause (Flag83)
5357 -- Machine_Radix_10 (Flag84)
5087048c 5358 -- Aft_Value (synth)
f937473f
RD
5359 -- Type_Low_Bound (synth)
5360 -- Type_High_Bound (synth)
a4100e55 5361 -- (plus type attributes)
70482933
RK
5362
5363 -- E_Discriminant
f937473f
RD
5364 -- Normalized_First_Bit (Uint8)
5365 -- Current_Value (Node9) (always Empty)
5366 -- Normalized_Position_Max (Uint10)
5367 -- Component_Bit_Offset (Uint11)
5368 -- Esize (Uint12)
5369 -- Component_Clause (Node13)
5370 -- Normalized_Position (Uint14)
5371 -- Discriminant_Number (Uint15)
5372 -- Discriminal (Node17)
5373 -- Renamed_Object (Node18) (always Empty)
5374 -- Corresponding_Discriminant (Node19)
5375 -- Discriminant_Default_Value (Node20)
05dbb83f 5376 -- Corresponding_Record_Component (Node21)
f937473f
RD
5377 -- Original_Record_Component (Node22)
5378 -- CR_Discriminant (Node23)
b54d1d39 5379 -- Is_Completely_Hidden (Flag103)
f937473f 5380 -- Is_Return_Object (Flag209)
76f9c7f4
BD
5381 -- Entry_Formal $$$???
5382 -- Linker_Section_Pragma $$$???
f937473f
RD
5383 -- Next_Component_Or_Discriminant (synth)
5384 -- Next_Discriminant (synth)
5385 -- Next_Stored_Discriminant (synth)
70482933
RK
5386
5387 -- E_Entry
5388 -- E_Entry_Family
f937473f
RD
5389 -- Protected_Body_Subprogram (Node11)
5390 -- Barrier_Function (Node12)
3f99a611 5391 -- Elaboration_Entity (Node13)
c9d70ab1 5392 -- Postconditions_Proc (Node14)
f937473f
RD
5393 -- Entry_Parameters_Type (Node15)
5394 -- First_Entity (Node17)
5395 -- Alias (Node18) (for entry only. Empty)
f937473f
RD
5396 -- Last_Entity (Node20)
5397 -- Accept_Address (Elist21)
5398 -- Scope_Depth_Value (Uint22)
21d27997 5399 -- Protection_Object (Node23) (protected kind)
8a0183fd 5400 -- Contract_Wrapper (Node25)
94bbf008 5401 -- Extra_Formals (Node28)
6c3c671e 5402 -- Contract (Node34)
877a5a12 5403 -- SPARK_Pragma (Node40) (protected kind)
f937473f
RD
5404 -- Default_Expressions_Processed (Flag108)
5405 -- Entry_Accepted (Flag152)
8afbdb8a 5406 -- Has_Yield_Aspect (Flag308)
c9d70ab1 5407 -- Has_Expanded_Contract (Flag240)
cf9a473e 5408 -- Ignore_SPARK_Mode_Pragmas (Flag301)
90e491a7 5409 -- Is_Elaboration_Checks_OK_Id (Flag148)
162ed06f 5410 -- Is_Elaboration_Warnings_OK_Id (Flag304)
5e127570 5411 -- Is_Entry_Wrapper (Flag297)
cf9a473e
AC
5412 -- Needs_No_Actuals (Flag22)
5413 -- Sec_Stack_Needed_For_Return (Flag167)
5414 -- SPARK_Pragma_Inherited (Flag265) (protected kind)
5415 -- Uses_Sec_Stack (Flag95)
76f9c7f4 5416 -- Renamed_Entity $$$???
f937473f 5417 -- Address_Clause (synth)
ea7f928b 5418 -- Entry_Index_Type (synth)
f937473f
RD
5419 -- First_Formal (synth)
5420 -- First_Formal_With_Extras (synth)
48688534 5421 -- Is_Elaboration_Target (synth)
ea7f928b 5422 -- Last_Formal (synth)
f937473f
RD
5423 -- Number_Formals (synth)
5424 -- Scope_Depth (synth)
70482933
RK
5425
5426 -- E_Entry_Index_Parameter
f937473f 5427 -- Entry_Index_Constant (Node18)
70482933
RK
5428
5429 -- E_Enumeration_Literal
f937473f
RD
5430 -- Enumeration_Pos (Uint11)
5431 -- Enumeration_Rep (Uint12)
f937473f
RD
5432 -- Alias (Node18)
5433 -- Enumeration_Rep_Expr (Node22)
76f9c7f4
BD
5434 -- Interface_Name $$$???
5435 -- Renamed_Object $$$???
5436 -- Esize $$$???
5437 -- Renamed_Entity $$$???
f937473f 5438 -- Next_Literal (synth)
70482933
RK
5439
5440 -- E_Enumeration_Type
5441 -- E_Enumeration_Subtype
76f9c7f4
BD
5442 -- First_Entity $$$??? type
5443 -- Renamed_Object $$$???
f937473f
RD
5444 -- Lit_Strings (Node16) (root type only)
5445 -- First_Literal (Node17)
760804f3 5446 -- Lit_Indexes (Node18) (root type only)
688a9b51 5447 -- Default_Aspect_Value (Node19) (base type only)
f937473f 5448 -- Scalar_Range (Node20)
c11207d3 5449 -- Lit_Hash (Node21) (root type only)
f937473f 5450 -- Enum_Pos_To_Rep (Node23) (type only)
60f908dd 5451 -- Static_Discrete_Predicate (List25)
f937473f
RD
5452 -- Has_Biased_Representation (Flag139)
5453 -- Has_Contiguous_Rep (Flag181)
5454 -- Has_Enumeration_Rep_Clause (Flag66)
bd29d519 5455 -- Has_Pragma_Ordered (Flag198) (base type only)
f937473f 5456 -- Nonzero_Is_True (Flag162) (base type only)
a6282852
ES
5457 -- No_Predicate_On_Actual (Flag275)
5458 -- No_Dynamic_Predicate_On_Actual (Flag276)
f937473f
RD
5459 -- Type_Low_Bound (synth)
5460 -- Type_High_Bound (synth)
a4100e55 5461 -- (plus type attributes)
70482933
RK
5462
5463 -- E_Exception
0a36105d 5464 -- Esize (Uint12)
f937473f
RD
5465 -- Alignment (Uint14)
5466 -- Renamed_Entity (Node18)
5467 -- Register_Exception_Call (Node20)
5468 -- Interface_Name (Node21)
6af9261c 5469 -- Activation_Record_Component (Node31)
f937473f 5470 -- Discard_Names (Flag88)
d5e96bc6 5471 -- Is_Raised (Flag224)
76f9c7f4 5472 -- Renamed_Object $$$???
70482933
RK
5473
5474 -- E_Exception_Type
f937473f 5475 -- Equivalent_Type (Node18)
a4100e55 5476 -- (plus type attributes)
70482933
RK
5477
5478 -- E_Floating_Point_Type
5479 -- E_Floating_Point_Subtype
f937473f 5480 -- Digits_Value (Uint17)
26df19ce 5481 -- Float_Rep (Uint10) (Float_Rep_Kind)
688a9b51 5482 -- Default_Aspect_Value (Node19) (base type only)
19fb051c 5483 -- Scalar_Range (Node20)
fc3a3f3b 5484 -- Static_Real_Or_String_Predicate (Node25)
d32e3cee
GB
5485 -- Machine_Emax_Value (synth)
5486 -- Machine_Emin_Value (synth)
5487 -- Machine_Mantissa_Value (synth)
5488 -- Machine_Radix_Value (synth)
5489 -- Model_Emin_Value (synth)
5490 -- Model_Epsilon_Value (synth)
5491 -- Model_Mantissa_Value (synth)
5492 -- Model_Small_Value (synth)
5493 -- Safe_Emax_Value (synth)
5494 -- Safe_First_Value (synth)
5495 -- Safe_Last_Value (synth)
f937473f
RD
5496 -- Type_Low_Bound (synth)
5497 -- Type_High_Bound (synth)
a4100e55 5498 -- (plus type attributes)
70482933
RK
5499
5500 -- E_Function
5501 -- E_Generic_Function
f937473f
RD
5502 -- Mechanism (Uint8) (Mechanism_Type)
5503 -- Renaming_Map (Uint9)
5504 -- Handler_Records (List10) (non-generic case only)
5505 -- Protected_Body_Subprogram (Node11)
5506 -- Next_Inlined_Subprogram (Node12)
477cfc5b 5507 -- Elaboration_Entity (Node13) (not implicit /=)
c9d70ab1 5508 -- Postconditions_Proc (Node14) (non-generic case only)
f937473f
RD
5509 -- DT_Position (Uint15)
5510 -- DTC_Entity (Node16)
5511 -- First_Entity (Node17)
5512 -- Alias (Node18) (non-generic case only)
c27a8bce 5513 -- Renamed_Entity (Node18)
76f9c7f4 5514 -- Renamed_Object $$$???
63585f75 5515 -- Extra_Accessibility_Of_Result (Node19) (non-generic case only)
f937473f
RD
5516 -- Last_Entity (Node20)
5517 -- Interface_Name (Node21)
5518 -- Scope_Depth_Value (Uint22)
5519 -- Generic_Renamings (Elist23) (for an instance)
043ce308 5520 -- Inner_Instances (Elist23) (generic case only)
76f9c7f4 5521 -- Inner_Instances $$$??? also E_Function
21d27997 5522 -- Protection_Object (Node23) (for concurrent kind)
3830827c 5523 -- Subps_Index (Uint24) (non-generic case only)
ce2b6ba5 5524 -- Interface_Alias (Node25)
f937473f 5525 -- Overridden_Operation (Node26)
d44202ba 5526 -- Wrapped_Entity (Node27) (non-generic case only)
f937473f 5527 -- Extra_Formals (Node28)
5b42c035 5528 -- Anonymous_Masters (Elist29) (non-generic case only)
477cfc5b 5529 -- Corresponding_Equality (Node30) (implicit /= only)
59fad002 5530 -- Thunk_Entity (Node31) (thunk case only)
888be6b1 5531 -- Corresponding_Procedure (Node32) (generate C code only)
19992053 5532 -- Linker_Section_Pragma (Node33)
6c3c671e 5533 -- Contract (Node34)
d3ef4bd6 5534 -- Import_Pragma (Node35) (non-generic case only)
7a71a7c4 5535 -- Class_Wide_Clone (Node38)
90e491a7 5536 -- Protected_Subprogram (Node39) (non-generic case only)
877a5a12 5537 -- SPARK_Pragma (Node40)
42f11e4c 5538 -- Original_Protected_Subprogram (Node41)
f937473f 5539 -- Body_Needed_For_SAL (Flag40)
8636f52f 5540 -- Contains_Ignored_Ghost_Code (Flag279)
f937473f
RD
5541 -- Default_Expressions_Processed (Flag108)
5542 -- Delay_Cleanups (Flag114)
5543 -- Delay_Subprogram_Descriptors (Flag50)
5544 -- Discard_Names (Flag88)
8636f52f 5545 -- Elaboration_Entity_Required (Flag174)
f937473f
RD
5546 -- Has_Completion (Flag26)
5547 -- Has_Controlling_Result (Flag98)
c9d70ab1 5548 -- Has_Expanded_Contract (Flag240) (non-generic case only)
f937473f
RD
5549 -- Has_Master_Entity (Flag21)
5550 -- Has_Missing_Return (Flag142)
5551 -- Has_Nested_Block_With_Handler (Flag101)
5a271a7f 5552 -- Has_Nested_Subprogram (Flag282)
fc999c5d 5553 -- Has_Out_Or_In_Out_Parameter (Flag110)
f937473f 5554 -- Has_Recursive_Call (Flag143)
8afbdb8a 5555 -- Has_Yield_Aspect (Flag308)
cf9a473e 5556 -- Ignore_SPARK_Mode_Pragmas (Flag301)
f937473f
RD
5557 -- Is_Abstract_Subprogram (Flag19) (non-generic case only)
5558 -- Is_Called (Flag102) (non-generic case only)
5559 -- Is_Constructor (Flag76)
ad1bea3a 5560 -- Is_CUDA_Kernel (Flag118) (non-generic case only)
f63d601b 5561 -- Is_DIC_Procedure (Flag132) (non-generic case only)
f937473f 5562 -- Is_Discrim_SO_Function (Flag176)
e2ef0ff6 5563 -- Is_Discriminant_Check_Function (Flag264)
90e491a7 5564 -- Is_Elaboration_Checks_OK_Id (Flag148)
162ed06f 5565 -- Is_Elaboration_Warnings_OK_Id (Flag304)
f937473f 5566 -- Is_Eliminated (Flag124)
fce54763 5567 -- Is_Generic_Actual_Subprogram (Flag274) (non-generic case only)
7b4ebba5 5568 -- Is_Hidden_Non_Overridden_Subpgm (Flag2) (non-generic case only)
90e491a7 5569 -- Is_Initial_Condition_Procedure (Flag302) (non-generic case only)
4bd4bb7f 5570 -- Is_Inlined_Always (Flag1) (non-generic case only)
f937473f
RD
5571 -- Is_Instantiated (Flag126) (generic case only)
5572 -- Is_Intrinsic_Subprogram (Flag64)
fc142f63 5573 -- Is_Invariant_Procedure (Flag257) (non-generic case only)
f937473f 5574 -- Is_Machine_Code_Subprogram (Flag137) (non-generic case only)
3ddfabe3 5575 -- Is_Partial_Invariant_Procedure (Flag292) (non-generic case only)
fc142f63
AC
5576 -- Is_Predicate_Function (Flag255) (non-generic case only)
5577 -- Is_Predicate_Function_M (Flag256) (non-generic case only)
5d37ba92 5578 -- Is_Primitive (Flag218)
d44202ba 5579 -- Is_Primitive_Wrapper (Flag195) (non-generic case only)
f937473f 5580 -- Is_Private_Descendant (Flag53)
d44202ba 5581 -- Is_Private_Primitive (Flag245) (non-generic case only)
f937473f 5582 -- Is_Pure (Flag44)
8ca1ee5d 5583 -- Is_Visible_Lib_Unit (Flag116)
f937473f
RD
5584 -- Needs_No_Actuals (Flag22)
5585 -- Requires_Overriding (Flag213) (non-generic case only)
5586 -- Return_Present (Flag54)
5587 -- Returns_By_Ref (Flag90)
888be6b1 5588 -- Rewritten_For_C (Flag287) (generate C code only)
f937473f 5589 -- Sec_Stack_Needed_For_Return (Flag167)
579847c2 5590 -- SPARK_Pragma_Inherited (Flag265)
f937473f
RD
5591 -- Uses_Sec_Stack (Flag95)
5592 -- Address_Clause (synth)
5593 -- First_Formal (synth)
5594 -- First_Formal_With_Extras (synth)
48688534 5595 -- Is_Elaboration_Target (synth)
ea7f928b 5596 -- Last_Formal (synth)
f937473f
RD
5597 -- Number_Formals (synth)
5598 -- Scope_Depth (synth)
70482933
RK
5599
5600 -- E_General_Access_Type
76f9c7f4
BD
5601 -- First_Entity $$$???
5602 -- Renamed_Entity $$$???
f937473f
RD
5603 -- Master_Id (Node17)
5604 -- Directly_Designated_Type (Node20)
a4100e55 5605 -- Associated_Storage_Pool (Node22) (root type only)
d3f70b35 5606 -- Finalization_Master (Node23) (root type only)
760804f3 5607 -- Storage_Size_Variable (Node26) (base type only)
70482933
RK
5608 -- (plus type attributes)
5609
5610 -- E_Generic_In_Parameter
5611 -- E_Generic_In_Out_Parameter
f937473f
RD
5612 -- Current_Value (Node9) (always Empty)
5613 -- Entry_Component (Node11)
5614 -- Actual_Subtype (Node17)
5615 -- Renamed_Object (Node18) (always Empty)
5616 -- Default_Value (Node20)
5617 -- Protected_Formal (Node22)
5618 -- Is_Controlling_Formal (Flag97)
f937473f
RD
5619 -- Is_Return_Object (Flag209)
5620 -- Parameter_Mode (synth)
70482933
RK
5621
5622 -- E_Incomplete_Type
6e443c90 5623 -- E_Incomplete_Subtype
46202729 5624 -- Direct_Primitive_Operations (Elist10)
47346923 5625 -- Non_Limited_View (Node19)
f937473f
RD
5626 -- Private_Dependents (Elist18)
5627 -- Discriminant_Constraint (Elist21)
5628 -- Stored_Constraint (Elist23)
76f9c7f4
BD
5629 -- First_Entity $$$???
5630 -- Last_Entity $$$???
47346923 5631 -- Has_Non_Limited_View (synth)
70482933
RK
5632 -- (plus type attributes)
5633
5634 -- E_In_Parameter
5635 -- E_In_Out_Parameter
5636 -- E_Out_Parameter
76f9c7f4 5637 -- Linker_Section_Pragma $$$???
f937473f
RD
5638 -- Mechanism (Uint8) (Mechanism_Type)
5639 -- Current_Value (Node9)
5640 -- Discriminal_Link (Node10) (discriminals only)
5641 -- Entry_Component (Node11)
5642 -- Esize (Uint12)
5643 -- Extra_Accessibility (Node13)
5644 -- Alignment (Uint14)
5645 -- Extra_Formal (Node15)
5646 -- Unset_Reference (Node16)
5647 -- Actual_Subtype (Node17)
5648 -- Renamed_Object (Node18)
5649 -- Spec_Entity (Node19)
5650 -- Default_Value (Node20)
5651 -- Default_Expr_Function (Node21)
5652 -- Protected_Formal (Node22)
5653 -- Extra_Constrained (Node23)
43b26411 5654 -- Minimum_Accessibility (Node24)
67ce0d7e 5655 -- Last_Assignment (Node26) (OUT, IN-OUT only)
3830827c 5656 -- Activation_Record_Component (Node31)
5d37ba92 5657 -- Has_Initial_Value (Flag219)
f937473f 5658 -- Is_Controlling_Formal (Flag97)
ce0bead3 5659 -- Is_Only_Out_Parameter (Flag226)
fad0600d 5660 -- Low_Bound_Tested (Flag205)
f937473f 5661 -- Is_Return_Object (Flag209)
7037d2bb 5662 -- Is_Activation_Record (Flag305)
f937473f 5663 -- Parameter_Mode (synth)
70482933
RK
5664
5665 -- E_Label
76f9c7f4
BD
5666 -- Renamed_Object $$$???
5667 -- Renamed_Entity $$$???
f937473f
RD
5668 -- Enclosing_Scope (Node18)
5669 -- Reachable (Flag49)
70482933
RK
5670
5671 -- E_Limited_Private_Type
5672 -- E_Limited_Private_Subtype
76f9c7f4 5673 -- Scalar_Range $$$??? type
f937473f
RD
5674 -- First_Entity (Node17)
5675 -- Private_Dependents (Elist18)
5676 -- Underlying_Full_View (Node19)
5677 -- Last_Entity (Node20)
5678 -- Discriminant_Constraint (Elist21)
f937473f
RD
5679 -- Stored_Constraint (Elist23)
5680 -- Has_Completion (Flag26)
70482933
RK
5681 -- (plus type attributes)
5682
5683 -- E_Loop
51bf9bdf 5684 -- First_Exit_Statement (Node8)
f937473f 5685 -- Has_Exit (Flag47)
d436b30d 5686 -- Has_Loop_Entry_Attributes (Flag260)
f937473f
RD
5687 -- Has_Master_Entity (Flag21)
5688 -- Has_Nested_Block_With_Handler (Flag101)
7edfb4c6 5689 -- Uses_Sec_Stack (Flag95)
76f9c7f4
BD
5690 -- First_Entity $$$???
5691 -- Last_Entity $$$???
5692 -- Renamed_Object $$$???
70482933
RK
5693
5694 -- E_Modular_Integer_Type
5695 -- E_Modular_Integer_Subtype
19fb051c 5696 -- Modulus (Uint17) (base type only)
688a9b51 5697 -- Default_Aspect_Value (Node19) (base type only)
f937473f
RD
5698 -- Original_Array_Type (Node21)
5699 -- Scalar_Range (Node20)
60f908dd 5700 -- Static_Discrete_Predicate (List25)
19fb051c 5701 -- Non_Binary_Modulus (Flag58) (base type only)
f937473f 5702 -- Has_Biased_Representation (Flag139)
4c51ff88 5703 -- Has_Shift_Operator (Flag267) (base type only)
a6282852
ES
5704 -- No_Predicate_On_Actual (Flag275)
5705 -- No_Dynamic_Predicate_On_Actual (Flag276)
f937473f
RD
5706 -- Type_Low_Bound (synth)
5707 -- Type_High_Bound (synth)
70482933
RK
5708 -- (plus type attributes)
5709
5710 -- E_Named_Integer
76f9c7f4 5711 -- Renamed_Object $$$???
70482933
RK
5712
5713 -- E_Named_Real
70482933
RK
5714
5715 -- E_Operator
f937473f
RD
5716 -- First_Entity (Node17)
5717 -- Alias (Node18)
63585f75 5718 -- Extra_Accessibility_Of_Result (Node19)
f937473f 5719 -- Last_Entity (Node20)
3830827c 5720 -- Subps_Index (Uint24)
038140ed 5721 -- Overridden_Operation (Node26)
19992053 5722 -- Linker_Section_Pragma (Node33)
6c3c671e 5723 -- Contract (Node34)
d3ef4bd6 5724 -- Import_Pragma (Node35)
f99ff327
AC
5725 -- SPARK_Pragma (Node40)
5726 -- Default_Expressions_Processed (Flag108)
caf07df9 5727 -- Has_Nested_Subprogram (Flag282)
cf9a473e 5728 -- Ignore_SPARK_Mode_Pragmas (Flag301)
90e491a7 5729 -- Is_Elaboration_Checks_OK_Id (Flag148)
162ed06f 5730 -- Is_Elaboration_Warnings_OK_Id (Flag304)
f937473f 5731 -- Is_Intrinsic_Subprogram (Flag64)
f99ff327 5732 -- Is_Machine_Code_Subprogram (Flag137)
5d37ba92 5733 -- Is_Primitive (Flag218)
f99ff327
AC
5734 -- Is_Pure (Flag44)
5735 -- SPARK_Pragma_Inherited (Flag265)
76f9c7f4
BD
5736 -- Interface_Name $$$???
5737 -- Renamed_Entity $$$???
5738 -- Renamed_Object $$$???
48688534 5739 -- Is_Elaboration_Target (synth)
21d27997
RD
5740 -- Aren't there more flags and fields? seems like this list should be
5741 -- more similar to the E_Function list, which is much longer ???
70482933
RK
5742
5743 -- E_Ordinary_Fixed_Point_Type
5744 -- E_Ordinary_Fixed_Point_Subtype
f937473f 5745 -- Delta_Value (Ureal18)
688a9b51 5746 -- Default_Aspect_Value (Node19) (base type only)
f937473f 5747 -- Scalar_Range (Node20)
fc3a3f3b 5748 -- Static_Real_Or_String_Predicate (Node25)
f937473f
RD
5749 -- Small_Value (Ureal21)
5750 -- Has_Small_Clause (Flag67)
5087048c 5751 -- Aft_Value (synth)
f937473f
RD
5752 -- Type_Low_Bound (synth)
5753 -- Type_High_Bound (synth)
a4100e55 5754 -- (plus type attributes)
70482933
RK
5755
5756 -- E_Package
5757 -- E_Generic_Package
f937473f
RD
5758 -- Dependent_Instances (Elist8) (for an instance)
5759 -- Renaming_Map (Uint9)
5760 -- Handler_Records (List10) (non-generic case only)
5761 -- Generic_Homonym (Node11) (generic case only)
5762 -- Associated_Formal_Package (Node12)
5763 -- Elaboration_Entity (Node13)
f937473f
RD
5764 -- Related_Instance (Node15) (non-generic case only)
5765 -- First_Private_Entity (Node16)
5766 -- First_Entity (Node17)
5767 -- Renamed_Entity (Node18)
76f9c7f4 5768 -- Renamed_Object $$$???
f937473f
RD
5769 -- Body_Entity (Node19)
5770 -- Last_Entity (Node20)
5771 -- Interface_Name (Node21)
5772 -- Scope_Depth_Value (Uint22)
5773 -- Generic_Renamings (Elist23) (for an instance)
5774 -- Inner_Instances (Elist23) (generic case only)
76f9c7f4 5775 -- Inner_Instances $$$??? also E_Package
f937473f 5776 -- Limited_View (Node23) (non-generic/instance)
167b47d9 5777 -- Incomplete_Actuals (Elist24) (for an instance)
cf6956bb 5778 -- Abstract_States (Elist25)
f937473f 5779 -- Package_Instantiation (Node26)
cf6956bb 5780 -- Current_Use_Clause (Node27)
54e28df2 5781 -- Finalizer (Node28) (non-generic case only)
5b42c035 5782 -- Anonymous_Masters (Elist29) (non-generic case only)
6c3c671e 5783 -- Contract (Node34)
877a5a12
AC
5784 -- SPARK_Pragma (Node40)
5785 -- SPARK_Aux_Pragma (Node41)
b03d3f73 5786 -- Body_Needed_For_Inlining (Flag299)
f937473f 5787 -- Body_Needed_For_SAL (Flag40)
8636f52f 5788 -- Contains_Ignored_Ghost_Code (Flag279)
2bb988bb 5789 -- Delay_Subprogram_Descriptors (Flag50)
f937473f 5790 -- Discard_Names (Flag88)
f937473f 5791 -- Elaborate_Body_Desirable (Flag210) (non-generic case only)
2bb988bb 5792 -- Elaboration_Entity_Required (Flag174)
7b56a91b 5793 -- From_Limited_With (Flag159)
f937473f
RD
5794 -- Has_All_Calls_Remote (Flag79)
5795 -- Has_Completion (Flag26)
5796 -- Has_Forward_Instantiation (Flag175)
5797 -- Has_Master_Entity (Flag21)
5798 -- Has_RACW (Flag214) (non-generic case only)
cf9a473e 5799 -- Ignore_SPARK_Mode_Pragmas (Flag301)
4b96d386 5800 -- Is_Called (Flag102) (non-generic case only)
90e491a7 5801 -- Is_Elaboration_Checks_OK_Id (Flag148)
162ed06f 5802 -- Is_Elaboration_Warnings_OK_Id (Flag304)
f937473f 5803 -- Is_Instantiated (Flag126)
4b96d386 5804 -- In_Package_Body (Flag48)
f937473f 5805 -- Is_Private_Descendant (Flag53)
4b96d386 5806 -- In_Use (Flag8)
8ca1ee5d 5807 -- Is_Visible_Lib_Unit (Flag116)
ce0bead3 5808 -- Renamed_In_Spec (Flag231) (non-generic case only)
579847c2
AC
5809 -- SPARK_Aux_Pragma_Inherited (Flag266)
5810 -- SPARK_Pragma_Inherited (Flag265)
0a36105d 5811 -- Static_Elaboration_Desired (Flag77) (non-generic case only)
76f9c7f4 5812 -- Renamed_Object $$$???
08f52d9f 5813 -- Has_Non_Null_Abstract_State (synth)
39af2bac 5814 -- Has_Null_Abstract_State (synth)
48688534 5815 -- Is_Elaboration_Target (synth)
11fa950b 5816 -- Is_Wrapper_Package (synth) (non-generic case only)
b2dea70e 5817 -- Has_Limited_View (synth) (non-generic case only)
11fa950b 5818 -- Scope_Depth (synth)
70482933
RK
5819
5820 -- E_Package_Body
f937473f
RD
5821 -- Handler_Records (List10) (non-generic case only)
5822 -- Related_Instance (Node15) (non-generic case only)
5823 -- First_Entity (Node17)
5824 -- Spec_Entity (Node19)
5825 -- Last_Entity (Node20)
5826 -- Scope_Depth_Value (Uint22)
54e28df2 5827 -- Finalizer (Node28) (non-generic case only)
6c3c671e 5828 -- Contract (Node34)
877a5a12
AC
5829 -- SPARK_Pragma (Node40)
5830 -- SPARK_Aux_Pragma (Node41)
8636f52f 5831 -- Contains_Ignored_Ghost_Code (Flag279)
f937473f 5832 -- Delay_Subprogram_Descriptors (Flag50)
cf9a473e 5833 -- Ignore_SPARK_Mode_Pragmas (Flag301)
579847c2
AC
5834 -- SPARK_Aux_Pragma_Inherited (Flag266)
5835 -- SPARK_Pragma_Inherited (Flag265)
76f9c7f4 5836 -- Renamed_Entity $$$???
11fa950b 5837 -- Scope_Depth (synth)
70482933
RK
5838
5839 -- E_Private_Type
5840 -- E_Private_Subtype
76f9c7f4 5841 -- Scalar_Range $$$??? type
46202729 5842 -- Direct_Primitive_Operations (Elist10)
f937473f
RD
5843 -- First_Entity (Node17)
5844 -- Private_Dependents (Elist18)
5845 -- Underlying_Full_View (Node19)
5846 -- Last_Entity (Node20)
5847 -- Discriminant_Constraint (Elist21)
f937473f
RD
5848 -- Stored_Constraint (Elist23)
5849 -- Has_Completion (Flag26)
0cb81445 5850 -- Is_Controlled_Active (Flag42) (base type only)
76f9c7f4 5851 -- $$$???above in (plus type attributes)
70482933
RK
5852 -- (plus type attributes)
5853
5854 -- E_Procedure
5855 -- E_Generic_Procedure
76f9c7f4 5856 -- Associated_Node_For_Itype $$$??? E_Procedure
f937473f
RD
5857 -- Renaming_Map (Uint9)
5858 -- Handler_Records (List10) (non-generic case only)
5859 -- Protected_Body_Subprogram (Node11)
5860 -- Next_Inlined_Subprogram (Node12)
5861 -- Elaboration_Entity (Node13)
c9d70ab1 5862 -- Postconditions_Proc (Node14) (non-generic case only)
f937473f
RD
5863 -- DT_Position (Uint15)
5864 -- DTC_Entity (Node16)
5865 -- First_Entity (Node17)
5866 -- Alias (Node18) (non-generic case only)
c27a8bce 5867 -- Renamed_Entity (Node18)
76f9c7f4 5868 -- Renamed_Object $$$???
90e491a7 5869 -- Receiving_Entry (Node19) (non-generic case only)
f937473f
RD
5870 -- Last_Entity (Node20)
5871 -- Interface_Name (Node21)
5872 -- Scope_Depth_Value (Uint22)
043ce308
AC
5873 -- Generic_Renamings (Elist23) (for an instance)
5874 -- Inner_Instances (Elist23) (generic case only)
76f9c7f4 5875 -- Inner_Instances $$$??? also E_Procedure
21d27997 5876 -- Protection_Object (Node23) (for concurrent kind)
3830827c 5877 -- Subps_Index (Uint24) (non-generic case only)
ce2b6ba5 5878 -- Interface_Alias (Node25)
c28408b7 5879 -- Overridden_Operation (Node26) (never for init proc)
f937473f
RD
5880 -- Wrapped_Entity (Node27) (non-generic case only)
5881 -- Extra_Formals (Node28)
5b42c035 5882 -- Anonymous_Masters (Elist29) (non-generic case only)
477cfc5b 5883 -- Static_Initialization (Node30) (init_proc only)
59fad002 5884 -- Thunk_Entity (Node31) (thunk case only)
888be6b1 5885 -- Corresponding_Function (Node32) (generate C code only)
19992053 5886 -- Linker_Section_Pragma (Node33)
6c3c671e 5887 -- Contract (Node34)
d3ef4bd6 5888 -- Import_Pragma (Node35) (non-generic case only)
7a71a7c4 5889 -- Class_Wide_Clone (Node38)
90e491a7 5890 -- Protected_Subprogram (Node39) (non-generic case only)
877a5a12 5891 -- SPARK_Pragma (Node40)
42f11e4c 5892 -- Original_Protected_Subprogram (Node41)
f937473f 5893 -- Body_Needed_For_SAL (Flag40)
8636f52f 5894 -- Contains_Ignored_Ghost_Code (Flag279)
76f9c7f4
BD
5895 -- Delay_Cleanups (Flag114)$$$???Dup below
5896 -- Discard_Names (Flag88)$$$???Dup below
f937473f 5897 -- Elaboration_Entity_Required (Flag174)
f937473f
RD
5898 -- Default_Expressions_Processed (Flag108)
5899 -- Delay_Cleanups (Flag114)
5900 -- Delay_Subprogram_Descriptors (Flag50)
5901 -- Discard_Names (Flag88)
5902 -- Has_Completion (Flag26)
c9d70ab1 5903 -- Has_Expanded_Contract (Flag240) (non-generic case only)
f937473f
RD
5904 -- Has_Master_Entity (Flag21)
5905 -- Has_Nested_Block_With_Handler (Flag101)
5a271a7f 5906 -- Has_Nested_Subprogram (Flag282)
8afbdb8a 5907 -- Has_Yield_Aspect (Flag308)
cf9a473e 5908 -- Ignore_SPARK_Mode_Pragmas (Flag301)
f937473f
RD
5909 -- Is_Abstract_Subprogram (Flag19) (non-generic case only)
5910 -- Is_Asynchronous (Flag81)
043ce308 5911 -- Is_Called (Flag102) (non-generic case only)
f937473f 5912 -- Is_Constructor (Flag76)
ad1bea3a 5913 -- Is_CUDA_Kernel (Flag118)
f63d601b 5914 -- Is_DIC_Procedure (Flag132) (non-generic case only)
90e491a7 5915 -- Is_Elaboration_Checks_OK_Id (Flag148)
162ed06f 5916 -- Is_Elaboration_Warnings_OK_Id (Flag304)
f937473f 5917 -- Is_Eliminated (Flag124)
09c954dc 5918 -- Is_Generic_Actual_Subprogram (Flag274) (non-generic case only)
7b4ebba5 5919 -- Is_Hidden_Non_Overridden_Subpgm (Flag2) (non-generic case only)
90e491a7 5920 -- Is_Initial_Condition_Procedure (Flag302) (non-generic case only)
4bd4bb7f 5921 -- Is_Inlined_Always (Flag1) (non-generic case only)
f937473f
RD
5922 -- Is_Instantiated (Flag126) (generic case only)
5923 -- Is_Interrupt_Handler (Flag89)
5924 -- Is_Intrinsic_Subprogram (Flag64)
fc142f63 5925 -- Is_Invariant_Procedure (Flag257) (non-generic case only)
f937473f
RD
5926 -- Is_Machine_Code_Subprogram (Flag137) (non-generic case only)
5927 -- Is_Null_Init_Proc (Flag178)
f7937111 5928 -- Is_Partial_DIC_Procedure (synth) (non-generic case only)
3ddfabe3 5929 -- Is_Partial_Invariant_Procedure (Flag292) (non-generic case only)
fc142f63
AC
5930 -- Is_Predicate_Function (Flag255) (non-generic case only)
5931 -- Is_Predicate_Function_M (Flag256) (non-generic case only)
5d37ba92 5932 -- Is_Primitive (Flag218)
f937473f
RD
5933 -- Is_Primitive_Wrapper (Flag195) (non-generic case only)
5934 -- Is_Private_Descendant (Flag53)
d44202ba 5935 -- Is_Private_Primitive (Flag245) (non-generic case only)
f937473f 5936 -- Is_Pure (Flag44)
f937473f 5937 -- Is_Valued_Procedure (Flag127)
8ca1ee5d 5938 -- Is_Visible_Lib_Unit (Flag116)
f937473f
RD
5939 -- Needs_No_Actuals (Flag22)
5940 -- No_Return (Flag113)
5941 -- Requires_Overriding (Flag213) (non-generic case only)
5942 -- Sec_Stack_Needed_For_Return (Flag167)
579847c2 5943 -- SPARK_Pragma_Inherited (Flag265)
76f9c7f4 5944 -- Entry_Parameters_Type $$$???
f937473f
RD
5945 -- Address_Clause (synth)
5946 -- First_Formal (synth)
5947 -- First_Formal_With_Extras (synth)
48688534 5948 -- Is_Elaboration_Target (synth)
df3e68b1 5949 -- Is_Finalizer (synth)
ea7f928b 5950 -- Last_Formal (synth)
f937473f 5951 -- Number_Formals (synth)
70482933
RK
5952
5953 -- E_Protected_Body
877a5a12 5954 -- SPARK_Pragma (Node40)
cf9a473e 5955 -- Ignore_SPARK_Mode_Pragmas (Flag301)
877a5a12 5956 -- SPARK_Pragma_Inherited (Flag265)
70482933
RK
5957 -- (any others??? First/Last Entity, Scope_Depth???)
5958
76f9c7f4 5959 -- E_Protected_Object$$$???No such thing
70482933
RK
5960
5961 -- E_Protected_Type
5962 -- E_Protected_Subtype
46202729 5963 -- Direct_Primitive_Operations (Elist10)
f937473f
RD
5964 -- First_Private_Entity (Node16)
5965 -- First_Entity (Node17)
5966 -- Corresponding_Record_Type (Node18)
760804f3 5967 -- Entry_Bodies_Array (Node19)
f937473f
RD
5968 -- Last_Entity (Node20)
5969 -- Discriminant_Constraint (Elist21)
5970 -- Scope_Depth_Value (Uint22)
f937473f 5971 -- Stored_Constraint (Elist23)
75b87c16
AC
5972 -- Anonymous_Object (Node30)
5973 -- Contract (Node34)
442d1abb 5974 -- Entry_Max_Queue_Lengths_Array (Node35)
877a5a12 5975 -- SPARK_Aux_Pragma (Node41)
cf9a473e 5976 -- Ignore_SPARK_Mode_Pragmas (Flag301)
877a5a12 5977 -- SPARK_Aux_Pragma_Inherited (Flag266)
88e7531b 5978 -- Uses_Lock_Free (Flag188)
aafc151a
AC
5979 -- First_Component (synth)
5980 -- First_Component_Or_Discriminant (synth)
f937473f 5981 -- Has_Entries (synth)
877a5a12 5982 -- Has_Interrupt_Handler (synth)
f937473f 5983 -- Number_Entries (synth)
877a5a12 5984 -- Scope_Depth (synth)
75b87c16 5985 -- (plus type attributes)
70482933
RK
5986
5987 -- E_Record_Type
5988 -- E_Record_Subtype
76f9c7f4
BD
5989 -- Renamed_Entity $$$??? type
5990 -- Interface_Name $$$??? type
46202729 5991 -- Direct_Primitive_Operations (Elist10)
f937473f
RD
5992 -- Access_Disp_Table (Elist16) (base type only)
5993 -- Cloned_Subtype (Node16) (subtype case only)
5994 -- First_Entity (Node17)
5995 -- Corresponding_Concurrent_Type (Node18)
6fb4cdde 5996 -- Parent_Subtype (Node19) (base type only)
f937473f
RD
5997 -- Last_Entity (Node20)
5998 -- Discriminant_Constraint (Elist21)
5999 -- Corresponding_Remote_Type (Node22)
6000 -- Stored_Constraint (Elist23)
ce2b6ba5 6001 -- Interfaces (Elist25)
04cbd48e 6002 -- Dispatch_Table_Wrappers (Elist26) (base type only)
cf49bd32 6003 -- Underlying_Record_View (Node28) (base type only)
8dce7371 6004 -- Access_Disp_Table_Elab_Flag (Node30) (base type only)
3f6d1daa 6005 -- Predicated_Parent (Node38) (subtype only)
f937473f
RD
6006 -- Component_Alignment (special) (base type only)
6007 -- C_Pass_By_Copy (Flag125) (base type only)
5d37ba92 6008 -- Has_Dispatch_Table (Flag220) (base tagged type only)
a01b9df6 6009 -- Has_Pragma_Pack (Flag121) (impl base type only)
87729e5a 6010 -- Has_Private_Ancestor (Flag151)
48c8c473 6011 -- Has_Private_Extension (Flag300)
f937473f
RD
6012 -- Has_Record_Rep_Clause (Flag65) (base type only)
6013 -- Has_Static_Discriminants (Flag211) (subtype only)
6014 -- Is_Class_Wide_Equivalent_Type (Flag35)
6015 -- Is_Concurrent_Record_Type (Flag20)
6016 -- Is_Constrained (Flag12)
0cb81445 6017 -- Is_Controlled_Active (Flag42) (base type only)
76f9c7f4 6018 -- $$$???above in (plus type attributes)
f937473f 6019 -- Is_Interface (Flag186)
0a36105d 6020 -- Is_Limited_Interface (Flag197)
8489c295 6021 -- No_Reordering (Flag239) (base type only)
f937473f 6022 -- Reverse_Bit_Order (Flag164) (base type only)
de94a7e7 6023 -- Reverse_Storage_Order (Flag93) (base type only)
220d1fd9
AC
6024 -- SSO_Set_High_By_Default (Flag273) (base type only)
6025 -- SSO_Set_Low_By_Default (Flag272) (base type only)
f937473f
RD
6026 -- First_Component (synth)
6027 -- First_Component_Or_Discriminant (synth)
70482933
RK
6028 -- (plus type attributes)
6029
6030 -- E_Record_Type_With_Private
6031 -- E_Record_Subtype_With_Private
76f9c7f4 6032 -- Corresponding_Remote_Type $$$??? E_Record_Subtype_With_Private
46202729 6033 -- Direct_Primitive_Operations (Elist10)
f937473f
RD
6034 -- First_Entity (Node17)
6035 -- Private_Dependents (Elist18)
6036 -- Underlying_Full_View (Node19)
6037 -- Last_Entity (Node20)
6038 -- Discriminant_Constraint (Elist21)
f937473f 6039 -- Stored_Constraint (Elist23)
ce2b6ba5 6040 -- Interfaces (Elist25)
76f9c7f4 6041 -- Underlying_Record_View $$$??? (Node28) (base type only)
3f6d1daa 6042 -- Predicated_Parent (Node38) (subtype only)
f937473f 6043 -- Has_Completion (Flag26)
87729e5a 6044 -- Has_Private_Ancestor (Flag151)
48c8c473 6045 -- Has_Private_Extension (Flag300)
f937473f 6046 -- Has_Record_Rep_Clause (Flag65) (base type only)
f937473f
RD
6047 -- Is_Concurrent_Record_Type (Flag20)
6048 -- Is_Constrained (Flag12)
0cb81445 6049 -- Is_Controlled_Active (Flag42) (base type only)
76f9c7f4 6050 -- $$$???above in (plus type attributes)
f937473f 6051 -- Is_Interface (Flag186)
0a36105d 6052 -- Is_Limited_Interface (Flag197)
8489c295 6053 -- No_Reordering (Flag239) (base type only)
f937473f 6054 -- Reverse_Bit_Order (Flag164) (base type only)
de94a7e7 6055 -- Reverse_Storage_Order (Flag93) (base type only)
220d1fd9
AC
6056 -- SSO_Set_High_By_Default (Flag273) (base type only)
6057 -- SSO_Set_Low_By_Default (Flag272) (base type only)
76f9c7f4 6058 -- Corresponding_Remote_Type $$$??? type
f937473f
RD
6059 -- First_Component (synth)
6060 -- First_Component_Or_Discriminant (synth)
70482933
RK
6061 -- (plus type attributes)
6062
6e443c90 6063 -- E_Return_Statement
f937473f 6064 -- Return_Applies_To (Node8)
76f9c7f4
BD
6065 -- First_Entity $$$???
6066 -- Last_Entity $$$???
6e443c90 6067
70482933
RK
6068 -- E_Signed_Integer_Type
6069 -- E_Signed_Integer_Subtype
76f9c7f4
BD
6070 -- Renamed_Object $$$??? subtype
6071 -- Interface_Name $$$??? subtype
6072 -- Direct_Primitive_Operations $$$??? type
6073 -- First_Entity $$$???
688a9b51 6074 -- Default_Aspect_Value (Node19) (base type only)
f937473f 6075 -- Scalar_Range (Node20)
60f908dd 6076 -- Static_Discrete_Predicate (List25)
f937473f 6077 -- Has_Biased_Representation (Flag139)
4c51ff88 6078 -- Has_Shift_Operator (Flag267) (base type only)
a6282852
ES
6079 -- No_Predicate_On_Actual (Flag275)
6080 -- No_Dynamic_Predicate_On_Actual (Flag276)
f937473f
RD
6081 -- Type_Low_Bound (synth)
6082 -- Type_High_Bound (synth)
70482933
RK
6083 -- (plus type attributes)
6084
70482933 6085 -- E_String_Literal_Subtype
f937473f
RD
6086 -- String_Literal_Length (Uint16)
6087 -- First_Index (Node17) (always Empty)
760804f3 6088 -- String_Literal_Low_Bound (Node18)
8ca597af 6089 -- Packed_Array_Impl_Type (Node23)
70482933
RK
6090 -- (plus type attributes)
6091
6092 -- E_Subprogram_Body
f937473f
RD
6093 -- Mechanism (Uint8)
6094 -- First_Entity (Node17)
855f2f8c 6095 -- Corresponding_Protected_Entry (Node18)
f937473f
RD
6096 -- Last_Entity (Node20)
6097 -- Scope_Depth_Value (Uint22)
94bbf008 6098 -- Extra_Formals (Node28)
5b42c035 6099 -- Anonymous_Masters (Elist29)
6c3c671e 6100 -- Contract (Node34)
877a5a12 6101 -- SPARK_Pragma (Node40)
8636f52f
HK
6102 -- Contains_Ignored_Ghost_Code (Flag279)
6103 -- SPARK_Pragma_Inherited (Flag265)
76f9c7f4
BD
6104 -- Interface_Name $$$???
6105 -- Renamed_Entity $$$???
f937473f 6106 -- Scope_Depth (synth)
70482933
RK
6107
6108 -- E_Subprogram_Type
63585f75 6109 -- Extra_Accessibility_Of_Result (Node19)
f937473f 6110 -- Directly_Designated_Type (Node20)
94bbf008 6111 -- Extra_Formals (Node28)
dc419b9f 6112 -- Access_Subprogram_Wrapper (Node41)
f937473f
RD
6113 -- First_Formal (synth)
6114 -- First_Formal_With_Extras (synth)
ea7f928b 6115 -- Last_Formal (synth)
f937473f 6116 -- Number_Formals (synth)
7d4d54aa 6117 -- Returns_By_Ref (Flag90)
76f9c7f4
BD
6118 -- First_Entity $$$???
6119 -- Last_Entity $$$???
6120 -- Interface_Name $$$???
70482933
RK
6121 -- (plus type attributes)
6122
6123 -- E_Task_Body
f99ff327 6124 -- Contract (Node34)
877a5a12 6125 -- SPARK_Pragma (Node40)
cf9a473e 6126 -- Ignore_SPARK_Mode_Pragmas (Flag301)
877a5a12 6127 -- SPARK_Pragma_Inherited (Flag265)
76f9c7f4 6128 -- First_Entity $$$???
70482933
RK
6129 -- (any others??? First/Last Entity, Scope_Depth???)
6130
6131 -- E_Task_Type
6132 -- E_Task_Subtype
46202729 6133 -- Direct_Primitive_Operations (Elist10)
f937473f
RD
6134 -- First_Private_Entity (Node16)
6135 -- First_Entity (Node17)
6136 -- Corresponding_Record_Type (Node18)
f937473f
RD
6137 -- Last_Entity (Node20)
6138 -- Discriminant_Constraint (Elist21)
6139 -- Scope_Depth_Value (Uint22)
f937473f
RD
6140 -- Stored_Constraint (Elist23)
6141 -- Task_Body_Procedure (Node25)
760804f3
AC
6142 -- Storage_Size_Variable (Node26) (base type only)
6143 -- Relative_Deadline_Variable (Node28) (base type only)
75b87c16 6144 -- Anonymous_Object (Node30)
f99ff327 6145 -- Contract (Node34)
877a5a12 6146 -- SPARK_Aux_Pragma (Node41)
f937473f
RD
6147 -- Delay_Cleanups (Flag114)
6148 -- Has_Master_Entity (Flag21)
6149 -- Has_Storage_Size_Clause (Flag23) (base type only)
cf9a473e 6150 -- Ignore_SPARK_Mode_Pragmas (Flag301)
90e491a7 6151 -- Is_Elaboration_Checks_OK_Id (Flag148)
162ed06f 6152 -- Is_Elaboration_Warnings_OK_Id (Flag304)
877a5a12 6153 -- SPARK_Aux_Pragma_Inherited (Flag266)
aafc151a
AC
6154 -- First_Component (synth)
6155 -- First_Component_Or_Discriminant (synth)
f937473f 6156 -- Has_Entries (synth)
48688534 6157 -- Is_Elaboration_Target (synth)
f937473f 6158 -- Number_Entries (synth)
75b87c16 6159 -- Scope_Depth (synth)
70482933
RK
6160 -- (plus type attributes)
6161
6162 -- E_Variable
f937473f
RD
6163 -- Hiding_Loop_Variable (Node8)
6164 -- Current_Value (Node9)
75b87c16 6165 -- Part_Of_Constituents (Elist10)
fdc54be6 6166 -- Part_Of_References (Elist11)
f937473f
RD
6167 -- Esize (Uint12)
6168 -- Extra_Accessibility (Node13)
6169 -- Alignment (Uint14)
3cebd1c0 6170 -- Status_Flag_Or_Transient_Decl (Node15) (transient object only)
f937473f
RD
6171 -- Unset_Reference (Node16)
6172 -- Actual_Subtype (Node17)
6173 -- Renamed_Object (Node18)
76f9c7f4
BD
6174 -- Renamed_Entity $$$???
6175 -- Discriminal_Link $$$???
f937473f 6176 -- Size_Check_Code (Node19)
21d27997 6177 -- Prival_Link (Node20)
f937473f 6178 -- Interface_Name (Node21)
685094bf 6179 -- Shared_Var_Procs_Instance (Node22)
f937473f 6180 -- Extra_Constrained (Node23)
a4941eec 6181 -- Related_Expression (Node24)
4c8e94ab 6182 -- Debug_Renaming_Link (Node25)
67ce0d7e 6183 -- Last_Assignment (Node26)
cefce34c 6184 -- Related_Type (Node27)
02217452 6185 -- Initialization_Statements (Node28)
8c7ff9a0 6186 -- BIP_Initialization_Call (Node29)
4ac2bbbd 6187 -- Last_Aggregate_Assignment (Node30)
3830827c 6188 -- Activation_Record_Component (Node31)
caf07df9 6189 -- Encapsulating_State (Node32)
19992053 6190 -- Linker_Section_Pragma (Node33)
6c3c671e 6191 -- Contract (Node34)
5b42c035 6192 -- Anonymous_Designated_Type (Node35)
3f6d1daa 6193 -- Validated_Object (Node38)
75b87c16 6194 -- SPARK_Pragma (Node40)
f937473f
RD
6195 -- Has_Alignment_Clause (Flag46)
6196 -- Has_Atomic_Components (Flag86)
6197 -- Has_Biased_Representation (Flag139)
28fa5430 6198 -- Has_Independent_Components (Flag34)
5d37ba92 6199 -- Has_Initial_Value (Flag219)
f937473f
RD
6200 -- Has_Size_Clause (Flag29)
6201 -- Has_Volatile_Components (Flag87)
f937473f 6202 -- Is_Atomic (Flag85)
90e491a7 6203 -- Is_Elaboration_Checks_OK_Id (Flag148)
162ed06f 6204 -- Is_Elaboration_Warnings_OK_Id (Flag304)
f937473f 6205 -- Is_Eliminated (Flag124)
937e9676
AC
6206 -- Is_Finalized_Transient (Flag252)
6207 -- Is_Ignored_Transient (Flag295)
8a52daee 6208 -- Is_Independent (Flag268)
c8d3b4ff 6209 -- Is_Return_Object (Flag209)
273adcdf 6210 -- Is_Safe_To_Reevaluate (Flag249)
f937473f
RD
6211 -- Is_Shared_Passive (Flag60)
6212 -- Is_True_Constant (Flag163)
f8dae9bb 6213 -- Is_Uplevel_Referenced_Entity (Flag283)
c8d3b4ff 6214 -- Is_Volatile (Flag16)
57abdadd 6215 -- Is_Volatile_Full_Access (Flag285)
d1f453b7 6216 -- OK_To_Rename (Flag247)
21d27997
RD
6217 -- Optimize_Alignment_Space (Flag241)
6218 -- Optimize_Alignment_Time (Flag242)
75b87c16 6219 -- SPARK_Pragma_Inherited (Flag265)
99425ec3 6220 -- Suppress_Initialization (Flag105)
21d27997 6221 -- Treat_As_Volatile (Flag41)
f937473f
RD
6222 -- Address_Clause (synth)
6223 -- Alignment_Clause (synth)
48688534 6224 -- Is_Elaboration_Target (synth)
b120ca61 6225 -- Is_Full_Access (synth)
f937473f 6226 -- Size_Clause (synth)
70482933
RK
6227
6228 -- E_Void
6229 -- Since E_Void is the initial Ekind value of an entity when it is first
6230 -- created, one might expect that no attributes would be defined on such
6231 -- an entity until its Ekind field is set. However, in practice, there
6232 -- are many instances in which fields of an E_Void entity are set in the
6233 -- code prior to setting the Ekind field. This is not well documented or
6234 -- well controlled, and needs cleaning up later. Meanwhile, the access
6235 -- procedures in the body of Einfo permit many, but not all, attributes
6236 -- to be applied to an E_Void entity, precisely so that this kind of
6237 -- pre-setting of attributes works. This is really a hole in the dynamic
6238 -- type checking, since there is no assurance that the eventual Ekind
6239 -- value will be appropriate for the attributes set, and the consequence
6240 -- is that the dynamic type checking in the Einfo body is unnecessarily
6241 -- weak. To be looked at systematically some time ???
76f9c7f4
BD
6242 --
6243 -- ???Following are examples of getters and setters called with E_Void:
6244 -- Entry_Formal $$$???
6245 -- Esize $$$???
6246 -- First_Entity $$$???
6247 -- Handler_Records $$$???
6248 -- Interface_Name $$$???
6249 -- Last_Entity $$$???
6250 -- Renamed_Entity $$$???
6251 -- Renamed_Object $$$???
6252 -- Scalar_Range $$$???
6253 -- Set_Associated_Node_For_Itype $$$???
6254 -- Set_Debug_Renaming_Link $$$???
6255 -- Set_Entry_Cancel_Parameter $$$???
6256 -- Set_First_Entity $$$???
6257 -- Set_Inner_Instances $$$???
6258 -- Set_Last_Entity $$$???
6259 -- Set_Scalar_Range $$$???
6260 -- Set_Entry_Cancel_Parameter $$$???
23c799b1 6261
70482933
RK
6262 ---------------
6263 -- Iterators --
6264 ---------------
6265
6266 -- In addition to attributes that are stored as plain data, other
6267 -- attributes are procedural, and require some small amount of
6268 -- computation. Of course, from the point of view of a user of this
6269 -- package, the distinction is not visible (even the field information
4ef36ac7
AC
6270 -- provided below should be disregarded, as it is subject to change
6271 -- without notice). A number of attributes appear as lists: lists of
6272 -- formals, lists of actuals, of discriminants, etc. For these, pairs
70482933
RK
6273 -- of functions are defined, which take the form:
6274
6275 -- function First_Thing (E : Enclosing_Construct) return Thing;
6276 -- function Next_Thing (T : Thing) return Thing;
6277
6278 -- The end of iteration is always signaled by a value of Empty, so that
6279 -- loops over these chains invariably have the form:
6280
6281 -- This : Thing;
6282 -- ...
6283 -- This := First_Thing (E);
6284
6285 -- while Present (This) loop
6286 -- Do_Something_With (This);
6287 -- ...
6288 -- This := Next_Thing (This);
6289 -- end loop;
6290
6291 -----------------------------------
6292 -- Handling of Check Suppression --
6293 -----------------------------------
6294
6295 -- There are three ways that checks can be suppressed:
6296
fbf5a39b
AC
6297 -- 1. At the command line level
6298 -- 2. At the scope level.
6299 -- 3. At the entity level.
70482933 6300
fbf5a39b
AC
6301 -- See spec of Sem in sem.ads for details of the data structures used
6302 -- to keep track of these various methods for suppressing checks.
70482933
RK
6303
6304 -------------------------------
6305 -- Handling of Discriminants --
6306 -------------------------------
6307
6308 -- During semantic processing, discriminants are separate entities which
6309 -- reflect the semantic properties and allowed usage of discriminants in
6310 -- the language.
6311
6312 -- In the case of discriminants used as bounds, the references are handled
6313 -- directly, since special processing is needed in any case. However, there
6314 -- are two circumstances in which discriminants are referenced in a quite
6315 -- general manner, like any other variables:
6316
6317 -- In initialization expressions for records. Note that the expressions
21d27997
RD
6318 -- used in Priority, Storage_Size, Task_Info and Relative_Deadline
6319 -- pragmas are effectively in this category, since these pragmas are
6320 -- converted to initialized record fields in the Corresponding_Record_
6321 -- Type.
70482933
RK
6322
6323 -- In task and protected bodies, where the discriminant values may be
6324 -- referenced freely within these bodies. Discriminants can also appear
6325 -- in bounds of entry families and in defaults of operations.
6326
6327 -- In both these cases, the discriminants must be treated essentially as
6328 -- objects. The following approach is used to simplify and minimize the
6329 -- special processing that is required.
6330
21d27997
RD
6331 -- When a record type with discriminants is analyzed, semantic processing
6332 -- creates the entities for the discriminants. It also creates additional
6333 -- sets of entities called discriminals, one for each of the discriminants,
6334 -- and the Discriminal field of the discriminant entity points to this
6335 -- additional entity, which is initially created as an uninitialized
6336 -- (E_Void) entity.
70482933
RK
6337
6338 -- During expansion of expressions, any discriminant reference is replaced
6339 -- by a reference to the corresponding discriminal. When the initialization
6340 -- procedure for the record is created (there will always be one, since
6341 -- discriminants are present, see Exp_Ch3 for further details), the
6342 -- discriminals are used as the entities for the formal parameters of
6343 -- this initialization procedure. The references to these discriminants
6344 -- have already been replaced by references to these discriminals, which
6345 -- are now the formal parameters corresponding to the required objects.
6346
21d27997
RD
6347 -- In the case of a task or protected body, the semantics similarly creates
6348 -- a set of discriminals for the discriminants of the task or protected
6349 -- type. When the procedure is created for the task body, the parameter
6350 -- passed in is a reference to the task value type, which contains the
6351 -- required discriminant values. The expander creates a set of declarations
6352 -- of the form:
70482933 6353
f3d0f304 6354 -- discr_nameD : constant discr_type renames _task.discr_name;
70482933 6355
21d27997
RD
6356 -- where discr_nameD is the discriminal entity referenced by the task
6357 -- discriminant, and _task is the task value passed in as the parameter.
70482933
RK
6358 -- Again, any references to discriminants in the task body have been
6359 -- replaced by the discriminal reference, which is now an object that
6360 -- contains the required value.
6361
6362 -- This approach for tasks means that two sets of discriminals are needed
6363 -- for a task type, one for the initialization procedure, and one for the
6364 -- task body. This works out nicely, since the semantics allocates one set
6365 -- for the task itself, and one set for the corresponding record.
6366
6367 -- The one bit of trickiness arises in making sure that the right set of
6368 -- discriminals is used at the right time. First the task definition is
6369 -- processed. Any references to discriminants here are replaced by the
21d27997
RD
6370 -- corresponding *task* discriminals (the record type doesn't even exist
6371 -- yet, since it is constructed as part of the expansion of the task
6372 -- declaration, which happens after the semantic processing of the task
6373 -- definition). The discriminants to be used for the corresponding record
6374 -- are created at the same time as the other discriminals, and held in the
6375 -- CR_Discriminant field of the discriminant. A use of the discriminant in
6376 -- a bound for an entry family is replaced with the CR_Discriminant because
6377 -- it controls the bound of the entry queue array which is a component of
6378 -- the corresponding record.
70482933
RK
6379
6380 -- Just before the record initialization routine is constructed, the
6381 -- expander exchanges the task and record discriminals. This has two
6382 -- effects. First the generation of the record initialization routine
6383 -- uses the discriminals that are now on the record, which is the set
6384 -- that used to be on the task, which is what we want.
6385
6386 -- Second, a new set of (so far unused) discriminals is now on the task
6387 -- discriminants, and it is this set that will be used for expanding the
6388 -- task body, and also for the discriminal declarations at the start of
6389 -- the task body.
6390
21d27997
RD
6391 ---------------------------------------------------
6392 -- Handling of private data in protected objects --
6393 ---------------------------------------------------
6394
6395 -- Private components in protected types pose problems similar to those
6396 -- of discriminants. Private data is visible and can be directly referenced
6397 -- from protected bodies. However, when protected entries and subprograms
6398 -- are expanded into corresponding bodies and barrier functions, private
6399 -- components lose their original context and visibility.
6400
6401 -- To remedy this side effect of expansion, private components are expanded
6402 -- into renamings called "privals", by analogy with "discriminals".
6403
6404 -- private_comp : comp_type renames _object.private_comp;
6405
6406 -- Prival declarations are inserted during the analysis of subprogram and
6407 -- entry bodies to ensure proper visibility for any subsequent expansion.
6408 -- _Object is the formal parameter of the generated corresponding body or
6409 -- a local renaming which denotes the protected object obtained from entry
6410 -- parameter _O. Privals receive minimal decoration upon creation and are
6411 -- categorized as either E_Variable for the general case or E_Constant when
6412 -- they appear in functions.
6413
6414 -- Along with the local declarations, each private component carries a
6415 -- placeholder which references the prival entity in the current body. This
6416 -- form of indirection is used to resolve name clashes of privals and other
6417 -- locally visible entities such as parameters, local objects, entry family
6418 -- indexes or identifiers used in the barrier condition.
6419
6420 -- When analyzing the statements of a protected subprogram or entry, any
6421 -- reference to a private component must resolve to the locally declared
6422 -- prival through normal visibility. In case of name conflicts (the cases
6423 -- above), the prival is marked as hidden and acts as a weakly declared
6424 -- entity. As a result, the reference points to the correct entity. When a
6425 -- private component is denoted by an expanded name (prot_type.comp for
6426 -- example), the expansion mechanism uses the placeholder of the component
6427 -- to correct the Entity and Etype of the reference.
70482933 6428
148c86d1
EB
6429 ----------------------------------
6430 -- Inline Pragmas for functions --
6431 ----------------------------------
70482933
RK
6432
6433 -- Note that these inline pragmas are referenced by the XEINFO utility
6434 -- program in preparing the corresponding C header, and only those
6435 -- subprograms meeting the requirements documented in the section on
6436 -- XEINFO may be referenced in this section.
76f9c7f4 6437 -- ????
70482933
RK
6438
6439end Einfo;