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