PR27116, Spelling errors found by Debian style checker
[official-gcc.git] / gcc / ada / einfo.ads
blob977392899f9233d951b9fb3cd26d329ead25fb0f
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- E I N F O --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2023, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
26 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_Designated_Type
430 -- Defined in variables which represent anonymous finalization masters.
431 -- Contains the designated type which is being serviced by the master.
433 -- Anonymous_Masters
434 -- Defined in packages, subprograms, and subprogram bodies. Contains a
435 -- list of anonymous finalization masters declared within the related
436 -- unit. The list acts as a mapping between a master and a designated
437 -- type.
439 -- Anonymous_Object
440 -- Present in protected and task type entities. Contains the entity of
441 -- the anonymous object created for a single protected or task type.
443 -- Associated_Entity
444 -- Defined in all entities. This field is similar to Associated_Node, but
445 -- applied to entities. The attribute links an entity from the generic
446 -- template with its corresponding entity in the analyzed generic copy.
447 -- The global references mechanism relies on the Associated_Entity to
448 -- infer the context.
450 -- Associated_Formal_Package
451 -- Defined in packages that are the actuals of formal_packages. Points
452 -- to the entity in the declaration for the formal package.
454 -- Associated_Node_For_Itype
455 -- Defined in all type and subtype entities. Set non-Empty only for
456 -- Itypes. Set to point to the associated node for the Itype, i.e.
457 -- the node whose elaboration generated the Itype. This is used for
458 -- copying trees, to determine whether or not to copy an Itype, and
459 -- also for accessibility checks on anonymous access types. This
460 -- node is typically an object declaration, component declaration,
461 -- type or subtype declaration.
463 -- For an access discriminant in a type declaration, the associated_
464 -- node_for_itype is the corresponding discriminant specification.
466 -- For an access parameter it is the enclosing subprogram declaration.
468 -- For an access_to_protected_subprogram parameter it is the declaration
469 -- of the corresponding formal parameter.
471 -- Itypes have no explicit declaration, and therefore are not attached to
472 -- the tree: their Parent field is always empty. The Associated_Node_For_
473 -- Itype is the only way to determine the construct that leads to the
474 -- creation of a given itype entity.
476 -- Associated_Storage_Pool [root type only]
477 -- Defined in simple and general access type entities. References the
478 -- storage pool to be used for the corresponding collection. A value of
479 -- Empty means that the default pool is to be used. This is defined
480 -- only in the root type, since derived types must have the same pool
481 -- as the parent type.
483 -- Barrier_Function
484 -- Defined in protected entries and entry families. This is the
485 -- subprogram declaration for the body of the function that returns
486 -- the value of the entry barrier.
488 -- Base_Type (synthesized)
489 -- Applies to all type and subtype entities. Returns the base type of a
490 -- type or subtype. The base type of a type is the type itself. The base
491 -- type of a subtype is the type that it constrains (which is always
492 -- a type entity, not some other subtype). Note that in the case of a
493 -- subtype of a private type, it is possible for the base type attribute
494 -- to return a private type, even if the subtype to which it applies is
495 -- non-private. See also Implementation_Base_Type. Note: it is allowed to
496 -- apply Base_Type to other than a type, in which case it simply returns
497 -- the entity unchanged.
499 -- Block_Node
500 -- Defined in block entities. Points to the identifier in the
501 -- Block_Statement itself. Used when retrieving the block construct
502 -- for finalization purposes, the block entity has an implicit label
503 -- declaration in the enclosing declarative part, and has otherwise
504 -- no direct connection in the tree with the block statement. The
505 -- link is to the identifier (which is an occurrence of the entity)
506 -- and not to the block_statement itself, because the statement may
507 -- be rewritten, e.g. in the process of removing dead code.
509 -- Body_Entity
510 -- Defined in package and generic package entities, points to the
511 -- corresponding package body entity if one is present.
513 -- Body_Needed_For_SAL
514 -- Defined in package and subprogram entities that are compilation
515 -- units. Indicates that the source for the body must be included
516 -- when the unit is part of a standalone library.
518 -- Body_Needed_For_Inlining
519 -- Defined in package entities that are compilation units. Used to
520 -- determine whether the body unit needs to be compiled when the
521 -- package declaration appears in the list of units to inline. A body
522 -- is needed for inline processing if the unit declaration contains
523 -- functions that carry pragma Inline or Inline_Always, or if it
524 -- contains a generic unit that requires a body.
526 -- Body_References
527 -- Defined in abstract state entities. Contains an element list of
528 -- references (identifiers) that appear in a package body whose spec
529 -- defines the related state. If the body refines the said state, all
530 -- references on this list are illegal due to the visible refinement.
532 -- BIP_Initialization_Call
533 -- Defined in constants and variables whose corresponding declaration
534 -- is wrapped in a transient block and the inital value is provided by
535 -- a build-in-place function call. Contains the relocated build-in-place
536 -- call after the expansion has decoupled the call from the object. This
537 -- attribute is used by the finalization machinery to insert cleanup code
538 -- for all additional transient objects found in the transient block.
540 -- C_Pass_By_Copy [implementation base type only]
541 -- Defined in record types. Set if a pragma Convention for the record
542 -- type specifies convention C_Pass_By_Copy. This convention name is
543 -- treated as identical in all respects to convention C, except that
544 -- if it is specified for a record type, then the C_Pass_By_Copy flag
545 -- is set, and if a foreign convention subprogram has a formal of the
546 -- corresponding type, then the parameter passing mechanism will be
547 -- set to By_Copy (unless specifically overridden by an Import or
548 -- Export pragma).
550 -- Can_Never_Be_Null
551 -- This flag is defined in all entities. It is set in an object which can
552 -- never have a null value. Set for constant access values initialized to
553 -- a non-null value. This is also set for all access parameters in Ada 83
554 -- and Ada 95 modes, and for access parameters that explicitly exclude
555 -- null in Ada 2005 mode.
557 -- This is used to avoid unnecessary resetting of the Is_Known_Non_Null
558 -- flag for such entities. In Ada 2005 mode, this is also used when
559 -- determining subtype conformance of subprogram profiles to ensure
560 -- that two formals have the same null-exclusion status.
562 -- This is also set on some access types, e.g. the Etype of the anonymous
563 -- access type of a controlling formal.
565 -- Can_Use_Internal_Rep [base type only]
566 -- Defined in Access_Subprogram_Kind nodes. This flag is set by the
567 -- front end and used by the backend. False means that the backend
568 -- must represent the type in the same way as Convention-C types (and
569 -- other foreign-convention types). On many targets, this means that
570 -- the backend will use dynamically generated trampolines for nested
571 -- subprograms. True means that the backend can represent the type in
572 -- some internal way. On the aforementioned targets, this means that the
573 -- backend will not use dynamically generated trampolines. This flag
574 -- must be False if Has_Foreign_Convention is True; otherwise, the front
575 -- end is free to set the policy.
577 -- Setting this False in all cases corresponds to the traditional back
578 -- end strategy, where all access-to-subprogram types are represented the
579 -- same way, independent of the Convention. For further details, see also
580 -- Always_Compatible_Rep in Targparm.
582 -- Efficiency note: On targets that use dynamically generated
583 -- trampolines, False generally favors efficiency of top-level
584 -- subprograms, whereas True generally favors efficiency of nested
585 -- ones. On other targets, this flag has little or no effect on
586 -- efficiency. The front end should take this into account. In
587 -- particular, pragma Favor_Top_Level gives a hint that the flag
588 -- should be False.
590 -- Note: We considered using Convention-C for this purpose, but we need
591 -- this separate flag, because Convention-C implies that in the case of
592 -- P'[Unrestricted_]Access, P also have convention C. Sometimes we want
593 -- to have Can_Use_Internal_Rep False for an access type, but allow P to
594 -- have convention Ada.
596 -- Chars
597 -- Defined in all entities. This field contains an entry into the names
598 -- table that has the character string of the identifier, character
599 -- literal or operator symbol. See Namet for further details. Note that
600 -- throughout the processing of the front end, this name is the simple
601 -- unqualified name. However, just before the backend is called, a call
602 -- is made to Qualify_All_Entity_Names. This causes entity names to be
603 -- qualified using the encoding described in exp_dbug.ads, and from that
604 -- point (including post backend steps, e.g. cross-reference generation),
605 -- the entities will contain the encoded qualified names.
607 -- Checks_May_Be_Suppressed
608 -- Defined in all entities. Set if a pragma Suppress or Unsuppress
609 -- mentions the entity specifically in the second argument. If this flag
610 -- is set the global and local suppress stacks must be consulted to
611 -- determine if there actually is an active Suppress or Unsuppress pragma
612 -- that applies to the entity.
614 -- Class_Postconditions
615 -- Defined on subprogram entities. Set if the subprogram has class-wide
616 -- postconditions. Denotes the (and-then) expression built by merging
617 -- inherited class-wide postconditions with its own class-wide
618 -- postconditions.
620 -- Class_Preconditions
621 -- Defined on subprogram entities. Set if the subprogram has class-wide
622 -- preconditions. Denotes the (or-else) expression built by merging
623 -- inherited class-wide preconditions with its own class-wide
624 -- preconditions.
626 -- Class_Preconditions_Subprogram
627 -- Defined on subprogram entities. Set on subprogram helpers and also on
628 -- the indirect-call wrapper internally built for subprograms that have
629 -- class-wide preconditions. References the subprogram that has the
630 -- class-wide preconditions.
632 -- Class_Wide_Type
633 -- Defined in all type entities. For a tagged type or subtype, returns
634 -- the corresponding implicitly declared class-wide type. For a
635 -- class-wide type, returns itself. Set to Empty for untagged types.
637 -- Cloned_Subtype
638 -- Defined in E_Record_Subtype and E_Class_Wide_Subtype entities.
639 -- Each such entity can either have a Discriminant_Constraint, in
640 -- which case it represents a distinct type from the base type (and
641 -- will have a list of components and discriminants in the list headed by
642 -- First_Entity) or else no such constraint, in which case it will be a
643 -- copy of the base type.
645 -- o Each element of the list in First_Entity is copied from the base
646 -- type; in that case, this field is Empty.
648 -- o The list in First_Entity is shared with the base type; in that
649 -- case, this field points to that entity.
651 -- A record or classwide subtype may also be a copy of some other
652 -- subtype and share the entities in the First_Entity with that subtype.
653 -- In that case, this field points to that subtype.
655 -- For E_Class_Wide_Subtype, the presence of Equivalent_Type overrides
656 -- this field. Note that this field ONLY appears in subtype entities, not
657 -- in type entities, it is not defined, and it is an error to reference
658 -- Cloned_Subtype in an E_Record_Type or E_Class_Wide_Type entity.
660 -- Comes_From_Source
661 -- This flag appears on all nodes, including entities, and indicates
662 -- that the node was created by the scanner or parser from the original
663 -- source. Thus for entities, it indicates that the entity is defined
664 -- in the original source program.
666 -- Component_Alignment (special field) [base type only]
667 -- Defined in array and record entities. Contains a value of type
668 -- Component_Alignment_Kind indicating the alignment of components.
669 -- Set to Calign_Default normally, but can be overridden by use of
670 -- the Component_Alignment pragma. Note: this field is currently
671 -- stored in a non-standard way, see body for details.
673 -- Component_Bit_Offset
674 -- Defined in record components (E_Component, E_Discriminant). First
675 -- bit position of given component, computed from the first bit and
676 -- position values given in the component clause. A value of No_Uint
677 -- means that the value is not yet known. The value can be set by the
678 -- appearance of an explicit component clause in a record representation
679 -- clause, or it can be set by the front-end in package Layout, or it can
680 -- be set by the backend. By the time backend processing is completed,
681 -- this field is always set. A negative value is used to represent
682 -- a value which is not known at compile time, and must be computed
683 -- at run-time (this happens if fields of a record have variable
684 -- lengths). See package Repinfo for details of these values.
686 -- Note: Component_Bit_Offset is redundant with respect to the fields
687 -- Normalized_First_Bit and Normalized_Position, and could in principle
688 -- be eliminated, but it is convenient in several situations, including
689 -- use in the backend, to have this redundant field.
691 -- Component_Clause
692 -- Defined in record components and discriminants. If a record
693 -- representation clause is present for the corresponding record type a
694 -- that specifies a position for the component, then the Component_Clause
695 -- field of the E_Component entity points to the N_Component_Clause node.
696 -- Set to Empty if no record representation clause was present, or if
697 -- there was no specification for this component.
699 -- Component_Size [implementation base type only]
700 -- Defined in array types. It contains the component size value for
701 -- the array. A value of No_Uint means that the value is not yet set.
702 -- The value can be set by the use of a component size clause, or
703 -- by the front end in package Layout, or by the backend. A negative
704 -- value is used to represent a value which is not known at compile
705 -- time, and must be computed at run-time (this happens if the type
706 -- of the component has a variable length size). See package Repinfo
707 -- for details of these values. Component_Size can also be negative in
708 -- an illegal program that says e.g. "for T'Component_Size use -8;".
710 -- Component_Type [implementation base type only]
711 -- Defined in array types and string types. References component type.
713 -- Contains_Ignored_Ghost_Code
714 -- Defined in blocks, packages and their bodies, subprograms and their
715 -- bodies. Set if the entity contains any ignored Ghost code in the form
716 -- of declaration, procedure call, assignment statement or pragma.
718 -- Contract
719 -- Defined in constant, entry, entry family, operator, [generic] package,
720 -- package body, protected unit, [generic] subprogram, subprogram body,
721 -- variable, task unit, and type entities. Points to the contract of the
722 -- entity, holding various assertion items and data classifiers.
724 -- Contract_Wrapper
725 -- Defined in entry and entry family entities. Set only when the entry
726 -- [family] has contract cases, preconditions, and/or postconditions.
727 -- Contains the entity of a wrapper procedure which encapsulates the
728 -- original entry and implements precondition/postcondition semantics.
730 -- Corresponding_Concurrent_Type
731 -- Defined in record types that are constructed by the expander to
732 -- represent task and protected types (Is_Concurrent_Record_Type flag
733 -- set). Points to the entity for the corresponding task type or the
734 -- protected type.
736 -- Corresponding_Discriminant
737 -- Defined in discriminants of a derived type, when the discriminant is
738 -- used to constrain a discriminant of the parent type. Points to the
739 -- corresponding discriminant in the parent type. Otherwise it is Empty.
741 -- Corresponding_Equality
742 -- Defined in function entities for implicit inequality operators.
743 -- Denotes the explicit or derived equality operation that creates
744 -- the implicit inequality. Note that this field is not present in
745 -- other function entities, only in implicit inequality routines,
746 -- where Comes_From_Source is always False.
748 -- Corresponding_Function
749 -- Defined on procedures internally built with an extra out parameter
750 -- to return a constrained array type, when Modify_Tree_For_C is set.
751 -- Denotes the function that returns the constrained array type for
752 -- which this procedure was built.
754 -- Corresponding_Procedure
755 -- Defined on functions that return a constrained array type, when
756 -- Modify_Tree_For_C is set. Denotes the internally built procedure
757 -- with an extra out parameter created for it.
759 -- Corresponding_Record_Component
760 -- Defined in components of a derived untagged record type, including
761 -- discriminants. For a regular component or a stored discriminant,
762 -- points to the corresponding component in the parent type. Set to
763 -- Empty for a non-stored discriminant. It is used by the back end to
764 -- ensure the layout of the derived type matches that of the parent
765 -- type when there is no representation clause on the derived type.
767 -- Corresponding_Record_Type
768 -- Defined in protected and task types and subtypes. References the
769 -- entity for the corresponding record type constructed by the expander
770 -- (see Exp_Ch9). This type is used to represent values of the task type.
772 -- Corresponding_Remote_Type
773 -- Defined in record types that describe the fat pointer structure for
774 -- Remote_Access_To_Subprogram types. References the original access
775 -- to subprogram type.
777 -- CR_Discriminant
778 -- Defined in discriminants of concurrent types. Denotes the homologous
779 -- discriminant of the corresponding record type. The CR_Discriminant is
780 -- created at the same time as the discriminal, and used to replace
781 -- occurrences of the discriminant within the type declaration.
783 -- Current_Use_Clause
784 -- Defined in packages and in types. For packages, denotes the use
785 -- package clause currently in scope that makes the package use_visible.
786 -- For types, it denotes the use_type clause that makes the operators of
787 -- the type visible. Used for more precise warning messages on redundant
788 -- use clauses.
790 -- Current_Value
791 -- Defined in all object entities. Set in E_Variable, E_Constant, formal
792 -- parameters and E_Loop_Parameter entities if we have trackable current
793 -- values. Set non-Empty if the (constant) current value of the variable
794 -- is known. This value is valid only for references from the same
795 -- sequential scope as the entity. The sequential scope of an entity
796 -- includes the immediate scope and any contained scopes that are package
797 -- specs, package bodies, blocks (at any nesting level) or statement
798 -- sequences in IF or loop statements.
800 -- Another related use of this field is to record information about the
801 -- value obtained from an IF or WHILE statement condition. If the IF or
802 -- ELSIF or WHILE condition has the form "NOT {,NOT] OBJ RELOP VAL ",
803 -- or OBJ [AND [THEN]] expr, where OBJ refers to an entity with a
804 -- Current_Value field, RELOP is one of the six relational operators, and
805 -- VAL is a compile-time known value then the Current_Value field of OBJ
806 -- points to the N_If_Statement, N_Elsif_Part, or N_Iteration_Scheme node
807 -- of the relevant construct, and the Condition field of this can be
808 -- consulted to give information about the value of OBJ. For more details
809 -- on this usage, see the procedure Exp_Util.Get_Current_Value_Condition.
811 -- Debug_Info_Off
812 -- Defined in all entities. Set if a pragma Suppress_Debug_Info applies
813 -- to the entity, or if internal processing in the compiler determines
814 -- that suppression of debug information is desirable. Note that this
815 -- flag is only for use by the front end as part of the processing for
816 -- determining if Needs_Debug_Info should be set. The backend should
817 -- always test Needs_Debug_Info, it should never test Debug_Info_Off.
819 -- Debug_Renaming_Link
820 -- Used to link the variable associated with a debug renaming declaration
821 -- to the renamed entity. See Exp_Dbug.Debug_Renaming_Declaration for
822 -- details of the use of this field.
824 -- Declaration_Node (synthesized)
825 -- Applies to all entities. Returns the tree node for the construct that
826 -- declared the entity. Normally this is just the Parent of the entity.
827 -- One exception arises with child units, where the parent of the entity
828 -- is a selected component/defining program unit name. Another exception
829 -- is that if the entity is an incomplete type that has been completed or
830 -- a private type, then we obtain the declaration node denoted by the
831 -- full type, i.e. the full type declaration node. Also note that for
832 -- subprograms, this returns the {function,procedure}_specification, not
833 -- the subprogram_declaration. If the parent of an Itype is a type or
834 -- subtype declaration, we return the declaration node as for any other
835 -- type. For other Itypes, we return Empty.
837 -- Default_Aspect_Component_Value [base type only]
838 -- Defined in array types. Holds the static value specified in a
839 -- Default_Component_Value aspect specification for the array type,
840 -- or inherited on derivation.
842 -- Default_Aspect_Value [base type only]
843 -- Defined in scalar types. Holds the static value specified in a
844 -- Default_Value aspect specification for the type, or inherited
845 -- on derivation.
847 -- Default_Expr_Function
848 -- Defined in parameters. It holds the entity of the parameterless
849 -- function that is built to evaluate the default expression if it is
850 -- more complex than a simple identifier or literal. For the latter
851 -- simple cases or if there is no default value, this field is Empty.
853 -- Default_Expressions_Processed
854 -- A flag in subprograms (functions, operators, procedures) and in
855 -- entries and entry families used to indicate that default expressions
856 -- have been processed and to avoid multiple calls to process the
857 -- default expressions (see Freeze.Process_Default_Expressions), which
858 -- would not only waste time, but also generate false error messages.
860 -- Default_Value
861 -- Defined in formal parameters. Points to the node representing the
862 -- expression for the default value for the parameter. Empty if the
863 -- parameter has no default value (which is always the case for OUT
864 -- and IN OUT parameters in the absence of errors).
866 -- Delay_Cleanups
867 -- Defined in entities that have finalization lists (subprograms, blocks
868 -- and tasks) or finalizers (package specs and bodies). Set if there are
869 -- pending package body instantiations for the corresponding entity. If
870 -- it is set, then generation of cleanup actions for the corresponding
871 -- entity must be delayed, since the insertion of the package bodies may
872 -- affect cleanup generation (see Inline for further details).
874 -- Delta_Value
875 -- Defined in fixed and decimal types. Points to a universal real
876 -- that holds value of delta for the type, as given in the declaration
877 -- or as inherited by a subtype or derived type.
879 -- Dependent_Instances
880 -- Defined in packages that are instances. Holds list of instances
881 -- of inner generics. Used to place freeze nodes for those instances
882 -- after that of the current one, i.e. after the corresponding generic
883 -- bodies.
885 -- Depends_On_Private
886 -- Defined in all type entities. Set if the type is private or if it
887 -- depends on a private type.
889 -- Derived_Type_Link
890 -- Defined in all type and subtype entities. Set in a base type if
891 -- a derived type declaration is encountered which derives from
892 -- this base type or one of its subtypes, and there are already
893 -- primitive operations declared. In this case, it references the
894 -- entity for the type declared by the derived type declaration.
895 -- For example:
897 -- type R is ...
898 -- subtype RS is R ...
899 -- ...
900 -- type G is new RS ...
902 -- In this case, if primitive operations have been declared for R, at
903 -- the point of declaration of G, then the Derived_Type_Link of R is set
904 -- to point to the entity for G. This is used to generate warnings and
905 -- errors for rep clauses that appear later on for R, which might result
906 -- in an unexpected (or illegal) implicit conversion operation.
908 -- Note: if there is more than one such derived type, the link will point
909 -- to the last one.
911 -- Designated_Type (synthesized)
912 -- Applies to access types. Returns the designated type. Differs from
913 -- Directly_Designated_Type in that if the access type refers to an
914 -- incomplete type, and the full type is available, then this full type
915 -- is returned instead of the incomplete type.
917 -- DIC_Procedure (synthesized)
918 -- Defined in all type entities. Set for a private type and its full view
919 -- when the type is subject to pragma Default_Initial_Condition (DIC), or
920 -- when the type inherits a DIC pragma from a parent type. Points to the
921 -- entity of a procedure which takes a single argument of the given type
922 -- and verifies the assertion expression of the DIC pragma at run time.
924 -- Note: the reason this is marked as a synthesized attribute is that the
925 -- way this is stored is as an element of the Subprograms_For_Type field.
927 -- Digits_Value
928 -- Defined in floating point types and subtypes and decimal types and
929 -- subtypes. Contains the Digits value specified in the declaration.
931 -- Direct_Primitive_Operations
932 -- Defined in tagged types and subtypes (including synchronized types),
933 -- in tagged private types, and in tagged incomplete types. Moreover, it
934 -- is also defined for untagged types, both when Extensions_Allowed is
935 -- True (-gnatX) to support the extension feature of prefixed calls for
936 -- untagged types, and when Extensions_Allowed is False to get better
937 -- error messages. This field is an element list of entities for
938 -- primitive operations of the type. For incomplete types the list is
939 -- always empty. In order to follow the C++ ABI, entities of primitives
940 -- that come from source must be stored in this list in the order of
941 -- their occurrence in the sources. When expansion is disabled, the
942 -- corresponding record type of a synchronized type is not constructed.
943 -- In that case, such types carry this attribute directly.
945 -- Directly_Designated_Type
946 -- Defined in access types. This field points to the type that is
947 -- directly designated by the access type. In the case of an access
948 -- type to an incomplete type, this field references the incomplete
949 -- type. Directly_Designated_Type is typically used in implementing the
950 -- static semantics of the language; in implementing dynamic semantics,
951 -- we typically want the full view of the designated type. The function
952 -- Designated_Type obtains this full type in the case of access to an
953 -- incomplete type.
955 -- Disable_Controlled [base type only]
956 -- Present in all entities. Set for a controlled type subject to aspect
957 -- Disable_Controlled which evaluates to True. This flag is taken into
958 -- account in synthesized attribute Is_Controlled.
960 -- Discard_Names
961 -- Defined in types and exception entities. Set if pragma Discard_Names
962 -- applies to the entity. It is also set for declarative regions and
963 -- package specs for which a Discard_Names pragma with zero arguments
964 -- has been encountered. The purpose of setting this flag is to be able
965 -- to set the Discard_Names attribute on enumeration types declared
966 -- after the pragma within the same declarative region. This flag is
967 -- set to False if a Keep_Names pragma appears for an enumeration type.
969 -- Discriminal
970 -- Defined in discriminants (Discriminant formal: GNAT's first
971 -- coinage). The entity used as a formal parameter that corresponds
972 -- to a discriminant. See section "Handling of Discriminants" for
973 -- full details of the use of discriminals.
975 -- Discriminal_Link
976 -- Defined in E_In_Parameter or E_Constant entities. For discriminals,
977 -- points back to corresponding discriminant. For other entities, must
978 -- remain Empty.
980 -- Discriminant_Checking_Func
981 -- Defined in components. Points to the defining identifier of the
982 -- function built by the expander returns a Boolean indicating whether
983 -- the given record component exists for the current discriminant
984 -- values.
986 -- Discriminant_Constraint
987 -- Defined in entities whose Has_Discriminants flag is set (concurrent
988 -- types, subtypes, record types and subtypes, private types and
989 -- subtypes, limited private types and subtypes and incomplete types).
990 -- It is an error to reference the Discriminant_Constraint field if
991 -- Has_Discriminants is False.
993 -- If the Is_Constrained flag is set, Discriminant_Constraint points
994 -- to an element list containing the discriminant constraints in the
995 -- same order in which the discriminants are declared.
997 -- If the Is_Constrained flag is not set but the discriminants of the
998 -- unconstrained type have default initial values then this field
999 -- points to an element list giving these default initial values in
1000 -- the same order in which the discriminants are declared. Note that
1001 -- in this case the entity cannot be a tagged record type, because
1002 -- discriminants in this case cannot have defaults.
1004 -- If the entity is a tagged record implicit type, then this field is
1005 -- inherited from the first subtype (so that the itype is subtype
1006 -- conformant with its first subtype, which is needed when the first
1007 -- subtype overrides primitive operations inherited by the implicit
1008 -- base type).
1010 -- In all other cases Discriminant_Constraint contains the empty
1011 -- Elist (i.e. it is initialized with a call to New_Elmt_List).
1013 -- Discriminant_Default_Value
1014 -- Defined in discriminants. Points to the node representing the
1015 -- expression for the default value of the discriminant. Set to
1016 -- Empty if the discriminant has no default value.
1018 -- Discriminant_Number
1019 -- Defined in discriminants. Gives the ranking of a discriminant in
1020 -- the list of discriminants of the type, i.e. a sequential integer
1021 -- index starting at 1 and ranging up to number of discriminants.
1023 -- Dispatch_Table_Wrappers [implementation base type only]
1024 -- Defined in E_Record_Type and E_Record_Subtype entities. Set in library
1025 -- level tagged type entities if we are generating statically allocated
1026 -- dispatch tables. Points to the list of dispatch table wrappers
1027 -- associated with the tagged type. For an untagged record, contains
1028 -- No_Elist.
1030 -- Dynamic_Call_Helper
1031 -- Defined on subprogram entities. Set if the subprogram has class-wide
1032 -- preconditions. Denotes the helper that evaluates at run time the
1033 -- class-wide preconditions performing dispatching calls.
1035 -- DTC_Entity
1036 -- Defined in function and procedure entities. Set to Empty unless
1037 -- the subprogram is dispatching in which case it references the
1038 -- Dispatch Table pointer Component. For regular Ada tagged this, this
1039 -- is the _Tag component. For CPP_Class types and their descendants,
1040 -- this points to the component entity in the record that holds the
1041 -- Vtable pointer for the Vtable containing the entry referencing the
1042 -- subprogram.
1044 -- DT_Entry_Count
1045 -- Defined in E_Component entities. Only used for component marked
1046 -- Is_Tag. Store the number of entries in the Vtable (or Dispatch Table)
1048 -- DT_Offset_To_Top_Func
1049 -- Defined in E_Component entities. Only used for component marked
1050 -- Is_Tag. If present it stores the Offset_To_Top function used to
1051 -- provide this value in tagged types whose ancestor has discriminants.
1053 -- DT_Position
1054 -- Defined in function and procedure entities which are dispatching
1055 -- (should not be referenced without first checking that flag
1056 -- Is_Dispatching_Operation is True). Contains the offset into
1057 -- the Vtable for the entry that references the subprogram.
1059 -- Ekind (Ekind)
1060 -- Defined in all entities. Contains a value of the enumeration type
1061 -- Entity_Kind declared in a subsequent section in this spec.
1063 -- Elaborate_Body_Desirable
1064 -- Defined in package entities. Set if the elaboration circuitry detects
1065 -- a case where there is a package body that modifies one or more visible
1066 -- entities in the package spec and there is no explicit Elaborate_Body
1067 -- pragma for the package. This information is passed on to the binder,
1068 -- which attempts, but does not promise, to elaborate the body as close
1069 -- to the spec as possible.
1071 -- Elaboration_Entity
1072 -- Defined in entry, entry family, [generic] package, and subprogram
1073 -- entities. This is a counter associated with the unit that is initially
1074 -- set to zero, is incremented when an elaboration request for the unit
1075 -- is made, and is decremented when a finalization request for the unit
1076 -- is made. This is used for three purposes. First, it is used to
1077 -- implement access before elaboration checks (the counter must be
1078 -- non-zero to call a subprogram at elaboration time). Second, it is
1079 -- used to guard against repeated execution of the elaboration code.
1080 -- Third, it is used to ensure that the finalization code is executed
1081 -- only after all clients have requested it.
1083 -- Note that we always allocate this counter, and set this field, but
1084 -- we do not always actually use it. It is only used if it is needed
1085 -- for access before elaboration use (see Elaboration_Entity_Required
1086 -- flag) or if either the spec or the body has elaboration code. If
1087 -- neither of these two conditions holds, then the entity is still
1088 -- allocated (since we don't know early enough whether or not there
1089 -- is elaboration code), but is simply not used for any purpose.
1091 -- Elaboration_Entity_Required
1092 -- Defined in entry, entry family, [generic] package, and subprogram
1093 -- entities. Set only if Elaboration_Entity is non-Empty to indicate that
1094 -- the counter is required to be non-zero even if there is no other
1095 -- elaboration code. This occurs when the Elaboration_Entity counter
1096 -- is used for access before elaboration checks. If the counter is
1097 -- only used to prevent multiple execution of the elaboration code,
1098 -- then if there is no other elaboration code, obviously there is no
1099 -- need to set the flag.
1101 -- Encapsulating_State
1102 -- Defined in abstract state, constant and variable entities. Contains
1103 -- the entity of an ancestor state or a single concurrent type whose
1104 -- refinement utilizes this item as a constituent.
1106 -- Enclosing_Scope
1107 -- Defined in labels. Denotes the innermost enclosing construct that
1108 -- contains the label. Identical to the scope of the label, except for
1109 -- labels declared in the body of an accept statement, in which case the
1110 -- entry_name is the Enclosing_Scope. Used to validate goto's within
1111 -- accept statements.
1113 -- Entry_Accepted
1114 -- Defined in E_Entry and E_Entry_Family entities. Set if there is
1115 -- at least one accept for this entry in the task body. Used to
1116 -- generate warnings for missing accepts.
1118 -- Entry_Bodies_Array
1119 -- Defined in protected types for which Has_Entries is true.
1120 -- This is the defining identifier for the array of entry body
1121 -- action procedures and barrier functions used by the runtime to
1122 -- execute the user code associated with each entry.
1124 -- Entry_Cancel_Parameter
1125 -- Defined in blocks. This only applies to a block statement for
1126 -- which the Is_Asynchronous_Call_Block flag is set. It
1127 -- contains the defining identifier of an object that must be
1128 -- passed to the Cancel_Task_Entry_Call or Cancel_Protected_Entry_Call
1129 -- call in the cleanup handler added to the block by
1130 -- Exp_Ch7.Expand_Cleanup_Actions. This parameter is a Boolean
1131 -- object for task entry calls and a Communications_Block object
1132 -- in the case of protected entry calls. In both cases the objects
1133 -- are declared in outer scopes to this block.
1134 -- This is also defined in labels, because we temporarily set the
1135 -- Ekind of an E_Block to E_Label in Analyze_Implicit_Label_Declaration.
1137 -- Entry_Component
1138 -- Defined in formal parameters (in, in out and out parameters). Used
1139 -- only for formals of entries. References the corresponding component
1140 -- of the entry parameter record for the entry.
1142 -- Entry_Formal
1143 -- Defined in components of the record built to correspond to entry
1144 -- parameters. This field points from the component to the formal. It
1145 -- is the back pointer corresponding to Entry_Component.
1147 -- Entry_Index_Constant
1148 -- Defined in an entry index parameter. This is an identifier that
1149 -- eventually becomes the name of a constant representing the index
1150 -- of the entry family member whose entry body is being executed. Used
1151 -- to expand references to the entry index specification identifier.
1153 -- Entry_Index_Type (synthesized)
1154 -- Applies to an entry family. Denotes Etype of the subtype indication
1155 -- in the entry declaration. Used to resolve the index expression in an
1156 -- accept statement for a member of the family, and in the prefix of
1157 -- 'COUNT when it applies to a family member.
1159 -- Entry_Max_Queue_Lengths_Array
1160 -- Defined in protected types for which Has_Entries is true. Contains the
1161 -- defining identifier for the array of naturals used by the runtime to
1162 -- limit the queue size of each entry individually.
1164 -- Entry_Parameters_Type
1165 -- Defined in entries. Points to the access-to-record type that is
1166 -- constructed by the expander to hold a reference to the parameter
1167 -- values. This reference is manipulated (as an address) by the
1168 -- tasking runtime. The designated record represents a packaging
1169 -- up of the entry parameters (see Exp_Ch9.Expand_N_Entry_Declaration
1170 -- for further details). Entry_Parameters_Type is Empty if the entry
1171 -- has no parameters.
1173 -- Enumeration_Pos
1174 -- Defined in enumeration literals. Contains the position number
1175 -- corresponding to the value of the enumeration literal.
1177 -- Enumeration_Rep
1178 -- Defined in enumeration literals. Contains the representation that
1179 -- corresponds to the value of the enumeration literal. Note that
1180 -- this is normally the same as Enumeration_Pos except in the presence
1181 -- of representation clauses, where Pos will still represent the
1182 -- position of the literal within the type and Rep will have be the
1183 -- value given in the representation clause.
1185 -- Enumeration_Rep_Expr
1186 -- Defined in enumeration literals. Points to the expression in an
1187 -- associated enumeration rep clause that provides the representation
1188 -- value for this literal. Empty if no enumeration rep clause for this
1189 -- literal (or if rep clause does not have an entry for this literal,
1190 -- an error situation). This is also used to catch duplicate entries
1191 -- for the same literal.
1193 -- Enum_Pos_To_Rep
1194 -- Defined in enumeration types, but not enumeration subtypes. Set to
1195 -- Empty unless the enumeration type has a non-standard representation,
1196 -- i.e. at least one literal has a representation value different from
1197 -- its position value. In this case, the alternative is the following:
1198 -- if the representation is not contiguous, then Enum_Pos_To_Rep is the
1199 -- entity for an array constant built when the type is frozen that maps
1200 -- Pos values to corresponding Rep values, whose index type is Natural
1201 -- and whose component type is the enumeration type itself; or else, if
1202 -- the representation is contiguous, then Enum_Pos_To_Rep is the entity
1203 -- of the index type defined above.
1205 -- Equivalent_Type
1206 -- Defined in class wide types and subtypes, access to protected
1207 -- subprogram types, and in exception types. For a classwide type, it
1208 -- is always Empty. For a class wide subtype, it points to an entity
1209 -- created by the expander which gives the backend an understandable
1210 -- equivalent of the class subtype with a known size (given by an
1211 -- initial value). See Exp_Util.Expand_Class_Wide_Subtype for further
1212 -- details. For E_Exception_Type, this points to the record containing
1213 -- the data necessary to represent exceptions (for further details, see
1214 -- System.Standard_Library). For access to protected subprograms, it
1215 -- denotes a record that holds pointers to the operation and to the
1216 -- protected object. For remote Access_To_Subprogram types, it denotes
1217 -- the record that is the fat pointer representation of an RAST.
1219 -- Esize
1220 -- Defined in all types and subtypes, and also for components, constants,
1221 -- and variables, including exceptions where it refers to the static data
1222 -- allocated for an exception. Contains the Object_Size of the type or of
1223 -- the object. A value of zero indicates that the value is not yet known.
1225 -- For the case of components where a component clause is present, the
1226 -- value is the value from the component clause, which must be non-
1227 -- negative (but may be zero, which is acceptable for the case of
1228 -- a type with only one possible value). It is also possible for Esize
1229 -- of a component to be set without a component clause defined, which
1230 -- means that the component size is specified, but not the position.
1231 -- See also RM_Size and the section on "Handling of Type'Size Values".
1232 -- During backend processing, the value is back annotated for all zero
1233 -- values, so that after the call to the backend, the value is set.
1235 -- Etype
1236 -- Defined in all entities. Represents the type of the entity, which
1237 -- is itself another entity. For a type entity, points to the parent
1238 -- type for a derived type, or if the type is not derived, points to
1239 -- itself. For a subtype entity, Etype points to the base type. For
1240 -- a class wide type, points to the corresponding specific type. For a
1241 -- subprogram or subprogram type, Etype has the return type of a function
1242 -- or is set to Standard_Void_Type to represent a procedure. The Etype
1243 -- field of a package is also set to Standard_Void_Type.
1245 -- Note one obscure case: for pragma Default_Storage_Pool (null), the
1246 -- Etype of the N_Null node is Empty.
1248 -- Extra_Accessibility
1249 -- Defined in formal parameters in the non-generic case. Normally Empty,
1250 -- but if expansion is active, and a parameter is one for which a
1251 -- dynamic accessibility check is required, then an extra formal of type
1252 -- Natural is created (see description of field Extra_Formal), and the
1253 -- Extra_Accessibility field of the formal parameter points to the entity
1254 -- for this extra formal. Also defined in variables when compiling
1255 -- receiving stubs. In this case, a non Empty value means that this
1256 -- variable's accessibility depth has been transmitted by the caller and
1257 -- must be retrieved through the entity designed by this field instead of
1258 -- being computed.
1260 -- Extra_Accessibility_Of_Result
1261 -- Defined in (non-generic) Function, Operator, and Subprogram_Type
1262 -- entities. Normally Empty, but if expansion is active, and a function
1263 -- is one for which "the accessibility level of the result ... determined
1264 -- by the point of call" (AI05-0234) is needed, then an extra formal of
1265 -- subtype Natural is created (see description of field Extra_Formal),
1266 -- and the Extra_Accessibility_Of_Result field of the function points to
1267 -- the entity for this extra formal.
1269 -- Extra_Constrained
1270 -- Defined in formal parameters in the non-generic case. Normally Empty,
1271 -- but if expansion is active and a parameter is one for which a dynamic
1272 -- indication of its constrained status is required, then an extra formal
1273 -- of type Boolean is created (see description of field Extra_Formal),
1274 -- and the Extra_Constrained field of the formal parameter points to the
1275 -- entity for this extra formal. Also defined in variables when compiling
1276 -- receiving stubs. In this case, a non empty value means that this
1277 -- variable's constrained status has been transmitted by the caller and
1278 -- must be retrieved through the entity designed by this field instead of
1279 -- being computed.
1281 -- Extra_Formal
1282 -- Defined in formal parameters in the non-generic case. Certain
1283 -- parameters require extra implicit information to be passed (e.g. the
1284 -- flag indicating if an unconstrained variant record argument is
1285 -- constrained, and the accessibility level for access parameters). See
1286 -- description of Extra_Constrained, Extra_Accessibility fields for
1287 -- further details. Extra formal parameters are constructed to represent
1288 -- these values, and chained to the end of the list of formals using the
1289 -- Extra_Formal field (i.e. the Extra_Formal field of the last "real"
1290 -- formal points to the first extra formal, and the Extra_Formal field of
1291 -- each extra formal points to the next one, with Empty indicating the
1292 -- end of the list of extra formals). Another case of Extra_Formal arises
1293 -- in connection with unnesting of subprograms, where the ARECnF formal
1294 -- that represents an activation record pointer is an extra formal.
1296 -- Extra_Formals
1297 -- Applies to subprograms, subprogram types, entries, and entry
1298 -- families. Returns first extra formal of the subprogram or entry.
1299 -- Returns Empty if there are no extra formals.
1301 -- Finalization_Master [root type only]
1302 -- Defined in access-to-controlled or access-to-class-wide types. The
1303 -- field contains the entity of the finalization master which handles
1304 -- dynamically allocated controlled objects referenced by the access
1305 -- type. Empty for access-to-subprogram types. Empty for access types
1306 -- whose designated type does not need finalization actions.
1308 -- Finalize_Storage_Only [base type only]
1309 -- Defined in all types. Set on direct controlled types to which a
1310 -- valid Finalize_Storage_Only pragma applies. This flag is also set on
1311 -- composite types when they have at least one controlled component and
1312 -- all their controlled components are Finalize_Storage_Only. It is also
1313 -- inherited by type derivation except for direct controlled types where
1314 -- the Finalize_Storage_Only pragma is required at each level of
1315 -- derivation.
1317 -- Finalizer
1318 -- Applies to package declarations and bodies. Contains the entity of the
1319 -- library-level program which finalizes all package-level controlled
1320 -- objects.
1322 -- First_Component (synthesized)
1323 -- Applies to incomplete, private, protected, record and task types.
1324 -- Returns the first component by following the chain of declared
1325 -- entities for the type a component is found (one with an Ekind of
1326 -- E_Component). The discriminants are skipped. If the record is null,
1327 -- then Empty is returned.
1329 -- First_Component_Or_Discriminant (synthesized)
1330 -- Similar to First_Component, but discriminants are not skipped, so will
1331 -- find the first discriminant if discriminants are present.
1333 -- First_Entity
1334 -- Defined in all entities that act as scopes to which a list of
1335 -- associated entities is attached, and also in all [sub]types. Some
1336 -- entities are both; for example E_Record_Type acts as a scope and
1337 -- is a type. [Sub]types that do not act as scopes (e.g. scalars) are
1338 -- included to make it more convenient to Mutate_Entity between type
1339 -- kinds. Points to a list of associated entities linked through the
1340 -- Next_Entity field with Empty marking end-of-list.
1341 -- See also Last_Entity.
1343 -- First_Exit_Statement
1344 -- Defined in E_Loop entity. The exit statements for a loop are chained
1345 -- (in reverse order of appearance) using this field to point to the
1346 -- first entry in the chain (last exit statement in the loop). The
1347 -- entries are chained through the Next_Exit_Statement field of the
1348 -- N_Exit_Statement node with Empty marking the end of the list.
1350 -- First_Formal (synthesized)
1351 -- Applies to subprograms and subprogram types, and also to entries
1352 -- and entry families. Returns first formal of the subprogram or entry.
1353 -- The formals are the first entities declared in a subprogram or in
1354 -- a subprogram type (the designated type of an Access_To_Subprogram
1355 -- definition) or in an entry.
1357 -- First_Formal_With_Extras (synthesized)
1358 -- Applies to subprograms and subprogram types, and also in entries
1359 -- and entry families. Returns first formal of the subprogram or entry.
1360 -- Returns Empty if there are no formals. The list returned includes
1361 -- all the extra formals (see description of Extra_Formals field).
1363 -- First_Index
1364 -- Defined in array types and subtypes. By introducing implicit subtypes
1365 -- for the index constraints, we have the same structure for constrained
1366 -- and unconstrained arrays, subtype marks and discrete ranges are
1367 -- both represented by a subtype. This function returns the tree node
1368 -- corresponding to an occurrence of the first index (NOT the entity for
1369 -- the type). Subsequent indices are obtained using Next_Index. Note that
1370 -- this field is defined for the case of string literal subtypes, but is
1371 -- always Empty.
1373 -- First_Literal
1374 -- Defined in all enumeration types, including character and boolean
1375 -- types. This field points to the first enumeration literal entity
1376 -- for the type (i.e. it is set to First (Literals (N)) where N is
1377 -- the enumeration type definition node. A special case occurs with
1378 -- standard character and wide character types, where this field is
1379 -- Empty, since there are no enumeration literal lists in these cases.
1380 -- Note that this field is set in enumeration subtypes, but it still
1381 -- points to the first literal of the base type in this case.
1383 -- First_Private_Entity
1384 -- Defined in all entities containing private parts (packages, protected
1385 -- types and subtypes, task types and subtypes). The entities on the
1386 -- entity chain are in order of declaration, so the entries for private
1387 -- entities are at the end of the chain. This field points to the first
1388 -- entity for the private part. It is Empty if there are no entities
1389 -- declared in the private part or if there is no private part.
1391 -- First_Rep_Item
1392 -- Defined in all entities. If non-empty, points to a linked list of
1393 -- representation pragmas nodes and representation clause nodes that
1394 -- apply to the entity, linked using Next_Rep_Item, with Empty marking
1395 -- the end of the list. In the case of derived types and subtypes, the
1396 -- new entity inherits the chain at the point of declaration. This means
1397 -- that it is possible to have multiple instances of the same kind of rep
1398 -- item on the chain, in which case it is the first one that applies to
1399 -- the entity.
1401 -- Note: pragmas that can apply to more than one overloadable entity,
1402 -- (Convention, Interface, Inline, Inline_Always, Import, Export,
1403 -- External) are never present on this chain when they apply to
1404 -- overloadable entities, since it is impossible for a given pragma
1405 -- to be on more than one chain at a time.
1407 -- For most representation items, the representation information is
1408 -- reflected in other fields and flags in the entity. For example if a
1409 -- record representation clause is present, the component entities
1410 -- reflect the specified information. However, there are some items that
1411 -- are only reflected in the chain. These include:
1413 -- Machine_Attribute pragma
1414 -- Link_Alias pragma
1415 -- Linker_Constructor pragma
1416 -- Linker_Destructor pragma
1417 -- Weak_External pragma
1418 -- Thread_Local_Storage pragma
1420 -- If any of these items are present, then the flag Has_Gigi_Rep_Item is
1421 -- set, indicating that the backend should search the chain.
1423 -- Other representation items are included in the chain so that error
1424 -- messages can easily locate the relevant nodes for posting errors.
1425 -- Note in particular that size clauses are defined only for this
1426 -- purpose, and should only be accessed if Has_Size_Clause is set.
1428 -- Float_Rep [base type only]
1429 -- Defined in floating-point entities. Contains a value of type
1430 -- Float_Rep_Kind. Together with the Digits_Value uniquely defines
1431 -- the floating-point representation to be used.
1433 -- Freeze_Node
1434 -- Defined in all entities. If there is an associated freeze node for the
1435 -- entity, this field references this freeze node. If no freeze node is
1436 -- associated with the entity, then this field is Empty. See package
1437 -- Freeze for further details.
1439 -- From_Limited_With
1440 -- Defined in abtract states, package and type entities. Set to True when
1441 -- the related entity is generated by the expansion of a limited with
1442 -- clause. Such an entity is said to be a "shadow" - it acts as the
1443 -- abstract view of a state or variable or as the incomplete view of a
1444 -- type by inheriting relevant attributes from the said entity.
1446 -- Full_View
1447 -- Defined in all type and subtype entities and in deferred constants.
1448 -- References the entity for the corresponding full type or constant
1449 -- declaration. For all types other than private and incomplete types,
1450 -- this field always contains Empty. If an incomplete type E1 is
1451 -- completed by a private type E2 whose full type declaration entity is
1452 -- E3 then the full view of E1 is E2, and the full view of E2 is E3. See
1453 -- also Underlying_Type.
1455 -- Generic_Homonym
1456 -- Defined in generic packages. The generic homonym is the entity of
1457 -- a renaming declaration inserted in every generic unit. It is used
1458 -- to resolve the name of a local entity that is given by a qualified
1459 -- name, when the generic entity itself is hidden by a local name.
1461 -- Generic_Renamings
1462 -- Defined in package and subprogram instances. Holds mapping that
1463 -- associates generic parameters with the corresponding instances, in
1464 -- those cases where the instance is an entity.
1466 -- Handler_Records
1467 -- Defined in subprogram and package entities. Points to a list of
1468 -- identifiers referencing the handler record entities for the
1469 -- corresponding unit.
1471 -- Has_Aliased_Components [implementation base type only]
1472 -- Defined in array type entities. Indicates that the component type
1473 -- of the array is aliased. Should this also be set for records to
1474 -- indicate that at least one component is aliased (see processing in
1475 -- Sem_Prag.Process_Atomic_Independent_Shared_Volatile???)
1477 -- Has_Alignment_Clause
1478 -- Defined in all type entities and objects. Indicates if an alignment
1479 -- clause has been given for the entity. If set, then Alignment_Clause
1480 -- returns the N_Attribute_Definition node for the alignment attribute
1481 -- definition clause. Note that it is possible for this flag to be False
1482 -- even when Alignment_Clause returns non_Empty (this happens in the case
1483 -- of derived type declarations).
1485 -- Has_All_Calls_Remote
1486 -- Defined in all library unit entities. Set if the library unit has an
1487 -- All_Calls_Remote pragma. Note that such entities must also be RCI
1488 -- entities, so the flag Is_Remote_Call_Interface will always be set if
1489 -- this flag is set.
1491 -- Has_Atomic_Components [implementation base type only]
1492 -- Defined in all types and objects. Set only for an array type or
1493 -- an array object if a valid pragma Atomic_Components applies to the
1494 -- type or object. Note that in the case of an object, this flag is
1495 -- only set on the object if there was an explicit pragma for the
1496 -- object. In other words, the proper test for whether an object has
1497 -- atomic components is to see if either the object or its base type
1498 -- has this flag set. Note that in the case of a type, the pragma will
1499 -- be chained to the rep item chain of the first subtype in the usual
1500 -- manner.
1502 -- Has_Attach_Handler (synthesized)
1503 -- Applies to record types that are constructed by the expander to
1504 -- represent protected types. Returns True if there is at least one
1505 -- Attach_Handler pragma in the corresponding specification.
1507 -- Has_Biased_Representation
1508 -- Defined in discrete types (where it applies to the type'size value),
1509 -- and to objects (both stand-alone and components), where it applies to
1510 -- the size of the object from a size or record component clause. In
1511 -- all cases it indicates that the size in question is smaller than
1512 -- would normally be required, but that the size requirement can be
1513 -- satisfied by using a biased representation, in which stored values
1514 -- have the low bound (Expr_Value (Type_Low_Bound (T)) subtracted to
1515 -- reduce the required size. For example, a type with a range of 1..2
1516 -- takes one bit, using 0 to represent 1 and 1 to represent 2.
1518 -- Note that in the object and component cases, the flag is only set if
1519 -- the type is unbiased, but the object specifies a smaller size than the
1520 -- size of the type, forcing biased representation for the object, but
1521 -- the subtype is still an unbiased type.
1523 -- Has_Completion
1524 -- Defined in all entities that require a completion (functions,
1525 -- procedures, private types, limited private types, incomplete types,
1526 -- constants and packages that require a body). The flag is set if the
1527 -- completion has been encountered and analyzed.
1529 -- Has_Completion_In_Body
1530 -- Defined in all entities for types and subtypes. Set only in "Taft
1531 -- amendment types" (incomplete types whose full declaration appears in
1532 -- the package body).
1534 -- Has_Complex_Representation [implementation base type only]
1535 -- Defined in record types. Set only for a base type to which a valid
1536 -- pragma Complex_Representation applies.
1538 -- Has_Component_Size_Clause [implementation base type only]
1539 -- Defined in all type entities. Set if a component size clause is
1540 -- Defined for the given type. Note that this flag can be False even
1541 -- if Component_Size is non-zero (happens in the case of derived types).
1543 -- Has_Constrained_Partial_View [base type only]
1544 -- Defined in private type and their completions, when the private
1545 -- type has no discriminants and the full view has discriminants with
1546 -- defaults. In Ada 2005 heap-allocated objects of such types are not
1547 -- constrained, and can change their discriminants with full assignment.
1549 -- Ada 2012 has an additional rule (3.3. (23/10.3)) concerning objects
1550 -- declared in a generic package body. Objects whose type is an untagged
1551 -- generic formal private type are considered to have a constrained
1552 -- partial view. The predicate Object_Type_Has_Constrained_Partial_View
1553 -- in sem_aux is used to test for this case.
1555 -- Has_Contiguous_Rep
1556 -- Defined in enumeration types. Set if the type has a representation
1557 -- clause whose entries are successive integers.
1559 -- Has_Controlled_Component [base type only]
1560 -- Defined in all type and subtype entities. Set only for composite type
1561 -- entities which contain a component that either is a controlled type,
1562 -- or itself contains controlled component (i.e. either Is_Controlled or
1563 -- Has_Controlled_Component is set for at least one component).
1565 -- Has_Controlling_Result
1566 -- Defined in E_Function entities. Set if the function is a primitive
1567 -- function of a tagged type which can dispatch on result. Also set on
1568 -- secondary stack thunks built for such a primitive function.
1570 -- Has_Convention_Pragma
1571 -- Defined in all entities. Set for an entity for which a valid pragma
1572 -- Convention, Import, or Export has been given. Used to prevent more
1573 -- than one such pragma appearing for a given entity (RM B.1(45)).
1575 -- Has_Default_Aspect [base type only]
1576 -- Defined in entities for types and subtypes, set for scalar types with
1577 -- a Default_Value aspect and array types with a Default_Component_Value
1578 -- aspect. If this flag is set, then a corresponding aspect specification
1579 -- node will be present on the rep item chain for the entity. For a
1580 -- derived type that inherits a default from its ancestor, the default
1581 -- value is set, but it may be overridden by an aspect declaration on
1582 -- type derivation.
1584 -- Has_Delayed_Aspects
1585 -- Defined in all entities. Set if the Rep_Item chain for the entity has
1586 -- one or more N_Aspect_Definition nodes chained which are not to be
1587 -- evaluated till the freeze point. The aspect definition expression
1588 -- clause has been preanalyzed to get visibility at the point of use,
1589 -- but no other action has been taken.
1591 -- Has_Delayed_Freeze
1592 -- Defined in all entities. Set to indicate that an explicit freeze
1593 -- node must be generated for the entity at its freezing point. See
1594 -- separate section ("Delayed Freezing and Elaboration") for details.
1596 -- Has_Delayed_Rep_Aspects
1597 -- Defined in all types and subtypes. This flag is set if there is at
1598 -- least one aspect for a representation characteristic that has to be
1599 -- delayed and is one of the characteristics that may be inherited by
1600 -- types derived from this type if not overridden. If this flag is set,
1601 -- then types derived from this type have May_Inherit_Delayed_Rep_Aspects
1602 -- set, signalling that Freeze.Inherit_Delayed_Rep_Aspects must be called
1603 -- at the freeze point of the derived type.
1605 -- Has_DIC (synthesized)
1606 -- Defined in all type entities. Set for a private type and its full view
1607 -- when the type is subject to pragma Default_Initial_Condition (DIC), or
1608 -- when the type inherits a DIC pragma from a parent type.
1610 -- Has_Discriminants
1611 -- Defined in all types and subtypes. For types that are allowed to have
1612 -- discriminants (record types and subtypes, task types and subtypes,
1613 -- protected types and subtypes, private types, limited private types,
1614 -- and incomplete types), indicates if the corresponding type or subtype
1615 -- has a known discriminant part. Always false for all other types.
1617 -- Has_Dispatch_Table
1618 -- Defined in E_Record_Types that are tagged. Set to indicate that the
1619 -- corresponding dispatch table is already built. This flag is used to
1620 -- avoid duplicate construction of library level dispatch tables (because
1621 -- the declaration of library level objects cause premature construction
1622 -- of the table); otherwise the code that builds the table is added at
1623 -- the end of the list of declarations of the package.
1625 -- Has_Dynamic_Predicate_Aspect
1626 -- Defined in all types and subtypes. Set if a Dynamic_Predicate aspect
1627 -- was explicitly applied to the type. Generally we treat predicates as
1628 -- static if possible, regardless of whether they are specified using
1629 -- Predicate, Static_Predicate, or Dynamic_Predicate. And if a predicate
1630 -- can be treated as static (i.e. its expression is predicate-static),
1631 -- then the flag Has_Static_Predicate will be set True. But there are
1632 -- cases where legality is affected by the presence of an explicit
1633 -- Dynamic_Predicate aspect. For example, even if a predicate looks
1634 -- static, you can't use it in a case statement if there is an explicit
1635 -- Dynamic_Predicate aspect specified. So test Has_Static_Predicate if
1636 -- you just want to know if the predicate can be evaluated statically,
1637 -- but test Has_Dynamic_Predicate_Aspect to enforce legality rules about
1638 -- the use of dynamic predicates.
1640 -- Has_Entries (synthesized)
1641 -- Applies to concurrent types. True if any entries are declared
1642 -- within the task or protected definition for the type.
1644 -- Has_Enumeration_Rep_Clause
1645 -- Defined in enumeration types. Set if an enumeration representation
1646 -- clause has been given for this enumeration type. Used to prevent more
1647 -- than one enumeration representation clause for a given type. Note
1648 -- that this does not imply a representation with holes, since the rep
1649 -- clause may merely confirm the default 0..N representation.
1651 -- Has_Exit
1652 -- Defined in loop entities. Set if the loop contains an exit statement.
1654 -- Has_Expanded_Contract
1655 -- Defined in functions, procedures, entries, and entry families. Set
1656 -- when a subprogram has a N_Contract node that has been expanded. The
1657 -- flag prevents double expansion of a contract when a construct is
1658 -- rewritten into something else and subsequently reanalyzed/expanded.
1660 -- Has_Foreign_Convention (synthesized)
1661 -- Applies to all entities. Determines if the Convention for the entity
1662 -- is a foreign convention, i.e. non-native: other than Convention_Ada,
1663 -- Convention_Intrinsic, Convention_Entry, Convention_Protected,
1664 -- Convention_Stubbed and Convention_Ada_Pass_By_(Copy,Reference).
1666 -- Has_Forward_Instantiation
1667 -- Defined in package entities. Set for packages that instantiate local
1668 -- generic entities before the corresponding generic body has been seen.
1669 -- If a package has a forward instantiation, we cannot inline subprograms
1670 -- appearing in the same package because the placement requirements of
1671 -- the instance will conflict with the linear elaboration of front-end
1672 -- inlining.
1674 -- Has_Fully_Qualified_Name
1675 -- Defined in all entities. Set if the name in the Chars field has been
1676 -- replaced by the fully qualified name, as used for debug output. See
1677 -- Exp_Dbug for a full description of the use of this flag and also the
1678 -- related flag Has_Qualified_Name.
1680 -- Has_Ghost_Predicate_Aspect
1681 -- Defined in all types and subtypes. Set if a Ghost_Predicate aspect
1682 -- was explicitly applied to the type.
1684 -- Has_Gigi_Rep_Item
1685 -- Defined in all entities. Set if the rep item chain (referenced by
1686 -- First_Rep_Item and linked through the Next_Rep_Item chain) contains a
1687 -- representation item that needs to be specially processed by the back
1688 -- end, i.e. one of the following items:
1690 -- Machine_Attribute pragma
1691 -- Linker_Alias pragma
1692 -- Linker_Constructor pragma
1693 -- Linker_Destructor pragma
1694 -- Weak_External pragma
1695 -- Thread_Local_Storage pragma
1697 -- If this flag is set, then the backend should scan the rep item chain
1698 -- to process any of these items that appear. At least one such item will
1699 -- be present.
1701 -- Has_Homonym
1702 -- Defined in all entities. Set if an entity has a homonym in the same
1703 -- scope. Used by the backend to generate unique names for all entities.
1705 -- Has_Implicit_Dereference
1706 -- Defined in types and discriminants. Set if the type has an aspect
1707 -- Implicit_Dereference. Set also on the discriminant named in the aspect
1708 -- clause, to simplify type resolution.
1710 -- Has_Independent_Components [implementation base type only]
1711 -- Defined in all types and objects. Set only for a record type or an
1712 -- array type or array object if a valid pragma Independent_Components
1713 -- applies to the type or object. Note that in the case of an object,
1714 -- this flag is only set on the object if there was an explicit pragma
1715 -- for the object. In other words, the proper test for whether an object
1716 -- has independent components is to see if either the object or its base
1717 -- type has this flag set. Note that in the case of a type, the pragma
1718 -- will be chained to the rep item chain of the first subtype in the
1719 -- usual manner. Also set if a pragma Has_Atomic_Components or pragma
1720 -- Has_Aliased_Components applies to the type or object.
1722 -- Has_Inheritable_Invariants [base type only]
1723 -- Defined in all type entities. Set on private types and interface types
1724 -- which define at least one class-wide invariant. Such invariants must
1725 -- be inherited by derived types. The flag is also set on the full view
1726 -- of a private type for completeness.
1728 -- Has_Inherited_DIC [base type only]
1729 -- Defined in all type entities. Set for a derived type which inherits
1730 -- pragma Default_Initial_Condition from a parent type.
1732 -- Has_Inherited_Invariants [base type only]
1733 -- Defined in all type entities. Set on private extensions and derived
1734 -- types which inherit at least one class-wide invariant from a parent or
1735 -- an interface type. The flag is also set on the full view of a private
1736 -- extension for completeness.
1738 -- Has_Initial_Value
1739 -- Defined in entities for variables and out parameters. Set if there
1740 -- is an explicit initial value expression in the declaration of the
1741 -- variable. Note that this is set only if this initial value is
1742 -- explicit, it is not set for the case of implicit initialization
1743 -- of access types or controlled types. Always set to False for out
1744 -- parameters. Also defined in entities for in and in-out parameters,
1745 -- but always false in these cases.
1747 -- Has_Interrupt_Handler (synthesized)
1748 -- Applies to all protected type entities. Set if the protected type
1749 -- definition contains at least one procedure to which a pragma
1750 -- Interrupt_Handler applies.
1752 -- Has_Invariants (synthesized)
1753 -- Defined in all type entities. True if the type defines at least one
1754 -- invariant of its own or inherits at least one class-wide invariant
1755 -- from a parent type or an interface.
1757 -- Has_Limited_View (synth)
1758 -- Defined in all entities. True for non-generic package entities that
1759 -- are non-instances and their Limited_View attribute is present.
1761 -- Has_Loop_Entry_Attributes
1762 -- Defined in E_Loop entities. Set when the loop is subject to at least
1763 -- one attribute 'Loop_Entry. The flag also implies that the loop has
1764 -- already been transformed. See Expand_Loop_Entry_Attribute for details.
1766 -- Has_Machine_Radix_Clause
1767 -- Defined in decimal types and subtypes, set if a Machine_Radix
1768 -- representation clause is present. This flag is used to detect
1769 -- the error of multiple machine radix clauses for a single type.
1771 -- Has_Master_Entity
1772 -- Defined in entities that can appear in the scope stack (see spec
1773 -- of Sem). It is set if a task master entity (_master) has been
1774 -- declared and initialized in the corresponding scope.
1776 -- Has_Missing_Return
1777 -- Defined in functions and generic functions. Set if there is one or
1778 -- more missing return statements in the function. This is used to
1779 -- control wrapping of the body in Exp_Ch6 to ensure that the program
1780 -- error exception is correctly raised in this case at run time.
1782 -- Has_Nested_Block_With_Handler
1783 -- Defined in scope entities. Set if there is a nested block within the
1784 -- scope that has an exception handler and the two scopes are in the
1785 -- same procedure. This is used by the backend for controlling certain
1786 -- optimizations to ensure that they are consistent with exceptions.
1787 -- See documentation in backend for further details.
1789 -- Has_Nested_Subprogram
1790 -- Defined in subprogram entities. Set for a subprogram which contains at
1791 -- least one nested subprogram.
1793 -- Has_Non_Limited_View (synth)
1794 -- Defined in E_Incomplete_Type, E_Incomplete_Subtype, E_Class_Wide_Type,
1795 -- E_Abstract_State entities. True if their Non_Limited_View attribute
1796 -- is present.
1798 -- Has_Non_Null_Abstract_State (synth)
1799 -- Defined in package entities. True if the package is subject to a non-
1800 -- null Abstract_State aspect/pragma.
1802 -- Has_Non_Null_Visible_Refinement (synth)
1803 -- Defined in E_Abstract_State entities. True if the state has a visible
1804 -- refinement of at least one variable or state constituent as expressed
1805 -- in aspect/pragma Refined_State.
1807 -- Has_Non_Standard_Rep [implementation base type only]
1808 -- Defined in all type entities. Set when some representation clause
1809 -- or pragma causes the representation of the item to be significantly
1810 -- modified. In this category are changes of small or radix for a
1811 -- fixed-point type, change of component size for an array, and record
1812 -- or enumeration representation clauses, as well as packed pragmas.
1813 -- All other representation clauses (e.g. Size and Alignment clauses)
1814 -- are not considered to be significant since they do not affect
1815 -- stored bit patterns.
1817 -- Has_Null_Abstract_State (synth)
1818 -- Defined in package entities. True if the package is subject to a null
1819 -- Abstract_State aspect/pragma.
1821 -- Has_Null_Visible_Refinement (synth)
1822 -- Defined in E_Abstract_State entities. True if the state has a visible
1823 -- null refinement as expressed in aspect/pragma Refined_State.
1825 -- Has_Object_Size_Clause
1826 -- Defined in entities for types and subtypes. Set if an Object_Size
1827 -- clause has been processed for the type. Used to prevent multiple
1828 -- Object_Size clauses for a given entity.
1830 -- Has_Out_Or_In_Out_Parameter
1831 -- Present in subprograms, generic subprograms, entries, and entry
1832 -- families. Set if they have at least one OUT or IN OUT parameter
1833 -- (allowed for functions only in Ada 2012).
1835 -- Has_Own_DIC [base type only]
1836 -- Defined in all type entities. Set for a private type and its full view
1837 -- (and its underlying full view, if the full view is itself private)
1838 -- when the type is subject to pragma Default_Initial_Condition.
1840 -- Has_Own_Invariants [base type only]
1841 -- Defined in all type entities. Set on any type that defines at least
1842 -- one invariant of its own.
1844 -- Note: this flag is set on both partial and full view of types to which
1845 -- an Invariant pragma or aspect applies, and on the underlying full view
1846 -- if the full view is private.
1848 -- Has_Partial_Visible_Refinement
1849 -- Defined in E_Abstract_State entities. Set when a state has at least
1850 -- one refinement constituent subject to indicator Part_Of, and analysis
1851 -- is in the region between the declaration of the first constituent for
1852 -- this abstract state (in the private part of the package) and the end
1853 -- of the package spec or body with visibility over this private part
1854 -- (which includes the package itself and its child packages).
1856 -- Has_Per_Object_Constraint
1857 -- Defined in E_Component entities. Set if the subtype of the component
1858 -- has a per object constraint. Per object constraints result from the
1859 -- following situations:
1861 -- 1. N_Attribute_Reference - when the prefix is the enclosing type and
1862 -- the attribute is Access.
1863 -- 2. N_Discriminant_Association - when the expression uses the
1864 -- discriminant of the enclosing type.
1865 -- 3. N_Index_Or_Discriminant_Constraint - when at least one of the
1866 -- individual constraints is a per object constraint.
1867 -- 4. N_Range - when the lower or upper bound uses the discriminant of
1868 -- the enclosing type.
1869 -- 5. N_Range_Constraint - when the range expression uses the
1870 -- discriminant of the enclosing type.
1872 -- Has_Pragma_Controlled [implementation base type only]
1873 -- Defined in access type entities. It is set if a pragma Controlled
1874 -- applies to the access type.
1876 -- Has_Pragma_Elaborate_Body
1877 -- Defined in all entities. Set in compilation unit entities if a
1878 -- pragma Elaborate_Body applies to the compilation unit.
1880 -- Has_Pragma_Inline
1881 -- Defined in all entities. Set for functions and procedures for which a
1882 -- pragma Inline or Inline_Always applies to the subprogram. Note that
1883 -- this flag can be set even if Is_Inlined is not set. This happens for
1884 -- pragma Inline (if Inline_Active is False). In other words, the flag
1885 -- Has_Pragma_Inline represents the formal semantic status, and is used
1886 -- for checking semantic correctness. The flag Is_Inlined indicates
1887 -- whether inlining is actually active for the entity.
1889 -- Has_Pragma_Inline_Always
1890 -- Defined in all entities. Set for functions and procedures for which a
1891 -- pragma Inline_Always applies. Note that if this flag is set, the flag
1892 -- Has_Pragma_Inline is also set.
1894 -- Has_Pragma_No_Inline
1895 -- Defined in all entities. Set for functions and procedures for which a
1896 -- pragma No_Inline applies. Note that if this flag is set, the flag
1897 -- Has_Pragma_Inline_Always cannot be set.
1899 -- Has_Pragma_Ordered [implementation base type only]
1900 -- Defined in entities for enumeration types. If set indicates that a
1901 -- valid pragma Ordered was given for the type. This flag is inherited
1902 -- by derived enumeration types. We don't need to distinguish the derived
1903 -- case since we allow multiple occurrences of this pragma anyway.
1905 -- Has_Pragma_Pack [implementation base type only]
1906 -- Defined in array and record type entities. If set, indicates that a
1907 -- valid pragma Pack was given for the type. Note that this flag is not
1908 -- inherited by derived type. See also the Is_Packed flag.
1910 -- Has_Pragma_Preelab_Init
1911 -- Defined in type and subtype entities. If set indicates that a valid
1912 -- pragma Preelaborable_Initialization applies to the type.
1914 -- Has_Pragma_Pure
1915 -- Defined in all entities. If set, indicates that a valid pragma Pure
1916 -- was given for the entity. In some cases, we need to test whether
1917 -- Is_Pure was explicitly set using this pragma.
1919 -- Has_Pragma_Pure_Function
1920 -- Defined in all entities. If set, indicates that a valid pragma
1921 -- Pure_Function was given for the entity. In some cases, we need to test
1922 -- whether Is_Pure was explicitly set using this pragma. We also set
1923 -- this flag for some internal entities that we know should be treated
1924 -- as pure for optimization purposes.
1926 -- Has_Pragma_Thread_Local_Storage
1927 -- Defined in all entities. If set, indicates that a valid pragma
1928 -- Thread_Local_Storage was given for the entity.
1930 -- Has_Pragma_Unmodified
1931 -- Defined in all entities. Can only be set for variables (E_Variable,
1932 -- E_Out_Parameter, E_In_Out_Parameter). Set if a valid pragma Unmodified
1933 -- applies to the variable, indicating that no warning should be given
1934 -- if the entity is never modified. Note that clients should generally
1935 -- not test this flag directly, but instead use function Has_Unmodified.
1937 -- Has_Pragma_Unreferenced
1938 -- Defined in all entities. Set if a valid pragma Unreferenced applies
1939 -- to the entity, indicating that no warning should be given if the
1940 -- entity has no references, but a warning should be given if it is
1941 -- in fact referenced. For private types, this flag is set in both the
1942 -- private entity and full entity if the pragma applies to either. Note
1943 -- that clients should generally not test this flag directly, but instead
1944 -- use function Has_Unreferenced.
1946 -- Has_Pragma_Unreferenced_Objects
1947 -- Defined in all entities. Set if a valid pragma Unused applies to an
1948 -- entity, indicating that warnings should be given if the entity is
1949 -- modified or referenced. This pragma is equivalent to a pair of
1950 -- Unmodified and Unreferenced pragmas.
1952 -- Has_Pragma_Unused
1953 -- Defined in all entities. Set if a valid pragma Unused applies to a
1954 -- variable or entity, indicating that warnings should not be given if
1955 -- it is never modified or referenced. Note: This pragma is exactly
1956 -- equivalent Unmodified and Unreference combined.
1958 -- Has_Predicates
1959 -- Defined in type and subtype entities. Set if a pragma Predicate or
1960 -- Predicate aspect applies to the type or subtype, or if it inherits a
1961 -- Predicate aspect from its parent or progenitor types.
1963 -- Note: this flag is set on both partial and full view of types to which
1964 -- a Predicate pragma or aspect applies, and on the underlying full view
1965 -- if the full view is private.
1967 -- Has_Primitive_Operations [base type only]
1968 -- Defined in all type entities. Set if at least one primitive operation
1969 -- is defined for the type.
1971 -- Has_Private_Ancestor
1972 -- Applies to derived record types. True if an ancestor is derived from a
1973 -- private type, making some components invisible and aggregates illegal.
1974 -- This flag is set at the point of derivation. The legality of the
1975 -- aggregate must be rechecked because it also depends on the visibility
1976 -- at the point the aggregate is resolved. See sem_aggr.adb. This is part
1977 -- of AI05-0115.
1979 -- Has_Private_Declaration
1980 -- Defined in all entities. Set if it is the defining entity of a private
1981 -- type declaration or its corresponding full declaration. This flag is
1982 -- thus preserved when the full and the partial views are exchanged, to
1983 -- indicate if a full type declaration is a completion. Used for semantic
1984 -- checks in E.4(18) and elsewhere.
1986 -- Has_Private_Extension
1987 -- Defined in tagged types. Set to indicate that the tagged type has some
1988 -- private extension. Used to report a warning on public primitives added
1989 -- after defining its private extensions.
1991 -- Has_Protected [base type only]
1992 -- Defined in all type entities. Set on protected types themselves, and
1993 -- also (recursively) on any composite type which has a component for
1994 -- which Has_Protected is set, unless the protected type is declared in
1995 -- the private part of an internal unit. The meaning is that restrictions
1996 -- for protected types apply to this type. Note: the flag is not set on
1997 -- access types, even if they designate an object that Has_Protected.
1999 -- Has_Qualified_Name
2000 -- Defined in all entities. Set if the name in the Chars field has
2001 -- been replaced by its qualified name, as used for debug output. See
2002 -- Exp_Dbug for a full description of qualification requirements. For
2003 -- some entities, the name is the fully qualified name, but there are
2004 -- exceptions. In particular, for local variables in procedures, we
2005 -- do not include the procedure itself or higher scopes. See also the
2006 -- flag Has_Fully_Qualified_Name, which is set if the name does indeed
2007 -- include the fully qualified name.
2009 -- Has_RACW
2010 -- Defined in package spec entities. Set if the spec contains the
2011 -- declaration of a remote access-to-classwide type.
2013 -- Has_Record_Rep_Clause [implementation base type only]
2014 -- Defined in record types. Set if a record representation clause has
2015 -- been given for this record type. Used to prevent more than one such
2016 -- clause for a given record type. Note that this is initially cleared
2017 -- for a derived type, even though the representation is inherited. See
2018 -- also the flag Has_Specified_Layout.
2020 -- Has_Recursive_Call
2021 -- Defined in procedures. Set if a direct parameterless recursive call
2022 -- is detected while analyzing the body. Used to activate some error
2023 -- checks for infinite recursion.
2025 -- Has_Shift_Operator [base type only]
2026 -- Defined in integer types. Set in the base type of an integer type for
2027 -- which at least one of the shift operators is defined.
2029 -- Has_Size_Clause
2030 -- Defined in entities for types and objects. Set if a size or value size
2031 -- clause is defined for the entity. Used to prevent multiple clauses
2032 -- for a given entity. Note that it is always initially cleared for a
2033 -- derived type, even though the Size or Value_Size clause for such a
2034 -- type might be inherited from an ancestor type.
2036 -- Has_Small_Clause
2037 -- Defined in ordinary fixed point types (but not subtypes). Indicates
2038 -- that a small clause has been given for the entity. Used to prevent
2039 -- multiple Small clauses for a given entity. Note that it is always
2040 -- initially cleared for a derived type, even though the Small for such
2041 -- a type is inherited from a Small clause given for the parent type.
2043 -- Has_Specified_Layout [implementation base type only]
2044 -- Defined in all type entities. Set for a record type or subtype if
2045 -- the record layout has been specified by a record representation
2046 -- clause. Note that this differs from the flag Has_Record_Rep_Clause
2047 -- in that it is inherited by a derived type. Has_Record_Rep_Clause is
2048 -- used to indicate that the type is mentioned explicitly in a record
2049 -- representation clause, and thus is not inherited by a derived type.
2050 -- This flag is always False for non-record types.
2052 -- Has_Specified_Stream_Input
2053 -- Has_Specified_Stream_Output
2054 -- Has_Specified_Stream_Read
2055 -- Has_Specified_Stream_Write
2056 -- Defined in all type and subtype entities. Set for a given view if the
2057 -- corresponding stream-oriented attribute has been defined by an
2058 -- attribute definition clause. When such a clause occurs, a TSS is set
2059 -- on the underlying full view; the flags are used to track visibility of
2060 -- the attribute definition clause for partial or incomplete views.
2062 -- Has_Static_Discriminants
2063 -- Defined in record subtypes constrained by discriminant values. Set if
2064 -- all the discriminant values have static values, meaning that in the
2065 -- case of a variant record, the component list can be trimmed down to
2066 -- include only the components corresponding to these discriminants.
2068 -- Has_Static_Predicate
2069 -- Defined in all types and subtypes. Set if the type (which must be a
2070 -- scalar type) has a predicate whose expression is predicate-static.
2071 -- This can result from the use of any Predicate, Static_Predicate, or
2072 -- Dynamic_Predicate aspect. We can distinguish these cases by testing
2073 -- Has_Static_Predicate_Aspect and Has_Dynamic_Predicate_Aspect. See
2074 -- description of the latter flag for further information on dynamic
2075 -- predicates which are also static.
2077 -- Has_Static_Predicate_Aspect
2078 -- Defined in all types and subtypes. Set if a Static_Predicate aspect
2079 -- applies to the type. Note that we can tell if a static predicate is
2080 -- present by looking at Has_Static_Predicate, but this could have come
2081 -- from a Predicate aspect or pragma or even from a Dynamic_Predicate
2082 -- aspect. When we need to know the difference (e.g. to know what set of
2083 -- check policies apply, use this flag and Has_Dynamic_Predicate_Aspect
2084 -- to determine which case we have).
2086 -- Has_Storage_Size_Clause [implementation base type only]
2087 -- Defined in task types and access types. It is set if a Storage_Size
2088 -- clause is present for the type. Used to prevent multiple clauses for
2089 -- one type. Note that this flag is initially cleared for a derived type
2090 -- even though the Storage_Size for such a type is inherited from a
2091 -- Storage_Size clause given for the parent type. Note that in the case
2092 -- of access types, this flag is defined only in the root type, since a
2093 -- storage size clause cannot be given to a derived type.
2095 -- Has_Stream_Size_Clause
2096 -- Defined in all entities. It is set for types which have a Stream_Size
2097 -- clause attribute. Used to prevent multiple Stream_Size clauses for a
2098 -- given entity, and also whether it is necessary to check for a stream
2099 -- size clause.
2101 -- Has_Task [base type only]
2102 -- Defined in all type entities. Set on task types themselves, and also
2103 -- (recursively) on any composite type which has a component for which
2104 -- Has_Task is set. The meaning is that an allocator or declaration of
2105 -- such an object must create the required tasks. Note: the flag is not
2106 -- set on access types, even if they designate an object that Has_Task.
2108 -- Has_Timing_Event [base type only]
2109 -- Defined in all type entities. Set on language defined type
2110 -- Ada.Real_Time.Timing_Events.Timing_Event, and also (recursively) on
2111 -- any composite type which has a component for which Has_Timing_Event
2112 -- is set. Used for the No_Local_Timing_Event restriction.
2114 -- Has_Thunks
2115 -- Applies to E_Constant entities marked Is_Tag. True for secondary tag
2116 -- referencing a dispatch table whose contents are pointers to thunks.
2118 -- Has_Unchecked_Union [base type only]
2119 -- Defined in all type entities. Set on unchecked unions themselves
2120 -- and (recursively) on any composite type which has a component for
2121 -- which Has_Unchecked_Union is set. The meaning is that a comparison
2122 -- operation or 'Valid_Scalars reference for the type is not permitted.
2123 -- Note that the flag is not set on access types, even if they designate
2124 -- an object that has the flag Has_Unchecked_Union set.
2126 -- Has_Unknown_Discriminants
2127 -- Defined in all entities. Set for types with unknown discriminants.
2128 -- Types can have unknown discriminants either from their declaration or
2129 -- through type derivation. The use of this flag exactly meets the spec
2130 -- in RM 3.7(26). Note that all class-wide types are considered to have
2131 -- unknown discriminants. Note that both flags Has_Discriminants and
2132 -- Has_Unknown_Discriminants may be true for a type. Class-wide types and
2133 -- their subtypes have unknown discriminants and can have declared ones
2134 -- as well. Private types declared with unknown discriminants may have a
2135 -- full view that has explicit discriminants, and both flag will be set
2136 -- on the partial view, to ensure that discriminants are properly
2137 -- inherited in certain contexts.
2139 -- Has_Visible_Refinement
2140 -- Defined in E_Abstract_State entities. Set when a state has at least
2141 -- one refinement constituent and analysis is in the region between
2142 -- pragma Refined_State and the end of the package body declarations.
2144 -- Has_Volatile_Components [implementation base type only]
2145 -- Defined in all types and objects. Set only for an array type or array
2146 -- object if a valid pragma Volatile_Components or a valid pragma
2147 -- Atomic_Components applies to the type or object. Note that in the case
2148 -- of an object, this flag is only set on the object if there was an
2149 -- explicit pragma for the object. In other words, the proper test for
2150 -- whether an object has volatile components is to see if either the
2151 -- object or its base type has this flag set. Note that in the case of a
2152 -- type the pragma will be chained to the rep item chain of the first
2153 -- subtype in the usual manner.
2155 -- Has_Xref_Entry
2156 -- Defined in all entities. Set if an entity has an entry in the Xref
2157 -- information generated in ali files. This is true for all source
2158 -- entities in the extended main source file. It is also true of entities
2159 -- in other packages that are referenced directly or indirectly from the
2160 -- main source file (indirect reference occurs when the main source file
2161 -- references an entity with a type reference. See package Lib.Xref for
2162 -- further details).
2164 -- Has_Yield_Aspect
2165 -- Defined in subprograms, generic subprograms, entries, entry families.
2166 -- Set if the entity has aspect Yield.
2168 -- Hiding_Loop_Variable
2169 -- Defined in variables. Set only if a variable of a discrete type is
2170 -- hidden by a loop variable in the same local scope, in which case
2171 -- the Hiding_Loop_Variable field of the hidden variable points to
2172 -- the E_Loop_Parameter entity doing the hiding. Used in processing
2173 -- warning messages if the hidden variable turns out to be unused
2174 -- or is referenced without being set.
2176 -- Hidden_In_Formal_Instance
2177 -- Defined on actuals for formal packages. Entities on the list are
2178 -- formals that are hidden outside of the formal package when this
2179 -- package is not declared with a box, or the formal itself is not
2180 -- defaulted (see RM 12.7 (10)). Their visibility is restored on exit
2181 -- from the current generic, because the actual for the formal package
2182 -- may be used subsequently in the current unit.
2184 -- Homonym
2185 -- Defined in all entities. Link for list of entities that have the
2186 -- same source name and that are declared in the same or enclosing
2187 -- scopes. Homonyms in the same scope are overloaded. Used for name
2188 -- resolution and for the generation of debugging information.
2190 -- Ignore_SPARK_Mode_Pragmas
2191 -- Present in concurrent type, entry, operator, [generic] package,
2192 -- package body, [generic] subprogram, and subprogram body entities.
2193 -- Set when the entity appears in an instance subject to SPARK_Mode
2194 -- "off" and indicates that all SPARK_Mode pragmas found within must
2195 -- be ignored.
2197 -- Ignored_Class_Postconditions
2198 -- Defined on subprogram entities. Set if the subprogram has class-wide
2199 -- postconditions. Denotes the (and-then) expression built by merging
2200 -- inherited ignored class-wide postconditions with its own ignored
2201 -- class-wide postconditions.
2203 -- Ignored_Class_Preconditions
2204 -- Defined on subprogram entities. Set if the subprogram has class-wide
2205 -- preconditions. Denotes the (or-else) expression built by merging
2206 -- inherited ignored class-wide preconditions with its own ignored
2207 -- class-wide preconditions.
2209 -- Implementation_Base_Type (synthesized)
2210 -- Applies to all entities. For types, similar to Base_Type, but never
2211 -- returns a private type when applied to a non-private type. Instead in
2212 -- this case, it always returns the Underlying_Type of the base type, so
2213 -- that we still have a concrete type. For entities other than types,
2214 -- returns the entity unchanged.
2216 -- Import_Pragma
2217 -- Defined in subprogram entities. Set if a valid pragma Import or pragma
2218 -- Import_Function or pragma Import_Procedure applies to the subprogram,
2219 -- in which case this field points to the pragma (we can't use the normal
2220 -- Rep_Item chain mechanism, because a single pragma Import can apply
2221 -- to multiple subprogram entities).
2223 -- In_Package_Body
2224 -- Defined in package entities. Set on the entity that denotes the
2225 -- package (the defining occurrence of the package declaration) while
2226 -- analyzing and expanding the package body. Reset on completion of
2227 -- analysis/expansion.
2229 -- In_Private_Part
2230 -- Defined in all entities. Can be set only in package entities and
2231 -- objects. For package entities, this flag is set to indicate that the
2232 -- private part of the package is being analyzed. The flag is reset at
2233 -- the end of the package declaration. For objects it indicates that the
2234 -- declaration of the object occurs in the private part of a package.
2236 -- Incomplete_Actuals
2237 -- Defined on package entities that are instances. Indicates the actuals
2238 -- types in the instantiation that are limited views. If this list is
2239 -- not empty, the instantiation, which appears in a package declaration,
2240 -- is relocated to the corresponding package body, which must have a
2241 -- corresponding nonlimited with_clause.
2243 -- Indirect_Call_Wrapper
2244 -- Defined on subprogram entities. Set if the subprogram has class-wide
2245 -- preconditions. Denotes the internal wrapper that checks preconditions
2246 -- and invokes the subprogram body. Subp'Access points to the indirect
2247 -- call wrapper if available.
2249 -- Initialization_Statements
2250 -- Defined in constants and variables. For a composite object initialized
2251 -- with an aggregate that has been converted to a sequence of
2252 -- assignments, points to a compound statement containing the
2253 -- assignments.
2255 -- Inner_Instances
2256 -- Defined in generic units. Contains element list of units that are
2257 -- instantiated within the given generic. Used to diagnose circular
2258 -- instantiations.
2260 -- Interface_Alias
2261 -- Defined in subprograms that cover a primitive operation of an abstract
2262 -- interface type. Can be set only if the Is_Hidden flag is also set,
2263 -- since such entities are always hidden. Points to its associated
2264 -- interface subprogram. It is used to register the subprogram in
2265 -- secondary dispatch table of the interface (Ada 2005: AI-251).
2267 -- Interface_Name
2268 -- Defined in constants, variables, exceptions, functions, procedures,
2269 -- and packages. Set to Empty unless an export, import, or interface name
2270 -- pragma has explicitly specified an external name, in which case it
2271 -- references an N_String_Literal node for the specified external name.
2272 -- Note that if this field is Empty, and Is_Imported or Is_Exported is
2273 -- set, then the default interface name is the name of the entity, cased
2274 -- in a manner that is appropriate to the system in use. Note that
2275 -- Interface_Name is ignored if an address clause is present (since it
2276 -- is meaningless in this case).
2278 -- Interfaces
2279 -- Defined in record types and subtypes. List of abstract interfaces
2280 -- implemented by a tagged type that are not already implemented by the
2281 -- ancestors (Ada 2005: AI-251).
2283 -- Invariant_Procedure (synthesized)
2284 -- Defined in types and subtypes. Set for private types and their full
2285 -- views if one or more [class-wide] invariants apply to the type, or
2286 -- when the type inherits class-wide invariants from a parent type or
2287 -- an interface, or when the type is an array and its component type is
2288 -- subject to an invariant, or when the type is record and contains a
2289 -- component subject to an invariant (property is recursive). Points to
2290 -- to the entity for a procedure which checks all these invariants. The
2291 -- invariant procedure takes a single argument of the given type, and
2292 -- returns if the invariant holds, or raises exception Assertion_Error
2293 -- with an appropriate message if it does not hold. This attribute is
2294 -- defined but always Empty for private subtypes.
2296 -- Note: the reason this is marked as a synthesized attribute is that the
2297 -- way this is stored is as an element of the Subprograms_For_Type field.
2299 -- In_Use
2300 -- Defined in packages and types. Set when analyzing a use clause for
2301 -- the corresponding entity. Reset at end of corresponding declarative
2302 -- part. The flag on a type is also used to determine the visibility of
2303 -- the primitive operators of the type.
2305 -- Note that manipulation of scopes on the scope stack will also cause
2306 -- the flag to be set/unset since the setting of scopes affects
2307 -- visibility.
2309 -- Is_Abstract_Subprogram
2310 -- Defined in all subprograms and entries. Set for abstract subprograms.
2311 -- Always False for enumeration literals and entries. See also
2312 -- Requires_Overriding.
2314 -- Is_Abstract_Type
2315 -- Defined in all types. Set for abstract types.
2317 -- Is_Access_Constant
2318 -- Defined in access types and subtypes. Indicates that the keyword
2319 -- constant was present in the access type definition.
2321 -- Is_Access_Protected_Subprogram_Type (synthesized)
2322 -- Applies to all types, true for named and anonymous access to
2323 -- protected subprograms.
2325 -- Is_Access_Type (synthesized)
2326 -- Applies to all entities, true for access types and subtypes
2328 -- Is_Access_Object_Type (synthesized)
2329 -- Applies to all entities, true for access-to-object types and subtypes
2331 -- Is_Activation_Record
2332 -- Applies to E_In_Parameters generated in Exp_Unst for nested
2333 -- subprograms, to mark the added formal that carries the activation
2334 -- record created in the enclosing subprogram.
2336 -- Is_Actual_Subtype
2337 -- Defined on all types, true for the generated constrained subtypes
2338 -- that are built for unconstrained composite actuals.
2340 -- Is_Ada_2005_Only
2341 -- Defined in all entities, true if a valid pragma Ada_05 or Ada_2005
2342 -- applies to the entity which specifically names the entity, indicating
2343 -- that the entity is Ada 2005 only. Note that this flag is not set if
2344 -- the entity is part of a unit compiled with the normal no-argument form
2345 -- of pragma Ada_05 or Ada_2005.
2347 -- Is_Ada_2012_Only
2348 -- Defined in all entities, true if a valid pragma Ada_12 or Ada_2012
2349 -- applies to the entity which specifically names the entity, indicating
2350 -- that the entity is Ada 2012 only. Note that this flag is not set if
2351 -- the entity is part of a unit compiled with the normal no-argument form
2352 -- of pragma Ada_12 or Ada_2012.
2354 -- Is_Ada_2022_Only
2355 -- Defined in all entities, true if a valid pragma Ada_2022 applies to
2356 -- the entity which specifically names the entity, indicating that the
2357 -- entity is Ada 2022 only. Note that this flag is not set if the entity
2358 -- is part of a unit compiled with the normal no-argument form of pragma
2359 -- Ada_2022.
2361 -- Is_Aliased
2362 -- Defined in all entities. Set for objects and types whose declarations
2363 -- carry the keyword aliased, and on record components that have the
2364 -- keyword. For Ada 2012, also applies to formal parameters.
2366 -- Is_Array_Type (synthesized)
2367 -- Applies to all entities, true for array types and subtypes
2369 -- Is_Asynchronous
2370 -- Defined in all type entities and in procedure entities. Set
2371 -- if a pragma Asynchronous applies to the entity.
2373 -- Is_Atomic
2374 -- Defined in all type entities, and also in constants, components, and
2375 -- variables. Set if a pragma Atomic or Shared applies to the entity.
2376 -- In the case of private and incomplete types, this flag is set in
2377 -- both the partial view and the full view.
2379 -- Is_Full_Access (synth)
2380 -- Defined in all type entities, and also in constants, components and
2381 -- variables. Set if an aspect/pragma Atomic/Shared, or an aspect/pragma
2382 -- Volatile_Full_Access or an Ada 2022 aspect Full_Access_Only applies
2383 -- to the entity. In the case of private and incomplete types, the flag
2384 -- applies to both the partial view and the full view.
2386 -- Is_Base_Type (synthesized)
2387 -- Applies to type and subtype entities. True if entity is a base type.
2389 -- Is_Bit_Packed_Array [implementation base type only]
2390 -- Defined in all entities. This flag is set for a packed array type that
2391 -- is bit-packed (i.e. the component size is known by the front end and
2392 -- is in the range 1-63 but not a multiple of 8). Is_Packed is always set
2393 -- if Is_Bit_Packed_Array is set, but it is possible for Is_Packed to be
2394 -- set without Is_Bit_Packed_Array if the component size is not known by
2395 -- the front-end or for the case of an array having one or more index
2396 -- types that are enumeration types with non-standard representation.
2398 -- Is_Boolean_Type (synthesized)
2399 -- Applies to all entities, true for boolean types and subtypes,
2400 -- i.e. Standard.Boolean and all types ultimately derived from it.
2402 -- Is_Called
2403 -- Defined in subprograms and packages. Set if a subprogram is called
2404 -- from the unit being compiled or a unit in the closure. Also set for
2405 -- a package that contains called subprograms. Used only for inlining.
2407 -- Is_Character_Type
2408 -- Defined in all entities. Set for character types and subtypes,
2409 -- i.e. enumeration types that have at least one character literal.
2411 -- Is_Checked_Ghost_Entity
2412 -- Applies to all entities. Set for abstract states, [generic] packages,
2413 -- [generic] subprograms, components, discriminants, formal parameters,
2414 -- objects, package bodies, subprogram bodies, and [sub]types subject to
2415 -- pragma Ghost or inherit "ghostness" from an enclosing construct, and
2416 -- subject to Assertion_Policy Ghost => Check.
2418 -- Is_Child_Unit
2419 -- Defined in all entities. Set only for defining entities of program
2420 -- units that are child units (but False for subunits).
2422 -- Is_Class_Wide_Equivalent_Type
2423 -- Defined in record types and subtypes. Set to True, if the type acts
2424 -- as a class-wide equivalent type, i.e. the Equivalent_Type field of
2425 -- some class-wide subtype entity references this record type.
2427 -- Is_Class_Wide_Type (synthesized)
2428 -- Applies to all entities, true for class wide types and subtypes
2430 -- Is_Class_Wide_Wrapper
2431 -- Defined in subprogram entities. Indicates that it has been created as
2432 -- a wrapper in a generic/instance scenario involving a formal type and
2433 -- a generic primitive operation when the actual is a class-wide type.
2435 -- Is_Compilation_Unit
2436 -- Defined in all entities. Set if the entity is a package or subprogram
2437 -- entity for a compilation unit other than a subunit (since we treat
2438 -- subunits as part of the same compilation operation as the ultimate
2439 -- parent, we do not consider them to be separate units for this flag).
2441 -- Is_Completely_Hidden
2442 -- Defined on discriminants. Only set on stored discriminants of
2443 -- untagged types. When set, the entity is a stored discriminant of a
2444 -- derived untagged type which is not directly visible in the derived
2445 -- type because the derived type or one of its ancestors have renamed the
2446 -- discriminants in the root type. Note: there are stored discriminants
2447 -- which are not Completely_Hidden (e.g. discriminants of a root type).
2449 -- Is_Composite_Type (synthesized)
2450 -- Applies to all entities, true for all composite types and subtypes.
2451 -- Either Is_Composite_Type or Is_Elementary_Type (but not both) is true
2452 -- of any type.
2454 -- Is_Concurrent_Record_Type
2455 -- Defined in record types and subtypes. Set if the type was created
2456 -- by the expander to represent a task or protected type. For every
2457 -- concurrent type, such as record type is constructed, and task and
2458 -- protected objects are instances of this record type at run time
2459 -- (The backend will replace declarations of the concurrent type using
2460 -- the declarations of the corresponding record type). See Exp_Ch9 for
2461 -- further details.
2463 -- Is_Concurrent_Type (synthesized)
2464 -- Applies to all entities, true for task types and subtypes and for
2465 -- protected types and subtypes.
2467 -- Is_Constant_Object (synthesized)
2468 -- Applies to all entities, true for E_Constant, E_Loop_Parameter, and
2469 -- E_In_Parameter entities.
2471 -- Is_Constrained
2472 -- Defined in types or subtypes which may have index, discriminant
2473 -- or range constraint (i.e. array types and subtypes, record types
2474 -- and subtypes, string types and subtypes, and all numeric types).
2475 -- Set if the type or subtype is constrained.
2477 -- Is_Constr_Subt_For_U_Nominal
2478 -- Defined in all types and subtypes. Set only for the constructed
2479 -- subtype of an object whose nominal subtype is unconstrained. Note
2480 -- that the constructed subtype itself will be constrained.
2482 -- Is_Constr_Subt_For_UN_Aliased
2483 -- Defined in all types and subtypes. This flag can be set only if
2484 -- Is_Constr_Subt_For_U_Nominal is also set. It indicates that in
2485 -- addition the object concerned is aliased. This flag is used by
2486 -- the backend to determine whether a template must be constructed.
2488 -- Is_Constructor
2489 -- Defined in function and procedure entities. Set if a pragma
2490 -- CPP_Constructor applies to the subprogram.
2492 -- Is_Controlled_Active [base type only]
2493 -- Defined in all type entities. Indicates that the type is controlled,
2494 -- i.e. is either a descendant of Ada.Finalization.Controlled or of
2495 -- Ada.Finalization.Limited_Controlled.
2497 -- Is_Controlled (synth) [base type only]
2498 -- Defined in all type entities. Set if Is_Controlled_Active is set for
2499 -- the type, and Disable_Controlled is not set.
2501 -- Is_Controlling_Formal
2502 -- Defined in all Formal_Kind entities. Marks the controlling parameters
2503 -- of dispatching operations.
2505 -- Is_CPP_Class
2506 -- Defined in all type entities, set only for tagged types to which a
2507 -- valid pragma Import (CPP, ...) or pragma CPP_Class has been applied.
2509 -- Is_CUDA_Kernel
2510 -- Defined in function and procedure entities. Set if the subprogram is a
2511 -- CUDA kernel.
2513 -- Is_Decimal_Fixed_Point_Type (synthesized)
2514 -- Applies to all type entities, true for decimal fixed point
2515 -- types and subtypes.
2517 -- Is_Descendant_Of_Address
2518 -- Defined in all entities. True if the entity is type System.Address,
2519 -- or (recursively) a subtype or derived type of System.Address.
2521 -- Is_DIC_Procedure
2522 -- Defined in functions and procedures. Set for a generated procedure
2523 -- which verifies the assumption of pragma Default_Initial_Condition at
2524 -- run time.
2526 -- Is_Discrete_Or_Fixed_Point_Type (synthesized)
2527 -- Applies to all entities, true for all discrete types and subtypes
2528 -- and all fixed-point types and subtypes.
2530 -- Is_Discrete_Type (synthesized)
2531 -- Applies to all entities, true for all discrete types and subtypes
2533 -- Is_Discrim_SO_Function
2534 -- Defined in all entities. Set only in E_Function entities that Layout
2535 -- creates to compute discriminant-dependent dynamic size/offset values.
2537 -- Is_Discriminant_Check_Function
2538 -- Defined in all entities. Set only in E_Function entities for functions
2539 -- created to do discriminant checks.
2541 -- Is_Discriminal (synthesized)
2542 -- Applies to all entities, true for renamings of discriminants. Such
2543 -- entities appear as constants or IN parameters.
2545 -- Is_Dispatch_Table_Entity
2546 -- Applies to all entities. Set to indicate to the backend that this
2547 -- entity is associated with a dispatch table.
2549 -- Is_Dispatch_Table_Wrapper
2550 -- Applies to all entities. Set on wrappers built when the subprogram has
2551 -- class-wide preconditions or class-wide postconditions affected by
2552 -- overriding (AI12-0195).
2554 -- Is_Dispatching_Operation
2555 -- Defined in all entities. Set for procedures, functions, generic
2556 -- procedures, and generic functions if the corresponding operation
2557 -- is dispatching.
2559 -- Is_Dynamic_Scope (synthesized)
2560 -- Applies to all Entities. Returns True if the entity is a dynamic
2561 -- scope (i.e. a block, subprogram, task_type, entry or extended return
2562 -- statement).
2564 -- Is_Elaboration_Checks_OK_Id
2565 -- Defined in elaboration targets (see terminology in Sem_Elab). Set when
2566 -- the target appears in a region which is subject to enabled elaboration
2567 -- checks. Such targets are allowed to generate run-time conditional ABE
2568 -- checks or guaranteed ABE failures.
2570 -- Is_Elaboration_Target (synthesized)
2571 -- Applies to all entities, True only for elaboration targets (see the
2572 -- terminology in Sem_Elab).
2574 -- Is_Elaboration_Warnings_OK_Id
2575 -- Defined in elaboration targets (see terminology in Sem_Elab). Set when
2576 -- the target appears in a region with elaboration warnings enabled.
2578 -- Is_Elementary_Type (synthesized)
2579 -- Applies to all entities, True for all elementary types and subtypes.
2580 -- Either Is_Composite_Type or Is_Elementary_Type (but not both) is true
2581 -- of any type.
2583 -- Is_Eliminated
2584 -- Defined in type entities, subprogram entities, and object entities.
2585 -- Indicates that the corresponding entity has been eliminated by use
2586 -- of pragma Eliminate. Also used to mark subprogram entities whose
2587 -- declaration and body are within unreachable code that is removed.
2589 -- Is_Entry (synthesized)
2590 -- Applies to all entities, True only for entry and entry family
2591 -- entities and False for all other entity kinds.
2593 -- Is_Entry_Formal
2594 -- Defined in all entities. Set only for entry formals (which can only
2595 -- be in, in-out or out parameters). This flag is used to speed up the
2596 -- test for the need to replace references in Exp_Ch2.
2598 -- Is_Entry_Wrapper
2599 -- Defined on wrappers created for entries that have precondition or
2600 -- postcondition aspects.
2602 -- Is_Enumeration_Type (synthesized)
2603 -- Defined in all entities, true for enumeration types and subtypes
2605 -- Is_Exception_Handler
2606 -- Defined in blocks. Set if the block serves only as a scope of an
2607 -- exception handler with a choice parameter. Such a block does not
2608 -- physically appear in the tree.
2610 -- Is_Exported
2611 -- Defined in all entities. Set if the entity is exported. For now we
2612 -- only allow the export of constants, exceptions, functions, procedures
2613 -- and variables, but that may well change later on. Exceptions can only
2614 -- be exported in the Java VM implementation of GNAT, which is retired.
2616 -- Is_External_State (synthesized)
2617 -- Applies to all entities, true for abstract states that are subject to
2618 -- option External or Synchronous.
2620 -- Is_Finalized_Transient
2621 -- Defined in constants, loop parameters of generalized iterators, and
2622 -- variables. Set when a transient object has been finalized by one of
2623 -- the transient finalization mechanisms. The flag prevents the double
2624 -- finalization of the object.
2626 -- Is_Finalizer (synthesized)
2627 -- Applies to all entities, true for procedures containing finalization
2628 -- code to process local or library level objects.
2630 -- Is_First_Subtype
2631 -- Defined in all entities. True for first subtypes (RM 3.2.1(6)),
2632 -- i.e. the entity in the type declaration that introduced the type.
2633 -- This may be the base type itself (e.g. for record declarations and
2634 -- enumeration type declarations), or it may be the first subtype of
2635 -- an anonymous base type (e.g. for integer type declarations or
2636 -- constrained array declarations).
2638 -- Is_Fixed_Lower_Bound_Array_Subtype
2639 -- Defined in type entities. True for unconstrained array types and
2640 -- subtypes where at least one index has a range specified with a fixed
2641 -- lower bound (range syntax is "<expression> .. <>").
2643 -- Is_Fixed_Lower_Bound_Index_Subtype
2644 -- Defined in type entities. True for an index of an unconstrained array
2645 -- type or subtype whose range is specified with a fixed lower bound
2646 -- (range syntax is "<expression> .. <>").
2648 -- Is_Fixed_Point_Type (synthesized)
2649 -- Applies to all entities, true for decimal and ordinary fixed
2650 -- point types and subtypes.
2652 -- Is_Floating_Point_Type (synthesized)
2653 -- Applies to all entities, true for float types and subtypes
2655 -- Is_Formal (synthesized)
2656 -- Applies to all entities, true for IN, IN OUT and OUT parameters
2658 -- Is_Formal_Object (synthesized)
2659 -- Applies to all entities, true for generic IN and IN OUT parameters
2661 -- Is_Formal_Subprogram
2662 -- Defined in all entities. Set for generic formal subprograms.
2664 -- Is_Frozen
2665 -- Defined in all type and subtype entities. Set if type or subtype has
2666 -- been frozen.
2668 -- Is_Generic_Actual_Subprogram
2669 -- Defined on functions and procedures. Set on the entity of the renaming
2670 -- declaration created within an instance for an actual subprogram.
2671 -- Used to generate constraint checks on calls to these subprograms, even
2672 -- within an instance of a predefined run-time unit, in which checks
2673 -- are otherwise suppressed.
2675 -- Is_Generic_Actual_Type
2676 -- Defined in all type and subtype entities. Set in the subtype
2677 -- declaration that renames the generic formal as a subtype of the
2678 -- actual. Guarantees that the subtype is not static within the instance.
2679 -- Also used during analysis of an instance, to simplify resolution of
2680 -- accidental overloading that occurs when different formal types get the
2681 -- same actual.
2683 -- Is_Generic_Instance
2684 -- Defined in all entities. Set to indicate that the entity is an
2685 -- instance of a generic unit, or a formal package (which is an instance
2686 -- of the template).
2688 -- Is_Generic_Subprogram (synthesized)
2689 -- Applies to all entities. Yields True for a generic subprogram
2690 -- (generic function, generic subprogram), False for all other entities.
2692 -- Is_Generic_Type
2693 -- Defined in all entities. Set for types which are generic formal types.
2694 -- Such types have an Ekind that corresponds to their classification, so
2695 -- the Ekind cannot be used to identify generic formal types.
2697 -- Is_Generic_Unit (synthesized)
2698 -- Applies to all entities. Yields True for a generic unit (generic
2699 -- package, generic function, generic procedure), and False for all
2700 -- other entities.
2702 -- Is_Ghost_Entity (synthesized)
2703 -- Applies to all entities. Yields True for abstract states, [generic]
2704 -- packages, [generic] subprograms, components, discriminants, formal
2705 -- parameters, objects, package bodies, subprogram bodies, and [sub]types
2706 -- subject to pragma Ghost or those that inherit the Ghost property from
2707 -- an enclosing construct.
2709 -- Is_Hidden
2710 -- Defined in all entities. Set for all entities declared in the
2711 -- private part or body of a package. Also marks generic formals of a
2712 -- formal package declared without a box. For library level entities,
2713 -- this flag is set if the entity is not publicly visible. This flag
2714 -- is reset when compiling the body of the package where the entity
2715 -- is declared, when compiling the private part or body of a public
2716 -- child unit, and when compiling a private child unit (see Install_
2717 -- Private_Declaration in sem_ch7).
2719 -- Is_Hidden_Non_Overridden_Subpgm
2720 -- Defined in all entities. Set for implicitly declared subprograms
2721 -- that require overriding or are null procedures, and are hidden by
2722 -- a non-fully conformant homograph with the same characteristics
2723 -- (Ada RM 8.3 12.3/2).
2725 -- Is_Hidden_Open_Scope
2726 -- Defined in all entities. Set for a scope that contains the
2727 -- instantiation of a child unit, and whose entities are not visible
2728 -- during analysis of the instance.
2730 -- Is_Ignored_Ghost_Entity
2731 -- Applies to all entities. Set for abstract states, [generic] packages,
2732 -- [generic] subprograms, components, discriminants, formal parameters,
2733 -- objects, package bodies, subprogram bodies, and [sub]types subject to
2734 -- pragma Ghost or inherit "ghostness" from an enclosing construct, and
2735 -- subject to Assertion_Policy Ghost => Ignore.
2737 -- Is_Ignored_Transient
2738 -- Defined in constants, loop parameters of generalized iterators, and
2739 -- variables. Set when a transient object must be processed by one of
2740 -- the transient finalization mechanisms. Once marked, a transient is
2741 -- intentionally ignored by the general finalization mechanism because
2742 -- its clean up actions are context specific.
2744 -- Is_Immediately_Visible
2745 -- Defined in all entities. Set if entity is immediately visible, i.e.
2746 -- is defined in some currently open scope (RM 8.3(4)).
2748 -- Is_Implementation_Defined
2749 -- Defined in all entities. Set if a pragma Implementation_Defined is
2750 -- applied to the pragma. Used to mark all implementation defined
2751 -- identifiers in standard library packages, and to implement the
2752 -- restriction No_Implementation_Identifiers.
2754 -- Is_Imported
2755 -- Defined in all entities. Set if the entity is imported. For now we
2756 -- only allow the import of exceptions, functions, procedures, packages,
2757 -- constants, and variables. Exceptions, packages, and types can only be
2758 -- imported in the Java VM implementation, which is retired.
2760 -- Is_Incomplete_Or_Private_Type (synthesized)
2761 -- Applies to all entities, true for private and incomplete types
2763 -- Is_Incomplete_Type (synthesized)
2764 -- Applies to all entities, true for incomplete types and subtypes
2766 -- Is_Independent
2767 -- Defined in all types and objects. Set if a valid pragma or aspect
2768 -- Independent applies to the entity, or for a component if a valid
2769 -- pragma or aspect Independent_Components applies to the enclosing
2770 -- record type. Also set if a pragma Shared or pragma Atomic applies to
2771 -- the entity, or if the declaration of the entity carries the Aliased
2772 -- keyword. For Ada 2012, also applies to formal parameters. In the
2773 -- case of private and incomplete types, this flag is set in both the
2774 -- partial view and the full view.
2776 -- Is_Initial_Condition_Procedure
2777 -- Defined in functions and procedures. Set for a generated procedure
2778 -- which verifies the assumption of pragma Initial_Condition at run time.
2780 -- Is_Inlined
2781 -- Defined in all entities. Set for functions and procedures which are
2782 -- to be inlined. For subprograms created during expansion, this flag
2783 -- may be set directly by the expander to request inlining. Also set
2784 -- for packages that contain inlined subprograms, whose bodies must be
2785 -- be compiled. Is_Inlined is also set on generic subprograms and is
2786 -- inherited by their instances. It is also set on the body entities
2787 -- of inlined subprograms. See also Has_Pragma_Inline.
2789 -- Is_Inlined_Always
2790 -- Defined in subprograms. Set for functions and procedures which are
2791 -- always inlined in GNATprove mode. GNATprove uses this flag to know
2792 -- when a body does not need to be analyzed. The value of this flag is
2793 -- only meaningful if Body_To_Inline is not Empty for the subprogram.
2795 -- Is_Instantiated
2796 -- Defined in generic packages and generic subprograms. Set if the unit
2797 -- is instantiated from somewhere in the extended main source unit. This
2798 -- flag is used to control warnings about the unit being uninstantiated.
2799 -- Also set in a package that is used as an actual for a generic package
2800 -- formal in an instantiation. Also set on a parent instance, in the
2801 -- instantiation of a child, which is implicitly declared in the parent.
2803 -- Is_Integer_Type (synthesized)
2804 -- Applies to all entities, true for integer types and subtypes
2806 -- Is_Interface
2807 -- Defined in record types and subtypes. Set to indicate that the current
2808 -- entity corresponds to an abstract interface. Because abstract
2809 -- interfaces are conceptually a special kind of abstract tagged type
2810 -- we represent them by means of tagged record types and subtypes
2811 -- marked with this attribute. This allows us to reuse most of the
2812 -- compiler support for abstract tagged types to implement interfaces
2813 -- (Ada 2005: AI-251).
2815 -- Is_Internal
2816 -- Defined in all entities. Set to indicate an entity created during
2817 -- semantic processing (e.g. an implicit type, or a temporary). The
2818 -- current uses of this flag are:
2820 -- 1) Internal entities (such as temporaries generated for the result
2821 -- of an inlined function call or dummy variables generated for the
2822 -- debugger). Set to indicate that they need not be initialized, even
2823 -- when scalars are initialized or normalized.
2825 -- 2) Predefined primitives of tagged types. Set to mark that they
2826 -- have specific properties: first they are primitives even if they
2827 -- are not defined in the type scope (the freezing point is not
2828 -- necessarily in the same scope), and second the predefined equality
2829 -- can be overridden by a user-defined equality, no body will be
2830 -- generated in this case.
2832 -- 3) Object declarations generated by the expander that are implicitly
2833 -- imported or exported so that they can be marked in Sprint output.
2835 -- 4) Internal entities in the list of primitives of tagged types that
2836 -- are used to handle secondary dispatch tables. These entities have
2837 -- also the attribute Interface_Alias.
2839 -- Is_Interrupt_Handler
2840 -- Defined in procedures. Set if a pragma Interrupt_Handler applies
2841 -- to the procedure. The procedure must be a parameterless protected
2842 -- procedure.
2844 -- Is_Intrinsic_Subprogram
2845 -- Defined in functions and procedures. It is set if a valid pragma
2846 -- Interface or Import is present for this subprogram specifying
2847 -- convention Intrinsic. Valid means that the name and profile of the
2848 -- subprogram match the requirements of one of the recognized intrinsic
2849 -- subprograms (see package Sem_Intr for details). Note: the value of
2850 -- Convention for such an entity will be set to Convention_Intrinsic,
2851 -- but it is the setting of Is_Intrinsic_Subprogram, NOT simply having
2852 -- convention set to intrinsic, which causes intrinsic code to be
2853 -- generated.
2855 -- Is_Invariant_Procedure
2856 -- Defined in functions and procedures. Set for a generated invariant
2857 -- procedure which verifies the invariants of both the partial and full
2858 -- views of a private type or private extension as well as any inherited
2859 -- class-wide invariants from parent types or interfaces.
2861 -- Is_Itype
2862 -- Defined in all entities. Set to indicate that a type is an Itype,
2863 -- which means that the declaration for the type does not appear
2864 -- explicitly in the tree. Instead the backend will elaborate the type
2865 -- when it is first used. Has_Delayed_Freeze can be set for Itypes, and
2866 -- the meaning is that the first use (the one which causes the type to be
2867 -- defined) will be the freeze node. Note that an important restriction
2868 -- on Itypes is that the first use of such a type (the one that causes it
2869 -- to be defined) must be in the same scope as the type.
2871 -- Is_Known_Non_Null
2872 -- Defined in all entities. Relevant (and can be set) only for
2873 -- objects of an access type. It is set if the object is currently
2874 -- known to have a non-null value (meaning that no access checks
2875 -- are needed). The indication can for example come from assignment
2876 -- of an access parameter or an allocator whose value is known non-null.
2878 -- Note: this flag is set according to the sequential flow of the
2879 -- program, watching the current value of the variable. However, this
2880 -- processing can miss cases of changing the value of an aliased or
2881 -- constant object, so even if this flag is set, it should not be
2882 -- believed if the variable is aliased or volatile. It would be a
2883 -- little neater to avoid the flag being set in the first place in
2884 -- such cases, but that's trickier, and there is only one place that
2885 -- tests the value anyway.
2887 -- The flag is dynamically set and reset as semantic analysis and
2888 -- expansion proceeds. Its value is meaningless once the tree is
2889 -- fully constructed, since it simply indicates the last state.
2890 -- Thus this flag has no meaning to the backend.
2892 -- Is_Known_Null
2893 -- Defined in all entities. Relevant (and can be set ) only for
2894 -- objects of an access type. It is set if the object is currently known
2895 -- to have a null value (meaning that a dereference will surely raise
2896 -- constraint error exception). The indication can come from an
2897 -- assignment or object declaration.
2899 -- The comments above about sequential flow and aliased and volatile for
2900 -- the Is_Known_Non_Null flag apply equally to the Is_Known_Null flag.
2902 -- Is_Known_Valid
2903 -- Defined in all entities. Relevant for types (and subtype) and
2904 -- for objects (and enumeration literals) of a discrete type.
2906 -- The purpose of this flag is to implement the requirement stated
2907 -- in (RM 13.9.1(9-11)) which require that the use of possibly invalid
2908 -- values may not cause programs to become erroneous. See the function
2909 -- Checks.Expr_Known_Valid for further details. Note that the setting
2910 -- is conservative, in the sense that if the flag is set, it must be
2911 -- right. If the flag is not set, nothing is known about the validity.
2913 -- For enumeration literals, the flag is always set, since clearly
2914 -- an enumeration literal represents a valid value. Range checks
2915 -- where necessary will ensure that this valid value is appropriate.
2917 -- For objects, the flag indicates the state of knowledge about the
2918 -- current value of the object. This may be modified during expansion,
2919 -- and thus the final value is not relevant to the backend.
2921 -- For types and subtypes, the flag is set if all possible bit patterns
2922 -- of length Object_Size (i.e. Esize of the type) represent valid values
2923 -- of the type. In general for such types, all values are valid, the
2924 -- only exception being the case where an object of the type has an
2925 -- explicit size that is greater than Object_Size.
2927 -- For non-discrete objects, the setting of the Is_Known_Valid flag is
2928 -- not defined, and is not relevant, since the considerations of the
2929 -- requirement in (RM 13.9.1(9-11)) do not apply.
2931 -- The flag is dynamically set and reset as semantic analysis and
2932 -- expansion proceeds. Its value is meaningless once the tree is
2933 -- fully constructed, since it simply indicates the last state.
2934 -- Thus this flag has no meaning to the backend.
2936 -- Is_Limited_Composite
2937 -- Defined in all entities. Set for composite types that have a limited
2938 -- component. Used to enforce the rule that operations on the composite
2939 -- type that depend on the full view of the component do not become
2940 -- visible until the immediate scope of the composite type itself
2941 -- (RM 7.3.1 (5)).
2943 -- Is_Limited_Interface
2944 -- Defined in record types and subtypes. True for interface types, if
2945 -- interface is declared limited, task, protected, or synchronized, or
2946 -- is derived from a limited interface.
2948 -- Is_Limited_Record
2949 -- Defined in all entities. Set to true for record (sub)types if the
2950 -- record is declared to be limited. Note that this flag is not set
2951 -- simply because some components of the record are limited.
2953 -- Is_Local_Anonymous_Access
2954 -- Defined in access types. Set for an anonymous access type to indicate
2955 -- that the type is created for a record component with an access
2956 -- definition, an array component, or (pre-Ada 2012) a standalone object.
2957 -- Such anonymous types have an accessibility level equal to that of the
2958 -- declaration in which they appear, unlike the anonymous access types
2959 -- that are created for access parameters, access discriminants, and
2960 -- (as of Ada 2012) stand-alone objects.
2962 -- Is_Loop_Parameter
2963 -- Applies to all entities. Certain loops, in particular "for ... of"
2964 -- loops, get transformed so that the loop parameter is declared by a
2965 -- variable declaration, so the entity is an E_Variable. This is True for
2966 -- such E_Variables; False otherwise.
2968 -- Is_Machine_Code_Subprogram
2969 -- Defined in subprogram entities. Set to indicate that the subprogram
2970 -- is a machine code subprogram (i.e. its body includes at least one
2971 -- code statement). Also indicates that all necessary semantic checks
2972 -- as required by RM 13.8(3) have been performed.
2974 -- Is_Modular_Integer_Type (synthesized)
2975 -- Applies to all entities. True if entity is a modular integer type
2977 -- Is_Non_Static_Subtype
2978 -- Defined in all type and subtype entities. It is set in some (but not
2979 -- all) cases in which a subtype is known to be non-static. Before this
2980 -- flag was added, the computation of whether a subtype was static was
2981 -- entirely synthesized, by looking at the bounds, and the immediate
2982 -- subtype parent. However, this method does not work for some Itypes
2983 -- that have no parent set (and the only way to find the immediate
2984 -- subtype parent is to go through the tree). For now, this flag is set
2985 -- conservatively, i.e. if it is set then for sure the subtype is non-
2986 -- static, but if it is not set, then the type may or may not be static.
2987 -- Thus the test for a static subtype is that this flag is clear AND that
2988 -- the bounds are static AND that the parent subtype (if available to be
2989 -- tested) is static. Eventually we should make sure this flag is always
2990 -- set right, at which point, these comments can be removed, and the
2991 -- tests for static subtypes greatly simplified.
2993 -- Is_Null_Init_Proc
2994 -- Defined in procedure entities. Set for generated init proc procedures
2995 -- (used to initialize composite types), if the code for the procedure
2996 -- is null (i.e. is a return and nothing else). Such null initialization
2997 -- procedures are generated in case some client is compiled using the
2998 -- Initialize_Scalars pragma, generating a call to this null procedure,
2999 -- but there is no need to call such procedures within a compilation
3000 -- unit, and this flag is used to suppress such calls.
3002 -- Is_Null_State (synthesized)
3003 -- Applies to all entities, true for an abstract state declared with
3004 -- keyword null.
3006 -- Is_Numeric_Type (synthesized)
3007 -- Applies to all entities, true for all numeric types and subtypes
3008 -- (integer, fixed, float).
3010 -- Is_Object (synthesized)
3011 -- Applies to all entities, true for entities representing objects,
3012 -- including generic formal parameters.
3014 -- Is_Obsolescent
3015 -- Defined in all entities. Set for any entity to which a valid pragma
3016 -- or aspect Obsolescent applies.
3018 -- Is_Only_Out_Parameter
3019 -- Defined in formal parameter entities. Set if this parameter is the
3020 -- only OUT parameter for this formal part. If there is more than one
3021 -- out parameter, or if there is some other IN OUT parameter then this
3022 -- flag is not set in any of them. Used in generation of warnings.
3024 -- Is_Ordinary_Fixed_Point_Type (synthesized)
3025 -- Applies to all entities, true for ordinary fixed point types and
3026 -- subtypes.
3028 -- Is_Package_Body_Entity
3029 -- Defined in all entities. Set for entities defined at the top level
3030 -- of a package body. Used to control externally generated names.
3032 -- Is_Package_Or_Generic_Package (synthesized)
3033 -- Applies to all entities. True for packages and generic packages.
3034 -- False for all other entities.
3036 -- Is_Packed [implementation base type only]
3037 -- Defined in all type entities. This flag is set only for record and
3038 -- array types which have a packed representation. There are four cases
3039 -- which cause packing:
3041 -- 1. Explicit use of pragma Pack to pack a record.
3042 -- 2. Explicit use of pragma Pack to pack an array.
3043 -- 3. Setting Component_Size of an array to a packable value.
3044 -- 4. Indexing an array with a non-standard enumeration type.
3046 -- For records, Is_Packed is always set if Has_Pragma_Pack is set, and
3047 -- can also be set on its own in a derived type which inherited its
3048 -- packed status.
3050 -- For arrays, Is_Packed is set if either Has_Pragma_Pack is set and the
3051 -- component size is either not known at compile time or known but not
3052 -- 8/16/32/64 bits, or a Component_Size clause exists and the specified
3053 -- value is smaller than 64 bits but not 8/16/32, or if the array has one
3054 -- or more index types that are enumeration types with a non-standard
3055 -- representation (in GNAT, we store such arrays compactly, using the Pos
3056 -- of the enumeration type value). As for the case of records, Is_Packed
3057 -- can be set on its own for a derived type.
3059 -- Before an array type is frozen, Is_Packed will always be set if
3060 -- Has_Pragma_Pack is set. Before the freeze point, it is not possible
3061 -- to know the component size, since the component type is not frozen
3062 -- until the array type is frozen. Thus Is_Packed for an array type
3063 -- before it is frozen means that packed is required. Then if it turns
3064 -- out that the component size doesn't require packing, the Is_Packed
3065 -- flag gets turned off.
3067 -- In the bit-packed array case (i.e. the component size is known by the
3068 -- front end and is in the range 1-63 but not a multiple of 8), then the
3069 -- Is_Bit_Packed_Array flag will be set once the array type is frozen.
3071 -- Is_Packed_Array (synth)
3072 -- Applies to all entities, true if entity is for a packed array.
3074 -- Is_Packed_Array_Impl_Type
3075 -- Defined in all entities. This flag is set on the entity for the type
3076 -- used to implement a packed array (either a modular type or a subtype
3077 -- of Packed_Bytes{1,2,4} in the bit-packed array case, a regular array
3078 -- in the non-standard enumeration index case). It is set if and only
3079 -- if the type appears in the Packed_Array_Impl_Type field of some other
3080 -- entity. It is used by the back end to activate the special processing
3081 -- for such types (unchecked conversions that would not otherwise be
3082 -- allowed are allowed for such types). If Is_Packed_Array_Impl_Type is
3083 -- set in an entity, then the Original_Array_Type field of this entity
3084 -- points to the array type for which this is the Packed_Array_Impl_Type.
3086 -- Is_Param_Block_Component_Type [base type only]
3087 -- Defined in access types. Set to indicate that a type is the type of a
3088 -- component of the parameter block record type generated by the compiler
3089 -- for an entry or a select statement. Read by CodePeer.
3091 -- Is_Partial_Invariant_Procedure
3092 -- Defined in functions and procedures. Set for a generated invariant
3093 -- procedure which verifies the invariants of the partial view of a
3094 -- private type or private extension.
3096 -- Is_Not_Self_Hidden
3097 -- Defined in all entities. Roughly speaking, this is False if the
3098 -- declaration of the entity is hidden from all visibility because
3099 -- we are within its declaration, as defined by 8.3(16-18). When
3100 -- we reach the end of the declaration or other place defined by
3101 -- 8.3(16-18), this is set to True. However, this flag is not used
3102 -- for most overloaded declarations (but is used for enumeration
3103 -- literals), and is also used for other cases of premature usage
3104 -- such as defined in 3.8(10) for record components and the like.
3105 -- In addition, there are cases involving discriminants where we
3106 -- set this True, then temporarily False again.
3108 -- Is_Potentially_Use_Visible
3109 -- Defined in all entities. Set if entity is potentially use visible,
3110 -- i.e. it is defined in a package that appears in a currently active
3111 -- use clause (RM 8.4(8)). Note that potentially use visible entities
3112 -- are not necessarily use visible (RM 8.4(9-11)).
3114 -- Is_Predicate_Function
3115 -- Present in functions and procedures. Set for generated predicate
3116 -- functions.
3118 -- Is_Preelaborated
3119 -- Defined in all entities, set in E_Package and E_Generic_Package
3120 -- entities to which a pragma Preelaborate is applied, and also in
3121 -- all entities within such packages. Note that the fact that this
3122 -- flag is set does not necessarily mean that no elaboration code is
3123 -- generated for the package.
3125 -- Is_Primitive
3126 -- Defined in overloadable entities and in generic subprograms. Set to
3127 -- indicate that this is a primitive operation of some type, which may
3128 -- be a tagged type or an untagged type. Used to verify overriding
3129 -- indicators in bodies.
3131 -- Is_Primitive_Wrapper
3132 -- Defined in functions and procedures created by the expander to serve
3133 -- as an indirection mechanism to overriding primitives of concurrent
3134 -- types, entries and protected procedures.
3136 -- Is_Prival (synthesized)
3137 -- Applies to all entities, true for renamings of private protected
3138 -- components. Such entities appear as constants or variables.
3140 -- Is_Private_Composite
3141 -- Defined in composite types that have a private component. Used to
3142 -- enforce the rule that operations on the composite type that depend
3143 -- on the full view of the component, do not become visible until the
3144 -- immediate scope of the composite type itself (7.3.1 (5)). Both this
3145 -- flag and Is_Limited_Composite are needed.
3147 -- Is_Private_Descendant
3148 -- Defined in entities that can represent library units (packages,
3149 -- functions, procedures). Set if the library unit is itself a private
3150 -- child unit, or if it is the descendant of a private child unit.
3152 -- Is_Private_Primitive
3153 -- Defined in subprograms. Set if the operation is a primitive of a
3154 -- tagged type (procedure or function dispatching on result) whose
3155 -- full view has not been seen. Used in particular for primitive
3156 -- subprograms of a synchronized type declared between the two views
3157 -- of the type, so that the wrapper built for such a subprogram can
3158 -- be given the proper signature.
3160 -- Is_Private_Type (synthesized)
3161 -- Applies to all entities, true for private types and subtypes,
3162 -- as well as for record with private types as subtypes.
3164 -- Is_Protected_Component (synthesized)
3165 -- Applicable to all entities, true if the entity denotes a private
3166 -- component of a protected type.
3168 -- Is_Protected_Interface (synthesized)
3169 -- Defined in types that are interfaces. True if interface is declared
3170 -- protected, or is derived from protected interfaces.
3172 -- Is_Protected_Record_Type (synthesized)
3173 -- Applies to all entities, true if Is_Concurrent_Record_Type is true and
3174 -- Corresponding_Concurrent_Type is a protected type.
3176 -- Is_Protected_Type (synthesized)
3177 -- Applies to all entities, true for protected types and subtypes
3179 -- Is_Public
3180 -- Defined in all entities. Set to indicate that an entity defined in
3181 -- one compilation unit can be referenced from other compilation units.
3182 -- If this reference causes a reference in the generated code, for
3183 -- example in the case of a variable name, then the backend will generate
3184 -- an appropriate external name for use by the linker.
3186 -- Is_Pure
3187 -- Defined in all entities. Set in all entities of a unit to which a
3188 -- pragma Pure is applied except for non-intrinsic imported subprograms,
3189 -- and also set for the entity of the unit itself. In addition, this
3190 -- flag may be set for any other functions or procedures that are known
3191 -- to be side effect free, so in the case of subprograms, the Is_Pure
3192 -- flag may be used by the optimizer to imply that it can assume freedom
3193 -- from side effects (other than those resulting from assignment to Out
3194 -- or In Out parameters, or to objects designated by access parameters).
3196 -- Is_Pure_Unit_Access_Type
3197 -- Defined in access type and subtype entities. Set if the type or
3198 -- subtype appears in a pure unit. Used to give an error message at
3199 -- freeze time if the access type has a storage pool.
3201 -- Is_RACW_Stub_Type
3202 -- Defined in all types, true for the stub types generated for remote
3203 -- access-to-class-wide types.
3205 -- Is_Raised
3206 -- Defined in exception entities. Set if the entity is referenced by a
3207 -- a raise statement.
3209 -- Is_Real_Type (synthesized)
3210 -- Applies to all entities, true for real types and subtypes
3212 -- Is_Record_Type (synthesized)
3213 -- Applies to all entities, true for record types and subtypes,
3214 -- includes class-wide types and subtypes (which are also records).
3216 -- Is_Relaxed_Initialization_State (synthesized)
3217 -- Applies to all entities, true for abstract states that are subject to
3218 -- option Relaxed_Initialization.
3220 -- Is_Remote_Call_Interface
3221 -- Defined in all entities. Set in E_Package and E_Generic_Package
3222 -- entities to which a pragma Remote_Call_Interface is applied, and
3223 -- also on entities declared in the visible part of such a package.
3225 -- Is_Remote_Types
3226 -- Defined in all entities. Set in E_Package and E_Generic_Package
3227 -- entities to which a pragma Remote_Types is applied, and also on
3228 -- entities declared in the visible part of the spec of such a package.
3229 -- Also set for types which are generic formal types to which the
3230 -- pragma Remote_Access_Type applies.
3232 -- Is_Renaming_Of_Object
3233 -- Defined in all entities, set only for a variable or constant for
3234 -- which the Renamed_Object field is non-empty and for which the
3235 -- renaming is handled by the front end, by macro substitution of
3236 -- a copy of the (evaluated) name tree wherever the variable is used.
3238 -- Is_Return_Object
3239 -- Defined in all object entities. True if the object is the return
3240 -- object of an extended_return_statement; False otherwise.
3242 -- Is_Safe_To_Reevaluate
3243 -- Defined in all entities. Set in variables that are initialized by
3244 -- means of an assignment statement. When initialized their contents
3245 -- never change and hence they can be seen by the backend as constants.
3246 -- See also Is_True_Constant.
3248 -- Is_Scalar_Type (synthesized)
3249 -- Applies to all entities, true for scalar types and subtypes
3251 -- Is_Shared_Passive
3252 -- Defined in all entities. Set in E_Package and E_Generic_Package
3253 -- entities to which a pragma Shared_Passive is applied, and also in
3254 -- all entities within such packages.
3256 -- Is_Standard_Character_Type (synthesized)
3257 -- Applies to all entities, true for types and subtypes whose root type
3258 -- is one of the standard character types (Character, Wide_Character, or
3259 -- Wide_Wide_Character).
3261 -- Is_Standard_String_Type (synthesized)
3262 -- Applies to all entities, true for types and subtypes whose root
3263 -- type is one of the standard string types (String, Wide_String, or
3264 -- Wide_Wide_String).
3266 -- Is_Static_Type
3267 -- Defined in entities. Only set for (sub)types. If set, indicates that
3268 -- the type is known to be a static type (defined as a discrete type with
3269 -- static bounds, a record all of whose component types are static types,
3270 -- or an array, all of whose bounds are of a static type, and also have
3271 -- a component type that is a static type). See Set_Uplevel_Type for more
3272 -- information on how this flag is used.
3274 -- Is_Statically_Allocated
3275 -- Defined in all entities. This can only be set for exception,
3276 -- variable, constant, and type/subtype entities. If the flag is set,
3277 -- then the variable or constant must be allocated statically rather
3278 -- than on the local stack frame. For exceptions, the meaning is that
3279 -- the exception data should be allocated statically (and indeed this
3280 -- flag is always set for exceptions, since exceptions do not have
3281 -- local scope). For a type, the meaning is that the type must be
3282 -- elaborated at the global level rather than locally. No type marked
3283 -- with this flag may depend on a local variable, or on any other type
3284 -- which does not also have this flag set to True. For a variable or
3285 -- or constant, if the flag is set, then the type of the object must
3286 -- either be declared at the library level, or it must also have the
3287 -- flag set (since to allocate the object statically, its type must
3288 -- also be elaborated globally).
3290 -- Is_String_Type (synthesized)
3291 -- Applies to all type entities. Determines if the given type is a
3292 -- string type, i.e. it is directly a string type or string subtype,
3293 -- or a string slice type, or an array type with one dimension and a
3294 -- component type that is a character type.
3296 -- Is_Subprogram (synthesized)
3297 -- Applies to all entities, true for function, procedure and operator
3298 -- entities.
3300 -- Is_Subprogram_Or_Generic_Subprogram
3301 -- Applies to all entities, true for function procedure and operator
3302 -- entities, and also for the corresponding generic entities.
3304 -- Is_Synchronized_Interface (synthesized)
3305 -- Defined in types that are interfaces. True if interface is declared
3306 -- synchronized, task, or protected, or is derived from a synchronized
3307 -- interface.
3309 -- Is_Synchronized_State (synthesized)
3310 -- Applies to all entities, true for abstract states that are subject to
3311 -- option Synchronous.
3313 -- Is_Tag
3314 -- Defined in E_Component and E_Constant entities. For regular tagged
3315 -- type this flag is set on the tag component (whose name is Name_uTag).
3316 -- For CPP_Class tagged types, this flag marks the pointer to the main
3317 -- vtable (i.e. the one to be extended by derivation).
3319 -- Is_Tagged_Type
3320 -- Defined in all entities, set for an entity that is a tagged type
3322 -- Is_Task_Interface (synthesized)
3323 -- Defined in types that are interfaces. True if interface is declared as
3324 -- a task interface, or if it is derived from task interfaces.
3326 -- Is_Task_Record_Type (synthesized)
3327 -- Applies to all entities, true if Is_Concurrent_Record_Type is true and
3328 -- Corresponding_Concurrent_Type is a task type.
3330 -- Is_Task_Type (synthesized)
3331 -- Applies to all entities. True for task types and subtypes
3333 -- Is_Thunk
3334 -- Defined in all entities. True for subprograms that are thunks, that is
3335 -- small subprograms built by the expander for particular tagged types.
3336 -- There are two different kinds of thunk: interface thunk and secondary
3337 -- stack thunk. Interface thunks are built for tagged types that cover
3338 -- interface types. As part of the runtime call to an interface, they
3339 -- displace the pointer to the object (pointer named "this" in the C++
3340 -- terminology) from a secondary dispatch table to the primary dispatch
3341 -- table associated with a given tagged type; if the thunk is a function
3342 -- that returns an object which covers an interface type then the thunk
3343 -- displaces the pointer to the object from the primary dispatch table to
3344 -- the secondary dispatch table associated with the interface type.
3346 -- Secondary stack thunks are built for tagged types that do not need to
3347 -- be returned on the secondary stack but have primitive functions which
3348 -- can dispatch on result. In this case, dispatching calls made to these
3349 -- primitive functions nevertheless need to return on the secondary stack
3350 -- and a thunk is built to move the result from the primary stack onto
3351 -- the secondary stack on return from the primitive function. The flag
3352 -- Has_Controlling_Result is set on secondary stack thunks but not on
3353 -- interface thunks.
3355 -- Thunks may be chained in a single way: an interface thunk may point to
3356 -- a secondary stack thunk, which points to the final thunk target.
3358 -- Is_Trivial_Subprogram
3359 -- Defined in all entities. Set in subprograms where either the body
3360 -- consists of a single null statement, or the first or only statement
3361 -- of the body raises an exception. This is used for suppressing certain
3362 -- warnings, see Sem_Ch6.Analyze_Subprogram_Body discussion for details.
3364 -- Is_True_Constant
3365 -- Defined in all entities for constants and variables. Set in constants
3366 -- and variables which have an initial value specified but which are
3367 -- never assigned, partially or in the whole. For variables, it means
3368 -- that the variable was initialized but never modified, and hence can be
3369 -- treated as a constant by the code generator. For a constant, it means
3370 -- that the constant was not modified by generated code (e.g. to set a
3371 -- discriminant in an init proc). Assignments by user or generated code
3372 -- will reset this flag. See also Is_Safe_To_Reevaluate.
3374 -- Is_Type (synthesized)
3375 -- Applies to all entities, true for a type entity
3377 -- Is_Unchecked_Union [implementation base type only]
3378 -- Defined in all entities. Set only in record types to which the
3379 -- pragma Unchecked_Union has been validly applied.
3381 -- Is_Underlying_Full_View
3382 -- Defined in all entities. Set for types which represent the true full
3383 -- view of a private type completed by another private type. For further
3384 -- details, see attribute Underlying_Full_View.
3386 -- Is_Underlying_Record_View [base type only]
3387 -- Defined in all entities. Set only in record types that represent the
3388 -- underlying record view. This view is built for derivations of types
3389 -- with unknown discriminants; it is a record with the same structure
3390 -- as its corresponding record type, but whose parent is the full view
3391 -- of the parent in the original type extension.
3393 -- Is_Unimplemented
3394 -- Defined in all entities. Set for any entity to which a valid pragma
3395 -- or aspect Unimplemented applies.
3397 -- Is_Unsigned_Type
3398 -- Defined in all types, but can be set only for discrete and fixed-point
3399 -- type and subtype entities. This flag is only valid if the entity is
3400 -- frozen. If set it indicates that the representation is known to be
3401 -- unsigned (i.e. that no negative values appear in the range). This is
3402 -- normally just a reflection of the lower bound of the subtype or base
3403 -- type, but there is one case in which the setting is not obvious,
3404 -- namely the case of an unsigned subtype of a signed type from which
3405 -- a further subtype is obtained using variable bounds. This further
3406 -- subtype is still unsigned, but this cannot be determined by looking
3407 -- at its bounds or the bounds of the corresponding base type.
3408 -- For a subtype indication whose range is statically a null range,
3409 -- the flag is set if the lower bound is non-negative, but the flag
3410 -- cannot be used to determine the comparison operator to emit in the
3411 -- generated code: use the base type.
3413 -- Is_Uplevel_Referenced_Entity
3414 -- Defined in all entities. Used when unnesting subprograms to indicate
3415 -- that an entity is locally defined within a subprogram P, and there is
3416 -- a reference to the entity within a subprogram nested within P (at any
3417 -- depth). Set for uplevel referenced objects (variables, constants,
3418 -- discriminants and loop parameters), and also for upreferenced dynamic
3419 -- types, including the cases where the reference is implicit (e.g. the
3420 -- type of an array used for computing the location of an element in an
3421 -- array. This is used internally in Exp_Unst, see this package for
3422 -- further details.
3424 -- Is_Valued_Procedure
3425 -- Defined in procedure entities. Set if an Import_Valued_Procedure
3426 -- or Export_Valued_Procedure pragma applies to the procedure entity.
3428 -- Is_Visible_Formal
3429 -- Defined in all entities. Set for instances of the formals of a
3430 -- formal package. Indicates that the entity must be made visible in the
3431 -- body of the instance, to reproduce the visibility of the generic.
3432 -- This simplifies visibility settings in instance bodies.
3434 -- Is_Visible_Lib_Unit
3435 -- Defined in all (root or child) library unit entities. Once compiled,
3436 -- library units remain chained to the entities in the parent scope, and
3437 -- a separate flag must be used to indicate whether the names are visible
3438 -- by selected notation, or not.
3440 -- Is_Volatile
3441 -- Defined in all type entities, and also in constants, components and
3442 -- variables. Set if a pragma Volatile applies to the entity. Also set
3443 -- if pragma Shared or pragma Atomic applies to entity. In the case of
3444 -- private or incomplete types, this flag is set in both the private
3445 -- and full view. The flag is not set reliably on private subtypes,
3446 -- and is always retrieved from the base type (but this is not a base-
3447 -- type-only attribute because it applies to other entities). Note that
3448 -- the backend should use Treat_As_Volatile, rather than Is_Volatile
3449 -- to indicate code generation requirements for volatile variables.
3450 -- Similarly, any front end test which is concerned with suppressing
3451 -- optimizations on volatile objects should test Treat_As_Volatile
3452 -- rather than testing this flag.
3453 -- This is a synthesized attribute in Einfo.Utils, based on
3454 -- Is_Volatile_Type and Is_Volatile_Object. The latter two should be
3455 -- used in preference to Is_Volatile when we know that we have a type
3456 -- or an object.
3458 -- Is_Volatile_Full_Access
3459 -- Defined in all type entities, and also in constants, components, and
3460 -- variables. Set if an aspect/pragma Volatile_Full_Access or an Ada 2022
3461 -- aspect Full_Access_Only applies to the entity. In the case of private
3462 -- and incomplete types, this flag is set in both the partial view and
3463 -- the full view.
3465 -- Is_Wrapper_Package (synthesized)
3466 -- Defined in package entities. Indicates that the package has been
3467 -- created as a wrapper for a subprogram instantiation.
3469 -- Is_Wrapper
3470 -- Defined in subprogram entities. Indicates that it has been created as
3471 -- a wrapper to handle inherited class-wide pre/post conditions that call
3472 -- overridden primitives or as a wrapper of a controlling function.
3474 -- Itype_Printed
3475 -- Defined in all type and subtype entities. Set in Itypes if the Itype
3476 -- has been printed by Sprint. This is used to avoid printing an Itype
3477 -- more than once.
3479 -- Kill_Elaboration_Checks
3480 -- Defined in all entities. Set by the expander to kill elaboration
3481 -- checks which are known not to be needed. Equivalent in effect to
3482 -- the use of pragma Suppress (Elaboration_Checks) for that entity
3483 -- except that the effect is permanent and cannot be undone by a
3484 -- subsequent pragma Unsuppress.
3486 -- Kill_Range_Checks
3487 -- Defined in all entities. Equivalent in effect to the use of pragma
3488 -- Suppress (Range_Checks) for that entity except that the result is
3489 -- permanent and cannot be undone by a subsequent pragma Unsuppress.
3490 -- This is currently only used in one odd situation in Sem_Ch3 for
3491 -- record types, and it would be good to get rid of it???
3493 -- Known_To_Have_Preelab_Init
3494 -- Defined in all type and subtype entities. If set, then the type is
3495 -- known to have preelaborable initialization. In the case of a partial
3496 -- view of a private type, it is only possible for this to be set if a
3497 -- pragma Preelaborable_Initialization is given for the type. For other
3498 -- types, it is never set if the type does not have preelaborable
3499 -- initialization, it may or may not be set if the type does have
3500 -- preelaborable initialization.
3502 -- Last_Aggregate_Assignment
3503 -- Applies to controlled constants and variables initialized by an
3504 -- aggregate. Points to the last statement associated with the expansion
3505 -- of the aggregate. The attribute is used by the finalization machinery
3506 -- when marking an object as successfully initialized.
3508 -- Last_Assignment
3509 -- Defined in entities for variables, and OUT or IN OUT formals. Set for
3510 -- a local variable or formal to point to the left side of an assignment
3511 -- statement assigning a value to the variable. Cleared if the value of
3512 -- the entity is referenced. Used to warn about dubious assignment
3513 -- statements whose value is not used.
3515 -- Last_Entity
3516 -- Defined for the same entity kinds as First_Entity. Last_Entity
3517 -- is the last entry in the list. Empty if no entities are chained.
3519 -- Last_Formal (synthesized)
3520 -- Applies to subprograms and subprogram types, and also in entries
3521 -- and entry families. Returns last formal of the subprogram or entry.
3522 -- The formals are the first entities declared in a subprogram or in
3523 -- a subprogram type (the designated type of an Access_To_Subprogram
3524 -- definition) or in an entry.
3526 -- Limited_View
3527 -- Defined in non-generic package entities that are not instances. Bona
3528 -- fide package with the limited-view list through the first_entity and
3529 -- first_private attributes. The elements of this list are the shadow
3530 -- entities created for the types and local packages that are declared
3531 -- in a package appearing in a limited_with clause (Ada 2005: AI-50217).
3533 -- Linker_Section_Pragma
3534 -- Present in constant, variable, type and subprogram entities. Points
3535 -- to a linker section pragma that applies to the entity, or is Empty if
3536 -- no such pragma applies. Note that for constants and variables, this
3537 -- field may be set as a result of a linker section pragma applied to the
3538 -- type of the object.
3540 -- Lit_Hash [root type only]
3541 -- Defined in enumeration types and subtypes. Non-empty only for the
3542 -- case of an enumeration root type, where it contains the entity for
3543 -- the generated hash function. See unit Exp_Imgv for full details of
3544 -- the nature and use of this entity for implementing the Value
3545 -- attribute for the enumeration type in question.
3547 -- Lit_Indexes
3548 -- Defined in enumeration types and subtypes. Non-empty only for the
3549 -- case of an enumeration root type, where it contains the entity for
3550 -- the generated indexes entity. See unit Exp_Imgv for full details of
3551 -- the nature and use of this entity for implementing the Image and
3552 -- Value attributes for the enumeration type in question.
3554 -- Lit_Strings
3555 -- Defined in enumeration types and subtypes. Non-empty only for the
3556 -- case of an enumeration root type, where it contains the entity for
3557 -- the literals string entity. See unit Exp_Imgv for full details of
3558 -- the nature and use of this entity for implementing the Image and
3559 -- Value attributes for the enumeration type in question.
3561 -- Low_Bound_Tested
3562 -- Defined in all entities. Currently this can only be set for formal
3563 -- parameter entries of a standard unconstrained one-dimensional array
3564 -- or string type. Indicates that an explicit test of the low bound of
3565 -- the formal appeared in the code, e.g. in a pragma Assert. If this
3566 -- flag is set, warnings about assuming the index low bound to be one
3567 -- are suppressed.
3569 -- Machine_Radix_10
3570 -- Defined in decimal types and subtypes, set if the Machine_Radix is 10,
3571 -- as the result of the specification of a machine radix representation
3572 -- clause. Note that it is possible for this flag to be set without
3573 -- having Has_Machine_Radix_Clause True. This happens when a type is
3574 -- derived from a type with a clause present.
3576 -- Master_Id
3577 -- Defined in access types and subtypes. Empty unless Has_Task is set for
3578 -- the designated type, in which case it points to the entity for the
3579 -- Master_Id for the access type master. Also set for access-to-limited-
3580 -- class-wide types whose root may be extended with task components, and
3581 -- for access-to-limited-interfaces because they can be used to reference
3582 -- tasks implementing such interface.
3584 -- Materialize_Entity
3585 -- Defined in all entities. Set only for renamed obects which should be
3586 -- materialized for debugging purposes. This means that a memory location
3587 -- containing the renamed address should be allocated. This is needed so
3588 -- that the debugger can find the entity.
3590 -- May_Inherit_Delayed_Rep_Aspects
3591 -- Defined in all entities for types and subtypes. Set if the type is
3592 -- derived from a type which has delayed rep aspects (marked by the flag
3593 -- Has_Delayed_Rep_Aspects being set). In this case, at the freeze point
3594 -- for the derived type we know that the parent type is frozen, and if
3595 -- a given attribute has not been set for the derived type, we copy the
3596 -- value from the parent type. See Freeze.Inherit_Delayed_Rep_Aspects.
3598 -- Mechanism (returned as Mechanism_Type)
3599 -- Defined in functions and non-generic formal parameters. Indicates
3600 -- the mechanism to be used for the function return or for the formal
3601 -- parameter. See full description in the spec of Sem_Mech. This field
3602 -- is also set (to the default value of zero = Default_Mechanism) in a
3603 -- subprogram body entity but not used in this context.
3605 -- Minimum_Accessibility
3606 -- Defined in formal parameters in the non-generic case. Normally Empty,
3607 -- but if expansion is active, and a parameter exists for which a
3608 -- dynamic accessibility check is required, then an object is generated
3609 -- within such a subprogram representing the accessibility level of the
3610 -- subprogram or the formal's Extra_Accessibility - whichever one is
3611 -- lesser. The Minimum_Accessibility field then points to this object.
3613 -- Modulus [base type only]
3614 -- Defined in modular types. Contains the modulus. For the binary case,
3615 -- this will be a power of 2, but if Non_Binary_Modulus is set, then it
3616 -- will not be a power of 2.
3618 -- Must_Be_On_Byte_Boundary
3619 -- Defined in entities for types and subtypes. Set if objects of the type
3620 -- must always be allocated on a byte boundary (more accurately a storage
3621 -- unit boundary). The front end checks that component clauses respect
3622 -- this rule, and the backend ensures that record packing does not
3623 -- violate this rule. Currently the flag is set only for packed arrays
3624 -- longer than 64 bits where the component size is not a power of 2.
3626 -- Must_Have_Preelab_Init
3627 -- Defined in entities for types and subtypes. Set in the full type of a
3628 -- private type or subtype if a pragma Has_Preelaborable_Initialization
3629 -- is present for the private type. Used to check that the full type has
3630 -- preelaborable initialization at freeze time (this has to be deferred
3631 -- to the freeze point because of the rule about overriding Initialize).
3633 -- Needs_Activation_Record
3634 -- Defined on generated subprogram types. Indicates that a call through
3635 -- a named or anonymous access to subprogram requires an activation
3636 -- record when compiling with unnesting for C or LLVM.
3638 -- Needs_Debug_Info
3639 -- Defined in all entities. Set if the entity requires normal debugging
3640 -- information to be generated. This is true of all entities that have
3641 -- Comes_From_Source set, and also transitively for entities associated
3642 -- with such components (e.g. their types). It is true for all entities
3643 -- in Debug_Generated_Code mode (-gnatD switch). This is the flag that
3644 -- the backend should check to determine whether or not to generate
3645 -- debugging information for an entity. Note that callers should always
3646 -- use Sem_Util.Set_Debug_Info_Needed, rather than Set_Needs_Debug_Info,
3647 -- so that the flag is set properly on subsidiary entities.
3649 -- Needs_No_Actuals
3650 -- Defined in callable entities (subprograms, entries, access to
3651 -- subprograms) which can be called without actuals because all of
3652 -- their formals (if any) have default values. This flag simplifies the
3653 -- resolution of the syntactic ambiguity involving a call to these
3654 -- entities when the return type is an array type, and a call can be
3655 -- interpreted as an indexing of the result of the call. It is also
3656 -- used to resolve various cases of entry calls.
3658 -- Never_Set_In_Source
3659 -- Defined in all entities, but can be set only for variables and
3660 -- parameters. This flag is set if the object is never assigned a value
3661 -- in user source code, either by assignment or by being used as an out
3662 -- or in out parameter. Note that this flag is not reset from using an
3663 -- initial value, so if you want to test for this case as well, test the
3664 -- Has_Initial_Value flag also.
3666 -- This flag is only for the purposes of issuing warnings, it must not
3667 -- be used by the code generator to indicate that the variable is in
3668 -- fact a constant, since some assignments in generated code do not
3669 -- count (for example, the call to an init proc to assign some but
3670 -- not all of the fields in a partially initialized record). The code
3671 -- generator should instead use the flag Is_True_Constant.
3673 -- For the purposes of this warning, the default assignment of access
3674 -- variables to null is not considered the assignment of a value (so
3675 -- the warning can be given for code that relies on this initial null
3676 -- value when no other value is ever set).
3678 -- In variables and out parameters, if this flag is set after full
3679 -- processing of the corresponding declarative unit, it indicates that
3680 -- the variable or parameter was never set, and a warning message can
3681 -- be issued.
3683 -- Note: this flag is initially set, and then cleared on encountering
3684 -- any construct that might conceivably legitimately set the value.
3685 -- Thus during the analysis of a declarative region and its associated
3686 -- statement sequence, the meaning of the flag is "not set yet", and
3687 -- once this analysis is complete the flag means "never assigned".
3689 -- Note: for variables appearing in package declarations, this flag is
3690 -- never set. That is because there is no way to tell if some client
3691 -- modifies the variable (or, in the case of variables in the private
3692 -- part, if some child unit modifies the variables).
3694 -- Note: in the case of renamed objects, the flag must be set in the
3695 -- ultimate renamed object. Clients noting a possible modification
3696 -- should use the Note_Possible_Modification procedure in Sem_Util
3697 -- rather than Set_Never_Set_In_Source precisely to deal properly with
3698 -- the renaming possibility.
3700 -- Next_Component (synthesized)
3701 -- Applies to record components. Returns the next component by following
3702 -- the chain of declared entities until one is found which corresponds to
3703 -- a component (Ekind is E_Component). Any internal types generated from
3704 -- the subtype indications of the record components are skipped. Returns
3705 -- Empty if no more components.
3707 -- Next_Component_Or_Discriminant (synthesized)
3708 -- Similar to Next_Component, but includes components and discriminants
3709 -- so the input can have either E_Component or E_Discriminant, and the
3710 -- same is true for the result. Returns Empty if no more components or
3711 -- discriminants in the record.
3713 -- Next_Discriminant (synthesized)
3714 -- Applies to discriminants returned by First/Next_Discriminant. Returns
3715 -- the next language-defined (i.e. perhaps non-stored) discriminant by
3716 -- following the chain of declared entities as long as the kind of the
3717 -- entity corresponds to a discriminant. Note that the discriminants
3718 -- might be the only components of the record. Returns Empty if there
3719 -- are no more discriminants.
3721 -- Next_Entity
3722 -- Defined in all entities. The entities of a scope are chained, with
3723 -- the head of the list being in the First_Entity field of the scope
3724 -- entity. All entities use the Next_Entity field as a forward pointer
3725 -- for this list, with Empty indicating the end of the list. Since this
3726 -- field is in the base part of the entity, the access routines for this
3727 -- field are in Sinfo.
3729 -- Next_Formal (synthesized)
3730 -- Applies to the entity for a formal parameter. Returns the next formal
3731 -- parameter of the subprogram or subprogram type. Returns Empty if there
3732 -- are no more formals.
3734 -- Next_Formal_With_Extras (synthesized)
3735 -- Applies to the entity for a formal parameter. Returns the next
3736 -- formal parameter of the subprogram or subprogram type. Returns
3737 -- Empty if there are no more formals. The list returned includes
3738 -- all the extra formals (see description of Extra_Formal field)
3740 -- Next_Index (synthesized)
3741 -- Applies to array types and subtypes and to string types and
3742 -- subtypes. Yields the next index. The first index is obtained by
3743 -- using the First_Index attribute, and then subsequent indexes are
3744 -- obtained by applying Next_Index to the previous index. Empty is
3745 -- returned to indicate that there are no more indexes. Note that
3746 -- unlike most attributes in this package, Next_Index applies to
3747 -- nodes for the indexes, not to entities.
3749 -- Next_Inlined_Subprogram
3750 -- Defined in subprograms. Used to chain inlined subprograms used in
3751 -- the current compilation, in the order in which they must be compiled
3752 -- by the backend to ensure that all inlinings are performed.
3754 -- Next_Literal (synthesized)
3755 -- Applies to enumeration literals, returns the next literal, or
3756 -- Empty if applied to the last literal. This is actually a synonym
3757 -- for Next, but its use is preferred in this context.
3759 -- No_Dynamic_Predicate_On_Actual
3760 -- Defined in discrete types. Set for generic formal types that are used
3761 -- in loops and quantified expressions. The corresponding actual cannot
3762 -- have dynamic predicates.
3764 -- No_Pool_Assigned [root type only]
3765 -- Defined in access types. Set if a storage size clause applies to the
3766 -- variable with a static expression value of zero. This flag is used to
3767 -- generate errors if any attempt is made to allocate or free an instance
3768 -- of such an access type. This is set only in the root type, since
3769 -- derived types must have the same pool.
3771 -- No_Predicate_On_Actual
3772 -- Defined in discrete types. Set for generic formal types that are used
3773 -- in the spec of a generic package, in constructs that forbid discrete
3774 -- types with predicates.
3776 -- No_Reordering [implementation base type only]
3777 -- Defined in record types. Set only for a base type to which a valid
3778 -- pragma No_Component_Reordering applies.
3780 -- No_Return
3781 -- Defined in all entities. Set for subprograms and generic subprograms
3782 -- to which a valid aspect or pragma No_Return applies.
3784 -- No_Strict_Aliasing [base type only]
3785 -- Defined in access types. Set to direct the backend to avoid any
3786 -- optimizations based on an assumption about the aliasing status of
3787 -- objects designated by the access type. For the case of the gcc
3788 -- backend, the effect is as though all references to objects of
3789 -- the type were compiled with -fno-strict-aliasing. This flag is
3790 -- set if an unchecked conversion with the access type as a target
3791 -- type occurs in the same source unit as the declaration of the
3792 -- access type, or if an explicit pragma No_Strict_Aliasing applies.
3794 -- No_Tagged_Streams_Pragma
3795 -- Present in all subtype and type entities. Set for tagged types and
3796 -- subtypes (i.e. entities with Is_Tagged_Type set True) if a valid
3797 -- pragma/aspect applies to the type.
3799 -- Non_Binary_Modulus [base type only]
3800 -- Defined in all subtype and type entities. Set for modular integer
3801 -- types if the modulus value is other than a power of 2.
3803 -- Non_Limited_View
3804 -- Defined in abstract states and incomplete types that act as shadow
3805 -- entities created when analysing a limited with clause (Ada 2005:
3806 -- AI-50217). Points to the defining entity of the original declaration.
3808 -- Nonzero_Is_True [base type only]
3809 -- Defined in enumeration types. Set if any non-zero value is to be
3810 -- interpreted as true. Currently this is set for derived Boolean
3811 -- types which have a convention of C, C++ or Fortran.
3813 -- Normalized_First_Bit
3814 -- Defined in components and discriminants. Indicates the normalized
3815 -- value of First_Bit for the component, i.e. the offset within the
3816 -- lowest addressed storage unit containing part or all of the field.
3817 -- Set to No_Uint if no first bit position is assigned yet.
3819 -- Normalized_Position
3820 -- Defined in components and discriminants. Indicates the normalized
3821 -- value of Position for the component, i.e. the offset in storage
3822 -- units from the start of the record to the lowest addressed storage
3823 -- unit containing part or all of the field.
3825 -- Number_Dimensions (synthesized)
3826 -- Applies to array types and subtypes. Returns the number of dimensions
3827 -- of the array type or subtype as a value of type Pos.
3829 -- Number_Entries (synthesized)
3830 -- Applies to concurrent types. Returns the number of entries that are
3831 -- declared within the task or protected definition for the type.
3833 -- Number_Formals (synthesized)
3834 -- Applies to subprograms and subprogram types. Yields the number of
3835 -- formals as a value of type Nat.
3837 -- Object_Size_Clause (synthesized)
3838 -- Applies to entities for types and subtypes. If an object size clause
3839 -- is present in the rep item chain for an entity then the attribute
3840 -- definition clause node is returned. Otherwise Object_Size_Clause
3841 -- returns Empty if no item is present. Usually this is only meaningful
3842 -- if the flag Has_Object_Size_Clause is set. This is because when the
3843 -- representation item chain is copied for a derived type, it can inherit
3844 -- an object size clause that is not applicable to the entity.
3846 -- OK_To_Rename
3847 -- Defined only in entities for variables. If this flag is set, it
3848 -- means that if the entity is used as the initial value of an object
3849 -- declaration, the object declaration can be safely converted into a
3850 -- renaming to avoid an extra copy. This is set for variables which are
3851 -- generated by the expander to hold the result of evaluating some
3852 -- expression. Most notably, the local variables used to store the result
3853 -- of concatenations are so marked (see Exp_Ch4.Expand_Concatenate). It
3854 -- is only worth setting this flag for composites, since for primitive
3855 -- types, it is cheaper to do the copy.
3857 -- Optimize_Alignment_Space
3858 -- Defined in type, subtype, variable, and constant entities. This
3859 -- flag records that the type or object is to be laid out in a manner
3860 -- consistent with Optimize_Alignment (Space) mode. The compiler and
3861 -- binder ensure a consistent view of any given type or object. If pragma
3862 -- Optimize_Alignment (Off) mode applies to the type/object, then neither
3863 -- of the flags Optimize_Alignment_Space/Optimize_Alignment_Time is set.
3865 -- Optimize_Alignment_Time
3866 -- Defined in type, subtype, variable, and constant entities. This
3867 -- flag records that the type or object is to be laid out in a manner
3868 -- consistent with Optimize_Alignment (Time) mode. The compiler and
3869 -- binder ensure a consistent view of any given type or object. If pragma
3870 -- Optimize_Alignment (Off) mode applies to the type/object, then neither
3871 -- of the flags Optimize_Alignment_Space/Optimize_Alignment_Time is set.
3873 -- Original_Access_Type
3874 -- Defined in E_Access_Subprogram_Type entities. Set only if the access
3875 -- type was generated by the expander as part of processing an access-
3876 -- to-protected-subprogram type. Points to the access-to-protected-
3877 -- subprogram type.
3879 -- Original_Array_Type
3880 -- Defined in modular types and array types and subtypes. Set only if
3881 -- the Is_Packed_Array_Impl_Type flag is set, indicating that the type
3882 -- is the implementation type for a packed array, and in this case it
3883 -- points to the original array type for which this is the packed
3884 -- array implementation type.
3886 -- Original_Protected_Subprogram
3887 -- Defined in functions and procedures. Set only on internally built
3888 -- dispatching subprograms of protected types to reference their original
3889 -- non-dispatching protected subprogram since their names differ.
3891 -- Original_Record_Component
3892 -- Defined in components, including discriminants. The usage depends
3893 -- on whether the record is a base type and whether it is tagged.
3895 -- In base tagged types:
3896 -- When the component is inherited in a record extension, it points
3897 -- to the original component (the entity of the ancestor component
3898 -- which is not itself inherited) otherwise it points to itself. The
3899 -- backend uses this attribute to implement the automatic dereference
3900 -- in the extension and to apply the transformation:
3902 -- Rec_Ext.Comp -> Rec_Ext.Parent. ... .Parent.Comp
3904 -- In base untagged types:
3905 -- Always points to itself except for non-stored discriminants, where
3906 -- it points to the stored discriminant it renames.
3908 -- In subtypes (tagged and untagged):
3909 -- Points to the component in the base type.
3911 -- Overlays_Constant
3912 -- Defined in all entities. Set only for E_Constant or E_Variable for
3913 -- which there is an address clause that causes the entity to overlay
3914 -- a constant object.
3916 -- Overridden_Operation
3917 -- Defined in subprograms. For overriding operations, points to the
3918 -- user-defined parent subprogram that is being overridden. Note: this
3919 -- attribute uses the same field as Static_Initialization. The latter
3920 -- is only defined for internal initialization procedures, for which
3921 -- Overridden_Operation is irrelevant. Thus this attribute must not be
3922 -- set for init_procs.
3924 -- Package_Instantiation
3925 -- Defined in packages and generic packages. When defined, this field
3926 -- references an N_Generic_Instantiation node associated with an
3927 -- instantiated package. In the case where the referenced node has
3928 -- been rewritten to an N_Package_Specification, the instantiation
3929 -- node is available from the Original_Node field of the package spec
3930 -- node. This is currently not guaranteed to be set in all cases, but
3931 -- when set, the field is used in Get_Unit_Instantiation_Node as
3932 -- one of the means of obtaining the instantiation node. Eventually
3933 -- it should be set in all cases, including package entities associated
3934 -- with formal packages. ???
3936 -- Packed_Array_Impl_Type
3937 -- Defined in array types and subtypes, except for the string literal
3938 -- subtype case, if the corresponding type is packed and implemented
3939 -- specially (either bit-packed or packed to eliminate holes in the
3940 -- non-contiguous enumeration index types). References the type used to
3941 -- represent the packed array, which is either a modular type for short
3942 -- static arrays or an array of System.Unsigned in the bit-packed case,
3943 -- or a regular array in the non-standard enumeration index case. Note
3944 -- that in some situations (internal types and references to fields of
3945 -- variant records), it is not always possible to construct this type in
3946 -- advance of its use. If this field is empty, then the necessary type
3947 -- is declared on the fly for each reference to the array.
3949 -- Parameter_Mode (synthesized)
3950 -- Applies to formal parameter entities. This is a synonym for Ekind,
3951 -- used when obtaining the formal kind of a formal parameter (the result
3952 -- is one of E_[In/Out/In_Out]_Parameter).
3954 -- Parent_Subtype [base type only]
3955 -- Defined in E_Record_Type. Set only for derived tagged types, in which
3956 -- case it points to the subtype of the parent type. This is the type
3957 -- that is used as the Etype of the _parent field.
3959 -- Part_Of_Constituents
3960 -- Present in abstract state and variable entities. Contains all
3961 -- constituents that are subject to indicator Part_Of (both aspect and
3962 -- option variants).
3964 -- Part_Of_References
3965 -- Present in variable entities. Contains all references to the variable
3966 -- when it is subject to pragma Part_Of. If the variable is a constituent
3967 -- of a single protected/task type, the references are examined as they
3968 -- must appear only within the type definition and the corresponding
3969 -- body.
3971 -- Partial_DIC_Procedure (synthesized)
3972 -- Defined in type entities. Set for a private type and its full view
3973 -- when the type is subject to pragma Default_Initial_Condition (DIC), or
3974 -- when the type inherits a DIC pragma from a parent type. Points to the
3975 -- entity of a procedure that takes a single argument of the given type
3976 -- and verifies the assertion expression of the DIC pragma at run time.
3977 -- When present, the Partial_DIC_Procedure of a type only checks DICs
3978 -- associated with the partial (private) view of the type, and is invoked
3979 -- by the full DIC_Procedure (which may check additional DICs associated
3980 -- with the full view).
3982 -- Note: the reason this is marked as a synthesized attribute is that the
3983 -- way this is stored is as an element of the Subprograms_For_Type field.
3985 -- Partial_Invariant_Procedure (synthesized)
3986 -- Defined in types and subtypes. Set for private types when one or more
3987 -- [class-wide] type invariants apply to them. Points to the entity for a
3988 -- procedure which checks the invariant. This invariant procedure takes a
3989 -- single argument of the given type, and returns if the invariant holds,
3990 -- or raises exception Assertion_Error with an appropriate message if it
3991 -- does not hold. This attribute is defined but always Empty for private
3992 -- subtypes. This attribute is also set for the corresponding full type.
3994 -- Note: the reason this is marked as a synthesized attribute is that the
3995 -- way this is stored is as an element of the Subprograms_For_Type field.
3997 -- Partial_Refinement_Constituents (synthesized)
3998 -- Defined in abstract state entities. Returns the constituents that
3999 -- refine the state in the current scope, which are allowed in a global
4000 -- refinement in this scope. These consist of those constituents that are
4001 -- abstract states with no or only partial refinement visible, and those
4002 -- that are not themselves abstract states.
4004 -- Partial_View_Has_Unknown_Discr
4005 -- Present in all types. Set to Indicate that the partial view of a type
4006 -- has unknown discriminants. A default initialization of an object of
4007 -- the type does not require an invariant check (AI12-0133).
4009 -- Pending_Access_Types
4010 -- Defined in all types. Set for incomplete, private, Taft-amendment
4011 -- types, and their corresponding full views. This list contains all
4012 -- access types, both named and anonymous, declared between the partial
4013 -- and the full view. The list is used by the finalization machinery to
4014 -- ensure that the finalization masters of all pending access types are
4015 -- fully initialized when the full view is frozen.
4017 -- Postconditions_Proc
4018 -- Obsolete field which can be removed once CodePeer is fixed ???
4020 -- Predicate_Function (synthesized)
4021 -- Defined in all types. Set for types for which (Has_Predicates is True)
4022 -- and for which a predicate procedure has been built that tests that the
4023 -- specified predicates are True. Contains the entity for the function
4024 -- which takes a single argument of the given type (and sometimes an
4025 -- additional Boolean parameter), and returns True if the predicate
4026 -- holds and False if it does not.
4028 -- Note: flag Has_Predicate does not imply that Predicate_Function is set
4029 -- to a non-empty entity; this happens, for example, for itypes created
4030 -- when instantiating generic units with private types with predicates.
4031 -- However, if an explicit pragma Predicate or Predicate aspect is given
4032 -- either for private or full type declaration then both Has_Predicates
4033 -- and a non-empty Predicate_Function will be set on both the partial and
4034 -- full views of the type.
4036 -- Note: the reason this is marked as a synthesized attribute is that the
4037 -- way this is stored is as an element of the Subprograms_For_Type field.
4039 -- Predicate_Expression
4040 -- Defined on functions. For the defining identifier of the subprogram
4041 -- declaration (not of the subprogram body) of a predicate function,
4042 -- yields the expression for the noninherited portion of the given
4043 -- predicate (except in the case where the inherited portion is
4044 -- non-empty and the non-inherited portion is empty, in which case the
4045 -- expression for the inherited portion is returned). Otherwise yields
4046 -- empty.
4048 -- Predicated_Parent
4049 -- Defined on itypes created by subtype indications, when the parent
4050 -- subtype has predicates. The itype shares the Predicate_Function
4051 -- of the predicated parent, but this function may not have been built
4052 -- at the point the Itype is constructed, so this attribute allows its
4053 -- retrieval at the point a predicate check needs to be generated.
4054 -- The utility Predicate_Function takes this link into account.
4056 -- Predicates_Ignored
4057 -- Defined on all types. Indicates whether the subtype declaration is in
4058 -- a context where Assertion_Policy is Ignore, in which case no checks
4059 -- (static or dynamic) must be generated for objects of the type.
4061 -- Prev_Entity
4062 -- Defined in all entities. The entities of a scope are chained, and this
4063 -- field is used as a backward pointer for this entity list - effectively
4064 -- making the entity chain doubly-linked.
4066 -- Primitive_Operations (synthesized)
4067 -- Defined in concurrent types, tagged record types and subtypes, tagged
4068 -- private types and tagged incomplete types. For concurrent types whose
4069 -- Corresponding_Record_Type (CRT) is available, returns the list of
4070 -- Direct_Primitive_Operations of its CRT; otherwise returns No_Elist.
4071 -- For all the other types returns the Direct_Primitive_Operations.
4073 -- Prival
4074 -- Defined in private components of protected types. Refers to the entity
4075 -- of the component renaming declaration generated inside protected
4076 -- subprograms, entries or barrier functions.
4078 -- Prival_Link
4079 -- Defined in constants and variables which rename private components of
4080 -- protected types. Set to the original private component.
4082 -- Private_Dependents
4083 -- Defined in private (sub)types. Records the subtypes of the private
4084 -- type, derivations from it, and records and arrays with components
4085 -- dependent on the type.
4087 -- The subtypes are traversed when installing and deinstalling (the full
4088 -- view of) a private type in order to ensure correct view of the
4089 -- subtypes.
4091 -- Used in similar fashion for incomplete types: holds list of subtypes
4092 -- of these incomplete types that have discriminant constraints. The
4093 -- full views of these subtypes are constructed when the full view of
4094 -- the incomplete type is processed.
4096 -- In addition, if the incomplete type is the designated type in an
4097 -- access definition for an access parameter, the operation may be
4098 -- a dispatching primitive operation, which is only known when the full
4099 -- declaration of the type is seen. Subprograms that have such an
4100 -- access parameter are also placed in the list of private_dependents.
4102 -- Protected_Body_Subprogram
4103 -- Defined in protected operations. References the entity for the
4104 -- subprogram which implements the body of the operation.
4106 -- Protected_Formal
4107 -- Defined in formal parameters (in, in out and out parameters). Used
4108 -- only for formals of protected operations. References corresponding
4109 -- formal parameter in the unprotected version of the operation that
4110 -- is created during expansion.
4112 -- Protected_Subprogram
4113 -- Defined in functions and procedures. Set for the pair of subprograms
4114 -- which emulate the runtime semantics of a protected subprogram. Denotes
4115 -- the entity of the original protected subprogram.
4117 -- Protection_Object
4118 -- Applies to protected entries, entry families and subprograms. Denotes
4119 -- the entity which is used to rename the _object component of protected
4120 -- types.
4122 -- Reachable
4123 -- Defined in labels. The flag is set over the range of statements in
4124 -- which a goto to that label is legal.
4126 -- Receiving_Entry
4127 -- Defined in procedures. Set for an internally generated procedure which
4128 -- wraps the original statements of an accept alternative. Designates the
4129 -- entity of the task entry being accepted.
4131 -- Referenced
4132 -- Defined in all entities. Set if the entity is referenced, except for
4133 -- the case of an appearance of a simple variable that is not a renaming
4134 -- as the left side of an assignment in which case Referenced_As_LHS is
4135 -- set instead, or a similar appearance as an out parameter actual, in
4136 -- which case Referenced_As_Out_Parameter is set.
4138 -- Referenced_As_LHS
4139 -- Defined in all entities. This flag is set instead of Referenced if a
4140 -- simple variable that is not a renaming appears as the left side of an
4141 -- assignment. The reason we distinguish this kind of reference is that
4142 -- we have a separate warning for variables that are only assigned and
4143 -- never read.
4145 -- Referenced_As_Out_Parameter
4146 -- Defined in all entities. This flag is set instead of Referenced if a
4147 -- simple variable that is not a renaming appears as an actual for an out
4148 -- formal. The reason we distinguish this kind of reference is that
4149 -- we have a separate warning for variables that are only assigned and
4150 -- never read, and out parameters are a special case.
4152 -- Refinement_Constituents
4153 -- Present in abstract state entities. Contains all the constituents that
4154 -- refine the state, in other words, all the hidden states that appear in
4155 -- the constituent_list of aspect/pragma Refined_State.
4157 -- Register_Exception_Call
4158 -- Defined in exception entities. When an exception is declared,
4159 -- a call is expanded to Register_Exception. This field points to
4160 -- the expanded N_Procedure_Call_Statement node for this call. It
4161 -- is used for Import/Export_Exception processing to modify the
4162 -- register call to make appropriate entries in the special tables
4163 -- used for handling these pragmas at run time.
4165 -- Related_Array_Object
4166 -- Defined in array types and subtypes. Used only for the base type
4167 -- and subtype created for an anonymous array object. Set to point
4168 -- to the entity of the corresponding array object. Currently used
4169 -- only for type-related error messages.
4171 -- Related_Expression
4172 -- Defined in variables, types and functions. When Set for internally
4173 -- generated entities, it may be used to denote the source expression
4174 -- whose elaboration created the variable declaration. If set, it is used
4175 -- for generating clearer messages from CodePeer. It is used on source
4176 -- entities that are variables in iterator specifications, to provide
4177 -- a link to the container that is the domain of iteration. This allows
4178 -- for better cross-reference information when the loop modifies elements
4179 -- of the container, and suppresses spurious warnings.
4180 -- Finally this node is used on functions specified via the Real_Literal
4181 -- aspect, to denote the 2-parameter overloading, if found.
4183 -- Shouldn't it also be used for the same purpose in errout? It seems
4184 -- odd to have two mechanisms here???
4186 -- Related_Instance
4187 -- Defined in the wrapper packages created for subprogram instances.
4188 -- The internal subprogram that implements the instance is inside the
4189 -- wrapper package, but for debugging purposes its external symbol
4190 -- must correspond to the name and scope of the related instance.
4192 -- Related_Type
4193 -- Defined in components, constants and variables. Set when there is an
4194 -- associated dispatch table to point to entities containing primary or
4195 -- secondary tags. Not set in the _tag component of record types.
4197 -- Relative_Deadline_Variable [implementation base type only]
4198 -- Defined in task type entities. This flag is set if a valid and
4199 -- effective pragma Relative_Deadline applies to the base type. Points
4200 -- to the entity for a variable that is created to hold the value given
4201 -- in a Relative_Deadline pragma for a task type.
4203 -- Renamed_Entity
4204 -- Defined in exception, generic unit, package, and subprogram entities.
4205 -- Set when the entity is defined by a renaming declaration. Denotes the
4206 -- renamed entity, or transitively the ultimate renamed entity if there
4207 -- is a chain of renaming declarations. Empty if no renaming.
4209 -- Renamed_In_Spec
4210 -- Defined in package entities. If a package renaming occurs within
4211 -- a package spec, then this flag is set on the renamed package. The
4212 -- purpose is to prevent a warning about unused entities in the renamed
4213 -- package. Such a warning would be inappropriate since clients of the
4214 -- package can see the entities in the package via the renaming.
4216 -- Renamed_Object
4217 -- Defined in components, constants, discriminants, formal parameters,
4218 -- generic formals, loop parameters, and variables. Set to non-Empty if
4219 -- the object was declared by a renaming declaration. For constants and
4220 -- variables, the attribute references the tree node for the name of the
4221 -- renamed object. For formal parameters, the field is used in inlining
4222 -- and maps the entities of all formal parameters of a subprogram to the
4223 -- entities of the corresponding actuals. For formals of a task entry,
4224 -- the attribute denotes the local renaming that replaces the actual
4225 -- within an accept statement. For all remaining cases (discriminants,
4226 -- loop parameters) the field is Empty.
4228 -- Requires_Overriding
4229 -- Defined in all subprograms and entries. Set for subprograms that
4230 -- require overriding as defined by RM-2005-3.9.3(6/2). Note that this
4231 -- is True only for implicitly declared subprograms; it is not set on the
4232 -- parent type's subprogram. See also Is_Abstract_Subprogram.
4234 -- Return_Applies_To
4235 -- Defined in E_Return_Statement. Points to the entity representing
4236 -- the construct to which the return statement applies, as defined in
4237 -- RM-6.5(4/2). Note that a (simple) return statement within an
4238 -- extended_return_statement applies to the extended_return_statement,
4239 -- even though it causes the whole function to return.
4240 -- Also defined in special E_Block entities built as E_Return_Statement
4241 -- for extended return statements and attached to the block statement
4242 -- by Expand_N_Extended_Return_Statement before being turned into an
4243 -- E_Block by semantic analysis.
4245 -- Return_Present
4246 -- Defined in function and generic function entities. Set if the
4247 -- function contains a return statement (used for error checking).
4248 -- This flag can also be set in procedure and generic procedure
4249 -- entities (for convenience in setting it), but is only tested
4250 -- for the function case.
4252 -- Return_Statement
4253 -- Defined in E_Variable. Set when Is_Return_Object is set, in which
4254 -- case it points to the N_Simple_Return_Statement made from the
4255 -- extended return statement.
4257 -- Returns_By_Ref
4258 -- Defined in subprogram type entities and functions. Set if a function
4259 -- (or an access-to-function type) returns a result by reference, either
4260 -- because the result is built in place, or its type is by-reference.
4262 -- Reverse_Bit_Order [base type only]
4263 -- Defined in all record type entities. Set if entity has a Bit_Order
4264 -- aspect (set by an aspect clause or attribute definition clause) that
4265 -- has reversed the order of bits from the default value. When this flag
4266 -- is set, a component clause must specify a set of bits entirely within
4267 -- a single storage unit (Ada 95) or within a single machine scalar (see
4268 -- Ada 2005 AI-133), or must occupy an integral number of storage units.
4270 -- Reverse_Storage_Order [base type only]
4271 -- Defined in all record and array type entities. Set if entity has a
4272 -- Scalar_Storage_Order aspect (set by an aspect clause or attribute
4273 -- definition clause) that has reversed the order of storage elements
4274 -- from the default value. When this flag is set for a record type,
4275 -- the Bit_Order aspect must be set to the same value (either explicitly
4276 -- or as the target default value).
4278 -- Rewritten_For_C
4279 -- Defined on functions that return a constrained array type, when
4280 -- Modify_Tree_For_C is set. Indicates that a procedure with an extra
4281 -- out parameter has been created for it, and calls must be rewritten as
4282 -- calls to the new procedure.
4284 -- RM_Size
4285 -- Defined in all type and subtype entities. Contains the value of
4286 -- type'Size as defined in the RM. See also the Esize field and
4287 -- and the description on "Handling of Type'Size Values". A value
4288 -- of zero in this field for a non-discrete type means that
4289 -- the front end has not yet determined the size value. For the
4290 -- case of a discrete type, this field is always set by the front
4291 -- end and zero is a legitimate value for a type with one value.
4293 -- Root_Type (synthesized)
4294 -- Applies to all type entities. For class-wide types, returns the root
4295 -- type of the class covered by the CW type, otherwise returns the
4296 -- ultimate derivation ancestor of the given type. This function
4297 -- preserves the view, i.e. the Root_Type of a partial view is the
4298 -- partial view of the ultimate ancestor, the Root_Type of a full view
4299 -- is the full view of the ultimate ancestor. Note that this function
4300 -- does not correspond exactly to the use of root type in the RM, since
4301 -- in the RM root type applies to a class of types, not to a type.
4303 -- Scalar_Range
4304 -- Defined in all scalar types (including modular types, where the
4305 -- bounds are 0 .. modulus - 1). References a node in the tree that
4306 -- contains the bounds for the range. Note that this information
4307 -- could be obtained by rummaging around the tree, but it is more
4308 -- convenient to have it immediately at hand in the entity. The
4309 -- contents of Scalar_Range can either be an N_Subtype_Indication
4310 -- node (with a constraint), a Range node, or an Integer_Type_Definition,
4311 -- but not a simple subtype reference (a subtype is converted into a
4312 -- explicit range).
4314 -- Scale_Value
4315 -- Defined in decimal fixed-point types and subtypes. This holds the
4316 -- value of the Scale attribute for the type, i.e. the scale of the type
4317 -- defined as the integer N such that the delta is equal to 10.0**(-N).
4318 -- Note that, if Scale_Value is positive, then it is equal to Aft_Value.
4320 -- Scope
4321 -- Defined in all entities. Points to the entity for the scope (block,
4322 -- loop, subprogram, package etc.) in which the entity is declared.
4323 -- Since this field is in the base part of the entity node, the access
4324 -- routines for this field are in Sinfo. Note that for a child unit,
4325 -- the Scope will be the parent package, and for a root library unit,
4326 -- the Scope will be Standard.
4328 -- Scope_Depth (synthesized)
4329 -- Applies to program units, blocks, loops, return statements,
4330 -- concurrent types, private types and entries, and also to record types,
4331 -- i.e. to any entity that can appear on the scope stack. Yields the
4332 -- scope depth value, which for those entities other than records is
4333 -- simply the Scope_Depth_Value, and for record entities, is the
4334 -- Scope_Depth of the record's scope.
4336 -- Scope_Depth_Value
4337 -- Defined in program units, blocks, loops, return statements,
4338 -- concurrent types, private types and entries.
4339 -- Indicates the number of scopes that statically enclose the declaration
4340 -- of the unit or type. Library units have a depth of one. Note that
4341 -- record types can act as scopes but do NOT have this field set (see
4342 -- Scope_Depth above). Queries should normally be via Scope_Depth,
4343 -- and not call Scope_Depth_Value directly.
4345 -- Scope_Depth_Set (synthesized)
4346 -- Applies to a special predicate function that returns a Boolean value
4347 -- indicating whether or not the Scope_Depth field has been set. It is
4348 -- needed, since returns an invalid value in this case.
4350 -- Sec_Stack_Needed_For_Return
4351 -- Defined in scope entities (blocks, entries, entry families, functions,
4352 -- and procedures). Set to True when secondary stack is used to hold the
4353 -- returned value of a function and thus should not be released on scope
4354 -- exit.
4356 -- Shared_Var_Procs_Instance
4357 -- Defined in variables. Set non-Empty only if Is_Shared_Passive is
4358 -- set, in which case this is the entity for the associated instance of
4359 -- System.Shared_Storage.Shared_Var_Procs. See Exp_Smem for full details.
4361 -- Size_Check_Code
4362 -- Defined in constants and variables. Normally Empty. Set if code is
4363 -- generated to check the size of the object. This field is used to
4364 -- suppress this code if a subsequent address clause is encountered.
4366 -- Size_Clause (synthesized)
4367 -- Applies to all entities. If a size or value size clause is present in
4368 -- the rep item chain for an entity then that attribute definition clause
4369 -- is returned. Otherwise Size_Clause returns Empty. Usually this is only
4370 -- meaningful if the flag Has_Size_Clause is set. This is because when
4371 -- the representation item chain is copied for a derived type, it can
4372 -- inherit a size clause that is not applicable to the entity.
4374 -- Size_Depends_On_Discriminant
4375 -- Defined in all entities for types and subtypes. Indicates that the
4376 -- size of the type depends on the value of one or more discriminants.
4377 -- Currently, this flag is only set for arrays which have one or more
4378 -- bounds depending on a discriminant value.
4380 -- Size_Known_At_Compile_Time
4381 -- Defined in all entities for types and subtypes. Indicates that the
4382 -- size of objects of the type is known at compile time. This flag is
4383 -- used to optimize some generated code sequences, and also to enable
4384 -- some error checks (e.g. disallowing component clauses on variable
4385 -- length objects). It is set conservatively (i.e. if it is True, the
4386 -- size is certainly known at compile time, if it is False, then the
4387 -- size may or may not be known at compile time, but the code will
4388 -- assume that it is not known). Note that the value may be known only
4389 -- to the back end, so the fact that this flag is set does not mean that
4390 -- the front end can access the value.
4392 -- Small_Value
4393 -- Defined in fixed point types. Points to the universal real for the
4394 -- Small of the type, either as given in a representation clause, or
4395 -- as computed (as a power of two) by the compiler.
4397 -- SPARK_Aux_Pragma
4398 -- Present in concurrent type, [generic] package spec and package body
4399 -- entities. For concurrent types and package specs it refers to the
4400 -- SPARK mode setting for the private part. This field points to the
4401 -- N_Pragma node that either appears in the private part or is inherited
4402 -- from the enclosing context. For package bodies, it refers to the SPARK
4403 -- mode of the elaboration sequence after the BEGIN. The fields points to
4404 -- the N_Pragma node that either appears in the statement sequence or is
4405 -- inherited from the enclosing context. In all cases, if the pragma is
4406 -- inherited, then the SPARK_Aux_Pragma_Inherited flag is set.
4408 -- SPARK_Aux_Pragma_Inherited
4409 -- Present in concurrent type, [generic] package spec and package body
4410 -- entities. Set if the SPARK_Aux_Pragma field points to a pragma that is
4411 -- inherited, rather than a local one.
4413 -- SPARK_Pragma
4414 -- Present in the following entities:
4416 -- abstract states
4417 -- constants
4418 -- entries
4419 -- operators
4420 -- [generic] packages
4421 -- package bodies
4422 -- [generic] subprograms
4423 -- subprogram bodies
4424 -- variables
4425 -- types
4427 -- Points to the N_Pragma node that applies to the initial declaration or
4428 -- body. This is either set by a local SPARK_Mode pragma or is inherited
4429 -- from the context (from an outer scope for the spec case or from the
4430 -- spec for the body case). In the case where the attribute is inherited,
4431 -- flag SPARK_Pragma_Inherited is set. Empty if no SPARK_Mode pragma is
4432 -- applicable.
4434 -- SPARK_Pragma_Inherited
4435 -- Present in the following entities:
4437 -- abstract states
4438 -- constants
4439 -- entries
4440 -- operators
4441 -- [generic] packages
4442 -- package bodies
4443 -- [generic] subprograms
4444 -- subprogram bodies
4445 -- variables
4446 -- types
4448 -- Set if the SPARK_Pragma attribute points to an inherited pragma rather
4449 -- than a local one.
4451 -- Spec_Entity
4452 -- Defined in package body entities. Points to corresponding package
4453 -- spec entity. Also defined in subprogram body parameters in the
4454 -- case where there is a separate spec, where this field references
4455 -- the corresponding parameter entities in the spec.
4457 -- SSO_Set_High_By_Default [base type only]
4458 -- Defined for record and array types. Set in the base type if a pragma
4459 -- Default_Scalar_Storage_Order (High_Order_First) was active at the time
4460 -- the record or array was declared and therefore applies to it.
4462 -- SSO_Set_Low_By_Default [base type only]
4463 -- Defined for record and array types. Set in the base type if a pragma
4464 -- Default_Scalar_Storage_Order (High_Order_First) was active at the time
4465 -- the record or array was declared and therefore applies to it.
4467 -- Static_Call_Helper
4468 -- Defined on subprogram entities. Set if the subprogram has class-wide
4469 -- preconditions. Denotes the helper that evaluates at runtime the
4470 -- class-wide preconditions performing static calls.
4472 -- Static_Discrete_Predicate
4473 -- Defined in discrete types/subtypes with static predicates (with the
4474 -- two flags Has_Predicates and Has_Static_Predicate set). Set if the
4475 -- type/subtype has a static predicate. Points to a list of expression
4476 -- and N_Range nodes that represent the predicate in canonical form. The
4477 -- canonical form has entries sorted in ascending order, with duplicates
4478 -- eliminated, and adjacent ranges coalesced, so that there is always a
4479 -- gap in the values between successive entries. The entries in this list
4480 -- are fully analyzed and typed with the base type of the subtype. Note
4481 -- that all entries are static and have values within the subtype range.
4483 -- Static_Elaboration_Desired
4484 -- Defined in library-level packages. Set by the pragma of the same
4485 -- name, to indicate that static initialization must be attempted for
4486 -- all types declared in the package, and that a warning must be emitted
4487 -- for those types to which static initialization is not available.
4489 -- Static_Initialization
4490 -- Defined in initialization procedures for types whose objects can be
4491 -- initialized statically. The value of this attribute is a positional
4492 -- aggregate whose components are compile-time static values. Used
4493 -- when available in object declarations to eliminate the call to the
4494 -- initialization procedure, and to minimize elaboration code. Note:
4495 -- This attribute uses the same field as Overridden_Operation, which is
4496 -- irrelevant in init_procs.
4498 -- Static_Real_Or_String_Predicate
4499 -- Defined in real types/subtypes with static predicates (with the two
4500 -- flags Has_Predicates and Has_Static_Predicate set). Set if the type
4501 -- or subtype has a static predicate. Points to the return expression
4502 -- of the predicate function. This is the original expression given as
4503 -- the predicate except that occurrences of the type are replaced by
4504 -- occurrences of the formal parameter of the predicate function (note
4505 -- that the spec of this function including this formal parameter name
4506 -- is available from the Subprograms_For_Type field; it can be accessed
4507 -- as Predicate_Function (typ)). Also, in the case where a predicate is
4508 -- inherited, the expression is of the form:
4510 -- xxxPredicate (typ2 (ent)) AND THEN expression
4512 -- where typ2 is the type from which the predicate is inherited, ent is
4513 -- the entity for the current predicate function, and xxxPredicate is the
4514 -- inherited predicate (from typ2). Finally for a predicate that inherits
4515 -- from another predicate but does not add a predicate of its own, the
4516 -- expression may consist of the above xxxPredicate call on its own.
4518 -- Status_Flag_Or_Transient_Decl
4519 -- Defined in constant, loop, and variable entities. Applies to objects
4520 -- that require special treatment by the finalization machinery, such as
4521 -- extended return results, IF and CASE expression results, and objects
4522 -- inside N_Expression_With_Actions nodes. The attribute contains the
4523 -- entity of a flag which specifies particular behavior over a region of
4524 -- code or the declaration of a "hook" object.
4525 -- In which case is it a flag, or a hook object???
4527 -- Storage_Size_Variable [implementation base type only]
4528 -- Defined in access types and task type entities. This flag is set
4529 -- if a valid and effective pragma Storage_Size applies to the base
4530 -- type. Points to the entity for a variable that is created to
4531 -- hold the value given in a Storage_Size pragma for an access
4532 -- collection or a task type. Note that in the access type case,
4533 -- this field is defined only in the root type (since derived types
4534 -- share the same storage pool).
4536 -- Stored_Constraint
4537 -- Defined in type entities. Points to an element list containing the
4538 -- expressions for each of the stored discriminants, if any, for the
4539 -- (sub)type.
4541 -- Stores_Attribute_Old_Prefix
4542 -- Defined in constants, variables, and types which are created during
4543 -- expansion in order to save the value of attribute 'Old's prefix.
4545 -- Strict_Alignment [implementation base type only]
4546 -- Defined in all type entities. Indicates that the type is by-reference
4547 -- or contains an aliased part. This forbids packing a component of this
4548 -- type tighter than the alignment and size of the type, as specified by
4549 -- RM 13.2(7) modified by AI12-001 as a Binding Interpretation.
4551 -- String_Literal_Length
4552 -- Defined in string literal subtypes (which are created to correspond
4553 -- to string literals in the program). Contains the length of the string
4554 -- literal.
4556 -- String_Literal_Low_Bound
4557 -- Defined in string literal subtypes (which are created to correspond
4558 -- to string literals in the program). Contains an expression whose
4559 -- value represents the low bound of the literal. This is a copy of
4560 -- the low bound of the applicable index constraint if there is one,
4561 -- or a copy of the low bound of the index base type if not.
4563 -- Subprograms_For_Type
4564 -- Defined in all types. The list may contain the entities of the default
4565 -- initial condition procedure, invariant procedure, and the two versions
4566 -- of the predicate function.
4568 -- Historical note: This attribute used to be a direct linked list of
4569 -- entities rather than an Elist. The Elist allows greater flexibility
4570 -- in inheritance of subprograms between views of the same type.
4572 -- Subps_Index
4573 -- Present in subprogram entities. Set if the subprogram contains nested
4574 -- subprograms, or is a subprogram nested within such a subprogram. Holds
4575 -- the index in the Exp_Unst.Subps table for the subprogram. Note that
4576 -- for the outer level subprogram, this is the starting index in the Subp
4577 -- table for the entries for this subprogram.
4579 -- Suppress_Elaboration_Warnings
4580 -- NOTE: this flag is relevant only for the legacy ABE mechanism and
4581 -- should not be used outside of that context.
4583 -- Defined in all entities, can be set only for subprogram entities and
4584 -- for variables. If this flag is set then Sem_Elab will not generate
4585 -- elaboration warnings for the subprogram or variable. Suppression of
4586 -- such warnings is automatic for subprograms for which elaboration
4587 -- checks are suppressed (without the need to set this flag), but the
4588 -- flag is also set for various internal entities (such as init procs)
4589 -- which are known not to generate any possible access before elaboration
4590 -- and it is set on variables when a warning is given to avoid multiple
4591 -- elaboration warnings for the same variable.
4593 -- Suppress_Initialization
4594 -- Defined in all variable, type and subtype entities. If set for a base
4595 -- type, then the generation of initialization procedures is suppressed
4596 -- for the type. Any other implicit initialization (e.g. from the use of
4597 -- pragma Initialize_Scalars) is also suppressed if this flag is set for
4598 -- either the subtype in question, or for the base type. For variables,
4599 -- this flag suppresses all implicit initialization for the object, even
4600 -- if the type would normally require initialization. Set by use of
4601 -- pragma Suppress_Initialization and also for internal entities where
4602 -- we know that no initialization is required. For example, enumeration
4603 -- image table entities set it.
4605 -- Suppress_Style_Checks
4606 -- Defined in all entities. Suppresses any style checks specifically
4607 -- associated with the given entity if set.
4609 -- Suppress_Value_Tracking_On_Call
4610 -- Defined in all entities. Set in a scope entity if value tracking is to
4611 -- be suppressed on any call within the scope. Used when an access to a
4612 -- local subprogram is computed, to deal with the possibility that this
4613 -- value may be passed around, and if used, may clobber a local variable.
4615 -- Task_Body_Procedure
4616 -- Defined in task types and subtypes. Points to the entity for the task
4617 -- task body procedure (as further described in Exp_Ch9, task bodies are
4618 -- expanded into procedures). A convenient function to retrieve this
4619 -- field is Sem_Util.Get_Task_Body_Procedure.
4621 -- The last sentence is odd??? Why not have Task_Body_Procedure go to the
4622 -- Underlying_Type of the Root_Type???
4624 -- Thunk_Entity
4625 -- Defined in functions and procedures which have been classified as
4626 -- Is_Thunk. Set to the target entity called by the thunk.
4628 -- Treat_As_Volatile
4629 -- Defined in all type entities, and also in constants, components and
4630 -- variables. Set if this entity is to be treated as volatile for code
4631 -- generation purposes. Always set if Is_Volatile is set, but can also
4632 -- be set as a result of situations (such as address overlays) where
4633 -- the front end wishes to force volatile handling to inhibit aliasing
4634 -- optimization which might be legally ok, but is undesirable. Note
4635 -- that the backend always tests this flag rather than Is_Volatile.
4636 -- The front end tests Is_Volatile if it is concerned with legality
4637 -- checks associated with declared volatile variables, but if the test
4638 -- is for the purposes of suppressing optimizations, then the front
4639 -- end should test Treat_As_Volatile rather than Is_Volatile.
4641 -- Note: before testing Treat_As_Volatile, consider whether it would
4642 -- be more appropriate to use Exp_Util.Is_Volatile_Reference instead,
4643 -- which catches more cases of volatile references.
4645 -- Type_High_Bound (synthesized)
4646 -- Applies to scalar types. Returns the tree node (Node_Id) that contains
4647 -- the high bound of a scalar type. The returned value is literal for a
4648 -- base type, but may be an expression in the case of scalar type with
4649 -- dynamic bounds.
4651 -- Type_Low_Bound (synthesized)
4652 -- Applies to scalar types. Returns the tree node (Node_Id) that contains
4653 -- the low bound of a scalar type. The returned value is literal for a
4654 -- base type, but may be an expression in the case of scalar type with
4655 -- dynamic bounds.
4657 -- Underlying_Full_View
4658 -- Defined in private subtypes that are the completion of other private
4659 -- types, or in private types that are derived from private subtypes. If
4660 -- the full view of a private type T is derived from another private type
4661 -- with discriminants Td, the full view of T is also private, and there
4662 -- is no way to attach to it a further full view that would convey the
4663 -- structure of T to the backend. The Underlying_Full_View is an
4664 -- attribute of the full view that is a subtype of Td with the same
4665 -- constraint as the declaration for T. The declaration for this subtype
4666 -- is built at the point of the declaration of T, either as completion,
4667 -- or as a subtype declaration where the base type is private and has a
4668 -- private completion. If Td is already constrained, then its full view
4669 -- can serve directly as the full view of T.
4671 -- Underlying_Record_View
4672 -- Defined in record types. Set for record types that are extensions of
4673 -- types with unknown discriminants, and also set for internally built
4674 -- underlying record views to reference its original record type. Record
4675 -- types that are extensions of types with unknown discriminants do not
4676 -- have a completion, but they cannot be used without having some
4677 -- discriminated view at hand. This view is a record type with the same
4678 -- structure, whose parent type is the full view of the parent in the
4679 -- original type extension.
4681 -- Underlying_Type (synthesized)
4682 -- Applies to all entities. This is the identity function except in the
4683 -- case where it is applied to an incomplete or private type, in which
4684 -- case it is the underlying type of the type declared by the completion,
4685 -- or Empty if the completion has not yet been encountered and analyzed.
4687 -- Note: the reason this attribute applies to all entities, and not just
4688 -- types, is to legitimize code where Underlying_Type is applied to an
4689 -- entity which may or may not be a type, with the intent that if it is a
4690 -- type, its underlying type is taken.
4692 -- Note also that the value of this attribute is interesting only after
4693 -- the full view of the parent type has been processed. If the parent
4694 -- type is declared in an enclosing package, the attribute will be non-
4695 -- trivial only after the full view of the type has been analyzed.
4697 -- Universal_Aliasing [implementation base type only]
4698 -- Defined in all type entities. Set to direct the back-end to avoid
4699 -- any optimizations based on type-based alias analysis for this type.
4700 -- Indicates that objects of this type can alias objects of any other
4701 -- types, which guarantees that any objects can be referenced through
4702 -- access types designating this type safely, whatever the actual type
4703 -- of these objects. In other words, the effect is as though access
4704 -- types designating this type were subject to No_Strict_Aliasing.
4706 -- Unset_Reference
4707 -- Defined in variables and out parameters. This is normally Empty. It
4708 -- is set to point to an identifier that represents a reference to the
4709 -- entity before any value has been set. Only the first such reference
4710 -- is identified. This field is used to generate a warning message if
4711 -- necessary (see Sem_Warn.Check_Unset_Reference).
4713 -- Used_As_Generic_Actual
4714 -- Defined in all entities, set if the entity is used as an argument to
4715 -- a generic instantiation. Used to tune certain warning messages, and
4716 -- in checking type conformance within an instantiation that involves
4717 -- incomplete formal and actual types.
4719 -- Uses_Lock_Free
4720 -- Defined in protected type entities. Set to True when the Lock Free
4721 -- implementation is used for the protected type. This implementation is
4722 -- based on atomic transactions and doesn't require anymore the use of
4723 -- Protection object (see System.Tasking.Protected_Objects).
4725 -- Uses_Sec_Stack
4726 -- Defined in scope entities (blocks, entries, entry families, functions,
4727 -- loops, and procedures). Set to True when the secondary stack is used
4728 -- in this scope and must be released on exit unless flag
4729 -- Sec_Stack_Needed_For_Return is set.
4731 -- Validated_Object
4732 -- Defined in variables. Contains the object whose value is captured by
4733 -- the variable for validity check purposes.
4735 -- Warnings_Off
4736 -- Defined in all entities. Set if a pragma Warnings (Off, entity-name)
4737 -- is used to suppress warnings for a given entity. It is also used by
4738 -- the compiler in some situations to kill spurious warnings. Note that
4739 -- clients should generally not test this flag directly, but instead
4740 -- use function Has_Warnings_Off.
4742 -- Warnings_Off_Used
4743 -- Defined in all entities. Can only be set if Warnings_Off is set. If
4744 -- set indicates that a warning was suppressed by the Warnings_Off flag,
4745 -- and Unmodified/Unreferenced would not have suppressed the warning.
4747 -- Warnings_Off_Used_Unmodified
4748 -- Defined in all entities. Can only be set if Warnings_Off is set and
4749 -- Has_Pragma_Unmodified is not set. If set indicates that a warning was
4750 -- suppressed by the Warnings_Off status but that pragma Unmodified
4751 -- would also have suppressed the warning.
4753 -- Warnings_Off_Used_Unreferenced
4754 -- Defined in all entities. Can only be set if Warnings_Off is set and
4755 -- Has_Pragma_Unreferenced is not set. If set indicates that a warning
4756 -- was suppressed by the Warnings_Off status but that pragma Unreferenced
4757 -- would also have suppressed the warning.
4759 -- Was_Hidden
4760 -- Defined in all entities. Used to save the value of the Is_Hidden
4761 -- attribute when the limited-view is installed (Ada 2005: AI-217).
4763 -- Wrapped_Entity
4764 -- Defined in functions and procedures which have been classified as
4765 -- Is_Primitive_Wrapper. Set to the entity being wrapper.
4767 -- Wrapped_Statements
4768 -- Defined in functions, procedures, entries, and entry families. Refers
4769 -- to the entity of the _Wrapped_Statements procedure, which gets
4770 -- generated as part of the expansion of contracts and postconditions
4771 -- and contains its enclosing subprogram's original source declarations
4772 -- and statements.
4774 -- LSP_Subprogram
4775 -- Defined in subprogram entities. Set on wrappers created to handle
4776 -- inherited class-wide pre/post conditions that call overridden
4777 -- primitives. It references the parent primitive that has the
4778 -- class-wide pre/post conditions. LSP stands for Liskov Substitution
4779 -- Principle.
4781 ---------------------------
4782 -- Renaming and Aliasing --
4783 ---------------------------
4785 -- Several entity attributes relate to renaming constructs, and to the use of
4786 -- different names to refer to the same entity. The following is a summary of
4787 -- these constructs and their preferred uses.
4789 -- There are three related attributes:
4791 -- Renamed_Entity
4792 -- Renamed_Object
4793 -- Alias
4795 -- These are implemented in Einfo.Utils as renamings of the Renamed_Or_Alias
4796 -- field. They are semantically related, and have the following intended uses:
4798 -- a) Renamed_Entity applies to entities in renaming declarations that rename
4799 -- an entity, so the value of the attribute IS an entity. This applies to
4800 -- generic renamings, package renamings, exception renamings, and subprogram
4801 -- renamings that rename a subprogram (rather than an attribute, an entry, a
4802 -- protected operation, etc).
4804 -- b) Alias applies to overloadable entities, and the value is an overloadable
4805 -- entity. So this is a subset of the previous one. We use the term Alias to
4806 -- cover both renamings and inherited operations, because both cases are
4807 -- handled in the same way when expanding a call. Namely the Alias of a given
4808 -- subprogram is the subprogram that will actually be called.
4810 -- Both a) and b) are set transitively, so that in fact it is not necessary to
4811 -- traverse chains of renamings when looking for the original entity: it's
4812 -- there in one step (this is done when analyzing renaming declarations other
4813 -- than object renamings in sem_ch8).
4815 -- c) Renamed_Object applies to constants and variables. Given that the name
4816 -- in an object renaming declaration is not necessarily an entity name, the
4817 -- value of the attribute is the tree for that name, eg AR (1).Comp. The case
4818 -- when that name is in fact an entity is not handled specially. This is why
4819 -- in a few cases we need to use a loop to trace a chain of object renamings
4820 -- where all of them happen to be entities. So:
4822 -- X : Integer;
4823 -- Y : Integer renames X; -- renamed object is the identifier X
4824 -- Z : Integer renames Y; -- renamed object is the identifier Y
4826 -- The front-end does not store explicitly the fact that Z renames X.
4828 ------------------
4829 -- Access Kinds --
4830 ------------------
4832 -- The following entity kinds are introduced by the corresponding type
4833 -- definitions:
4835 -- E_Access_Type,
4836 -- E_General_Access_Type,
4837 -- E_Anonymous_Access_Type
4839 -- E_Access_Subprogram_Type,
4840 -- E_Anonymous_Access_Subprogram_Type,
4842 -- E_Access_Protected_Subprogram_Type,
4843 -- E_Anonymous_Access_Protected_Subprogram_Type
4845 -- E_Access_Subtype is for an access subtype created by a subtype declaration
4847 -- In addition, we define the kind E_Allocator_Type to label allocators.
4848 -- This is because special resolution rules apply to this construct.
4849 -- Eventually the constructs are labeled with the access type imposed by
4850 -- the context. The backend should never see types with this Ekind.
4852 -- Similarly, we define the kind E_Access_Attribute_Type as the initial
4853 -- kind associated with an access attribute whose prefix is an object.
4854 -- After resolution, a specific access type will be established instead
4855 -- as determined by the context. Note that, for the case of an access
4856 -- attribute whose prefix is a subprogram, we build a corresponding type
4857 -- with E_Access_Subprogram_Type or E_Access_Protected_Subprogram_Type kind
4858 -- but whose designated type is the subprogram itself, instead of a regular
4859 -- E_Subprogram_Type entity.
4861 --------------------------------------------------------
4862 -- Description of Defined Attributes for Entity_Kinds --
4863 --------------------------------------------------------
4865 -- For each enumeration value defined in Entity_Kind we list all the
4866 -- attributes defined in Einfo which can legally be applied to an entity
4867 -- of that kind. The implementation of the attribute functions (and for
4868 -- non-synthesized attributes, of the corresponding set procedures) are
4869 -- in the Einfo body.
4871 -- The following attributes are defined in all entities
4873 -- Ekind (Ekind)
4875 -- Chars
4876 -- Next_Entity
4877 -- Scope
4878 -- Homonym
4879 -- Etype
4880 -- First_Rep_Item
4881 -- Freeze_Node
4882 -- Prev_Entity
4883 -- Associated_Entity
4885 -- Address_Taken
4886 -- Can_Never_Be_Null
4887 -- Checks_May_Be_Suppressed
4888 -- Debug_Info_Off
4889 -- Has_Convention_Pragma
4890 -- Has_Delayed_Aspects
4891 -- Has_Delayed_Freeze
4892 -- Has_Fully_Qualified_Name
4893 -- Has_Gigi_Rep_Item
4894 -- Has_Homonym
4895 -- Has_Pragma_Elaborate_Body
4896 -- Has_Pragma_Inline
4897 -- Has_Pragma_Inline_Always
4898 -- Has_Pragma_No_Inline
4899 -- Has_Pragma_Pure
4900 -- Has_Pragma_Pure_Function
4901 -- Has_Pragma_Thread_Local_Storage
4902 -- Has_Pragma_Unmodified
4903 -- Has_Pragma_Unreferenced
4904 -- Has_Pragma_Unused
4905 -- Has_Private_Declaration
4906 -- Has_Qualified_Name
4907 -- Has_Stream_Size_Clause
4908 -- Has_Unknown_Discriminants
4909 -- Has_Xref_Entry
4910 -- In_Private_Part
4911 -- Is_Ada_2005_Only
4912 -- Is_Ada_2012_Only
4913 -- Is_Ada_2022_Only
4914 -- Is_Bit_Packed_Array (base type only)
4915 -- Is_Aliased
4916 -- Is_Character_Type
4917 -- Is_Checked_Ghost_Entity
4918 -- Is_Child_Unit
4919 -- Is_Compilation_Unit
4920 -- Is_Descendant_Of_Address
4921 -- Is_Discrim_SO_Function
4922 -- Is_Discriminant_Check_Function
4923 -- Is_Dispatch_Table_Entity
4924 -- Is_Dispatch_Table_Wrapper
4925 -- Is_Dispatching_Operation
4926 -- Is_Entry_Formal
4927 -- Is_Exported
4928 -- Is_First_Subtype
4929 -- Is_Formal_Subprogram
4930 -- Is_Generic_Instance
4931 -- Is_Generic_Type
4932 -- Is_Hidden
4933 -- Is_Hidden_Open_Scope
4934 -- Is_Ignored_Ghost_Entity
4935 -- Is_Immediately_Visible
4936 -- Is_Implementation_Defined
4937 -- Is_Imported
4938 -- Is_Inlined
4939 -- Is_Internal
4940 -- Is_Itype
4941 -- Is_Known_Non_Null
4942 -- Is_Known_Null
4943 -- Is_Known_Valid
4944 -- Is_Limited_Composite
4945 -- Is_Limited_Record
4946 -- Is_Loop_Parameter
4947 -- Is_Obsolescent
4948 -- Is_Package_Body_Entity
4949 -- Is_Packed_Array_Impl_Type
4950 -- Is_Not_Self_Hidden
4951 -- Is_Potentially_Use_Visible
4952 -- Is_Preelaborated
4953 -- Is_Primitive_Wrapper
4954 -- Is_Public
4955 -- Is_Pure
4956 -- Is_Remote_Call_Interface
4957 -- Is_Remote_Types
4958 -- Is_Renaming_Of_Object
4959 -- Is_Shared_Passive
4960 -- Is_Statically_Allocated
4961 -- Is_Static_Type
4962 -- Is_Tagged_Type
4963 -- Is_Thunk
4964 -- Is_Trivial_Subprogram
4965 -- Is_Unchecked_Union
4966 -- Is_Unimplemented
4967 -- Is_Visible_Formal
4968 -- Kill_Elaboration_Checks
4969 -- Kill_Range_Checks
4970 -- Low_Bound_Tested
4971 -- Materialize_Entity
4972 -- Needs_Debug_Info
4973 -- Never_Set_In_Source
4974 -- No_Return
4975 -- Overlays_Constant
4976 -- Referenced
4977 -- Referenced_As_LHS
4978 -- Referenced_As_Out_Parameter
4979 -- Suppress_Elaboration_Warnings
4980 -- Suppress_Style_Checks
4981 -- Suppress_Value_Tracking_On_Call
4982 -- Used_As_Generic_Actual
4983 -- Warnings_Off
4984 -- Warnings_Off_Used
4985 -- Warnings_Off_Used_Unmodified
4986 -- Warnings_Off_Used_Unreferenced
4987 -- Was_Hidden
4989 -- Declaration_Node (synth)
4990 -- Has_Foreign_Convention (synth)
4991 -- Is_Dynamic_Scope (synth)
4992 -- Is_Ghost_Entity (synth)
4993 -- Is_Standard_Character_Type (synth)
4994 -- Is_Standard_String_Type (synth)
4995 -- Underlying_Type (synth)
4996 -- all classification attributes (synth)
4998 -- The following list of access functions applies to all entities for
4999 -- types and subtypes. References to this list appear subsequently as
5000 -- "(plus type attributes)" for each appropriate Entity_Kind.
5002 -- Associated_Node_For_Itype
5003 -- Class_Wide_Type
5004 -- Full_View
5005 -- Esize
5006 -- RM_Size
5007 -- Alignment
5008 -- Pending_Access_Types
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_Subt_For_U_Nominal
5064 -- Is_Constr_Subt_For_UN_Aliased
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_Relaxed_Initialization_State (synth)
5136 -- Is_Synchronized_State (synth)
5137 -- Partial_Refinement_Constituents (synth)
5139 -- E_Access_Protected_Subprogram_Type
5140 -- Equivalent_Type
5141 -- Directly_Designated_Type
5142 -- Needs_No_Actuals
5143 -- Can_Use_Internal_Rep
5144 -- (plus type attributes)
5146 -- E_Access_Subprogram_Type
5147 -- Equivalent_Type (remote types only)
5148 -- Directly_Designated_Type
5149 -- Needs_No_Actuals
5150 -- Original_Access_Type
5151 -- Can_Use_Internal_Rep
5152 -- Needs_Activation_Record
5153 -- Associated_Storage_Pool $$$
5154 -- Interface_Name $$$
5155 -- (plus type attributes)
5157 -- E_Access_Type
5158 -- E_Access_Subtype
5159 -- Direct_Primitive_Operations $$$ type
5160 -- Master_Id
5161 -- Directly_Designated_Type
5162 -- Associated_Storage_Pool (base type only)
5163 -- Finalization_Master (base type only)
5164 -- Storage_Size_Variable (base type only)
5165 -- Has_Pragma_Controlled (base type only)
5166 -- Has_Storage_Size_Clause (base type only)
5167 -- Is_Access_Constant
5168 -- Is_Local_Anonymous_Access
5169 -- Is_Pure_Unit_Access_Type
5170 -- No_Pool_Assigned (base type only)
5171 -- No_Strict_Aliasing (base type only)
5172 -- Is_Param_Block_Component_Type (base type only)
5173 -- (plus type attributes)
5175 -- E_Access_Attribute_Type
5176 -- Renamed_Entity $$$
5177 -- Directly_Designated_Type
5178 -- (plus type attributes)
5180 -- E_Allocator_Type
5181 -- Directly_Designated_Type
5182 -- Associated_Storage_Pool $$$
5183 -- (plus type attributes)
5185 -- E_Anonymous_Access_Subprogram_Type
5186 -- E_Anonymous_Access_Protected_Subprogram_Type
5187 -- Interface_Name $$$ E_Anonymous_Access_Subprogram_Type
5188 -- Directly_Designated_Type
5189 -- Storage_Size_Variable is this needed ???
5190 -- Can_Use_Internal_Rep
5191 -- Needs_Activation_Record
5192 -- (plus type attributes)
5194 -- E_Anonymous_Access_Type
5195 -- Directly_Designated_Type
5196 -- Finalization_Master
5197 -- Storage_Size_Variable is this needed ???
5198 -- Associated_Storage_Pool $$$
5199 -- (plus type attributes)
5201 -- E_Array_Type
5202 -- E_Array_Subtype
5203 -- First_Entity $$$
5204 -- Direct_Primitive_Operations $$$ subtype
5205 -- Renamed_Object $$$ E_Array_Subtype
5206 -- First_Index
5207 -- Default_Aspect_Component_Value (base type only)
5208 -- Component_Type (base type only)
5209 -- Original_Array_Type
5210 -- Component_Size (base type only)
5211 -- Packed_Array_Impl_Type
5212 -- Related_Array_Object
5213 -- Predicated_Parent (subtype only)
5214 -- Component_Alignment (special) (base type only)
5215 -- Has_Component_Size_Clause (base type only)
5216 -- Has_Pragma_Pack (impl base type only)
5217 -- Is_Constrained
5218 -- Reverse_Storage_Order (base type only)
5219 -- SSO_Set_High_By_Default (base type only)
5220 -- SSO_Set_Low_By_Default (base type only)
5221 -- Next_Index (synth)
5222 -- Number_Dimensions (synth)
5223 -- (plus type attributes)
5225 -- E_Block
5226 -- Renamed_Entity $$$
5227 -- Renamed_Object $$$
5228 -- Return_Applies_To
5229 -- Block_Node
5230 -- First_Entity
5231 -- Last_Entity
5232 -- Scope_Depth_Value
5233 -- Entry_Cancel_Parameter
5234 -- Contains_Ignored_Ghost_Code
5235 -- Delay_Cleanups
5236 -- Discard_Names
5237 -- Has_Master_Entity
5238 -- Has_Nested_Block_With_Handler
5239 -- Is_Exception_Handler
5240 -- Sec_Stack_Needed_For_Return
5241 -- Uses_Sec_Stack
5242 -- Scope_Depth (synth)
5244 -- E_Class_Wide_Type
5245 -- E_Class_Wide_Subtype
5246 -- Direct_Primitive_Operations
5247 -- Cloned_Subtype (subtype case only)
5248 -- First_Entity
5249 -- Equivalent_Type (always Empty for type)
5250 -- Non_Limited_View
5251 -- Last_Entity
5252 -- SSO_Set_High_By_Default (base type only)
5253 -- SSO_Set_Low_By_Default (base type only)
5254 -- Corresponding_Remote_Type $$$ type
5255 -- Renamed_Entity $$$ type
5256 -- First_Component (synth)
5257 -- First_Component_Or_Discriminant (synth)
5258 -- Has_Non_Limited_View (synth)
5259 -- (plus type attributes)
5261 -- E_Component
5262 -- Linker_Section_Pragma $$$
5263 -- Normalized_First_Bit
5264 -- Current_Value (always Empty)
5265 -- Component_Bit_Offset
5266 -- Esize
5267 -- Component_Clause
5268 -- Normalized_Position
5269 -- DT_Entry_Count
5270 -- Entry_Formal
5271 -- Prival
5272 -- Renamed_Object (always Empty)
5273 -- Discriminant_Checking_Func
5274 -- Corresponding_Record_Component
5275 -- Original_Record_Component
5276 -- DT_Offset_To_Top_Func
5277 -- Related_Type
5278 -- Has_Biased_Representation
5279 -- Has_Per_Object_Constraint
5280 -- Is_Atomic
5281 -- Is_Independent
5282 -- Is_Return_Object
5283 -- Is_Tag
5284 -- Is_Volatile
5285 -- Is_Volatile_Full_Access
5286 -- Treat_As_Volatile
5287 -- Is_Full_Access (synth)
5288 -- Next_Component (synth)
5289 -- Next_Component_Or_Discriminant (synth)
5291 -- E_Constant
5292 -- E_Loop_Parameter
5293 -- Current_Value (always Empty)
5294 -- Discriminal_Link
5295 -- Full_View
5296 -- Esize
5297 -- Extra_Accessibility (constants only)
5298 -- Alignment
5299 -- Status_Flag_Or_Transient_Decl
5300 -- Actual_Subtype
5301 -- Renamed_Object
5302 -- Renamed_Entity $$$
5303 -- Size_Check_Code (constants only)
5304 -- Prival_Link (privals only)
5305 -- Interface_Name (constants only)
5306 -- Related_Type (constants only)
5307 -- Initialization_Statements
5308 -- BIP_Initialization_Call
5309 -- Last_Aggregate_Assignment
5310 -- Activation_Record_Component
5311 -- Encapsulating_State (constants only)
5312 -- Linker_Section_Pragma
5313 -- Contract (constants only)
5314 -- SPARK_Pragma (constants only)
5315 -- Has_Alignment_Clause
5316 -- Has_Atomic_Components
5317 -- Has_Biased_Representation
5318 -- Has_Completion (constants only)
5319 -- Has_Independent_Components
5320 -- Has_Size_Clause
5321 -- Has_Thunks (constants only)
5322 -- Has_Volatile_Components
5323 -- Is_Atomic
5324 -- Is_Elaboration_Checks_OK_Id (constants only)
5325 -- Is_Elaboration_Warnings_OK_Id (constants only)
5326 -- Is_Eliminated
5327 -- Is_Finalized_Transient
5328 -- Is_Ignored_Transient
5329 -- Is_Independent
5330 -- Is_Return_Object
5331 -- Is_True_Constant
5332 -- Is_Uplevel_Referenced_Entity
5333 -- Is_Volatile
5334 -- Is_Volatile_Full_Access
5335 -- Optimize_Alignment_Space (constants only)
5336 -- Optimize_Alignment_Time (constants only)
5337 -- SPARK_Pragma_Inherited (constants only)
5338 -- Stores_Attribute_Old_Prefix (constants only)
5339 -- Treat_As_Volatile
5340 -- Address_Clause (synth)
5341 -- Alignment_Clause (synth)
5342 -- Is_Elaboration_Target (synth)
5343 -- Is_Full_Access (synth)
5344 -- Size_Clause (synth)
5346 -- E_Decimal_Fixed_Point_Type
5347 -- E_Decimal_Fixed_Point_Subtype
5348 -- Scale_Value
5349 -- Digits_Value
5350 -- Scalar_Range
5351 -- Delta_Value
5352 -- Small_Value
5353 -- Static_Real_Or_String_Predicate
5354 -- Has_Machine_Radix_Clause
5355 -- Machine_Radix_10
5356 -- Aft_Value (synth)
5357 -- Type_Low_Bound (synth)
5358 -- Type_High_Bound (synth)
5359 -- (plus type attributes)
5361 -- E_Discriminant
5362 -- Normalized_First_Bit
5363 -- Current_Value (always Empty)
5364 -- Component_Bit_Offset
5365 -- Esize
5366 -- Component_Clause
5367 -- Normalized_Position
5368 -- Discriminant_Number
5369 -- Discriminal
5370 -- Renamed_Object (always Empty)
5371 -- Corresponding_Discriminant
5372 -- Discriminant_Default_Value
5373 -- Corresponding_Record_Component
5374 -- Original_Record_Component
5375 -- CR_Discriminant
5376 -- Is_Completely_Hidden
5377 -- Is_Return_Object
5378 -- Entry_Formal $$$
5379 -- Linker_Section_Pragma $$$
5380 -- Next_Component_Or_Discriminant (synth)
5381 -- Next_Discriminant (synth)
5382 -- Next_Stored_Discriminant (synth)
5384 -- E_Entry
5385 -- E_Entry_Family
5386 -- Protected_Body_Subprogram
5387 -- Barrier_Function
5388 -- Elaboration_Entity
5389 -- Entry_Parameters_Type
5390 -- First_Entity
5391 -- Alias (for entry only. Empty)
5392 -- Last_Entity
5393 -- Accept_Address
5394 -- Scope_Depth_Value
5395 -- Protection_Object (protected kind)
5396 -- Contract_Wrapper
5397 -- Extra_Formals
5398 -- Contract
5399 -- SPARK_Pragma (protected kind)
5400 -- Default_Expressions_Processed
5401 -- Entry_Accepted
5402 -- Has_Yield_Aspect
5403 -- Has_Expanded_Contract
5404 -- Ignore_SPARK_Mode_Pragmas
5405 -- Is_Elaboration_Checks_OK_Id
5406 -- Is_Elaboration_Warnings_OK_Id
5407 -- Is_Entry_Wrapper
5408 -- Needs_No_Actuals
5409 -- Sec_Stack_Needed_For_Return
5410 -- SPARK_Pragma_Inherited (protected kind)
5411 -- Uses_Sec_Stack
5412 -- Renamed_Entity $$$
5413 -- Address_Clause (synth)
5414 -- Entry_Index_Type (synth)
5415 -- First_Formal (synth)
5416 -- First_Formal_With_Extras (synth)
5417 -- Is_Elaboration_Target (synth)
5418 -- Last_Formal (synth)
5419 -- Number_Formals (synth)
5420 -- Scope_Depth (synth)
5422 -- E_Entry_Index_Parameter
5423 -- Entry_Index_Constant
5425 -- E_Enumeration_Literal
5426 -- Enumeration_Pos
5427 -- Enumeration_Rep
5428 -- Alias
5429 -- Enumeration_Rep_Expr
5430 -- Interface_Name $$$
5431 -- Renamed_Object $$$
5432 -- Esize $$$
5433 -- Renamed_Entity $$$
5434 -- Next_Literal (synth)
5436 -- E_Enumeration_Type
5437 -- E_Enumeration_Subtype
5438 -- First_Entity $$$ type
5439 -- Renamed_Object $$$
5440 -- Lit_Strings (root type only)
5441 -- First_Literal
5442 -- Lit_Indexes (root type only)
5443 -- Default_Aspect_Value (base type only)
5444 -- Scalar_Range
5445 -- Lit_Hash (root type only)
5446 -- Enum_Pos_To_Rep (type only)
5447 -- Static_Discrete_Predicate
5448 -- Has_Biased_Representation
5449 -- Has_Contiguous_Rep
5450 -- Has_Enumeration_Rep_Clause
5451 -- Has_Pragma_Ordered (base type only)
5452 -- Nonzero_Is_True (base type only)
5453 -- No_Predicate_On_Actual
5454 -- No_Dynamic_Predicate_On_Actual
5455 -- Type_Low_Bound (synth)
5456 -- Type_High_Bound (synth)
5457 -- (plus type attributes)
5459 -- E_Exception
5460 -- Esize
5461 -- Alignment
5462 -- Renamed_Entity
5463 -- Register_Exception_Call
5464 -- Interface_Name
5465 -- Activation_Record_Component
5466 -- Discard_Names
5467 -- Is_Raised
5468 -- Renamed_Object $$$
5470 -- E_Exception_Type
5471 -- Equivalent_Type
5472 -- (plus type attributes)
5474 -- E_Floating_Point_Type
5475 -- E_Floating_Point_Subtype
5476 -- Digits_Value
5477 -- Float_Rep (Float_Rep_Kind)
5478 -- Default_Aspect_Value (base type only)
5479 -- Scalar_Range
5480 -- Static_Real_Or_String_Predicate
5481 -- Machine_Emax_Value (synth)
5482 -- Machine_Emin_Value (synth)
5483 -- Machine_Mantissa_Value (synth)
5484 -- Machine_Radix_Value (synth)
5485 -- Model_Emin_Value (synth)
5486 -- Model_Epsilon_Value (synth)
5487 -- Model_Mantissa_Value (synth)
5488 -- Model_Small_Value (synth)
5489 -- Safe_Emax_Value (synth)
5490 -- Safe_First_Value (synth)
5491 -- Safe_Last_Value (synth)
5492 -- Type_Low_Bound (synth)
5493 -- Type_High_Bound (synth)
5494 -- (plus type attributes)
5496 -- E_Function
5497 -- E_Generic_Function
5498 -- Mechanism (Mechanism_Type)
5499 -- Handler_Records (non-generic case only)
5500 -- Protected_Body_Subprogram
5501 -- Next_Inlined_Subprogram
5502 -- Elaboration_Entity (not implicit /=)
5503 -- DT_Position
5504 -- DTC_Entity
5505 -- First_Entity
5506 -- Alias (non-generic case only)
5507 -- Renamed_Entity
5508 -- Renamed_Object $$$
5509 -- Extra_Accessibility_Of_Result (non-generic case only)
5510 -- Last_Entity
5511 -- Interface_Name
5512 -- Scope_Depth_Value
5513 -- Generic_Renamings (for an instance)
5514 -- Inner_Instances (generic case only)
5515 -- Inner_Instances $$$ also E_Function
5516 -- Protection_Object (for concurrent kind)
5517 -- Subps_Index (non-generic case only)
5518 -- Interface_Alias
5519 -- LSP_Subprogram (non-generic case only)
5520 -- Overridden_Operation
5521 -- Wrapped_Entity (non-generic case only)
5522 -- Extra_Formals
5523 -- Anonymous_Masters (non-generic case only)
5524 -- Corresponding_Equality (implicit /= only)
5525 -- Thunk_Entity (thunk case only)
5526 -- Corresponding_Procedure (generate C code only)
5527 -- Linker_Section_Pragma
5528 -- Contract
5529 -- Import_Pragma (non-generic case only)
5530 -- Class_Postconditions
5531 -- Class_Preconditions
5532 -- Class_Preconditions_Subprogram
5533 -- Dynamic_Call_Helper
5534 -- Ignored_Class_Preconditions
5535 -- Ignored_Class_Postconditions
5536 -- Indirect_Call_Wrapper
5537 -- Static_Call_Helper
5538 -- Protected_Subprogram (non-generic case only)
5539 -- SPARK_Pragma
5540 -- Original_Protected_Subprogram
5541 -- Body_Needed_For_SAL
5542 -- Contains_Ignored_Ghost_Code
5543 -- Default_Expressions_Processed
5544 -- Delay_Cleanups
5545 -- Discard_Names
5546 -- Elaboration_Entity_Required
5547 -- Has_Completion
5548 -- Has_Controlling_Result
5549 -- Has_Expanded_Contract (non-generic case only)
5550 -- Has_Master_Entity
5551 -- Has_Missing_Return
5552 -- Has_Nested_Block_With_Handler
5553 -- Has_Nested_Subprogram
5554 -- Has_Out_Or_In_Out_Parameter
5555 -- Has_Recursive_Call
5556 -- Has_Yield_Aspect
5557 -- Ignore_SPARK_Mode_Pragmas
5558 -- Is_Abstract_Subprogram (non-generic case only)
5559 -- Is_Called (non-generic case only)
5560 -- Is_Class_Wide_Wrapper
5561 -- Is_Constructor
5562 -- Is_CUDA_Kernel (non-generic case only)
5563 -- Is_DIC_Procedure (non-generic case only)
5564 -- Is_Discrim_SO_Function
5565 -- Is_Discriminant_Check_Function
5566 -- Is_Elaboration_Checks_OK_Id
5567 -- Is_Elaboration_Warnings_OK_Id
5568 -- Is_Eliminated
5569 -- Is_Generic_Actual_Subprogram (non-generic case only)
5570 -- Is_Hidden_Non_Overridden_Subpgm (non-generic case only)
5571 -- Is_Initial_Condition_Procedure (non-generic case only)
5572 -- Is_Inlined_Always (non-generic case only)
5573 -- Is_Instantiated (generic case only)
5574 -- Is_Intrinsic_Subprogram
5575 -- Is_Invariant_Procedure (non-generic case only)
5576 -- Is_Machine_Code_Subprogram (non-generic case only)
5577 -- Is_Partial_Invariant_Procedure (non-generic case only)
5578 -- Is_Predicate_Function (non-generic case only)
5579 -- Is_Primitive
5580 -- Is_Primitive_Wrapper (non-generic case only)
5581 -- Is_Private_Descendant
5582 -- Is_Private_Primitive (non-generic case only)
5583 -- Is_Pure
5584 -- Is_Visible_Lib_Unit
5585 -- Is_Wrapper
5586 -- Needs_No_Actuals
5587 -- Requires_Overriding (non-generic case only)
5588 -- Return_Present
5589 -- Returns_By_Ref
5590 -- Rewritten_For_C (generate C code only)
5591 -- Sec_Stack_Needed_For_Return
5592 -- SPARK_Pragma_Inherited
5593 -- Uses_Sec_Stack
5594 -- Address_Clause (synth)
5595 -- First_Formal (synth)
5596 -- First_Formal_With_Extras (synth)
5597 -- Is_Elaboration_Target (synth)
5598 -- Last_Formal (synth)
5599 -- Number_Formals (synth)
5600 -- Scope_Depth (synth)
5602 -- E_General_Access_Type
5603 -- First_Entity $$$
5604 -- Renamed_Entity $$$
5605 -- Master_Id
5606 -- Directly_Designated_Type
5607 -- Associated_Storage_Pool (root type only)
5608 -- Finalization_Master (root type only)
5609 -- Storage_Size_Variable (base type only)
5610 -- (plus type attributes)
5612 -- E_Generic_In_Parameter
5613 -- E_Generic_In_Out_Parameter
5614 -- Current_Value (always Empty)
5615 -- Entry_Component
5616 -- Actual_Subtype
5617 -- Renamed_Object (always Empty)
5618 -- Default_Value
5619 -- Protected_Formal
5620 -- Is_Controlling_Formal
5621 -- Is_Return_Object
5622 -- Parameter_Mode (synth)
5624 -- E_Incomplete_Type
5625 -- E_Incomplete_Subtype
5626 -- Direct_Primitive_Operations
5627 -- Non_Limited_View
5628 -- Private_Dependents
5629 -- Discriminant_Constraint
5630 -- Stored_Constraint
5631 -- First_Entity $$$
5632 -- Last_Entity $$$
5633 -- Has_Non_Limited_View (synth)
5634 -- (plus type attributes)
5636 -- E_In_Parameter
5637 -- E_In_Out_Parameter
5638 -- E_Out_Parameter
5639 -- Linker_Section_Pragma $$$
5640 -- Mechanism (Mechanism_Type)
5641 -- Current_Value
5642 -- Discriminal_Link (discriminals only)
5643 -- Entry_Component
5644 -- Esize
5645 -- Extra_Accessibility
5646 -- Alignment
5647 -- Extra_Formal
5648 -- Unset_Reference
5649 -- Actual_Subtype
5650 -- Renamed_Object
5651 -- Spec_Entity
5652 -- Default_Value
5653 -- Default_Expr_Function
5654 -- Protected_Formal
5655 -- Extra_Constrained
5656 -- Minimum_Accessibility
5657 -- Last_Assignment (OUT, IN-OUT only)
5658 -- Activation_Record_Component
5659 -- Has_Initial_Value
5660 -- Is_Controlling_Formal
5661 -- Is_Only_Out_Parameter
5662 -- Low_Bound_Tested
5663 -- Is_Return_Object
5664 -- Is_Activation_Record
5665 -- Parameter_Mode (synth)
5667 -- E_Label
5668 -- Renamed_Object $$$
5669 -- Renamed_Entity $$$
5670 -- Entry_Cancel_Parameter
5671 -- Enclosing_Scope
5672 -- Reachable
5674 -- E_Limited_Private_Type
5675 -- E_Limited_Private_Subtype
5676 -- Scalar_Range $$$ type
5677 -- First_Entity
5678 -- Private_Dependents
5679 -- Underlying_Full_View
5680 -- Last_Entity
5681 -- Discriminant_Constraint
5682 -- Stored_Constraint
5683 -- Has_Completion
5684 -- (plus type attributes)
5686 -- E_Loop
5687 -- First_Exit_Statement
5688 -- Has_Exit
5689 -- Has_Loop_Entry_Attributes
5690 -- Has_Master_Entity
5691 -- Has_Nested_Block_With_Handler
5692 -- Uses_Sec_Stack
5693 -- First_Entity $$$
5694 -- Last_Entity $$$
5695 -- Renamed_Object $$$
5697 -- E_Modular_Integer_Type
5698 -- E_Modular_Integer_Subtype
5699 -- Modulus (base type only)
5700 -- Default_Aspect_Value (base type only)
5701 -- Original_Array_Type
5702 -- Scalar_Range
5703 -- Static_Discrete_Predicate
5704 -- Non_Binary_Modulus (base type only)
5705 -- Has_Biased_Representation
5706 -- Has_Shift_Operator (base type only)
5707 -- No_Predicate_On_Actual
5708 -- No_Dynamic_Predicate_On_Actual
5709 -- Type_Low_Bound (synth)
5710 -- Type_High_Bound (synth)
5711 -- (plus type attributes)
5713 -- E_Named_Integer
5714 -- Renamed_Object $$$
5716 -- E_Named_Real
5718 -- E_Operator
5719 -- First_Entity
5720 -- Alias
5721 -- Extra_Accessibility_Of_Result
5722 -- Last_Entity
5723 -- Subps_Index
5724 -- Overridden_Operation
5725 -- Linker_Section_Pragma
5726 -- Contract
5727 -- Import_Pragma
5728 -- LSP_Subprogram
5729 -- SPARK_Pragma
5730 -- Default_Expressions_Processed
5731 -- Has_Nested_Subprogram
5732 -- Ignore_SPARK_Mode_Pragmas
5733 -- Is_Class_Wide_Wrapper
5734 -- Is_Elaboration_Checks_OK_Id
5735 -- Is_Elaboration_Warnings_OK_Id
5736 -- Is_Intrinsic_Subprogram
5737 -- Is_Machine_Code_Subprogram
5738 -- Is_Primitive
5739 -- Is_Pure
5740 -- Is_Wrapper
5741 -- SPARK_Pragma_Inherited
5742 -- Interface_Name $$$
5743 -- Renamed_Entity $$$
5744 -- Renamed_Object $$$
5745 -- Is_Elaboration_Target (synth)
5746 -- Aren't there more flags and fields? seems like this list should be
5747 -- more similar to the E_Function list, which is much longer ???
5749 -- E_Ordinary_Fixed_Point_Type
5750 -- E_Ordinary_Fixed_Point_Subtype
5751 -- Delta_Value
5752 -- Default_Aspect_Value (base type only)
5753 -- Scalar_Range
5754 -- Static_Real_Or_String_Predicate
5755 -- Small_Value
5756 -- Has_Small_Clause
5757 -- Aft_Value (synth)
5758 -- Type_Low_Bound (synth)
5759 -- Type_High_Bound (synth)
5760 -- (plus type attributes)
5762 -- E_Package
5763 -- E_Generic_Package
5764 -- Dependent_Instances (for an instance)
5765 -- Handler_Records (non-generic case only)
5766 -- Generic_Homonym (generic case only)
5767 -- Associated_Formal_Package
5768 -- Elaboration_Entity
5769 -- Related_Instance (non-generic case only)
5770 -- First_Private_Entity
5771 -- First_Entity
5772 -- Renamed_Entity
5773 -- Renamed_Object $$$
5774 -- Body_Entity
5775 -- Last_Entity
5776 -- Interface_Name
5777 -- Scope_Depth_Value
5778 -- Generic_Renamings (for an instance)
5779 -- Inner_Instances (generic case only)
5780 -- Inner_Instances $$$ also E_Package
5781 -- Limited_View (non-generic/instance)
5782 -- Incomplete_Actuals (for an instance)
5783 -- Abstract_States
5784 -- Package_Instantiation
5785 -- Current_Use_Clause
5786 -- Finalizer (non-generic case only)
5787 -- Anonymous_Masters (non-generic case only)
5788 -- Contract
5789 -- SPARK_Pragma
5790 -- SPARK_Aux_Pragma
5791 -- Body_Needed_For_Inlining
5792 -- Body_Needed_For_SAL
5793 -- Contains_Ignored_Ghost_Code
5794 -- Discard_Names
5795 -- Elaborate_Body_Desirable (non-generic case only)
5796 -- Elaboration_Entity_Required
5797 -- From_Limited_With
5798 -- Has_All_Calls_Remote
5799 -- Has_Completion
5800 -- Has_Forward_Instantiation
5801 -- Has_Master_Entity
5802 -- Has_RACW (non-generic case only)
5803 -- Ignore_SPARK_Mode_Pragmas
5804 -- Is_Called (non-generic case only)
5805 -- Is_Elaboration_Checks_OK_Id
5806 -- Is_Elaboration_Warnings_OK_Id
5807 -- Is_Instantiated
5808 -- In_Package_Body
5809 -- Is_Private_Descendant
5810 -- In_Use
5811 -- Is_Visible_Lib_Unit
5812 -- Renamed_In_Spec (non-generic case only)
5813 -- SPARK_Aux_Pragma_Inherited
5814 -- SPARK_Pragma_Inherited
5815 -- Static_Elaboration_Desired (non-generic case only)
5816 -- Renamed_Object $$$
5817 -- Has_Non_Null_Abstract_State (synth)
5818 -- Has_Null_Abstract_State (synth)
5819 -- Is_Elaboration_Target (synth)
5820 -- Is_Wrapper_Package (synth) (non-generic case only)
5821 -- Has_Limited_View (synth) (non-generic case only)
5822 -- Scope_Depth (synth)
5824 -- E_Package_Body
5825 -- Handler_Records (non-generic case only)
5826 -- Related_Instance (non-generic case only)
5827 -- First_Entity
5828 -- Spec_Entity
5829 -- Last_Entity
5830 -- Scope_Depth_Value
5831 -- Finalizer (non-generic case only)
5832 -- Contract
5833 -- SPARK_Pragma
5834 -- SPARK_Aux_Pragma
5835 -- Contains_Ignored_Ghost_Code
5836 -- Ignore_SPARK_Mode_Pragmas
5837 -- SPARK_Aux_Pragma_Inherited
5838 -- SPARK_Pragma_Inherited
5839 -- Renamed_Entity $$$
5840 -- Scope_Depth (synth)
5842 -- E_Private_Type
5843 -- E_Private_Subtype
5844 -- Scalar_Range $$$ type
5845 -- Direct_Primitive_Operations
5846 -- First_Entity
5847 -- Private_Dependents
5848 -- Underlying_Full_View
5849 -- Last_Entity
5850 -- Discriminant_Constraint
5851 -- Stored_Constraint
5852 -- Has_Completion
5853 -- Is_Controlled_Active (base type only)
5854 -- $$$above in (plus type attributes)
5855 -- (plus type attributes)
5857 -- E_Procedure
5858 -- E_Generic_Procedure
5859 -- Associated_Node_For_Itype $$$ E_Procedure
5860 -- Handler_Records (non-generic case only)
5861 -- Protected_Body_Subprogram
5862 -- Next_Inlined_Subprogram
5863 -- Elaboration_Entity
5864 -- DT_Position
5865 -- DTC_Entity
5866 -- First_Entity
5867 -- Alias (non-generic case only)
5868 -- Renamed_Entity
5869 -- Renamed_Object $$$
5870 -- Receiving_Entry (non-generic case only)
5871 -- Last_Entity
5872 -- Interface_Name
5873 -- Scope_Depth_Value
5874 -- Generic_Renamings (for an instance)
5875 -- Inner_Instances (generic case only)
5876 -- Inner_Instances $$$ also E_Procedure
5877 -- Protection_Object (for concurrent kind)
5878 -- Subps_Index (non-generic case only)
5879 -- Interface_Alias
5880 -- LSP_Subprogram (non-generic case only)
5881 -- Overridden_Operation (never for init proc)
5882 -- Wrapped_Entity (non-generic case only)
5883 -- Extra_Formals
5884 -- Anonymous_Masters (non-generic case only)
5885 -- Static_Initialization (init_proc only)
5886 -- Thunk_Entity (thunk case only)
5887 -- Corresponding_Function (generate C code only)
5888 -- Linker_Section_Pragma
5889 -- Contract
5890 -- Import_Pragma (non-generic case only)
5891 -- Class_Postconditions
5892 -- Class_Preconditions
5893 -- Class_Preconditions_Subprogram
5894 -- Dynamic_Call_Helper
5895 -- Ignored_Class_Preconditions
5896 -- Ignored_Class_Postconditions
5897 -- Indirect_Call_Wrapper
5898 -- Static_Call_Helper
5899 -- Protected_Subprogram (non-generic case only)
5900 -- SPARK_Pragma
5901 -- Original_Protected_Subprogram
5902 -- Body_Needed_For_SAL
5903 -- Contains_Ignored_Ghost_Code
5904 -- Delay_Cleanups $$$Dup below
5905 -- Discard_Names $$$Dup below
5906 -- Elaboration_Entity_Required
5907 -- Default_Expressions_Processed
5908 -- Delay_Cleanups
5909 -- Discard_Names
5910 -- Has_Completion
5911 -- Has_Expanded_Contract (non-generic case only)
5912 -- Has_Master_Entity
5913 -- Has_Nested_Block_With_Handler
5914 -- Has_Nested_Subprogram
5915 -- Has_Yield_Aspect
5916 -- Ignore_SPARK_Mode_Pragmas
5917 -- Is_Abstract_Subprogram (non-generic case only)
5918 -- Is_Asynchronous
5919 -- Is_Called (non-generic case only)
5920 -- Is_Class_Wide_Wrapper
5921 -- Is_Constructor
5922 -- Is_CUDA_Kernel
5923 -- Is_DIC_Procedure (non-generic case only)
5924 -- Is_Elaboration_Checks_OK_Id
5925 -- Is_Elaboration_Warnings_OK_Id
5926 -- Is_Eliminated
5927 -- Is_Generic_Actual_Subprogram (non-generic case only)
5928 -- Is_Hidden_Non_Overridden_Subpgm (non-generic case only)
5929 -- Is_Initial_Condition_Procedure (non-generic case only)
5930 -- Is_Inlined_Always (non-generic case only)
5931 -- Is_Instantiated (generic case only)
5932 -- Is_Interrupt_Handler
5933 -- Is_Intrinsic_Subprogram
5934 -- Is_Invariant_Procedure (non-generic case only)
5935 -- Is_Machine_Code_Subprogram (non-generic case only)
5936 -- Is_Null_Init_Proc
5937 -- Is_Partial_DIC_Procedure (synth) (non-generic case only)
5938 -- Is_Partial_Invariant_Procedure (non-generic case only)
5939 -- Is_Predicate_Function (non-generic case only)
5940 -- Is_Primitive
5941 -- Is_Primitive_Wrapper (non-generic case only)
5942 -- Is_Private_Descendant
5943 -- Is_Private_Primitive (non-generic case only)
5944 -- Is_Pure
5945 -- Is_Wrapper
5946 -- Is_Valued_Procedure
5947 -- Is_Visible_Lib_Unit
5948 -- Needs_No_Actuals
5949 -- No_Return
5950 -- Requires_Overriding (non-generic case only)
5951 -- Sec_Stack_Needed_For_Return
5952 -- SPARK_Pragma_Inherited
5953 -- Entry_Parameters_Type $$$
5954 -- Address_Clause (synth)
5955 -- First_Formal (synth)
5956 -- First_Formal_With_Extras (synth)
5957 -- Is_Elaboration_Target (synth)
5958 -- Is_Finalizer (synth)
5959 -- Last_Formal (synth)
5960 -- Number_Formals (synth)
5962 -- E_Protected_Body
5963 -- SPARK_Pragma
5964 -- Ignore_SPARK_Mode_Pragmas
5965 -- SPARK_Pragma_Inherited
5966 -- (any others??? First/Last Entity, Scope_Depth???)
5968 -- E_Protected_Object$$$No such thing
5970 -- E_Protected_Type
5971 -- E_Protected_Subtype
5972 -- Direct_Primitive_Operations
5973 -- First_Private_Entity
5974 -- First_Entity
5975 -- Corresponding_Record_Type
5976 -- Entry_Bodies_Array
5977 -- Last_Entity
5978 -- Discriminant_Constraint
5979 -- Scope_Depth_Value
5980 -- Stored_Constraint
5981 -- Anonymous_Object
5982 -- Contract
5983 -- Entry_Max_Queue_Lengths_Array
5984 -- SPARK_Aux_Pragma
5985 -- Ignore_SPARK_Mode_Pragmas
5986 -- SPARK_Aux_Pragma_Inherited
5987 -- Uses_Lock_Free
5988 -- First_Component (synth)
5989 -- First_Component_Or_Discriminant (synth)
5990 -- Has_Entries (synth)
5991 -- Has_Interrupt_Handler (synth)
5992 -- Number_Entries (synth)
5993 -- Scope_Depth (synth)
5994 -- (plus type attributes)
5996 -- E_Record_Type
5997 -- E_Record_Subtype
5998 -- Renamed_Entity $$$ type
5999 -- Interface_Name $$$ type
6000 -- Direct_Primitive_Operations
6001 -- Access_Disp_Table (base type only)
6002 -- Cloned_Subtype (subtype case only)
6003 -- First_Entity
6004 -- Corresponding_Concurrent_Type
6005 -- Parent_Subtype (base type only)
6006 -- Last_Entity
6007 -- Discriminant_Constraint
6008 -- Corresponding_Remote_Type
6009 -- Stored_Constraint
6010 -- Interfaces
6011 -- Dispatch_Table_Wrappers (base type only)
6012 -- Underlying_Record_View (base type only)
6013 -- Access_Disp_Table_Elab_Flag (base type only)
6014 -- Predicated_Parent (subtype only)
6015 -- Component_Alignment (special) (base type only)
6016 -- C_Pass_By_Copy (base type only)
6017 -- Has_Dispatch_Table (base tagged type only)
6018 -- Has_Pragma_Pack (impl base type only)
6019 -- Has_Private_Ancestor
6020 -- Has_Private_Extension
6021 -- Has_Record_Rep_Clause (base type only)
6022 -- Has_Static_Discriminants (subtype only)
6023 -- Is_Class_Wide_Equivalent_Type
6024 -- Is_Concurrent_Record_Type
6025 -- Is_Constrained
6026 -- Is_Controlled_Active (base type only)
6027 -- $$$above in (plus type attributes)
6028 -- Is_Interface
6029 -- Is_Limited_Interface
6030 -- No_Reordering (base type only)
6031 -- Reverse_Bit_Order (base type only)
6032 -- Reverse_Storage_Order (base type only)
6033 -- SSO_Set_High_By_Default (base type only)
6034 -- SSO_Set_Low_By_Default (base type only)
6035 -- First_Component (synth)
6036 -- First_Component_Or_Discriminant (synth)
6037 -- (plus type attributes)
6039 -- E_Record_Type_With_Private
6040 -- E_Record_Subtype_With_Private
6041 -- Corresponding_Remote_Type $$$ E_Record_Subtype_With_Private
6042 -- Direct_Primitive_Operations
6043 -- First_Entity
6044 -- Private_Dependents
6045 -- Underlying_Full_View
6046 -- Last_Entity
6047 -- Discriminant_Constraint
6048 -- Stored_Constraint
6049 -- Interfaces
6050 -- Underlying_Record_View $$$ (base type only)
6051 -- Predicated_Parent (subtype only)
6052 -- Has_Completion
6053 -- Has_Private_Ancestor
6054 -- Has_Private_Extension
6055 -- Has_Record_Rep_Clause (base type only)
6056 -- Is_Concurrent_Record_Type
6057 -- Is_Constrained
6058 -- Is_Controlled_Active (base type only)
6059 -- $$$above in (plus type attributes)
6060 -- Is_Interface
6061 -- Is_Limited_Interface
6062 -- No_Reordering (base type only)
6063 -- Reverse_Bit_Order (base type only)
6064 -- Reverse_Storage_Order (base type only)
6065 -- SSO_Set_High_By_Default (base type only)
6066 -- SSO_Set_Low_By_Default (base type only)
6067 -- Corresponding_Remote_Type $$$ type
6068 -- First_Component (synth)
6069 -- First_Component_Or_Discriminant (synth)
6070 -- (plus type attributes)
6072 -- E_Return_Statement
6073 -- Return_Applies_To
6074 -- First_Entity $$$
6075 -- Last_Entity $$$
6077 -- E_Signed_Integer_Type
6078 -- E_Signed_Integer_Subtype
6079 -- Renamed_Object $$$ subtype
6080 -- Interface_Name $$$ subtype
6081 -- Direct_Primitive_Operations $$$ type
6082 -- First_Entity $$$
6083 -- Default_Aspect_Value (base type only)
6084 -- Scalar_Range
6085 -- Static_Discrete_Predicate
6086 -- Has_Biased_Representation
6087 -- Has_Shift_Operator (base type only)
6088 -- No_Predicate_On_Actual
6089 -- No_Dynamic_Predicate_On_Actual
6090 -- Type_Low_Bound (synth)
6091 -- Type_High_Bound (synth)
6092 -- (plus type attributes)
6094 -- E_String_Literal_Subtype
6095 -- String_Literal_Length
6096 -- First_Index (always Empty)
6097 -- String_Literal_Low_Bound
6098 -- Packed_Array_Impl_Type
6099 -- (plus type attributes)
6101 -- E_Subprogram_Body
6102 -- Mechanism
6103 -- First_Entity
6104 -- Corresponding_Protected_Entry
6105 -- Last_Entity
6106 -- Scope_Depth_Value
6107 -- Extra_Formals
6108 -- Anonymous_Masters
6109 -- Contract
6110 -- SPARK_Pragma
6111 -- Contains_Ignored_Ghost_Code
6112 -- SPARK_Pragma_Inherited
6113 -- Interface_Name $$$
6114 -- Renamed_Entity $$$
6115 -- Scope_Depth (synth)
6117 -- E_Subprogram_Type
6118 -- Extra_Accessibility_Of_Result
6119 -- Directly_Designated_Type
6120 -- Extra_Formals
6121 -- Access_Subprogram_Wrapper
6122 -- First_Formal (synth)
6123 -- First_Formal_With_Extras (synth)
6124 -- Last_Formal (synth)
6125 -- Number_Formals (synth)
6126 -- Returns_By_Ref
6127 -- First_Entity $$$
6128 -- Last_Entity $$$
6129 -- Interface_Name $$$
6130 -- (plus type attributes)
6132 -- E_Task_Body
6133 -- Contract
6134 -- SPARK_Pragma
6135 -- Ignore_SPARK_Mode_Pragmas
6136 -- SPARK_Pragma_Inherited
6137 -- First_Entity $$$
6138 -- (any others??? First/Last Entity, Scope_Depth???)
6140 -- E_Task_Type
6141 -- E_Task_Subtype
6142 -- Direct_Primitive_Operations
6143 -- First_Private_Entity
6144 -- First_Entity
6145 -- Corresponding_Record_Type
6146 -- Last_Entity
6147 -- Discriminant_Constraint
6148 -- Scope_Depth_Value
6149 -- Stored_Constraint
6150 -- Task_Body_Procedure
6151 -- Storage_Size_Variable (base type only)
6152 -- Relative_Deadline_Variable (base type only)
6153 -- Anonymous_Object
6154 -- Contract
6155 -- SPARK_Aux_Pragma
6156 -- Delay_Cleanups
6157 -- Has_Master_Entity
6158 -- Has_Storage_Size_Clause (base type only)
6159 -- Ignore_SPARK_Mode_Pragmas
6160 -- Is_Elaboration_Checks_OK_Id
6161 -- Is_Elaboration_Warnings_OK_Id
6162 -- SPARK_Aux_Pragma_Inherited
6163 -- First_Component (synth)
6164 -- First_Component_Or_Discriminant (synth)
6165 -- Has_Entries (synth)
6166 -- Is_Elaboration_Target (synth)
6167 -- Number_Entries (synth)
6168 -- Scope_Depth (synth)
6169 -- (plus type attributes)
6171 -- E_Variable
6172 -- Hiding_Loop_Variable
6173 -- Current_Value
6174 -- Part_Of_Constituents
6175 -- Part_Of_References
6176 -- Esize
6177 -- Extra_Accessibility
6178 -- Alignment
6179 -- Status_Flag_Or_Transient_Decl (transient object only)
6180 -- Unset_Reference
6181 -- Actual_Subtype
6182 -- Renamed_Object
6183 -- Renamed_Entity $$$
6184 -- Discriminal_Link $$$
6185 -- Size_Check_Code
6186 -- Prival_Link
6187 -- Interface_Name
6188 -- Shared_Var_Procs_Instance
6189 -- Extra_Constrained
6190 -- Related_Expression
6191 -- Debug_Renaming_Link
6192 -- Last_Assignment
6193 -- Related_Type
6194 -- Initialization_Statements
6195 -- BIP_Initialization_Call
6196 -- Last_Aggregate_Assignment
6197 -- Activation_Record_Component
6198 -- Encapsulating_State
6199 -- Linker_Section_Pragma
6200 -- Contract
6201 -- Anonymous_Designated_Type
6202 -- Validated_Object
6203 -- SPARK_Pragma
6204 -- Has_Alignment_Clause
6205 -- Has_Atomic_Components
6206 -- Has_Biased_Representation
6207 -- Has_Independent_Components
6208 -- Has_Initial_Value
6209 -- Has_Size_Clause
6210 -- Has_Volatile_Components
6211 -- Is_Atomic
6212 -- Is_Elaboration_Checks_OK_Id
6213 -- Is_Elaboration_Warnings_OK_Id
6214 -- Is_Eliminated
6215 -- Is_Finalized_Transient
6216 -- Is_Ignored_Transient
6217 -- Is_Independent
6218 -- Is_Return_Object
6219 -- Is_Safe_To_Reevaluate
6220 -- Is_Shared_Passive
6221 -- Is_True_Constant
6222 -- Is_Uplevel_Referenced_Entity
6223 -- Is_Volatile
6224 -- Is_Volatile_Full_Access
6225 -- OK_To_Rename
6226 -- Optimize_Alignment_Space
6227 -- Optimize_Alignment_Time
6228 -- SPARK_Pragma_Inherited
6229 -- Suppress_Initialization
6230 -- Treat_As_Volatile
6231 -- Address_Clause (synth)
6232 -- Alignment_Clause (synth)
6233 -- Is_Elaboration_Target (synth)
6234 -- Is_Full_Access (synth)
6235 -- Size_Clause (synth)
6237 -- E_Void
6238 -- Since E_Void is the initial Ekind value of an entity when it is first
6239 -- created, one might expect that no attributes would be defined on such
6240 -- an entity until its Ekind field is set. However, in practice, there
6241 -- are many instances in which fields of an E_Void entity are set in the
6242 -- code prior to setting the Ekind field. This is not well documented or
6243 -- well controlled, and needs cleaning up later. Meanwhile, the access
6244 -- procedures in the body of Einfo permit many, but not all, attributes
6245 -- to be applied to an E_Void entity, precisely so that this kind of
6246 -- pre-setting of attributes works. This is really a hole in the dynamic
6247 -- type checking, since there is no assurance that the eventual Ekind
6248 -- value will be appropriate for the attributes set, and the consequence
6249 -- is that the dynamic type checking in the Einfo body is unnecessarily
6250 -- weak.
6252 -- The following are examples of getters and setters called with E_Void:
6253 -- Entry_Formal $$$
6254 -- Esize $$$
6255 -- First_Entity $$$
6256 -- Handler_Records $$$
6257 -- Interface_Name $$$
6258 -- Last_Entity $$$
6259 -- Renamed_Entity $$$
6260 -- Renamed_Object $$$
6261 -- Scalar_Range $$$
6262 -- Set_Associated_Node_For_Itype $$$
6263 -- Set_Debug_Renaming_Link $$$
6264 -- Set_Entry_Cancel_Parameter $$$
6265 -- Set_First_Entity $$$
6266 -- Set_Inner_Instances $$$
6267 -- Set_Last_Entity $$$
6268 -- Set_Scalar_Range $$$
6269 -- Set_Entry_Cancel_Parameter $$$
6271 ---------------
6272 -- Iterators --
6273 ---------------
6275 -- In addition to attributes that are stored as plain data, other
6276 -- attributes are procedural, and require some small amount of
6277 -- computation. Of course, from the point of view of a user of this
6278 -- package, the distinction is not visible (even the field information
6279 -- provided below should be disregarded, as it is subject to change
6280 -- without notice). A number of attributes appear as lists: lists of
6281 -- formals, lists of actuals, of discriminants, etc. For these, pairs
6282 -- of functions are defined, which take the form:
6284 -- function First_Thing (E : Enclosing_Construct) return Thing;
6285 -- function Next_Thing (T : Thing) return Thing;
6287 -- The end of iteration is always signaled by a value of Empty, so that
6288 -- loops over these chains invariably have the form:
6290 -- This : Thing;
6291 -- ...
6292 -- This := First_Thing (E);
6294 -- while Present (This) loop
6295 -- Do_Something_With (This);
6296 -- ...
6297 -- This := Next_Thing (This);
6298 -- end loop;
6300 -----------------------------------
6301 -- Handling of Check Suppression --
6302 -----------------------------------
6304 -- There are three ways that checks can be suppressed:
6306 -- 1. At the command line level
6307 -- 2. At the scope level.
6308 -- 3. At the entity level.
6310 -- See spec of Sem in sem.ads for details of the data structures used
6311 -- to keep track of these various methods for suppressing checks.
6313 -------------------------------
6314 -- Handling of Discriminants --
6315 -------------------------------
6317 -- During semantic processing, discriminants are separate entities which
6318 -- reflect the semantic properties and allowed usage of discriminants in
6319 -- the language.
6321 -- In the case of discriminants used as bounds, the references are handled
6322 -- directly, since special processing is needed in any case. However, there
6323 -- are two circumstances in which discriminants are referenced in a quite
6324 -- general manner, like any other variables:
6326 -- In initialization expressions for records. Note that the expressions
6327 -- used in Priority, Storage_Size, Task_Info and Relative_Deadline
6328 -- pragmas are effectively in this category, since these pragmas are
6329 -- converted to initialized record fields in the Corresponding_Record_
6330 -- Type.
6332 -- In task and protected bodies, where the discriminant values may be
6333 -- referenced freely within these bodies. Discriminants can also appear
6334 -- in bounds of entry families and in defaults of operations.
6336 -- In both these cases, the discriminants must be treated essentially as
6337 -- objects. The following approach is used to simplify and minimize the
6338 -- special processing that is required.
6340 -- When a record type with discriminants is analyzed, semantic processing
6341 -- creates the entities for the discriminants. It also creates additional
6342 -- sets of entities called discriminals, one for each of the discriminants,
6343 -- and the Discriminal field of the discriminant entity points to this
6344 -- additional entity, which is initially created as an uninitialized
6345 -- (E_Void) entity.
6347 -- During expansion of expressions, any discriminant reference is replaced
6348 -- by a reference to the corresponding discriminal. When the initialization
6349 -- procedure for the record is created (there will always be one, since
6350 -- discriminants are present, see Exp_Ch3 for further details), the
6351 -- discriminals are used as the entities for the formal parameters of
6352 -- this initialization procedure. The references to these discriminants
6353 -- have already been replaced by references to these discriminals, which
6354 -- are now the formal parameters corresponding to the required objects.
6356 -- In the case of a task or protected body, the semantics similarly creates
6357 -- a set of discriminals for the discriminants of the task or protected
6358 -- type. When the procedure is created for the task body, the parameter
6359 -- passed in is a reference to the task value type, which contains the
6360 -- required discriminant values. The expander creates a set of declarations
6361 -- of the form:
6363 -- discr_nameD : constant discr_type renames _task.discr_name;
6365 -- where discr_nameD is the discriminal entity referenced by the task
6366 -- discriminant, and _task is the task value passed in as the parameter.
6367 -- Again, any references to discriminants in the task body have been
6368 -- replaced by the discriminal reference, which is now an object that
6369 -- contains the required value.
6371 -- This approach for tasks means that two sets of discriminals are needed
6372 -- for a task type, one for the initialization procedure, and one for the
6373 -- task body. This works out nicely, since the semantics allocates one set
6374 -- for the task itself, and one set for the corresponding record.
6376 -- The one bit of trickiness arises in making sure that the right set of
6377 -- discriminals is used at the right time. First the task definition is
6378 -- processed. Any references to discriminants here are replaced by the
6379 -- corresponding *task* discriminals (the record type doesn't even exist
6380 -- yet, since it is constructed as part of the expansion of the task
6381 -- declaration, which happens after the semantic processing of the task
6382 -- definition). The discriminants to be used for the corresponding record
6383 -- are created at the same time as the other discriminals, and held in the
6384 -- CR_Discriminant field of the discriminant. A use of the discriminant in
6385 -- a bound for an entry family is replaced with the CR_Discriminant because
6386 -- it controls the bound of the entry queue array which is a component of
6387 -- the corresponding record.
6389 -- Just before the record initialization routine is constructed, the
6390 -- expander exchanges the task and record discriminals. This has two
6391 -- effects. First the generation of the record initialization routine
6392 -- uses the discriminals that are now on the record, which is the set
6393 -- that used to be on the task, which is what we want.
6395 -- Second, a new set of (so far unused) discriminals is now on the task
6396 -- discriminants, and it is this set that will be used for expanding the
6397 -- task body, and also for the discriminal declarations at the start of
6398 -- the task body.
6400 ---------------------------------------------------
6401 -- Handling of private data in protected objects --
6402 ---------------------------------------------------
6404 -- Private components in protected types pose problems similar to those
6405 -- of discriminants. Private data is visible and can be directly referenced
6406 -- from protected bodies. However, when protected entries and subprograms
6407 -- are expanded into corresponding bodies and barrier functions, private
6408 -- components lose their original context and visibility.
6410 -- To remedy this side effect of expansion, private components are expanded
6411 -- into renamings called "privals", by analogy with "discriminals".
6413 -- private_comp : comp_type renames _object.private_comp;
6415 -- Prival declarations are inserted during the analysis of subprogram and
6416 -- entry bodies to ensure proper visibility for any subsequent expansion.
6417 -- _Object is the formal parameter of the generated corresponding body or
6418 -- a local renaming which denotes the protected object obtained from entry
6419 -- parameter _O. Privals receive minimal decoration upon creation and are
6420 -- categorized as either E_Variable for the general case or E_Constant when
6421 -- they appear in functions.
6423 -- Along with the local declarations, each private component carries a
6424 -- placeholder which references the prival entity in the current body. This
6425 -- form of indirection is used to resolve name clashes of privals and other
6426 -- locally visible entities such as parameters, local objects, entry family
6427 -- indexes or identifiers used in the barrier condition.
6429 -- When analyzing the statements of a protected subprogram or entry, any
6430 -- reference to a private component must resolve to the locally declared
6431 -- prival through normal visibility. In case of name conflicts (the cases
6432 -- above), the prival is marked as hidden and acts as a weakly declared
6433 -- entity. As a result, the reference points to the correct entity. When a
6434 -- private component is denoted by an expanded name (prot_type.comp for
6435 -- example), the expansion mechanism uses the placeholder of the component
6436 -- to correct the Entity and Etype of the reference.
6438 end Einfo;