mips.h (set_volatile): Delete.
[official-gcc.git] / gcc / ada / einfo.ads
blob8e659f12ab302cc50e84cc883e664e54e9073605
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- E I N F O --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2007, 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 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
21 -- --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
28 -- --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
31 -- --
32 ------------------------------------------------------------------------------
34 with Namet; use Namet;
35 with Snames; use Snames;
36 with Types; use Types;
37 with Uintp; use Uintp;
38 with Urealp; use Urealp;
40 package Einfo is
42 -- This package defines the annotations to the abstract syntax tree that
43 -- are needed to support semantic processing of an Ada compilation.
45 -- Note that after editing this spec and the corresponding body it is
46 -- required to run ceinfo to check the consistentcy of spec and body.
47 -- See ceinfo.adb for more information about the checks made.
49 -- These annotations are for the most part attributes of declared entities,
50 -- and they correspond to conventional symbol table information. Other
51 -- attributes include sets of meanings for overloaded names, possible
52 -- types for overloaded expressions, flags to indicate deferred constants,
53 -- incomplete types, etc. These attributes are stored in available fields
54 -- in tree nodes (i.e. fields not used by the parser, as defined by the
55 -- Sinfo package specification), and accessed by means of a set of
56 -- subprograms which define an abstract interface.
58 -- There are two kinds of semantic information
60 -- First, the tree nodes with the following Nkind values:
62 -- N_Defining_Identifier
63 -- N_Defining_Character_Literal
64 -- N_Defining_Operator_Symbol
66 -- are called Entities, and constitute the information that would often
67 -- be stored separately in a symbol table. These nodes are all extended
68 -- to provide extra space, and contain fields which depend on the entity
69 -- kind, as defined by the contents of the Ekind field. The use of the
70 -- Ekind field, and the associated fields in the entity, are defined
71 -- in this package, as are the access functions to these fields.
73 -- Second, in some cases semantic information is stored directly in other
74 -- kinds of nodes, e.g. the Etype field, used to indicate the type of an
75 -- expression. The access functions to these fields are defined in the
76 -- Sinfo package, but their full documentation is to be found in
77 -- the Einfo package specification.
79 -- Declaration processing places information in the nodes of their defining
80 -- identifiers. Name resolution places in all other occurrences of an
81 -- identifier a pointer to the corresponding defining occurrence.
83 --------------------------------
84 -- The XEINFO Utility Program --
85 --------------------------------
87 -- XEINFO is a utility program which automatically produces a C header file,
88 -- einfo.h from the spec and body of package Einfo. It reads the input
89 -- files einfo.ads and einfo.adb and produces the output file einfo.h.
90 -- XEINFO is run automatically by the build scripts when you do a full
91 -- bootstrap.
93 -- In order for this utility program to operate correctly, the form of the
94 -- einfo.ads and einfo.adb files must meet certain requirements and be laid
95 -- out in a specific manner.
97 -- The general form of einfo.ads is as follows:
99 -- type declaration for type Entity_Kind
100 -- subtype declarations declaring subranges of Entity_Kind
101 -- subtype declarations declaring synonyms for some standard types
102 -- function specs for attributes
103 -- procedure specs
104 -- pragma Inline declarations
106 -- This order must be observed. There are no restrictions on the procedures,
107 -- since the C header file only includes functions (Gigi is not allowed to
108 -- modify the generated tree). However, functions are required to have headers
109 -- that fit on a single line.
111 -- XEINFO reads and processes the function specs and the pragma Inlines. For
112 -- functions that are declared as inlined, XEINFO reads the corresponding body
113 -- from einfo.adb, and processes it into C code. This results in some strict
114 -- restrictions on which functions can be inlined:
116 -- The function spec must be on a single line
118 -- There can only be a single statement, contained on a single line,
119 -- not counting any pragma Assert statements.
121 -- This single statement must either be a function call with simple,
122 -- single token arguments, or it must be a membership test of the form
123 -- a in b, where a and b are single tokens.
125 -- For functions that are not inlined, there is no restriction on the body,
126 -- and XEINFO generates a direct reference in the C header file which allows
127 -- the C code in Gigi to directly call the corresponding Ada body.
129 ----------------------------------
130 -- Handling of Type'Size Values --
131 ----------------------------------
133 -- The Ada 95 RM contains some rather peculiar (to us!) rules on the value
134 -- of type'Size (see RM 13.3(55)). We have found that attempting to use
135 -- these RM Size values generally, and in particular for determining the
136 -- default size of objects, creates chaos, and major incompatibilies in
137 -- existing code.
139 -- We proceed as follows, for discrete and fixed-point subtypes, we have
140 -- two separate sizes for each subtype:
142 -- The Object_Size, which is used for determining the default size of
143 -- objects and components. This size value can be referred to using the
144 -- Object_Size attribute. The phrase "is used" here means that it is
145 -- the basis of the determination of the size. The backend is free to
146 -- pad this up if necessary for efficiency, e.g. an 8-bit stand-alone
147 -- character might be stored in 32 bits on a machine with no efficient
148 -- byte access instructions such as the Alpha.
150 -- The default rules for the value of Object_Size for fixed-point and
151 -- discrete types are as follows:
153 -- The Object_Size for base subtypes reflect the natural hardware
154 -- size in bits (see Ttypes and Cstand for integer types). For
155 -- enumeration and fixed-point base subtypes have 8. 16. 32 or 64
156 -- bits for this size, depending on the range of values to be stored.
158 -- The Object_Size of a subtype is the same as the Object_Size of
159 -- the subtype from which it is obtained.
161 -- The Object_Size of a derived base type is copied from the parent
162 -- base type, and the Object_Size of a derived first subtype is copied
163 -- from the parent first subtype.
165 -- The Value_Size which is the number of bits required to store a value
166 -- of the type. This size can be referred to using the Value_Size
167 -- attribute. This value is used to determine how tightly to pack
168 -- records or arrays with components of this type, and also affects
169 -- the semantics of unchecked conversion (unchecked conversions where
170 -- the Value_Size values differ generate a warning, and are potentially
171 -- target dependent).
173 -- The default rule for the value of Value_Size are as follows:
175 -- The Value_Size for a base subtype is the minimum number of bits
176 -- required to store all values of the type (including the sign bit
177 -- only if negative values are possible).
179 -- If a subtype statically matches the first subtype, then it has
180 -- by default the same Value_Size as the first subtype. This is a
181 -- consequence of RM 13.1(14) ("if two subtypes statically match,
182 -- then their subtype-specific aspects are the same".)
184 -- All other subtypes have a Value_Size corresponding to the minimum
185 -- number of bits required to store all values of the subtype. For
186 -- dynamic bounds, it is assumed that the value can range down or up
187 -- to the corresponding bound of the ancestor
189 -- The RM defined attribute Size corresponds to the Value_Size attribute
191 -- The Size attribute may be defined for a first-named subtype. This sets
192 -- the Value_Size of the first-named subtype to the given value, and the
193 -- Object_Size of this first-named subtype to the given value padded up
194 -- to an appropriate boundary. It is a consequence of the default rules
195 -- above that this Object_Size will apply to all further subtypes. On the
196 -- other hand, Value_Size is affected only for the first subtype, any
197 -- dynamic subtypes obtained from it directly, and any statically matching
198 -- subtypes. The Value_Size of any other static subtypes is not affected.
200 -- Value_Size and Object_Size may be explicitly set for any subtype using
201 -- an attribute definition clause. Note that the use of these attributes
202 -- can cause the RM 13.1(14) rule to be violated. If two access types
203 -- reference aliased objects whose subtypes have differing Object_Size
204 -- values as a result of explicit attribute definition clauses, then it
205 -- is erroneous to convert from one access subtype to the other.
207 -- At the implementation level, Esize stores the Object_Size and the
208 -- RM_Size field stores the Value_Size (and hence the value of the
209 -- Size attribute, which, as noted above, is equivalent to Value_Size).
211 -- To get a feel for the difference, consider the following examples (note
212 -- that in each case the base is short_short_integer with a size of 8):
214 -- Object_Size Value_Size
216 -- type x1 is range 0..5; 8 3
218 -- type x2 is range 0..5;
219 -- for x2'size use 12; 12 12
221 -- subtype x3 is x2 range 0 .. 3; 12 2
223 -- subtype x4 is x2'base range 0 .. 10; 8 4
225 -- subtype x5 is x2 range 0 .. dynamic; 12 (7)
227 -- subtype x6 is x2'base range 0 .. dynamic; 8 (7)
229 -- Note: the entries marked (7) are not actually specified by the Ada 95 RM,
230 -- but it seems in the spirit of the RM rules to allocate the minimum number
231 -- of bits known to be large enough to hold the given range of values.
233 -- So far, so good, but GNAT has to obey the RM rules, so the question is
234 -- under what conditions must the RM Size be used. The following is a list
235 -- of the occasions on which the RM Size must be used:
237 -- Component size for packed arrays or records
238 -- Value of the attribute Size for a type
239 -- Warning about sizes not matching for unchecked conversion
241 -- The RM_Size field keeps track of the RM Size as needed in these
242 -- three situations.
244 -- For types other than discrete and fixed-point types, the Object_Size
245 -- and Value_Size are the same (and equivalent to the RM attribute Size).
246 -- Only Size may be specified for such types.
248 -- All size attributes are stored as Uint values. Negative values are used to
249 -- reference GCC expressions for the case of non-static sizes, as explained
250 -- in Repinfo.
252 -----------------------
253 -- Entity Attributes --
254 -----------------------
256 -- This section contains a complete list of the attributes that are defined
257 -- on entities. Some attributes apply to all entities, others only to certain
258 -- kinds of entities. In the latter case the attribute should only be set or
259 -- accessed if the Ekind field indicates an appropriate entity.
261 -- There are two kinds of attributes that apply to entities, stored and
262 -- synthesized. Stored attributes correspond to a field or flag in the entity
263 -- itself. Such attributes are identified in the table below by giving the
264 -- field or flag in the attribute that is used to hold the attribute value.
265 -- Synthesized attributes are not stored directly, but are rather computed as
266 -- needed from other attributes, or from information in the tree. These are
267 -- marked "synthesized" in the table below. The stored attributes have both
268 -- access functions and set procedures to set the corresponding values, while
269 -- synthesized attributes have only access functions.
271 -- Note: in the case of Node, Uint, or Elist fields, there are cases where
272 -- the same physical field is used for different purposes in different
273 -- entities, so these access functions should only be referenced for the
274 -- class of entities in which they are defined as being present. Flags are
275 -- not overlapped in this way, but nevertheless as a matter of style and
276 -- abstraction (which may or may not be checked by assertions in the body),
277 -- this restriction should be observed for flag fields as well.
279 -- Note: certain of the attributes on types apply only to base types, and
280 -- are so noted by the notation [base type only]. These are cases where the
281 -- attribute of any subtype is the same as the attribute of the base type.
282 -- The attribute can be referenced on a subtype (and automatically retrieves
283 -- the value from the base type). However, it is an error to try to set the
284 -- attribute on other than the base type, and if assertions are enabled,
285 -- an attempt to set the attribute on a subtype will raise an assert error.
287 -- Other attributes are noted as applying the implementation base type only.
288 -- These are representation attributes which must always apply to a full
289 -- non-private type, and where the attributes are always on the full type.
290 -- The attribute can be referenced on a subtype (and automatically retries
291 -- the value from the implementation base type). However, it is an error
292 -- to try to set the attribute on other than the implementation base type,
293 -- and if assertions are enabled, an attempt to set the attribute on a
294 -- subtype will raise an assert error.
296 -- Abstract_Interfaces (Elist25)
297 -- Present in record types and subtypes. List of abstract interfaces
298 -- implemented by a tagged type that are not already implemented by the
299 -- ancestors (Ada 2005: AI-251).
301 -- Abstract_Interface_Alias (Node25)
302 -- Present in subprograms that cover a primitive operation of an abstract
303 -- interface type. Can be set only if the Is_Hidden flag is also set,
304 -- since such entities are always hidden. Points to its associated
305 -- interface subprogram. It is used to register the subprogram in
306 -- secondary dispatch table of the interface (Ada 2005: AI-251).
308 -- Accept_Address (Elist21)
309 -- Present in entries. If an accept has a statement sequence, then an
310 -- address variable is created, which is used to hold the address of the
311 -- parameters, as passed by the runtime. Accept_Address holds an element
312 -- list which represents a stack of entities for these address variables.
313 -- The current entry is the top of the stack, which is the last element
314 -- on the list. A stack is required to handle the case of nested select
315 -- statements referencing the same entry.
317 -- Actual_Subtype (Node17)
318 -- Present in variables, constants, and formal parameters. This is the
319 -- subtype imposed by the value of the object, as opposed to its nominal
320 -- subtype, which is imposed by the declaration. The actual subtype
321 -- differs from the nominal one when the latter is indefinite (as in the
322 -- case of an unconstrained formal parameter, or a variable declared
323 -- with an unconstrained type and an initial value). The nominal subtype
324 -- is the Etype entry for the entity. The Actual_Subtype field is set
325 -- only if the actual subtype differs from the nominal subtype. If the
326 -- actual and nominal subtypes are the same, then the Actual_Subtype
327 -- field is Empty, and Etype indicates both types.
329 -- For objects, the Actual_Subtype is set only if this is a discriminated
330 -- type. For arrays, the bounds of the expression are obtained and the
331 -- Etype of the object is directly the constrained subtype. This is
332 -- rather irregular, and the semantic checks that depend on the nominal
333 -- subtype being unconstrained use flag Is_Constr_Subt_For_U_Nominal(qv).
335 -- Access_Disp_Table (Elist16) [implementation base type only]
336 -- Present in record type entities. For a tagged type, points to the
337 -- dispatch tables associated with the tagged type; the last entity of
338 -- this list is an access type declaration used to expand dispatching
339 -- calls through the primary dispatch table. For a non-tagged record,
340 -- contains Empty.
342 -- Address_Clause (synthesized)
343 -- Applies to entries, objects and subprograms. Set if an address clause
344 -- is present which references the object or subprogram and points to
345 -- the N_Attribute_Definition_Clause node. Empty if no Address clause.
346 -- The expression in the address clause is always a constant that is
347 -- defined before the entity to which the address clause applies.
348 -- Note: Gigi references this field in E_Task_Type entities???
350 -- Address_Taken (Flag104)
351 -- Present in all entities. Set if the Address or Unrestricted_Access
352 -- attribute is applied directly to the entity, i.e. the entity is the
353 -- entity of the prefix of the attribute reference. Used by Gigi to
354 -- make sure that the address can be meaningfully taken, and also in
355 -- the case of subprograms to control output of certain warnings.
357 -- Alias (Node18)
358 -- Present in overloaded entities (literals, subprograms, entries) and
359 -- subprograms that cover a primitive operation of an abstract interface
360 -- (that is, subprograms with the Abstract_Interface_Alias attribute).
361 -- In case of overloaded entities it points to the parent subprogram of
362 -- a derived subprogram. In case of abstract interface subprograms it
363 -- points to the subprogram that covers the abstract interface primitive.
364 -- Also used for a subprogram renaming, where it points to the renamed
365 -- subprogram. Always empty for entries.
367 -- Alignment (Uint14)
368 -- Present in entities for types and also in constants, variables
369 -- (including exceptions where it refers to the static data allocated for
370 -- an exception), loop parameters, and formal parameters. This indicates
371 -- the desired alignment for a type, or the actual alignment for an
372 -- object. A value of zero (Uint_0) indicates that the alignment has not
373 -- been set yet. The alignment can be set by an explicit alignment
374 -- clause, or set by the front-end in package Layout, or set by the
375 -- back-end as part of the back end back-annotation process. The
376 -- alignment field is also present in E_Exception entities, but there it
377 -- is used only by the back-end for back annotation.
379 -- Alignment_Clause (synthesized)
380 -- Applies to all entities for types and objects. If an alignment
381 -- attribute definition clause is present for the entity, then this
382 -- function returns the N_Attribute_Definition clause that specifies the
383 -- alignment. If no alignment clause applies to the type, then the call
384 -- to this function returns Empty. Note that the call can return a
385 -- non-Empty value even if Has_Alignment_Clause is not set (happens with
386 -- subtype and derived type declarations). Note also that a record
387 -- definition clause with an (obsolescent) mod clause is converted
388 -- into an attribute definition clause for this purpose.
390 -- Ancestor_Subtype (synthesized)
391 -- Applies to all type and subtype entities. If the argument is a
392 -- subtype then it returns the subtype or type from which the subtype
393 -- was obtained, otherwise it returns Empty.
395 -- Available_View (synthesized)
396 -- Applies to types that have the With_Type flag set. Returns the
397 -- non-limited view of the type, if available, otherwise the type
398 -- itself. For class-wide types, there is no direct link in the tree,
399 -- so we have to retrieve the class-wide type of the non-limited view
400 -- of the Etype.
402 -- Associated_Formal_Package (Node12)
403 -- Present in packages that are the actuals of formal_packages. Points
404 -- to the entity in the declaration for the formal package.
406 -- Associated_Node_For_Itype (Node8)
407 -- Present in all type and subtype entities. Set non-Empty only for
408 -- Itypes. Set to point to the associated node for the Itype, i.e.
409 -- the node whose elaboration generated the Itype. This is used for
410 -- copying trees, to determine whether or not to copy an Itype, and
411 -- also for accessibility checks on anonymous access types. This
412 -- node is typically an object declaration, component declaration,
413 -- type or subtype declaration. For an access discriminant in a type
414 -- declaration, the associated_node_for_itype is the discriminant
415 -- specification. For an access parameter it is the enclosing subprogram
416 -- declaration.
418 -- Associated_Storage_Pool (Node22) [root type only]
419 -- Present in simple and general access type entities. References the
420 -- storage pool to be used for the corresponding collection. A value of
421 -- Empty means that the default pool is to be used. This is present
422 -- only in the root type, since derived types must have the same pool
423 -- as the parent type.
425 -- Associated_Final_Chain (Node23)
426 -- Present in simple and general access type entities. References the
427 -- List_Controller object that holds the finalization chain on which
428 -- are attached dynamically allocated objects referenced by the access
429 -- type. Empty when the access type cannot reference a controlled object.
431 -- Barrier_Function (Node12)
432 -- Present in protected entries and entry families. This is the
433 -- subprogram declaration for the body of the function that returns
434 -- the value of the entry barrier.
436 -- Base_Type (synthesized)
437 -- Applies to all type entities. Returns the base type of a type or
438 -- subtype. The base type of a type is the type itself. The base type
439 -- of a subtype is the type that it constrains (which is always a type
440 -- entity, not some other subtype). Note that in the case of a subtype
441 -- of a private type, it is possible for the base type attribute to
442 -- return a private type, even if the subtype to which it applies is
443 -- non-private. See also Implementation_Base_Type. Note: it is allowed
444 -- to apply Base_Type to other than a type, in which case it simply
445 -- returns the entity unchanged.
447 -- Block_Node (Node11)
448 -- Present in block entities. Points to the identifier in the
449 -- Block_Statement itself. Used when retrieving the block construct
450 -- for finalization purposes, The block entity has an implicit label
451 -- declaration in the enclosing declarative part, and has otherwise
452 -- no direct connection in the tree with the block statement. The
453 -- link is to the identifier (which is an occurence of the entity)
454 -- and not to the block_statement itself, because the statement may
455 -- be rewritten, e.g. in the process of removing dead code.
457 -- Body_Entity (Node19)
458 -- Present in package and generic package entities, points to the
459 -- corresponding package body entity if one is present.
461 -- Body_Needed_For_SAL (Flag40)
462 -- Present in package and subprogram entities that are compilation
463 -- units. Indicates that the source for the body must be included
464 -- when the unit is part of a standalone library.
466 -- C_Pass_By_Copy (Flag125) [implementation base type only]
467 -- Present in record types. Set if a pragma Convention for the record
468 -- type specifies convention C_Pass_By_Copy. This convention name is
469 -- treated as identical in all respects to convention C, except that
470 -- if it is specified for a record type, then the C_Pass_By_Copy flag
471 -- is set, and if a foreign convention subprogram has a formal of the
472 -- corresponding type, then the parameter passing mechanism will be
473 -- set to By_Copy (unless specifically overridden by an Import or
474 -- Export pragma).
476 -- Can_Never_Be_Null (Flag38)
477 -- This flag is present in all entities, but can only be set in an object
478 -- which can never have a null value. This is set True for constant
479 -- access values initialized to a non-null value. This is also True for
480 -- all access parameters in Ada 83 and Ada 95 modes, and for access
481 -- parameters that explicily exlude null in Ada 2005.
483 -- This is used to avoid unnecessary resetting of the Is_Known_Non_Null
484 -- flag for such entities. In Ada 2005 mode, this is also used when
485 -- determining subtype conformance of subprogram profiles to ensure
486 -- that two formals have the same null-exclusion status.
488 -- ??? This is also set on some access types, eg the Etype of the
489 -- anonymous access type of a controlling formal.
491 -- Chars (Name1)
492 -- Present in all entities. This field contains an entry into the names
493 -- table that has the character string of the identifier, character
494 -- literal or operator symbol. See Namet for further details. Note that
495 -- throughout the processing of the front end, this name is the simple
496 -- unqualified name. However, just before gigi is called, a call is made
497 -- to Qualify_All_Entity_Names. This causes entity names to be qualified
498 -- using the encoding described in exp_dbug.ads, and from that point on
499 -- (including post gigi steps such as cross-reference generation), the
500 -- entities will contain the encoded qualified names.
502 -- Checks_May_Be_Suppressed (Flag31)
503 -- Present in all entities. Set if a pragma Suppress or Unsuppress
504 -- mentions the entity specifically in the second argument. If this
505 -- flag is set the the Global_Entity_Suppress and Local_Entity_Suppress
506 -- tables must be consulted to determine if the is actually an active
507 -- Suppress or Unsuppress pragma that applies to the entity.
509 -- Class_Wide_Type (Node9)
510 -- Present in all type entities. For a tagged type or subtype, returns
511 -- the corresponding implicitly declared class-wide type. Set to Empty
512 -- for non-tagged types.
514 -- Cloned_Subtype (Node16)
515 -- Present in E_Record_Subtype and E_Class_Wide_Subtype entities.
516 -- Each such entity can either have a Discriminant_Constraint, in
517 -- which case it represents a distinct type from the base type (and
518 -- will have a list of components and discrimants in the list headed by
519 -- First_Entity) or else no such constraint, in which case it will be a
520 -- copy of the base type.
522 -- o Each element of the list in First_Entity is copied from the base
523 -- type; in that case, this field is Empty.
525 -- o The list in First_Entity is shared with the base type; in that
526 -- case, this field points to that entity.
528 -- A record or classwide subtype may also be a copy of some other
529 -- subtype and share the entities in the First_Entity with that subtype.
530 -- In that case, this field points to that subtype.
532 -- For E_Class_Wide_Subtype, the presence of Equivalent_Type overrides
533 -- this field. Note that this field ONLY appears in subtype entries, not
534 -- in type entries, it is not present, and it is an error to reference
535 -- Cloned_Subtype in an E_Record_Type or E_Class_Wide_Type entity.
537 -- Comes_From_Source
538 -- This flag appears on all nodes, including entities, and indicates
539 -- that the node was created by the scanner or parser from the original
540 -- source. Thus for entities, it indicates that the entity is defined
541 -- in the original source program.
543 -- Component_Alignment (special field) [base type only]
544 -- Present in array and record entities. Contains a value of type
545 -- Component_Alignment_Kind indicating the alignment of components.
546 -- Set to Calign_Default normally, but can be overridden by use of
547 -- the Component_Alignment pragma. Note: this field is currently
548 -- stored in a non-standard way, see body for details.
550 -- Component_Bit_Offset (Uint11)
551 -- Present in record components (E_Component, E_Discriminant) if a
552 -- component clause applies to the component. First bit position of
553 -- given component, computed from the first bit and position values
554 -- given in the component clause. A value of No_Uint means that the
555 -- value is not yet known. The value can be set by the appearence of
556 -- an explicit component clause in a record representation clause,
557 -- or it can be set by the front-end in package Layout, or it can be
558 -- set by the backend. By the time backend processing is completed,
559 -- this field is always set. A negative value is used to represent
560 -- a value which is not known at compile time, and must be computed
561 -- at run-time (this happens if fields of a record have variable
562 -- lengths). See package Layout for details of these values.
564 -- Note: this field is obsolescent, to be eventually replaced entirely
565 -- by Normalized_First_Bit and Normalized_Position, but for the moment,
566 -- gigi is still using (and back annotating) this field, and gigi does
567 -- not know about the new fields. For the front end layout case, the
568 -- Component_Bit_Offset field is only set if it is static, and otherwise
569 -- the new Normalized_First_Bit and Normalized_Position fields are used.
571 -- Component_Clause (Node13)
572 -- Present in record components and discriminants. If a record
573 -- representation clause is present for the corresponding record
574 -- type a that specifies a position for the component, then the
575 -- Component_Clause field of the E_Component entity points to the
576 -- N_Component_Clause node. Set to Empty if no record representation
577 -- clause was present, or if there was no specification for this
578 -- component.
580 -- Component_Size (Uint22) [implementation base type only]
581 -- Present in array types. It contains the component size value for
582 -- the array. A value of No_Uint means that the value is not yet set.
583 -- The value can be set by the use of a component size clause, or
584 -- by the front end in package Layout, or by the backend. A negative
585 -- value is used to represent a value which is not known at compile
586 -- time, and must be computed at run-time (this happens if the type
587 -- of the component has a variable length size). See package Layout
588 -- for details of these values.
590 -- Component_Type (Node20) [implementation base type only]
591 -- Present in array types and string types. References component type.
593 -- Constant_Value (synthesized)
594 -- Applies to variables, constants, named integers, and named reals.
595 -- Obtains the initialization expression for the entity. Will return
596 -- Empty for for a deferred constant whose full view is not available
597 -- or in some other cases of internal entities, which cannot be treated
598 -- as constants from the point of view of constant folding. Empty is
599 -- also returned for variables with no initialization expression.
601 -- Corresponding_Concurrent_Type (Node18)
602 -- Present in record types that are constructed by the expander to
603 -- represent task and protected types (Is_Concurrent_Record_Type flag
604 -- set True). Points to the entity for the corresponding task type or
605 -- protected type.
607 -- Corresponding_Discriminant (Node19)
608 -- Present in discriminants of a derived type, when the discriminant is
609 -- used to constrain a discriminant of the parent type. Points to the
610 -- corresponding discriminant in the parent type. Otherwise it is Empty.
612 -- Corresponding_Equality (Node13)
613 -- Present in function entities for implicit inequality operators.
614 -- Denotes the explicit or derived equality operation that creates
615 -- the implicit inequality. Note that this field is not present in
616 -- other function entities, only in implicit inequality routines,
617 -- where Comes_From_Source is always False.
619 -- Corresponding_Record_Type (Node18)
620 -- Present in protected and task types and subtypes. References the
621 -- entity for the corresponding record type constructed by the expander
622 -- (see Exp_Ch9). This type is used to represent values of the task type.
624 -- Corresponding_Remote_Type (Node22)
625 -- Present in record types that describe the fat pointer structure for
626 -- Remote_Access_To_Subrogram types. References the original access type.
628 -- CR_Discriminant (Node23)
629 -- Present in discriminants of concurrent types. Denotes the homologous
630 -- discriminant of the corresponding record type. The CR_Discriminant is
631 -- created at the same time as the discriminal, and used to replace
632 -- occurrences of the discriminant within the type declaration.
634 -- Current_Use_Clause (Node25)
635 -- Present in packages. Indicates the use clause currently in scope
636 -- that makes the package use_visible. Used to detect redundant use
637 -- clauses for the same package.
639 -- Current_Value (Node9)
640 -- Present in all object entities. Set in E_Variable, E_Constant, formal
641 -- parameters and E_Loop_Parameter entities if we have trackable current
642 -- values. Set non-Empty if the (constant) current value of the variable
643 -- is known, This value is valid only for references from the same
644 -- sequential scope as the entity. The sequential scope of an entity
645 -- includes the immediate scope and any contained scopes that are package
646 -- specs, package bodies, blocks (at any nesting level) or statement
647 -- sequences in IF or loop statements.
649 -- Another related use of this field is to record information about the
650 -- value obtained from an IF or WHILE statement condition. If the IF or
651 -- ELSIF or WHILE condition has the form "NOT {,NOT] OBJ RELOP VAL ",
652 -- or OBJ [AND [THEN]] expr, where OBJ refers to an entity with a
653 -- Current_Value field, RELOP is one of the six relational operators, and
654 -- VAL is a compile-time known value then the Current_Value field of OBJ
655 -- points to the N_If_Statement, N_Elsif_Part, or N_Iteration_Scheme node
656 -- of the relevant construct, and the Condition field of this can be
657 -- consulted to give information about the value of OBJ. For more details
658 -- on this usage, see the procedure Exp_Util.Get_Current_Value_Condition.
660 -- Debug_Info_Off (Flag166)
661 -- Present in all entities. Set if a pragma Suppress_Debug_Info applies
662 -- to the entity, or if internal processing in the compiler determines
663 -- that suppression of debug information is desirable. Note that this
664 -- flag is only for use by the front end as part of the processing for
665 -- determining if Needs_Debug_Info should be set. The back end should
666 -- always test Needs_Debug_Info, it should never test Debug_Info_Off.
668 -- Debug_Renaming_Link (Node25)
669 -- Used to link the variable associated with a debug renaming declaration
670 -- to the renamed entity. See Exp_Dbug.Debug_Renaming_Declaration for
671 -- details of the use of this field.
673 -- Declaration_Node (synthesized)
674 -- Applies to all entities. Returns the tree node for the declaration
675 -- that declared the entity. Normally this is just the Parent of the
676 -- entity. One exception arises with child units, where the parent of
677 -- the entity is a selected component or a defining program unit name.
678 -- Another exception is that if the entity is an incomplete type that
679 -- has been completed, then we obtain the declaration node denoted by
680 -- the full type, i.e. the full type declaration node.
682 -- Default_Expr_Function (Node21)
683 -- Present in parameters. It holds the entity of the parameterless
684 -- function that is built to evaluate the default expression if it is
685 -- more complex than a simple identifier or literal. For the latter
686 -- simple cases or if there is no default value, this field is Empty.
688 -- Default_Expressions_Processed (Flag108)
689 -- A flag in subprograms (functions, operators, procedures) and in
690 -- entries and entry families used to indicate that default expressions
691 -- have been processed and to avoid multiple calls to process the
692 -- default expressions (see Freeze.Process_Default_Expressions), which
693 -- would not only waste time, but also generate false error messages.
695 -- Default_Value (Node20)
696 -- Present in formal parameters. Points to the node representing the
697 -- expression for the default value for the parameter. Empty if the
698 -- parameter has no default value (which is always the case for OUT
699 -- and IN OUT parameters in the absence of errors).
701 -- Delay_Cleanups (Flag114)
702 -- Present in entities that have finalization lists (subprograms
703 -- blocks, and tasks). Set if there are pending generic body
704 -- instantiations for the corresponding entity. If this flag is
705 -- set, then generation of cleanup actions for the corresponding
706 -- entity must be delayed, since the insertion of the generic body
707 -- may affect cleanup generation (see Inline for further details).
709 -- Delay_Subprogram_Descriptors (Flag50)
710 -- Present in entities for which exception subprogram descriptors
711 -- are generated (subprograms, package declarations and package
712 -- bodies). Present if there are pending generic body instantiations
713 -- for the corresponding entity. If this flag is set, then generation
714 -- of the subprogram descriptor for the corresponding enities must
715 -- be delayed, since the insertion of the generic body may add entries
716 -- to the list of handlers.
718 -- Note: for subprograms, Delay_Subprogram_Descriptors is set if and
719 -- only if Delay_Cleanups is set. But Delay_Cleanups can be set for a
720 -- a block (in which case Delay_Subprogram_Descriptors is set for the
721 -- containing subprogram). In addition Delay_Subprogram_Descriptors is
722 -- set for a library level package declaration or body which contains
723 -- delayed instantiations (in this case the descriptor refers to the
724 -- enclosing elaboration procedure).
726 -- Delta_Value (Ureal18)
727 -- Present in fixed and decimal types. Points to a universal real
728 -- that holds value of delta for the type, as given in the declaration
729 -- or as inherited by a subtype or derived type.
731 -- Dependent_Instances (Elist8)
732 -- Present in packages that are instances. Holds list of instances
733 -- of inner generics. Used to place freeze nodes for those instances
734 -- after that of the current one, i.e. after the corresponding generic
735 -- bodies.
737 -- Depends_On_Private (Flag14)
738 -- Present in all type entities. Set if the type is private or if it
739 -- depends on a private type.
741 -- Designated_Type (synthesized)
742 -- Applies to access types. Returns the designated type. Differs
743 -- from Directly_Designated_Type in that if the access type refers
744 -- to an incomplete type, and the full type is available, then this
745 -- full type is returned instead of the incomplete type.
747 -- Digits_Value (Uint17)
748 -- Present in floating point types and subtypes and decimal types and
749 -- subtypes. Contains the Digits value specified in the declaration.
751 -- Directly_Designated_Type (Node20)
752 -- Present in access types. This field points to the type that is
753 -- directly designated by the access type. In the case of an access
754 -- type to an incomplete type, this field references the incomplete
755 -- type. Note that in the semantic processing, what is useful in
756 -- nearly all cases is the full type designated by the access type.
757 -- The function Designated_Type obtains this full type in the case of
758 -- access to an incomplete type.
760 -- Discard_Names (Flag88)
761 -- Present in types and exception entities. Set if pragma Discard_Names
762 -- applies to the entity. It is also set for declarative regions and
763 -- package specs for which a Discard_Names pragma with zero arguments
764 -- has been encountered. The purpose of setting this flag is to be able
765 -- to set the Discard_Names attribute on enumeration types declared
766 -- after the pragma within the same declarative region. This flag is
767 -- set to False if a Keep_Names pragma appears for an enumeration type.
769 -- Discriminal (Node17)
770 -- Present in discriminants (Discriminant formal: GNAT's first
771 -- coinage). The entity used as a formal parameter that corresponds
772 -- to a discriminant. See section "Handling of Discriminants" for
773 -- full details of the use of discriminals.
775 -- Discriminal_Link (Node10)
776 -- Present in discriminals (which have an Ekind of E_In_Parameter,
777 -- or E_Constant), points back to corresponding discriminant.
779 -- Discriminant_Checking_Func (Node20)
780 -- Present in components. Points to the defining identifier of the
781 -- function built by the expander returns a Boolean indicating whether
782 -- the given record component exists for the current discriminant
783 -- values.
785 -- Discriminant_Constraint (Elist21)
786 -- Present in entities whose Has_Discriminants flag is set (concurrent
787 -- types, subtypes, record types and subtypes, private types and
788 -- subtypes, limited private types and subtypes and incomplete types).
789 -- It is an error to reference the Discriminant_Constraint field if
790 -- Has_Discriminants is False.
792 -- If the Is_Constrained flag is set, Discriminant_Constraint points
793 -- to an element list containing the discriminant constraints in the
794 -- same order in which the discriminants are declared.
796 -- If the Is_Constrained flag is not set but the discriminants of the
797 -- unconstrained type have default initial values then this field
798 -- points to an element list giving these default initial values in
799 -- the same order in which the discriminants are declared. Note that
800 -- in this case the entity cannot be a tagged record type, because
801 -- discriminants in this case cannot have defaults.
803 -- If the entity is a tagged record implicit type, then this field is
804 -- inherited from the first subtype (so that the itype is subtype
805 -- conformant with its first subtype, which is needed when the first
806 -- subtype overrides primitive operations inherited by the implicit
807 -- base type).
809 -- In all other cases Discriminant_Constraint contains the empty
810 -- Elist (ie it is initialized with a call to New_Elmt_List).
812 -- Discriminant_Default_Value (Node20)
813 -- Present in discriminants. Points to the node representing the
814 -- expression for the default value of the discriminant. Set to
815 -- Empty if the discriminant has no default value.
817 -- Discriminant_Number (Uint15)
818 -- Present in discriminants. Gives the ranking of a discriminant in
819 -- the list of discriminants of the type, i.e. a sequential integer
820 -- index starting at 1 and ranging up to Number_Discriminants.
822 -- Dispatch_Table_Wrapper (Node26) [implementation base type only]
823 -- Present in library level record type entities if we are generating
824 -- statically allocated dispatch tables. For a tagged type, points to
825 -- the dispatch table wrapper associated with the tagged type. For a
826 -- non-tagged record, contains Empty.
828 -- DTC_Entity (Node16)
829 -- Present in function and procedure entities. Set to Empty unless
830 -- the subprogram is dispatching in which case it references the
831 -- Dispatch Table pointer Component. That is to say the component _tag
832 -- for regular Ada tagged types, for CPP_Class types and their
833 -- descendants this field points to the component entity in the record
834 -- that is the Vtable pointer for the Vtable containing the entry that
835 -- references the subprogram.
837 -- DT_Entry_Count (Uint15)
838 -- Present in E_Component entities. Only used for component marked
839 -- Is_Tag. Store the number of entries in the Vtable (or Dispatch Table)
841 -- DT_Offset_To_Top_Func (Node25)
842 -- Present in E_Component entities. Only used for component marked
843 -- Is_Tag. If present it stores the Offset_To_Top function used to
844 -- provide this value in tagged types whose ancestor has discriminants.
846 -- DT_Position (Uint15)
847 -- Present in function and procedure entities which are dispatching
848 -- (should not be referenced without first checking that flag
849 -- Is_Dispatching_Operation is True). Contains the offset into
850 -- the Vtable for the entry that references the subprogram.
852 -- Ekind (Ekind)
853 -- Present in all entities. Contains a value of the enumeration type
854 -- Entity_Kind declared in a subsequent section in this spec.
856 -- Elaborate_Body_Desirable (Flag210)
857 -- Present in package entities. Set if the elaboration circuitry detects
858 -- a case where there is a package body that modifies one or more visible
859 -- entities in the package spec and there is no explicit Elaborate_Body
860 -- pragma for the package. This information is passed on to the binder,
861 -- which attempts, but does not promise, to elaborate the body as close
862 -- to the spec as possible.
864 -- Elaboration_Entity (Node13)
865 -- Present in generic and non-generic package and subprogram
866 -- entities. This is a boolean entity associated with the unit that
867 -- is initiallly set to False, and is set True when the unit is
868 -- elaborated. This is used for two purposes. First, it is used to
869 -- implement required access before elaboration checks (the flag
870 -- must be true to call a subprogram at elaboration time). Second,
871 -- it is used to guard against repeated execution of the generated
872 -- elaboration code.
874 -- Note that we always allocate this flag, and set this field, but
875 -- we do not always actually use it. It is only used if it is needed
876 -- for access-before-elaboration use (see Elaboration_Entity_Required
877 -- flag) or if either the spec or the body has elaboration code. If
878 -- neither of these two conditions holds, then the entity is still
879 -- allocated (since we don't know early enough whether or not there
880 -- is elaboration code), but is simply not used for any purpose.
882 -- Elaboration_Entity_Required (Flag174)
883 -- Present in generics and non-generic package and subprogram
884 -- entities. Set only if Elaboration_Entity is non-Empty to indicate
885 -- that the boolean is required to be set even if there is no other
886 -- elaboration code. This occurs when the Elaboration_Entity flag
887 -- is used for required access-before-elaboration checking. If the
888 -- flag is only for preventing multiple execution of the elaboration
889 -- code, then if there is no other elaboration code, obviously there
890 -- is no need to set the flag.
892 -- Enclosing_Dynamic_Scope (synthesized)
893 -- Applies to all entities. Returns the closest dynamic scope in which
894 -- the entity is declared or Standard_Standard for library-level entities
896 -- Enclosing_Scope (Node18)
897 -- Present in labels. Denotes the innermost enclosing construct that
898 -- contains the label. Identical to the scope of the label, except for
899 -- labels declared in the body of an accept statement, in which case the
900 -- entry_name is the Enclosing_Scope. Used to validate goto's within
901 -- accept statements.
903 -- Entry_Accepted (Flag152)
904 -- Present in E_Entry and E_Entry_Family entities. Set if there is
905 -- at least one accept for this entry in the task body. Used to
906 -- generate warnings for missing accepts.
908 -- Entry_Bodies_Array (Node15)
909 -- Present in protected types for which Has_Entries is true.
910 -- This is the defining identifier for the array of entry body
911 -- action procedures and barrier functions used by the runtime to
912 -- execute the user code associated with each entry.
914 -- Entry_Cancel_Parameter (Node23)
915 -- Present in blocks. This only applies to a block statement for
916 -- which the Is_Asynchronous_Call_Block flag is set. It
917 -- contains the defining identifier of an object that must be
918 -- passed to the Cancel_Task_Entry_Call or Cancel_Protected_Entry_Call
919 -- call in the cleanup handler added to the block by
920 -- Exp_Ch7.Expand_Cleanup_Actions. This parameter is a Boolean
921 -- object for task entry calls and a Communications_Block object
922 -- in the case of protected entry calls. In both cases the objects
923 -- are declared in outer scopes to this block.
925 -- Entry_Component (Node11)
926 -- Present in formal parameters (in, in out and out parameters). Used
927 -- only for formals of entries. References the corresponding component
928 -- of the entry parameter record for the entry.
930 -- Entry_Formal (Node16)
931 -- Present in components of the record built to correspond to entry
932 -- parameters. This field points from the component to the formal. It
933 -- is the back pointer corresponding to Entry_Component.
935 -- Entry_Index_Constant (Node18)
936 -- Present in an entry index parameter. This is an identifier that
937 -- eventually becomes the name of a constant representing the index
938 -- of the entry family member whose entry body is being executed. Used
939 -- to expand references to the entry index specification identifier.
941 -- Entry_Index_Type (synthesized)
942 -- Applies to an entry family. Denotes Etype of the subtype indication
943 -- in the entry declaration. Used to resolve the index expression in an
944 -- accept statement for a member of the family, and in the prefix of
945 -- 'COUNT when it applies to a family member.
947 -- Entry_Parameters_Type (Node15)
948 -- Present in entries. Points to the access-to-record type that is
949 -- constructed by the expander to hold a reference to the parameter
950 -- values. This reference is manipulated (as an address) by the
951 -- tasking runtime. The designated record represents a packaging
952 -- up of the entry parameters (see Exp_Ch9.Expand_N_Entry_Declaration
953 -- for further details). Entry_Parameters_Type is Empty if the entry
954 -- has no parameters.
956 -- Enumeration_Pos (Uint11)
957 -- Present in enumeration literals. Contains the position number
958 -- corresponding to the value of the enumeration literal.
960 -- Enumeration_Rep (Uint12)
961 -- Present in enumeration literals. Contains the representation that
962 -- corresponds to the value of the enumeration literal. Note that
963 -- this is normally the same as Enumeration_Pos except in the presence
964 -- of representation clauses, where Pos will still represent the
965 -- position of the literal within the type and Rep will have be the
966 -- value given in the representation clause.
968 -- Enumeration_Rep_Expr (Node22)
969 -- Present in enumeration literals. Points to the expression in an
970 -- associated enumeration rep clause that provides the representation
971 -- value for this literal. Empty if no enumeration rep clause for this
972 -- literal (or if rep clause does not have an entry for this literal,
973 -- an error situation). This is also used to catch duplicate entries
974 -- for the same literal.
976 -- Enum_Pos_To_Rep (Node23)
977 -- Present in enumeration types (but not enumeration subtypes). Set to
978 -- Empty unless the enumeration type has a non-standard representation
979 -- (i.e. at least one literal has a representation value different from
980 -- its pos value). In this case, Enum_Pos_To_Rep is the entity for an
981 -- array constructed when the type is frozen that maps Pos values to
982 -- corresponding Rep values. The index type of this array is Natural,
983 -- and the component type is a suitable integer type that holds the
984 -- full range of representation values.
986 -- Equivalent_Type (Node18)
987 -- Present in class wide types and subtypes, access to protected
988 -- subprogram types, and in exception_types. For a classwide type, it
989 -- is always Empty. For a class wide subtype, it points to an entity
990 -- created by the expander which gives Gigi an easily understandable
991 -- equivalent of the class subtype with a known size (given by an
992 -- initial value). See Exp_Util.Expand_Class_Wide_Subtype for further
993 -- details. For E_exception_type, this points to the record containing
994 -- the data necessary to represent exceptions (for further details, see
995 -- System.Standard_Library. For access_to_protected subprograms, it
996 -- denotes a record that holds pointers to the operation and to the
997 -- protected object. For remote Access_To_Subprogram types, it denotes
998 -- the record that is the fat pointer representation of an RAST.
1000 -- Esize (Uint12)
1001 -- Present in all types and subtypes, and also for components, constants,
1002 -- and variables, including exceptions where it refers to the static data
1003 -- allocated for an exception. Contains the Object_Size of the type or of
1004 -- the object. A value of zero indicates that the value is not yet known.
1006 -- For the case of components where a component clause is present, the
1007 -- value is the value from the component clause, which must be non-
1008 -- negative (but may be zero, which is acceptable for the case of
1009 -- a type with only one possible value). It is also possible for Esize
1010 -- of a component to be set without a component clause present, which
1011 -- means that the component size is specified, but not the position.
1012 -- See also RM_Size and the section on "Handling of Type'Size Values".
1013 -- During gigi processing, the value is back annotated for all zero
1014 -- values, so that after the call to gigi, the value is properly set.
1016 -- Etype (Node5)
1017 -- Present in all entities. Represents the type of the entity, which
1018 -- is itself another entity. For a type entity, points to the parent
1019 -- type for a derived type, or if the type is not derived, points to
1020 -- itself. For a subtype entity, Etype points to the base type. For
1021 -- a class wide type, points to the parent type. For a subprogram or
1022 -- subprogram type, Etype has the return type of a function or is set
1023 -- to Standard_Void_Type to represent a procedure.
1025 -- Exception_Code (Uint22)
1026 -- Present in exception entitites. Set to zero unless either an
1027 -- Import_Exception or Export_Exception pragma applies to the
1028 -- pragma and specifies a Code value. See description of these
1029 -- pragmas for details. Note that this field is relevant only if
1030 -- Is_VMS_Exception is set.
1032 -- Extra_Formal (Node15)
1033 -- Present in formal parameters in the non-generic case. Certain
1034 -- parameters require extra implicit information to be passed
1035 -- (e.g. the flag indicating if an unconstrained variant record
1036 -- argument is constrained, and the accessibility level for
1037 -- access parameters. See description of Extra_Constrained,
1038 -- Extra_Accessibility fields for further details. Extra formal
1039 -- parameters are constructed to represent these values, and
1040 -- chained to the end of the list of formals using the
1041 -- Extra_Formal field (i.e. the Extra_Formal field of the last
1042 -- "real" formal points to the first extra formal, and the
1043 -- Extra_Formal field of each extra formal points to the next
1044 -- one, with Empty indicating the end of the list of extra
1045 -- formals.
1047 -- Extra_Formals (Node28)
1048 -- Applies to subprograms and subprogram types, and also in entries
1049 -- and entry families. Returns first extra formal of the subprogram
1050 -- or entry. Returns Empty if there are no extra formals.
1052 -- Extra_Accessibility (Node13)
1053 -- Present in formal parameters in the non-generic case if
1054 -- expansion is active. Normally Empty, but if a parameter is
1055 -- one for which a dynamic accessibility check is required, then
1056 -- an extra formal of type Natural is created (see description
1057 -- of field Extra_Formal), and the Extra_Accessibility field of
1058 -- the formal parameter points to the entity for this extra
1059 -- formal. Also present in variables when compiling receiving
1060 -- stubs. In this case, a non Empty value means that this
1061 -- variable's accessibility depth has been transmitted by the
1062 -- caller and must be retrieved through the entity designed by
1063 -- this field instead of being computed.
1065 -- Extra_Constrained (Node23)
1066 -- Present in formal parameters in the non-generic case if
1067 -- expansion is active. Normally Empty, but if a parameter is
1068 -- one for which a dynamic indication of its constrained status
1069 -- is required, then an extra formal of type Boolean is created
1070 -- (see description of field Extra_Formal), and the
1071 -- Extra_Constrained field of the formal parameter points to the
1072 -- entity for this extra formal. Also present in variables when
1073 -- compiling receiving stubs. In this case, a non empty value
1074 -- means that this variable's constrained status has been
1075 -- transmitted by the caller and must be retrieved through the
1076 -- entity designed by this field instead of being computed.
1078 -- Finalization_Chain_Entity (Node19)
1079 -- Present in scopes that can have finalizable entities (blocks,
1080 -- functions, procedures, tasks, entries, return statements). When this
1081 -- field is empty it means that there are no finalization actions to
1082 -- perform on exit of the scope. When this field contains 'Error', it
1083 -- means that no finalization actions should happen at this level and
1084 -- the finalization chain of a parent scope shall be used (??? this is
1085 -- an improper use of 'Error' and should be changed). Otherwise it
1086 -- contains an entity of type Finalizable_Ptr that is the head of the
1087 -- list of objects to finalize on exit. See "Finalization Management"
1088 -- section in exp_ch7.adb for more details.
1090 -- Finalize_Storage_Only (Flag158) [base type only]
1091 -- Present in all types. Set on direct controlled types to which a
1092 -- valid Finalize_Storage_Only pragma applies. This flag is also set on
1093 -- composite types when they have at least one controlled component and
1094 -- all their controlled components are Finalize_Storage_Only. It is also
1095 -- inherited by type derivation except for direct controlled types where
1096 -- the Finalize_Storage_Only pragma is required at each level of
1097 -- derivation.
1099 -- First_Component (synthesized)
1100 -- Applies to record types. Returns the first component by following the
1101 -- chain of declared entities for the record until a component is found
1102 -- (one with an Ekind of E_Component). The discriminants are skipped. If
1103 -- the record is null, then Empty is returned.
1105 -- First_Component_Or_Discriminant (synthesized)
1106 -- Similar to First_Component, but discriminants are not skipped, so will
1107 -- find the first discriminant if discriminants are present.
1109 -- First_Discriminant (synthesized)
1110 -- Applies to types with discriminants. The discriminants are the first
1111 -- entities declared in the type, so normally this is equivalent to
1112 -- First_Entity. The exception arises for tagged types, where the tag
1113 -- itself is prepended to the front of the entity chain, so the
1114 -- First_Discriminant function steps past the tag if it is present.
1116 -- First_Entity (Node17)
1117 -- Present in all entities which act as scopes to which a list of
1118 -- associated entities is attached (blocks, class subtypes and types,
1119 -- entries, functions, loops, packages, procedures, protected objects,
1120 -- record types and subtypes, private types, task types and subtypes).
1121 -- Points to a list of associated entities using the Next_Entity field
1122 -- as a chain pointer with Empty marking the end of the list.
1124 -- First_Formal (synthesized)
1125 -- Applies to subprograms and subprogram types, and also in entries
1126 -- and entry families. Returns first formal of the subprogram or entry.
1127 -- The formals are the first entities declared in a subprogram or in
1128 -- a subprogram type (the designated type of an Access_To_Subprogram
1129 -- definition) or in an entry.
1131 -- First_Formal_With_Extras (synthesized)
1132 -- Applies to subprograms and subprogram types, and also in entries
1133 -- and entry families. Returns first formal of the subprogram or entry.
1134 -- Returns Empty if there are no formals. The list returned includes
1135 -- all the extra formals (see description of Extra_Formals field).
1137 -- First_Index (Node17)
1138 -- Present in array types and subtypes and in string types and subtypes.
1139 -- By introducing implicit subtypes for the index constraints, we have
1140 -- the same structure for constrained and unconstrained arrays, subtype
1141 -- marks and discrete ranges are both represented by a subtype. This
1142 -- function returns the tree node corresponding to an occurrence of the
1143 -- first index (NOT the entity for the type). Subsequent indexes are
1144 -- obtained using Next_Index. Note that this field is present for the
1145 -- case of string literal subtypes, but is always Empty.
1147 -- First_Literal (Node17)
1148 -- Present in all enumeration types, including character and boolean
1149 -- types. This field points to the first enumeration literal entity
1150 -- for the type (i.e. it is set to First (Literals (N)) where N is
1151 -- the enumeration type definition node. A special case occurs with
1152 -- standard character and wide character types, where this field is
1153 -- Empty, since there are no enumeration literal lists in these cases.
1154 -- Note that this field is set in enumeration subtypes, but it still
1155 -- points to the first literal of the base type in this case.
1157 -- First_Optional_Parameter (Node14)
1158 -- Present in (non-generic) function and procedure entities. Set to a
1159 -- non-null value only if a pragma Import_Function, Import_Procedure
1160 -- or Import_Valued_Procedure specifies a First_Optional_Parameter
1161 -- argument, in which case this field points to the parameter entity
1162 -- corresponding to the specified parameter.
1164 -- First_Private_Entity (Node16)
1165 -- Present in all entities containing private parts (packages,
1166 -- protected types and subtypes, task types and subtypes). The
1167 -- entities on the entity chain are in order of declaration, so the
1168 -- entries for private entities are at the end of the chain. This
1169 -- field points to the first entity for the private part. It is
1170 -- Empty if there are no entities declared in the private part or
1171 -- if there is no private part.
1173 -- First_Rep_Item (Node6)
1174 -- Present in all entities. If non-empty, points to a linked list of
1175 -- representation pragmas nodes and representation clause nodes that
1176 -- apply to the entity, linked using Next_Rep_Item, with Empty marking
1177 -- the end of the list. In the case of derived types and subtypes, the
1178 -- new entity inherits the chain at the point of declaration. This
1179 -- means that it is possible to have multiple instances of the same
1180 -- kind of rep item on the chain, in which case it is the first one
1181 -- that applies to the entity.
1183 -- For most representation items, the representation information is
1184 -- reflected in other fields and flags in the entity. For example if
1185 -- a record representation clause is present, the component entities
1186 -- reflect the specified information. However, there are some items
1187 -- that are only reflected in the chain. These include:
1189 -- Alignment attribute definition clause
1190 -- Machine_Attribute pragma
1191 -- Link_Alias pragma
1192 -- Link-Section pragma
1193 -- Weak_External pragma
1195 -- If any of these items are present, then the flag Has_Gigi_Rep_Item
1196 -- is set, indicating that Gigi should search the chain.
1198 -- Other representation items are included in the chain so that error
1199 -- messages can easily locate the relevant nodes for posting errors.
1200 -- Note in particular that size clauses are present only for this
1201 -- purpose, and should only be accessed if Has_Size_Clause is set.
1203 -- First_Stored_Discriminant (synthesized)
1204 -- Applies to types with discriminants. Gives the first discriminant
1205 -- stored in the object. In many cases, these are the same as the
1206 -- normal visible discriminants for the type, but in the case of
1207 -- renamed discriminants, this is not always the case.
1209 -- For tagged types, and untagged types which are root types or
1210 -- derived types but which do not rename discriminants in their
1211 -- root type, the stored discriminants are the same as the actual
1212 -- discriminants of the type, and hence this function is the same
1213 -- as First_Discriminant.
1215 -- For derived non-tagged types that rename discriminants in the root
1216 -- type this is the first of the discriminants that occur in the
1217 -- root type. To be precise, in this case stored discriminants are
1218 -- entities attached to the entity chain of the derived type which
1219 -- are a copy of the discriminants of the root type. Furthermore their
1220 -- Is_Completely_Hidden flag is set since although they are actually
1221 -- stored in the object, they are not in the set of discriminants that
1222 -- is visble in the type.
1224 -- For derived untagged types, stored discriminants are the real
1225 -- discriminants from Gigi's standpoint, i.e. those that will be
1226 -- stored in actual objects of the type.
1228 -- First_Subtype (synthesized)
1229 -- Applies to all types and subtypes. For types, yields the first
1230 -- subtype of the type. For subtypes, yields the first subtype of
1231 -- the base type of the subtype.
1233 -- First_Tag_Component (synthesized)
1234 -- Applies to tagged record types, returns the entity for the first
1235 -- _Tag field in this record.
1237 -- Freeze_Node (Node7)
1238 -- Present in all entities. If there is an associated freeze node for
1239 -- the entity, this field references this freeze node. If no freeze
1240 -- node is associated with the entity, then this field is Empty. See
1241 -- package Freeze for further details.
1243 -- From_With_Type (Flag159)
1244 -- Present in package and type entities. Indicates that the entity
1245 -- appears in a With_Type clause in the context of some other unit,
1246 -- either as the prefix (which must be a package), or as a type name.
1247 -- The package can only be used to retrieve such a type, and the type
1248 -- can be used only in component declarations and access definitions.
1249 -- The With_Type clause is used to construct mutually recursive
1250 -- types, i.e. record types (Java classes) that hold pointers to each
1251 -- other. If such a type is an access type, it has no explicit freeze
1252 -- node, so that the back-end does not attempt to elaborate it.
1253 -- Currently this flag is also used to implement Ada 2005 (AI-50217).
1254 -- It will be renamed to From_Limited_With after removal of the current
1255 -- GNAT with_type clause???
1257 -- Full_View (Node11)
1258 -- Present in all type and subtype entities and in deferred constants.
1259 -- References the entity for the corresponding full type declaration.
1260 -- For all types other than private and incomplete types, this field
1261 -- always contains Empty. See also Underlying_Type.
1263 -- Function_Returns_With_DSP (Flag169)
1264 -- Present in all subprogram entities, and type entities for access
1265 -- to subprogram values. Set True if the function (or referenced
1266 -- function in the case of an access value) returns with using the
1267 -- DSP (depressed stack pointer) approach. This can only be set
1268 -- True if Targparm.Functions_Return_By_DSP_On_Target is True and
1269 -- the function returns a value of a type whose size is not known
1270 -- at compile time.
1272 -- Note: this flag is obsolete, it is always False ???
1274 -- Generic_Homonym (Node11)
1275 -- Present in generic packages. The generic homonym is the entity of
1276 -- a renaming declaration inserted in every generic unit. It is used
1277 -- to resolve the name of a local entity that is given by a qualified
1278 -- name, when the generic entity itself is hidden by a local name.
1280 -- Generic_Renamings (Elist23)
1281 -- Present in package and subprogram instances. Holds mapping that
1282 -- associates generic parameters with the corresponding instances, in
1283 -- those cases where the instance is an entity.
1285 -- Handler_Records (List10)
1286 -- Present in subprogram and package entities. Points to a list of
1287 -- identifiers referencing the handler record entities for the
1288 -- corresponding unit.
1290 -- Has_Aliased_Components (Flag135) [implementation base type only]
1291 -- Present in array type entities. Indicates that the component type
1292 -- of the array is aliased.
1294 -- Has_Alignment_Clause (Flag46)
1295 -- Present in all type entities and objects. Indicates if an alignment
1296 -- clause has been given for the entity. If set, then Alignment_Clause
1297 -- returns the N_Attribute_Definition node for the alignment attribute
1298 -- definition clause. Note that it is possible for this flag to be False
1299 -- even when Alignment_Clause returns non_Empty (this happens in the case
1300 -- of derived type declarations).
1302 -- Has_All_Calls_Remote (Flag79)
1303 -- Present in all library unit entities. Set true if the library unit
1304 -- has an All_Calls_Remote pragma. Note that such entities must also
1305 -- be RCI entities, so the flag Is_Remote_Call_Interface will always
1306 -- be set if this flag is set.
1308 -- Has_Anon_Block_Suffix (Flag201)
1309 -- Present in all entities. Set if the entity is nested within one or
1310 -- more anonymous blocks and the Chars field contains a name with an
1311 -- anonymous block suffix (see Exp_Dbug for furthert details).
1313 -- Has_Atomic_Components (Flag86) [implementation base type only]
1314 -- Present in all types and objects. Set only for an array type or
1315 -- an array object if a valid pragma Atomic_Components applies to the
1316 -- type or object. Note that in the case of an object, this flag is
1317 -- only set on the object if there was an explicit pragma for the
1318 -- object. In other words, the proper test for whether an object has
1319 -- atomic components is to see if either the object or its base type
1320 -- has this flag set. Note that in the case of a type, the pragma will
1321 -- be chained to the rep item chain of the first subtype in the usual
1322 -- manner.
1324 -- Has_Attach_Handler (synthesized)
1325 -- Applies to record types that are constructed by the expander to
1326 -- represent protected types. Returns True if there is at least one
1327 -- Attach_Handler pragma in the corresponding specification.
1329 -- Has_Biased_Representation (Flag139)
1330 -- Present in discrete types (where it applies to the type'size value),
1331 -- and to objects (both stand-alone and components), where it applies to
1332 -- the size of the object from a size or record component clause. In
1333 -- all cases it indicates that the size in question is smaller than
1334 -- would normally be required, but that the size requirement can be
1335 -- satisfied by using a biased representation, in which stored values
1336 -- have the low bound (Expr_Value (Type_Low_Bound (T)) subtracted to
1337 -- reduce the required size. For example, a type with a range of 1..2
1338 -- takes one bit, using 0 to represent 1 and 1 to represent 2.
1340 -- Note that in the object and component cases, the flag is only set
1341 -- if the type is unbiased, but the object specifies a smaller size
1342 -- than the size of the type, forcing biased representation for the
1343 -- object, but the subtype is still an unbiased type.
1345 -- Has_Completion (Flag26)
1346 -- Present in all entities that require a completion (functions,
1347 -- procedures, private types, limited private types, incomplete types,
1348 -- constants and packages that require a body). The flag is set if the
1349 -- completion has been encountered and analyzed.
1351 -- Has_Completion_In_Body (Flag71)
1352 -- Present in all entities for types and subtypes. Set only in "Taft
1353 -- amendment types" (incomplete types whose full declaration appears in
1354 -- the package body).
1356 -- Has_Complex_Representation (Flag140) [implementation base type only]
1357 -- Present in all type entities. Set only for a record base type to
1358 -- which a valid pragma Complex_Representation applies.
1360 -- Has_Component_Size_Clause (Flag68) [implementation base type only]
1361 -- Present in all type entities. Set if a component size clause is
1362 -- present for the given type. Note that this flag can be False even
1363 -- if Component_Size is non-zero (happens in the case of derived types).
1365 -- Has_Constrained_Partial_View (Flag187)
1366 -- Present in private type and their completions, when the private
1367 -- type has no discriminants and the full view has discriminants with
1368 -- defaults. In Ada 2005 heap-allocated objects of such types are not
1369 -- constrained, and can change their discriminants with full assignment.
1371 -- Has_Contiguous_Rep (Flag181)
1372 -- Present in enumeration types. True if the type as a representation
1373 -- clause whose entries are successive integers.
1375 -- Has_Controlling_Result (Flag98)
1376 -- Present in E_Function entities. True if the function is a primitive
1377 -- function of a tagged type which can dispatch on result.
1379 -- Has_Controlled_Component (Flag43) [base type only]
1380 -- Present in all entities. Set only for composite type entities which
1381 -- contain a component that either is a controlled type, or itself
1382 -- contains controlled component (i.e. either Has_Controlled_Component
1383 -- or Is_Controlled is set for at least one component).
1385 -- Has_Convention_Pragma (Flag119)
1386 -- Present in all entities. Set true for an entity for which a valid
1387 -- Convention, Import, or Export pragma has been given. Used to prevent
1388 -- more than one such pragma appearing for a given entity (RM B.1(45)).
1390 -- Has_Delayed_Freeze (Flag18)
1391 -- Present in all entities. Set to indicate that an explicit freeze
1392 -- node must be generated for the entity at its freezing point. See
1393 -- separate section ("Delayed Freezing and Elaboration") for details.
1395 -- Has_Discriminants (Flag5)
1396 -- Present in all types and subtypes. For types that are allowed to have
1397 -- discriminants (record types and subtypes, task types and subtypes,
1398 -- protected types and subtypes, private types, limited private types,
1399 -- and incomplete types), indicates if the corresponding type or subtype
1400 -- has a known discriminant part. Always false for all other types.
1402 -- Has_Dispatch_Table (Flag220)
1403 -- Present in E_Record_Types that are tagged. Set to indicate that the
1404 -- corresponding dispatch table is already built. This flag is used to
1405 -- avoid duplicate construction of library level dispatch tables (because
1406 -- the declaration of library level objects cause premature construction
1407 -- of the table); otherwise the code that builds the table is added at
1408 -- the end of the list of declarations of the package.
1410 -- Has_Entries (synthesized)
1411 -- Applies to concurrent types. True if any entries are declared
1412 -- within the task or protected definition for the type.
1414 -- Has_Enumeration_Rep_Clause (Flag66)
1415 -- Present in enumeration types. Set if an enumeration representation
1416 -- clause has been given for this enumeration type. Used to prevent more
1417 -- than one enumeration representation clause for a given type. Note
1418 -- that this does not imply a representation with holes, since the rep
1419 -- clause may merely confirm the default 0..N representation.
1421 -- Has_External_Tag_Rep_Clause (Flag110)
1422 -- Present in tagged types. Set if an external_tag rep. clause has been
1423 -- given for this type. Use to avoid the generation of the default
1424 -- external_tag.
1426 -- Has_Exit (Flag47)
1427 -- Present in loop entities. Set if the loop contains an exit statement.
1429 -- Has_Foreign_Convention (synthesized)
1430 -- Applies to all entities. Determines if the Convention for the
1431 -- entity is a foreign convention (i.e. is other than Convention_Ada,
1432 -- Convention_Intrinsic, Convention_Entry or Convention_Protected).
1434 -- Has_Forward_Instantiation (Flag175)
1435 -- Present in package entities. Set true for packages that contain
1436 -- instantiations of local generic entities, before the corresponding
1437 -- generic body has been seen. If a package has a forward instantiation,
1438 -- we cannot inline subprograms appearing in the same package because
1439 -- the placement requirements of the instance will conflict with the
1440 -- linear elaboration of front-end inlining.
1442 -- Has_Fully_Qualified_Name (Flag173)
1443 -- Present in all entities. Set True if the name in the Chars field
1444 -- has been replaced by the fully qualified name, as used for debug
1445 -- output. See Exp_Dbug for a full description of the use of this
1446 -- flag and also the related flag Has_Qualified_Name.
1448 -- Has_Gigi_Rep_Item (Flag82)
1449 -- Present in all entities. Set if the rep item chain (referenced by
1450 -- First_Rep_Item and linked through the Next_Rep_Item chain) contains a
1451 -- representation item that needs to be specially processed by Gigi, i.e.
1452 -- one of the following items:
1454 -- Machine_Attribute pragma
1455 -- Linker_Alias pragma
1456 -- Linker_Section pragma
1457 -- Linker_Constructor pragma
1458 -- Linker_Destructor pragma
1459 -- Weak_External pragma
1461 -- If this flag is set, then Gigi should scan the rep item chain to
1462 -- process any of these items that appear. At least one such item will
1463 -- be present.
1465 -- Has_Homonym (Flag56)
1466 -- Present in all entities. Set if an entity has a homonym in the same
1467 -- scope. Used by Gigi to generate unique names for such entities.
1469 -- Has_Initial_Value (Flag219)
1470 -- Present in entities for variables and out parameters. Set if there
1471 -- is an explicit initial value expression in the declaration of the
1472 -- variable. Note that this is set only if this initial value is
1473 -- explicit, it is not set for the case of implicit initialization
1474 -- of access types or controlled types. Always set to False for out
1475 -- parameters. Also present in entities for in and in-out parameters,
1476 -- but always false in these cases.
1478 -- Has_Interrupt_Handler (synthesized)
1479 -- Applies to all protected type entities. Set if the protected type
1480 -- definition contains at least one procedure to which a pragma
1481 -- Interrupt_Handler applies.
1483 -- Has_Machine_Radix_Clause (Flag83)
1484 -- Present in decimal types and subtypes, set if a Machine_Radix
1485 -- representation clause is present. This flag is used to detect
1486 -- the error of multiple machine radix clauses for a single type.
1488 -- Has_Master_Entity (Flag21)
1489 -- Present in entities that can appear in the scope stack (see spec
1490 -- of Sem). It is set if a task master entity (_master) has been
1491 -- declared and initialized in the corresponding scope.
1493 -- Has_Missing_Return (Flag142)
1494 -- Present in functions and generic functions. Set if there is one or
1495 -- more missing return statements in the function. This is used to
1496 -- control wrapping of the body in Exp_Ch6 to ensure that the program
1497 -- error exeption is correctly raised in this case at runtime.
1499 -- Has_Up_Level_Access (Flag215)
1500 -- Present in E_Variable and E_Constant entities. Set if the entity is
1501 -- declared in a local procedure p and is accessed in a procedure nested
1502 -- inside p. Only set when VM_Target /= No_VM currently.
1504 -- Has_Nested_Block_With_Handler (Flag101)
1505 -- Present in scope entities. Set if there is a nested block within the
1506 -- scope that has an exception handler and the two scopes are in the
1507 -- same procedure. This is used by the backend for controlling certain
1508 -- optimizations to ensure that they are consistent with exceptions.
1509 -- See documentation in Gigi for further details.
1511 -- Has_Non_Standard_Rep (Flag75) [implementation base type only]
1512 -- Present in all type entities. Set when some representation clause
1513 -- or pragma causes the representation of the item to be significantly
1514 -- modified. In this category are changes of small or radix for a
1515 -- fixed-point type, change of component size for an array, and record
1516 -- or enumeration representation clauses, as well as packed pragmas.
1517 -- All other representation clauses (e.g. Size and Alignment clauses)
1518 -- are not considered to be significant since they do not affect
1519 -- stored bit patterns.
1521 -- Has_Object_Size_Clause (Flag172)
1522 -- Present in entities for types and subtypes. Set if an Object_Size
1523 -- clause has been processed for the type Used to prevent multiple
1524 -- Object_Size clauses for a given entity.
1526 -- Has_Per_Object_Constraint (Flag154)
1527 -- Present in E_Component entities, true if the subtype of the
1528 -- component has a per object constraint. Per object constraints result
1529 -- from the following situations:
1531 -- 1. N_Attribute_Reference - when the prefix is the enclosing type and
1532 -- the attribute is Access.
1533 -- 2. N_Discriminant_Association - when the expression uses the
1534 -- discriminant of the enclosing type.
1535 -- 3. N_Index_Or_Discriminant_Constraint - when at least one of the
1536 -- individual constraints is a per object constraint.
1537 -- 4. N_Range - when the lower or upper bound uses the discriminant of
1538 -- the enclosing type.
1539 -- 5. N_Range_Constraint - when the range expression uses the
1540 -- discriminant of the enclosing type.
1542 -- Has_Persistent_BSS (Flag188)
1543 -- Present in all entities. Set True for entities to which a valid
1544 -- pragma Persistent_BSS applies. Note that although the pragma is
1545 -- only meaningful for objects, we set it for all entities in a unit
1546 -- to which the pragma applies, as well as the unit entity itself, for
1547 -- convenience in propagating the flag to contained entities.
1549 -- Has_Pragma_Controlled (Flag27) [implementation base type only]
1550 -- Present in access type entities. It is set if a pragma Controlled
1551 -- applies to the access type.
1553 -- Has_Pragma_Elaborate_Body (Flag150)
1554 -- Present in all entities. Set in compilation unit entities if a
1555 -- pragma Elaborate_Body applies to the compilation unit.
1557 -- Has_Pragma_Inline (Flag157)
1558 -- Present in all entities. Set for functions and procedures for which
1559 -- a pragma Inline or Inline_Always applies to the subprogram. Note
1560 -- that this flag can be set even if Is_Inlined is not set. This
1561 -- happens for pragma Inline (if Inline_Active is False). In other
1562 -- words, the flag Has_Pragma_Inline represents the formal semantic
1563 -- status, and is used for checking semantic correctness.
1564 -- The flag Is_Inlined indicates whether inlining is actually active
1565 -- for the entity.
1567 -- Has_Pragma_Pack (Flag121) [implementation base type only]
1568 -- Present in all entities. If set, indicates that a valid pragma Pack
1569 -- was was given for the type. Note that this flag is not inherited by
1570 -- derived type. See also the Is_Packed flag.
1572 -- Has_Pragma_Pure (Flag203)
1573 -- Present in all entities. If set, indicates that a valid pragma Pure
1574 -- was given for the entity. In some cases, we need to test whether
1575 -- Is_Pure was explicitly set using this pragma.
1577 -- Has_Pragma_Preelab_Init (Flag221)
1578 -- Present in type and subtype entities. If set indicates that a valid
1579 -- pragma Preelaborable_Initialization applies to the type.
1581 -- Has_Pragma_Pure_Function (Flag179)
1582 -- Present in all entities. If set, indicates that a valid pragma
1583 -- Pure_Function was given for the entity. In some cases, we need to
1584 -- know that Is_Pure was explicitly set using this pragma.
1586 -- Has_Pragma_Unreferenced (Flag180)
1587 -- Present in all entities. Set if a valid pragma Unreferenced applies
1588 -- to the pragma, indicating that no warning should be given if the
1589 -- entity has no references, but a warning should be given if it is
1590 -- in fact referenced. For private types, this flag is set in both the
1591 -- private entity and full entity if the pragma applies to either.
1593 -- Has_Pragma_Unreferenced_Objects (Flag212)
1594 -- Present in type and subtype entities. Set if a valid pragma
1595 -- Unreferenced_Objects applies to the type, indicating that no warning
1596 -- should be given for objects of such a type for being unreferenced
1597 -- (but unlike the case with pragma Unreferenced, it is ok to reference
1598 -- such an object and no warning is generated.
1600 -- Has_Primitive_Operations (Flag120) [base type only]
1601 -- Present in all type entities. Set if at least one primitive operation
1602 -- is defined for the type.
1604 -- Has_Private_Ancestor (synthesized)
1605 -- Applies to all type and subtype entities. Returns True if at least
1606 -- one ancestor is private, and otherwise False if there are no private
1607 -- ancestors.
1609 -- Has_Private_Declaration (Flag155)
1610 -- Present in all entities. Returns True if it is the defining entity
1611 -- of a private type declaration or its corresponding full declaration.
1612 -- This flag is thus preserved when the full and the partial views are
1613 -- exchanged, to indicate if a full type declaration is a completion.
1614 -- Used for semantic checks in E.4 (18), and elsewhere.
1616 -- Has_Qualified_Name (Flag161)
1617 -- Present in all entities. Set True if the name in the Chars field
1618 -- has been replaced by its qualified name, as used for debug output.
1619 -- See Exp_Dbug for a full description of qualification requirements.
1620 -- For some entities, the name is the fully qualified name, but there
1621 -- are exceptions. In particular, for local variables in procedures,
1622 -- we do not include the procedure itself or higher scopes. See also
1623 -- the flag Has_Fully_Qualified_Name, which is set if the name does
1624 -- indeed include the fully qualified name.
1626 -- Has_RACW (Flag214)
1627 -- Present in package spec entities. Set if the spec contains the
1628 -- declaration of a remote access-to-classwide type.
1630 -- Has_Record_Rep_Clause (Flag65) [implementation base type only]
1631 -- Present in record types. Set if a record representation clause has
1632 -- been given for this record type. Used to prevent more than one such
1633 -- clause for a given record type. Note that this is initially cleared
1634 -- for a derived type, even though the representation is inherited. See
1635 -- also the flag Has_Specified_Layout.
1637 -- Has_Recursive_Call (Flag143)
1638 -- Present in procedures. Set if a direct parameterless recursive call
1639 -- is detected while analyzing the body. Used to activate some error
1640 -- checks for infinite recursion.
1642 -- Has_Size_Clause (Flag29)
1643 -- Present in entities for types and objects. Set if a size clause is
1644 -- present for the entity. Used to prevent multiple Size clauses for a
1645 -- given entity. Note that it is always initially cleared for a derived
1646 -- type, even though the Size for such a type is inherited from a Size
1647 -- clause given for the parent type.
1649 -- Has_Small_Clause (Flag67)
1650 -- Present in ordinary fixed point types (but not subtypes). Indicates
1651 -- that a small clause has been given for the entity. Used to prevent
1652 -- multiple Small clauses for a given entity. Note that it is always
1653 -- initially cleared for a derived type, even though the Small for such
1654 -- a type is inherited from a Small clause given for the parent type.
1656 -- Has_Specified_Layout (Flag100) [implementation base type only]
1657 -- Present in all type entities. Set for a record type or subtype if
1658 -- the record layout has been specified by a record representation
1659 -- clause. Note that this differs from the flag Has_Record_Rep_Clause
1660 -- in that it is inherited by a derived type. Has_Record_Rep_Clause is
1661 -- used to indicate that the type is mentioned explicitly in a record
1662 -- representation clause, and thus is not inherited by a derived type.
1663 -- This flag is always False for non-record types.
1665 -- Has_Specified_Stream_Input (Flag190)
1666 -- Has_Specified_Stream_Output (Flag191)
1667 -- Has_Specified_Stream_Read (Flag192)
1668 -- Has_Specified_Stream_Write (Flag193)
1669 -- Present in all type and subtype entities. Set for a given view if the
1670 -- corresponding stream-oriented attribute has been defined by an
1671 -- attribute definition clause. When such a clause occurs, a TSS is set
1672 -- on the underlying full view; the flags are used to track visibility of
1673 -- the attribute definition clause for partial or incomplete views.
1675 -- Has_Static_Discriminants (Flag211)
1676 -- Present in record subtypes constrained by discriminant values. Set if
1677 -- all the discriminant values have static values, meaning that in the
1678 -- case of a variant record, the component list can be trimmed down to
1679 -- include only the components corresponding to these discriminants.
1681 -- Has_Storage_Size_Clause (Flag23) [implementation base type only]
1682 -- Present in task types and access types. It is set if a Storage_Size
1683 -- clause is present for the type. Used to prevent multiple clauses for
1684 -- one type. Note that this flag is initially cleared for a derived type
1685 -- even though the Storage_Size for such a type is inherited from a
1686 -- Storage_Size clause given for the parent type. Note that in the case
1687 -- of access types, this flag is present only in the root type, since a
1688 -- storage size clause cannot be given to a derived type.
1690 -- Has_Stream_Size_Clause (Flag184)
1691 -- Present in all entities. It is set for types which have a Stream_Size
1692 -- clause attribute. Used to prevent multiple Stream_Size clauses for a
1693 -- given entity, and also whether it is necessary to check for a stream
1694 -- size clause.
1696 -- Has_Subprogram_Descriptor (Flag93)
1697 -- This flag is set on entities for which zero-cost exception subprogram
1698 -- descriptors can be generated (subprograms and library level package
1699 -- declarations and bodies). It indicates that a subprogram descriptor
1700 -- has been generated, and is used to suppress generation of multiple
1701 -- descriptors (e.g. when instantiating generic bodies).
1703 -- Has_Task (Flag30) [base type only]
1704 -- Present in all type entities. Set on task types themselves, and also
1705 -- (recursively) on any composite type which has a component for which
1706 -- Has_Task is set. The meaning is that an allocator or declaration of
1707 -- such an object must create the required tasks. Note: the flag is not
1708 -- set on access types, even if they designate an object that Has_Task.
1710 -- Has_Unchecked_Union (Flag123) [base type only]
1711 -- Present in all type entities. Set on unchecked unions themselves
1712 -- and (recursively) on any composite type which has a component for
1713 -- which Has_Unchecked_Union is set. The meaning is that a comparison
1714 -- operation for the type is not permitted. Note that the flag is not
1715 -- set on access types, even if they designate an object that has
1716 -- the flag Has_Unchecked_Union set.
1718 -- Has_Unknown_Discriminants (Flag72)
1719 -- Present in all entities. Set for types with unknown discriminants.
1720 -- Types can have unknown discriminants either from their declaration or
1721 -- through type derivation. The use of this flag exactly meets the spec
1722 -- in RM 3.7(26). Note that all class-wide types are considered to have
1723 -- unknown discriminants. Note that both Has_Discriminants and
1724 -- Has_Unknown_Discriminants may be true for a type. Class-wide types and
1725 -- their subtypes have unknown discriminants and can have declared ones
1726 -- as well. Private types declared with unknown discriminants may have a
1727 -- full view that has explicit discriminants, and both flag will be set
1728 -- on the partial view, to insure that discriminants are properly
1729 -- inherited in certain contexts.
1731 -- Has_Volatile_Components (Flag87) [implementation base type only]
1732 -- Present in all types and objects. Set only for an array type or
1733 -- array object if a valid pragma Volatile_Components or a valid
1734 -- pragma Atomic_Components applies to the type or object. Note that
1735 -- in the case of an object, this flag is only set on the object if
1736 -- there was an explicit pragma for the object. In other words, the
1737 -- proper test for whether an object has volatile components is to
1738 -- see if either the object or its base type has this flag set. Note
1739 -- that in the case of a type the pragma will be chained to the rep
1740 -- item chain of the first subtype in the usual manner.
1742 -- Has_Xref_Entry (Flag182)
1743 -- Present in all entities. Set if an entity has an entry in the Xref
1744 -- information generated in ali files. This is true for all source
1745 -- entities in the extended main source file. It is also true of entities
1746 -- in other packages that are referenced directly or indirectly from the
1747 -- main source file (indirect reference occurs when the main source file
1748 -- references an entity with a type reference. See package Lib.Xref for
1749 -- further details).
1751 -- Hiding_Loop_Variable (Node8)
1752 -- Present in variables. Set only if a variable of a discrete type is
1753 -- hidden by a loop variable in the same local scope, in which case
1754 -- the Hiding_Loop_Variable field of the hidden variable points to
1755 -- the E_Loop_Parameter entity doing the hiding. Used in processing
1756 -- warning messages if the hidden variable turns out to be unused
1757 -- or is referenced without being set.
1759 -- Homonym (Node4)
1760 -- Present in all entities. Link for list of entities that have the
1761 -- same source name and that are declared in the same or enclosing
1762 -- scopes. Homonyms in the same scope are overloaded. Used for name
1763 -- resolution and for the generation of debugging information.
1765 -- Implementation_Base_Type (synthesized)
1766 -- Applies to all types. Similar to Base_Type, but never returns a
1767 -- private type when applied to a non-private type. Instead in this case,
1768 -- it always returns the Underlying_Type of the base type, so that we
1769 -- still have a concrete type. Note: it is allowed to apply
1770 -- Implementation_Base_Type to other than a type, in which case it simply
1771 -- returns the entity unchanged.
1773 -- In_Package_Body (Flag48)
1774 -- Present in package entities. Set on the entity that denotes the
1775 -- package (the defining occurrence of the package declaration) while
1776 -- analyzing and expanding the package body. Reset on completion of
1777 -- analysis/expansion.
1779 -- In_Private_Part (Flag45)
1780 -- Present in all entities. Can be set only in package entities and
1781 -- objects. For package entities, this flag is set to indicate that the
1782 -- private part of the package is being analyzed. The flag is reset at
1783 -- the end of the package declaration. For objects it indicates that the
1784 -- declaration of the object occurs in the private part of a package.
1786 -- Inner_Instances (Elist23)
1787 -- Present in generic units. Contains element list of units that are
1788 -- instantiated within the given generic. Used to diagnose circular
1789 -- instantiations.
1791 -- Interface_Name (Node21)
1792 -- Present in exceptions, functions, procedures, variables, constants,
1793 -- and packages. Set to Empty unless an export, import, or interface
1794 -- name pragma has explicitly specified an external name, in which
1795 -- case it references an N_String_Literal node for the specified
1796 -- external name. In the case of exceptions, the field is set by
1797 -- Import_Exception/Export_Exception (which can be used in OpenVMS
1798 -- versions only). Note that if this field is Empty, and Is_Imported
1799 -- or Is_Exported is set, then the default interface name is the name
1800 -- of the entity, cased in a manner that is appropriate to the system
1801 -- in use. Note that Interface_Name is ignored if an address clause
1802 -- is present (since it is meaningless in this case).
1804 -- An additional special case usage of this field is in JGNAT for
1805 -- E_Component and E_Discriminant. JGNAT allows these entities to
1806 -- be imported by specifying pragma Import within a component's
1807 -- containing record definition. This supports interfacing to
1808 -- object fields defined within Java classes, and such pragmas
1809 -- are generated by the jvm2ada binding generator tool whenever
1810 -- it processes classes with public object fields. A pragma Import
1811 -- for a component can define the External_Name of the imported
1812 -- Java field (which is generally needed, because Java names are
1813 -- case sensitive).
1815 -- In_Use (Flag8)
1816 -- Present in packages and types. Set when analyzing a use clause for
1817 -- the corresponding entity. Reset at end of corresponding declarative
1818 -- part. The flag on a type is also used to determine the visibility of
1819 -- the primitive operators of the type.
1821 -- Is_Abstract_Subprogram (Flag19)
1822 -- Present in all subprograms and entries. Set for abstract subprograms.
1823 -- Always False for enumeration literals and entries. See also
1824 -- Requires_Overriding.
1826 -- Is_Abstract_Type (Flag146)
1827 -- Present in all types. Set for abstract types.
1829 -- Is_Local_Anonymous_Access (Flag194)
1830 -- Present in access types. Set for an anonymous access type to indicate
1831 -- that the type is created for a record component with an access
1832 -- definition, an array component, or a stand-alone object. Such
1833 -- anonymous types have an accessibility level equal to that of the
1834 -- declaration in which they appear, unlike the anonymous access types
1835 -- that are created for access parameters and access discriminants.
1837 -- Is_Access_Constant (Flag69)
1838 -- Present in access types and subtypes. Indicates that the keyword
1839 -- constant was present in the access type definition.
1841 -- Is_Access_Protected_Subprogram_Type (synthesized)
1842 -- Applies to all types, true for named and anonymous access to
1843 -- protected subprograms.
1845 -- Is_Access_Type (synthesized)
1846 -- Applies to all entities, true for access types and subtypes
1848 -- Is_Ada_2005_Only (Flag185)
1849 -- Present in all entities, true if a valid pragma Ada_05 applies to the
1850 -- entity which specifically names the entity, indicating that the entity
1851 -- is Ada 2005 only. Note that this flag is not set if the entity is part
1852 -- of a unit compiled with the normal no-argument form of pragma Ada_05.
1854 -- Is_Aliased (Flag15)
1855 -- Present in objects whose declarations carry the keyword aliased,
1856 -- and on record components that have the keyword.
1858 -- Is_Always_Inlined (synthesized)
1859 -- Present in subprograms. True if there is a pragma Inline_Always for
1860 -- the subprogram.
1862 -- Is_AST_Entry (Flag132)
1863 -- Present in entry entities. Set if a valid pragma AST_Entry applies
1864 -- to the entry. This flag can only be set in OpenVMS versions of GNAT.
1865 -- Note: we also allow the flag to appear in entry families, but given
1866 -- the current implementation of the pragma AST_Entry, this flag will
1867 -- always be False in entry families.
1869 -- Is_Atomic (Flag85)
1870 -- Present in all type entities, and also in constants, components and
1871 -- variables. Set if a pragma Atomic or Shared applies to the entity.
1872 -- In the case of private and incomplete types, this flag is set in
1873 -- both the partial view and the full view.
1875 -- Is_Array_Type (synthesized)
1876 -- Applies to all entities, true for array types and subtypes
1878 -- Is_Asynchronous (Flag81)
1879 -- Present in all type entities and in procedure entities. Set
1880 -- if a pragma Asynchronous applies to the entity.
1882 -- Is_Bit_Packed_Array (Flag122) [implementation base type only]
1883 -- Present in all entities. This flag is set for a packed array
1884 -- type that is bit packed (i.e. the component size is known by the
1885 -- front end and is in the range 1-7, 9-15, 17-31, or 33-63). Is_Packed
1886 -- is always set if Is_Bit_Packed_Array is set, but it is possible for
1887 -- Is_Packed to be set without Is_Bit_Packed_Array for the case of an
1888 -- array having one or more index types that are enumeration types
1889 -- with non-standard enumeration representations.
1891 -- Is_Boolean_Type (synthesized)
1892 -- Applies to all entities, true for boolean types and subtypes,
1893 -- i.e. Standard.Boolean and all types ultimately derived from it.
1895 -- Is_By_Copy_Type (synthesized)
1896 -- Applies to all type entities. Returns true if the entity is
1897 -- a by copy type (RM 6.2(3)).
1899 -- Is_By_Reference_Type (synthesized)
1900 -- Applies to all type entities. True if the type is required to
1901 -- be passed by reference, as defined in (RM 6.2(4-9)).
1903 -- Is_Called (Flag102)
1904 -- Present in subprograms. Returns true if the subprogram is called
1905 -- in the unit being compiled or in a unit in the context. Used for
1906 -- inlining.
1908 -- Is_Character_Type (Flag63)
1909 -- Present in all entities. Set for character types and subtypes,
1910 -- i.e. enumeration types that have at least one character literal.
1912 -- Is_Child_Unit (Flag73)
1913 -- Present in all entities. Set only for defining entities of program
1914 -- units that are child units (but False for subunits).
1916 -- Is_Class_Wide_Type (synthesized)
1917 -- Applies to all entities, true for class wide types and subtypes
1919 -- Is_Class_Wide_Equivalent_Type (Flag35)
1920 -- Present in record types and subtypes. Set to True, if the type acts
1921 -- as a class-wide equivalent type, i.e. the Equivalent_Type field of
1922 -- some class-wide subtype entity references this record type.
1924 -- Is_Compilation_Unit (Flag149)
1925 -- Present in all entities. Set if the entity is a package or subprogram
1926 -- entity for a compilation unit other than a subunit (since we treat
1927 -- subunits as part of the same compilation operation as the ultimate
1928 -- parent, we do not consider them to be separate units for this flag).
1930 -- Is_Completely_Hidden (Flag103)
1931 -- Present in all entities. This flag can be set only for E_Discriminant
1932 -- entities. This flag can be set only for girder discriminants of
1933 -- untagged types. When set, the entity is a girder discriminant of a
1934 -- derived untagged type which is not directly visible in the derived
1935 -- type because the derived type or one of its ancestors have renamed the
1936 -- discriminants in the root type. Note: there are girder discriminants
1937 -- which are not Completely_Hidden (e.g. discriminants of a root type).
1939 -- Is_Composite_Type (synthesized)
1940 -- Applies to all entities, true for all composite types and
1941 -- subtypes. Either Is_Composite_Type or Is_Elementary_Type (but
1942 -- not both) is true of any type.
1944 -- Is_Concurrent_Record_Type (Flag20)
1945 -- Present in record types and subtypes. Set if the type was created
1946 -- by the expander to represent a task or protected type. For every
1947 -- concurrent type, such as record type is constructed, and task and
1948 -- protected objects are instances of this record type at runtime
1949 -- (Gigi will replace declarations of the concurrent type using the
1950 -- declarations of the corresponding record type). See package Exp_Ch9
1951 -- for further details.
1953 -- Is_Concurrent_Type (synthesized)
1954 -- Applies to all entities, true for task types and subtypes and
1955 -- for protected types and subtypes.
1957 -- Is_Constrained (Flag12)
1958 -- Present in types or subtypes which may have index, discriminant
1959 -- or range constraint (i.e. array types and subtypes, record types
1960 -- and subtypes, string types and subtypes, and all numeric types).
1961 -- Set if the type or subtype is constrained.
1963 -- Is_Constr_Subt_For_U_Nominal (Flag80)
1964 -- Present in all types and subtypes. Set true only for the constructed
1965 -- subtype of an object whose nominal subtype is unconstrained. Note
1966 -- that the constructed subtype itself will be constrained.
1968 -- Is_Constr_Subt_For_UN_Aliased (Flag141)
1969 -- Present in all types and subtypes. This flag can be set only if
1970 -- Is_Constr_Subt_For_U_Nominal is also set. It indicates that in
1971 -- addition the object concerned is aliased. This flag is used by
1972 -- Gigi to determine whether a template must be constructed.
1974 -- Is_Constructor (Flag76)
1975 -- Present in function and procedure entities. Set if a pragma
1976 -- CPP_Constructor applies to the subprogram.
1978 -- Is_Controlled (Flag42) [base type only]
1979 -- Present in all type entities. Indicates that the type is controlled,
1980 -- i.e. is either a descendant of Ada.Finalization.Controlled or of
1981 -- Ada.Finalization.Limited_Controlled.
1983 -- Is_Controlling_Formal (Flag97)
1984 -- Present in all Formal_Kind entities. Marks the controlling parameters
1985 -- of dispatching operations.
1987 -- Is_CPP_Class (Flag74)
1988 -- Present in all type entities, set only for tagged types to which a
1989 -- valid pragma Import (CPP, ...) or pragma CPP_Class has been applied.
1991 -- Is_Decimal_Fixed_Point_Type (synthesized)
1992 -- Applies to all type entities, true for decimal fixed point
1993 -- types and subtypes.
1995 -- Is_Derived_Type (synthesized)
1996 -- Applies to all entities. Determine if given entity is a derived type.
1997 -- Always false if argument is not a type.
1999 -- Is_Descendent_Of_Address (Flag223)
2000 -- Present in all type and subtype entities. Indicates that a type is an
2001 -- address type that is visibly a numeric type. Used for semantic checks
2002 -- on VMS to remove ambiguities in universal integer expressions that may
2003 -- have an address interpretation
2005 -- Is_Discrete_Type (synthesized)
2006 -- Applies to all entities, true for all discrete types and subtypes
2008 -- Is_Discrete__Or_Fixed_Point_Type (synthesized)
2009 -- Applies to all entities, true for all discrete types and subtypes
2010 -- and all fixed-point types and subtypes.
2012 -- Is_Discrim_SO_Function (Flag176)
2013 -- Present in all entities. Set only in E_Function entities that Layout
2014 -- creates to compute discriminant-dependent dynamic size/offset values.
2016 -- Is_Dispatching_Operation (Flag6)
2017 -- Present in all entities. Set true for procedures, functions,
2018 -- generic procedures and generic functions if the corresponding
2019 -- operation is dispatching.
2021 -- Is_Dynamic_Scope (synthesized)
2022 -- Applies to all Entities. Returns True if the entity is a dynamic
2023 -- scope (i.e. a block, subprogram, task_type, entry
2024 -- or extended return statement).
2026 -- Is_Elementary_Type (synthesized)
2027 -- Applies to all entities, true for all elementary types and
2028 -- subtypes. Either Is_Composite_Type or Is_Elementary_Type (but
2029 -- not both) is true of any type.
2031 -- Is_Eliminated (Flag124)
2032 -- Present in type entities, subprogram entities, and object entities.
2033 -- Indicates that the corresponding entity has been eliminated by use
2034 -- of pragma Eliminate. Also used to mark subprogram entities whose
2035 -- declaration and body are within unreachable code that is removed.
2037 -- Is_Enumeration_Type (synthesized)
2038 -- Present in all entities, true for enumeration types and subtypes
2040 -- Is_Entry (synthesized)
2041 -- Applies to all entities, True only for entry and entry family
2042 -- entities and False for all other entity kinds.
2044 -- Is_Entry_Formal (Flag52)
2045 -- Present in all entities. Set only for entry formals (which can
2046 -- only be in, in-out or out parameters). This flag is used to speed
2047 -- up the test for the need to replace references in Exp_Ch2.
2049 -- Is_Exported (Flag99)
2050 -- Present in all entities. Set if the entity is exported. For now we
2051 -- only allow the export of constants, exceptions, functions, procedures
2052 -- and variables, but that may well change later on. Exceptions can only
2053 -- be exported in the OpenVMS and Java VM implementations of GNAT.
2055 -- Is_First_Subtype (Flag70)
2056 -- Present in all entities. True for first subtypes (RM 3.2.1(6)),
2057 -- i.e. the entity in the type declaration that introduced the type.
2058 -- This may be the base type itself (e.g. for record declarations and
2059 -- enumeration type declarations), or it may be the first subtype of
2060 -- an anonymous base type (e.g. for integer type declarations or
2061 -- constrained array declarations).
2063 -- Is_Fixed_Point_Type (synthesized)
2064 -- Applies to all entities, true for decimal and ordinary fixed
2065 -- point types and subtypes
2067 -- Is_Floating_Point_Type (synthesized)
2068 -- Applies to all entities, true for float types and subtypes
2070 -- Is_Formal (synthesized)
2071 -- Applies to all entities, true for IN, IN OUT and OUT parameters
2073 -- Is_Formal_Object (synthesized)
2074 -- Applies to all entities, true for generic IN and IN OUT parameters
2076 -- Is_Formal_Subprogram (Flag111)
2077 -- Present in all entities. Set for generic formal subprograms.
2079 -- Is_For_Access_Subtype (Flag118)
2080 -- Present in E_Private_Subtype and E_Record_Subtype entities.
2081 -- Means the sole purpose of the type is to be designated by an
2082 -- Access_Subtype and hence should not be expanded into components
2083 -- because the type may not have been found or frozen yet.
2085 -- Is_Frozen (Flag4)
2086 -- Present in all type and subtype entities. Set if type or subtype has
2087 -- been frozen.
2089 -- Is_Generic_Actual_Type (Flag94)
2090 -- Present in all type and subtype entities. Set in the subtype
2091 -- declaration that renames the generic formal as a subtype of the
2092 -- actual. Guarantees that the subtype is not static within the instance.
2094 -- Is_Generic_Instance (Flag130)
2095 -- Present in all entities. Set to indicate that the entity is an
2096 -- instance of a generic unit, or a formal package (which is an instance
2097 -- of the template).
2099 -- Is_Generic_Subprogram (synthesized)
2100 -- Applies to all entities. Yields True for a generic subprogram
2101 -- (generic function, generic subprogram), False for all other entities.
2103 -- Is_Generic_Type (Flag13)
2104 -- Present in all types and subtypes. Set for types which are generic
2105 -- formal types. Such types have an Ekind that corresponds to their
2106 -- classification, so the Ekind cannot be used to identify generic types.
2108 -- Is_Generic_Unit (synthesized)
2109 -- Applies to all entities. Yields True for a generic unit (generic
2110 -- package, generic function, generic procedure), and False for all
2111 -- other entities.
2113 -- Is_Hidden (Flag57)
2114 -- Present in all entities. Set true for all entities declared in the
2115 -- private part or body of a package. Also marks generic formals of a
2116 -- formal package declared without a box. For library level entities,
2117 -- this flag is set if the entity is not publicly visible.
2119 -- Is_Hidden_Open_Scope (Flag171)
2120 -- Present in all entities. Set true for a scope that contains the
2121 -- instantiation of a child unit, and whose entities are not visible
2122 -- during analysis of the instance.
2124 -- Is_Immediately_Visible (Flag7)
2125 -- Present in all entities. Set if entity is immediately visible, i.e.
2126 -- is defined in some currently open scope (RM 8.3(4)).
2128 -- Is_Imported (Flag24)
2129 -- Present in all entities. Set if the entity is imported. For now we
2130 -- only allow the import of exceptions, functions, procedures, packages.
2131 -- and variables. Exceptions can only be imported in the OpenVMS and
2132 -- Java VM implementations of GNAT. Packages and types can only be
2133 -- imported in the Java VM implementation.
2135 -- Is_Incomplete_Or_Private_Type (synthesized)
2136 -- Applies to all entities, true for private and incomplete types
2138 -- Is_Incomplete_Type (synthesized)
2139 -- Applies to all entities, true for incomplete types and subtypes
2141 -- Is_Indefinite_Subtype (synthesized)
2142 -- Applies to all entities for types and subtypes. Determines if given
2143 -- entity is an unconstrained array type or subtype, a discriminated
2144 -- record type or subtype with no initial discriminant values or a
2145 -- class wide type or subtype.
2147 -- Is_Inlined (Flag11)
2148 -- Present in all entities. Set for functions and procedures which are
2149 -- to be inlined. For subprograms created during expansion, this flag
2150 -- may be set directly by the expander to request inlining. Also set
2151 -- for packages that contain inlined subprograms, whose bodies must be
2152 -- be compiled. Is_Inlined is also set on generic subprograms and is
2153 -- inherited by their instances. It is also set on the body entities
2154 -- of inlined subprograms. See also Has_Pragma_Inline.
2156 -- Is_Instantiated (Flag126)
2157 -- Present in generic packages and generic subprograms. Set if the unit
2158 -- is instantiated from somewhere in the extended main source unit. This
2159 -- flag is used to control warnings about the unit being uninstantiated.
2160 -- Also set in a package that is used as an actual for a generic package
2161 -- formal in an instantiation. Also set on a parent instance, in the
2162 -- instantiation of a child, which is implicitly declared in the parent.
2164 -- Is_Integer_Type (synthesized)
2165 -- Applies to all entities, true for integer types and subtypes
2167 -- Is_Interface (Flag186)
2168 -- Present in record types and subtypes. Set to indicate that the current
2169 -- entity corresponds with an abstract interface. Because abstract
2170 -- interfaces are conceptually a special kind of abstract tagged types
2171 -- we represent them by means of tagged record types and subtypes
2172 -- marked with this attribute. This allows us to reuse most of the
2173 -- compiler support for abstract tagged types to implement interfaces
2174 -- (Ada 2005: AI-251).
2176 -- Is_Internal (Flag17)
2177 -- Present in all entities. Set to indicate an entity created during
2178 -- semantic processing (e.g. an implicit type, or a temporary). The
2179 -- current uses of this flag are: 1) to indicate that internal entities
2180 -- (such as temporaries generated for the result of an inlined function
2181 -- call or dummy variables generated for the debugger) need not be
2182 -- initialized, even when scalars are initialized or normalized, and 2)
2183 -- to indicate object declarations generated by the expander that are
2184 -- implicitly imported or exported, so that they can be appropriately
2185 -- marked in Sprint output.
2187 -- Is_Interrupt_Handler (Flag89)
2188 -- Present in procedures. Set if a pragma Interrupt_Handler applies
2189 -- to the procedure. The procedure must be parameterless, and on all
2190 -- targets except AAMP it must be a protected procedure.
2192 -- Is_Intrinsic_Subprogram (Flag64)
2193 -- Present in functions and procedures. It is set if a valid pragma
2194 -- Interface or Import is present for this subprogram specifying pragma
2195 -- Intrinsic. Valid means that the name and profile of the subprogram
2196 -- match the requirements of one of the recognized intrinsic subprograms
2197 -- (see package Sem_Intr for details). Note: the value of Convention for
2198 -- such an entity will be set to Convention_Intrinsic, but it is the
2199 -- setting of Is_Intrinsic_Subprogram, NOT simply having convention set
2200 -- to intrinsic, which causes intrinsic code to be generated.
2202 -- Is_Itype (Flag91)
2203 -- Present in all entities. Set to indicate that a type is an Itype,
2204 -- which means that the declaration for the type does not appear
2205 -- explicitly in the tree. Instead gigi will elaborate the type when it
2206 -- is first used. Has_Delayed_Freeze can be set for Itypes, and the
2207 -- meaning is that the first use (the one which causes the type to be
2208 -- defined) will be the freeze node. Note that an important restriction
2209 -- on Itypes is that the first use of such a type (the one that causes it
2210 -- to be defined) must be in the same scope as the type.
2212 -- Is_Known_Non_Null (Flag37)
2213 -- Present in all entities. Relevant (and can be set True) only for
2214 -- objects of an access type. It is set if the object is currently
2215 -- known to have a non-null value (meaning that no access checks
2216 -- are needed). The indication can for example come from assignment
2217 -- of an access parameter or an allocator whose value is known non-null.
2219 -- Note: this flag is set according to the sequential flow of the
2220 -- program, watching the current value of the variable. However,
2221 -- this processing can miss cases of changing the value of an aliased
2222 -- or constant object, so even if this flag is set, it should not
2223 -- be believed if the variable is aliased or volatile. It would
2224 -- be a little neater to avoid the flag being set in the first
2225 -- place in such cases, but that's trickier, and there is only
2226 -- one place that tests the value anyway.
2228 -- The flag is dynamically set and reset as semantic analysis and
2229 -- expansion proceeds. Its value is meaningless once the tree is
2230 -- fully constructed, since it simply indicates the last state.
2231 -- Thus this flag has no meaning to the back end.
2233 -- Is_Known_Null (Flag204)
2234 -- Present in all entities. Relevant (and can be set True) only for
2235 -- objects of an access type. It is set if the object is currently known
2236 -- to have a null value (meaning that a dereference will surely raise
2237 -- constraint error exception). The indication can come from an
2238 -- assignment or object declaration.
2240 -- The comments above about sequential flow and aliased and volatile for
2241 -- the Is_Known_Non_Null flag apply equally to the Is_Known_Null flag.
2243 -- Is_Known_Valid (Flag170)
2244 -- Present in all entities. Relevant for types (and subtype) and
2245 -- for objects (and enumeration literals) of a discrete type.
2247 -- The purpose of this flag is to implement the requirement stated
2248 -- in (RM 13.9.1(9-11)) which require that the use of possibly invalid
2249 -- values may not cause programs to become erroneous. See the function
2250 -- Exp_Util.Expr_Known_Valid for further details. Note that the setting
2251 -- is conservative, in the sense that if the flag is set, it must be
2252 -- right. If the flag is not set, nothing is known about the validity.
2254 -- For enumeration literals, the flag is always set, since clearly
2255 -- an enumeration literal represents a valid value. Range checks
2256 -- where necessary will ensure that this valid value is appropriate.
2258 -- For objects, the flag indicates the state of knowledge about the
2259 -- current value of the object. This may be modified during expansion,
2260 -- and thus the final value is not relevant to gigi.
2262 -- For types and subtypes, the flag is set if all possible bit patterns
2263 -- of length Object_Size (i.e. Esize of the type) represent valid values
2264 -- of the type. In general for such tytpes, all values are valid, the
2265 -- only exception being the case where an object of the type has an
2266 -- explicit size that is greater than Object_Size.
2268 -- For non-discrete objects, the setting of the Is_Known_Valid flag is
2269 -- not defined, and is not relevant, since the considerations of the
2270 -- requirement in (RM 13.9.1(9-11)) do not apply.
2272 -- The flag is dynamically set and reset as semantic analysis and
2273 -- expansion proceeds. Its value is meaningless once the tree is
2274 -- fully constructed, since it simply indicates the last state.
2275 -- Thus this flag has no meaning to the back end.
2277 -- Is_Limited_Composite (Flag106)
2278 -- Present in all entities. Set for composite types that have a
2279 -- limited component. Used to enforce the rule that operations on
2280 -- the composite type that depend on the full view of the component
2281 -- do not become visible until the immediate scope of the composite
2282 -- type itself (RM 7.3.1 (5)).
2284 -- Is_Limited_Interface (Flag197)
2285 -- Present in record types and subtypes. True for interface types, if
2286 -- interface is declared limited, task, protected, or synchronized, or
2287 -- is derived from a limited interface.
2289 -- Is_Limited_Record (Flag25)
2290 -- Present in all entities. Set to true for record (sub)types if the
2291 -- record is declared to be limited. Note that this flag is not set
2292 -- simply because some components of the record are limited.
2294 -- Is_Limited_Type (synthesized)
2295 -- Applies to all entities. True if entity is a limited type (limited
2296 -- private type, limited interface type, task type, protected type,
2297 -- composite containing a limited component, or a subtype of any of
2298 -- these types).
2300 -- Is_Machine_Code_Subprogram (Flag137)
2301 -- Present in subprogram entities. Set to indicate that the subprogram
2302 -- is a machine code subprogram (i.e. its body includes at least one
2303 -- code statement). Also indicates that all necessary semantic checks
2304 -- as required by RM 13.8(3) have been performed.
2306 -- Is_Modular_Integer_Type (synthesized)
2307 -- Applies to all entities. True if entity is a modular integer type
2309 -- Is_Non_Static_Subtype (Flag109)
2310 -- Present in all type and subtype entities. It is set in some (but not
2311 -- all) cases in which a subtype is known to be non-static. Before this
2312 -- flag was added, the computation of whether a subtype was static was
2313 -- entirely synthesized, by looking at the bounds, and the immediate
2314 -- subtype parent. However, this method does not work for some Itypes
2315 -- that have no parent set (and the only way to find the immediate
2316 -- subtype parent is to go through the tree). For now, this flay is set
2317 -- conservatively, i.e. if it is set then for sure the subtype is non-
2318 -- static, but if it is not set, then the type may or may not be static.
2319 -- Thus the test for a static subtype is that this flag is clear AND that
2320 -- the bounds are static AND that the parent subtype (if available to be
2321 -- tested) is static. Eventually we should make sure this flag is always
2322 -- set right, at which point, these comments can be removed, and the
2323 -- tests for static subtypes greatly simplified.
2325 -- Is_Null_Init_Proc (Flag178)
2326 -- Present in procedure entities. Set for generated init proc procedures
2327 -- (used to initialize composite types), if the code for the procedure
2328 -- is null (i.e. is a return and nothing else). Such null initialization
2329 -- procedures are generated in case some client is compiled using the
2330 -- Initialize_Scalars pragma, generating a call to this null procedure,
2331 -- but there is no need to call such procedures within a compilation
2332 -- unit, and this flag is used to suppress such calls.
2334 -- Is_Numeric_Type (synthesized)
2335 -- Applies to all entities, true for all numeric types and subtypes
2336 -- (integer, fixed, float).
2338 -- Is_Object (synthesized)
2339 -- Applies to all entities, true for entities representing objects,
2340 -- including generic formal parameters.
2342 -- Is_Obsolescent (Flag153)
2343 -- Present in all entities. Set for any entity for which a valid pragma
2344 -- Obsolescent applies.
2346 -- Is_Optional_Parameter (Flag134)
2347 -- Present in parameter entities. Set if the parameter is specified as
2348 -- optional by use of a First_Optional_Parameter argument to one of the
2349 -- extended Import pragmas. Can only be set for OpenVMS versions of GNAT.
2351 -- Is_Ordinary_Fixed_Point_Type (synthesized)
2352 -- Applies to all entities, true for ordinary fixed point types
2353 -- and subtypes
2355 -- Is_Overriding_Operation (Flag39)
2356 -- Present in subprograms. Set if the subprogram is a primitive
2357 -- operation of a derived type, that overrides an inherited operation.
2359 -- Is_Package_Or_Generic_Package (synthesized)
2360 -- Applies to all entities. True for packages and generic packages.
2361 -- False for all other entities.
2363 -- Is_Package_Body_Entity (Flag160)
2364 -- Present in all entities. Set for entities defined at the top level
2365 -- of a package body. Used to control externally generated names.
2367 -- Is_Packed (Flag51) [implementation base type only]
2368 -- Present in all type entities. This flag is set only for record and
2369 -- array types which have a packed representation. There are three
2370 -- cases which cause packing:
2372 -- 1. Explicit use of pragma Pack for an array of package components
2373 -- 2. Explicit use of pragma Pack to pack a record
2374 -- 4. Setting Component_Size of an array to a bit-packable value
2375 -- 3. Indexing an array with a non-standard enumeration type.
2377 -- For records, Is_Packed is always set if Has_Pack_Pragma is set,
2378 -- and can also be set on its own in a derived type which inherited
2379 -- its packed status.
2381 -- For arrays, Is_Packed is set if an array is bit packed (i.e. the
2382 -- component size is known at compile time and is 1-7, 9-15 or 17-31),
2383 -- or if the array has one or more index types that are enumeration
2384 -- types with non-standard representations (in GNAT, we store such
2385 -- arrays compactly, using the Pos of the enumeration type value).
2387 -- As for the case of records, Is_Packed can be set on its own for a
2388 -- derived type, with the same dual before/after freeze meaning.
2389 -- Is_Packed can also be set as the result of an explicit component
2390 -- size clause that specifies an appropriate component size.
2392 -- In the bit packed array case, Is_Bit_Packed_Array will be set in
2393 -- the bit packed case once the array type is frozen.
2395 -- Before an array type is frozen, Is_Packed will always be set if
2396 -- Has_Pack_Pragma is set. Before the freeze point, it is not possible
2397 -- to know the component size, since the component type is not frozen
2398 -- until the array type is frozen. Thus Is_Packed for an array type
2399 -- before it is frozen means that packed is required. Then if it turns
2400 -- out that the component size is not suitable for bit packing, the
2401 -- Is_Packed flag gets turned off.
2403 -- Is_Packed_Array_Type (Flag138)
2404 -- Present in all entities. This flag is set on the entity for the type
2405 -- used to implement a packed array (either a modular type, or a subtype
2406 -- of Packed_Bytes{1,2,4} as appropriate). The flag is set if and only
2407 -- if the type appears in the Packed_Array_Type field of some other type
2408 -- entity. It is used by Gigi to activate the special processing for such
2409 -- types (unchecked conversions that would not otherwise be allowed are
2410 -- allowed for such types). If the Is_Packed_Array_Type flag is set in
2411 -- an entity, then the Original_Array_Type field of this entity points
2412 -- to the original array type for which this is the packed array type.
2414 -- Is_Potentially_Use_Visible (Flag9)
2415 -- Present in all entities. Set if entity is potentially use visible,
2416 -- i.e. it is defined in a package that appears in a currently active
2417 -- use clause (RM 8.4(8)). Note that potentially use visible entities
2418 -- are not necessarily use visible (RM 8.4(9-11)).
2420 -- Is_Preelaborated (Flag59)
2421 -- Present in all entities, set in E_Package and E_Generic_Package
2422 -- entities to which a pragma Preelaborate is applied, and also in
2423 -- all entities within such packages. Note that the fact that this
2424 -- flag is set does not necesarily mean that no elaboration code is
2425 -- generated for the package.
2427 -- Is_Primitive (Flag218)
2428 -- Present in overloadable entities and in generic subprograms. Set to
2429 -- indicate that this is a primitive operation of some type, which may be
2430 -- a tagged type or a non-tagged type. Used to verify overriding
2431 -- indicators in bodies.
2433 -- Is_Primitive_Wrapper (Flag195)
2434 -- Present in all entities. Set for procedure entries that are used as
2435 -- primitive wrappers. which are generated by the expander to wrap
2436 -- entries of protected or task types implementing a limited interface.
2438 -- Is_Private_Composite (Flag107)
2439 -- Present in composite types that have a private component. Used to
2440 -- enforce the rule that operations on the composite type that depend
2441 -- on the full view of the component, do not become visible until the
2442 -- immediate scope of the composite type itself (7.3.1 (5)). Both this
2443 -- flag and Is_Limited_Composite are needed.
2445 -- Is_Private_Descendant (Flag53)
2446 -- Present in entities that can represent library units (packages,
2447 -- functions, procedures). Set if the library unit is itself a private
2448 -- child unit, or if it is the descendent of a private child unit.
2450 -- Is_Private_Type (synthesized)
2451 -- Applies to all entities, true for private types and subtypes,
2452 -- as well as for record with private types as subtypes
2454 -- Is_Protected_Interface (Flag198)
2455 -- Present in types that are interfaces. True if interface is declared
2456 -- protected, or is derived from protected interfaces.
2458 -- Is_Protected_Type (synthesized)
2459 -- Applies to all entities, true for protected types and subtypes
2461 -- Is_Public (Flag10)
2462 -- Present in all entities. Set to indicate that an entity defined in
2463 -- one compilation unit can be referenced from other compilation units.
2464 -- If this reference causes a reference in the generated variable, for
2465 -- example in the case of a variable name, then Gigi will generate an
2466 -- appropriate external name for use by the linker.
2468 -- Is_Protected_Private (synthesized)
2469 -- Applies to a record component. Returns true if this component
2470 -- is used to represent a private declaration of a protected type.
2472 -- Is_Protected_Record_Type (synthesized)
2473 -- Applies to all entities, true if Is_Concurrent_Record_Type
2474 -- Corresponding_Concurrent_Type is a protected type.
2476 -- Is_Pure (Flag44)
2477 -- Present in all entities. Set in all entities of a unit to which a
2478 -- pragma Pure is applied, and also set for the entity of the unit
2479 -- itself. In addition, this flag may be set for any other functions
2480 -- or procedures that are known to be side effect free, so in the case
2481 -- of subprograms, the Is_Pure flag may be used by the optimizer to
2482 -- imply that it can assume freedom from side effects (other than those
2483 -- resulting from assignment to out parameters, or to objects designated
2484 -- by access parameters).
2486 -- Is_Pure_Unit_Access_Type (Flag189)
2487 -- Present in access type and subtype entities. Set if the type or
2488 -- subtype appears in a pure unit. Used to give an error message at
2489 -- freeze time if the access type has a storage pool.
2491 -- Is_Raised (Flag224)
2492 -- Present in entities which denote exceptions. Set if the exception is
2493 -- thrown by a raise statement.
2495 -- Is_Real_Type (synthesized)
2496 -- Applies to all entities, true for real types and subtypes
2498 -- Is_Record_Type (synthesized)
2499 -- Applies to all entities, true for record types and subtypes,
2500 -- includes class-wide types and subtypes (which are also records)
2502 -- Is_Remote_Call_Interface (Flag62)
2503 -- Present in all entities. Set in E_Package and E_Generic_Package
2504 -- entities to which a pragma Remote_Call_Interace is applied, and
2505 -- also in all entities within such packages.
2507 -- Is_Remote_Types (Flag61)
2508 -- Present in all entities. Set in E_Package and E_Generic_Package
2509 -- entities to which a pragma Remote_Types is applied, and also in
2510 -- all entities within such packages.
2512 -- Is_Renaming_Of_Object (Flag112)
2513 -- Present in all entities, set only for a variable or constant for
2514 -- which the Renamed_Object field is non-empty and for which the
2515 -- renaming is handled by the front end, by macro substitution of
2516 -- a copy of the (evaluated) name tree whereever the variable is used.
2518 -- Is_Inherently_Limited_Type (synthesized)
2519 -- Applies to all type entities. True if the type is "inherently"
2520 -- limited (i.e. cannot become nonlimited). From the Ada 2005
2521 -- RM-7.5(8.1/2), "a type with a part that is of a task, protected, or
2522 -- explicitly limited record type". These are the types that are defined
2523 -- as return-by-reference types in Ada 95 (see RM95-6.5(11-16)). In Ada
2524 -- 2005, these are the types that require build-in-place for function
2525 -- calls. Note that build-in-place is allowed for other types, too.
2527 -- Is_Return_Object (Flag209)
2528 -- Present in all object entities. True if the object is the return
2529 -- object of an extended_return_statement; False otherwise.
2531 -- Is_Scalar_Type (synthesized)
2532 -- Applies to all entities, true for scalar types and subtypes
2534 -- Is_Shared_Passive (Flag60)
2535 -- Present in all entities. Set in E_Package and E_Generic_Package
2536 -- entities to which a pragma Shared_Passive is applied, and also in
2537 -- all entities within such packages.
2539 -- Is_Statically_Allocated (Flag28)
2540 -- Present in all entities. This can only be set True for exception,
2541 -- variable, constant, and type/subtype entities. If the flag is set,
2542 -- then the variable or constant must be allocated statically rather
2543 -- than on the local stack frame. For exceptions, the meaning is that
2544 -- the exception data should be allocated statically (and indeed this
2545 -- flag is always set for exceptions, since exceptions do not have
2546 -- local scope). For a type, the meaning is that the type must be
2547 -- elaborated at the global level rather than locally. No type marked
2548 -- with this flag may depend on a local variable, or on any other type
2549 -- which does not also have this flag set to True. For a variable or
2550 -- or constant, if the flag is set, then the type of the object must
2551 -- either be declared at the library level, or it must also have the
2552 -- flag set (since to allocate the oject statically, its type must
2553 -- also be elaborated globally).
2555 -- Is_Subprogram (synthesized)
2556 -- Applies to all entities, true for bodies of functions, procedures
2557 -- and operators.
2559 -- Is_String_Type (synthesized)
2560 -- Applies to all type entities. Determines if the given type is a
2561 -- string type, i.e. it is directly a string type or string subtype,
2562 -- or a string slice type, or an array type with one dimension and a
2563 -- component type that is a character type.
2565 -- Is_Synchronized_Interface (Flag199)
2566 -- Present in types that are interfaces. True if interface is declared
2567 -- synchronized, task, or protected, or is derived from a synchronized
2568 -- interface.
2570 -- Is_Tag (Flag78)
2571 -- Present in E_Component entities. For regular tagged type this flag is
2572 -- set on the tag component (whose name is Name_uTag) and for CPP_Class
2573 -- tagged types, this flag marks the pointer to the main vtable (i.e. the
2574 -- one to be extended by derivation)
2576 -- Is_Tagged_Type (Flag55)
2577 -- Present in all entities. Set for an entity for a tagged type.
2579 -- Is_Task_Interface (Flag200)
2580 -- Present in types that are interfaces. True is interface is declared
2581 -- as such, or if it is derived from task interfaces.
2583 -- Is_Task_Record_Type (synthesized)
2584 -- Applies to all entities. True if Is_Concurrent_Record_Type
2585 -- Corresponding_Concurrent_Type is a task type.
2587 -- Is_Task_Type (synthesized)
2588 -- Applies to all entities. True for task types and subtypes
2590 -- Is_Thunk (Flag225)
2591 -- True for subprograms that are thunks. Thunks are small subprograms
2592 -- built by the expander for tagged types that cover interface types;
2593 -- at run-time thunks displace the pointer to the object (pointer named
2594 -- "this" in the C++ terminology) from a secondary dispatch table to the
2595 -- primary dispatch table associated with a given tagged type. Set by
2596 -- Expand_Interface_Thunk and used by Expand_Call to handle extra
2597 -- actuals associated with accessibility level.
2599 -- Is_True_Constant (Flag163)
2600 -- This flag applies to all entities for constants and variables. Set
2601 -- in constants and variables which have an initial value specified but
2602 -- which are never assigned, partially or in the whole. For variables, it
2603 -- means that the variable was initialized but never modified, and hence
2604 -- can be treated as a constant by the code generator. For a constant, it
2605 -- means that the constant was not modified by generated code (e.g. to
2606 -- set a discriminant in an init proc). Assignments by user or generated
2607 -- code will reset this flag.
2609 -- Note: there is one situation in which the back end does not permit
2610 -- this flag to be set, even if no assignments are generated. This is
2611 -- the case of an object of a record or array type which is initialized
2612 -- with an aggregate, and is itself used as the expression initializing
2613 -- an atomic object, or the right hand side of an assignment to an atomic
2614 -- object. In this case the object must not have Is_True_Constant set,
2615 -- even though no assignments are generated (the reason for this is that
2616 -- the back end must not optimize the object away, because that would
2617 -- violate the restriction on aggregates in these positions).
2619 -- Is_Type (synthesized)
2620 -- Applies to all entities, true for a type entity
2622 -- Is_Unchecked_Union (Flag117) [implementation base type only]
2623 -- Present in all entities. Set only in record types to which the
2624 -- pragma Unchecked_Union has been validly applied.
2626 -- Is_Unsigned_Type (Flag144)
2627 -- Present in all types, but can be set only for discrete and fixed-point
2628 -- type and subtype entities. This flag is only valid if the entity is
2629 -- frozen. If set it indicates that the representation is known to be
2630 -- unsigned (i.e. that no negative values appear in the range). This is
2631 -- normally just a reflection of the lower bound of the subtype or base
2632 -- type, but there is one case in which the setting is non-obvious,
2633 -- namely the case of an unsigned subtype of a signed type from which
2634 -- a further subtype is obtained using variable bounds. This further
2635 -- subtype is still unsigned, but this cannot be determined by looking
2636 -- at its bounds or the bounds of the corresponding base type.
2638 -- Is_Valued_Procedure (Flag127)
2639 -- Present in procedure entities. Set if an Import_Valued_Procedure
2640 -- or Export_Valued_Procedure pragma applies to the procedure entity.
2642 -- Is_Visible_Child_Unit (Flag116)
2643 -- Present in compilation units that are child units. Once compiled,
2644 -- child units remain chained to the entities in the parent unit, and
2645 -- a separate flag must be used to indicate whether the names are
2646 -- visible by selected notation, or not.
2648 -- Is_Visible_Formal (Flag206)
2649 -- Present in all entities. Set for instances of the formals of a formal
2650 -- package. Indicates that the entity must be made visible in the body
2651 -- of the instance, to reproduce the visibility of the generic. This
2652 -- simplifies visibility settings in instance bodies.
2653 -- ??? confusion in abovecomments between being present and being set
2655 -- Is_VMS_Exception (Flag133)
2656 -- Present in all entities. Set only for exception entities where the
2657 -- exception was specified in an Import_Exception or Export_Exception
2658 -- pragma with the VMS option for Form. See description of these pragmas
2659 -- for details. This flag can only be set in OpenVMS versions of GNAT.
2661 -- Is_Volatile (Flag16)
2662 -- Present in all type entities, and also in constants, components and
2663 -- variables. Set if a pragma Volatile applies to the entity. Also set
2664 -- if pragma Shared or pragma Atomic applies to entity. In the case of
2665 -- private or incomplete types, this flag is set in both the private
2666 -- and full view. The flag is not set reliably on private subtypes,
2667 -- and is always retrieved from the base type (but this is not a base-
2668 -- type-only attribute because it applies to other entities). Note that
2669 -- the back end should use Treat_As_Volatile, rather than Is_Volatile
2670 -- to indicate code generation requirements for volatile variables.
2671 -- Similarly, any front end test which is concerned with suppressing
2672 -- optimizations on volatile objects should test Treat_As_Volatile
2673 -- rather than testing this flag.
2675 -- Is_Wrapper_Package (synthesized)
2676 -- Present in package entities. Indicates that the package has been
2677 -- created as a wrapper for a subprogram instantiation.
2679 -- Itype_Printed (Flag202)
2680 -- Present in all type and subtype entities. Set in Itypes if the Itype
2681 -- has been printed by Sprint. This is used to avoid printing an Itype
2682 -- more than once.
2684 -- Kill_Elaboration_Checks (Flag32)
2685 -- Present in all entities. Set by the expander to kill elaboration
2686 -- checks which are known not to be needed. Equivalent in effect to
2687 -- the use of pragma Supress (Elaboration_Checks) for that entity
2688 -- except that the effect is permanent and cannot be undone by a
2689 -- subsequent pragma Unsuppress.
2691 -- Kill_Range_Checks (Flag33)
2692 -- Present in all entities. Equivalent in effect to the use of pragma
2693 -- Supress (Range_Checks) for that entity except that the result is
2694 -- permanent and cannot be undone by a subsequent pragma Unsuppress.
2695 -- This is currently only used in one odd situation in Sem_Ch3 for
2696 -- record types, and it would be good to get rid of it???
2698 -- Kill_Tag_Checks (Flag34)
2699 -- Present in all entities. Set by the expander to kill elaboration
2700 -- checks which are known not to be needed. Equivalent in effect to
2701 -- the use of pragma Supress (Tag_Checks) for that entity except
2702 -- that the result is permanent and cannot be undone by a subsequent
2703 -- pragma Unsuppress.
2705 -- Known_To_Have_Preelab_Init (Flag207)
2706 -- Present in all type and subtype entities. If set, then the type is
2707 -- known to have preelaborable initialization. In the case of a partial
2708 -- view of a private type, it is only possible for this to be set if a
2709 -- pragma Preelaborable_Initialization is given for the type. For other
2710 -- types, it is never set if the type does not have preelaborable
2711 -- initialization, it may or may not be set if the type does have
2712 -- preelaborable initialization.
2714 -- Last_Assignment (Node26)
2715 -- Present in entities for variables, and OUT or IN OUT formals. Set for
2716 -- a local variable or formal to point to the left side of an assignment
2717 -- statement assigning a value to the variable. Cleared if the value of
2718 -- the entity is referenced. Used to warn about dubious assignment
2719 -- statements whose value is not used.
2721 -- Last_Entity (Node20)
2722 -- Present in all entities which act as scopes to which a list of
2723 -- associated entities is attached (blocks, class subtypes and types,
2724 -- entries, functions, loops, packages, procedures, protected objects,
2725 -- record types and subtypes, private types, task types and subtypes).
2726 -- Points to a the last entry in the list of associated entities chained
2727 -- through the Next_Entity field. Empty if no entities are chained.
2729 -- Limited_View (Node23)
2730 -- Present in non-generic package entities that are not instances. Bona
2731 -- fide package with the limited-view list through the first_entity and
2732 -- first_private attributes. The elements of this list are the shadow
2733 -- entities created for the types and local packages that are declared
2734 -- in a package appearing in a limited_with clause (Ada 2005: AI-50217)
2736 -- Lit_Indexes (Node15)
2737 -- Present in enumeration types and subtypes. Non-empty only for the
2738 -- case of an enumeration root type, where it contains the entity for
2739 -- the generated indexes entity. See unit Exp_Imgv for full details of
2740 -- the nature and use of this entity for implkementing the Image and
2741 -- Value attributes for the enumeration type in question.
2743 -- Lit_Strings (Node16)
2744 -- Present in enumeration types and subtypes. Non-empty only for the
2745 -- case of an enumeration root type, where it contains the entity for
2746 -- the literals string entity. See unit Exp_Imgv for full details of
2747 -- the nature and use of this entity for implementing the Image and
2748 -- Value attributes for the enumeration type in question.
2750 -- Low_Bound_Known (Flag205)
2751 -- Present in all entities. Currently this can only be set True for
2752 -- formal parameter entries of a standard unconstrained one-dimensional
2753 -- array or string type, where the lower bound of the index type is zero
2754 -- or one. Indicates that the low bound is known to be equal to the lower
2755 -- bound of the index type (e.g. 1 for String, since the index type is
2756 -- Positive). This flag can only be set by a pragma Assert which
2757 -- specifies this. If this flag is set, warnings about assuming the index
2758 -- low bound to be zero or one are suppressed.
2760 -- Machine_Radix_10 (Flag84)
2761 -- Present in decimal types and subtypes, set if the Machine_Radix
2762 -- is 10, as the result of the specification of a machine radix
2763 -- representation clause. Note that it is possible for this flag
2764 -- to be set without having Has_Machine_Radix_Clause True. This
2765 -- happens when a type is derived from a type with a clause present.
2767 -- Master_Id (Node17)
2768 -- Present in access types and subtypes. Empty unless Has_Task is
2769 -- set for the designated type, in which case it points to the entity
2770 -- for the Master_Id for the access type master. Also set for access-to-
2771 -- limited-class-wide types whose root may be extended with task
2772 -- components, and for access-to-limited-interfaces because they can be
2773 -- used to reference tasks implementing such interface.
2775 -- Materialize_Entity (Flag168)
2776 -- Present in all entities. Set only for constant or renamed entities
2777 -- which should be materialized for debugging purposes. In the case of
2778 -- a constant, a memory location should be allocated containing the
2779 -- value. In the case of a renaming, a memory location containing the
2780 -- renamed address should be allocated.
2782 -- Mechanism (Uint8) (returned as Mechanism_Type)
2783 -- Present in functions and non-generic formal parameters. Indicates
2784 -- the mechanism to be used for the function return or for the formal
2785 -- parameter. See separate section on passing mechanisms. This field
2786 -- is also set (to the default value of zero) in a subprogram body
2787 -- entity but not used in this context.
2789 -- Modulus (Uint17) [base type only]
2790 -- Present in modular types. Contains the modulus. For the binary
2791 -- case, this will be a power of 2, but if Non_Binary_Modulus is
2792 -- set, then it will not be a power of 2.
2794 -- Must_Be_On_Byte_Boundary (Flag183)
2795 -- Present in entities for types and subtypes. Set if objects of
2796 -- the type must always be allocated on a byte boundary (more
2797 -- accurately a storage unit boundary). The front end checks that
2798 -- component clauses respect this rule, and the back end ensures
2799 -- that record packing does not violate this rule. Currently the
2800 -- flag is set only for packed arrays longer than 64 bits where
2801 -- the component size is not a power of 2.
2803 -- Must_Have_Preelab_Init (Flag208)
2804 -- Present in entities for types and subtypes. Set in the full type of a
2805 -- private type or subtype if a pragma Has_Preelaborable_Initialization
2806 -- is present for the private type. Used to check that the full type has
2807 -- preelaborable initialization at freeze time (this has to be deferred
2808 -- to the freeze point because of the rule about overriding Initialize).
2810 -- Needs_Debug_Info (Flag147)
2811 -- Present in all entities. Set if the entity requires debugging
2812 -- information to be generated. This is true of all entities that
2813 -- have Comes_From_Source set, and also transitively for entities
2814 -- associated with such components (e.g. their types). It is true
2815 -- for all entities in Debug_Generated_Code mode (-gnatD switch).
2816 -- This is the flag that the back end should check to determine
2817 -- whether or not to generate debugging information for an entity.
2819 -- Needs_No_Actuals (Flag22)
2820 -- Present in callable entities (subprograms, entries, access to
2821 -- subprograms) which can be called without actuals because all of
2822 -- their formals (if any) have default values. This flag simplifies the
2823 -- resolution of the syntactic ambiguity involving a call to these
2824 -- entities when the return type is an array type, and a call can be
2825 -- interpreted as an indexing of the result of the call. It is also
2826 -- used to resolve various cases of entry calls.
2828 -- Never_Set_In_Source (Flag115)
2829 -- Present in all entities, but can be set only for variables and
2830 -- parameters. This flag is set if the object is never assigned a value
2831 -- in user source code, either by assignment or by being used as an out
2832 -- or in out parameter. Note that this flag is not reset from using an
2833 -- initial value, so if you want to test for this case as well, test the
2834 -- Has_Initial_Value flag also.
2836 -- This flag is only for the purposes of issuing warnings, it must not
2837 -- be used by the code generator to indicate that the variable is in
2838 -- fact a constant, since some assignments in generated code do not
2839 -- count (for example, the call to an init proc to assign some but
2840 -- not all of the fields in a partially initialized record). The code
2841 -- generator should instead use the flag Is_True_Constant.
2843 -- For the purposes of this warning, the default assignment of
2844 -- access variables to null is not considered the assignment of
2845 -- of a value (so the warning can be given for code that relies
2846 -- on this initial null value, when no other value is ever set).
2848 -- In variables and out parameters, if this flag is set after full
2849 -- processing of the corresponding declarative unit, it indicates that
2850 -- the variable or parameter was never set, and a warning message can
2851 -- be issued.
2853 -- Note: this flag is initially set, and then cleared on encountering
2854 -- any construct that might conceivably legitimately set the value.
2855 -- Thus during the analysis of a declarative region and its associated
2856 -- statement sequence, the meaning of the flag is "not set yet", and
2857 -- once this analysis is complete the flag means "never assigned".
2859 -- Note: for variables appearing in package declarations, this flag
2860 -- is never set. That is because there is no way to tell if some
2861 -- client modifies the variable (or in the case of variables in the
2862 -- private part, if some child unit modifies the variables).
2864 -- Note: in the case of renamed objects, the flag must be set in the
2865 -- ultimate renamed object. Clients noting a possible modification
2866 -- should use the Note_Possible_Modification procedure in Sem_Util
2867 -- rather than Set_Never_Set_In_Source precisely to deal properly with
2868 -- the renaming possibility.
2870 -- Next_Component (synthesized)
2871 -- Applies to record components. Returns the next component by following
2872 -- the chain of declared entities until one is found which corresponds to
2873 -- a component (Ekind is E_Component). Any internal types generated from
2874 -- the subtype indications of the record components are skipped. Returns
2875 -- Empty if no more components.
2877 -- Next_Component_Or_Discriminant (synthesized)
2878 -- Similar to Next_Component, but includes components and discriminants
2879 -- so the input can have either E_Component or E_Discriminant, and the
2880 -- same is true for the result. Returns Empty if no more components or
2881 -- discriminants in the record.
2883 -- Next_Discriminant (synthesized)
2884 -- Applies to discriminants returned by First/Next_Discriminant.
2885 -- Returns the next language-defined (ie: perhaps non-girder)
2886 -- discriminant by following the chain of declared entities as long as
2887 -- the kind of the entity corresponds to a discriminant. Note that the
2888 -- discriminants might be the only components of the record.
2889 -- Returns Empty if there are no more.
2891 -- Next_Entity (Node2)
2892 -- Present in all entities. The entities of a scope are chained, with
2893 -- the head of the list being in the First_Entity field of the scope
2894 -- entity. All entities use the Next_Entity field as a forward pointer
2895 -- for this list, with Empty indicating the end of the list. Since this
2896 -- field is in the base part of the entity, the access routines for this
2897 -- field are in Sinfo.
2899 -- Next_Formal (synthesized)
2900 -- Applies to the entity for a formal parameter. Returns the next
2901 -- formal parameter of the subprogram or subprogram type. Returns
2902 -- Empty if there are no more formals.
2904 -- Next_Formal_With_Extras (synthesized)
2905 -- Applies to the entity for a formal parameter. Returns the next
2906 -- formal parameter of the subprogram or subprogram type. Returns
2907 -- Empty if there are no more formals. The list returned includes
2908 -- all the extra formals (see description of Extra_Formal field)
2910 -- Next_Girder_Discriminant (synthesized)
2911 -- Applies to discriminants. Set only for a discriminant returned by
2912 -- a call to First/Next_Girder_Discriminant. Returns next girder
2913 -- discriminant, if there are more (see complete description in
2914 -- First_Girder_Discriminant), or Empty if there are no more.
2916 -- Next_Index (synthesized)
2917 -- Applies to array types and subtypes and to string types and
2918 -- subtypes. Yields the next index. The first index is obtained by
2919 -- using the First_Index attribute, and then subsequent indexes are
2920 -- obtained by applying Next_Index to the previous index. Empty is
2921 -- returned to indicate that there are no more indexes. Note that
2922 -- unlike most attributes in this package, Next_Index applies to
2923 -- nodes for the indexes, not to entities.
2925 -- Next_Inlined_Subprogram (Node12)
2926 -- Present in subprograms. Used to chain inlined subprograms used in
2927 -- the current compilation, in the order in which they must be compiled
2928 -- by Gigi to insure that all inlinings are performed.
2930 -- Next_Literal (synthesized)
2931 -- Applies to enumeration literals, returns the next literal, or
2932 -- Empty if applied to the last literal. This is actually a synonym
2933 -- for Next, but its use is preferred in this context.
2935 -- Next_Tag_Component (synthesized)
2936 -- Applies to components of tagged record types. Given a _Tag field
2937 -- of a record, returns the next _Tag field in this record.
2939 -- Non_Binary_Modulus (Flag58) [base type only]
2940 -- Present in modular integer types. Set if the modulus for the type
2941 -- is other than a power of 2.
2943 -- Non_Limited_View (Node17)
2944 -- Present in incomplete types that are the shadow entities created
2945 -- when analyzing a limited_with_clause (Ada 2005: AI-50217). Points to
2946 -- the defining entity in the original declaration.
2948 -- Nonzero_Is_True (Flag162) [base type only]
2949 -- Present in enumeration types. True if any non-zero value is to be
2950 -- interpreted as true. Currently this is set true for derived Boolean
2951 -- types which have a convention of C, C++ or Fortran.
2953 -- No_Pool_Assigned (Flag131) [root type only]
2954 -- Present in access types. Set if a storage size clause applies to
2955 -- the variable with a compile time known value of zero. This flag is
2956 -- used to generate warnings if any attempt is made to allocate or free
2957 -- an instance of such an access type. This is set only in the root
2958 -- type, since derived types must have the same pool.
2960 -- No_Return (Flag113)
2961 -- Present in all entities. Always false except in the case of procedures
2962 -- and generic procedures for which a pragma No_Return is given.
2964 -- Normalized_First_Bit (Uint8)
2965 -- Present in components and discriminants. Indicates the normalized
2966 -- value of First_Bit for the component, i.e. the offset within the
2967 -- lowest addressed storage unit containing part or all of the field.
2968 -- Set to No_Uint if no first bit position is assigned yet.
2970 -- Normalized_Position (Uint14)
2971 -- Present in components and discriminants. Indicates the normalized
2972 -- value of Position for the component, i.e. the offset in storage
2973 -- units from the start of the record to the lowest addressed storage
2974 -- unit containing part or all of the field.
2976 -- Normalized_Position_Max (Uint10)
2977 -- Present in components and discriminants. For almost all cases, this
2978 -- is the same as Normalized_Position. The one exception is for the case
2979 -- of a discriminated record containing one or more arrays whose length
2980 -- depends on discriminants. In this case, the Normalized_Position_Max
2981 -- field represents the maximum possible value of Normalized_Position
2982 -- assuming min/max values for discriminant subscripts in all fields.
2983 -- This is used by Layout in front end layout mode to properly computed
2984 -- the maximum size such records (needed for allocation purposes when
2985 -- there are default discriminants, and also for the 'Size value).
2987 -- No_Strict_Aliasing (Flag136) [base type only]
2988 -- Present in access types. Set to direct the back end to avoid any
2989 -- optimizations based on an assumption about the aliasing status of
2990 -- objects designated by the access type. For the case of the gcc
2991 -- back end, the effect is as though all references to objects of
2992 -- the type were compiled with -fno-strict-aliasing. This flag is
2993 -- set if an unchecked conversion with the access type as a target
2994 -- type occurs in the same source unit as the declaration of the
2995 -- access type, or if an explicit pragma No_Strict_Aliasing applies.
2997 -- Number_Dimensions (synthesized)
2998 -- Applies to array types and subtypes. Returns the number of dimensions
2999 -- of the array type or subtype as a value of type Pos.
3001 -- Number_Discriminants (synthesized)
3002 -- Applies to all types with discriminants. Yields the number of
3003 -- discriminants as a value of type Pos.
3005 -- Number_Entries (synthesized)
3006 -- Applies to concurrent types. Returns the number of entries that are
3007 -- declared within the task or protected definition for the type.
3009 -- Number_Formals (synthesized)
3010 -- Applies to subprograms and subprogram types. Yields the number of
3011 -- formals as a value of type Pos.
3013 -- Obsolescent_Warning (Node24)
3014 -- Present in all entities. Set non-empty only if a pragma Obsolescent
3015 -- applying to the entity had a string argument, in which case it records
3016 -- the contents of the corresponding string literal node. This field is
3017 -- only accessed if the flag Is_Obsolescent is set.
3019 -- Original_Array_Type (Node21)
3020 -- Present in modular types and array types and subtypes. Set only
3021 -- if the Is_Packed_Array_Type flag is set, indicating that the type
3022 -- is the implementation type for a packed array, and in this case it
3023 -- points to the original array type for which this is the packed
3024 -- array implementation type.
3026 -- Object_Ref (Node17)
3027 -- Present in protected bodies. This is an implicit prival for the
3028 -- Protection object associated with a protected object. See Prival
3029 -- for further details on the use of privals.
3031 -- Original_Record_Component (Node22)
3032 -- Present in components, including discriminants. The usage depends
3033 -- on whether the record is a base type and whether it is tagged.
3035 -- In base tagged types:
3036 -- When the component is inherited in a record extension, it points
3037 -- to the original component (the entity of the ancestor component
3038 -- which is not itself inherited) otherwise it points to itself.
3039 -- Gigi uses this attribute to implement the automatic dereference in
3040 -- the extension and to apply the transformation:
3042 -- Rec_Ext.Comp -> Rec_Ext.Parent. ... .Parent.Comp
3044 -- In base non-tagged types:
3045 -- Always points to itself except for non-girder discriminants, where
3046 -- it points to the girder discriminant it renames.
3048 -- In subtypes (tagged and untagged):
3049 -- Points to the component in the base type.
3051 -- Overridden_Operation (Node26)
3052 -- Present in subprograms. For overriding operations, points to the
3053 -- user-defined parent subprogram that is being overridden.
3055 -- Package_Instantiation (Node26)
3056 -- Present in packages and generic packages. When present, this field
3057 -- references an N_Package_Instantiation node associated with an
3058 -- instantiated package. In the case where the referenced node has
3059 -- been rewritten to an N_Package_Specification, the instantiation
3060 -- node is available from the Original_Node field of the package spec
3061 -- node. This is currently not guaranteed to be set in all cases, but
3062 -- when set, the field is used in Get_Package_Instantiation_Node as
3063 -- one of the means of obtaining the instantiation node. Eventually
3064 -- it should be set in all cases, including package entities associated
3065 -- with formal packages. ???
3067 -- Packed_Array_Type (Node23)
3068 -- Present in array types and subtypes, including the string literal
3069 -- subtype case, if the corresponding type is packed (either bit packed
3070 -- or packed to eliminate holes in non-contiguous enumeration type
3071 -- index types). References the type used to represent the packed array,
3072 -- which is either a modular type for short static arrays, or an
3073 -- array of System.Unsigned. Note that in some situations (internal
3074 -- types, and references to fields of variant records), it is not
3075 -- always possible to construct this type in advance of its use. If
3076 -- Packed_Array_Type is empty, then the necessary type is declared
3077 -- on the fly for each reference to the array.
3079 -- Parameter_Mode (synthesized)
3080 -- Applies to formal parameter entities. This is a synonym for Ekind,
3081 -- used when obtaining the formal kind of a formal parameter (the result
3082 -- is one of E_[In/Out/In_Out]_Paramter)
3084 -- Parent_Subtype (Node19)
3085 -- Present in E_Record_Type. Points to the subtype to use for a
3086 -- field that references the parent record.
3088 -- Primitive_Operations (Elist15)
3089 -- Present in tagged record types and subtypes and in tagged private
3090 -- types. Points to an element list of entities for primitive operations
3091 -- for the tagged type. Not present (and not set) in untagged types (it
3092 -- is an error to reference the primitive operations field of a type
3093 -- that is not tagged).
3095 -- Private_Dependents (Elist18)
3096 -- Present in private (sub)types. Records the subtypes of the
3097 -- private type, derivations from it, and records and arrays
3098 -- with components dependent on the type.
3100 -- The subtypes are traversed when installing and deinstalling
3101 -- (the full view of) a private type in order to ensure correct
3102 -- view of the subtypes.
3104 -- Used in similar fashion for incomplete types: holds list of subtypes
3105 -- of these incomplete types that have discriminant constraints. The
3106 -- full views of these subtypes are constructed when the full view of
3107 -- the incomplete type is processed.
3109 -- In addition, if the incomplete type is the designated type in an
3110 -- access definition for an access parameter, the operation may be
3111 -- a dispatching primitive operation, which is only known when the full
3112 -- declaration of the type is seen. Subprograms that have such an
3113 -- access parameter are also placed in the list of private_dependents.
3115 -- Prival (Node17)
3116 -- Present in components. Used for representing private declarations
3117 -- of protected objects (private formal: by analogy to Discriminal_Link).
3118 -- Empty unless the synthesized Is_Protected_Private attribute is
3119 -- true. The entity used as a formal parameter that corresponds to
3120 -- the to the private declaration in protected operations. See
3121 -- "Private data in protected objects" for details.
3123 -- Privals_Chain (Elist23)
3124 -- Present in protected operations (subprograms and entries). Links
3125 -- all occurrences of the Privals in the body of the operation, in
3126 -- order to patch their types at the end of their expansion. See
3127 -- "Private data in protected objects" for details.
3129 -- Private_View (Node22)
3130 -- For each private type, three entities are allocated, the private view,
3131 -- the full view, and the shadow entity. The shadow entity contains a
3132 -- copy of the private view and is used for restoring the proper private
3133 -- view after a region in which the full view is visible (and is copied
3134 -- into the entity normally used for the private view during this period
3135 -- of visibility). The Private_View field is self-referential when the
3136 -- private view lives in its normal entity, but in the copy that is made
3137 -- in the shadow entity, it points to the proper location in which to
3138 -- restore the private view saved in the shadow.
3140 -- Protected_Formal (Node22)
3141 -- Present in formal parameters (in, in out and out parameters). Used
3142 -- only for formals of protected operations. References corresponding
3143 -- formal parameter in the unprotected version of the operation that
3144 -- is created during expansion.
3146 -- Protected_Body_Subprogram (Node11)
3147 -- Present in protected operations. References the entity for the
3148 -- subprogram which implements the body of the operation.
3150 -- Protected_Operation (Node23)
3151 -- Present in components. Used for representing private declarations
3152 -- of protected objects. Empty unless the synthesized attribute
3153 -- Is_Protected_Private is True. This is the entity corresponding
3154 -- to the body of the protected operation currently being analyzed,
3155 -- and which will eventually use the current Prival associated with
3156 -- this component to refer to the renaming of a private object
3157 -- component. As soon as the expander generates this renaming, this
3158 -- attribute is changed to refer to the next protected subprogram.
3159 -- See "Private data in protected objects" for details.
3161 -- Reachable (Flag49)
3162 -- Present in labels. The flag is set over the range of statements in
3163 -- which a goto to that label is legal.
3165 -- Referenced (Flag156)
3166 -- Present in all entities. Set if the entity is referenced, except
3167 -- for the case of an appearence of a simple variable, that is not a
3168 -- renaming, as the left side of an assignment in which case the flag
3169 -- Referenced_As_LHS is set instead.
3171 -- Referenced_As_LHS (Flag36):
3172 -- Present in all entities. This flag is set instead of Referenced if a
3173 -- simple variable that is not a renaming appears as the left side of an
3174 -- assignment. The reason we distinguish this kind of reference is that
3175 -- we have a separate warning for variables that are only assigned and
3176 -- never read.
3178 -- Referenced_Object (Node10)
3179 -- Present in all type entities. Set non-Empty only for type entities
3180 -- constructed for unconstrained objects, or objects that depend on
3181 -- discriminants. Points to the expression from which the actual
3182 -- subtype of the object can be evaluated.
3184 -- Register_Exception_Call (Node20)
3185 -- Present in exception entities. When an exception is declared,
3186 -- a call is expanded to Register_Exception. This field points to
3187 -- the expanded N_Procedure_Call_Statement node for this call. It
3188 -- is used for Import/Export_Exception processing to modify the
3189 -- register call to make appropriate entries in the special tables
3190 -- used for handling these pragmas at runtime.
3192 -- Related_Array_Object (Node19)
3193 -- Present in array types and subtypes. Used only for the base type
3194 -- and subtype created for an anonymous array object. Set to point
3195 -- to the entity of the corresponding array object. Currently used
3196 -- only for type-related error messages.
3198 -- Related_Instance (Node15)
3199 -- Present in the wrapper packages created for subprogram instances.
3200 -- The internal subprogram that implements the instance is inside the
3201 -- wrapper package, but for debugging purposes its external symbol
3202 -- must correspond to the name and scope of the related instance.
3204 -- Related_Interface (Node26)
3205 -- Present in components and constants associated with dispatch tables.
3206 -- Set to point to the entity of the associated interface type.
3208 -- Renamed_Entity (Node18)
3209 -- Present in exceptions, packages, subprograms and generic units. Set
3210 -- for entities that are defined by a renaming declaration. Denotes the
3211 -- renamed entity, or transititively the ultimate renamed entity if
3212 -- there is a chain of renaming declarations. Empty if no renaming.
3214 -- Renamed_Object (Node18)
3215 -- Present in all objects (constants, variables, components, formal
3216 -- parameters, generic formal parameters, and loop parameters).
3217 -- ??? Present in discriminants?
3218 -- Set non-Empty if the object was declared by a renaming declaration,
3219 -- in which case it references the tree node for the name of the renamed
3220 -- object. This is only possible for the variable and constant cases.
3221 -- For formal parameters, this field is used in the course of inline
3222 -- expansion, to map the formals of a subprogram into the corresponding
3223 -- actuals. For formals of a task entry, it denotes the local renaming
3224 -- that replaces the actual within the accept statement. The field is
3225 -- Empty otherwise (it is always empty for loop parameters).
3227 -- Renaming_Map (Uint9)
3228 -- Present in generic subprograms, generic packages, and their
3229 -- instances. Also present in the instances of the corresponding
3230 -- bodies. Denotes the renaming map (generic entities => instance
3231 -- entities) used to construct the instance by givin an index into
3232 -- the tables used to represent these maps. See Sem_Ch12 for further
3233 -- details. The maps for package instances are also used when the
3234 -- instance is the actual corresponding to a formal package.
3236 -- Requires_Overriding (Flag213)
3237 -- Present in all subprograms and entries. Set for subprograms that
3238 -- require overriding as defined by RM-2005-3.9.3(6/2). Note that this
3239 -- is True only for implicitly declare subprograms; it is not set on the
3240 -- parent type's subprogram. See also Is_Abstract_Subprogram.
3242 -- Return_Present (Flag54)
3243 -- Present in function and generic function entities. Set if the
3244 -- function contains a return statement (used for error checking).
3245 -- This flag can also be set in procedure and generic procedure
3246 -- entities (for convenience in setting it), but is only tested
3247 -- for the function case.
3249 -- Return_Applies_To (Node8)
3250 -- Present in E_Return_Statement. Points to the entity representing
3251 -- the construct to which the return statement applies, as defined in
3252 -- RM-6.5(4/2). Note that a (simple) return statement within an
3253 -- extended_return_statement applies to the extended_return_statement,
3254 -- even though it causes the whole function to return.
3256 -- Returns_By_Ref (Flag90)
3257 -- Present in function entities, to indicate that the function
3258 -- returns the result by reference, either because its return type is a
3259 -- by-reference-type or because it uses explicitly the secondary stack.
3261 -- Reverse_Bit_Order (Flag164) [base type only]
3262 -- Present in all record type entities. Set if a valid pragma an
3263 -- attribute represention clause for Bit_Order has reversed the order of
3264 -- bits from the default value. When this flag is set, a component clause
3265 -- must specify a set of bits entirely contained in a single storage unit
3266 -- (Ada 95) or a single machine scalar (see Ada 2005 AI-133), or must
3267 -- occupy in integral number of storage units.
3269 -- RM_Size (Uint13)
3270 -- Present in all type and subtype entities. Contains the value of
3271 -- type'Size as defined in the RM. See also the Esize field and
3272 -- and the description on "Handling of Type'Size Values". A value
3273 -- of zero in this field for a non-discrete type means that
3274 -- the front end has not yet determined the size value. For the
3275 -- case of a discrete type, this field is always set by the front
3276 -- end and zero is a legitimate value for a type with one value.
3278 -- Root_Type (synthesized)
3279 -- Applies to all type entities. For class-wide types, return the root
3280 -- type of the class covered by the CW type, otherwise returns the
3281 -- ultimate derivation ancestor of the given type. This function
3282 -- preserves the view, i.e. the Root_Type of a partial view is the
3283 -- partial view of the ulimate ancestor, the Root_Type of a full view
3284 -- is the full view of the ultimate ancestor. Note that this function
3285 -- does not correspond exactly to the use of root type in the RM, since
3286 -- in the RM root type applies to a class of types, not to a type.
3288 -- Scalar_Range (Node20)
3289 -- Present in all scalar types (including modular types, where the
3290 -- bounds are 0 .. modulus - 1). References a node in the tree that
3291 -- contains the bounds for the range. Note that this information
3292 -- could be obtained by rummaging around the tree, but it is more
3293 -- convenient to have it immediately at hand in the entity. The
3294 -- contents of Scalar_Range can either be an N_Subtype_Indication
3295 -- node (with a constraint), or a Range node, but not a simple
3296 -- subtype reference (a subtype is converted into a range).
3298 -- Scale_Value (Uint15)
3299 -- Present in decimal fixed-point types and subtypes. Contains the scale
3300 -- for the type (i.e. the value of type'Scale = the number of decimal
3301 -- digits after the decimal point).
3303 -- Scope (Node3)
3304 -- Present in all entities. Points to the entity for the scope (block,
3305 -- loop, subprogram, package etc.) in which the entity is declared.
3306 -- Since this field is in the base part of the entity node, the access
3307 -- routines for this field are in Sinfo. Note that for a child package,
3308 -- the Scope will be the parent package, and for a non-child package,
3309 -- the Scope will be Standard.
3311 -- Scope_Depth (synth)
3312 -- Applies to program units, blocks, concurrent types and entries,
3313 -- and also to record types, i.e. to any entity that can appear on
3314 -- the scope stack. Yields the scope depth value, which for those
3315 -- entities other than records is simply the scope depth value,
3316 -- for record entities, it is the Scope_Depth of the record scope.
3318 -- Scope_Depth_Value (Uint22)
3319 -- Present in program units, blocks, concurrent types and entries.
3320 -- Indicates the number of scopes that statically enclose the
3321 -- declaration of the unit or type. Library units have a depth of zero.
3322 -- Note that record types can act as scopes but do NOT have this field
3323 -- set (see Scope_Depth above)
3325 -- Scope_Depth_Set (synthesized)
3326 -- Applies to a special predicate function that returns a Boolean value
3327 -- indicating whether or not the Scope_Depth field has been set. It
3328 -- is needed, since returns an invalid value in this case!
3330 -- Sec_Stack_Needed_For_Return (Flag167)
3331 -- Present in scope entities (blocks, functions, procedures, tasks,
3332 -- entries). Set to True when secondary stack is used to hold
3333 -- the returned value of a function and thus should not be
3334 -- released on scope exit.
3336 -- Shadow_Entities (List14)
3337 -- Present in package and generic package entities. Points to a list
3338 -- of entities that correspond to private types. For each private type
3339 -- a shadow entity is created that holds a copy of the private view.
3340 -- In regions of the program where the full views of these private
3341 -- entities are visible, the full view is copied into the entity that
3342 -- is normally used to hold the private view, but the shadow entity
3343 -- copy is unchanged. The shadow entities are then used to restore the
3344 -- original private views at the end of the region. This list is a
3345 -- standard format list (i.e. First (Shadow_Entities) is the first
3346 -- entry and subsequent entries are obtained using Next.
3348 -- Shared_Var_Assign_Proc (Node22)
3349 -- Present in variables. Set non-Empty only if Is_Shared_Passive is
3350 -- set, in which case this is the entity for the shared memory assign
3351 -- routine. See Exp_Smem for full details.
3353 -- Shared_Var_Read_Proc (Node15)
3354 -- Present in variables. Set non-Empty only if Is_Shared_Passive is
3355 -- set, in which case this is the entity for the shared memory read
3356 -- routine. See Exp_Smem for full details.
3358 -- Size_Check_Code (Node19)
3359 -- Present in constants and variables. Normally Empty. Set if code is
3360 -- generated to check the size of the object. This field is used to
3361 -- suppress this code if a subsequent address clause is encountered.
3363 -- Size_Clause (synthesized)
3364 -- Applies to all entities. If a size clause is present in the rep
3365 -- item chain for an entity then the attribute definition clause node
3366 -- for the size clause is returned. Otherwise Size_Clause returns Empty
3367 -- if no item is present. Usually this is only meaningful if the flag
3368 -- Has_Size_Clause is set. This is because when the representation item
3369 -- chain is copied for a derived type, it can inherit a size clause that
3370 -- is not applicable to the entity.
3372 -- Size_Depends_On_Discriminant (Flag177)
3373 -- Present in all entities for types and subtypes. Indicates that the
3374 -- size of the type depends on the value of one or more discriminants.
3375 -- Currently, this flag is only set in front end layout mode for arrays
3376 -- which have one or more bounds depending on a discriminant value.
3378 -- Size_Known_At_Compile_Time (Flag92)
3379 -- Present in all entities for types and subtypes. Indicates that the
3380 -- size of objects of the type is known at compile time. This flag is
3381 -- used to optimize some generated code sequences, and also to enable
3382 -- some error checks (e.g. disallowing component clauses on variable
3383 -- length objects. It is set conservatively (i.e. if it is True, the
3384 -- size is certainly known at compile time, if it is False, then the
3385 -- size may or may not be known at compile time, but the code will
3386 -- assume that it is not known).
3388 -- Small_Value (Ureal21)
3389 -- Present in fixed point types. Points to the universal real for the
3390 -- Small of the type, either as given in a representation clause, or
3391 -- as computed (as a power of two) by the compiler.
3393 -- Spec_Entity (Node19)
3394 -- Present in package body entities. Points to corresponding package
3395 -- spec entity. Also present in subprogram body parameters in the
3396 -- case where there is a separate spec, where this field references
3397 -- the corresponding parameter entities in the spec.
3399 -- Storage_Size_Variable (Node15) [implementation base type only]
3400 -- Present in access types and task type entities. This flag is set
3401 -- if a valid and effective pragma Storage_Size applies to the base
3402 -- type. Points to the entity for a variable that is created to
3403 -- hold the value given in a Storage_Size pragma for an access
3404 -- collection or a task type. Note that in the access type case,
3405 -- this field is present only in the root type (since derived types
3406 -- share the same storage pool).
3408 -- Static_Elaboration_Desired (Flag77)
3409 -- Present in library-level packages. Set by the pragma of the same
3410 -- name, to indicate that static initialization must be attempted for
3411 -- all types declared in the package, and that a warning must be emitted
3412 -- for those types to which static initialization is not available.
3414 -- Static_Initialization (Node26)
3415 -- Present in initialization procedures for types whose objects can be
3416 -- initialized statically. The value of this attribute is a positional
3417 -- aggregate whose components are compile-time static values. Used
3418 -- when available in object declarations to eliminate the call to the
3419 -- initialization procedure, and to minimize elaboration code.
3421 -- Stored_Constraint (Elist23)
3422 -- Present in entities that can have discriminants (concurrent types
3423 -- subtypes, record types and subtypes, private types and subtypes,
3424 -- limited private types and subtypes and incomplete types). Points
3425 -- to an element list containing the expressions for each of the
3426 -- stored discriminants for the record (sub)type.
3428 -- Strict_Alignment (Flag145) [implementation base type only]
3429 -- Present in all type entities. Indicates that some containing part
3430 -- is either aliased or tagged. This prohibits packing the object
3431 -- tighter than its natural size and alignment.
3433 -- String_Literal_Length (Uint16)
3434 -- Present in string literal subtypes (which are created to correspond
3435 -- to string literals in the program). Contains the length of the string
3436 -- literal.
3438 -- String_Literal_Low_Bound (Node15)
3439 -- Present in string literal subtypes (which are created to correspond
3440 -- to string literals in the program). Contains an expression whose
3441 -- value represents the low bound of the literal. This is a copy of
3442 -- the low bound of the applicable index constraint if there is one,
3443 -- or a copy of the low bound of the index base type if not.
3445 -- Suppress_Elaboration_Warnings (Flag148)
3446 -- Present in all entities, can be set only for subprogram entities and
3447 -- for variables. If this flag is set then Sem_Elab will not generate
3448 -- elaboration warnings for the subprogram or variable. Suppression of
3449 -- such warnings is automatic for subprograms for which elaboration
3450 -- checks are suppressed (without the need to set this flag), but the
3451 -- flag is also set for various internal entities (such as init procs)
3452 -- which are known not to generate any possible access before
3453 -- elaboration, and it is set on variables when a warning is given to
3454 -- avoid multiple elaboration warnings for the same variable.
3456 -- Suppress_Init_Proc (Flag105) [base type only]
3457 -- Present in all type entities. Set to suppress the generation of
3458 -- initialization procedures where they are known to be not needed.
3459 -- For example, the enumeration image table entity uses this flag.
3461 -- Suppress_Style_Checks (Flag165)
3462 -- Present in all entities. Suppresses any style checks specifically
3463 -- associated with the given entity if set.
3465 -- Suppress_Value_Tracking_On_Call (Flag217)
3466 -- Present in all entities. Set in a scope entity if value tracking is to
3467 -- be suppressed on any call within the scope. Used when an access to a
3468 -- local subprogram is computed, to deal with the possibility that this
3469 -- value may be passed around, and if used, may clobber a local variable.
3471 -- Task_Body_Procedure (Node25)
3472 -- Present in task types and subtypes. Points to the entity for
3473 -- the task body procedure (as further described in Exp_Ch9, task
3474 -- bodies are expanded into procedures). A convenient function to
3475 -- retrieve this field is Sem_Util.Get_Task_Body_Procedure.
3476 -- The last sentence is odd ??? Why not have Task_Body_Procedure
3477 -- go to the Underlying_Type of the Root_Type???
3479 -- Treat_As_Volatile (Flag41)
3480 -- Present in all type entities, and also in constants, components and
3481 -- variables. Set if this entity is to be treated as volatile for code
3482 -- generation purposes. Always set if Is_Volatile is set, but can also
3483 -- be set as a result of situations (such as address overlays) where
3484 -- the front end wishes to force volatile handling to inhibit aliasing
3485 -- optimization which might be legally ok, but is undesirable. Note
3486 -- that the back end always tests this flag rather than Is_Volatile.
3487 -- The front end tests Is_Volatile if it is concerned with legality
3488 -- checks associated with declared volatile variables, but if the test
3489 -- is for the purposes of suppressing optimizations, then the front
3490 -- end should test Treat_As_Volatile rather than Is_Volatile.
3492 -- Type_High_Bound (synthesized)
3493 -- Applies to scalar types. Returns the tree node (Node_Id) that contains
3494 -- the high bound of a scalar type. The returned value is literal for a
3495 -- base type, but may be an expression in the case of scalar type with
3496 -- dynamic bounds. Note that in the case of a fixed point type, the high
3497 -- bound is in units of small, and is an integer.
3499 -- Type_Low_Bound (synthesized)
3500 -- Applies to scalar types. Returns the tree node (Node_Id) that contains
3501 -- the low bound of a scalar type. The returned value is literal for a
3502 -- base type, but may be an expression in the case of scalar type with
3503 -- dynamic bounds. Note that in the case of a fixed point type, the low
3504 -- bound is in units of small, and is an integer.
3506 -- Underlying_Full_View (Node19)
3507 -- Present in private subtypes that are the completion of other private
3508 -- types, or in private types that are derived from private subtypes. If
3509 -- the full view of a private type T is derived from another private type
3510 -- with discriminants Td, the full view of T is also private, and there
3511 -- is no way to attach to it a further full view that would convey the
3512 -- structure of T to the back end. The Underlying_Full_ View is an
3513 -- attribute of the full view that is a subtype of Td with the same
3514 -- constraint as the declaration for T. The declaration for this subtype
3515 -- is built at the point of the declaration of T, either as completion,
3516 -- or as a subtype declaration where the base type is private and has a
3517 -- private completion. If Td is already constrained, then its full view
3518 -- can serve directly as the full view of T.
3520 -- Underlying_Type (synthesized)
3521 -- Applies to all entities. This is the identity function except in the
3522 -- case where it is applied to an incomplete or private type, in which
3523 -- case it is the underlying type of the type declared by the completion,
3524 -- or Empty if the completion has not yet been encountered and analyzed.
3526 -- Note: the reason this attribute applies to all entities, and not just
3527 -- types, is to legitimize code where Underlying_Type is applied to an
3528 -- entity which may or may not be a type, with the intent that if it is a
3529 -- type, its underlying type is taken.
3531 -- Universal_Aliasing (Flag216) [base type only]
3532 -- Present in all type entities. Set to direct the back-end to avoid
3533 -- any optimizations based on type-based alias analysis for this type.
3534 -- Indicates that objects of this type can alias objects of any other
3535 -- types, which guarantees that any objects can be referenced through
3536 -- access types designating this type safely, whatever the actual type
3537 -- of these objects. In other words, the effect is as though access
3538 -- types designating this type were subject to No_Strict_Aliasing.
3540 -- Unset_Reference (Node16)
3541 -- Present in variables and out parameters. This is normally Empty. It
3542 -- is set to point to an identifier that represents a reference to the
3543 -- entity before any value has been set. Only the first such reference
3544 -- is identified. This field is used to generate a warning message if
3545 -- necessary (see Sem_Warn.Check_Unset_Reference).
3547 -- Used_As_Generic_Actual (Flag222)
3548 -- Present in all entities, set if the entity is used as an argument to
3549 -- a generic instantiation. Used to tune certain warning messages.
3551 -- Uses_Sec_Stack (Flag95)
3552 -- Present in scope entities (blocks,functions, procedures, tasks,
3553 -- entries). Set to True when secondary stack is used in this scope and
3554 -- must be released on exit unless Sec_Stack_Needed_For_Return is set.
3556 -- Vax_Float (Flag151) [base type only]
3557 -- Present in all type and subtype entities. Set only on the base type of
3558 -- float types with Vax format. The particular format is determined by
3559 -- the Digits_Value value which is 6,9,15 for F_Float, D_Float, G_Float.
3561 -- Warnings_Off (Flag96)
3562 -- Present in all entities. Set if a pragma Warnings (Off, entity-name)
3563 -- is used to suppress warnings for a given entity. It is also used by
3564 -- the compiler in some situations to kill spurious warnings.
3566 -- Was_Hidden (Flag196)
3567 -- Present in all entities. Used to save the value of the Is_Hidden
3568 -- attribute when the limited-view is installed (Ada 2005: AI-217).
3570 -- Wrapped_Entity (Node27)
3571 -- Present in an E_Procedure classified as an Is_Primitive_Wrapper. Set
3572 -- to the entity that is being wrapped.
3574 ------------------
3575 -- Access Kinds --
3576 ------------------
3578 -- The following five entity kinds are introduced by the corresponding
3579 -- type definitions:
3581 -- E_Access_Type,
3582 -- E_General_Access_Type,
3583 -- E_Anonymous_Access_Subprogram_Type,
3584 -- E_Anonymous_Access_Protected_Subprogram_Type
3585 -- E_Anonymous_Access_Type.
3587 -- In addition, we define the kind E_Allocator_Type to label
3588 -- allocators. This is because special resolution rules apply to this
3589 -- construct. Eventually the constructs are labeled with the access
3590 -- type imposed by the context. Gigi should never see the type
3591 -- E_Allocator.
3593 -- Similarly, the type E_Access_Attribute_Type is used as the initial
3594 -- kind associated with an access attribute. After resolution a specific
3595 -- access type will be established as determined by the context.
3597 -- Finally, the type Any_Access is used to label -null- during type
3598 -- resolution. Any_Access is also replaced by the context type after
3599 -- resolution.
3601 --------------------------------
3602 -- Classification of Entities --
3603 --------------------------------
3605 -- The classification of program entities which follows is a refinement of
3606 -- the list given in RM 3.1(1). E.g., separate entities denote subtypes of
3607 -- different type classes. Ada 95 entities include class wide types,
3608 -- protected types, subprogram types, generalized access types, generic
3609 -- formal derived types and generic formal packages.
3611 -- The order chosen for these kinds allows us to classify related entities
3612 -- so that they are contiguous. As a result, they do not appear in the
3613 -- exact same order as their order of first appearance in the LRM (For
3614 -- example, private types are listed before packages). The contiguity
3615 -- allows us to define useful subtypes (see below) such as type entities,
3616 -- overloaded entities, etc.
3618 -- Each entity (explicitly or implicitly declared) has a kind, which is
3619 -- a value of the following type:
3621 type Entity_Kind is (
3623 E_Void,
3624 -- The initial Ekind value for a newly created entity. Also used as
3625 -- the Ekind for Standard_Void_Type, a type entity in Standard used
3626 -- as a dummy type for the return type of a procedure (the reason we
3627 -- create this type is to share the circuits for performing overload
3628 -- resolution on calls).
3630 -------------
3631 -- Objects --
3632 -------------
3634 E_Component,
3635 -- Components of a record declaration, private declarations of
3636 -- protected objects.
3638 E_Constant,
3639 -- Constants created by an object declaration with a constant keyword
3641 E_Discriminant,
3642 -- A discriminant, created by the use of a discriminant in a type
3643 -- declaration.
3645 E_Loop_Parameter,
3646 -- A loop parameter created by a for loop
3648 E_Variable,
3649 -- Variables created by an object declaration with no constant keyword
3651 ------------------------
3652 -- Parameter Entities --
3653 ------------------------
3655 -- Parameters are also objects
3657 E_Out_Parameter,
3658 -- An out parameter of a subprogram or entry
3660 E_In_Out_Parameter,
3661 -- An in-out parameter of a subprogram or entry
3663 E_In_Parameter,
3664 -- An in parameter of a subprogram or entry
3666 --------------------------------
3667 -- Generic Parameter Entities --
3668 --------------------------------
3670 -- Generic parameters are also objects
3672 E_Generic_In_Out_Parameter,
3673 -- A generic in out parameter, created by the use of a generic in out
3674 -- parameter in a generic declaration.
3676 E_Generic_In_Parameter,
3677 -- A generic in parameter, created by the use of a generic in
3678 -- parameter in a generic declaration.
3680 -------------------
3681 -- Named Numbers --
3682 -------------------
3684 E_Named_Integer,
3685 -- Named numbers created by a number declaration with an integer value
3687 E_Named_Real,
3688 -- Named numbers created by a number declaration with a real value
3690 -----------------------
3691 -- Enumeration Types --
3692 -----------------------
3694 E_Enumeration_Type,
3695 -- Enumeration types, created by an enumeration type declaration
3697 E_Enumeration_Subtype,
3698 -- Enumeration subtypes, created by an explicit or implicit subtype
3699 -- declaration applied to an enumeration type or subtype.
3701 -------------------
3702 -- Numeric Types --
3703 -------------------
3705 E_Signed_Integer_Type,
3706 -- Signed integer type, used for the anonymous base type of the
3707 -- integer subtype created by an integer type declaration.
3709 E_Signed_Integer_Subtype,
3710 -- Signed integer subtype, created by either an integer subtype or
3711 -- integer type declaration (in the latter case an integer type is
3712 -- created for the base type, and this is the first named subtype).
3714 E_Modular_Integer_Type,
3715 -- Modular integer type, used for the anonymous base type of the
3716 -- integer subtype created by a modular integer type declaration.
3718 E_Modular_Integer_Subtype,
3719 -- Modular integer subtype, created by either an modular subtype
3720 -- or modular type declaration (in the latter case a modular type
3721 -- is created for the base type, and this is the first named subtype).
3723 E_Ordinary_Fixed_Point_Type,
3724 -- Ordinary fixed type, used for the anonymous base type of the
3725 -- fixed subtype created by an ordinary fixed point type declaration.
3727 E_Ordinary_Fixed_Point_Subtype,
3728 -- Ordinary fixed point subtype, created by either an ordinary fixed
3729 -- point subtype or ordinary fixed point type declaration (in the
3730 -- latter case a fixed point type is created for the base type, and
3731 -- this is the first named subtype).
3733 E_Decimal_Fixed_Point_Type,
3734 -- Decimal fixed type, used for the anonymous base type of the decimal
3735 -- fixed subtype created by an ordinary fixed point type declaration.
3737 E_Decimal_Fixed_Point_Subtype,
3738 -- Decimal fixed point subtype, created by either a decimal fixed point
3739 -- subtype or decimal fixed point type declaration (in the latter case
3740 -- a fixed point type is created for the base type, and this is the
3741 -- first named subtype).
3743 E_Floating_Point_Type,
3744 -- Floating point type, used for the anonymous base type of the
3745 -- floating point subtype created by a floating point type declaration.
3747 E_Floating_Point_Subtype,
3748 -- Floating point subtype, created by either a floating point subtype
3749 -- or floating point type declaration (in the latter case a floating
3750 -- point type is created for the base type, and this is the first
3751 -- named subtype).
3753 ------------------
3754 -- Access Types --
3755 ------------------
3757 E_Access_Type,
3758 -- An access type created by an access type declaration with no all
3759 -- keyword present. Note that the predefined type Any_Access, which
3760 -- has E_Access_Type Ekind, is used to label NULL in the upwards pass
3761 -- of type analysis, to be replaced by the true access type in the
3762 -- downwards resolution pass.
3764 E_Access_Subtype,
3765 -- An access subtype created by a subtype declaration for any access
3766 -- type (whether or not it is a general access type).
3768 E_Access_Attribute_Type,
3769 -- An access type created for an access attribute (such as 'Access,
3770 -- 'Unrestricted_Access and Unchecked_Access)
3772 E_Allocator_Type,
3773 -- A special internal type used to label allocators and attribute
3774 -- references using 'Access. This is needed because special resolution
3775 -- rules apply to these constructs. On the resolution pass, this type
3776 -- is always replaced by the actual access type, so Gigi should never
3777 -- see types with this Ekind.
3779 E_General_Access_Type,
3780 -- An access type created by an access type declaration with the all
3781 -- keyword present.
3783 E_Access_Subprogram_Type,
3784 -- An access to subprogram type, created by an access to subprogram
3785 -- declaration.
3787 E_Anonymous_Access_Subprogram_Type,
3788 -- An anonymous access to subprogram type, created by an access to
3789 -- subprogram declaration.
3791 E_Access_Protected_Subprogram_Type,
3792 -- An access to a protected subprogram, created by the corresponding
3793 -- declaration. Values of such a type denote both a protected object
3794 -- and a protected operation within, and have different compile-time
3795 -- and run-time properties than other access to subprograms.
3797 E_Anonymous_Access_Protected_Subprogram_Type,
3798 -- An anonymous access to protected subprogram type, created by an
3799 -- access to subprogram declaration.
3801 E_Anonymous_Access_Type,
3802 -- An anonymous access type created by an access parameter or access
3803 -- discriminant.
3805 ---------------------
3806 -- Composite Types --
3807 ---------------------
3809 E_Array_Type,
3810 -- An array type created by an array type declaration. Includes all
3811 -- cases of arrays, except for string types.
3813 E_Array_Subtype,
3814 -- An array subtype, created by an explicit array subtype declaration,
3815 -- or the use of an anonymous array subtype.
3817 E_String_Type,
3818 -- A string type, i.e. an array type whose component type is a character
3819 -- type, and for which string literals can thus be written.
3821 E_String_Subtype,
3822 -- A string subtype, created by an explicit subtype declaration for a
3823 -- string type, or the use of an anonymous subtype of a string type,
3825 E_String_Literal_Subtype,
3826 -- A special string subtype, used only to describe the type of a string
3827 -- literal (will always be one dimensional, with literal bounds).
3829 E_Class_Wide_Type,
3830 -- A class wide type, created by any tagged type declaration (i.e. if
3831 -- a tagged type is declared, the corresponding class type is always
3832 -- created, using this Ekind value).
3834 E_Class_Wide_Subtype,
3835 -- A subtype of a class wide type, created by a subtype declaration
3836 -- used to declare a subtype of a class type.
3838 E_Record_Type,
3839 -- A record type, created by a record type declaration
3841 E_Record_Subtype,
3842 -- A record subtype, created by a record subtype declaration
3844 E_Record_Type_With_Private,
3845 -- Used for types defined by a private extension declaration, and
3846 -- for tagged private types. Includes the fields for both private
3847 -- types and for record types (with the sole exception of
3848 -- Corresponding_Concurrent_Type which is obviously not needed).
3849 -- This entity is considered to be both a record type and
3850 -- a private type.
3852 E_Record_Subtype_With_Private,
3853 -- A subtype of a type defined by a private extension declaration
3855 E_Private_Type,
3856 -- A private type, created by a private type declaration
3857 -- that has neither the keyword limited nor the keyword tagged.
3859 E_Private_Subtype,
3860 -- A subtype of a private type, created by a subtype declaration used
3861 -- to declare a subtype of a private type.
3863 E_Limited_Private_Type,
3864 -- A limited private type, created by a private type declaration that
3865 -- has the keyword limited, but not the keyword tagged.
3867 E_Limited_Private_Subtype,
3868 -- A subtype of a limited private type, created by a subtype declaration
3869 -- used to declare a subtype of a limited private type.
3871 E_Incomplete_Type,
3872 -- An incomplete type, created by an incomplete type declaration
3874 E_Incomplete_Subtype,
3875 -- An incomplete subtype, created by a subtype declaration where the
3876 -- subtype mark denotes an incomplete type.
3878 E_Task_Type,
3879 -- A task type, created by a task type declaration. An entity with this
3880 -- Ekind is also created to describe the anonymous type of a task that
3881 -- is created by a single task declaration.
3883 E_Task_Subtype,
3884 -- A subtype of a task type, created by a subtype declaration used to
3885 -- declare a subtype of a task type.
3887 E_Protected_Type,
3888 -- A protected type, created by a protected type declaration. An entity
3889 -- with this Ekind is also created to describe the anonymous type of
3890 -- a protected object created by a single protected declaration.
3892 E_Protected_Subtype,
3893 -- A subtype of a protected type, created by a subtype declaration used
3894 -- to declare a subtype of a protected type.
3896 -----------------
3897 -- Other Types --
3898 -----------------
3900 E_Exception_Type,
3901 -- The type of an exception created by an exception declaration
3903 E_Subprogram_Type,
3904 -- This is the designated type of an Access_To_Subprogram. Has type
3905 -- and signature like a subprogram entity, so can appear in calls,
3906 -- which are resolved like regular calls, except that such an entity
3907 -- is not overloadable.
3909 ---------------------------
3910 -- Overloadable Entities --
3911 ---------------------------
3913 E_Enumeration_Literal,
3914 -- An enumeration literal, created by the use of the literal in an
3915 -- enumeration type definition.
3917 E_Function,
3918 -- A function, created by a function declaration or a function body
3919 -- that acts as its own declaration.
3921 E_Operator,
3922 -- A predefined operator, appearing in Standard, or an implicitly
3923 -- defined concatenation operator created whenever an array is
3924 -- declared. We do not make normal derived operators explicit in
3925 -- the tree, but the concatenation operators are made explicit.
3927 E_Procedure,
3928 -- A procedure, created by a procedure declaration or a procedure
3929 -- body that acts as its own declaration.
3931 E_Entry,
3932 -- An entry, created by an entry declaration in a task or protected
3933 -- object.
3935 --------------------
3936 -- Other Entities --
3937 --------------------
3939 E_Entry_Family,
3940 -- An entry family, created by an entry family declaration in a
3941 -- task or protected type definition.
3943 E_Block,
3944 -- A block identifier, created by an explicit or implicit label on
3945 -- a block or declare statement.
3947 E_Entry_Index_Parameter,
3948 -- An entry index parameter created by an entry index specification
3949 -- for the body of a protected entry family.
3951 E_Exception,
3952 -- An exception created by an exception declaration. The exception
3953 -- itself uses E_Exception for the Ekind, the implicit type that is
3954 -- created to represent its type uses the Ekind E_Exception_Type.
3956 E_Generic_Function,
3957 -- A generic function. This is the entity for a generic function
3958 -- created by a generic subprogram declaration.
3960 E_Generic_Procedure,
3961 -- A generic function. This is the entity for a generic procedure
3962 -- created by a generic subprogram declaration.
3964 E_Generic_Package,
3965 -- A generic package, this is the entity for a generic package created
3966 -- by a generic package declaration.
3968 E_Label,
3969 -- The defining entity for a label. Note that this is created by the
3970 -- implicit label declaration, not the occurrence of the label itself,
3971 -- which is simply a direct name referring to the label.
3973 E_Loop,
3974 -- A loop identifier, created by an explicit or implicit label on a
3975 -- loop statement.
3977 E_Return_Statement,
3978 -- A dummy entity created for each return statement. Used to hold
3979 -- information about the return statement (what it applies to) and in
3980 -- rules checking. For example, a simple_return_statement that applies
3981 -- to an extended_return_statement cannot have an expression; this
3982 -- requires putting the E_Return_Statement entity for the
3983 -- extended_return_statement on the scope stack.
3985 E_Package,
3986 -- A package, created by a package declaration
3988 E_Package_Body,
3989 -- A package body. This entity serves only limited functions, since
3990 -- most semantic analysis uses the package entity (E_Package). However
3991 -- there are some attributes that are significant for the body entity.
3992 -- For example, collection of exception handlers.
3994 E_Protected_Object,
3995 -- A protected object, created by an object declaration that declares
3996 -- an object of a protected type.
3998 E_Protected_Body,
3999 -- A protected body. This entity serves almost no function, since all
4000 -- semantic analysis uses the protected entity (E_Protected_Type)
4002 E_Task_Body,
4003 -- A task body. This entity serves almost no function, since all
4004 -- semantic analysis uses the protected entity (E_Task_Type).
4006 E_Subprogram_Body
4007 -- A subprogram body. Used when a subprogram has a separate declaration
4008 -- to represent the entity for the body. This entity serves almost no
4009 -- function, since all semantic analysis uses the subprogram entity
4010 -- for the declaration (E_Function or E_Procedure).
4013 for Entity_Kind'Size use 8;
4014 -- The data structures in Atree assume this!
4016 --------------------------
4017 -- Subtype Declarations --
4018 --------------------------
4020 -- The above entities are arranged so that they can be conveniently grouped
4021 -- into subtype ranges. Note that for each of the xxx_Kind ranges defined
4022 -- below, there is a corresponding Is_xxx (or for types, Is_xxx_Type)
4023 -- predicate which is to be used in preference to direct range tests using
4024 -- the subtype name. However, the subtype names are available for direct
4025 -- use, e.g. as choices in case statements.
4027 subtype Access_Kind is Entity_Kind range
4028 E_Access_Type ..
4029 -- E_Access_Subtype
4030 -- E_Access_Attribute_Type
4031 -- E_Allocator_Type
4032 -- E_General_Access_Type
4033 -- E_Access_Subprogram_Type
4034 -- E_Anonymous_Access_Subprogram_Type
4035 -- E_Access_Protected_Subprogram_Type
4036 -- E_Anonymous_Access_Protected_Subprogram_Type
4037 E_Anonymous_Access_Type;
4039 subtype Access_Protected_Kind is Entity_Kind range
4040 E_Access_Protected_Subprogram_Type ..
4041 E_Anonymous_Access_Protected_Subprogram_Type;
4043 subtype Array_Kind is Entity_Kind range
4044 E_Array_Type ..
4045 -- E_Array_Subtype
4046 -- E_String_Type
4047 -- E_String_Subtype
4048 E_String_Literal_Subtype;
4050 subtype Assignable_Kind is Entity_Kind range
4051 E_Variable ..
4052 -- E_Out_Parameter
4053 E_In_Out_Parameter;
4055 subtype Class_Wide_Kind is Entity_Kind range
4056 E_Class_Wide_Type ..
4057 E_Class_Wide_Subtype;
4059 subtype Composite_Kind is Entity_Kind range
4060 E_Array_Type ..
4061 -- E_Array_Subtype
4062 -- E_String_Type
4063 -- E_String_Subtype
4064 -- E_String_Literal_Subtype
4065 -- E_Class_Wide_Type
4066 -- E_Class_Wide_Subtype
4067 -- E_Record_Type
4068 -- E_Record_Subtype
4069 -- E_Record_Type_With_Private
4070 -- E_Record_Subtype_With_Private
4071 -- E_Private_Type
4072 -- E_Private_Subtype
4073 -- E_Limited_Private_Type
4074 -- E_Limited_Private_Subtype
4075 -- E_Incomplete_Type
4076 -- E_Incomplete_Subtype
4077 -- E_Task_Type
4078 -- E_Task_Subtype,
4079 -- E_Protected_Type,
4080 E_Protected_Subtype;
4082 subtype Concurrent_Kind is Entity_Kind range
4083 E_Task_Type ..
4084 -- E_Task_Subtype,
4085 -- E_Protected_Type,
4086 E_Protected_Subtype;
4088 subtype Concurrent_Body_Kind is Entity_Kind range
4089 E_Protected_Body ..
4090 E_Task_Body;
4092 subtype Decimal_Fixed_Point_Kind is Entity_Kind range
4093 E_Decimal_Fixed_Point_Type ..
4094 E_Decimal_Fixed_Point_Subtype;
4096 subtype Digits_Kind is Entity_Kind range
4097 E_Decimal_Fixed_Point_Type ..
4098 -- E_Decimal_Fixed_Point_Subtype
4099 -- E_Floating_Point_Type
4100 E_Floating_Point_Subtype;
4102 subtype Discrete_Kind is Entity_Kind range
4103 E_Enumeration_Type ..
4104 -- E_Enumeration_Subtype
4105 -- E_Signed_Integer_Type
4106 -- E_Signed_Integer_Subtype
4107 -- E_Modular_Integer_Type
4108 E_Modular_Integer_Subtype;
4110 subtype Discrete_Or_Fixed_Point_Kind is Entity_Kind range
4111 E_Enumeration_Type ..
4112 -- E_Enumeration_Subtype
4113 -- E_Signed_Integer_Type
4114 -- E_Signed_Integer_Subtype
4115 -- E_Modular_Integer_Type
4116 -- E_Modular_Integer_Subtype
4117 -- E_Ordinary_Fixed_Point_Type
4118 -- E_Ordinary_Fixed_Point_Subtype
4119 -- E_Decimal_Fixed_Point_Type
4120 E_Decimal_Fixed_Point_Subtype;
4122 subtype Elementary_Kind is Entity_Kind range
4123 E_Enumeration_Type ..
4124 -- E_Enumeration_Subtype
4125 -- E_Signed_Integer_Type
4126 -- E_Signed_Integer_Subtype
4127 -- E_Modular_Integer_Type
4128 -- E_Modular_Integer_Subtype
4129 -- E_Ordinary_Fixed_Point_Type
4130 -- E_Ordinary_Fixed_Point_Subtype
4131 -- E_Decimal_Fixed_Point_Type
4132 -- E_Decimal_Fixed_Point_Subtype
4133 -- E_Floating_Point_Type
4134 -- E_Floating_Point_Subtype
4135 -- E_Access_Type
4136 -- E_Access_Subtype
4137 -- E_Access_Attribute_Type
4138 -- E_Allocator_Type
4139 -- E_General_Access_Type
4140 -- E_Access_Subprogram_Type
4141 -- E_Access_Protected_Subprogram_Type
4142 -- E_Anonymous_Access_Subprogram_Type
4143 -- E_Anonymous_Access_Protected_Subprogram_Type
4144 E_Anonymous_Access_Type;
4146 subtype Enumeration_Kind is Entity_Kind range
4147 E_Enumeration_Type ..
4148 E_Enumeration_Subtype;
4150 subtype Entry_Kind is Entity_Kind range
4151 E_Entry ..
4152 E_Entry_Family;
4154 subtype Fixed_Point_Kind is Entity_Kind range
4155 E_Ordinary_Fixed_Point_Type ..
4156 -- E_Ordinary_Fixed_Point_Subtype
4157 -- E_Decimal_Fixed_Point_Type
4158 E_Decimal_Fixed_Point_Subtype;
4160 subtype Float_Kind is Entity_Kind range
4161 E_Floating_Point_Type ..
4162 E_Floating_Point_Subtype;
4164 subtype Formal_Kind is Entity_Kind range
4165 E_Out_Parameter ..
4166 -- E_In_Out_Parameter
4167 E_In_Parameter;
4169 subtype Formal_Object_Kind is Entity_Kind range
4170 E_Generic_In_Out_Parameter ..
4171 E_Generic_In_Parameter;
4173 subtype Generic_Subprogram_Kind is Entity_Kind range
4174 E_Generic_Function ..
4175 E_Generic_Procedure;
4177 subtype Generic_Unit_Kind is Entity_Kind range
4178 E_Generic_Function ..
4179 -- E_Generic_Procedure
4180 E_Generic_Package;
4182 subtype Incomplete_Kind is Entity_Kind range
4183 E_Incomplete_Type ..
4184 E_Incomplete_Subtype;
4186 subtype Incomplete_Or_Private_Kind is Entity_Kind range
4187 E_Record_Type_With_Private ..
4188 -- E_Record_Subtype_With_Private
4189 -- E_Private_Type
4190 -- E_Private_Subtype
4191 -- E_Limited_Private_Type
4192 -- E_Limited_Private_Subtype
4193 -- E_Incomplete_Type
4194 E_Incomplete_Subtype;
4196 subtype Integer_Kind is Entity_Kind range
4197 E_Signed_Integer_Type ..
4198 -- E_Signed_Integer_Subtype
4199 -- E_Modular_Integer_Type
4200 E_Modular_Integer_Subtype;
4202 subtype Modular_Integer_Kind is Entity_Kind range
4203 E_Modular_Integer_Type ..
4204 E_Modular_Integer_Subtype;
4206 subtype Named_Kind is Entity_Kind range
4207 E_Named_Integer ..
4208 E_Named_Real;
4210 subtype Numeric_Kind is Entity_Kind range
4211 E_Signed_Integer_Type ..
4212 -- E_Signed_Integer_Subtype
4213 -- E_Modular_Integer_Type
4214 -- E_Modular_Integer_Subtype
4215 -- E_Ordinary_Fixed_Point_Type
4216 -- E_Ordinary_Fixed_Point_Subtype
4217 -- E_Decimal_Fixed_Point_Type
4218 -- E_Decimal_Fixed_Point_Subtype
4219 -- E_Floating_Point_Type
4220 E_Floating_Point_Subtype;
4222 subtype Object_Kind is Entity_Kind range
4223 E_Component ..
4224 -- E_Constant
4225 -- E_Discriminant
4226 -- E_Loop_Parameter
4227 -- E_Variable
4228 -- E_Out_Parameter
4229 -- E_In_Out_Parameter
4230 -- E_In_Parameter
4231 -- E_Generic_In_Out_Parameter
4232 E_Generic_In_Parameter;
4234 subtype Ordinary_Fixed_Point_Kind is Entity_Kind range
4235 E_Ordinary_Fixed_Point_Type ..
4236 E_Ordinary_Fixed_Point_Subtype;
4238 subtype Overloadable_Kind is Entity_Kind range
4239 E_Enumeration_Literal ..
4240 -- E_Function
4241 -- E_Operator
4242 -- E_Procedure
4243 E_Entry;
4245 subtype Private_Kind is Entity_Kind range
4246 E_Record_Type_With_Private ..
4247 -- E_Record_Subtype_With_Private
4248 -- E_Private_Type
4249 -- E_Private_Subtype
4250 -- E_Limited_Private_Type
4251 E_Limited_Private_Subtype;
4253 subtype Protected_Kind is Entity_Kind range
4254 E_Protected_Type ..
4255 E_Protected_Subtype;
4257 subtype Real_Kind is Entity_Kind range
4258 E_Ordinary_Fixed_Point_Type ..
4259 -- E_Ordinary_Fixed_Point_Subtype
4260 -- E_Decimal_Fixed_Point_Type
4261 -- E_Decimal_Fixed_Point_Subtype
4262 -- E_Floating_Point_Type
4263 E_Floating_Point_Subtype;
4265 subtype Record_Kind is Entity_Kind range
4266 E_Class_Wide_Type ..
4267 -- E_Class_Wide_Subtype
4268 -- E_Record_Type
4269 -- E_Record_Subtype
4270 -- E_Record_Type_With_Private
4271 E_Record_Subtype_With_Private;
4273 subtype Scalar_Kind is Entity_Kind range
4274 E_Enumeration_Type ..
4275 -- E_Enumeration_Subtype
4276 -- E_Signed_Integer_Type
4277 -- E_Signed_Integer_Subtype
4278 -- E_Modular_Integer_Type
4279 -- E_Modular_Integer_Subtype
4280 -- E_Ordinary_Fixed_Point_Type
4281 -- E_Ordinary_Fixed_Point_Subtype
4282 -- E_Decimal_Fixed_Point_Type
4283 -- E_Decimal_Fixed_Point_Subtype
4284 -- E_Floating_Point_Type
4285 E_Floating_Point_Subtype;
4287 subtype String_Kind is Entity_Kind range
4288 E_String_Type ..
4289 -- E_String_Subtype
4290 E_String_Literal_Subtype;
4292 subtype Subprogram_Kind is Entity_Kind range
4293 E_Function ..
4294 -- E_Operator
4295 E_Procedure;
4297 subtype Signed_Integer_Kind is Entity_Kind range
4298 E_Signed_Integer_Type ..
4299 E_Signed_Integer_Subtype;
4301 subtype Task_Kind is Entity_Kind range
4302 E_Task_Type ..
4303 E_Task_Subtype;
4305 subtype Type_Kind is Entity_Kind range
4306 E_Enumeration_Type ..
4307 -- E_Enumeration_Subtype
4308 -- E_Signed_Integer_Type
4309 -- E_Signed_Integer_Subtype
4310 -- E_Modular_Integer_Type
4311 -- E_Modular_Integer_Subtype
4312 -- E_Ordinary_Fixed_Point_Type
4313 -- E_Ordinary_Fixed_Point_Subtype
4314 -- E_Decimal_Fixed_Point_Type
4315 -- E_Decimal_Fixed_Point_Subtype
4316 -- E_Floating_Point_Type
4317 -- E_Floating_Point_Subtype
4318 -- E_Access_Type
4319 -- E_Access_Subtype
4320 -- E_Access_Attribute_Type
4321 -- E_Allocator_Type,
4322 -- E_General_Access_Type
4323 -- E_Access_Subprogram_Type,
4324 -- E_Access_Protected_Subprogram_Type
4325 -- E_Anonymous_Access_Subprogram_Type
4326 -- E_Anonymous_Access_Protected_Subprogram_Type
4327 -- E_Anonymous_Access_Type
4328 -- E_Array_Type
4329 -- E_Array_Subtype
4330 -- E_String_Type
4331 -- E_String_Subtype
4332 -- E_String_Literal_Subtype
4333 -- E_Class_Wide_Subtype
4334 -- E_Class_Wide_Type
4335 -- E_Record_Type
4336 -- E_Record_Subtype
4337 -- E_Record_Type_With_Private
4338 -- E_Record_Subtype_With_Private
4339 -- E_Private_Type
4340 -- E_Private_Subtype
4341 -- E_Limited_Private_Type
4342 -- E_Limited_Private_Subtype
4343 -- E_Incomplete_Type
4344 -- E_Incomplete_Subtype
4345 -- E_Task_Type
4346 -- E_Task_Subtype
4347 -- E_Protected_Type
4348 -- E_Protected_Subtype
4349 -- E_Exception_Type
4350 E_Subprogram_Type;
4352 --------------------------------------------------------
4353 -- Description of Defined Attributes for Entity_Kinds --
4354 --------------------------------------------------------
4356 -- For each enumeration value defined in Entity_Kind we list all the
4357 -- attributes defined in Einfo which can legally be applied to an entity
4358 -- of that kind. The implementation of the attribute functions (and for
4359 -- non-synthetized attributes, of the corresponding set procedures) are
4360 -- in the Einfo body.
4362 -- The following attributes apply to all entities
4364 -- Ekind (Ekind)
4366 -- Chars (Name1)
4367 -- Next_Entity (Node2)
4368 -- Scope (Node3)
4369 -- Homonym (Node4)
4370 -- Etype (Node5)
4371 -- First_Rep_Item (Node6)
4372 -- Freeze_Node (Node7)
4373 -- Obsolescent_Warning (Node24)
4375 -- Address_Taken (Flag104)
4376 -- Can_Never_Be_Null (Flag38)
4377 -- Checks_May_Be_Suppressed (Flag31)
4378 -- Debug_Info_Off (Flag166)
4379 -- Has_Anon_Block_Suffix (Flag201)
4380 -- Has_Controlled_Component (Flag43) (base type only)
4381 -- Has_Convention_Pragma (Flag119)
4382 -- Has_Delayed_Freeze (Flag18)
4383 -- Has_Fully_Qualified_Name (Flag173)
4384 -- Has_Gigi_Rep_Item (Flag82)
4385 -- Has_Homonym (Flag56)
4386 -- Has_Persistent_BSS (Flag188)
4387 -- Has_Pragma_Elaborate_Body (Flag150)
4388 -- Has_Pragma_Inline (Flag157)
4389 -- Has_Pragma_Pack (Flag121) (base type only)
4390 -- Has_Pragma_Pure (Flag203)
4391 -- Has_Pragma_Pure_Function (Flag179)
4392 -- Has_Pragma_Unreferenced (Flag180)
4393 -- Has_Private_Declaration (Flag155)
4394 -- Has_Qualified_Name (Flag161)
4395 -- Has_Stream_Size_Clause (Flag184)
4396 -- Has_Unknown_Discriminants (Flag72)
4397 -- Has_Xref_Entry (Flag182)
4398 -- In_Private_Part (Flag45)
4399 -- Is_Ada_2005_Only (Flag185)
4400 -- Is_Bit_Packed_Array (Flag122) (base type only)
4401 -- Is_Character_Type (Flag63)
4402 -- Is_Child_Unit (Flag73)
4403 -- Is_Compilation_Unit (Flag149)
4404 -- Is_Completely_Hidden (Flag103)
4405 -- Is_Discrim_SO_Function (Flag176)
4406 -- Is_Dispatching_Operation (Flag6)
4407 -- Is_Entry_Formal (Flag52)
4408 -- Is_Exported (Flag99)
4409 -- Is_First_Subtype (Flag70)
4410 -- Is_Formal_Subprogram (Flag111)
4411 -- Is_Generic_Instance (Flag130)
4412 -- Is_Hidden (Flag57)
4413 -- Is_Hidden_Open_Scope (Flag171)
4414 -- Is_Immediately_Visible (Flag7)
4415 -- Is_Imported (Flag24)
4416 -- Is_Inlined (Flag11)
4417 -- Is_Internal (Flag17)
4418 -- Is_Itype (Flag91)
4419 -- Is_Known_Non_Null (Flag37)
4420 -- Is_Known_Null (Flag204)
4421 -- Is_Known_Valid (Flag170)
4422 -- Is_Limited_Composite (Flag106)
4423 -- Is_Limited_Record (Flag25)
4424 -- Is_Obsolescent (Flag153)
4425 -- Is_Package_Body_Entity (Flag160)
4426 -- Is_Packed_Array_Type (Flag138)
4427 -- Is_Potentially_Use_Visible (Flag9)
4428 -- Is_Preelaborated (Flag59)
4429 -- Is_Primitive_Wrapper (Flag195)
4430 -- Is_Public (Flag10)
4431 -- Is_Pure (Flag44)
4432 -- Is_Remote_Call_Interface (Flag62)
4433 -- Is_Remote_Types (Flag61)
4434 -- Is_Renaming_Of_Object (Flag112)
4435 -- Is_Shared_Passive (Flag60)
4436 -- Is_Statically_Allocated (Flag28)
4437 -- Is_Tagged_Type (Flag55)
4438 -- Is_Unchecked_Union (Flag117)
4439 -- Is_Visible_Formal (Flag206)
4440 -- Is_VMS_Exception (Flag133)
4441 -- Kill_Elaboration_Checks (Flag32)
4442 -- Kill_Range_Checks (Flag33)
4443 -- Kill_Tag_Checks (Flag34)
4444 -- Low_Bound_Known (Flag205)
4445 -- Materialize_Entity (Flag168)
4446 -- Needs_Debug_Info (Flag147)
4447 -- Never_Set_In_Source (Flag115)
4448 -- No_Return (Flag113)
4449 -- Referenced (Flag156)
4450 -- Referenced_As_LHS (Flag36)
4451 -- Suppress_Elaboration_Warnings (Flag148)
4452 -- Suppress_Style_Checks (Flag165)
4453 -- Suppress_Value_Tracking_On_Call (Flag217)
4454 -- Used_As_Generic_Actual (Flag222)
4455 -- Warnings_Off (Flag96)
4456 -- Was_Hidden (Flag196)
4458 -- Declaration_Node (synth)
4459 -- Enclosing_Dynamic_Scope (synth)
4460 -- Has_Foreign_Convention (synth)
4461 -- Is_Derived_Type (synth)
4462 -- Is_Dynamic_Scope (synth)
4463 -- Is_Limited_Type (synth)
4464 -- Underlying_Type (synth)
4465 -- all classification attributes (synth)
4467 -- The following list of access functions applies to all entities for
4468 -- types and subtypes. References to this list appear subsequently as
4469 -- as "(plus type attributes)" for each appropriate Entity_Kind.
4471 -- Associated_Node_For_Itype (Node8)
4472 -- Class_Wide_Type (Node9)
4473 -- Referenced_Object (Node10)
4474 -- Full_View (Node11)
4475 -- Esize (Uint12)
4476 -- RM_Size (Uint13)
4477 -- Alignment (Uint14)
4479 -- Depends_On_Private (Flag14)
4480 -- Discard_Names (Flag88)
4481 -- Finalize_Storage_Only (Flag158) (base type only)
4482 -- From_With_Type (Flag159)
4483 -- Has_Aliased_Components (Flag135) (base type only)
4484 -- Has_Alignment_Clause (Flag46)
4485 -- Has_Atomic_Components (Flag86) (base type only)
4486 -- Has_Completion_In_Body (Flag71)
4487 -- Has_Complex_Representation (Flag140) (base type only)
4488 -- Has_Constrained_Partial_View (Flag187)
4489 -- Has_Discriminants (Flag5)
4490 -- Has_Non_Standard_Rep (Flag75) (base type only)
4491 -- Has_Object_Size_Clause (Flag172)
4492 -- Has_Pragma_Preelab_Init (Flag221)
4493 -- Has_Pragma_Unreferenced_Objects (Flag212)
4494 -- Has_Primitive_Operations (Flag120) (base type only)
4495 -- Has_Size_Clause (Flag29)
4496 -- Has_Specified_Layout (Flag100) (base type only)
4497 -- Has_Specified_Stream_Input (Flag190)
4498 -- Has_Specified_Stream_Output (Flag191)
4499 -- Has_Specified_Stream_Read (Flag192)
4500 -- Has_Specified_Stream_Write (Flag193)
4501 -- Has_Task (Flag30) (base type only)
4502 -- Has_Unchecked_Union (Flag123) (base type only)
4503 -- Has_Volatile_Components (Flag87) (base type only)
4504 -- In_Use (Flag8)
4505 -- Is_Abstract_Type (Flag146)
4506 -- Is_Asynchronous (Flag81)
4507 -- Is_Atomic (Flag85)
4508 -- Is_Constr_Subt_For_U_Nominal (Flag80)
4509 -- Is_Constr_Subt_For_UN_Aliased (Flag141)
4510 -- Is_Controlled (Flag42) (base type only)
4511 -- Is_Eliminated (Flag124)
4512 -- Is_Frozen (Flag4)
4513 -- Is_Generic_Actual_Type (Flag94)
4514 -- Is_Generic_Type (Flag13)
4515 -- Is_Protected_Interface (Flag198)
4516 -- Is_Synchronized_Interface (Flag199)
4517 -- Is_Task_Interface (Flag200)
4518 -- Is_Non_Static_Subtype (Flag109)
4519 -- Is_Packed (Flag51) (base type only)
4520 -- Is_Private_Composite (Flag107)
4521 -- Is_Unsigned_Type (Flag144)
4522 -- Is_Volatile (Flag16)
4523 -- Itype_Printed (Flag202) (itypes only)
4524 -- Known_To_Have_Preelab_Init (Flag207)
4525 -- Must_Be_On_Byte_Boundary (Flag183)
4526 -- Must_Have_Preelab_Init (Flag208)
4527 -- Size_Depends_On_Discriminant (Flag177)
4528 -- Size_Known_At_Compile_Time (Flag92)
4529 -- Strict_Alignment (Flag145) (base type only)
4530 -- Suppress_Init_Proc (Flag105) (base type only)
4531 -- Treat_As_Volatile (Flag41)
4532 -- Universal_Aliasing (Flag216) (base type only)
4534 -- Alignment_Clause (synth)
4535 -- Ancestor_Subtype (synth)
4536 -- Base_Type (synth)
4537 -- First_Subtype (synth)
4538 -- Has_Private_Ancestor (synth)
4539 -- Implementation_Base_Type (synth)
4540 -- Is_Access_Protected_Subprogram_Type (synth)
4541 -- Is_By_Copy_Type (synth)
4542 -- Is_By_Reference_Type (synth)
4543 -- Is_Inherently_Limited_Type (synth)
4544 -- Root_Type (synth)
4545 -- Size_Clause (synth)
4547 ------------------------------------------
4548 -- Applicable attributes by entity kind --
4549 ------------------------------------------
4551 -- E_Access_Protected_Subprogram_Type
4552 -- Equivalent_Type (Node18)
4553 -- Directly_Designated_Type (Node20)
4554 -- Needs_No_Actuals (Flag22)
4555 -- (plus type attributes)
4557 -- E_Access_Subprogram_Type
4558 -- Equivalent_Type (Node18) (remote types only)
4559 -- Directly_Designated_Type (Node20)
4560 -- Needs_No_Actuals (Flag22)
4561 -- (plus type attributes)
4563 -- E_Access_Type
4564 -- E_Access_Subtype
4565 -- Storage_Size_Variable (Node15) (base type only)
4566 -- Master_Id (Node17)
4567 -- Directly_Designated_Type (Node20)
4568 -- Associated_Storage_Pool (Node22) (base type only)
4569 -- Associated_Final_Chain (Node23)
4570 -- Has_Pragma_Controlled (Flag27) (base type only)
4571 -- Has_Storage_Size_Clause (Flag23) (base type only)
4572 -- Is_Local_Anonymous_Access (Flag194)
4573 -- Is_Access_Constant (Flag69)
4574 -- Is_Pure_Unit_Access_Type (Flag189)
4575 -- No_Pool_Assigned (Flag131) (base type only)
4576 -- No_Strict_Aliasing (Flag136) (base type only)
4577 -- (plus type attributes)
4579 -- E_Access_Attribute_Type
4580 -- Directly_Designated_Type (Node20)
4581 -- (plus type attributes)
4583 -- E_Allocator_Type
4584 -- Directly_Designated_Type (Node20)
4585 -- (plus type attributes)
4587 -- E_Anonymous_Access_Subprogram_Type
4588 -- E_Anonymous_Access_Protected_Subprogram_Type
4589 -- E_Anonymous_Access_Type
4590 -- Storage_Size_Variable (Node15) ??? is this needed ???
4591 -- Directly_Designated_Type (Node20)
4592 -- (plus type attributes)
4594 -- E_Array_Type
4595 -- E_Array_Subtype
4596 -- First_Index (Node17)
4597 -- Related_Array_Object (Node19)
4598 -- Component_Type (Node20) (base type only)
4599 -- Original_Array_Type (Node21)
4600 -- Component_Size (Uint22) (base type only)
4601 -- Packed_Array_Type (Node23)
4602 -- Component_Alignment (special) (base type only)
4603 -- Has_Component_Size_Clause (Flag68) (base type only)
4604 -- Is_Aliased (Flag15)
4605 -- Is_Constrained (Flag12)
4606 -- Next_Index (synth)
4607 -- Number_Dimensions (synth)
4608 -- (plus type attributes)
4610 -- E_Block
4611 -- Block_Node (Node11)
4612 -- First_Entity (Node17)
4613 -- Last_Entity (Node20)
4614 -- Finalization_Chain_Entity (Node19)
4615 -- Scope_Depth_Value (Uint22)
4616 -- Entry_Cancel_Parameter (Node23)
4617 -- Delay_Cleanups (Flag114)
4618 -- Discard_Names (Flag88)
4619 -- Has_Master_Entity (Flag21)
4620 -- Has_Nested_Block_With_Handler (Flag101)
4621 -- Sec_Stack_Needed_For_Return (Flag167)
4622 -- Uses_Sec_Stack (Flag95)
4623 -- Scope_Depth (synth)
4625 -- E_Class_Wide_Type
4626 -- E_Class_Wide_Subtype
4627 -- Cloned_Subtype (Node16) (subtype case only)
4628 -- First_Entity (Node17)
4629 -- Equivalent_Type (Node18) (always Empty for type)
4630 -- Last_Entity (Node20)
4631 -- First_Component (synth)
4632 -- First_Component_Or_Discriminant (synth)
4633 -- First_Discriminant (synth)
4634 -- (plus type attributes)
4636 -- E_Component
4637 -- Normalized_First_Bit (Uint8)
4638 -- Current_Value (Node9) (always Empty)
4639 -- Normalized_Position_Max (Uint10)
4640 -- Component_Bit_Offset (Uint11)
4641 -- Esize (Uint12)
4642 -- Component_Clause (Node13)
4643 -- Normalized_Position (Uint14)
4644 -- DT_Entry_Count (Uint15)
4645 -- Entry_Formal (Node16)
4646 -- Prival (Node17)
4647 -- Renamed_Object (Node18) (always Empty)
4648 -- Discriminant_Checking_Func (Node20)
4649 -- Interface_Name (Node21) (JGNAT usage only)
4650 -- Original_Record_Component (Node22)
4651 -- Protected_Operation (Node23)
4652 -- DT_Offset_To_Top_Func (Node25)
4653 -- Related_Interface (Node26)
4654 -- Has_Biased_Representation (Flag139)
4655 -- Has_Per_Object_Constraint (Flag154)
4656 -- Is_Atomic (Flag85)
4657 -- Is_Tag (Flag78)
4658 -- Is_Volatile (Flag16)
4659 -- Treat_As_Volatile (Flag41)
4660 -- Is_Return_Object (Flag209)
4661 -- Is_Protected_Private (synth)
4662 -- Next_Component (synth)
4663 -- Next_Component_Or_Discriminant (synth)
4664 -- Next_Tag_Component (synth)
4666 -- E_Constant
4667 -- E_Loop_Parameter
4668 -- Current_Value (Node9) (always Empty)
4669 -- Discriminal_Link (Node10) (discriminals only)
4670 -- Full_View (Node11)
4671 -- Esize (Uint12)
4672 -- Alignment (Uint14)
4673 -- Actual_Subtype (Node17)
4674 -- Renamed_Object (Node18)
4675 -- Size_Check_Code (Node19) (constants only)
4676 -- Interface_Name (Node21)
4677 -- Related_Interface (Node26) (constants only)
4678 -- Has_Alignment_Clause (Flag46)
4679 -- Has_Atomic_Components (Flag86)
4680 -- Has_Biased_Representation (Flag139)
4681 -- Has_Completion (Flag26) (constants only)
4682 -- Has_Size_Clause (Flag29)
4683 -- Has_Up_Level_Access (Flag215)
4684 -- Has_Volatile_Components (Flag87)
4685 -- Is_Atomic (Flag85)
4686 -- Is_Eliminated (Flag124)
4687 -- Is_True_Constant (Flag163)
4688 -- Is_Volatile (Flag16)
4689 -- Treat_As_Volatile (Flag41)
4690 -- Is_Return_Object (Flag209)
4691 -- Address_Clause (synth)
4692 -- Alignment_Clause (synth)
4693 -- Constant_Value (synth)
4694 -- Size_Clause (synth)
4696 -- E_Decimal_Fixed_Point_Type
4697 -- E_Decimal_Fixed_Subtype
4698 -- Scale_Value (Uint15)
4699 -- Digits_Value (Uint17)
4700 -- Scalar_Range (Node20)
4701 -- Delta_Value (Ureal18)
4702 -- Small_Value (Ureal21)
4703 -- Has_Machine_Radix_Clause (Flag83)
4704 -- Machine_Radix_10 (Flag84)
4705 -- Type_Low_Bound (synth)
4706 -- Type_High_Bound (synth)
4707 -- (plus type attributes)
4709 -- E_Discriminant
4710 -- Normalized_First_Bit (Uint8)
4711 -- Current_Value (Node9) (always Empty)
4712 -- Normalized_Position_Max (Uint10)
4713 -- Component_Bit_Offset (Uint11)
4714 -- Esize (Uint12)
4715 -- Component_Clause (Node13)
4716 -- Normalized_Position (Uint14)
4717 -- Discriminant_Number (Uint15)
4718 -- Discriminal (Node17)
4719 -- Renamed_Object (Node18) (always Empty)
4720 -- Corresponding_Discriminant (Node19)
4721 -- Discriminant_Default_Value (Node20)
4722 -- Interface_Name (Node21) (JGNAT usage only)
4723 -- Original_Record_Component (Node22)
4724 -- CR_Discriminant (Node23)
4725 -- Is_Return_Object (Flag209)
4726 -- Next_Component_Or_Discriminant (synth)
4727 -- Next_Discriminant (synth)
4728 -- Next_Stored_Discriminant (synth)
4730 -- E_Entry
4731 -- E_Entry_Family
4732 -- Protected_Body_Subprogram (Node11)
4733 -- Barrier_Function (Node12)
4734 -- Entry_Parameters_Type (Node15)
4735 -- First_Entity (Node17)
4736 -- Alias (Node18) (for entry only. Empty)
4737 -- Finalization_Chain_Entity (Node19)
4738 -- Last_Entity (Node20)
4739 -- Accept_Address (Elist21)
4740 -- Scope_Depth_Value (Uint22)
4741 -- Privals_Chain (Elist23) (for a protected entry)
4742 -- Default_Expressions_Processed (Flag108)
4743 -- Entry_Accepted (Flag152)
4744 -- Is_AST_Entry (Flag132) (for entry only)
4745 -- Needs_No_Actuals (Flag22)
4746 -- Sec_Stack_Needed_For_Return (Flag167)
4747 -- Uses_Sec_Stack (Flag95)
4748 -- Address_Clause (synth)
4749 -- First_Formal (synth)
4750 -- First_Formal_With_Extras (synth)
4751 -- Entry_Index_Type (synth)
4752 -- Number_Formals (synth)
4753 -- Scope_Depth (synth)
4755 -- E_Entry_Index_Parameter
4756 -- Entry_Index_Constant (Node18)
4758 -- E_Enumeration_Literal
4759 -- Enumeration_Pos (Uint11)
4760 -- Enumeration_Rep (Uint12)
4761 -- Alias (Node18)
4762 -- Enumeration_Rep_Expr (Node22)
4763 -- Next_Literal (synth)
4765 -- E_Enumeration_Type
4766 -- E_Enumeration_Subtype
4767 -- Lit_Indexes (Node15) (root type only)
4768 -- Lit_Strings (Node16) (root type only)
4769 -- First_Literal (Node17)
4770 -- Scalar_Range (Node20)
4771 -- Enum_Pos_To_Rep (Node23) (type only)
4772 -- Has_Biased_Representation (Flag139)
4773 -- Has_Contiguous_Rep (Flag181)
4774 -- Has_Enumeration_Rep_Clause (Flag66)
4775 -- Nonzero_Is_True (Flag162) (base type only)
4776 -- Type_Low_Bound (synth)
4777 -- Type_High_Bound (synth)
4778 -- (plus type attributes)
4780 -- E_Exception
4781 -- Esize (Uint12)
4782 -- Alignment (Uint14)
4783 -- Renamed_Entity (Node18)
4784 -- Register_Exception_Call (Node20)
4785 -- Interface_Name (Node21)
4786 -- Exception_Code (Uint22)
4787 -- Discard_Names (Flag88)
4788 -- Is_VMS_Exception (Flag133)
4789 -- Is_Raised (Flag224)
4791 -- E_Exception_Type
4792 -- Equivalent_Type (Node18)
4793 -- (plus type attributes)
4795 -- E_Floating_Point_Type
4796 -- E_Floating_Point_Subtype
4797 -- Digits_Value (Uint17)
4798 -- Scalar_Range (Node20)
4799 -- Type_Low_Bound (synth)
4800 -- Type_High_Bound (synth)
4801 -- (plus type attributes)
4803 -- E_Function
4804 -- E_Generic_Function
4805 -- Mechanism (Uint8) (Mechanism_Type)
4806 -- Renaming_Map (Uint9)
4807 -- Handler_Records (List10) (non-generic case only)
4808 -- Protected_Body_Subprogram (Node11)
4809 -- Next_Inlined_Subprogram (Node12)
4810 -- Corresponding_Equality (Node13) (implicit /= only)
4811 -- Elaboration_Entity (Node13) (all other cases)
4812 -- First_Optional_Parameter (Node14) (non-generic case only)
4813 -- DT_Position (Uint15)
4814 -- DTC_Entity (Node16)
4815 -- First_Entity (Node17)
4816 -- Alias (Node18) (non-generic case only)
4817 -- Renamed_Entity (Node18) (generic case only)
4818 -- Finalization_Chain_Entity (Node19)
4819 -- Last_Entity (Node20)
4820 -- Interface_Name (Node21)
4821 -- Scope_Depth_Value (Uint22)
4822 -- Generic_Renamings (Elist23) (for an instance)
4823 -- Inner_Instances (Elist23) (generic function only)
4824 -- Privals_Chain (Elist23) (protected func only)
4825 -- Abstract_Interface_Alias (Node25)
4826 -- Overridden_Operation (Node26)
4827 -- Extra_Formals (Node28)
4828 -- Body_Needed_For_SAL (Flag40)
4829 -- Elaboration_Entity_Required (Flag174)
4830 -- Function_Returns_With_DSP (Flag169)
4831 -- Default_Expressions_Processed (Flag108)
4832 -- Delay_Cleanups (Flag114)
4833 -- Delay_Subprogram_Descriptors (Flag50)
4834 -- Discard_Names (Flag88)
4835 -- Has_Completion (Flag26)
4836 -- Has_Controlling_Result (Flag98)
4837 -- Has_Master_Entity (Flag21)
4838 -- Has_Missing_Return (Flag142)
4839 -- Has_Nested_Block_With_Handler (Flag101)
4840 -- Has_Recursive_Call (Flag143)
4841 -- Has_Subprogram_Descriptor (Flag93)
4842 -- Is_Abstract_Subprogram (Flag19) (non-generic case only)
4843 -- Is_Called (Flag102) (non-generic case only)
4844 -- Is_Constructor (Flag76)
4845 -- Is_Discrim_SO_Function (Flag176)
4846 -- Is_Eliminated (Flag124)
4847 -- Is_Instantiated (Flag126) (generic case only)
4848 -- Is_Intrinsic_Subprogram (Flag64)
4849 -- Is_Machine_Code_Subprogram (Flag137) (non-generic case only)
4850 -- Is_Overriding_Operation (Flag39) (non-generic case only)
4851 -- Is_Primitive (Flag218)
4852 -- Is_Private_Descendant (Flag53)
4853 -- Is_Pure (Flag44)
4854 -- Is_Thunk (Flag225)
4855 -- Is_Visible_Child_Unit (Flag116)
4856 -- Needs_No_Actuals (Flag22)
4857 -- Requires_Overriding (Flag213) (non-generic case only)
4858 -- Return_Present (Flag54)
4859 -- Returns_By_Ref (Flag90)
4860 -- Sec_Stack_Needed_For_Return (Flag167)
4861 -- Uses_Sec_Stack (Flag95)
4862 -- Address_Clause (synth)
4863 -- First_Formal (synth)
4864 -- First_Formal_With_Extras (synth)
4865 -- Number_Formals (synth)
4866 -- Scope_Depth (synth)
4868 -- E_General_Access_Type
4869 -- Storage_Size_Variable (Node15) (base type only)
4870 -- Master_Id (Node17)
4871 -- Directly_Designated_Type (Node20)
4872 -- Associated_Storage_Pool (Node22) (base type only)
4873 -- Associated_Final_Chain (Node23)
4874 -- (plus type attributes)
4876 -- E_Generic_In_Parameter
4877 -- E_Generic_In_Out_Parameter
4878 -- Current_Value (Node9) (always Empty)
4879 -- Entry_Component (Node11)
4880 -- Actual_Subtype (Node17)
4881 -- Renamed_Object (Node18) (always Empty)
4882 -- Default_Value (Node20)
4883 -- Protected_Formal (Node22)
4884 -- Is_Controlling_Formal (Flag97)
4885 -- Is_Return_Object (Flag209)
4886 -- Parameter_Mode (synth)
4888 -- E_Incomplete_Type
4889 -- E_Incomplete_Subtype
4890 -- Non_Limited_View (Node17)
4891 -- Private_Dependents (Elist18)
4892 -- Discriminant_Constraint (Elist21)
4893 -- Stored_Constraint (Elist23)
4894 -- First_Discriminant (synth)
4895 -- First_Stored_Discriminant (synth)
4896 -- (plus type attributes)
4898 -- E_In_Parameter
4899 -- E_In_Out_Parameter
4900 -- E_Out_Parameter
4901 -- Mechanism (Uint8) (Mechanism_Type)
4902 -- Current_Value (Node9)
4903 -- Discriminal_Link (Node10) (discriminals only)
4904 -- Entry_Component (Node11)
4905 -- Esize (Uint12)
4906 -- Extra_Accessibility (Node13)
4907 -- Alignment (Uint14)
4908 -- Extra_Formal (Node15)
4909 -- Unset_Reference (Node16)
4910 -- Actual_Subtype (Node17)
4912 -- Renamed_Object (Node18)
4913 -- Spec_Entity (Node19)
4914 -- Default_Value (Node20)
4915 -- Default_Expr_Function (Node21)
4916 -- Protected_Formal (Node22)
4917 -- Extra_Constrained (Node23)
4918 -- Last_Assignment (Node26) (OUT, IN-OUT only)
4919 -- Has_Initial_Value (Flag219)
4920 -- Is_Controlling_Formal (Flag97)
4921 -- Is_Optional_Parameter (Flag134)
4922 -- Low_Bound_Known (Flag205)
4923 -- Is_Return_Object (Flag209)
4924 -- Parameter_Mode (synth)
4926 -- E_Label
4927 -- Enclosing_Scope (Node18)
4928 -- Reachable (Flag49)
4930 -- E_Limited_Private_Type
4931 -- E_Limited_Private_Subtype
4932 -- First_Entity (Node17)
4933 -- Private_Dependents (Elist18)
4934 -- Underlying_Full_View (Node19)
4935 -- Last_Entity (Node20)
4936 -- Discriminant_Constraint (Elist21)
4937 -- Private_View (Node22)
4938 -- Stored_Constraint (Elist23)
4939 -- Has_Completion (Flag26)
4940 -- First_Discriminant (synth)
4941 -- First_Stored_Discriminant (synth)
4942 -- (plus type attributes)
4944 -- E_Loop
4945 -- Has_Exit (Flag47)
4946 -- Has_Master_Entity (Flag21)
4947 -- Has_Nested_Block_With_Handler (Flag101)
4949 -- E_Modular_Integer_Type
4950 -- E_Modular_Integer_Subtype
4951 -- Modulus (Uint17) (base type only)
4952 -- Original_Array_Type (Node21)
4953 -- Scalar_Range (Node20)
4954 -- Non_Binary_Modulus (Flag58) (base type only)
4955 -- Has_Biased_Representation (Flag139)
4956 -- Type_Low_Bound (synth)
4957 -- Type_High_Bound (synth)
4958 -- (plus type attributes)
4960 -- E_Named_Integer
4961 -- Constant_Value (synth)
4963 -- E_Named_Real
4964 -- Constant_Value (synth)
4966 -- E_Operator
4967 -- First_Entity (Node17)
4968 -- Alias (Node18)
4969 -- Last_Entity (Node20)
4970 -- Is_Machine_Code_Subprogram (Flag137)
4971 -- Is_Pure (Flag44)
4972 -- Is_Intrinsic_Subprogram (Flag64)
4973 -- Is_Overriding_Operation (Flag39)
4974 -- Is_Primitive (Flag218)
4975 -- Is_Thunk (Flag225)
4976 -- Default_Expressions_Processed (Flag108)
4978 -- E_Ordinary_Fixed_Point_Type
4979 -- E_Ordinary_Fixed_Point_Subtype
4980 -- Delta_Value (Ureal18)
4981 -- Scalar_Range (Node20)
4982 -- Small_Value (Ureal21)
4983 -- Has_Small_Clause (Flag67)
4984 -- Type_Low_Bound (synth)
4985 -- Type_High_Bound (synth)
4986 -- (plus type attributes)
4988 -- E_Package
4989 -- E_Generic_Package
4990 -- Dependent_Instances (Elist8) (for an instance)
4991 -- Renaming_Map (Uint9)
4992 -- Handler_Records (List10) (non-generic case only)
4993 -- Generic_Homonym (Node11) (generic case only)
4994 -- Associated_Formal_Package (Node12)
4995 -- Elaboration_Entity (Node13)
4996 -- Shadow_Entities (List14)
4997 -- Related_Instance (Node15) (non-generic case only)
4998 -- First_Private_Entity (Node16)
4999 -- First_Entity (Node17)
5000 -- Renamed_Entity (Node18)
5001 -- Body_Entity (Node19)
5002 -- Last_Entity (Node20)
5003 -- Interface_Name (Node21)
5004 -- Scope_Depth_Value (Uint22)
5005 -- Generic_Renamings (Elist23) (for an instance)
5006 -- Inner_Instances (Elist23) (generic case only)
5007 -- Limited_View (Node23) (non-generic/instance)
5008 -- Current_Use_Clause (Node25)
5009 -- Package_Instantiation (Node26)
5010 -- Delay_Subprogram_Descriptors (Flag50)
5011 -- Body_Needed_For_SAL (Flag40)
5012 -- Discard_Names (Flag88)
5013 -- Elaboration_Entity_Required (Flag174)
5014 -- Elaborate_Body_Desirable (Flag210) (non-generic case only)
5015 -- From_With_Type (Flag159)
5016 -- Has_All_Calls_Remote (Flag79)
5017 -- Has_Completion (Flag26)
5018 -- Has_Forward_Instantiation (Flag175)
5019 -- Has_Master_Entity (Flag21)
5020 -- Has_RACW (Flag214) (non-generic case only)
5021 -- Has_Subprogram_Descriptor (Flag93)
5022 -- In_Package_Body (Flag48)
5023 -- In_Use (Flag8)
5024 -- Is_Instantiated (Flag126)
5025 -- Is_Private_Descendant (Flag53)
5026 -- Is_Visible_Child_Unit (Flag116)
5027 -- Is_Wrapper_Package (synth) (non-generic case only)
5028 -- Scope_Depth (synth)
5029 -- Static_Elaboration_Desired (Flag77) (non-generic case only)
5031 -- E_Package_Body
5032 -- Handler_Records (List10) (non-generic case only)
5033 -- Related_Instance (Node15) (non-generic case only)
5034 -- First_Entity (Node17)
5035 -- Spec_Entity (Node19)
5036 -- Last_Entity (Node20)
5037 -- Scope_Depth_Value (Uint22)
5038 -- Scope_Depth (synth)
5039 -- Delay_Subprogram_Descriptors (Flag50)
5040 -- Has_Subprogram_Descriptor (Flag93)
5042 -- E_Private_Type
5043 -- E_Private_Subtype
5044 -- Primitive_Operations (Elist15)
5045 -- First_Entity (Node17)
5046 -- Private_Dependents (Elist18)
5047 -- Underlying_Full_View (Node19)
5048 -- Last_Entity (Node20)
5049 -- Discriminant_Constraint (Elist21)
5050 -- Private_View (Node22)
5051 -- Stored_Constraint (Elist23)
5052 -- Has_Completion (Flag26)
5053 -- Is_Controlled (Flag42) (base type only)
5054 -- Is_For_Access_Subtype (Flag118) (subtype only)
5055 -- First_Discriminant (synth)
5056 -- First_Stored_Discriminant (synth)
5057 -- (plus type attributes)
5059 -- E_Procedure
5060 -- E_Generic_Procedure
5061 -- Renaming_Map (Uint9)
5062 -- Handler_Records (List10) (non-generic case only)
5063 -- Protected_Body_Subprogram (Node11)
5064 -- Next_Inlined_Subprogram (Node12)
5065 -- Elaboration_Entity (Node13)
5066 -- First_Optional_Parameter (Node14) (non-generic case only)
5067 -- DT_Position (Uint15)
5068 -- DTC_Entity (Node16)
5069 -- First_Entity (Node17)
5070 -- Alias (Node18) (non-generic case only)
5071 -- Renamed_Entity (Node18) (generic case only)
5072 -- Finalization_Chain_Entity (Node19)
5073 -- Last_Entity (Node20)
5074 -- Interface_Name (Node21)
5075 -- Scope_Depth_Value (Uint22)
5076 -- Generic_Renamings (Elist23) (for instance)
5077 -- Inner_Instances (Elist23) (for generic proc)
5078 -- Privals_Chain (Elist23) (for protected proc)
5079 -- Abstract_Interface_Alias (Node25)
5080 -- Static_Initialization (Node26) (init_proc only)
5081 -- Overridden_Operation (Node26)
5082 -- Wrapped_Entity (Node27) (non-generic case only)
5083 -- Extra_Formals (Node28)
5084 -- Body_Needed_For_SAL (Flag40)
5085 -- Delay_Cleanups (Flag114)
5086 -- Discard_Names (Flag88)
5087 -- Elaboration_Entity_Required (Flag174)
5088 -- Function_Returns_With_DSP (Flag169) (false for procedure)
5089 -- Default_Expressions_Processed (Flag108)
5090 -- Delay_Cleanups (Flag114)
5091 -- Delay_Subprogram_Descriptors (Flag50)
5092 -- Discard_Names (Flag88)
5093 -- Has_Completion (Flag26)
5094 -- Has_Master_Entity (Flag21)
5095 -- Has_Nested_Block_With_Handler (Flag101)
5096 -- Has_Subprogram_Descriptor (Flag93)
5097 -- Is_Visible_Child_Unit (Flag116)
5098 -- Is_Abstract_Subprogram (Flag19) (non-generic case only)
5099 -- Is_Asynchronous (Flag81)
5100 -- Is_Called (Flag102) (non-generic subprog)
5101 -- Is_Constructor (Flag76)
5102 -- Is_Eliminated (Flag124)
5103 -- Is_Instantiated (Flag126) (generic case only)
5104 -- Is_Interrupt_Handler (Flag89)
5105 -- Is_Intrinsic_Subprogram (Flag64)
5106 -- Is_Machine_Code_Subprogram (Flag137) (non-generic case only)
5107 -- Is_Null_Init_Proc (Flag178)
5108 -- Is_Overriding_Operation (Flag39) (non-generic case only)
5109 -- Is_Primitive (Flag218)
5110 -- Is_Primitive_Wrapper (Flag195) (non-generic case only)
5111 -- Is_Private_Descendant (Flag53)
5112 -- Is_Pure (Flag44)
5113 -- Is_Thunk (Flag225)
5114 -- Is_Valued_Procedure (Flag127)
5115 -- Is_Visible_Child_Unit (Flag116)
5116 -- Needs_No_Actuals (Flag22)
5117 -- No_Return (Flag113)
5118 -- Requires_Overriding (Flag213) (non-generic case only)
5119 -- Sec_Stack_Needed_For_Return (Flag167)
5120 -- Address_Clause (synth)
5121 -- First_Formal (synth)
5122 -- First_Formal_With_Extras (synth)
5123 -- Number_Formals (synth)
5124 -- Delay_Cleanups (Flag114)
5125 -- Discard_Names (Flag88)
5127 -- E_Protected_Body
5128 -- Object_Ref (Node17)
5129 -- (any others??? First/Last Entity, Scope_Depth???)
5131 -- E_Protected_Object
5133 -- E_Protected_Type
5134 -- E_Protected_Subtype
5135 -- Entry_Bodies_Array (Node15)
5136 -- First_Private_Entity (Node16)
5137 -- First_Entity (Node17)
5138 -- Corresponding_Record_Type (Node18)
5139 -- Finalization_Chain_Entity (Node19)
5140 -- Last_Entity (Node20)
5141 -- Discriminant_Constraint (Elist21)
5142 -- Scope_Depth_Value (Uint22)
5143 -- Scope_Depth (synth)
5144 -- Stored_Constraint (Elist23)
5145 -- Has_Interrupt_Handler (synth)
5146 -- Sec_Stack_Needed_For_Return (Flag167) ???
5147 -- Uses_Sec_Stack (Flag95) ???
5148 -- Has_Entries (synth)
5149 -- Number_Entries (synth)
5151 -- E_Record_Type
5152 -- E_Record_Subtype
5153 -- Primitive_Operations (Elist15)
5154 -- Access_Disp_Table (Elist16) (base type only)
5155 -- Dispatch_Table_Wrapper (Node26) (base type only)
5156 -- Cloned_Subtype (Node16) (subtype case only)
5157 -- First_Entity (Node17)
5158 -- Corresponding_Concurrent_Type (Node18)
5159 -- Parent_Subtype (Node19)
5160 -- Last_Entity (Node20)
5161 -- Discriminant_Constraint (Elist21)
5162 -- Corresponding_Remote_Type (Node22)
5163 -- Stored_Constraint (Elist23)
5164 -- Abstract_Interfaces (Elist25)
5165 -- Component_Alignment (special) (base type only)
5166 -- C_Pass_By_Copy (Flag125) (base type only)
5167 -- Has_Dispatch_Table (Flag220) (base tagged type only)
5168 -- Has_External_Tag_Rep_Clause (Flag110)
5169 -- Has_Record_Rep_Clause (Flag65) (base type only)
5170 -- Has_Static_Discriminants (Flag211) (subtype only)
5171 -- Is_Class_Wide_Equivalent_Type (Flag35)
5172 -- Is_Concurrent_Record_Type (Flag20)
5173 -- Is_Constrained (Flag12)
5174 -- Is_Controlled (Flag42) (base type only)
5175 -- Is_Interface (Flag186)
5176 -- Is_Limited_Interface (Flag197)
5177 -- Reverse_Bit_Order (Flag164) (base type only)
5178 -- First_Component (synth)
5179 -- First_Component_Or_Discriminant (synth)
5180 -- First_Discriminant (synth)
5181 -- First_Stored_Discriminant (synth)
5182 -- First_Tag_Component (synth)
5183 -- (plus type attributes)
5185 -- E_Record_Type_With_Private
5186 -- E_Record_Subtype_With_Private
5187 -- Primitive_Operations (Elist15)
5188 -- Access_Disp_Table (Elist16) (base type only)
5189 -- Dispatch_Table_Wrapper (Node26) (base type only)
5190 -- First_Entity (Node17)
5191 -- Private_Dependents (Elist18)
5192 -- Underlying_Full_View (Node19)
5193 -- Last_Entity (Node20)
5194 -- Discriminant_Constraint (Elist21)
5195 -- Private_View (Node22)
5196 -- Stored_Constraint (Elist23)
5197 -- Abstract_Interfaces (Elist25)
5198 -- Has_Completion (Flag26)
5199 -- Has_Record_Rep_Clause (Flag65) (base type only)
5200 -- Has_External_Tag_Rep_Clause (Flag110)
5201 -- Is_Concurrent_Record_Type (Flag20)
5202 -- Is_Constrained (Flag12)
5203 -- Is_Controlled (Flag42) (base type only)
5204 -- Is_Interface (Flag186)
5205 -- Is_Limited_Interface (Flag197)
5206 -- Reverse_Bit_Order (Flag164) (base type only)
5207 -- First_Component (synth)
5208 -- First_Component_Or_Discriminant (synth)
5209 -- First_Discriminant (synth)
5210 -- First_Stored_Discriminant (synth)
5211 -- First_Tag_Component (synth)
5212 -- (plus type attributes)
5214 -- E_Return_Statement
5215 -- Return_Applies_To (Node8)
5216 -- Finalization_Chain_Entity (Node19)
5218 -- E_Signed_Integer_Type
5219 -- E_Signed_Integer_Subtype
5220 -- Scalar_Range (Node20)
5221 -- Has_Biased_Representation (Flag139)
5222 -- Type_Low_Bound (synth)
5223 -- Type_High_Bound (synth)
5224 -- (plus type attributes)
5226 -- E_String_Type
5227 -- E_String_Subtype
5228 -- First_Index (Node17)
5229 -- Component_Type (Node20) (base type only)
5230 -- Is_Constrained (Flag12)
5231 -- Next_Index (synth)
5232 -- Number_Dimensions (synth)
5233 -- (plus type attributes)
5235 -- E_String_Literal_Subtype
5236 -- String_Literal_Low_Bound (Node15)
5237 -- String_Literal_Length (Uint16)
5238 -- First_Index (Node17) (always Empty)
5239 -- Packed_Array_Type (Node23)
5240 -- (plus type attributes)
5242 -- E_Subprogram_Body
5243 -- Mechanism (Uint8)
5244 -- First_Entity (Node17)
5245 -- Last_Entity (Node20)
5246 -- Scope_Depth_Value (Uint22)
5247 -- Scope_Depth (synth)
5249 -- E_Subprogram_Type
5250 -- Directly_Designated_Type (Node20)
5251 -- First_Formal (synth)
5252 -- First_Formal_With_Extras (synth)
5253 -- Number_Formals (synth)
5254 -- Function_Returns_With_DSP (Flag169)
5255 -- (plus type attributes)
5257 -- E_Task_Body
5258 -- (any others??? First/Last Entity, Scope_Depth???)
5260 -- E_Task_Type
5261 -- E_Task_Subtype
5262 -- Storage_Size_Variable (Node15) (base type only)
5263 -- First_Private_Entity (Node16)
5264 -- First_Entity (Node17)
5265 -- Corresponding_Record_Type (Node18)
5266 -- Finalization_Chain_Entity (Node19)
5267 -- Last_Entity (Node20)
5268 -- Discriminant_Constraint (Elist21)
5269 -- Scope_Depth_Value (Uint22)
5270 -- Scope_Depth (synth)
5271 -- Stored_Constraint (Elist23)
5272 -- Task_Body_Procedure (Node25)
5273 -- Delay_Cleanups (Flag114)
5274 -- Has_Master_Entity (Flag21)
5275 -- Has_Storage_Size_Clause (Flag23) (base type only)
5276 -- Uses_Sec_Stack (Flag95) ???
5277 -- Sec_Stack_Needed_For_Return (Flag167) ???
5278 -- Has_Entries (synth)
5279 -- Number_Entries (synth)
5280 -- (plus type attributes)
5282 -- E_Variable
5283 -- Hiding_Loop_Variable (Node8)
5284 -- Current_Value (Node9)
5285 -- Esize (Uint12)
5286 -- Extra_Accessibility (Node13)
5287 -- Alignment (Uint14)
5288 -- Shared_Var_Read_Proc (Node15)
5289 -- Unset_Reference (Node16)
5290 -- Actual_Subtype (Node17)
5291 -- Renamed_Object (Node18)
5292 -- Size_Check_Code (Node19)
5293 -- Interface_Name (Node21)
5294 -- Shared_Var_Assign_Proc (Node22)
5295 -- Extra_Constrained (Node23)
5296 -- Debug_Renaming_Link (Node25)
5297 -- Last_Assignment (Node26)
5298 -- Has_Alignment_Clause (Flag46)
5299 -- Has_Atomic_Components (Flag86)
5300 -- Has_Biased_Representation (Flag139)
5301 -- Has_Initial_Value (Flag219)
5302 -- Has_Size_Clause (Flag29)
5303 -- Has_Volatile_Components (Flag87)
5304 -- Is_Atomic (Flag85)
5305 -- Is_Eliminated (Flag124)
5306 -- Is_Shared_Passive (Flag60)
5307 -- Is_True_Constant (Flag163)
5308 -- Is_Volatile (Flag16)
5309 -- Treat_As_Volatile (Flag41)
5310 -- Is_Return_Object (Flag209)
5311 -- Has_Up_Level_Access (Flag215)
5312 -- Address_Clause (synth)
5313 -- Alignment_Clause (synth)
5314 -- Constant_Value (synth)
5315 -- Size_Clause (synth)
5317 -- E_Void
5318 -- Since E_Void is the initial Ekind value of an entity when it is first
5319 -- created, one might expect that no attributes would be defined on such
5320 -- an entity until its Ekind field is set. However, in practice, there
5321 -- are many instances in which fields of an E_Void entity are set in the
5322 -- code prior to setting the Ekind field. This is not well documented or
5323 -- well controlled, and needs cleaning up later. Meanwhile, the access
5324 -- procedures in the body of Einfo permit many, but not all, attributes
5325 -- to be applied to an E_Void entity, precisely so that this kind of
5326 -- pre-setting of attributes works. This is really a hole in the dynamic
5327 -- type checking, since there is no assurance that the eventual Ekind
5328 -- value will be appropriate for the attributes set, and the consequence
5329 -- is that the dynamic type checking in the Einfo body is unnecessarily
5330 -- weak. To be looked at systematically some time ???
5332 ---------------------------------
5333 -- Component_Alignment Control --
5334 ---------------------------------
5336 -- There are four types of alignment possible for array and record
5337 -- types, and a field in the type entities contains a value of the
5338 -- following type indicating which alignment choice applies. For full
5339 -- details of the meaning of these aligment types, see description
5340 -- of the Component_Alignment pragma
5342 type Component_Alignment_Kind is (
5343 Calign_Default, -- default alignment
5344 Calign_Component_Size, -- natural alignment for component size
5345 Calign_Component_Size_4, -- natural for size <= 4, 4 for size >= 4
5346 Calign_Storage_Unit); -- all components byte aligned
5348 ---------------
5349 -- Iterators --
5350 ---------------
5352 -- In addition to attributes that are stored as plain data, other
5353 -- attributes are procedural, and require some small amount of
5354 -- computation. Of course, from the point of view of a user of this
5355 -- package, the distinction is not visible (even the field information
5356 -- provided below should be disregarded, as it is subject to change
5357 -- without notice!). A number of attributes appear as lists: lists of
5358 -- formals, lists of actuals, of discriminants, etc. For these, pairs
5359 -- of functions are defined, which take the form:
5361 -- function First_Thing (E : Enclosing_Construct) return Thing;
5362 -- function Next_Thing (T : Thing) return Thing;
5364 -- The end of iteration is always signaled by a value of Empty, so that
5365 -- loops over these chains invariably have the form:
5367 -- This : Thing;
5368 -- ...
5369 -- This := First_Thing (E);
5371 -- while Present (This) loop
5372 -- Do_Something_With (This);
5373 -- ...
5374 -- This := Next_Thing (This);
5375 -- end loop;
5377 -----------------------------------
5378 -- Handling of Check Suppression --
5379 -----------------------------------
5381 -- There are three ways that checks can be suppressed:
5383 -- 1. At the command line level
5384 -- 2. At the scope level.
5385 -- 3. At the entity level.
5387 -- See spec of Sem in sem.ads for details of the data structures used
5388 -- to keep track of these various methods for suppressing checks.
5390 -------------------------------
5391 -- Handling of Discriminants --
5392 -------------------------------
5394 -- During semantic processing, discriminants are separate entities which
5395 -- reflect the semantic properties and allowed usage of discriminants in
5396 -- the language.
5398 -- In the case of discriminants used as bounds, the references are handled
5399 -- directly, since special processing is needed in any case. However, there
5400 -- are two circumstances in which discriminants are referenced in a quite
5401 -- general manner, like any other variables:
5403 -- In initialization expressions for records. Note that the expressions
5404 -- used in Priority, Storage_Size, and Task_Info pragmas are effectively
5405 -- in this category, since these pragmas are converted to initialized
5406 -- record fields in the Corresponding_Record_Type.
5408 -- In task and protected bodies, where the discriminant values may be
5409 -- referenced freely within these bodies. Discriminants can also appear
5410 -- in bounds of entry families and in defaults of operations.
5412 -- In both these cases, the discriminants must be treated essentially as
5413 -- objects. The following approach is used to simplify and minimize the
5414 -- special processing that is required.
5416 -- When a record type with discriminants is processed, the semantic
5417 -- processing creates the entities for the discriminants. It also creates
5418 -- an additional set of entities, called discriminals, one for each of
5419 -- the discriminants, and the Discriminal field of the discriminant entity
5420 -- points to this additional entity, which is initially created as an
5421 -- uninitialized (E_Void) entity.
5423 -- During expansion of expressions, any discriminant reference is replaced
5424 -- by a reference to the corresponding discriminal. When the initialization
5425 -- procedure for the record is created (there will always be one, since
5426 -- discriminants are present, see Exp_Ch3 for further details), the
5427 -- discriminals are used as the entities for the formal parameters of
5428 -- this initialization procedure. The references to these discriminants
5429 -- have already been replaced by references to these discriminals, which
5430 -- are now the formal parameters corresponding to the required objects.
5432 -- In the case of a task or protected body, the semantics similarly
5433 -- creates a set of discriminals for the discriminants of the task or
5434 -- protected type. When the procedure is created for the task body,
5435 -- the parameter passed in is a reference to the task value type, which
5436 -- contains the required discriminant values. The expander creates a
5437 -- set of declarations of the form:
5439 -- discriminal : constant dtype renames _Task.discriminant;
5441 -- where discriminal is the discriminal entity referenced by the task
5442 -- discriminant, and _Task is the task value passed in as the parameter.
5443 -- Again, any references to discriminants in the task body have been
5444 -- replaced by the discriminal reference, which is now an object that
5445 -- contains the required value.
5447 -- This approach for tasks means that two sets of discriminals are needed
5448 -- for a task type, one for the initialization procedure, and one for the
5449 -- task body. This works out nicely, since the semantics allocates one set
5450 -- for the task itself, and one set for the corresponding record.
5452 -- The one bit of trickiness arises in making sure that the right set of
5453 -- discriminals is used at the right time. First the task definition is
5454 -- processed. Any references to discriminants here are replaced by the
5455 -- the corresponding *task* discriminals (the record type doesn't even
5456 -- exist yet, since it is constructed as part of the expansion of the
5457 -- task declaration, which happens after the semantic processing of the
5458 -- task definition). The discriminants to be used for the corresponding
5459 -- record are created at the same time as the other discriminals, and
5460 -- held in the CR_Discriminant field of the discriminant. A use of the
5461 -- discriminant in a bound for an entry family is replaced with the CR_
5462 -- discriminant because it controls the bound of the entry queue array
5463 -- which is a component of the corresponding record.
5465 -- Just before the record initialization routine is constructed, the
5466 -- expander exchanges the task and record discriminals. This has two
5467 -- effects. First the generation of the record initialization routine
5468 -- uses the discriminals that are now on the record, which is the set
5469 -- that used to be on the task, which is what we want.
5471 -- Second, a new set of (so far unused) discriminals is now on the task
5472 -- discriminants, and it is this set that will be used for expanding the
5473 -- task body, and also for the discriminal declarations at the start of
5474 -- the task body.
5476 ---------------------------------------
5477 -- Private data in protected objects --
5478 ---------------------------------------
5480 -- Private object declarations in protected types pose problems
5481 -- similar to those of discriminants. They are expanded to components
5482 -- of a record which is passed as the parameter "_object" to expanded
5483 -- forms of all protected operations. As with discriminants, timing
5484 -- of this expansion is a problem. The sequence of statements for a
5485 -- protected operation is expanded before the operation itself, so the
5486 -- formal parameter for the record object containing the private data
5487 -- does not exist when the references to that data are expanded.
5489 -- For this reason, private data is handled in the same way as
5490 -- discriminants, expanding references to private data in protected
5491 -- operations (which appear as components) to placeholders which will
5492 -- eventually become renamings of the private selected components
5493 -- of the "_object" formal parameter. These placeholders are called
5494 -- "privals", by analogy to the "discriminals" used to implement
5495 -- discriminants. They are attached to the component declaration nodes
5496 -- representing the private object declarations of the protected type.
5498 -- As with discriminals, each protected subprogram needs a unique set
5499 -- of privals, since they must refer to renamings of components of a
5500 -- formal parameter of that operation. Entry bodies need another set,
5501 -- which they all share and which is associated with renamings in the
5502 -- Service_Entries procedure for the protected type (this is not yet
5503 -- implemented???). This means that we must associate a new set of
5504 -- privals (and discriminals) with the private declarations after
5505 -- the body of a protected subprogram is processed.
5507 -- The last complication is the presence of discriminants and discriminated
5508 -- components. In the corresponding record, the components are constrained
5509 -- by the discriminants of the record, but within each protected operation
5510 -- they are constrained by the discriminants of the actual. The actual
5511 -- subtypes of those components are constructed as for other unconstrained
5512 -- formals, but the privals are created before the formal object is added
5513 -- to the parameter list of the protected operation, so they carry the
5514 -- nominal subtype of the original component. After the protected operation
5515 -- is actually created (in the expansion of the protected body) we must
5516 -- patch the types of each prival occurrence with the proper actual subtype
5517 -- which is by now set. The Privals_Chain is used for this patching.
5519 -------------------
5520 -- Type Synonyms --
5521 -------------------
5523 -- The following type synonyms are used to tidy up the function and
5524 -- procedure declarations that follow, and also to make it possible
5525 -- to meet the requirement for the XEINFO utility that all function
5526 -- specs must fit on a single source line.
5528 subtype B is Boolean;
5529 subtype C is Component_Alignment_Kind;
5530 subtype E is Entity_Id;
5531 subtype M is Mechanism_Type;
5532 subtype N is Node_Id;
5533 subtype U is Uint;
5534 subtype R is Ureal;
5535 subtype L is Elist_Id;
5536 subtype S is List_Id;
5538 --------------------------------
5539 -- Attribute Access Functions --
5540 --------------------------------
5542 -- All attributes are manipulated through a procedural interface. This
5543 -- section contains the functions used to obtain attribute values which
5544 -- correspond to values in fields or flags in the entity itself.
5546 function Abstract_Interfaces (Id : E) return L;
5547 function Accept_Address (Id : E) return L;
5548 function Access_Disp_Table (Id : E) return L;
5549 function Actual_Subtype (Id : E) return E;
5550 function Address_Taken (Id : E) return B;
5551 function Alias (Id : E) return E;
5552 function Abstract_Interface_Alias (Id : E) return E;
5553 function Alignment (Id : E) return U;
5554 function Associated_Final_Chain (Id : E) return E;
5555 function Associated_Formal_Package (Id : E) return E;
5556 function Associated_Node_For_Itype (Id : E) return N;
5557 function Associated_Storage_Pool (Id : E) return E;
5558 function Barrier_Function (Id : E) return N;
5559 function Block_Node (Id : E) return N;
5560 function Body_Entity (Id : E) return E;
5561 function Body_Needed_For_SAL (Id : E) return B;
5562 function CR_Discriminant (Id : E) return E;
5563 function C_Pass_By_Copy (Id : E) return B;
5564 function Can_Never_Be_Null (Id : E) return B;
5565 function Checks_May_Be_Suppressed (Id : E) return B;
5566 function Class_Wide_Type (Id : E) return E;
5567 function Cloned_Subtype (Id : E) return E;
5568 function Component_Alignment (Id : E) return C;
5569 function Component_Clause (Id : E) return N;
5570 function Component_Bit_Offset (Id : E) return U;
5571 function Component_Size (Id : E) return U;
5572 function Component_Type (Id : E) return E;
5573 function Corresponding_Concurrent_Type (Id : E) return E;
5574 function Corresponding_Discriminant (Id : E) return E;
5575 function Corresponding_Equality (Id : E) return E;
5576 function Corresponding_Record_Type (Id : E) return E;
5577 function Corresponding_Remote_Type (Id : E) return E;
5578 function Current_Use_Clause (Id : E) return E;
5579 function Current_Value (Id : E) return N;
5580 function Debug_Info_Off (Id : E) return B;
5581 function Debug_Renaming_Link (Id : E) return E;
5582 function Dispatch_Table_Wrapper (Id : E) return E;
5583 function DTC_Entity (Id : E) return E;
5584 function DT_Entry_Count (Id : E) return U;
5585 function DT_Offset_To_Top_Func (Id : E) return E;
5586 function DT_Position (Id : E) return U;
5587 function Default_Expr_Function (Id : E) return E;
5588 function Default_Expressions_Processed (Id : E) return B;
5589 function Default_Value (Id : E) return N;
5590 function Delay_Cleanups (Id : E) return B;
5591 function Delay_Subprogram_Descriptors (Id : E) return B;
5592 function Delta_Value (Id : E) return R;
5593 function Dependent_Instances (Id : E) return L;
5594 function Depends_On_Private (Id : E) return B;
5595 function Digits_Value (Id : E) return U;
5596 function Directly_Designated_Type (Id : E) return E;
5597 function Discard_Names (Id : E) return B;
5598 function Discriminal (Id : E) return E;
5599 function Discriminal_Link (Id : E) return E;
5600 function Discriminant_Checking_Func (Id : E) return E;
5601 function Discriminant_Constraint (Id : E) return L;
5602 function Discriminant_Default_Value (Id : E) return N;
5603 function Discriminant_Number (Id : E) return U;
5604 function Elaborate_Body_Desirable (Id : E) return B;
5605 function Elaboration_Entity (Id : E) return E;
5606 function Elaboration_Entity_Required (Id : E) return B;
5607 function Enclosing_Scope (Id : E) return E;
5608 function Entry_Accepted (Id : E) return B;
5609 function Entry_Bodies_Array (Id : E) return E;
5610 function Entry_Cancel_Parameter (Id : E) return E;
5611 function Entry_Component (Id : E) return E;
5612 function Entry_Formal (Id : E) return E;
5613 function Entry_Index_Constant (Id : E) return E;
5614 function Entry_Index_Type (Id : E) return E;
5615 function Entry_Parameters_Type (Id : E) return E;
5616 function Enum_Pos_To_Rep (Id : E) return E;
5617 function Enumeration_Pos (Id : E) return U;
5618 function Enumeration_Rep (Id : E) return U;
5619 function Enumeration_Rep_Expr (Id : E) return N;
5620 function Equivalent_Type (Id : E) return E;
5621 function Esize (Id : E) return U;
5622 function Exception_Code (Id : E) return U;
5623 function Extra_Accessibility (Id : E) return E;
5624 function Extra_Constrained (Id : E) return E;
5625 function Extra_Formal (Id : E) return E;
5626 function Extra_Formals (Id : E) return E;
5627 function Finalization_Chain_Entity (Id : E) return E;
5628 function Finalize_Storage_Only (Id : E) return B;
5629 function First_Entity (Id : E) return E;
5630 function First_Index (Id : E) return N;
5631 function First_Literal (Id : E) return E;
5632 function First_Optional_Parameter (Id : E) return E;
5633 function First_Private_Entity (Id : E) return E;
5634 function First_Rep_Item (Id : E) return N;
5635 function Freeze_Node (Id : E) return N;
5636 function From_With_Type (Id : E) return B;
5637 function Full_View (Id : E) return E;
5638 function Function_Returns_With_DSP (Id : E) return B;
5639 function Generic_Homonym (Id : E) return E;
5640 function Generic_Renamings (Id : E) return L;
5641 function Handler_Records (Id : E) return S;
5642 function Has_Aliased_Components (Id : E) return B;
5643 function Has_Alignment_Clause (Id : E) return B;
5644 function Has_All_Calls_Remote (Id : E) return B;
5645 function Has_Anon_Block_Suffix (Id : E) return B;
5646 function Has_Atomic_Components (Id : E) return B;
5647 function Has_Biased_Representation (Id : E) return B;
5648 function Has_Completion (Id : E) return B;
5649 function Has_Completion_In_Body (Id : E) return B;
5650 function Has_Complex_Representation (Id : E) return B;
5651 function Has_Component_Size_Clause (Id : E) return B;
5652 function Has_Constrained_Partial_View (Id : E) return B;
5653 function Has_Contiguous_Rep (Id : E) return B;
5654 function Has_Controlled_Component (Id : E) return B;
5655 function Has_Controlling_Result (Id : E) return B;
5656 function Has_Convention_Pragma (Id : E) return B;
5657 function Has_Delayed_Freeze (Id : E) return B;
5658 function Has_Discriminants (Id : E) return B;
5659 function Has_Dispatch_Table (Id : E) return B;
5660 function Has_Enumeration_Rep_Clause (Id : E) return B;
5661 function Has_Exit (Id : E) return B;
5662 function Has_External_Tag_Rep_Clause (Id : E) return B;
5663 function Has_Fully_Qualified_Name (Id : E) return B;
5664 function Has_Gigi_Rep_Item (Id : E) return B;
5665 function Has_Homonym (Id : E) return B;
5666 function Has_Initial_Value (Id : E) return B;
5667 function Has_Interrupt_Handler (Id : E) return B;
5668 function Has_Machine_Radix_Clause (Id : E) return B;
5669 function Has_Master_Entity (Id : E) return B;
5670 function Has_Missing_Return (Id : E) return B;
5671 function Has_Nested_Block_With_Handler (Id : E) return B;
5672 function Has_Forward_Instantiation (Id : E) return B;
5673 function Has_Up_Level_Access (Id : E) return B;
5674 function Has_Non_Standard_Rep (Id : E) return B;
5675 function Has_Object_Size_Clause (Id : E) return B;
5676 function Has_Per_Object_Constraint (Id : E) return B;
5677 function Has_Persistent_BSS (Id : E) return B;
5678 function Has_Pragma_Controlled (Id : E) return B;
5679 function Has_Pragma_Elaborate_Body (Id : E) return B;
5680 function Has_Pragma_Inline (Id : E) return B;
5681 function Has_Pragma_Pack (Id : E) return B;
5682 function Has_Pragma_Preelab_Init (Id : E) return B;
5683 function Has_Pragma_Pure (Id : E) return B;
5684 function Has_Pragma_Pure_Function (Id : E) return B;
5685 function Has_Pragma_Unreferenced (Id : E) return B;
5686 function Has_Pragma_Unreferenced_Objects (Id : E) return B;
5687 function Has_Primitive_Operations (Id : E) return B;
5688 function Has_Qualified_Name (Id : E) return B;
5689 function Has_RACW (Id : E) return B;
5690 function Has_Record_Rep_Clause (Id : E) return B;
5691 function Has_Recursive_Call (Id : E) return B;
5692 function Has_Size_Clause (Id : E) return B;
5693 function Has_Small_Clause (Id : E) return B;
5694 function Has_Specified_Layout (Id : E) return B;
5695 function Has_Specified_Stream_Input (Id : E) return B;
5696 function Has_Specified_Stream_Output (Id : E) return B;
5697 function Has_Specified_Stream_Read (Id : E) return B;
5698 function Has_Specified_Stream_Write (Id : E) return B;
5699 function Has_Static_Discriminants (Id : E) return B;
5700 function Has_Storage_Size_Clause (Id : E) return B;
5701 function Has_Stream_Size_Clause (Id : E) return B;
5702 function Has_Subprogram_Descriptor (Id : E) return B;
5703 function Has_Task (Id : E) return B;
5704 function Has_Unchecked_Union (Id : E) return B;
5705 function Has_Unknown_Discriminants (Id : E) return B;
5706 function Has_Volatile_Components (Id : E) return B;
5707 function Has_Xref_Entry (Id : E) return B;
5708 function Hiding_Loop_Variable (Id : E) return E;
5709 function Homonym (Id : E) return E;
5710 function In_Package_Body (Id : E) return B;
5711 function In_Private_Part (Id : E) return B;
5712 function In_Use (Id : E) return B;
5713 function Inner_Instances (Id : E) return L;
5714 function Interface_Name (Id : E) return N;
5715 function Is_AST_Entry (Id : E) return B;
5716 function Is_Abstract_Subprogram (Id : E) return B;
5717 function Is_Abstract_Type (Id : E) return B;
5718 function Is_Local_Anonymous_Access (Id : E) return B;
5719 function Is_Access_Constant (Id : E) return B;
5720 function Is_Ada_2005_Only (Id : E) return B;
5721 function Is_Aliased (Id : E) return B;
5722 function Is_Asynchronous (Id : E) return B;
5723 function Is_Atomic (Id : E) return B;
5724 function Is_Bit_Packed_Array (Id : E) return B;
5725 function Is_CPP_Class (Id : E) return B;
5726 function Is_Called (Id : E) return B;
5727 function Is_Character_Type (Id : E) return B;
5728 function Is_Child_Unit (Id : E) return B;
5729 function Is_Class_Wide_Equivalent_Type (Id : E) return B;
5730 function Is_Compilation_Unit (Id : E) return B;
5731 function Is_Completely_Hidden (Id : E) return B;
5732 function Is_Constr_Subt_For_UN_Aliased (Id : E) return B;
5733 function Is_Constr_Subt_For_U_Nominal (Id : E) return B;
5734 function Is_Constrained (Id : E) return B;
5735 function Is_Constructor (Id : E) return B;
5736 function Is_Controlled (Id : E) return B;
5737 function Is_Controlling_Formal (Id : E) return B;
5738 function Is_Discrim_SO_Function (Id : E) return B;
5739 function Is_Dispatching_Operation (Id : E) return B;
5740 function Is_Eliminated (Id : E) return B;
5741 function Is_Entry_Formal (Id : E) return B;
5742 function Is_Exported (Id : E) return B;
5743 function Is_First_Subtype (Id : E) return B;
5744 function Is_For_Access_Subtype (Id : E) return B;
5745 function Is_Frozen (Id : E) return B;
5746 function Is_Generic_Instance (Id : E) return B;
5747 function Is_Hidden (Id : E) return B;
5748 function Is_Hidden_Open_Scope (Id : E) return B;
5749 function Is_Immediately_Visible (Id : E) return B;
5750 function Is_Imported (Id : E) return B;
5751 function Is_Inlined (Id : E) return B;
5752 function Is_Interface (Id : E) return B;
5753 function Is_Instantiated (Id : E) return B;
5754 function Is_Internal (Id : E) return B;
5755 function Is_Interrupt_Handler (Id : E) return B;
5756 function Is_Intrinsic_Subprogram (Id : E) return B;
5757 function Is_Itype (Id : E) return B;
5758 function Is_Known_Non_Null (Id : E) return B;
5759 function Is_Known_Null (Id : E) return B;
5760 function Is_Known_Valid (Id : E) return B;
5761 function Is_Limited_Composite (Id : E) return B;
5762 function Is_Limited_Interface (Id : E) return B;
5763 function Is_Machine_Code_Subprogram (Id : E) return B;
5764 function Is_Non_Static_Subtype (Id : E) return B;
5765 function Is_Null_Init_Proc (Id : E) return B;
5766 function Is_Obsolescent (Id : E) return B;
5767 function Is_Optional_Parameter (Id : E) return B;
5768 function Is_Package_Body_Entity (Id : E) return B;
5769 function Is_Packed (Id : E) return B;
5770 function Is_Packed_Array_Type (Id : E) return B;
5771 function Is_Potentially_Use_Visible (Id : E) return B;
5772 function Is_Preelaborated (Id : E) return B;
5773 function Is_Primitive (Id : E) return B;
5774 function Is_Primitive_Wrapper (Id : E) return B;
5775 function Is_Private_Composite (Id : E) return B;
5776 function Is_Private_Descendant (Id : E) return B;
5777 function Is_Protected_Interface (Id : E) return B;
5778 function Is_Public (Id : E) return B;
5779 function Is_Pure (Id : E) return B;
5780 function Is_Pure_Unit_Access_Type (Id : E) return B;
5781 function Is_Raised (Id : E) return B;
5782 function Is_Remote_Call_Interface (Id : E) return B;
5783 function Is_Remote_Types (Id : E) return B;
5784 function Is_Renaming_Of_Object (Id : E) return B;
5785 function Is_Return_Object (Id : E) return B;
5786 function Is_Shared_Passive (Id : E) return B;
5787 function Is_Statically_Allocated (Id : E) return B;
5788 function Is_Synchronized_Interface (Id : E) return B;
5789 function Is_Tag (Id : E) return B;
5790 function Is_Tagged_Type (Id : E) return B;
5791 function Is_Task_Interface (Id : E) return B;
5792 function Is_True_Constant (Id : E) return B;
5793 function Is_Unchecked_Union (Id : E) return B;
5794 function Is_Unsigned_Type (Id : E) return B;
5795 function Is_VMS_Exception (Id : E) return B;
5796 function Is_Valued_Procedure (Id : E) return B;
5797 function Is_Visible_Child_Unit (Id : E) return B;
5798 function Is_Visible_Formal (Id : E) return B;
5799 function Is_Volatile (Id : E) return B;
5800 function Itype_Printed (Id : E) return B;
5801 function Kill_Elaboration_Checks (Id : E) return B;
5802 function Kill_Range_Checks (Id : E) return B;
5803 function Kill_Tag_Checks (Id : E) return B;
5804 function Known_To_Have_Preelab_Init (Id : E) return B;
5805 function Last_Assignment (Id : E) return N;
5806 function Last_Entity (Id : E) return E;
5807 function Limited_View (Id : E) return E;
5808 function Lit_Indexes (Id : E) return E;
5809 function Lit_Strings (Id : E) return E;
5810 function Low_Bound_Known (Id : E) return B;
5811 function Machine_Radix_10 (Id : E) return B;
5812 function Master_Id (Id : E) return E;
5813 function Materialize_Entity (Id : E) return B;
5814 function Mechanism (Id : E) return M;
5815 function Modulus (Id : E) return U;
5816 function Must_Be_On_Byte_Boundary (Id : E) return B;
5817 function Must_Have_Preelab_Init (Id : E) return B;
5818 function Needs_Debug_Info (Id : E) return B;
5819 function Needs_No_Actuals (Id : E) return B;
5820 function Never_Set_In_Source (Id : E) return B;
5821 function Next_Inlined_Subprogram (Id : E) return E;
5822 function No_Pool_Assigned (Id : E) return B;
5823 function No_Return (Id : E) return B;
5824 function No_Strict_Aliasing (Id : E) return B;
5825 function Non_Binary_Modulus (Id : E) return B;
5826 function Non_Limited_View (Id : E) return E;
5827 function Nonzero_Is_True (Id : E) return B;
5828 function Normalized_First_Bit (Id : E) return U;
5829 function Normalized_Position (Id : E) return U;
5830 function Normalized_Position_Max (Id : E) return U;
5831 function Object_Ref (Id : E) return E;
5832 function Obsolescent_Warning (Id : E) return N;
5833 function Original_Array_Type (Id : E) return E;
5834 function Original_Record_Component (Id : E) return E;
5835 function Overridden_Operation (Id : E) return E;
5836 function Package_Instantiation (Id : E) return N;
5837 function Packed_Array_Type (Id : E) return E;
5838 function Parent_Subtype (Id : E) return E;
5839 function Primitive_Operations (Id : E) return L;
5840 function Prival (Id : E) return E;
5841 function Privals_Chain (Id : E) return L;
5842 function Private_Dependents (Id : E) return L;
5843 function Private_View (Id : E) return N;
5844 function Protected_Body_Subprogram (Id : E) return E;
5845 function Protected_Formal (Id : E) return E;
5846 function Protected_Operation (Id : E) return E;
5847 function RM_Size (Id : E) return U;
5848 function Reachable (Id : E) return B;
5849 function Referenced (Id : E) return B;
5850 function Referenced_As_LHS (Id : E) return B;
5851 function Referenced_Object (Id : E) return N;
5852 function Register_Exception_Call (Id : E) return N;
5853 function Related_Array_Object (Id : E) return E;
5854 function Related_Instance (Id : E) return E;
5855 function Related_Interface (Id : E) return E;
5856 function Renamed_Entity (Id : E) return N;
5857 function Renamed_Object (Id : E) return N;
5858 function Renaming_Map (Id : E) return U;
5859 function Requires_Overriding (Id : E) return B;
5860 function Return_Present (Id : E) return B;
5861 function Return_Applies_To (Id : E) return N;
5862 function Returns_By_Ref (Id : E) return B;
5863 function Reverse_Bit_Order (Id : E) return B;
5864 function Scalar_Range (Id : E) return N;
5865 function Scale_Value (Id : E) return U;
5866 function Scope_Depth_Value (Id : E) return U;
5867 function Sec_Stack_Needed_For_Return (Id : E) return B;
5868 function Shadow_Entities (Id : E) return S;
5869 function Shared_Var_Assign_Proc (Id : E) return E;
5870 function Shared_Var_Read_Proc (Id : E) return E;
5871 function Size_Check_Code (Id : E) return N;
5872 function Size_Known_At_Compile_Time (Id : E) return B;
5873 function Size_Depends_On_Discriminant (Id : E) return B;
5874 function Small_Value (Id : E) return R;
5875 function Spec_Entity (Id : E) return E;
5876 function Storage_Size_Variable (Id : E) return E;
5877 function Static_Elaboration_Desired (Id : E) return B;
5878 function Static_Initialization (Id : E) return N;
5879 function Stored_Constraint (Id : E) return L;
5880 function Strict_Alignment (Id : E) return B;
5881 function String_Literal_Length (Id : E) return U;
5882 function String_Literal_Low_Bound (Id : E) return N;
5883 function Suppress_Elaboration_Warnings (Id : E) return B;
5884 function Suppress_Init_Proc (Id : E) return B;
5885 function Suppress_Style_Checks (Id : E) return B;
5886 function Suppress_Value_Tracking_On_Call (Id : E) return B;
5887 function Task_Body_Procedure (Id : E) return N;
5888 function Treat_As_Volatile (Id : E) return B;
5889 function Underlying_Full_View (Id : E) return E;
5890 function Universal_Aliasing (Id : E) return B;
5891 function Unset_Reference (Id : E) return N;
5892 function Used_As_Generic_Actual (Id : E) return B;
5893 function Uses_Sec_Stack (Id : E) return B;
5894 function Vax_Float (Id : E) return B;
5895 function Warnings_Off (Id : E) return B;
5896 function Was_Hidden (Id : E) return B;
5897 function Wrapped_Entity (Id : E) return E;
5899 -------------------------------
5900 -- Classification Attributes --
5901 -------------------------------
5903 -- These functions provide a convenient functional notation for testing
5904 -- whether an Ekind value belongs to a specified kind, for example the
5905 -- function Is_Elementary_Type tests if its argument is in Elementary_Kind.
5906 -- In some cases, the test is of an entity attribute (e.g. in the case of
5907 -- Is_Generic_Type where the Ekind does not provide the needed information)
5909 function Is_Access_Type (Id : E) return B;
5910 function Is_Access_Protected_Subprogram_Type (Id : E) return B;
5911 function Is_Array_Type (Id : E) return B;
5912 function Is_Assignable (Id : E) return B;
5913 function Is_Class_Wide_Type (Id : E) return B;
5914 function Is_Composite_Type (Id : E) return B;
5915 function Is_Concurrent_Body (Id : E) return B;
5916 function Is_Concurrent_Record_Type (Id : E) return B;
5917 function Is_Concurrent_Type (Id : E) return B;
5918 function Is_Decimal_Fixed_Point_Type (Id : E) return B;
5919 function Is_Digits_Type (Id : E) return B;
5920 function Is_Descendent_Of_Address (Id : E) return B;
5921 function Is_Discrete_Or_Fixed_Point_Type (Id : E) return B;
5922 function Is_Discrete_Type (Id : E) return B;
5923 function Is_Elementary_Type (Id : E) return B;
5924 function Is_Entry (Id : E) return B;
5925 function Is_Enumeration_Type (Id : E) return B;
5926 function Is_Fixed_Point_Type (Id : E) return B;
5927 function Is_Floating_Point_Type (Id : E) return B;
5928 function Is_Formal (Id : E) return B;
5929 function Is_Formal_Object (Id : E) return B;
5930 function Is_Formal_Subprogram (Id : E) return B;
5931 function Is_Generic_Actual_Type (Id : E) return B;
5932 function Is_Generic_Unit (Id : E) return B;
5933 function Is_Generic_Type (Id : E) return B;
5934 function Is_Generic_Subprogram (Id : E) return B;
5935 function Is_Incomplete_Or_Private_Type (Id : E) return B;
5936 function Is_Incomplete_Type (Id : E) return B;
5937 function Is_Integer_Type (Id : E) return B;
5938 function Is_Limited_Record (Id : E) return B;
5939 function Is_Modular_Integer_Type (Id : E) return B;
5940 function Is_Named_Number (Id : E) return B;
5941 function Is_Numeric_Type (Id : E) return B;
5942 function Is_Object (Id : E) return B;
5943 function Is_Ordinary_Fixed_Point_Type (Id : E) return B;
5944 function Is_Overloadable (Id : E) return B;
5945 function Is_Overriding_Operation (Id : E) return B;
5946 function Is_Private_Type (Id : E) return B;
5947 function Is_Protected_Type (Id : E) return B;
5948 function Is_Real_Type (Id : E) return B;
5949 function Is_Record_Type (Id : E) return B;
5950 function Is_Scalar_Type (Id : E) return B;
5951 function Is_Signed_Integer_Type (Id : E) return B;
5952 function Is_Subprogram (Id : E) return B;
5953 function Is_Task_Type (Id : E) return B;
5954 function Is_Thunk (Id : E) return B;
5955 function Is_Type (Id : E) return B;
5957 -------------------------------------
5958 -- Synthesized Attribute Functions --
5959 -------------------------------------
5961 -- The functions in this section synthesize attributes from the tree,
5962 -- so they do not correspond to defined fields in the entity itself.
5964 function Address_Clause (Id : E) return N;
5965 function Alignment_Clause (Id : E) return N;
5966 function Ancestor_Subtype (Id : E) return E;
5967 function Available_View (Id : E) return E;
5968 function Base_Type (Id : E) return E;
5969 function Constant_Value (Id : E) return N;
5970 function Declaration_Node (Id : E) return N;
5971 function Designated_Type (Id : E) return E;
5972 function Enclosing_Dynamic_Scope (Id : E) return E;
5973 function First_Component (Id : E) return E;
5974 function First_Component_Or_Discriminant (Id : E) return E;
5975 function First_Discriminant (Id : E) return E;
5976 function First_Formal (Id : E) return E;
5977 function First_Formal_With_Extras (Id : E) return E;
5978 function First_Stored_Discriminant (Id : E) return E;
5979 function First_Subtype (Id : E) return E;
5980 function Has_Attach_Handler (Id : E) return B;
5981 function Has_Entries (Id : E) return B;
5982 function Has_Foreign_Convention (Id : E) return B;
5983 function Has_Private_Ancestor (Id : E) return B;
5984 function Has_Private_Declaration (Id : E) return B;
5985 function Implementation_Base_Type (Id : E) return E;
5986 function Is_Always_Inlined (Id : E) return B;
5987 function Is_Boolean_Type (Id : E) return B;
5988 function Is_By_Copy_Type (Id : E) return B;
5989 function Is_By_Reference_Type (Id : E) return B;
5990 function Is_Derived_Type (Id : E) return B;
5991 function Is_Dynamic_Scope (Id : E) return B;
5992 function Is_Indefinite_Subtype (Id : E) return B;
5993 function Is_Limited_Type (Id : E) return B;
5994 function Is_Package_Or_Generic_Package (Id : E) return B;
5995 function Is_Protected_Private (Id : E) return B;
5996 function Is_Protected_Record_Type (Id : E) return B;
5997 function Is_Inherently_Limited_Type (Id : E) return B;
5998 function Is_String_Type (Id : E) return B;
5999 function Is_Task_Record_Type (Id : E) return B;
6000 function Is_Wrapper_Package (Id : E) return B;
6001 function Next_Component (Id : E) return E;
6002 function Next_Component_Or_Discriminant (Id : E) return E;
6003 function Next_Discriminant (Id : E) return E;
6004 function Next_Formal (Id : E) return E;
6005 function Next_Formal_With_Extras (Id : E) return E;
6006 function Next_Literal (Id : E) return E;
6007 function Next_Stored_Discriminant (Id : E) return E;
6008 function Number_Dimensions (Id : E) return Pos;
6009 function Number_Discriminants (Id : E) return Pos;
6010 function Number_Entries (Id : E) return Nat;
6011 function Number_Formals (Id : E) return Pos;
6012 function Parameter_Mode (Id : E) return Formal_Kind;
6013 function Root_Type (Id : E) return E;
6014 function Scope_Depth_Set (Id : E) return B;
6015 function Size_Clause (Id : E) return N;
6016 function Stream_Size_Clause (Id : E) return N;
6017 function First_Tag_Component (Id : E) return E;
6018 function Next_Tag_Component (Id : E) return E;
6019 function Type_High_Bound (Id : E) return N;
6020 function Type_Low_Bound (Id : E) return N;
6021 function Underlying_Type (Id : E) return E;
6023 ----------------------------------------------
6024 -- Type Representation Attribute Predicates --
6025 ----------------------------------------------
6027 -- These predicates test the setting of the indicated attribute. If the
6028 -- value has been set, then Known is True, and Unknown is False. If no
6029 -- value is set, then Known is False and Unknown is True. The Known_Static
6030 -- predicate is true only if the value is set (Known) and is set to a
6031 -- compile time known value. Note that in the case of Alignment and
6032 -- Normalized_First_Bit, dynamic values are not possible, so we do not
6033 -- need a separate Known_Static calls in these cases. The not set (unknown
6034 -- values are as follows:
6036 -- Alignment Uint_0 or No_Uint
6037 -- Component_Size Uint_0 or No_Uint
6038 -- Component_Bit_Offset No_Uint
6039 -- Digits_Value Uint_0 or No_Uint
6040 -- Esize Uint_0 or No_Uint
6041 -- Normalized_First_Bit No_Uint
6042 -- Normalized_Position No_Uint
6043 -- Normalized_Position_Max No_Uint
6044 -- RM_Size Uint_0 or No_Uint
6046 -- It would be cleaner to use No_Uint in all these cases, but historically
6047 -- we chose to use Uint_0 at first, and the change over will take time ???
6048 -- This is particularly true for the RM_Size field, where a value of zero
6049 -- is legitimate. We deal with this by a nasty kludge that knows that the
6050 -- value is always known static for discrete types (and no other types can
6051 -- have an RM_Size value of zero).
6053 function Known_Alignment (E : Entity_Id) return B;
6054 function Known_Component_Bit_Offset (E : Entity_Id) return B;
6055 function Known_Component_Size (E : Entity_Id) return B;
6056 function Known_Esize (E : Entity_Id) return B;
6057 function Known_Normalized_First_Bit (E : Entity_Id) return B;
6058 function Known_Normalized_Position (E : Entity_Id) return B;
6059 function Known_Normalized_Position_Max (E : Entity_Id) return B;
6060 function Known_RM_Size (E : Entity_Id) return B;
6062 function Known_Static_Component_Bit_Offset (E : Entity_Id) return B;
6063 function Known_Static_Component_Size (E : Entity_Id) return B;
6064 function Known_Static_Esize (E : Entity_Id) return B;
6065 function Known_Static_Normalized_First_Bit (E : Entity_Id) return B;
6066 function Known_Static_Normalized_Position (E : Entity_Id) return B;
6067 function Known_Static_Normalized_Position_Max (E : Entity_Id) return B;
6068 function Known_Static_RM_Size (E : Entity_Id) return B;
6070 function Unknown_Alignment (E : Entity_Id) return B;
6071 function Unknown_Component_Bit_Offset (E : Entity_Id) return B;
6072 function Unknown_Component_Size (E : Entity_Id) return B;
6073 function Unknown_Esize (E : Entity_Id) return B;
6074 function Unknown_Normalized_First_Bit (E : Entity_Id) return B;
6075 function Unknown_Normalized_Position (E : Entity_Id) return B;
6076 function Unknown_Normalized_Position_Max (E : Entity_Id) return B;
6077 function Unknown_RM_Size (E : Entity_Id) return B;
6079 ------------------------------
6080 -- Attribute Set Procedures --
6081 ------------------------------
6083 procedure Set_Abstract_Interfaces (Id : E; V : L);
6084 procedure Set_Accept_Address (Id : E; V : L);
6085 procedure Set_Access_Disp_Table (Id : E; V : L);
6086 procedure Set_Dispatch_Table_Wrapper (Id : E; V : E);
6087 procedure Set_Actual_Subtype (Id : E; V : E);
6088 procedure Set_Address_Taken (Id : E; V : B := True);
6089 procedure Set_Alias (Id : E; V : E);
6090 procedure Set_Abstract_Interface_Alias (Id : E; V : E);
6091 procedure Set_Alignment (Id : E; V : U);
6092 procedure Set_Associated_Final_Chain (Id : E; V : E);
6093 procedure Set_Associated_Formal_Package (Id : E; V : E);
6094 procedure Set_Associated_Node_For_Itype (Id : E; V : N);
6095 procedure Set_Associated_Storage_Pool (Id : E; V : E);
6096 procedure Set_Barrier_Function (Id : E; V : N);
6097 procedure Set_Block_Node (Id : E; V : N);
6098 procedure Set_Body_Entity (Id : E; V : E);
6099 procedure Set_Body_Needed_For_SAL (Id : E; V : B := True);
6100 procedure Set_CR_Discriminant (Id : E; V : E);
6101 procedure Set_C_Pass_By_Copy (Id : E; V : B := True);
6102 procedure Set_Can_Never_Be_Null (Id : E; V : B := True);
6103 procedure Set_Checks_May_Be_Suppressed (Id : E; V : B := True);
6104 procedure Set_Class_Wide_Type (Id : E; V : E);
6105 procedure Set_Cloned_Subtype (Id : E; V : E);
6106 procedure Set_Component_Alignment (Id : E; V : C);
6107 procedure Set_Component_Bit_Offset (Id : E; V : U);
6108 procedure Set_Component_Clause (Id : E; V : N);
6109 procedure Set_Component_Size (Id : E; V : U);
6110 procedure Set_Component_Type (Id : E; V : E);
6111 procedure Set_Corresponding_Concurrent_Type (Id : E; V : E);
6112 procedure Set_Corresponding_Discriminant (Id : E; V : E);
6113 procedure Set_Corresponding_Equality (Id : E; V : E);
6114 procedure Set_Corresponding_Record_Type (Id : E; V : E);
6115 procedure Set_Corresponding_Remote_Type (Id : E; V : E);
6116 procedure Set_Current_Use_Clause (Id : E; V : E);
6117 procedure Set_Current_Value (Id : E; V : N);
6118 procedure Set_Debug_Info_Off (Id : E; V : B := True);
6119 procedure Set_Debug_Renaming_Link (Id : E; V : E);
6120 procedure Set_DTC_Entity (Id : E; V : E);
6121 procedure Set_DT_Entry_Count (Id : E; V : U);
6122 procedure Set_DT_Offset_To_Top_Func (Id : E; V : E);
6123 procedure Set_DT_Position (Id : E; V : U);
6124 procedure Set_Default_Expr_Function (Id : E; V : E);
6125 procedure Set_Default_Expressions_Processed (Id : E; V : B := True);
6126 procedure Set_Default_Value (Id : E; V : N);
6127 procedure Set_Delay_Cleanups (Id : E; V : B := True);
6128 procedure Set_Delay_Subprogram_Descriptors (Id : E; V : B := True);
6129 procedure Set_Delta_Value (Id : E; V : R);
6130 procedure Set_Dependent_Instances (Id : E; V : L);
6131 procedure Set_Depends_On_Private (Id : E; V : B := True);
6132 procedure Set_Digits_Value (Id : E; V : U);
6133 procedure Set_Directly_Designated_Type (Id : E; V : E);
6134 procedure Set_Discard_Names (Id : E; V : B := True);
6135 procedure Set_Discriminal (Id : E; V : E);
6136 procedure Set_Discriminal_Link (Id : E; V : E);
6137 procedure Set_Discriminant_Checking_Func (Id : E; V : E);
6138 procedure Set_Discriminant_Constraint (Id : E; V : L);
6139 procedure Set_Discriminant_Default_Value (Id : E; V : N);
6140 procedure Set_Discriminant_Number (Id : E; V : U);
6141 procedure Set_Elaborate_Body_Desirable (Id : E; V : B := True);
6142 procedure Set_Elaboration_Entity (Id : E; V : E);
6143 procedure Set_Elaboration_Entity_Required (Id : E; V : B := True);
6144 procedure Set_Enclosing_Scope (Id : E; V : E);
6145 procedure Set_Entry_Accepted (Id : E; V : B := True);
6146 procedure Set_Entry_Bodies_Array (Id : E; V : E);
6147 procedure Set_Entry_Cancel_Parameter (Id : E; V : E);
6148 procedure Set_Entry_Component (Id : E; V : E);
6149 procedure Set_Entry_Formal (Id : E; V : E);
6150 procedure Set_Entry_Index_Constant (Id : E; V : E);
6151 procedure Set_Entry_Parameters_Type (Id : E; V : E);
6152 procedure Set_Enum_Pos_To_Rep (Id : E; V : E);
6153 procedure Set_Enumeration_Pos (Id : E; V : U);
6154 procedure Set_Enumeration_Rep (Id : E; V : U);
6155 procedure Set_Enumeration_Rep_Expr (Id : E; V : N);
6156 procedure Set_Equivalent_Type (Id : E; V : E);
6157 procedure Set_Esize (Id : E; V : U);
6158 procedure Set_Exception_Code (Id : E; V : U);
6159 procedure Set_Extra_Accessibility (Id : E; V : E);
6160 procedure Set_Extra_Constrained (Id : E; V : E);
6161 procedure Set_Extra_Formal (Id : E; V : E);
6162 procedure Set_Extra_Formals (Id : E; V : E);
6163 procedure Set_Finalization_Chain_Entity (Id : E; V : E);
6164 procedure Set_Finalize_Storage_Only (Id : E; V : B := True);
6165 procedure Set_First_Entity (Id : E; V : E);
6166 procedure Set_First_Index (Id : E; V : N);
6167 procedure Set_First_Literal (Id : E; V : E);
6168 procedure Set_First_Optional_Parameter (Id : E; V : E);
6169 procedure Set_First_Private_Entity (Id : E; V : E);
6170 procedure Set_First_Rep_Item (Id : E; V : N);
6171 procedure Set_Freeze_Node (Id : E; V : N);
6172 procedure Set_From_With_Type (Id : E; V : B := True);
6173 procedure Set_Full_View (Id : E; V : E);
6174 procedure Set_Function_Returns_With_DSP (Id : E; V : B := True);
6175 procedure Set_Generic_Homonym (Id : E; V : E);
6176 procedure Set_Generic_Renamings (Id : E; V : L);
6177 procedure Set_Handler_Records (Id : E; V : S);
6178 procedure Set_Has_Aliased_Components (Id : E; V : B := True);
6179 procedure Set_Has_Alignment_Clause (Id : E; V : B := True);
6180 procedure Set_Has_All_Calls_Remote (Id : E; V : B := True);
6181 procedure Set_Has_Anon_Block_Suffix (Id : E; V : B := True);
6182 procedure Set_Has_Atomic_Components (Id : E; V : B := True);
6183 procedure Set_Has_Biased_Representation (Id : E; V : B := True);
6184 procedure Set_Has_Completion (Id : E; V : B := True);
6185 procedure Set_Has_Completion_In_Body (Id : E; V : B := True);
6186 procedure Set_Has_Complex_Representation (Id : E; V : B := True);
6187 procedure Set_Has_Component_Size_Clause (Id : E; V : B := True);
6188 procedure Set_Has_Constrained_Partial_View (Id : E; V : B := True);
6189 procedure Set_Has_Contiguous_Rep (Id : E; V : B := True);
6190 procedure Set_Has_Controlled_Component (Id : E; V : B := True);
6191 procedure Set_Has_Controlling_Result (Id : E; V : B := True);
6192 procedure Set_Has_Convention_Pragma (Id : E; V : B := True);
6193 procedure Set_Has_Delayed_Freeze (Id : E; V : B := True);
6194 procedure Set_Has_Discriminants (Id : E; V : B := True);
6195 procedure Set_Has_Dispatch_Table (Id : E; V : B := True);
6196 procedure Set_Has_Enumeration_Rep_Clause (Id : E; V : B := True);
6197 procedure Set_Has_Exit (Id : E; V : B := True);
6198 procedure Set_Has_External_Tag_Rep_Clause (Id : E; V : B := True);
6199 procedure Set_Has_Fully_Qualified_Name (Id : E; V : B := True);
6200 procedure Set_Has_Gigi_Rep_Item (Id : E; V : B := True);
6201 procedure Set_Has_Homonym (Id : E; V : B := True);
6202 procedure Set_Has_Initial_Value (Id : E; V : B := True);
6203 procedure Set_Has_Machine_Radix_Clause (Id : E; V : B := True);
6204 procedure Set_Has_Master_Entity (Id : E; V : B := True);
6205 procedure Set_Has_Missing_Return (Id : E; V : B := True);
6206 procedure Set_Has_Nested_Block_With_Handler (Id : E; V : B := True);
6207 procedure Set_Has_Forward_Instantiation (Id : E; V : B := True);
6208 procedure Set_Has_Up_Level_Access (Id : E; V : B := True);
6209 procedure Set_Has_Non_Standard_Rep (Id : E; V : B := True);
6210 procedure Set_Has_Object_Size_Clause (Id : E; V : B := True);
6211 procedure Set_Has_Per_Object_Constraint (Id : E; V : B := True);
6212 procedure Set_Has_Persistent_BSS (Id : E; V : B := True);
6213 procedure Set_Has_Pragma_Controlled (Id : E; V : B := True);
6214 procedure Set_Has_Pragma_Elaborate_Body (Id : E; V : B := True);
6215 procedure Set_Has_Pragma_Inline (Id : E; V : B := True);
6216 procedure Set_Has_Pragma_Pack (Id : E; V : B := True);
6217 procedure Set_Has_Pragma_Preelab_Init (Id : E; V : B := True);
6218 procedure Set_Has_Pragma_Pure (Id : E; V : B := True);
6219 procedure Set_Has_Pragma_Pure_Function (Id : E; V : B := True);
6220 procedure Set_Has_Pragma_Unreferenced (Id : E; V : B := True);
6221 procedure Set_Has_Pragma_Unreferenced_Objects (Id : E; V : B := True);
6222 procedure Set_Has_Primitive_Operations (Id : E; V : B := True);
6223 procedure Set_Has_Private_Declaration (Id : E; V : B := True);
6224 procedure Set_Has_Qualified_Name (Id : E; V : B := True);
6225 procedure Set_Has_RACW (Id : E; V : B := True);
6226 procedure Set_Has_Record_Rep_Clause (Id : E; V : B := True);
6227 procedure Set_Has_Recursive_Call (Id : E; V : B := True);
6228 procedure Set_Has_Size_Clause (Id : E; V : B := True);
6229 procedure Set_Has_Small_Clause (Id : E; V : B := True);
6230 procedure Set_Has_Specified_Layout (Id : E; V : B := True);
6231 procedure Set_Has_Specified_Stream_Input (Id : E; V : B := True);
6232 procedure Set_Has_Specified_Stream_Output (Id : E; V : B := True);
6233 procedure Set_Has_Specified_Stream_Read (Id : E; V : B := True);
6234 procedure Set_Has_Specified_Stream_Write (Id : E; V : B := True);
6235 procedure Set_Has_Static_Discriminants (Id : E; V : B := True);
6236 procedure Set_Has_Storage_Size_Clause (Id : E; V : B := True);
6237 procedure Set_Has_Stream_Size_Clause (Id : E; V : B := True);
6238 procedure Set_Has_Subprogram_Descriptor (Id : E; V : B := True);
6239 procedure Set_Has_Task (Id : E; V : B := True);
6240 procedure Set_Has_Unchecked_Union (Id : E; V : B := True);
6241 procedure Set_Has_Unknown_Discriminants (Id : E; V : B := True);
6242 procedure Set_Has_Volatile_Components (Id : E; V : B := True);
6243 procedure Set_Has_Xref_Entry (Id : E; V : B := True);
6244 procedure Set_Hiding_Loop_Variable (Id : E; V : E);
6245 procedure Set_Homonym (Id : E; V : E);
6246 procedure Set_In_Package_Body (Id : E; V : B := True);
6247 procedure Set_In_Private_Part (Id : E; V : B := True);
6248 procedure Set_In_Use (Id : E; V : B := True);
6249 procedure Set_Inner_Instances (Id : E; V : L);
6250 procedure Set_Interface_Name (Id : E; V : N);
6251 procedure Set_Is_AST_Entry (Id : E; V : B := True);
6252 procedure Set_Is_Abstract_Subprogram (Id : E; V : B := True);
6253 procedure Set_Is_Abstract_Type (Id : E; V : B := True);
6254 procedure Set_Is_Local_Anonymous_Access (Id : E; V : B := True);
6255 procedure Set_Is_Access_Constant (Id : E; V : B := True);
6256 procedure Set_Is_Ada_2005_Only (Id : E; V : B := True);
6257 procedure Set_Is_Aliased (Id : E; V : B := True);
6258 procedure Set_Is_Asynchronous (Id : E; V : B := True);
6259 procedure Set_Is_Atomic (Id : E; V : B := True);
6260 procedure Set_Is_Bit_Packed_Array (Id : E; V : B := True);
6261 procedure Set_Is_CPP_Class (Id : E; V : B := True);
6262 procedure Set_Is_Called (Id : E; V : B := True);
6263 procedure Set_Is_Character_Type (Id : E; V : B := True);
6264 procedure Set_Is_Child_Unit (Id : E; V : B := True);
6265 procedure Set_Is_Class_Wide_Equivalent_Type (Id : E; V : B := True);
6266 procedure Set_Is_Compilation_Unit (Id : E; V : B := True);
6267 procedure Set_Is_Completely_Hidden (Id : E; V : B := True);
6268 procedure Set_Is_Concurrent_Record_Type (Id : E; V : B := True);
6269 procedure Set_Is_Constr_Subt_For_UN_Aliased (Id : E; V : B := True);
6270 procedure Set_Is_Constr_Subt_For_U_Nominal (Id : E; V : B := True);
6271 procedure Set_Is_Constrained (Id : E; V : B := True);
6272 procedure Set_Is_Constructor (Id : E; V : B := True);
6273 procedure Set_Is_Controlled (Id : E; V : B := True);
6274 procedure Set_Is_Controlling_Formal (Id : E; V : B := True);
6275 procedure Set_Is_Descendent_Of_Address (Id : E; V : B := True);
6276 procedure Set_Is_Discrim_SO_Function (Id : E; V : B := True);
6277 procedure Set_Is_Dispatching_Operation (Id : E; V : B := True);
6278 procedure Set_Is_Eliminated (Id : E; V : B := True);
6279 procedure Set_Is_Entry_Formal (Id : E; V : B := True);
6280 procedure Set_Is_Exported (Id : E; V : B := True);
6281 procedure Set_Is_First_Subtype (Id : E; V : B := True);
6282 procedure Set_Is_For_Access_Subtype (Id : E; V : B := True);
6283 procedure Set_Is_Formal_Subprogram (Id : E; V : B := True);
6284 procedure Set_Is_Frozen (Id : E; V : B := True);
6285 procedure Set_Is_Generic_Actual_Type (Id : E; V : B := True);
6286 procedure Set_Is_Generic_Instance (Id : E; V : B := True);
6287 procedure Set_Is_Generic_Type (Id : E; V : B := True);
6288 procedure Set_Is_Hidden (Id : E; V : B := True);
6289 procedure Set_Is_Hidden_Open_Scope (Id : E; V : B := True);
6290 procedure Set_Is_Immediately_Visible (Id : E; V : B := True);
6291 procedure Set_Is_Imported (Id : E; V : B := True);
6292 procedure Set_Is_Inlined (Id : E; V : B := True);
6293 procedure Set_Is_Interface (Id : E; V : B := True);
6294 procedure Set_Is_Instantiated (Id : E; V : B := True);
6295 procedure Set_Is_Internal (Id : E; V : B := True);
6296 procedure Set_Is_Interrupt_Handler (Id : E; V : B := True);
6297 procedure Set_Is_Intrinsic_Subprogram (Id : E; V : B := True);
6298 procedure Set_Is_Itype (Id : E; V : B := True);
6299 procedure Set_Is_Known_Non_Null (Id : E; V : B := True);
6300 procedure Set_Is_Known_Null (Id : E; V : B := True);
6301 procedure Set_Is_Known_Valid (Id : E; V : B := True);
6302 procedure Set_Is_Limited_Composite (Id : E; V : B := True);
6303 procedure Set_Is_Limited_Interface (Id : E; V : B := True);
6304 procedure Set_Is_Limited_Record (Id : E; V : B := True);
6305 procedure Set_Is_Machine_Code_Subprogram (Id : E; V : B := True);
6306 procedure Set_Is_Non_Static_Subtype (Id : E; V : B := True);
6307 procedure Set_Is_Null_Init_Proc (Id : E; V : B := True);
6308 procedure Set_Is_Obsolescent (Id : E; V : B := True);
6309 procedure Set_Is_Optional_Parameter (Id : E; V : B := True);
6310 procedure Set_Is_Overriding_Operation (Id : E; V : B := True);
6311 procedure Set_Is_Package_Body_Entity (Id : E; V : B := True);
6312 procedure Set_Is_Packed (Id : E; V : B := True);
6313 procedure Set_Is_Packed_Array_Type (Id : E; V : B := True);
6314 procedure Set_Is_Potentially_Use_Visible (Id : E; V : B := True);
6315 procedure Set_Is_Preelaborated (Id : E; V : B := True);
6316 procedure Set_Is_Primitive (Id : E; V : B := True);
6317 procedure Set_Is_Primitive_Wrapper (Id : E; V : B := True);
6318 procedure Set_Is_Private_Composite (Id : E; V : B := True);
6319 procedure Set_Is_Private_Descendant (Id : E; V : B := True);
6320 procedure Set_Is_Protected_Interface (Id : E; V : B := True);
6321 procedure Set_Is_Public (Id : E; V : B := True);
6322 procedure Set_Is_Pure (Id : E; V : B := True);
6323 procedure Set_Is_Pure_Unit_Access_Type (Id : E; V : B := True);
6324 procedure Set_Is_Raised (Id : E; V : B := True);
6325 procedure Set_Is_Remote_Call_Interface (Id : E; V : B := True);
6326 procedure Set_Is_Remote_Types (Id : E; V : B := True);
6327 procedure Set_Is_Renaming_Of_Object (Id : E; V : B := True);
6328 procedure Set_Is_Return_Object (Id : E; V : B := True);
6329 procedure Set_Is_Shared_Passive (Id : E; V : B := True);
6330 procedure Set_Is_Statically_Allocated (Id : E; V : B := True);
6331 procedure Set_Is_Synchronized_Interface (Id : E; V : B := True);
6332 procedure Set_Is_Tag (Id : E; V : B := True);
6333 procedure Set_Is_Tagged_Type (Id : E; V : B := True);
6334 procedure Set_Is_Task_Interface (Id : E; V : B := True);
6335 procedure Set_Is_Thunk (Id : E; V : B := True);
6336 procedure Set_Is_True_Constant (Id : E; V : B := True);
6337 procedure Set_Is_Unchecked_Union (Id : E; V : B := True);
6338 procedure Set_Is_Unsigned_Type (Id : E; V : B := True);
6339 procedure Set_Is_VMS_Exception (Id : E; V : B := True);
6340 procedure Set_Is_Valued_Procedure (Id : E; V : B := True);
6341 procedure Set_Is_Visible_Child_Unit (Id : E; V : B := True);
6342 procedure Set_Is_Visible_Formal (Id : E; V : B := True);
6343 procedure Set_Is_Volatile (Id : E; V : B := True);
6344 procedure Set_Itype_Printed (Id : E; V : B := True);
6345 procedure Set_Kill_Elaboration_Checks (Id : E; V : B := True);
6346 procedure Set_Kill_Range_Checks (Id : E; V : B := True);
6347 procedure Set_Kill_Tag_Checks (Id : E; V : B := True);
6348 procedure Set_Known_To_Have_Preelab_Init (Id : E; V : B := True);
6349 procedure Set_Last_Assignment (Id : E; V : N);
6350 procedure Set_Last_Entity (Id : E; V : E);
6351 procedure Set_Limited_View (Id : E; V : E);
6352 procedure Set_Lit_Indexes (Id : E; V : E);
6353 procedure Set_Lit_Strings (Id : E; V : E);
6354 procedure Set_Low_Bound_Known (Id : E; V : B := True);
6355 procedure Set_Machine_Radix_10 (Id : E; V : B := True);
6356 procedure Set_Master_Id (Id : E; V : E);
6357 procedure Set_Materialize_Entity (Id : E; V : B := True);
6358 procedure Set_Mechanism (Id : E; V : M);
6359 procedure Set_Modulus (Id : E; V : U);
6360 procedure Set_Must_Be_On_Byte_Boundary (Id : E; V : B := True);
6361 procedure Set_Must_Have_Preelab_Init (Id : E; V : B := True);
6362 procedure Set_Needs_Debug_Info (Id : E; V : B := True);
6363 procedure Set_Needs_No_Actuals (Id : E; V : B := True);
6364 procedure Set_Never_Set_In_Source (Id : E; V : B := True);
6365 procedure Set_Next_Inlined_Subprogram (Id : E; V : E);
6366 procedure Set_No_Pool_Assigned (Id : E; V : B := True);
6367 procedure Set_No_Return (Id : E; V : B := True);
6368 procedure Set_No_Strict_Aliasing (Id : E; V : B := True);
6369 procedure Set_Non_Binary_Modulus (Id : E; V : B := True);
6370 procedure Set_Non_Limited_View (Id : E; V : E);
6371 procedure Set_Nonzero_Is_True (Id : E; V : B := True);
6372 procedure Set_Normalized_First_Bit (Id : E; V : U);
6373 procedure Set_Normalized_Position (Id : E; V : U);
6374 procedure Set_Normalized_Position_Max (Id : E; V : U);
6375 procedure Set_Object_Ref (Id : E; V : E);
6376 procedure Set_Obsolescent_Warning (Id : E; V : N);
6377 procedure Set_Original_Array_Type (Id : E; V : E);
6378 procedure Set_Original_Record_Component (Id : E; V : E);
6379 procedure Set_Overridden_Operation (Id : E; V : E);
6380 procedure Set_Package_Instantiation (Id : E; V : N);
6381 procedure Set_Packed_Array_Type (Id : E; V : E);
6382 procedure Set_Parent_Subtype (Id : E; V : E);
6383 procedure Set_Primitive_Operations (Id : E; V : L);
6384 procedure Set_Prival (Id : E; V : E);
6385 procedure Set_Privals_Chain (Id : E; V : L);
6386 procedure Set_Private_Dependents (Id : E; V : L);
6387 procedure Set_Private_View (Id : E; V : N);
6388 procedure Set_Protected_Body_Subprogram (Id : E; V : E);
6389 procedure Set_Protected_Formal (Id : E; V : E);
6390 procedure Set_Protected_Operation (Id : E; V : N);
6391 procedure Set_RM_Size (Id : E; V : U);
6392 procedure Set_Reachable (Id : E; V : B := True);
6393 procedure Set_Referenced (Id : E; V : B := True);
6394 procedure Set_Referenced_As_LHS (Id : E; V : B := True);
6395 procedure Set_Referenced_Object (Id : E; V : N);
6396 procedure Set_Register_Exception_Call (Id : E; V : N);
6397 procedure Set_Related_Array_Object (Id : E; V : E);
6398 procedure Set_Related_Instance (Id : E; V : E);
6399 procedure Set_Related_Interface (Id : E; V : E);
6400 procedure Set_Renamed_Entity (Id : E; V : N);
6401 procedure Set_Renamed_Object (Id : E; V : N);
6402 procedure Set_Renaming_Map (Id : E; V : U);
6403 procedure Set_Requires_Overriding (Id : E; V : B := True);
6404 procedure Set_Return_Present (Id : E; V : B := True);
6405 procedure Set_Return_Applies_To (Id : E; V : N);
6406 procedure Set_Returns_By_Ref (Id : E; V : B := True);
6407 procedure Set_Reverse_Bit_Order (Id : E; V : B := True);
6408 procedure Set_Scalar_Range (Id : E; V : N);
6409 procedure Set_Scale_Value (Id : E; V : U);
6410 procedure Set_Scope_Depth_Value (Id : E; V : U);
6411 procedure Set_Sec_Stack_Needed_For_Return (Id : E; V : B := True);
6412 procedure Set_Shadow_Entities (Id : E; V : S);
6413 procedure Set_Shared_Var_Assign_Proc (Id : E; V : E);
6414 procedure Set_Shared_Var_Read_Proc (Id : E; V : E);
6415 procedure Set_Size_Check_Code (Id : E; V : N);
6416 procedure Set_Size_Depends_On_Discriminant (Id : E; V : B := True);
6417 procedure Set_Size_Known_At_Compile_Time (Id : E; V : B := True);
6418 procedure Set_Small_Value (Id : E; V : R);
6419 procedure Set_Spec_Entity (Id : E; V : E);
6420 procedure Set_Storage_Size_Variable (Id : E; V : E);
6421 procedure Set_Static_Elaboration_Desired (Id : E; V : B);
6422 procedure Set_Static_Initialization (Id : E; V : N);
6423 procedure Set_Stored_Constraint (Id : E; V : L);
6424 procedure Set_Strict_Alignment (Id : E; V : B := True);
6425 procedure Set_String_Literal_Length (Id : E; V : U);
6426 procedure Set_String_Literal_Low_Bound (Id : E; V : N);
6427 procedure Set_Suppress_Elaboration_Warnings (Id : E; V : B := True);
6428 procedure Set_Suppress_Init_Proc (Id : E; V : B := True);
6429 procedure Set_Suppress_Style_Checks (Id : E; V : B := True);
6430 procedure Set_Suppress_Value_Tracking_On_Call (Id : E; V : B := True);
6431 procedure Set_Task_Body_Procedure (Id : E; V : N);
6432 procedure Set_Treat_As_Volatile (Id : E; V : B := True);
6433 procedure Set_Underlying_Full_View (Id : E; V : E);
6434 procedure Set_Universal_Aliasing (Id : E; V : B := True);
6435 procedure Set_Unset_Reference (Id : E; V : N);
6436 procedure Set_Used_As_Generic_Actual (Id : E; V : B := True);
6437 procedure Set_Uses_Sec_Stack (Id : E; V : B := True);
6438 procedure Set_Vax_Float (Id : E; V : B := True);
6439 procedure Set_Warnings_Off (Id : E; V : B := True);
6440 procedure Set_Was_Hidden (Id : E; V : B := True);
6441 procedure Set_Wrapped_Entity (Id : E; V : E);
6443 -----------------------------------
6444 -- Field Initialization Routines --
6445 -----------------------------------
6447 -- These routines are overloadings of some of the above Set procedures
6448 -- where the argument is normally a Uint. The overloadings take an Int
6449 -- parameter instead, and appropriately convert it. There are also
6450 -- versions that implicitly initialize to the appropriate "not set"
6451 -- value. The not set (unknown) values are as follows:
6453 -- Alignment Uint_0
6454 -- Component_Size Uint_0
6455 -- Component_Bit_Offset No_Uint
6456 -- Digits_Value Uint_0
6457 -- Esize Uint_0
6458 -- Normalized_First_Bit No_Uint
6459 -- Normalized_Position No_Uint
6460 -- Normalized_Position_Max No_Uint
6461 -- RM_Size Uint_0
6463 -- It would be cleaner to use No_Uint in all these cases, but historically
6464 -- we chose to use Uint_0 at first, and the change over will take time ???
6465 -- This is particularly true for the RM_Size field, where a value of zero
6466 -- is legitimate and causes some kludges around the code.
6468 -- Contrary to the corresponding Set procedures above, these routines
6469 -- do NOT check the entity kind of their argument, instead they set the
6470 -- underlying Uint fields directly (this allows them to be used for
6471 -- entities whose Ekind has not been set yet).
6473 procedure Init_Alignment (Id : E; V : Int);
6474 procedure Init_Component_Size (Id : E; V : Int);
6475 procedure Init_Component_Bit_Offset (Id : E; V : Int);
6476 procedure Init_Digits_Value (Id : E; V : Int);
6477 procedure Init_Esize (Id : E; V : Int);
6478 procedure Init_Normalized_First_Bit (Id : E; V : Int);
6479 procedure Init_Normalized_Position (Id : E; V : Int);
6480 procedure Init_Normalized_Position_Max (Id : E; V : Int);
6481 procedure Init_RM_Size (Id : E; V : Int);
6483 procedure Init_Alignment (Id : E);
6484 procedure Init_Component_Size (Id : E);
6485 procedure Init_Component_Bit_Offset (Id : E);
6486 procedure Init_Digits_Value (Id : E);
6487 procedure Init_Esize (Id : E);
6488 procedure Init_Normalized_First_Bit (Id : E);
6489 procedure Init_Normalized_Position (Id : E);
6490 procedure Init_Normalized_Position_Max (Id : E);
6491 procedure Init_RM_Size (Id : E);
6493 procedure Init_Size_Align (Id : E);
6494 -- This procedure initializes both size fields and the alignment
6495 -- field to all be Unknown.
6497 procedure Init_Size (Id : E; V : Int);
6498 -- Initialize both the Esize and RM_Size fields of E to V
6500 procedure Init_Component_Location (Id : E);
6501 -- Initializes all fields describing the location of a component
6502 -- (Normalized_Position, Component_Bit_Offset, Normalized_First_Bit,
6503 -- Normalized_Position_Max, Esize) to all be Unknown.
6505 ---------------
6506 -- Iterators --
6507 ---------------
6509 -- The call to Next_xxx (obj) is equivalent to obj := Next_xxx (obj)
6510 -- We define the set of Proc_Next_xxx routines simply for the purposes
6511 -- of inlining them without necessarily inlining the function.
6513 procedure Proc_Next_Component (N : in out Node_Id);
6514 procedure Proc_Next_Component_Or_Discriminant (N : in out Node_Id);
6515 procedure Proc_Next_Discriminant (N : in out Node_Id);
6516 procedure Proc_Next_Formal (N : in out Node_Id);
6517 procedure Proc_Next_Formal_With_Extras (N : in out Node_Id);
6518 procedure Proc_Next_Index (N : in out Node_Id);
6519 procedure Proc_Next_Inlined_Subprogram (N : in out Node_Id);
6520 procedure Proc_Next_Literal (N : in out Node_Id);
6521 procedure Proc_Next_Stored_Discriminant (N : in out Node_Id);
6523 pragma Inline (Proc_Next_Component);
6524 pragma Inline (Proc_Next_Component_Or_Discriminant);
6525 pragma Inline (Proc_Next_Discriminant);
6526 pragma Inline (Proc_Next_Formal);
6527 pragma Inline (Proc_Next_Formal_With_Extras);
6528 pragma Inline (Proc_Next_Index);
6529 pragma Inline (Proc_Next_Inlined_Subprogram);
6530 pragma Inline (Proc_Next_Literal);
6531 pragma Inline (Proc_Next_Stored_Discriminant);
6533 procedure Next_Component (N : in out Node_Id)
6534 renames Proc_Next_Component;
6536 procedure Next_Component_Or_Discriminant (N : in out Node_Id)
6537 renames Proc_Next_Component;
6539 procedure Next_Discriminant (N : in out Node_Id)
6540 renames Proc_Next_Discriminant;
6542 procedure Next_Formal (N : in out Node_Id)
6543 renames Proc_Next_Formal;
6545 procedure Next_Formal_With_Extras (N : in out Node_Id)
6546 renames Proc_Next_Formal_With_Extras;
6548 procedure Next_Index (N : in out Node_Id)
6549 renames Proc_Next_Index;
6551 procedure Next_Inlined_Subprogram (N : in out Node_Id)
6552 renames Proc_Next_Inlined_Subprogram;
6554 procedure Next_Literal (N : in out Node_Id)
6555 renames Proc_Next_Literal;
6557 procedure Next_Stored_Discriminant (N : in out Node_Id)
6558 renames Proc_Next_Stored_Discriminant;
6560 ----------------------------------------------
6561 -- Subprograms for Accessing Rep Item Chain --
6562 ----------------------------------------------
6564 -- The First_Rep_Item field of every entity points to a linked list
6565 -- (linked through Next_Rep_Item) of representation pragmas and attribute
6566 -- definition clauses that apply to the item. Note that in the case of
6567 -- types, it is assumed that any such rep items for a base type also apply
6568 -- to all subtypes. This is implemented by having the chain for subtypes
6569 -- link onto the chain for the base type, so that any new entries for the
6570 -- subtype are added at the start of the chain.
6572 function Get_Attribute_Definition_Clause
6573 (E : Entity_Id;
6574 Id : Attribute_Id) return Node_Id;
6575 -- Searches the Rep_Item chain for a given entity E, for an instance of an
6576 -- attribute definition clause with the given attribute Id. If found, the
6577 -- value returned is the N_Attribute_Definition_Clause node, otherwise
6578 -- Empty is returned.
6580 function Get_Rep_Pragma (E : Entity_Id; Nam : Name_Id) return Node_Id;
6581 -- Searches the Rep_Item chain for the given entity E, for an instance
6582 -- a representation pragma with the given name Nam. If found then the
6583 -- value returned is the N_Pragma node, otherwise Empty is returned.
6585 function Has_Rep_Pragma (E : Entity_Id; Nam : Name_Id) return Boolean;
6586 -- Searches the Rep_Item chain for the given entity E, for an instance
6587 -- of representation pragma with the given name Nam. If found then True
6588 -- is returned, otherwise False indicates that no matching entry was found.
6590 function Has_Attribute_Definition_Clause
6591 (E : Entity_Id;
6592 Id : Attribute_Id) return Boolean;
6593 -- Searches the Rep_Item chain for a given entity E, for an instance of an
6594 -- attribute definition clause with the given attribute Id. If found, True
6595 -- is returned, otherwise False indicates that no matching entry was found.
6597 procedure Record_Rep_Item (E : Entity_Id; N : Node_Id);
6598 -- N is the node for either a representation pragma or an attribute
6599 -- definition clause that applies to entity E. This procedure links
6600 -- the node N onto the Rep_Item chain for entity E.
6602 -------------------------------
6603 -- Miscellaneous Subprograms --
6604 -------------------------------
6606 procedure Append_Entity (Id : Entity_Id; V : Entity_Id);
6607 -- Add an entity to the list of entities declared in the scope V
6609 function Get_Full_View (T : Entity_Id) return Entity_Id;
6610 -- If T is an incomplete type and the full declaration has been
6611 -- seen, or is the name of a class_wide type whose root is incomplete.
6612 -- return the corresponding full declaration.
6614 function Is_Entity_Name (N : Node_Id) return Boolean;
6615 -- Test if the node N is the name of an entity (i.e. is an identifier,
6616 -- expanded name, or an attribute reference that returns an entity).
6618 function Next_Index (Id : Node_Id) return Node_Id;
6619 -- Given an index from a previous call to First_Index or Next_Index,
6620 -- returns a node representing the occurrence of the next index subtype,
6621 -- or Empty if there are no more index subtypes.
6623 function Scope_Depth (Id : Entity_Id) return Uint;
6624 -- Returns the scope depth value of the Id, unless the Id is a record
6625 -- type, in which case it returns the scope depth of the record scope.
6627 function Subtype_Kind (K : Entity_Kind) return Entity_Kind;
6628 -- Given an entity_kind K this function returns the entity_kind
6629 -- corresponding to subtype kind of the type represented by K. For
6630 -- example if K is E_Signed_Integer_Type then E_Signed_Integer_Subtype
6631 -- is returned. If K is already a subtype kind it itself is returned. An
6632 -- internal error is generated if no such correspondence exists for K.
6634 ----------------------------------
6635 -- Debugging Output Subprograms --
6636 ----------------------------------
6638 procedure Write_Entity_Flags (Id : Entity_Id; Prefix : String);
6639 -- Writes a series of entries giving a line for each flag that is
6640 -- set to True. Each line is prefixed by the given string
6642 procedure Write_Entity_Info (Id : Entity_Id; Prefix : String);
6643 -- A debugging procedure to write out information about an entity
6645 procedure Write_Field6_Name (Id : Entity_Id);
6646 procedure Write_Field7_Name (Id : Entity_Id);
6647 procedure Write_Field8_Name (Id : Entity_Id);
6648 procedure Write_Field9_Name (Id : Entity_Id);
6649 procedure Write_Field10_Name (Id : Entity_Id);
6650 procedure Write_Field11_Name (Id : Entity_Id);
6651 procedure Write_Field12_Name (Id : Entity_Id);
6652 procedure Write_Field13_Name (Id : Entity_Id);
6653 procedure Write_Field14_Name (Id : Entity_Id);
6654 procedure Write_Field15_Name (Id : Entity_Id);
6655 procedure Write_Field16_Name (Id : Entity_Id);
6656 procedure Write_Field17_Name (Id : Entity_Id);
6657 procedure Write_Field18_Name (Id : Entity_Id);
6658 procedure Write_Field19_Name (Id : Entity_Id);
6659 procedure Write_Field20_Name (Id : Entity_Id);
6660 procedure Write_Field21_Name (Id : Entity_Id);
6661 procedure Write_Field22_Name (Id : Entity_Id);
6662 procedure Write_Field23_Name (Id : Entity_Id);
6663 procedure Write_Field24_Name (Id : Entity_Id);
6664 procedure Write_Field25_Name (Id : Entity_Id);
6665 procedure Write_Field26_Name (Id : Entity_Id);
6666 procedure Write_Field27_Name (Id : Entity_Id);
6667 procedure Write_Field28_Name (Id : Entity_Id);
6668 -- These routines are used to output a nice symbolic name for the given
6669 -- field, depending on the Ekind. No blanks or end of lines are output,
6670 -- just the characters of the field name.
6672 --------------------
6673 -- Inline Pragmas --
6674 --------------------
6676 -- Note that these inline pragmas are referenced by the XEINFO utility
6677 -- program in preparing the corresponding C header, and only those
6678 -- subprograms meeting the requirements documented in the section on
6679 -- XEINFO may be referenced in this section.
6681 pragma Inline (Abstract_Interfaces);
6682 pragma Inline (Accept_Address);
6683 pragma Inline (Access_Disp_Table);
6684 pragma Inline (Actual_Subtype);
6685 pragma Inline (Address_Taken);
6686 pragma Inline (Abstract_Interface_Alias);
6687 pragma Inline (Alias);
6688 pragma Inline (Alignment);
6689 pragma Inline (Associated_Final_Chain);
6690 pragma Inline (Associated_Formal_Package);
6691 pragma Inline (Associated_Node_For_Itype);
6692 pragma Inline (Associated_Storage_Pool);
6693 pragma Inline (Barrier_Function);
6694 pragma Inline (Block_Node);
6695 pragma Inline (Body_Entity);
6696 pragma Inline (Body_Needed_For_SAL);
6697 pragma Inline (CR_Discriminant);
6698 pragma Inline (C_Pass_By_Copy);
6699 pragma Inline (Can_Never_Be_Null);
6700 pragma Inline (Checks_May_Be_Suppressed);
6701 pragma Inline (Class_Wide_Type);
6702 pragma Inline (Cloned_Subtype);
6703 pragma Inline (Component_Bit_Offset);
6704 pragma Inline (Component_Clause);
6705 pragma Inline (Component_Size);
6706 pragma Inline (Component_Type);
6707 pragma Inline (Corresponding_Concurrent_Type);
6708 pragma Inline (Corresponding_Discriminant);
6709 pragma Inline (Corresponding_Equality);
6710 pragma Inline (Corresponding_Record_Type);
6711 pragma Inline (Corresponding_Remote_Type);
6712 pragma Inline (Current_Use_Clause);
6713 pragma Inline (Current_Value);
6714 pragma Inline (Debug_Info_Off);
6715 pragma Inline (Debug_Renaming_Link);
6716 pragma Inline (Dispatch_Table_Wrapper);
6717 pragma Inline (DTC_Entity);
6718 pragma Inline (DT_Entry_Count);
6719 pragma Inline (DT_Offset_To_Top_Func);
6720 pragma Inline (DT_Position);
6721 pragma Inline (Default_Expr_Function);
6722 pragma Inline (Default_Expressions_Processed);
6723 pragma Inline (Default_Value);
6724 pragma Inline (Delay_Cleanups);
6725 pragma Inline (Delay_Subprogram_Descriptors);
6726 pragma Inline (Delta_Value);
6727 pragma Inline (Dependent_Instances);
6728 pragma Inline (Depends_On_Private);
6729 pragma Inline (Digits_Value);
6730 pragma Inline (Directly_Designated_Type);
6731 pragma Inline (Discard_Names);
6732 pragma Inline (Discriminal);
6733 pragma Inline (Discriminal_Link);
6734 pragma Inline (Discriminant_Checking_Func);
6735 pragma Inline (Discriminant_Constraint);
6736 pragma Inline (Discriminant_Default_Value);
6737 pragma Inline (Discriminant_Number);
6738 pragma Inline (Elaborate_Body_Desirable);
6739 pragma Inline (Elaboration_Entity);
6740 pragma Inline (Elaboration_Entity_Required);
6741 pragma Inline (Enclosing_Scope);
6742 pragma Inline (Entry_Accepted);
6743 pragma Inline (Entry_Bodies_Array);
6744 pragma Inline (Entry_Cancel_Parameter);
6745 pragma Inline (Entry_Component);
6746 pragma Inline (Entry_Formal);
6747 pragma Inline (Entry_Index_Constant);
6748 pragma Inline (Entry_Index_Type);
6749 pragma Inline (Entry_Parameters_Type);
6750 pragma Inline (Enum_Pos_To_Rep);
6751 pragma Inline (Enumeration_Pos);
6752 pragma Inline (Enumeration_Rep);
6753 pragma Inline (Enumeration_Rep_Expr);
6754 pragma Inline (Equivalent_Type);
6755 pragma Inline (Esize);
6756 pragma Inline (Exception_Code);
6757 pragma Inline (Extra_Accessibility);
6758 pragma Inline (Extra_Constrained);
6759 pragma Inline (Extra_Formal);
6760 pragma Inline (Extra_Formals);
6761 pragma Inline (Finalization_Chain_Entity);
6762 pragma Inline (First_Entity);
6763 pragma Inline (First_Index);
6764 pragma Inline (First_Literal);
6765 pragma Inline (First_Optional_Parameter);
6766 pragma Inline (First_Private_Entity);
6767 pragma Inline (First_Rep_Item);
6768 pragma Inline (Freeze_Node);
6769 pragma Inline (From_With_Type);
6770 pragma Inline (Full_View);
6771 pragma Inline (Function_Returns_With_DSP);
6772 pragma Inline (Generic_Homonym);
6773 pragma Inline (Generic_Renamings);
6774 pragma Inline (Handler_Records);
6775 pragma Inline (Has_Aliased_Components);
6776 pragma Inline (Has_Alignment_Clause);
6777 pragma Inline (Has_All_Calls_Remote);
6778 pragma Inline (Has_Anon_Block_Suffix);
6779 pragma Inline (Has_Atomic_Components);
6780 pragma Inline (Has_Biased_Representation);
6781 pragma Inline (Has_Completion);
6782 pragma Inline (Has_Completion_In_Body);
6783 pragma Inline (Has_Complex_Representation);
6784 pragma Inline (Has_Component_Size_Clause);
6785 pragma Inline (Has_Constrained_Partial_View);
6786 pragma Inline (Has_Contiguous_Rep);
6787 pragma Inline (Has_Controlled_Component);
6788 pragma Inline (Has_Controlling_Result);
6789 pragma Inline (Has_Convention_Pragma);
6790 pragma Inline (Has_Delayed_Freeze);
6791 pragma Inline (Has_Discriminants);
6792 pragma Inline (Has_Dispatch_Table);
6793 pragma Inline (Has_Enumeration_Rep_Clause);
6794 pragma Inline (Has_Exit);
6795 pragma Inline (Has_External_Tag_Rep_Clause);
6796 pragma Inline (Has_Fully_Qualified_Name);
6797 pragma Inline (Has_Gigi_Rep_Item);
6798 pragma Inline (Has_Homonym);
6799 pragma Inline (Has_Initial_Value);
6800 pragma Inline (Has_Machine_Radix_Clause);
6801 pragma Inline (Has_Master_Entity);
6802 pragma Inline (Has_Missing_Return);
6803 pragma Inline (Has_Nested_Block_With_Handler);
6804 pragma Inline (Has_Forward_Instantiation);
6805 pragma Inline (Has_Non_Standard_Rep);
6806 pragma Inline (Has_Object_Size_Clause);
6807 pragma Inline (Has_Per_Object_Constraint);
6808 pragma Inline (Has_Persistent_BSS);
6809 pragma Inline (Has_Pragma_Controlled);
6810 pragma Inline (Has_Pragma_Elaborate_Body);
6811 pragma Inline (Has_Pragma_Inline);
6812 pragma Inline (Has_Pragma_Pack);
6813 pragma Inline (Has_Pragma_Preelab_Init);
6814 pragma Inline (Has_Pragma_Pure);
6815 pragma Inline (Has_Pragma_Pure_Function);
6816 pragma Inline (Has_Pragma_Unreferenced);
6817 pragma Inline (Has_Pragma_Unreferenced_Objects);
6818 pragma Inline (Has_Primitive_Operations);
6819 pragma Inline (Has_Private_Declaration);
6820 pragma Inline (Has_Qualified_Name);
6821 pragma Inline (Has_RACW);
6822 pragma Inline (Has_Record_Rep_Clause);
6823 pragma Inline (Has_Recursive_Call);
6824 pragma Inline (Has_Size_Clause);
6825 pragma Inline (Has_Small_Clause);
6826 pragma Inline (Has_Specified_Layout);
6827 pragma Inline (Has_Specified_Stream_Input);
6828 pragma Inline (Has_Specified_Stream_Output);
6829 pragma Inline (Has_Specified_Stream_Read);
6830 pragma Inline (Has_Specified_Stream_Write);
6831 pragma Inline (Has_Static_Discriminants);
6832 pragma Inline (Has_Storage_Size_Clause);
6833 pragma Inline (Has_Stream_Size_Clause);
6834 pragma Inline (Has_Subprogram_Descriptor);
6835 pragma Inline (Has_Task);
6836 pragma Inline (Has_Unchecked_Union);
6837 pragma Inline (Has_Unknown_Discriminants);
6838 pragma Inline (Has_Up_Level_Access);
6839 pragma Inline (Has_Volatile_Components);
6840 pragma Inline (Has_Xref_Entry);
6841 pragma Inline (Hiding_Loop_Variable);
6842 pragma Inline (Homonym);
6843 pragma Inline (In_Package_Body);
6844 pragma Inline (In_Private_Part);
6845 pragma Inline (In_Use);
6846 pragma Inline (Inner_Instances);
6847 pragma Inline (Interface_Name);
6848 pragma Inline (Is_AST_Entry);
6849 pragma Inline (Is_Abstract_Subprogram);
6850 pragma Inline (Is_Abstract_Type);
6851 pragma Inline (Is_Local_Anonymous_Access);
6852 pragma Inline (Is_Access_Constant);
6853 pragma Inline (Is_Ada_2005_Only);
6854 pragma Inline (Is_Access_Type);
6855 pragma Inline (Is_Access_Protected_Subprogram_Type);
6856 pragma Inline (Is_Aliased);
6857 pragma Inline (Is_Array_Type);
6858 pragma Inline (Is_Assignable);
6859 pragma Inline (Is_Asynchronous);
6860 pragma Inline (Is_Atomic);
6861 pragma Inline (Is_Bit_Packed_Array);
6862 pragma Inline (Is_CPP_Class);
6863 pragma Inline (Is_Called);
6864 pragma Inline (Is_Character_Type);
6865 pragma Inline (Is_Child_Unit);
6866 pragma Inline (Is_Class_Wide_Equivalent_Type);
6867 pragma Inline (Is_Class_Wide_Type);
6868 pragma Inline (Is_Compilation_Unit);
6869 pragma Inline (Is_Completely_Hidden);
6870 pragma Inline (Is_Composite_Type);
6871 pragma Inline (Is_Concurrent_Body);
6872 pragma Inline (Is_Concurrent_Record_Type);
6873 pragma Inline (Is_Concurrent_Type);
6874 pragma Inline (Is_Constr_Subt_For_UN_Aliased);
6875 pragma Inline (Is_Constr_Subt_For_U_Nominal);
6876 pragma Inline (Is_Constrained);
6877 pragma Inline (Is_Constructor);
6878 pragma Inline (Is_Controlled);
6879 pragma Inline (Is_Controlling_Formal);
6880 pragma Inline (Is_Decimal_Fixed_Point_Type);
6881 pragma Inline (Is_Discrim_SO_Function);
6882 pragma Inline (Is_Digits_Type);
6883 pragma Inline (Is_Descendent_Of_Address);
6884 pragma Inline (Is_Discrete_Or_Fixed_Point_Type);
6885 pragma Inline (Is_Discrete_Type);
6886 pragma Inline (Is_Dispatching_Operation);
6887 pragma Inline (Is_Elementary_Type);
6888 pragma Inline (Is_Eliminated);
6889 pragma Inline (Is_Entry);
6890 pragma Inline (Is_Entry_Formal);
6891 pragma Inline (Is_Enumeration_Type);
6892 pragma Inline (Is_Exported);
6893 pragma Inline (Is_First_Subtype);
6894 pragma Inline (Is_Fixed_Point_Type);
6895 pragma Inline (Is_Floating_Point_Type);
6896 pragma Inline (Is_For_Access_Subtype);
6897 pragma Inline (Is_Formal);
6898 pragma Inline (Is_Formal_Object);
6899 pragma Inline (Is_Formal_Subprogram);
6900 pragma Inline (Is_Frozen);
6901 pragma Inline (Is_Generic_Actual_Type);
6902 pragma Inline (Is_Generic_Instance);
6903 pragma Inline (Is_Generic_Subprogram);
6904 pragma Inline (Is_Generic_Type);
6905 pragma Inline (Is_Generic_Unit);
6906 pragma Inline (Is_Hidden);
6907 pragma Inline (Is_Hidden_Open_Scope);
6908 pragma Inline (Is_Immediately_Visible);
6909 pragma Inline (Is_Imported);
6910 pragma Inline (Is_Incomplete_Or_Private_Type);
6911 pragma Inline (Is_Incomplete_Type);
6912 pragma Inline (Is_Inlined);
6913 pragma Inline (Is_Interface);
6914 pragma Inline (Is_Instantiated);
6915 pragma Inline (Is_Integer_Type);
6916 pragma Inline (Is_Internal);
6917 pragma Inline (Is_Interrupt_Handler);
6918 pragma Inline (Is_Intrinsic_Subprogram);
6919 pragma Inline (Is_Itype);
6920 pragma Inline (Is_Known_Non_Null);
6921 pragma Inline (Is_Known_Null);
6922 pragma Inline (Is_Known_Valid);
6923 pragma Inline (Is_Limited_Composite);
6924 pragma Inline (Is_Limited_Interface);
6925 pragma Inline (Is_Limited_Record);
6926 pragma Inline (Is_Machine_Code_Subprogram);
6927 pragma Inline (Is_Modular_Integer_Type);
6928 pragma Inline (Is_Named_Number);
6929 pragma Inline (Is_Non_Static_Subtype);
6930 pragma Inline (Is_Null_Init_Proc);
6931 pragma Inline (Is_Obsolescent);
6932 pragma Inline (Is_Numeric_Type);
6933 pragma Inline (Is_Object);
6934 pragma Inline (Is_Optional_Parameter);
6935 pragma Inline (Is_Package_Body_Entity);
6936 pragma Inline (Is_Ordinary_Fixed_Point_Type);
6937 pragma Inline (Is_Overloadable);
6938 pragma Inline (Is_Overriding_Operation);
6939 pragma Inline (Is_Packed);
6940 pragma Inline (Is_Packed_Array_Type);
6941 pragma Inline (Is_Potentially_Use_Visible);
6942 pragma Inline (Is_Preelaborated);
6943 pragma Inline (Is_Primitive);
6944 pragma Inline (Is_Primitive_Wrapper);
6945 pragma Inline (Is_Private_Composite);
6946 pragma Inline (Is_Private_Descendant);
6947 pragma Inline (Is_Private_Type);
6948 pragma Inline (Is_Protected_Interface);
6949 pragma Inline (Is_Protected_Type);
6950 pragma Inline (Is_Public);
6951 pragma Inline (Is_Pure);
6952 pragma Inline (Is_Pure_Unit_Access_Type);
6953 pragma Inline (Is_Raised);
6954 pragma Inline (Is_Real_Type);
6955 pragma Inline (Is_Record_Type);
6956 pragma Inline (Is_Remote_Call_Interface);
6957 pragma Inline (Is_Remote_Types);
6958 pragma Inline (Is_Renaming_Of_Object);
6959 pragma Inline (Is_Return_Object);
6960 pragma Inline (Is_Scalar_Type);
6961 pragma Inline (Is_Shared_Passive);
6962 pragma Inline (Is_Signed_Integer_Type);
6963 pragma Inline (Is_Statically_Allocated);
6964 pragma Inline (Is_Subprogram);
6965 pragma Inline (Is_Synchronized_Interface);
6966 pragma Inline (Is_Tag);
6967 pragma Inline (Is_Tagged_Type);
6968 pragma Inline (Is_Task_Interface);
6969 pragma Inline (Is_True_Constant);
6970 pragma Inline (Is_Task_Type);
6971 pragma Inline (Is_Thunk);
6972 pragma Inline (Is_Type);
6973 pragma Inline (Is_Unchecked_Union);
6974 pragma Inline (Is_Unsigned_Type);
6975 pragma Inline (Is_VMS_Exception);
6976 pragma Inline (Is_Valued_Procedure);
6977 pragma Inline (Is_Visible_Child_Unit);
6978 pragma Inline (Is_Visible_Formal);
6979 pragma Inline (Itype_Printed);
6980 pragma Inline (Kill_Elaboration_Checks);
6981 pragma Inline (Kill_Range_Checks);
6982 pragma Inline (Kill_Tag_Checks);
6983 pragma Inline (Known_To_Have_Preelab_Init);
6984 pragma Inline (Last_Assignment);
6985 pragma Inline (Last_Entity);
6986 pragma Inline (Limited_View);
6987 pragma Inline (Lit_Indexes);
6988 pragma Inline (Lit_Strings);
6989 pragma Inline (Low_Bound_Known);
6990 pragma Inline (Machine_Radix_10);
6991 pragma Inline (Master_Id);
6992 pragma Inline (Materialize_Entity);
6993 pragma Inline (Mechanism);
6994 pragma Inline (Modulus);
6995 pragma Inline (Must_Be_On_Byte_Boundary);
6996 pragma Inline (Must_Have_Preelab_Init);
6997 pragma Inline (Needs_Debug_Info);
6998 pragma Inline (Needs_No_Actuals);
6999 pragma Inline (Never_Set_In_Source);
7000 pragma Inline (Next_Index);
7001 pragma Inline (Next_Inlined_Subprogram);
7002 pragma Inline (Next_Literal);
7003 pragma Inline (No_Pool_Assigned);
7004 pragma Inline (No_Return);
7005 pragma Inline (No_Strict_Aliasing);
7006 pragma Inline (Non_Binary_Modulus);
7007 pragma Inline (Non_Limited_View);
7008 pragma Inline (Nonzero_Is_True);
7009 pragma Inline (Normalized_First_Bit);
7010 pragma Inline (Normalized_Position);
7011 pragma Inline (Normalized_Position_Max);
7012 pragma Inline (Object_Ref);
7013 pragma Inline (Obsolescent_Warning);
7014 pragma Inline (Original_Array_Type);
7015 pragma Inline (Original_Record_Component);
7016 pragma Inline (Overridden_Operation);
7017 pragma Inline (Package_Instantiation);
7018 pragma Inline (Packed_Array_Type);
7019 pragma Inline (Parameter_Mode);
7020 pragma Inline (Parent_Subtype);
7021 pragma Inline (Primitive_Operations);
7022 pragma Inline (Prival);
7023 pragma Inline (Privals_Chain);
7024 pragma Inline (Private_Dependents);
7025 pragma Inline (Private_View);
7026 pragma Inline (Protected_Body_Subprogram);
7027 pragma Inline (Protected_Formal);
7028 pragma Inline (Protected_Operation);
7029 pragma Inline (RM_Size);
7030 pragma Inline (Reachable);
7031 pragma Inline (Referenced);
7032 pragma Inline (Referenced_As_LHS);
7033 pragma Inline (Referenced_Object);
7034 pragma Inline (Register_Exception_Call);
7035 pragma Inline (Related_Array_Object);
7036 pragma Inline (Related_Instance);
7037 pragma Inline (Related_Interface);
7038 pragma Inline (Renamed_Entity);
7039 pragma Inline (Renamed_Object);
7040 pragma Inline (Renaming_Map);
7041 pragma Inline (Requires_Overriding);
7042 pragma Inline (Return_Present);
7043 pragma Inline (Return_Applies_To);
7044 pragma Inline (Returns_By_Ref);
7045 pragma Inline (Reverse_Bit_Order);
7046 pragma Inline (Scalar_Range);
7047 pragma Inline (Scale_Value);
7048 pragma Inline (Scope_Depth_Value);
7049 pragma Inline (Sec_Stack_Needed_For_Return);
7050 pragma Inline (Shadow_Entities);
7051 pragma Inline (Shared_Var_Assign_Proc);
7052 pragma Inline (Shared_Var_Read_Proc);
7053 pragma Inline (Size_Check_Code);
7054 pragma Inline (Size_Depends_On_Discriminant);
7055 pragma Inline (Size_Known_At_Compile_Time);
7056 pragma Inline (Small_Value);
7057 pragma Inline (Spec_Entity);
7058 pragma Inline (Storage_Size_Variable);
7059 pragma Inline (Static_Elaboration_Desired);
7060 pragma Inline (Static_Initialization);
7061 pragma Inline (Stored_Constraint);
7062 pragma Inline (Strict_Alignment);
7063 pragma Inline (String_Literal_Length);
7064 pragma Inline (String_Literal_Low_Bound);
7065 pragma Inline (Suppress_Elaboration_Warnings);
7066 pragma Inline (Suppress_Init_Proc);
7067 pragma Inline (Suppress_Style_Checks);
7068 pragma Inline (Suppress_Value_Tracking_On_Call);
7069 pragma Inline (Task_Body_Procedure);
7070 pragma Inline (Treat_As_Volatile);
7071 pragma Inline (Underlying_Full_View);
7072 pragma Inline (Universal_Aliasing);
7073 pragma Inline (Unset_Reference);
7074 pragma Inline (Used_As_Generic_Actual);
7075 pragma Inline (Uses_Sec_Stack);
7076 pragma Inline (Vax_Float);
7077 pragma Inline (Warnings_Off);
7078 pragma Inline (Was_Hidden);
7079 pragma Inline (Wrapped_Entity);
7081 pragma Inline (Init_Alignment);
7082 pragma Inline (Init_Component_Bit_Offset);
7083 pragma Inline (Init_Component_Size);
7084 pragma Inline (Init_Digits_Value);
7085 pragma Inline (Init_Esize);
7086 pragma Inline (Init_RM_Size);
7088 pragma Inline (Set_Abstract_Interfaces);
7089 pragma Inline (Set_Accept_Address);
7090 pragma Inline (Set_Access_Disp_Table);
7091 pragma Inline (Set_Actual_Subtype);
7092 pragma Inline (Set_Address_Taken);
7093 pragma Inline (Set_Abstract_Interface_Alias);
7094 pragma Inline (Set_Alias);
7095 pragma Inline (Set_Alignment);
7096 pragma Inline (Set_Associated_Final_Chain);
7097 pragma Inline (Set_Associated_Formal_Package);
7098 pragma Inline (Set_Associated_Node_For_Itype);
7099 pragma Inline (Set_Associated_Storage_Pool);
7100 pragma Inline (Set_Barrier_Function);
7101 pragma Inline (Set_Block_Node);
7102 pragma Inline (Set_Body_Entity);
7103 pragma Inline (Set_Body_Needed_For_SAL);
7104 pragma Inline (Set_CR_Discriminant);
7105 pragma Inline (Set_C_Pass_By_Copy);
7106 pragma Inline (Set_Can_Never_Be_Null);
7107 pragma Inline (Set_Checks_May_Be_Suppressed);
7108 pragma Inline (Set_Class_Wide_Type);
7109 pragma Inline (Set_Cloned_Subtype);
7110 pragma Inline (Set_Component_Bit_Offset);
7111 pragma Inline (Set_Component_Clause);
7112 pragma Inline (Set_Component_Size);
7113 pragma Inline (Set_Component_Type);
7114 pragma Inline (Set_Corresponding_Concurrent_Type);
7115 pragma Inline (Set_Corresponding_Discriminant);
7116 pragma Inline (Set_Corresponding_Equality);
7117 pragma Inline (Set_Corresponding_Record_Type);
7118 pragma Inline (Set_Corresponding_Remote_Type);
7119 pragma Inline (Set_Current_Use_Clause);
7120 pragma Inline (Set_Current_Value);
7121 pragma Inline (Set_Debug_Info_Off);
7122 pragma Inline (Set_Debug_Renaming_Link);
7123 pragma Inline (Set_Dispatch_Table_Wrapper);
7124 pragma Inline (Set_DTC_Entity);
7125 pragma Inline (Set_DT_Entry_Count);
7126 pragma Inline (Set_DT_Offset_To_Top_Func);
7127 pragma Inline (Set_DT_Position);
7128 pragma Inline (Set_Default_Expr_Function);
7129 pragma Inline (Set_Default_Expressions_Processed);
7130 pragma Inline (Set_Default_Value);
7131 pragma Inline (Set_Delay_Cleanups);
7132 pragma Inline (Set_Delay_Subprogram_Descriptors);
7133 pragma Inline (Set_Delta_Value);
7134 pragma Inline (Set_Dependent_Instances);
7135 pragma Inline (Set_Depends_On_Private);
7136 pragma Inline (Set_Digits_Value);
7137 pragma Inline (Set_Directly_Designated_Type);
7138 pragma Inline (Set_Discard_Names);
7139 pragma Inline (Set_Discriminal);
7140 pragma Inline (Set_Discriminal_Link);
7141 pragma Inline (Set_Discriminant_Checking_Func);
7142 pragma Inline (Set_Discriminant_Constraint);
7143 pragma Inline (Set_Discriminant_Default_Value);
7144 pragma Inline (Set_Discriminant_Number);
7145 pragma Inline (Set_Elaborate_Body_Desirable);
7146 pragma Inline (Set_Elaboration_Entity);
7147 pragma Inline (Set_Elaboration_Entity_Required);
7148 pragma Inline (Set_Enclosing_Scope);
7149 pragma Inline (Set_Entry_Accepted);
7150 pragma Inline (Set_Entry_Bodies_Array);
7151 pragma Inline (Set_Entry_Cancel_Parameter);
7152 pragma Inline (Set_Entry_Component);
7153 pragma Inline (Set_Entry_Formal);
7154 pragma Inline (Set_Entry_Parameters_Type);
7155 pragma Inline (Set_Enum_Pos_To_Rep);
7156 pragma Inline (Set_Enumeration_Pos);
7157 pragma Inline (Set_Enumeration_Rep);
7158 pragma Inline (Set_Enumeration_Rep_Expr);
7159 pragma Inline (Set_Equivalent_Type);
7160 pragma Inline (Set_Esize);
7161 pragma Inline (Set_Exception_Code);
7162 pragma Inline (Set_Extra_Accessibility);
7163 pragma Inline (Set_Extra_Constrained);
7164 pragma Inline (Set_Extra_Formal);
7165 pragma Inline (Set_Extra_Formals);
7166 pragma Inline (Set_Finalization_Chain_Entity);
7167 pragma Inline (Set_First_Entity);
7168 pragma Inline (Set_First_Index);
7169 pragma Inline (Set_First_Literal);
7170 pragma Inline (Set_First_Optional_Parameter);
7171 pragma Inline (Set_First_Private_Entity);
7172 pragma Inline (Set_First_Rep_Item);
7173 pragma Inline (Set_Freeze_Node);
7174 pragma Inline (Set_From_With_Type);
7175 pragma Inline (Set_Full_View);
7176 pragma Inline (Set_Function_Returns_With_DSP);
7177 pragma Inline (Set_Generic_Homonym);
7178 pragma Inline (Set_Generic_Renamings);
7179 pragma Inline (Set_Handler_Records);
7180 pragma Inline (Set_Has_Aliased_Components);
7181 pragma Inline (Set_Has_Alignment_Clause);
7182 pragma Inline (Set_Has_All_Calls_Remote);
7183 pragma Inline (Set_Has_Anon_Block_Suffix);
7184 pragma Inline (Set_Has_Atomic_Components);
7185 pragma Inline (Set_Has_Biased_Representation);
7186 pragma Inline (Set_Has_Completion);
7187 pragma Inline (Set_Has_Completion_In_Body);
7188 pragma Inline (Set_Has_Complex_Representation);
7189 pragma Inline (Set_Has_Component_Size_Clause);
7190 pragma Inline (Set_Has_Constrained_Partial_View);
7191 pragma Inline (Set_Has_Contiguous_Rep);
7192 pragma Inline (Set_Has_Controlled_Component);
7193 pragma Inline (Set_Has_Controlling_Result);
7194 pragma Inline (Set_Has_Convention_Pragma);
7195 pragma Inline (Set_Has_Delayed_Freeze);
7196 pragma Inline (Set_Has_Discriminants);
7197 pragma Inline (Set_Has_Dispatch_Table);
7198 pragma Inline (Set_Has_Enumeration_Rep_Clause);
7199 pragma Inline (Set_Has_Exit);
7200 pragma Inline (Set_Has_External_Tag_Rep_Clause);
7201 pragma Inline (Set_Has_Fully_Qualified_Name);
7202 pragma Inline (Set_Has_Gigi_Rep_Item);
7203 pragma Inline (Set_Has_Homonym);
7204 pragma Inline (Set_Has_Initial_Value);
7205 pragma Inline (Set_Has_Machine_Radix_Clause);
7206 pragma Inline (Set_Has_Master_Entity);
7207 pragma Inline (Set_Has_Missing_Return);
7208 pragma Inline (Set_Has_Nested_Block_With_Handler);
7209 pragma Inline (Set_Has_Forward_Instantiation);
7210 pragma Inline (Set_Has_Non_Standard_Rep);
7211 pragma Inline (Set_Has_Object_Size_Clause);
7212 pragma Inline (Set_Has_Per_Object_Constraint);
7213 pragma Inline (Set_Has_Persistent_BSS);
7214 pragma Inline (Set_Has_Pragma_Controlled);
7215 pragma Inline (Set_Has_Pragma_Elaborate_Body);
7216 pragma Inline (Set_Has_Pragma_Inline);
7217 pragma Inline (Set_Has_Pragma_Pack);
7218 pragma Inline (Set_Has_Pragma_Preelab_Init);
7219 pragma Inline (Set_Has_Pragma_Pure);
7220 pragma Inline (Set_Has_Pragma_Pure_Function);
7221 pragma Inline (Set_Has_Pragma_Unreferenced);
7222 pragma Inline (Set_Has_Pragma_Unreferenced_Objects);
7223 pragma Inline (Set_Has_Primitive_Operations);
7224 pragma Inline (Set_Has_Private_Declaration);
7225 pragma Inline (Set_Has_Qualified_Name);
7226 pragma Inline (Set_Has_RACW);
7227 pragma Inline (Set_Has_Record_Rep_Clause);
7228 pragma Inline (Set_Has_Recursive_Call);
7229 pragma Inline (Set_Has_Size_Clause);
7230 pragma Inline (Set_Has_Small_Clause);
7231 pragma Inline (Set_Has_Specified_Layout);
7232 pragma Inline (Set_Has_Specified_Stream_Input);
7233 pragma Inline (Set_Has_Specified_Stream_Output);
7234 pragma Inline (Set_Has_Specified_Stream_Read);
7235 pragma Inline (Set_Has_Specified_Stream_Write);
7236 pragma Inline (Set_Has_Static_Discriminants);
7237 pragma Inline (Set_Has_Storage_Size_Clause);
7238 pragma Inline (Set_Has_Stream_Size_Clause);
7239 pragma Inline (Set_Has_Subprogram_Descriptor);
7240 pragma Inline (Set_Has_Task);
7241 pragma Inline (Set_Has_Unchecked_Union);
7242 pragma Inline (Set_Has_Unknown_Discriminants);
7243 pragma Inline (Set_Has_Up_Level_Access);
7244 pragma Inline (Set_Has_Volatile_Components);
7245 pragma Inline (Set_Has_Xref_Entry);
7246 pragma Inline (Set_Hiding_Loop_Variable);
7247 pragma Inline (Set_Homonym);
7248 pragma Inline (Set_In_Package_Body);
7249 pragma Inline (Set_In_Private_Part);
7250 pragma Inline (Set_In_Use);
7251 pragma Inline (Set_Inner_Instances);
7252 pragma Inline (Set_Interface_Name);
7253 pragma Inline (Set_Is_AST_Entry);
7254 pragma Inline (Set_Is_Abstract_Subprogram);
7255 pragma Inline (Set_Is_Abstract_Type);
7256 pragma Inline (Set_Is_Local_Anonymous_Access);
7257 pragma Inline (Set_Is_Access_Constant);
7258 pragma Inline (Set_Is_Ada_2005_Only);
7259 pragma Inline (Set_Is_Aliased);
7260 pragma Inline (Set_Is_Asynchronous);
7261 pragma Inline (Set_Is_Atomic);
7262 pragma Inline (Set_Is_Bit_Packed_Array);
7263 pragma Inline (Set_Is_CPP_Class);
7264 pragma Inline (Set_Is_Called);
7265 pragma Inline (Set_Is_Character_Type);
7266 pragma Inline (Set_Is_Child_Unit);
7267 pragma Inline (Set_Is_Class_Wide_Equivalent_Type);
7268 pragma Inline (Set_Is_Compilation_Unit);
7269 pragma Inline (Set_Is_Completely_Hidden);
7270 pragma Inline (Set_Is_Concurrent_Record_Type);
7271 pragma Inline (Set_Is_Constr_Subt_For_U_Nominal);
7272 pragma Inline (Set_Is_Constr_Subt_For_UN_Aliased);
7273 pragma Inline (Set_Is_Constrained);
7274 pragma Inline (Set_Is_Constructor);
7275 pragma Inline (Set_Is_Controlled);
7276 pragma Inline (Set_Is_Controlling_Formal);
7277 pragma Inline (Set_Is_Descendent_Of_Address);
7278 pragma Inline (Set_Is_Discrim_SO_Function);
7279 pragma Inline (Set_Is_Dispatching_Operation);
7280 pragma Inline (Set_Is_Eliminated);
7281 pragma Inline (Set_Is_Entry_Formal);
7282 pragma Inline (Set_Is_Exported);
7283 pragma Inline (Set_Is_First_Subtype);
7284 pragma Inline (Set_Is_For_Access_Subtype);
7285 pragma Inline (Set_Is_Formal_Subprogram);
7286 pragma Inline (Set_Is_Frozen);
7287 pragma Inline (Set_Is_Generic_Actual_Type);
7288 pragma Inline (Set_Is_Generic_Instance);
7289 pragma Inline (Set_Is_Generic_Type);
7290 pragma Inline (Set_Is_Hidden);
7291 pragma Inline (Set_Is_Hidden_Open_Scope);
7292 pragma Inline (Set_Is_Immediately_Visible);
7293 pragma Inline (Set_Is_Imported);
7294 pragma Inline (Set_Is_Inlined);
7295 pragma Inline (Set_Is_Interface);
7296 pragma Inline (Set_Is_Instantiated);
7297 pragma Inline (Set_Is_Internal);
7298 pragma Inline (Set_Is_Interrupt_Handler);
7299 pragma Inline (Set_Is_Intrinsic_Subprogram);
7300 pragma Inline (Set_Is_Itype);
7301 pragma Inline (Set_Is_Known_Non_Null);
7302 pragma Inline (Set_Is_Known_Null);
7303 pragma Inline (Set_Is_Known_Valid);
7304 pragma Inline (Set_Is_Limited_Composite);
7305 pragma Inline (Set_Is_Limited_Interface);
7306 pragma Inline (Set_Is_Limited_Record);
7307 pragma Inline (Set_Is_Machine_Code_Subprogram);
7308 pragma Inline (Set_Is_Non_Static_Subtype);
7309 pragma Inline (Set_Is_Null_Init_Proc);
7310 pragma Inline (Set_Is_Obsolescent);
7311 pragma Inline (Set_Is_Optional_Parameter);
7312 pragma Inline (Set_Is_Overriding_Operation);
7313 pragma Inline (Set_Is_Package_Body_Entity);
7314 pragma Inline (Set_Is_Packed);
7315 pragma Inline (Set_Is_Packed_Array_Type);
7316 pragma Inline (Set_Is_Potentially_Use_Visible);
7317 pragma Inline (Set_Is_Preelaborated);
7318 pragma Inline (Set_Is_Primitive);
7319 pragma Inline (Set_Is_Primitive_Wrapper);
7320 pragma Inline (Set_Is_Private_Composite);
7321 pragma Inline (Set_Is_Private_Descendant);
7322 pragma Inline (Set_Is_Protected_Interface);
7323 pragma Inline (Set_Is_Public);
7324 pragma Inline (Set_Is_Pure);
7325 pragma Inline (Set_Is_Pure_Unit_Access_Type);
7326 pragma Inline (Set_Is_Raised);
7327 pragma Inline (Set_Is_Remote_Call_Interface);
7328 pragma Inline (Set_Is_Remote_Types);
7329 pragma Inline (Set_Is_Renaming_Of_Object);
7330 pragma Inline (Set_Is_Return_Object);
7331 pragma Inline (Set_Is_Shared_Passive);
7332 pragma Inline (Set_Is_Statically_Allocated);
7333 pragma Inline (Set_Is_Synchronized_Interface);
7334 pragma Inline (Set_Is_Tag);
7335 pragma Inline (Set_Is_Tagged_Type);
7336 pragma Inline (Set_Is_Task_Interface);
7337 pragma Inline (Set_Is_Thunk);
7338 pragma Inline (Set_Is_True_Constant);
7339 pragma Inline (Set_Is_Unchecked_Union);
7340 pragma Inline (Set_Is_Unsigned_Type);
7341 pragma Inline (Set_Is_VMS_Exception);
7342 pragma Inline (Set_Is_Valued_Procedure);
7343 pragma Inline (Set_Is_Visible_Child_Unit);
7344 pragma Inline (Set_Is_Visible_Formal);
7345 pragma Inline (Set_Is_Volatile);
7346 pragma Inline (Set_Itype_Printed);
7347 pragma Inline (Set_Kill_Elaboration_Checks);
7348 pragma Inline (Set_Kill_Range_Checks);
7349 pragma Inline (Set_Kill_Tag_Checks);
7350 pragma Inline (Set_Known_To_Have_Preelab_Init);
7351 pragma Inline (Set_Last_Assignment);
7352 pragma Inline (Set_Last_Entity);
7353 pragma Inline (Set_Limited_View);
7354 pragma Inline (Set_Lit_Indexes);
7355 pragma Inline (Set_Lit_Strings);
7356 pragma Inline (Set_Low_Bound_Known);
7357 pragma Inline (Set_Machine_Radix_10);
7358 pragma Inline (Set_Master_Id);
7359 pragma Inline (Set_Materialize_Entity);
7360 pragma Inline (Set_Mechanism);
7361 pragma Inline (Set_Modulus);
7362 pragma Inline (Set_Must_Be_On_Byte_Boundary);
7363 pragma Inline (Set_Must_Have_Preelab_Init);
7364 pragma Inline (Set_Needs_Debug_Info);
7365 pragma Inline (Set_Needs_No_Actuals);
7366 pragma Inline (Set_Never_Set_In_Source);
7367 pragma Inline (Set_Next_Inlined_Subprogram);
7368 pragma Inline (Set_No_Pool_Assigned);
7369 pragma Inline (Set_No_Return);
7370 pragma Inline (Set_No_Strict_Aliasing);
7371 pragma Inline (Set_Non_Binary_Modulus);
7372 pragma Inline (Set_Non_Limited_View);
7373 pragma Inline (Set_Nonzero_Is_True);
7374 pragma Inline (Set_Normalized_First_Bit);
7375 pragma Inline (Set_Normalized_Position);
7376 pragma Inline (Set_Normalized_Position_Max);
7377 pragma Inline (Set_Object_Ref);
7378 pragma Inline (Set_Obsolescent_Warning);
7379 pragma Inline (Set_Original_Array_Type);
7380 pragma Inline (Set_Original_Record_Component);
7381 pragma Inline (Set_Overridden_Operation);
7382 pragma Inline (Set_Package_Instantiation);
7383 pragma Inline (Set_Packed_Array_Type);
7384 pragma Inline (Set_Parent_Subtype);
7385 pragma Inline (Set_Primitive_Operations);
7386 pragma Inline (Set_Prival);
7387 pragma Inline (Set_Privals_Chain);
7388 pragma Inline (Set_Private_Dependents);
7389 pragma Inline (Set_Private_View);
7390 pragma Inline (Set_Protected_Body_Subprogram);
7391 pragma Inline (Set_Protected_Formal);
7392 pragma Inline (Set_Protected_Operation);
7393 pragma Inline (Set_RM_Size);
7394 pragma Inline (Set_Reachable);
7395 pragma Inline (Set_Referenced);
7396 pragma Inline (Set_Referenced_As_LHS);
7397 pragma Inline (Set_Referenced_Object);
7398 pragma Inline (Set_Register_Exception_Call);
7399 pragma Inline (Set_Related_Array_Object);
7400 pragma Inline (Set_Related_Instance);
7401 pragma Inline (Set_Related_Interface);
7402 pragma Inline (Set_Renamed_Entity);
7403 pragma Inline (Set_Renamed_Object);
7404 pragma Inline (Set_Renaming_Map);
7405 pragma Inline (Set_Requires_Overriding);
7406 pragma Inline (Set_Return_Present);
7407 pragma Inline (Set_Return_Applies_To);
7408 pragma Inline (Set_Returns_By_Ref);
7409 pragma Inline (Set_Reverse_Bit_Order);
7410 pragma Inline (Set_Scalar_Range);
7411 pragma Inline (Set_Scale_Value);
7412 pragma Inline (Set_Scope_Depth_Value);
7413 pragma Inline (Set_Sec_Stack_Needed_For_Return);
7414 pragma Inline (Set_Shadow_Entities);
7415 pragma Inline (Set_Shared_Var_Assign_Proc);
7416 pragma Inline (Set_Shared_Var_Read_Proc);
7417 pragma Inline (Set_Size_Check_Code);
7418 pragma Inline (Set_Size_Depends_On_Discriminant);
7419 pragma Inline (Set_Size_Known_At_Compile_Time);
7420 pragma Inline (Set_Small_Value);
7421 pragma Inline (Set_Spec_Entity);
7422 pragma Inline (Set_Storage_Size_Variable);
7423 pragma Inline (Set_Static_Elaboration_Desired);
7424 pragma Inline (Set_Static_Initialization);
7425 pragma Inline (Set_Stored_Constraint);
7426 pragma Inline (Set_Strict_Alignment);
7427 pragma Inline (Set_String_Literal_Length);
7428 pragma Inline (Set_String_Literal_Low_Bound);
7429 pragma Inline (Set_Suppress_Elaboration_Warnings);
7430 pragma Inline (Set_Suppress_Init_Proc);
7431 pragma Inline (Set_Suppress_Style_Checks);
7432 pragma Inline (Set_Suppress_Value_Tracking_On_Call);
7433 pragma Inline (Set_Task_Body_Procedure);
7434 pragma Inline (Set_Treat_As_Volatile);
7435 pragma Inline (Set_Underlying_Full_View);
7436 pragma Inline (Set_Universal_Aliasing);
7437 pragma Inline (Set_Unset_Reference);
7438 pragma Inline (Set_Used_As_Generic_Actual);
7439 pragma Inline (Set_Uses_Sec_Stack);
7440 pragma Inline (Set_Vax_Float);
7441 pragma Inline (Set_Warnings_Off);
7442 pragma Inline (Set_Was_Hidden);
7443 pragma Inline (Set_Wrapped_Entity);
7445 -- END XEINFO INLINES
7447 -- The following Inline pragmas are *not* read by xeinfo when building
7448 -- the C version of this interface automatically (so the C version will
7449 -- end up making out of line calls). The pragma scan in xeinfo will be
7450 -- terminated on encountering the END XEINFO INLINES line. We inline
7451 -- things here which are small, but not of the canonical attribute
7452 -- access/set format that can be handled by xeinfo.
7454 pragma Inline (Is_Package_Or_Generic_Package);
7455 pragma Inline (Is_Volatile);
7456 pragma Inline (Is_Wrapper_Package);
7457 pragma Inline (Known_RM_Size);
7458 pragma Inline (Known_Static_Component_Bit_Offset);
7459 pragma Inline (Known_Static_RM_Size);
7460 pragma Inline (Scope_Depth);
7461 pragma Inline (Scope_Depth_Set);
7462 pragma Inline (Unknown_RM_Size);
7464 end Einfo;