1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
11 -- Copyright (C) 1992-2001 Free Software Foundation, Inc. --
13 -- GNAT is free software; you can redistribute it and/or modify it under --
14 -- terms of the GNU General Public License as published by the Free Soft- --
15 -- ware Foundation; either version 2, or (at your option) any later ver- --
16 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
17 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
18 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
19 -- for more details. You should have received a copy of the GNU General --
20 -- Public License distributed with GNAT; see file COPYING. If not, write --
21 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
22 -- MA 02111-1307, USA. --
24 -- As a special exception, if other files instantiate generics from this --
25 -- unit, or you link this unit with other files to produce an executable, --
26 -- this unit does not by itself cause the resulting executable to be --
27 -- covered by the GNU General Public License. This exception does not --
28 -- however invalidate any other reasons why the executable file might be --
29 -- covered by the GNU Public License. --
31 -- GNAT was originally developed by the GNAT team at New York University. --
32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
34 ------------------------------------------------------------------------------
36 with Types; use Types;
37 with Uintp; use Uintp;
38 with Urealp; use Urealp;
42 -- This package defines the annotations to the abstract syntax tree that
43 -- are needed to support semantic processing of an Ada compilation.
45 -- These annotations are for the most part attributes of declared entities,
46 -- and they correspond to conventional symbol table information. Other
47 -- attributes include sets of meanings for overloaded names, possible
48 -- types for overloaded expressions, flags to indicate deferred constants,
49 -- incomplete types, etc. These attributes are stored in available fields
50 -- in tree nodes (i.e. fields not used by the parser, as defined by the
51 -- Sinfo package specification), and accessed by means of a set of
52 -- subprograms which define an abstract interface.
54 -- There are two kinds of semantic information
56 -- First, the tree nodes with the following Nkind values:
58 -- N_Defining_Identifier
59 -- N_Defining_Character_Literal
60 -- N_Defining_Operator_Symbol
62 -- are called Entities, and constitute the information that would often
63 -- be stored separately in a symbol table. These nodes are all extended
64 -- to provide extra space, and contain fields which depend on the entity
65 -- kind, as defined by the contents of the Ekind field. The use of the
66 -- Ekind field, and the associated fields in the entity, are defined
67 -- in this package, as are the access functions to these fields.
69 -- Second, in some cases semantic information is stored directly in other
70 -- kinds of nodes, e.g. the Etype field, used to indicate the type of an
71 -- expression. The access functions to these fields are defined in the
72 -- Sinfo package, but their full documentation is to be found in
73 -- the Einfo package specification.
75 -- Declaration processing places information in the nodes of their defining
76 -- identifiers. Name resolution places in all other occurrences of an
77 -- identifier a pointer to the corresponding defining occurrence.
79 --------------------------------
80 -- The XEINFO Utility Program --
81 --------------------------------
83 -- XEINFO is a utility program which automatically produces a C header file,
84 -- a-xeinfo.h from the spec and body of package Einfo. It reads the input
85 -- files einfo.ads and einfo.adb and produces the output file a-xeinfo.h.
87 -- In order for this utility program to operate correctly, the form of the
88 -- einfo.ads and einfo.adb files must meet certain requirements and be laid
89 -- out in a specific manner.
91 -- The general form of einfo.ads is as follows:
93 -- type declaration for type Entity_Kind
94 -- subtype declarations declaring subranges of Entity_Kind
95 -- subtype declarations declaring synonyms for some standard types
96 -- function specs for attributes
98 -- pragma Inline declarations
100 -- This order must be observed. There are no restrictions on the procedures,
101 -- since the C header file only includes functions (Gigi is not allowed to
102 -- modify the generated tree). However, functions are required to have headers
103 -- that fit on a single line.
105 -- XEINFO reads and processes the function specs and the pragma Inlines. For
106 -- functions that are declared as inlined, XEINFO reads the corresponding body
107 -- from xeinfo.adb, and processes it into C code. This results in some strict
108 -- restrictions on which functions can be inlined:
110 -- The function spec must be on a single line
112 -- There can only be a single statement, contained on a single line,
113 -- not counting any pragma Assert statements.
115 -- This single statement must either by a function call with simple,
116 -- single token arguments, or it must be a membership test of the form
117 -- a in b, where a and b are single tokens.
119 -- For functions that are not inlined, there is no restriction on the body,
120 -- and XEINFO generates a direct reference in the C header file which allows
121 -- the C code in Gigi to directly call the corresponding Ada body.
123 ----------------------------------
124 -- Handling of Type'Size Values --
125 ----------------------------------
127 -- The Ada 95 RM contains some rather peculiar (to us!) rules on the value
128 -- of type'Size (see RM 13.3(55)). We have found that attempting to use
129 -- these RM Size values generally, and in particular for determining the
130 -- default size of objects, creates chaos, and major incompatibilies in
133 -- We proceed as follows, for discrete and fixed-point subtypes, we have
134 -- two separate sizes for each subtype:
136 -- The Object_Size, which is used for determining the default size of
137 -- objects and components. This size value can be referred to using the
138 -- Object_Size attribute. The phrase "is used" here means that it is
139 -- the basis of the determination of the size. The backend is free to
140 -- pad this up if necessary for efficiency, e.g. an 8-bit stand-alone
141 -- character might be stored in 32 bits on a machine with no efficient
142 -- byte access instructions such as the Alpha.
144 -- The default rules for the value of Object_Size for fixed-point and
145 -- discrete types are as follows:
147 -- The Object_Size for base subtypes reflect the natural hardware
148 -- size in bits (see Ttypes and Cstand for integer types). For
149 -- enumeration and fixed-point base subtypes have 8. 16. 32 or 64
150 -- bits for this size, depending on the range of values to be stored.
152 -- The Object_Size of a subtype is the same as the Object_Size of
153 -- the subtype from which it is obtained.
155 -- The Object_Size of a derived base type is copied from the parent
156 -- base type, and the Object_Size of a derived first subtype is copied
157 -- from the parent first subtype.
159 -- The Value_Size which is the number of bits required to store a value
160 -- of the type. This size can be referred to using the Value_Size
161 -- attribute. This value is used to determine how tightly to pack
162 -- records or arrays with components of this type, and also affects
163 -- the semantics of unchecked conversion (unchecked conversions where
164 -- the Value_Size values differ generate a warning, and are potentially
165 -- target dependent).
167 -- The default rule for the value of Value_Size are as follows:
169 -- The Value_Size for a base subtype is the minimum number of bits
170 -- required to store all values of the type (including the sign bit
171 -- only if negative values are possible).
173 -- If a subtype statically matches the first subtype, then it has
174 -- by default the same Value_Size as the first subtype. This is a
175 -- consequence of RM 13.1(14) ("if two subtypes statically match,
176 -- then their subtype-specific aspects are the same".)
178 -- All other subtypes have a Value_Size corresponding to the minimum
179 -- number of bits required to store all values of the subtype. For
180 -- dynamic bounds, it is assumed that the value can range down or up
181 -- to the corresponding bound of the ancestor
183 -- The RM defined attribute Size corresponds to the Value_Size attribute.
185 -- The Size attribute may be defined for a first-named subtype. This sets
186 -- the Value_Size of the first-named subtype to the given value, and the
187 -- Object_Size of this first-named subtype to the given value padded up
188 -- to an appropriate boundary. It is a consequence of the default rules
189 -- above that this Object_Size will apply to all further subtypes. On the
190 -- otyher hand, Value_Size is affected only for the first subtype, any
191 -- dynamic subtypes obtained from it directly, and any statically matching
192 -- subtypes. The Value_Size of any other static subtypes is not affected.
194 -- Value_Size and Object_Size may be explicitly set for any subtype using
195 -- an attribute definition clause. Note that the use of these attributes
196 -- can cause the RM 13.1(14) rule to be violated. If two access types
197 -- reference aliased objects whose subtypes have differing Object_Size
198 -- values as a result of explicit attribute definition clauses, then it
199 -- is erroneous to convert from one access subtype to the other.
201 -- At the implementation level, Esize stores the Object_Size and the
202 -- RM_Size field stores the Value_Size (and hence the value of the
203 -- Size attribute, which, as noted above, is equivalent to Value_Size).
205 -- To get a feel for the difference, consider the following examples (note
206 -- that in each case the base is short_short_integer with a size of 8):
208 -- Object_Size Value_Size
210 -- type x1 is range 0..5; 8 3
212 -- type x2 is range 0..5;
213 -- for x2'size use 12; 12 12
215 -- subtype x3 is x2 range 0 .. 3; 12 2
217 -- subtype x4 is x2'base range 0 .. 10; 8 4
219 -- subtype x5 is x2 range 0 .. dynamic; 12 (7)
221 -- subtype x6 is x2'base range 0 .. dynamic; 8 (7)
223 -- Note: the entries marked (7) are not actually specified by the Ada 95 RM,
224 -- but it seems in the spirit of the RM rules to allocate the minimum number
225 -- of bits known to be large enough to hold the given range of values.
227 -- So far, so good, but GNAT has to obey the RM rules, so the question is
228 -- under what conditions must the RM Size be used. The following is a list
229 -- of the occasions on which the RM Size must be used:
231 -- Component size for packed arrays or records
232 -- Value of the attribute Size for a type
233 -- Warning about sizes not matching for unchecked conversion
235 -- The RM_Size field keeps track of the RM Size as needed in these
238 -- For types other than discrete and fixed-point types, the Object_Size
239 -- and Value_Size are the same (and equivalent to the RM attribute Size).
240 -- Only Size may be specified for such types.
242 -----------------------
243 -- Entity Attributes --
244 -----------------------
246 -- This section contains a complete list of the attributes that are defined
247 -- on entities. Some attributes apply to all entities, others only to certain
248 -- kinds of entities. In the latter case the attribute should only be set or
249 -- accessed if the Ekind field indicates an appropriate entity.
251 -- There are two kinds of attributes that apply to entities, stored and
252 -- synthesized. Stored attributes correspond to a field or flag in the entity
253 -- itself. Such attributes are identified in the table below by giving the
254 -- field or flag in the attribute that is used to hold the attribute value.
255 -- Synthesized attributes are not stored directly, but are rather computed as
256 -- needed from other attributes, or from information in the tree. These are
257 -- marked "synthesized" in the table below. The stored attributes have both
258 -- access functions and set procedures to set the corresponding values, while
259 -- synthesized attributes have only access functions.
261 -- Note: in the case of Node, Uint, or Elist fields, there are cases where
262 -- the same physical field is used for different purposes in different
263 -- entities, so these access functions should only be referenced for the
264 -- class of entities in which they are defined as being present. Flags are
265 -- not overlapped in this way, but nevertheless as a matter of style and
266 -- abstraction (which may or may not be checked by assertions in the body),
267 -- this restriction should be observed for flag fields as well.
269 -- Note: certain of the attributes on types apply only to base types, and
270 -- are so noted by the notation [base type only]. These are cases where the
271 -- attribute of any subtype is the same as the attribute of the base type.
272 -- The attribute can be referenced on a subtype (and automatically retrieves
273 -- the value from the base type), and if an attempt is made to set them on
274 -- other than a subtype, they will instead be set on the corresponding base
277 -- Other attributes are noted as applying the implementation base type only.
278 -- These are representation attributes which must always apply to a full
279 -- non-private type, and where the attributes are always on the full type.
280 -- The attribute can be referenced on a subtype (and automatically retries
281 -- the value from the implementation base type), and if an attempt is made
282 -- to set them on other than a subtype, they will instead be set on the
283 -- corresponding implementation base type.
285 -- Accept_Address (Elist21)
286 -- Present in entries. If an accept has a statement sequence, then an
287 -- address variable is created, which is used to hold the address of the
288 -- parameters, as passed by the runtime. Accept_Address holds an element
289 -- list which represents a stack of entities for these address variables.
290 -- The current entry is the top of the stack, which is the last element
291 -- on the list. A stack is required to handle the case of nested select
292 -- statements referencing the same entry.
294 -- Actual_Subtype (Node17)
295 -- Present in variables, constants, and formal parameters. This is the
296 -- subtype imposed by the value of the object, as opposed to its nominal
297 -- subtype, which is imposed by the declaration. The actual subtype
298 -- differs from the nominal one when the latter is indefinite (as in the
299 -- case of an unconstrained formal parameter, or a variable declared
300 -- with an unconstrained type and an initial value). The nominal subtype
301 -- is the Etype entry for the entity. The Actual_Subtype field is set
302 -- only if the actual subtype differs from the nominal subtype. If the
303 -- actual and nominal subtypes are the same, then the Actual_Subtype
304 -- field is Empty, and Etype indicates both types.
305 -- For objects, the Actual_Subtype is set only if this is a discriminated
306 -- type. For arrays, the bounds of the expression are obtained and the
307 -- Etype of the object is directly the constrained subtype. This is
308 -- rather irregular, and the semantic checks that depend on the nominal
309 -- subtype being unconstrained use flag Is_Constr_Subt_For_U_Nominal(qv).
311 -- Access_Disp_Table (Node16) [base type only]
312 -- Present in record type entities. For a tagged type, points to the
313 -- dispatch table associated with the tagged type. For a non-tagged
314 -- record, contains Empty.
316 -- Address_Clause (synthesized)
317 -- Applies to entries, objects and subprograms. Set if an address clause
318 -- is present which references the object or subprogram and points to
319 -- the N_Attribute_Definition_Clause node. Empty if no Address clause.
320 -- The expression in the address clause is always a constant that is
321 -- defined before the entity to which the address clause applies.
322 -- Note: Gigi references this field in E_Task_Type entities???
324 -- Address_Taken (Flag104)
325 -- Present in all entities. Set if the Address or Unrestricted_Access
326 -- attribute is applied directly to the entity, i.e. the entity is the
327 -- entity of the prefix of the attribute reference. Used by Gigi to
328 -- make sure that the address can be meaningfully taken.
331 -- Present in overloaded entities (literals, subprograms, entries).
332 -- Points to parent subprogram of a derived subprogram. Also used for
333 -- a subprogram renaming, where it points to the renamed subprogram.
334 -- Always empty for entries.
336 -- Alignment (Uint14)
337 -- Present in all entities for types and objects. This indicates the
338 -- desired alignment for a type, or the actual alignment for an object.
339 -- A value of zero (Uint_0) indicates that the alignment is not yet set.
340 -- The alignment can be set by an explicit alignment clause, or set by
341 -- the front-end in package Layout, or set by the back-end.
343 -- Alignment_Clause (synthesized)
344 -- Appllies to all entities for types and objects. If an alignment
345 -- attribute definition clause is present for the entity, then this
346 -- function returns the N_Attribute_Definition clause that specifies the
347 -- alignment. If no alignment clause applies to the type, then the call
348 -- to this function returns Empty. Note that the call can return a
349 -- non-Empty value even if Has_Alignment_Clause is not set (happens with
350 -- subtype and derived type declarations). Note also that a record
351 -- definition clause with an (obsolescent) mod clause is converted
352 -- into an attribute definition clause for this purpose.
354 -- Ancestor_Subtype (synthesized)
355 -- Applies to all type and subtype entities. If the argument is a
356 -- subtype then it returns the subtype or type from which the subtype
357 -- was obtained, otherwise it returns Empty.
359 -- Associated_Formal_Package (Node12)
360 -- Present in packages that are the actuals of formal_packages. Points
361 -- to the entity in the declaration for the formal package.
363 -- Associated_Node_For_Itype (Node8)
364 -- Present in all type and subtype entities. Set non-Empty only for
365 -- Itypes. Set to point to the associated node for the Itype, i.e.
366 -- the node whose elaboration generated the Itype. This is used for
367 -- copying trees, to determine whether or not to copy an Itype.
369 -- Associated_Storage_Pool (Node22)
370 -- Present in simple and general access type entities. References the
371 -- storage pool to be used for the corresponding collection. A value of
372 -- Empty means that the default pool is to be used.
374 -- Associated_Final_Chain (Node23)
375 -- Present in simple and general access type entities. References the
376 -- List_Controller object that holds the finalization chain on which
377 -- are attached dynamically allocated objects referenced by the access
378 -- type. Empty when the access type cannot reference a controlled object.
380 -- Barrier_Function (Node12)
381 -- Present in protected entries and entry families. This is the
382 -- subprogram declaration for the body of the function that returns
383 -- the value of the entry barrier.
385 -- Base_Type (synthesized)
386 -- Applies to all type entities. Returns the base type of a type or
387 -- subtype. The base type of a type is the type itself. The base type
388 -- of a subtype is the type that it constrains (which is always a type
389 -- entity, not some other subtype). Note that in the case of a subtype
390 -- of a private type, it is possible for the base type attribute to
391 -- return a private type, even if the subtype to which it applies is
392 -- non-private. See also Implementation_Base_Type. Note: it is allowed
393 -- to apply Base_Type to other than a type, in which case it simply
394 -- returns the entity unchanged.
396 -- Block_Node (Node11)
397 -- Present in block entities. Points to the identifier in the
398 -- Block_Statement itself. Used when retrieving the block construct
399 -- for finalization purposes, The block entity has an implicit label
400 -- declaration in the enclosing declarative part, and has otherwise
401 -- no direct connection in the tree with the block statement. The
402 -- link is to the identifier (which is an occurence of the entity)
403 -- and not to the block_statement itself, because the statement may
404 -- be rewritten, e.g. in the process of removing dead code.
406 -- Body_Entity (Node19)
407 -- Present in package and generic package entities, points to the
408 -- corresponding package body entity if one is present.
410 -- C_Pass_By_Copy (Flag125) [implementation base type only]
411 -- Present in record types. Set if a pragma Convention for the record
412 -- type specifies convention C_Pass_By_Copy. This convention name is
413 -- treated as identical in all respects to convention C, except that
414 -- if it is specified for a record type, then the C_Pass_By_Copy flag
415 -- is set, and if a foreign convention subprogram has a formal of the
416 -- corresponding type, then the parameter passing mechanism will be
417 -- set to By_Copy (unless specifically overridden by an Import or
421 -- Present in all entities. This field contains an entry into the names
422 -- table that has the character string of the identifier, character
423 -- literal or operator symbol. See Namet for further details. Note that
424 -- throughout the processing of the front end, this name is the simple
425 -- unqualified name. However, just before gigi is called, a call is made
426 -- to Qualify_All_Entity_Names. This causes entity names to be qualified
427 -- using the encoding described in exp_dbug.ads, and from that point on
428 -- (including post gigi steps such as cross-reference generation), the
429 -- entities will contain the encoded qualified names.
431 -- Class_Wide_Type (Node9)
432 -- Present in all type entities. For a tagged type or subtype, returns
433 -- the corresponding implicitly declared class-wide type. Set to Empty
434 -- for non-tagged types.
436 -- Cloned_Subtype (Node16)
437 -- Present in E_Record_Subtype and E_Class_Wide_Subtype entities.
438 -- Each such entity can either have a Discriminant_Constraint, in
439 -- which case it represents a distinct type from the base type (and
440 -- will have a list of components and discrimants in the list headed by
441 -- First_Entity) or else no such constraint, in which case it will be a
442 -- copy of the base type.
444 -- o Each element of the list in First_Entity is copied from the base
445 -- type; in that case, this field is Empty.
447 -- o The list in First_Entity is shared with the base type; in that
448 -- case, this field points to that entity.
450 -- A record or classwide subtype may also be a copy of some other
451 -- subtype and share the entities in the First_Entity with that subtype.
452 -- In that case, this field points to that subtype.
454 -- For E_Class_Wide_Subtype, the presence of Equivalent_Type overrides
455 -- this field. Note that this field ONLY appears in subtype entries, not
456 -- in type entries, it is not present, and it is an error to reference
457 -- Cloned_Subtype in an E_Record_Type or E_Class_Wide_Type entity.
460 -- This flag appears on all nodes, including entities, and indicates
461 -- that the node was created by the scanner or parser from the original
462 -- source. Thus for entities, it indicates that the entity is defined
463 -- in the original source program.
465 -- Component_Alignment (special field) [base type only]
466 -- Present in array and record entities. Contains a value of type
467 -- Component_Alignment_Kind indicating the alignment of components.
468 -- Set to Calign_Default normally, but can be overridden by use of
469 -- the Component_Alignment pragma. Note: this field is currently
470 -- stored in a non-standard way, see body for details.
472 -- Component_Bit_Offset (Uint11)
473 -- Present in record components (E_Component, E_Discriminant) if a
474 -- component clause applies to the component. First bit position of
475 -- given component, computed from the first bit and position values
476 -- given in the component clause. A value of No_Uint means that the
477 -- value is not yet known. The value can be set by the appearence of
478 -- an explicit component clause in a record representation clause,
479 -- or it can be set by the front-end in package Layout, or it can be
480 -- set by the backend. By the time backend processing is completed,
481 -- this field is always set. A negative value is used to represent
482 -- a value which is not known at compile time, and must be computed
483 -- at run-time (this happens if fields of a record have variable
484 -- lengths). See package Layout for details of these values.
486 -- Note: this field is obsolescent, to be eventually replaced entirely
487 -- by Normalized_First_Bit and Normalized_Position, but for the moment,
488 -- gigi is still using (and back annotating) this field, and gigi does
489 -- not know about the new fields. For the front end layout case, the
490 -- Component_Bit_Offset field is only set if it is static, and otherwise
491 -- the new Normalized_First_Bit and Normalized_Position fields are used.
493 -- Component_Clause (Node13)
494 -- Present in record components and discriminants. If a record
495 -- representation clause is present for the corresponding record
496 -- type a that specifies a position for the component, then the
497 -- Component_Clause field of the E_Component entity points to the
498 -- N_Component_Claue node. Set to Empty if no record representation
499 -- clause was present, or if there was no specification for this
502 -- Component_Size (Uint22) [implementation base type only]
503 -- Present in array types. It contains the component size value for
504 -- the array. A value of zero means that the value is not yet set.
505 -- The value can be set by the use of a component size clause, or
506 -- by the front end in package Layout, or by the backend. A negative
507 -- value is used to represent a value which is not known at compile
508 -- time, and must be computed at run-time (this happens if the type
509 -- of the component has a variable length size). See package Layout
510 -- for details of these values.
512 -- Component_Type (Node20) [implementation base type only]
513 -- Present in array types and subtypes, and also in the special
514 -- enumeration table type created for enumeration type. References
515 -- the entity for the component type.
517 -- Constant_Value (synthesized)
518 -- Applies to constants, named integers, and named reals. Obtains
519 -- the initialization expression for the entity. Will return Empty for
520 -- for a deferred constant whose full view is not available or in some
521 -- other cases of internal entities, which cannot be treated as
522 -- constants from the point of view of constant folding.
524 -- Corresponding_Concurrent_Type (Node18)
525 -- Present in record types that are constructed by the expander to
526 -- represent task and protected types (Is_Concurrent_Record_Type flag
527 -- set True). Points to the entity for the corresponding task type or
530 -- Corresponding_Discriminant (Node19)
531 -- Present in discriminants of a derived type, when the discriminant is
532 -- used to constrain a discriminant of the parent type. Points to the
533 -- corresponding discriminant in the parent type. Otherwise it is Empty.
535 -- Corresponding_Equality (Node13)
536 -- Present in function entities for implicit inequality operators.
537 -- Denotes the explicit or derived equality operation that creates
538 -- the implicit inequality. Note that this field is not present in
539 -- other function entities, only in implicit inequality routines,
540 -- where Comes_From_Source is always False.
542 -- Corresponding_Record_Type (Node18)
543 -- Present in protected and task types and subtypes. References the
544 -- entity for the corresponding record type constructed by the expander
545 -- (see Exp_Ch9). This type is used to represent values of the task type.
547 -- Corresponding_Remote_Type (Node22)
548 -- Present in record types that describe the fat pointer structure for
549 -- Remote_Access_To_Subrogram types. References the original access type.
551 -- CR_Discriminant (Node23)
552 -- Present in discriminants of concurrent types. Denotes the homologous
553 -- discriminant of the corresponding record type. The CR_Discriminant is
554 -- created at the same time as the discriminal, and used to replace
555 -- occurrences of the discriminant within the type declaration.
557 -- Debug_Info_Off (Flag166)
558 -- Present in all entities. Set if a pragma Suppress_Debug_Info applies
559 -- to the entity, or if internal processing in the compiler determines
560 -- that suppression of debug information is desirable.
562 -- Debug_Renaming_Link (Node13)
563 -- Used to link the enumeration literal of a debug renaming declaration
564 -- to the renamed entity. See Exp_Dbug.Debug_Renaming_Declaration for
565 -- details of the use of this field.
567 -- Declaration_Node (synthesized)
568 -- Applies to all entities. Returns the tree node for the declaration
569 -- that declared the entity. Normally this is just the Parent of the
570 -- entity. One exception arises with child units, where the parent of
571 -- the entity is a selected component or a defining program unit name.
572 -- Another exception is that if the entity is an incomplete type that
573 -- has been completed, then we obtain the declaration node denoted by
574 -- the full type, i.e. the full type declaration node.
576 -- Default_Expr_Function (Node21)
577 -- Present in parameters. It holds the entity of the parameterless
578 -- function that is built to evaluate the default expression if it is
579 -- more complex than a simple identifier or literal. For the latter
580 -- simple cases or if there is no default value, this field is Empty.
582 -- Default_Expressions_Processed (Flag108)
583 -- A flag in subprograms (functions, operators, procedures) and in
584 -- entries and entry families used to indicate that default expressions
585 -- have been processed and to avoid multiple calls to process the
586 -- default expressions (see Freeze.Process_Default_Expressions), which
587 -- would not only waste time, but also generate false error messages.
589 -- Default_Value (Node20)
590 -- Present in formal parameters. Points to the node representing the
591 -- expression for the default value for the parameter. Empty if the
592 -- parameter has no default value (which is always the case for OUT
593 -- and IN OUT parameters in the absence of errors).
595 -- Delay_Cleanups (Flag114)
596 -- Present in entities that have finalization lists (subprograms
597 -- blocks, and tasks). Set if there are pending generic body
598 -- instantiations for the corresponding entity. If this flag is
599 -- set, then generation of cleanup actions for the corresponding
600 -- entity must be delayed, since the insertion of the generic body
601 -- may affect cleanup generation (see Inline for further details).
603 -- Delay_Subprogram_Descriptors (Flag50)
604 -- Present in entities for which exception subprogram descriptors
605 -- are generated (subprograms, package declarations and package
606 -- bodies). Present if there are pending generic body instantiations
607 -- for the corresponding entity. If this flag is set, then generation
608 -- of the subprogram descriptor for the corresponding enities must
609 -- be delayed, since the insertion of the generic body may add entries
610 -- to the list of handlers.
612 -- Note: for subprograms, Delay_Subprogram_Descriptors is set if and
613 -- only if Delay_Cleanups is set. But Delay_Cleanups can be set for a
614 -- a block (in which case Delay_Subprogram_Descriptors is set for the
615 -- containing subprogram). In addition Delay_Subprogram_Descriptors is
616 -- set for a library level package declaration or body which contains
617 -- delayed instantiations (in this case the descriptor refers to the
618 -- enclosing elaboration procedure).
620 -- Delta_Value (Ureal18)
621 -- Present in fixed and decimal types. Points to a universal real
622 -- that holds value of delta for the type, as given in the declaration
623 -- or as inherited by a subtype or derived type.
625 -- Dependent_Instances (Elist8)
626 -- Present in packages that are instances. Holds list of instances
627 -- of inner generics. Used to place freeze nodes for those instances
628 -- after that of the current one, i.e. after the corresponding generic
631 -- Depends_On_Private (Flag14)
632 -- Present in all type entities. Set if the type is private or if it
633 -- depends on a private type.
635 -- Designated_Type (synthesized)
636 -- Applies to access types. Returns the designated type. Differs
637 -- from Directly_Designated_Type in that if the access type refers
638 -- to an incomplete type, and the full type is available, then this
639 -- full type is returned instead of the incomplete type.
641 -- Digits_Value (Uint17)
642 -- Present in floating point types and subtypes and decimal types and
643 -- subtypes. Contains the Digits value specified in the declaration.
645 -- Directly_Designated_Type (Node20)
646 -- Present in access types. This field points to the type that is
647 -- directly designated by the access type. In the case of an access
648 -- type to an incomplete type, this field references the incomplete
649 -- type. Note that in the semantic processing, what is useful in
650 -- nearly all cases is the full type designated by the access type.
651 -- The function Designated_Type obtains this full type in the case of
652 -- access to an incomplete type.
654 -- Discard_Names (Flag88)
655 -- Present in types and exception entities. Set if pragma Discard_Names
656 -- applies to the entity. It is also set for declarative regions and
657 -- package specs for which a Discard_Names pragma with zero arguments
658 -- has been encountered. The purpose of setting this flag is to be able
659 -- to set the Discard_Names attribute on enumeration types declared
660 -- after the pragma within the same declarative region.
662 -- Discriminal (Node17)
663 -- Present in discriminants (Discriminant formal: GNAT's first
664 -- coinage). The entity used as a formal parameter that corresponds
665 -- to a discriminant. See section "Use of Discriminants" for details.
667 -- Discriminal_Link (Node10)
668 -- Present in discriminals (which have an Ekind of E_In_Parameter,
669 -- or E_Constant), points back to corresponding discriminant.
671 -- Discriminant_Checking_Func (Node20)
672 -- Present in components. Points to the defining identifier of the
673 -- function built by the expander returns a Boolean indicating whether
674 -- the given record component exists for the current discriminant
677 -- Discriminant_Constraint (Elist21)
678 -- Present in entities whose Has_Discriminants flag is set (concurrent
679 -- types, subtypes, record types and subtypes, private types and
680 -- subtypes, limited private types and subtypes and incomplete types).
681 -- It is an error to reference the Discriminant_Constraint field if
682 -- Has_Disciminants is False.
684 -- If the Is_Constrained flag is set, Discriminant_Constraint points
685 -- to an element list containing the discriminant constraints in the
686 -- same order in which the discriminants are declared.
688 -- If the Is_Constrained flag is not set but the discriminants of the
689 -- unconstrained type have default initial values then this field
690 -- points to an element list giving these default initial values in
691 -- the same order in which the discriminants are declared. Note that
692 -- in this case the entity cannot be a tagged record type, because
693 -- discriminants in this case cannot have defaults.
695 -- If the entity is a tagged record implicit type, then this field is
696 -- inherited from the first subtype (so that the itype is subtype
697 -- conformant with its first subtype, which is needed when the first
698 -- subtype overrides primitive operations inherited by the implicit
701 -- In all other cases Discriminant_Constraint contains the empty
702 -- Elist (ie it is initialized with a call to New_Elmt_List).
704 -- Discriminant_Default_Value (Node20)
705 -- Present in discriminants. Points to the node representing the
706 -- expression for the default value of the discriminant. Set to
707 -- Empty if the discriminant has no default value.
709 -- Discriminant_Number (Uint15)
710 -- Present in discriminants. Gives the ranking of a discriminant in
711 -- the list of discriminants of the type, i.e. a sequential integer
712 -- index starting at 1 and ranging up to Number_Discriminants.
714 -- DTC_Entity (Node16)
715 -- Present in function and procedure entities. Set to Empty unless
716 -- the subprogram is dispatching in which case it references the
717 -- Dispatch Table pointer Component. That is to say the component _tag
718 -- for regular Ada tagged types, for CPP_Class types and their
719 -- descendants this field points to the component entity in the record
720 -- that is the Vtable pointer for the Vtable containing the entry that
721 -- references the subprogram.
723 -- DT_Entry_Count (Uint15)
724 -- Present in E_Component entities. Only used for component marked
725 -- Is_Tag. Store the number of entries in the Vtable (or Dispatch Table)
727 -- DT_Position (Uint15)
728 -- Present in function and procedure entities which are dispatching
729 -- (should not be referenced without first checking that flag
730 -- Is_Dispatching_Operation is True). Contains the offset into
731 -- the Vtable for the entry that references the subprogram.
734 -- Present in all entities. Contains a value of the enumeration type
735 -- Entity_Kind declared in a subsequent section in this spec.
737 -- Elaborate_All_Desirable (Flag146)
738 -- Present in package and subprogram entities, and in generic package
739 -- and subprogram entities. Set if internal analysis of a client that
740 -- with's this unit determines that Elaborate_All is desirable, i.e.
741 -- that there is a possibility that Program_Error may be raised if
742 -- Elaborate_All conditions cannot be met.
744 -- Elaboration_Entity (Node13)
745 -- Present in generic and non-generic package and subprogram
746 -- entities. This is a boolean entity associated with the unit that
747 -- is initiallly set to False, and is set True when the unit is
748 -- elaborated. This is used for two purposes. First, it is used to
749 -- implement required access before elaboration checks (the flag
750 -- must be true to call a subprogram at elaboration time). Second,
751 -- it is used to guard against repeated execution of the generated
754 -- Note that we always allocate this flag, and set this field, but
755 -- we do not always actually use it. It is only used if it is needed
756 -- for access-before-elaboration use (see Elaboration_Entity_Required
757 -- flag) or if either the spec or the body has elaboration code. If
758 -- neither of these two conditions holds, then the entity is still
759 -- allocated (since we don't know early enough whether or not there
760 -- is elaboration code), but is simply not used for any purpose.
762 -- Elaboration_Entity_Required (Flag174)
763 -- Present in generics and non-generic package and subprogram
764 -- entities. Set only if Elaboration_Entity is non-Empty to indicate
765 -- that the boolean is required to be set even if there is no other
766 -- elaboration code. This occurs when the Elaboration_Entity flag
767 -- is used for required access-before-elaboration checking. If the
768 -- flag is only for preventing multiple execution of the elaboration
769 -- code, then if there is no other elaboration code, obviously there
770 -- is no need to set the flag.
772 -- Enclosing_Dynamic_Scope (synthesized)
773 -- Appliesa to all entities. Returns the closest dynamic scope in which
774 -- the entity is declared or Standard_Standard for library-level entities
776 -- Enclosing_Scope (Node18)
777 -- Present in labels. Denotes the innermost enclosing construct that
778 -- contains the label. Identical to the scope of the label, except for
779 -- labels declared in the body of an accept statement, in which case the
780 -- entry_name is the Enclosing_Scope. Used to validate goto's within
781 -- accept statements.
783 -- Entry_Accepted (Flag152)
784 -- Present in E_Entry and E_Entry_Family entities. Set if there is
785 -- at least one accept for this entry in the task body. Used to
786 -- generate warnings for missing accepts.
788 -- Entry_Bodies_Array (Node15)
789 -- Present in protected types for which Has_Entries is true.
790 -- This is the defining identifier for the array of entry body
791 -- action procedures and barrier functions used by the runtime to
792 -- execute the user code associated with each entry.
794 -- Entry_Cancel_Parameter (Node23)
795 -- Present in blocks. This only applies to a block statement for
796 -- which the Is_Asynchronous_Call_Block flag is set. It
797 -- contains the defining identifier of an object that must be
798 -- passed to the Cancel_Task_Entry_Call or Cancel_Protected_Entry_Call
799 -- call in the cleanup handler added to the block by
800 -- Exp_Ch7.Expand_Cleanup_Actions. This parameter is a Boolean
801 -- object for task entry calls and a Communications_Block object
802 -- in the case of protected entry calls. In both cases the objects
803 -- are declared in outer scopes to this block.
805 -- Entry_Component (Node11)
806 -- Present in formal parameters (in, in out and out parameters). Used
807 -- only for formals of entries. References the corresponding component
808 -- of the entry parameter record for the entry.
810 -- Entry_Formal (Node16)
811 -- Present in components of the record built to correspond to entry
812 -- parameters. This field points from the component to the formal. It
813 -- is the back pointer corresponding to Entry_Component.
815 -- Entry_Index_Constant (Node18)
816 -- Present in an entry index parameter. This is an identifier that
817 -- eventually becomes the name of a constant representing the index
818 -- of the entry family member whose entry body is being executed. Used
819 -- to expand references to the entry index specification identifier.
821 -- Entry_Index_Type (synthesized)
822 -- Applies to an entry family. Denotes Etype of the subtype indication
823 -- in the entry declaration. Used to resolve the index expression in an
824 -- accept statement for a member of the family, and in the prefix of
825 -- 'COUNT when it applies to a family member.
827 -- Entry_Parameters_Type (Node15)
828 -- Present in entries. Points to the access-to-record type that is
829 -- constructed by the expander to hold a reference to the parameter
830 -- values. This reference is manipulated (as an address) by the
831 -- tasking runtime. The designated record represents a packaging
832 -- up of the entry parameters (see Exp_Ch9.Expand_N_Entry_Declaration
833 -- for further details). Entry_Parameters_Type is Empty if the entry
834 -- has no parameters.
836 -- Enumeration_Pos (Uint11)
837 -- Present in enumeration literals. Contains the position number
838 -- corresponding to the value of the enumeration literal.
840 -- Enumeration_Rep (Uint12)
841 -- Present in enumeration literals. Contains the representation that
842 -- corresponds to the value of the enumeration literal. Note that
843 -- this is normally the same as Enumeration_Pos except in the presence
844 -- of representation clauses, where Pos will still represent the
845 -- position of the literal within the type and Rep will have be the
846 -- value given in the representation clause.
848 -- Enumeration_Rep_Expr (Node22)
849 -- Present in enumeration literals. Points to the expression in an
850 -- associated enumeration rep clause that provides the representation
851 -- value for this literal. Empty if no enumeration rep clause for this
852 -- literal (or if rep clause does not have an entry for this literal,
853 -- an error situation). This is also used to catch duplicate entries
854 -- for the same literal.
856 -- Enum_Pos_To_Rep (Node23)
857 -- Present in enumeration types (but not enumeration subtypes). Set to
858 -- Empty unless the enumeration type has a non-standard representation
859 -- (i.e. at least one literal has a representation value different from
860 -- its pos value). In this case, Enum_Pos_To_Rep is the entity for an
861 -- array constructed when the type is frozen that maps Pos values to
862 -- corresponding Rep values. The index type of this array is Natural,
863 -- and the component type is a suitable integer type that holds the
864 -- full range of representation values.
866 -- Equivalent_Type (Node18)
867 -- Present in class wide types and subtypes, access to protected
868 -- subprogram types, and in exception_types. For a classwide type, it
869 -- is always Empty. For a class wide subtype, it points to an entity
870 -- created by the expander which gives Gigi an easily understandable
871 -- equivalent of the class subtype with a known size (given by an
872 -- initial value). See Exp_Util.Expand_Class_Wide_Subtype for further
873 -- details. For E_exception_type, this points to the record containing
874 -- the data necessary to represent exceptions (for further details, see
875 -- System.Standard_Library. For access_to_protected subprograms, it
876 -- denotes a record that holds pointers to the operation and to the
877 -- protected object. For remote Access_To_Subprogram types, it denotes
878 -- the record that is the fat pointer representation of an RAST.
881 -- Present in all types and subtypes, an also for components, constants,
882 -- and variables. Contains the Object_Size of the type or of the object.
883 -- A value of zero indicates that the value is not yet known.
885 -- For the case of components where a component clause is present, the
886 -- value is the value from the component clause, which must be non-
887 -- negative (but may be zero, which is acceptable for the case of
888 -- a type with only one possible value). It is also possible for Esize
889 -- of a component to be set without a component clause present, which
890 -- means that the component size is specified, but not the position.
891 -- See also RM_Size and the section on "Handling of Type'Size Values".
892 -- During gigi processing, the value is back annotated for all zero
893 -- values, so that after the call to gigi, the value is properly set.
896 -- Present in all entities. Represents the type of the entity, which
897 -- is itself another entity. For a type entity, points to the parent
898 -- type for a derived type, or if the type is not derived, points to
899 -- itself. For a subtype entity, Etype points to the base type.
901 -- Exception_Code (Uint22)
902 -- Present in exception entitites. Set to zero unless either an
903 -- Import_Exception or Export_Exception pragma applies to the
904 -- pragma and specifies a Code value. See description of these
905 -- pragmas for details. Note that this field is relevant only if
906 -- Is_VMS_Exception is set.
908 -- Extra_Formal (Node15)
909 -- Present in formal parameters in the non-generic case. Certain
910 -- parameters require extra implicit information to be passed
911 -- (e.g. the flag indicating if an unconstrained variant record
912 -- argument is constrained, and the accessibility level for
913 -- access parameters. See description of Extra_Constrained,
914 -- Extra_Accessibility fields for further details. Extra formal
915 -- parameters are constructed to represent these values, and
916 -- chained to the end of the list of formals using the
917 -- Extra_Formal field (i.e. the Extra_Formal field of the last
918 -- "real" formal points to the first extra formal, and the
919 -- Extra_Formal field of each extra formal points to the next
920 -- one, with Empty indicating the end of the list of extra
923 -- Extra_Accessibility (Node13)
924 -- Present in formal parameters in the non-generic case if
925 -- expansion is active. Normally Empty, but if a parameter is
926 -- one for which a dynamic accessibility check is required, then
927 -- an extra formal of type Natural is created (see description
928 -- of field Extra_Formal), and the Extra_Accessibility field of
929 -- the formal parameter points to the entity for this extra
930 -- formal. Also present in variables when compiling receiving
931 -- stubs. In this case, a non Empty value means that this
932 -- variable's accessibility depth has been transmitted by the
933 -- caller and must be retrieved through the entity designed by
934 -- this field instead of being computed.
936 -- Extra_Constrained (Node23)
937 -- Present in formal parameters in the non-generic case if
938 -- expansion is active. Normally Empty, but if a parameter is
939 -- one for which a dynamic indication of its constrained status
940 -- is required, then an extra formal of type Boolean is created
941 -- (see description of field Extra_Formal), and the
942 -- Extra_Constrained field of the formal parameter points to the
943 -- entity for this extra formal. Also present in variables when
944 -- compiling receiving stubs. In this case, a non empty value
945 -- means that this variable's constrained status has been
946 -- transmitted by the caller and must be retrieved through the
947 -- entity designed by this field instead of being computed.
949 -- Finalization_Chain_Entity (Node19)
950 -- Present in scopes which can have finalizable entities (blocks,
951 -- functions, procedures, tasks, entries). When this field is empty it
952 -- means that there are no finalization actions to perform on exit of the
953 -- scope. When this field contains 'Error', it means that no
954 -- finalization actions should happen at this level and the
955 -- finalization chain of a parent scope shall be used (??? this is
956 -- an improper use of 'Error' and should be changed). otherwise it
957 -- contains an entity of type Finalizable_Ptr that is the head of the
958 -- list of objects to finalize on exit. See "Finalization Management"
959 -- section in exp_ch7.adb for more details.
961 -- Finalize_Storage_Only (Flag158) [base type only]
962 -- Present in all types. Set on direct controlled types to which a
963 -- valid Finalize_Storage_Only pragma applies. This flag is also set on
964 -- composite types when they have at least one controlled component and
965 -- all their controlled components are Finalize_Storage_Only. It is also
966 -- inherited by type derivation except for direct controlled types where
967 -- the Finalize_Storage_Only pragma is required at each level of
970 -- First_Component (synthesized)
971 -- Applies to record types. Returns the first component by following
972 -- the chain of declared entities for the record until a component
973 -- is found (one with an Ekind of E_Component). The discriminants are
974 -- skipped. If the record is null, then Empty is returned.
976 -- First_Discriminant (synthesized)
977 -- Applies to types with discriminants. The discriminants are the
978 -- first entities declared in the type, so normally this is equivalent
979 -- to First_Entity. The exception arises for tagged types, where the
980 -- tag itself is prepended to the front of the entity chain, so the
981 -- First_Discriminant function steps past the tag if it is present.
983 -- First_Girder_Discriminant (synthesized)
984 -- Applies to types with discriminants. For tagged types, and untagged
985 -- types which are root types or derived types but which do not rename
986 -- discriminants in their root type, this is the same as
987 -- First_Discriminant.
989 -- For derived non-tagged types that rename discriminants in the root
990 -- type this is the first of the discriminants that occurr in the
991 -- root type. To be precise, in this case girder discriminants are
992 -- entities attached to the entity chain of the derived type which
993 -- are a copy of the discriminants of the root type. Furthermore their
994 -- Is_Completely_Hidden flag is set.
996 -- For derived untagged types, girder discriminants are the real
997 -- discriminants from Gigi's standpoint, ie those that will be stored in
998 -- actual objects of the type.
1000 -- First_Entity (Node17)
1001 -- Present in all entities which act as scopes to which a list of
1002 -- associated entities is attached (blocks, class subtypes and types,
1003 -- entries, functions, loops, packages, procedures, protected objects,
1004 -- record types and subtypes, private types, task types and subtypes).
1005 -- Points to a list of associated entities using the Next_Entity field
1006 -- as a chain pointer with Empty marking the end of the list.
1008 -- First_Formal (synthesized)
1009 -- Applies to subprograms and subprogram types, and also in entries
1010 -- and entry families. Returns first formal of the subprogram or entry.
1011 -- The formals are the first entities declared in a subprogram or in
1012 -- a subprogram type (the designated type of an Access_To_Subprogram
1013 -- definition) or in an entry.
1015 -- First_Index (Node17)
1016 -- Present in array types and subtypes and in string types and subtypes.
1017 -- By introducing implicit subtypes for the index constraints, we have
1018 -- the same structure for constrained and unconstrained arrays, subtype
1019 -- marks and discrete ranges are both represented by a subtype. This
1020 -- function returns the tree node corresponding to an occurrence of the
1021 -- first index (NOT the entity for the type). Subsequent indexes are
1022 -- obtained using Next_Index. Note that this field is present for the
1023 -- case of string literal subtypes, but is always Empty.
1025 -- First_Literal (Node17)
1026 -- Present in all enumeration types, including character and boolean
1027 -- types. This field points to the first enumeration literal entity
1028 -- for the type (i.e. it is set to First (Literals (N)) where N is
1029 -- the enumeration type definition node. A special case occurs with
1030 -- standard character and wide character types, where this field is
1031 -- Empty, since there are no enumeration literal lists in these cases.
1033 -- First_Optional_Parameter (Node14)
1034 -- Present in (non-generic) function and procedure entities. Set to a
1035 -- non-null value only if a pragma Import_Function, Import_Procedure
1036 -- or Import_Valued_Procedure specifies a First_Optional_Parameter
1037 -- argument, in which case this field points to the parameter entity
1038 -- corresponding to the specified parameter.
1040 -- First_Private_Entity (Node16)
1041 -- Present in all entities containing private parts (packages,
1042 -- protected types and subtypes, task types and subtypes). The
1043 -- entities on the entity chain are in order of declaration, so the
1044 -- entries for private entities are at the end of the chain. This
1045 -- field points to the first entity for the private part. It is
1046 -- Empty if there are no entities declared in the private part or
1047 -- if there is no private part.
1049 -- First_Rep_Item (Node6)
1050 -- Present in all entities. If non-empty, points to a linked list of
1051 -- representation pragmas nodes and representation clause nodes that
1052 -- apply to the entity, linked using Next_Rep_Item, with Empty marking
1053 -- the end of the list. In the case of derived types and subtypes, the
1054 -- new entity inherits the chain at the point of declaration. This
1055 -- means that it is possible to have multiple instances of the same
1056 -- kind of rep item on the chain, in which case it is the first one
1057 -- that applies to the entity.
1059 -- For most representation items, the representation information is
1060 -- reflected in other fields and flags in the entity. For example if
1061 -- a record representation clause is present, the component entities
1062 -- reflect the specified information. However, there are some items
1063 -- that are only reflected in the chain. These include:
1065 -- Alignment attribute definition clause
1066 -- Machine_Attribute pragma
1067 -- Link_Alias pragma
1068 -- Link-Section pragma
1069 -- Weak_External pragma
1071 -- If any of these items are present, then the flag Has_Gigi_Rep_Item
1072 -- is set, indicating that Gigi should search the chain.
1074 -- Other representation items are included in the chain so that error
1075 -- messages can easily locate the relevant nodes for posting errors.
1076 -- Note in particular that size clauses are present only for this
1077 -- purpose, and should only be accessed if Has_Size_Clause is set.
1079 -- First_Subtype (synthesized)
1080 -- Applies to all types and subtypes. For types, yields the first
1081 -- subtype of the type. For subtypes, yields the first subtype of
1082 -- the base type of the subtype.
1084 -- Freeze_Node (Node7)
1085 -- Present in all entities. If there is an associated freeze node for
1086 -- the entity, this field references this freeze node. If no freeze
1087 -- node is associated with the entity, then this field is Empty. See
1088 -- package Freeze for further details.
1090 -- From_With_Type (Flag159)
1091 -- Present in package and type entities. Indicates that the entity
1092 -- appears in a With_Type clause in the context of some other unit,
1093 -- either as the prefix (which must be a package), or as a type name.
1094 -- The package can only be used to retrieve such a type, and the type
1095 -- can be used only in component declarations and access definitions.
1096 -- The With_Type clause is used to construct mutually recursive
1097 -- types, i.e. record types (Java classes) that hold pointers to each
1098 -- other. If such a type is an access type, it has no explicit freeze
1099 -- node, so that the back-end does not attempt to elaborate it.
1101 -- Full_View (Node11)
1102 -- Present in all type and subtype entities and in deferred constants.
1103 -- References the entity for the corresponding full type declaration.
1104 -- For all types other than private and incomplete types, this field
1105 -- always contains Empty. See also Underlying_Type.
1107 -- Function_Returns_With_DSP (Flag169)
1108 -- Present in all subprogram entities, and type entities for access
1109 -- to subprogram values. Set True if the function (or referenced
1110 -- function in the case of an access value) returns with using the
1111 -- DSP (depressed stack pointer) approach. This can only be set
1112 -- True if Targparm.Functions_Return_By_DSP_On_Target is True and
1113 -- the function returns a value of a type whose size is not known
1116 -- Generic_Renamings (Elist23)
1117 -- Present in package and subprogram instances. Holds mapping that
1118 -- associates generic parameters with the corresponding instances, in
1119 -- those cases where the instance is an entity.
1121 -- Girder_Constraint (Elist23)
1122 -- Present in entities that can have discriminants (concurrent types
1123 -- subtypes, record types and subtypes, private types and subtypes,
1124 -- limited private types and subtypes and incomplete types). Points
1125 -- to an element list containing the expressions for each of the
1126 -- girder discriminants for the record (sub)type.
1128 -- Handler_Records (List10)
1129 -- Present in subprogram and package entities. Points to a list of
1130 -- identifiers referencing the handler record entities for the
1131 -- corresponding unit.
1133 -- Has_Aliased_Components (Flag135) [implementation base type only]
1134 -- Present in array type entities. Indicates that the component type
1135 -- of the array is aliased.
1137 -- Has_Alignment_Clause (Flag46)
1138 -- Present in all type entities and objects. Indicates if an alignment
1139 -- clause has been given for the entity. If set, then Alignment_Clause
1140 -- returns the N_Attribute_Definition node for the alignment attribute
1141 -- definition clause. Note that it is possible for this flag to be False
1142 -- even when Alignment_Clause returns non_Empty (this happens in the case
1143 -- of derived type declarations).
1145 -- Has_All_Calls_Remote (Flag79)
1146 -- Present in all library unit entities. Set true if the library unit
1147 -- has an All_Calls_Remote pragma. Note that such entities must also
1148 -- be RCI entities, so the flag Is_Remote_Call_Interface will always
1149 -- be set if this flag is set.
1151 -- Has_Atomic_Components (Flag86) [implementation base type only]
1152 -- Present in all types and objects. Set only for an array type or
1153 -- an array object if a valid pragma Atomic_Components applies to the
1154 -- type or object. Note that in the case of an object, this flag is
1155 -- only set on the object if there was an explicit pragma for the
1156 -- object. In other words, the proper test for whether an object has
1157 -- atomic components is to see if either the object or its base type
1158 -- has this flag set. Note that in the case of a type, the pragma will
1159 -- be chained to the rep item chain of the first subtype in the usual
1162 -- Has_Attach_Handler (synthesized)
1163 -- Applies to record types that are constructed by the expander to
1164 -- represent protected types. Returns True if there is at least one
1165 -- Attach_Handler pragma in the corresponding specification.
1167 -- Has_Biased_Representation (Flag139)
1168 -- Present in discrete types (where it applies to the type'size value),
1169 -- and to objects (both stand-alone and components), where it applies to
1170 -- the size of the object from a size or record component clause. In
1171 -- all cases it indicates that the size in question is smaller than
1172 -- would normally be required, but that the size requirement can be
1173 -- satisfied by using a biased representation, in which stored values
1174 -- have the low bound (Expr_Value (Type_Low_Bound (T)) subtracted to
1175 -- reduce the required size. For example, a type with a range of 1..2
1176 -- takes one bit, using 0 to represent 1 and 1 to represent 2.
1178 -- Note that in the object and component cases, the flag is only set
1179 -- if the type is unbiased, but the object specifies a smaller size
1180 -- than the size of the type, forcing biased representation for the
1181 -- object, but the subtype is still an unbiased type.
1183 -- Has_Completion (Flag26)
1184 -- Present in all entities that require a completion (functions,
1185 -- procedures, private types, limited private types, incomplete types,
1186 -- and packages that require a body). Set if the completion has been
1187 -- encountered and analyzed.
1189 -- Has_Completion_In_Body (Flag71)
1190 -- Present in "Taft amendment types" that is to say incomplete types
1191 -- whose full declaration appears in the package body.
1193 -- Has_Complex_Representation (Flag140) [implementation base type only]
1194 -- Present in all type entities. Set only for a record base type to
1195 -- which a valid pragma Complex_Representation applies.
1197 -- Has_Component_Size_Clause (Flag68) [implementation base type only]
1198 -- Present in all type entities. Set if a component size clause is
1199 -- present for the given type. Note that this flag can be False even
1200 -- if Component_Size is non-zero (happens in the case of derived types).
1202 -- Has_Controlling_Result (Flag98)
1203 -- Present in E_Function entities. True if The function is a primitive
1204 -- function of a tagged type which can dispatch on result
1206 -- Has_Controlled_Component (Flag43) [base type only]
1207 -- Present in composite type entities. Indicates that the type has a
1208 -- component that either is a controlled type, or itself contains a
1209 -- controlled component (i.e. either Has_Controlled_Component or
1210 -- Is_Controlled is set for at least one component).
1212 -- Has_Convention_Pragma (Flag119)
1213 -- Present in an entity for which a Convention, Import, or Export
1214 -- pragma has been given. Used to prevent more than one such pragma
1215 -- appearing for a given entity (RM B.1(45)).
1217 -- Has_Delayed_Freeze (Flag18)
1218 -- Present in all entities. Set to indicate that an explicit freeze
1219 -- node must be generated for the entity at its freezing point. See
1220 -- separate section ("Delayed Freezing and Elaboration") for details.
1222 -- Has_Discriminants (Flag5)
1223 -- Present in all types and subtypes. For types that are allowed to have
1224 -- discriminants (record types and subtypes, task types and subtypes,
1225 -- protected types and subtypes, private types, limited private types,
1226 -- and incomplete types), indicates if the corresponding type or subtype
1227 -- has a known discriminant part. Always false for all other types.
1229 -- Has_Entries (synthesized)
1230 -- Applies to concurrent types. True if any entries are declared
1231 -- within the task or protected definition for the type.
1233 -- Has_Enumeration_Rep_Clause (Flag66)
1234 -- Present in enumeration types. Set if an enumeration representation
1235 -- clause has been given for this enumeration type. Used to prevent more
1236 -- than one enumeration representation clause for a given type. Note
1237 -- that this does not imply a representation with holes, since the rep
1238 -- clause may merely confirm the default 0..N representation.
1240 -- Has_External_Tag_Rep_Clause (Flag110)
1241 -- Present in tagged types. Set if an external_tag rep. clause has been
1242 -- given for this type. Use to avoid the generation of the default
1245 -- Has_Exit (Flag47)
1246 -- Present in loop entities. Set if the loop contains an exit statement.
1248 -- Has_Foreign_Convention (synthesized)
1249 -- Applies to all entities. Determines if the Convention for the
1250 -- entity is a foreign convention (i.e. is other than Convention_Ada,
1251 -- Convention_Intrinsic, Convention_Entry or Convention_Protected).
1253 -- Has_Forward_Instantiation (Flag175)
1254 -- Present in package entities. Set true for packages that contain
1255 -- instantiations of local generic entities, before the corresponding
1256 -- generic body has been seen. If a package has a forward instantiation,
1257 -- we cannot inline subprograms appearing in the same package because
1258 -- the placement requirements of the instance will conflict with the
1259 -- linear elaboration of front-end inlining.
1261 -- Has_Fully_Qualified_Name (Flag173)
1262 -- Present in all entities. Set True if the name in the Chars field
1263 -- has been replaced by the fully qualified name, as used for debug
1264 -- output. See Exp_Dbug for a full description of the use of this
1265 -- flag and also the related flag Has_Qualified_Name.
1267 -- Has_Gigi_Rep_Item (Flag82)
1268 -- This flag is set if the rep item chain (referenced by First_Rep_Item
1269 -- and linked through the Next_Rep_Item chain contains a representation
1270 -- item that needs to be specially processed by Gigi, i.e. one of the
1273 -- Machine_Attribute pragma
1274 -- Linker_Alias pragma
1275 -- Linker_Section pragma
1276 -- Weak_External pragma
1278 -- If this flag is set, then Gigi should scan the rep item chain to
1279 -- process any of these items that appear. At least one such item will
1282 -- Has_Homonym (Flag56)
1283 -- Present in all entities. Set if an entity has a homonym in the same
1284 -- scope. Used by Gigi to generate unique names for such entities.
1286 -- Has_Interrupt_Handler (synthesized)
1287 -- Applies to all protected types entities. Set if the protected type
1288 -- definition contains at least one procedure to which a pragma
1289 -- Interrupt_Handler applies.
1291 -- Has_Machine_Radix_Clause (Flag83)
1292 -- Present in decimal types and subtypes, set if a Machine_Radix
1293 -- representation clause is present. This flag is used to detect
1294 -- the error of multiple machine radix clauses for a single type.
1296 -- Has_Master_Entity (Flag21)
1297 -- Present in entities that can appear in the scope stack (see spec
1298 -- of Sem). It is set if a task master entity (_master) has been
1299 -- declared and initialized in the corresponding scope.
1301 -- Has_Missing_Return (Flag142)
1302 -- Present in functions and generic functions. Set if there is one or
1303 -- more missing return statements in the function. This is used to
1304 -- control wrapping of the body in Exp_Ch6 to ensure that the program
1305 -- error exeption is correctly raised in this case at runtime.
1307 -- Has_Nested_Block_With_Handler (Flag101)
1308 -- Present in scope entities. Set if there is a nested block within the
1309 -- scope that has an exception handler and the two scopes are in the
1310 -- same procedure. This is used by the backend for controlling certain
1311 -- optimizations to ensure that they are consistent with exceptions.
1312 -- See documentation in Gigi for further details.
1314 -- Has_Non_Standard_Rep (Flag75) [implementation base type only]
1315 -- Present in all type entities. Set when some representation clause
1316 -- or pragma causes the representation of the item to be significantly
1317 -- modified. In this category are changes of small or radix for a
1318 -- fixed-point type, change of component size for an array, and record
1319 -- or enumeration representation clauses, as well as packed pragmas.
1320 -- All other representation clauses (e.g. Size and Alignment clauses)
1321 -- are not considered to be significant since they do not affect
1322 -- stored bit patterns.
1324 -- Has_Object_Size_Clause (Flag172)
1325 -- Present in entities for types and subtypes. Set if an Object_Size
1326 -- clause has been processed for the type Used to prevent multiple
1327 -- Object_Size clauses for a given entity.
1329 -- Has_Per_Object_Constraint (Flag154)
1330 -- Present in E_Component entities, true if the subtype of the
1331 -- component has a per object constraint, i.e. an actual discriminant
1332 -- value of the form T'Access, where T is the enclosing type.
1334 -- Has_Pragma_Controlled (Flag27) [implementation base type only]
1335 -- Present in access type entities. It is set if a pragma Controlled
1336 -- applies to the access type.
1338 -- Has_Pragma_Elaborate_Body (Flag150)
1339 -- Present in all entities. Set in compilation unit entities if a
1340 -- pragma Elaborate_Body applies to the compilation unit.
1342 -- Has_Pragma_Inline (Flag157)
1343 -- Present in all entities. Set for functions and procedures for which
1344 -- a pragma Inline or Inline_Always applies to the subprogram. Note
1345 -- subprogram. Note that this flag can be set even if Is_Inlined is
1346 -- not set. This happens for pragma Inline (if Inline_Active is False)
1347 -- In other words, the flag Has_Pragma_Inline represents the formal
1348 -- semantic status, and is used for checking semantic correctness.
1349 -- The flag Is_Inlined indicates whether inlining is actually active
1352 -- Has_Pragma_Pack (Flag121) [implementation base type only]
1353 -- Present in all entities. It indicates that a valid pragma Pack was
1354 -- was given for the type. Note that this flag is not inherited by a
1355 -- derived type. See also the Is_Packed flag.
1357 -- Has_Pragma_Pure_Function (Flag179)
1358 -- Present in subprogram entities. It indicates that a valid pragma
1359 -- Pure_Function was given for the entity. In some cases, we need to
1360 -- know that Is_Pure was explicitly set using this pragma.
1362 -- Has_Primitive_Operations (Flag120) [base type only]
1363 -- Present in all type entities. Set if at least one primitive operation
1364 -- is defined on the type. This flag is not yet properly set ???
1366 -- Has_Private_Ancestor (synthesized)
1367 -- Applies to all type and subtype entities. Returns True if at least
1368 -- one ancestor is private, and otherwise False if there are no private
1371 -- Has_Private_Declaration (Flag155)
1372 -- Present in all entities. Returns True if it is the defining entity
1373 -- of a private type declaration or its corresponding full declaration.
1374 -- This flag is thus preserved when the full and the partial views are
1375 -- exchanged, to indicate if a full type declaration is a completion.
1376 -- Used for semantic checks in E.4 (18), and elsewhere.
1378 -- Has_Qualified_Name (Flag161)
1379 -- Present in all entities. Set True if the name in the Chars field
1380 -- has been replaced by its qualified name, as used for debug output.
1381 -- See Exp_Dbug for a full description of qualification requirements.
1382 -- For some entities, the name is the fully qualified name, but there
1383 -- are exceptions. In particular, for local variables in procedures,
1384 -- we do not include the procedure itself or higher scopes. See also
1385 -- the flag Has_Fully_Qualified_Name, which is set if the name does
1386 -- indeed include the fully qualified name.
1388 -- Has_Record_Rep_Clause (Flag65)
1389 -- Present in record types. Set if a record representation clause has
1390 -- been given for this record type. Used to prevent more than one such
1391 -- clause for a given record type. Note that this is initially cleared
1392 -- for a derived type, even though the representation is inherited. See
1393 -- also the flag Has_Specified_Layout.
1395 -- Has_Recursive_Call (Flag143)
1396 -- Present in procedures. Set if a direct parameterless recursive call
1397 -- is detected while analyzing the body. Used to activate some error
1398 -- checks for infinite recursion.
1400 -- Has_Size_Clause (Flag29)
1401 -- Present in entities for types and objects. Set if a size clause is
1402 -- present for the entity. Used to prevent multiple Size clauses for a
1403 -- given entity. Note that it is always initially cleared for a derived
1404 -- type, even though the Size for such a type is inherited from a Size
1405 -- clause given for the parent type.
1407 -- Has_Small_Clause (Flag67)
1408 -- Present in ordinary fixed point types (but not subtypes). Indicates
1409 -- that a small clause has been given for the entity. Used to prevent
1410 -- multiple Small clauses for a given entity. Note that it is always
1411 -- initially cleared for a derived type, even though the Small for such
1412 -- a type is inherited from a Small clause given for the parent type.
1414 -- Has_Specified_Layout (Flag100)
1415 -- Present in all type entities. Set for a record type or subtype if
1416 -- the record layout has been specified by a record representation
1417 -- clause. Note that this differs from the flag Has_Record_Rep_Clause
1418 -- in that it is inherited by a derived type. Has_Record_Rep_Clause is
1419 -- used to indicate that the type is mentioned explicitly in a record
1420 -- representation clause, and thus is not inherited by a derived type.
1421 -- This flag is always False for non-record types.
1423 -- Has_Storage_Size_Clause (Flag23) [implementation base type only]
1424 -- Present in task types and access types. It is set if a Storage_Size
1425 -- clause is present for the type. Used to prevent multiple clauses for
1426 -- one type. Note that this flag is initially cleared for a derived type
1427 -- even though the Storage_Size for such a type is inherited from a
1428 -- Storage_Size clause given for the parent type. Note that in the case
1429 -- of access types, this flag is present only in the root type, since a
1430 -- storage size clause cannot be given to a derived type.
1432 -- Has_Subprogram_Descriptor (Flag93)
1433 -- This flag is set on entities for which zero-cost exception subprogram
1434 -- descriptors can be generated (subprograms and library level package
1435 -- declarations and bodies). It indicates that a subprogram descriptor
1436 -- has been generated, and is used to suppress generation of multiple
1437 -- descriptors (e.g. when instantiating generic bodies).
1439 -- Has_Task (Flag30) [base type only]
1440 -- Present in all type entities. Set on task types themselves, and also
1441 -- (recursively) on any composite type which has a component for which
1442 -- Has_Task is set. The meaning is that an allocator of such an object
1443 -- must create the required tasks. Note that the flag is not set on
1444 -- access types, even if they designate an object that Has_Task.
1446 -- Has_Unchecked_Union (Flag123) [base type only]
1447 -- Present in all type entities. Set on unchecked unions themselves
1448 -- and (recursively) on any composite type which has a component for
1449 -- which Has_Unchecked_Union is set. The meaning is that a comparison
1450 -- operation for the type is not permitted. Note that the flag is not
1451 -- set on access types, even if they designate an object that has
1452 -- the flag Has_Unchecked_Union set.
1454 -- Has_Unknown_Discriminants (Flag72)
1455 -- Present in all type entities. Types can have unknown discriminants
1456 -- either from their declaration or through type derivation. The use
1457 -- of this flag exactly meets the spec in RM 3.7(26). Note that all
1458 -- class-wide types are considered to have unknown discriminants.
1460 -- Has_Volatile_Components (Flag87) [implementation base type only]
1461 -- Present in all types and objects. Set only for an array type or
1462 -- array object if a valid pragma Volatile_Components or a valid
1463 -- pragma Atomic_Components applies to the type or object. Note that
1464 -- in the case of an object, this flag is only set on the object if
1465 -- there was an explicit pragma for the object. In other words, the
1466 -- proper test for whether an object has volatile components is to
1467 -- see if either the object or its base type has this flag set. Note
1468 -- that in the case of a type the pragma will be chained to the rep
1469 -- item chain of the first subtype in the usual manner.
1471 -- Hiding_Loop_Variable (Node8)
1472 -- Present in variables. Set only if a variable of a discrete type is
1473 -- hidden by a loop variable in the same local scope, in which case
1474 -- the Hiding_Loop_Variable field of the hidden variable points to
1475 -- the E_Loop_Variable entity doing the hiding. Used in processing
1476 -- warning messages if the hidden variable turns out to be unused
1477 -- or is referenced without being set.
1480 -- Present in all entities. Link for list of entities that have the
1481 -- same source name and that are declared in the same or enclosing
1482 -- scopes. Homonyms in the same scope are overloaded. Used for name
1483 -- resolution and for the generation of debugging information.
1485 -- Implementation_Base_Type (synthesized)
1486 -- Applies to all types. Similar to Base_Type, but never returns a
1487 -- private type when applied to a non-private type. Instead in this
1488 -- case, it always returns the Representation_Type of the base type
1489 -- in this case, so that we still have a concrete type. Note: it is
1490 -- allowed to apply Implementation_Base_Type to other than a type,
1491 -- in which case it simply returns the entity unchanged.
1493 -- In_Package_Body (Flag48)
1494 -- Set on the entity that denotes the package (the defining occurrence
1495 -- of the package declaration) while analyzing and expanding the package
1496 -- body. Reset on completion of analysis/expansion.
1498 -- In_Private_Part (Flag45)
1499 -- Present in package entities. Flag is set to indicate that the
1500 -- private part is being analyzed. The flag is reset at the end of the
1501 -- package declaration.
1503 -- Inner_Instances (Elist23)
1504 -- Present in generic units. Contains element list of units that are
1505 -- instantiated within the given generic. Used to diagnose circular
1508 -- Interface_Name (Node21)
1509 -- Present in exceptions, functions, procedures, variables, constants,
1510 -- and packages. Set to Empty unless an export, import, or interface
1511 -- name pragma has explicitly specified an external name, in which
1512 -- case it references an N_String_Literal node for the specified
1513 -- exteral name. In the case of exceptions, the field is set by
1514 -- Import_Exception/Export_Exception (which can be used in OpenVMS
1515 -- versions only). Note that if this field is Empty, and Is_Imported
1516 -- or Is_Exported is set, then the default interface name is the name
1517 -- of the entity, cased in a manner that is appropriate to the system
1518 -- in use. Note that Interface_Name is ignored if an address clause
1519 -- is present (since it is meaningless in this case).
1521 -- An additional special case usage of this field is in JGNAT for
1522 -- E_Component and E_Discriminant. JGNAT allows these entities to
1523 -- be imported by specifying pragma Import within a component's
1524 -- containing record definition. This supports interfacing to
1525 -- object fields defined within Java classes, and such pragmas
1526 -- are generated by the jvm2ada binding generator tool whenever
1527 -- it processes classes with public object fields. A pragma Import
1528 -- for a component can define the External_Name of the imported
1529 -- Java field (which is generally needed, because Java names are
1533 -- Present in packages and types. Set when analyzing a use clause for
1534 -- the corresponding entity. Reset at end of corresponding declarative
1535 -- part. The flag on a type is also used to determine the visibility of
1536 -- the primitive operators of the type.
1538 -- Is_Abstract (Flag19)
1539 -- Present in all types, and also for functions and procedures. Set
1540 -- for abstract types and abstract subprograms.
1542 -- Is_Access_Constant (Flag69)
1543 -- Present in access types and subtypes. Indicates that the keyword
1544 -- constant was present in the access type definition.
1546 -- Is_Access_Type (synthesized)
1547 -- Applies to all entities, true for access types and subtypes
1549 -- Is_Aliased (Flag15)
1550 -- Present in objects whose declarations carry the keyword aliased,
1551 -- and on record components that have the keyword.
1553 -- Is_Always_Inlined (synthesized)
1554 -- Present in subprograms. True if there is a pragma Inline_Always for
1557 -- Is_AST_Entry (Flag132)
1558 -- Present in entry entities. Set if a valid pragma AST_Entry applies
1559 -- to the entry. This flag can only be set in OpenVMS versions of GNAT.
1560 -- Note: we also allow the flag to appear in entry families, but given
1561 -- the current implementation of the pragma AST_Entry, this flag will
1562 -- always be False in entry families.
1564 -- Is_Atomic (Flag85)
1565 -- Present in all type entities, and also in constants, components and
1566 -- variables. Set if a pragma Atomic or Shared applies to the entity.
1567 -- In the case of private and incomplete types, this flag is set in
1568 -- both the partial view and the full view.
1570 -- Is_Array_Type (synthesized)
1571 -- Applies to all entities, true for array types and subtypes
1573 -- Is_Asynchronous (Flag81)
1574 -- Present in all type entities and in procedure entities. Set
1575 -- if a pragma Asynchronous applies to the entity.
1577 -- Is_Bit_Packed_Array (Flag122)
1578 -- Present in all entities. This flag is set for a packed array
1579 -- type that is bit packed (i.e. the component size is known by the
1580 -- front end and is in the range 1-7, 9-15, or 17-31). Is_Packed is
1581 -- always set if Is_Bit_Packed_Array is set, but it is possible for
1582 -- Is_Packed to be set without Is_Bit_Packed_Array or the case of an
1583 -- array having one or more index types that are enumeration types
1584 -- with non-standard enumeration representations.
1586 -- Is_Boolean_Type (synthesized)
1587 -- Applies to all entities, true for boolean types and subtypes,
1588 -- i.e. Standard.Boolean and all types ultimately derived from it.
1590 -- Is_By_Copy_Type (synthesized)
1591 -- Applies to all type entities. Returns true if the entity is
1592 -- a by copy type (RM 6.2(3)).
1594 -- Is_By_Reference_Type (synthesized)
1595 -- Applies to all type entities. True if the type is required to
1596 -- be passed by reference, as defined in (RM 6.2(4-9)).
1598 -- Is_Called (Flag102)
1599 -- Present in subprograms. Returns true if the subprogram is called
1600 -- in the unit being compiled or in a unit in the context. Used for
1603 -- Is_Character_Type (Flag63)
1604 -- Present in all entities, true for character types and subtypes,
1605 -- i.e. enumeration types that have at least one character literal.
1607 -- Is_Child_Unit (Flag73)
1608 -- Present in all entities. Set only for defining entities of program
1609 -- units that are child units (but False for subunits).
1611 -- Is_Class_Wide_Type (synthesized)
1612 -- Applies to all entities, true for class wide types and subtypes
1614 -- Is_Compilation_Unit (Flag149)
1615 -- Present in all entities. Set if the entity is a package or subprogram
1616 -- entity for a compilation unit other than a subunit (since we treat
1617 -- subunits as part of the same compilation operation as the ultimate
1618 -- parent, we do not consider them to be separate units for this flag).
1620 -- Is_Completely_Hidden (Flag103)
1621 -- A flag set on an E_Discriminant entity. This flag can be set only
1622 -- for girder discriminants of untagged types. When set, the entity
1623 -- is a girder discriminant of a derived untagged type which is not
1624 -- directly visible in the derived type because the derived type or
1625 -- one of its ancestors have renamed the discriminants in the root
1626 -- type. Note that there are girder discriminants which are not
1627 -- Completely_Hidden (eg the discriminants of a root type).
1629 -- Is_Composite_Type (synthesized)
1630 -- Applies to all entities, true for all composite types and
1631 -- subtypes. Either Is_Composite_Type or Is_Elementary_Type (but
1632 -- not both) is true of any type.
1634 -- Is_Concurrent_Record_Type (Flag20)
1635 -- Present in record types and subtypes. Set if the type was created
1636 -- by the expander to represent a task or protected type. For every
1637 -- concurrent type, such as record type is constructed, and task and
1638 -- protected objects are instances of this record type at runtime
1639 -- (Gigi will replace declarations of the concurrent type using the
1640 -- declarations of the corresponding record type). See package Exp_Ch9
1641 -- for further details.
1643 -- Is_Concurrent_Type (synthesized)
1644 -- Applies to all entities, true for task types and subtypes and
1645 -- for protected types and subtypes.
1647 -- Is_Constrained (Flag12)
1648 -- Present in types or subtypes which may have index, discriminant
1649 -- or range constraint (i.e. array types and subtypes, record types
1650 -- and subtypes, string types and subtypes, and all numeric types).
1651 -- Set if the type or subtype is constrained.
1653 -- Is_Constr_Subt_For_U_Nominal (Flag80)
1654 -- Present in all types and subtypes. Set true only for the constructed
1655 -- subtype of an object whose nominal subtype is unconstrained. Note
1656 -- that the constructed subtype itself will be constrained.
1658 -- Is_Constr_Subt_For_UN_Aliased (Flag141)
1659 -- This flag can only be set if Is_Constr_Subt_For_U_Nominal is set. It
1660 -- indicates that in addition the object concerned is aliased. This flag
1661 -- is used by Gigi to determine whether a template must be constructed.
1663 -- Is_Constructor (Flag76)
1664 -- Present in function and procedure entities. Set if a pragma
1665 -- CPP_Constructor applies to the subprogram.
1667 -- Is_Controlled (Flag42) [base type only]
1668 -- Present in all type entities. Indicates that the type is controlled,
1669 -- i.e. is either a descendant of Ada.Finalization.Controlled or of
1670 -- Ada.Finalization.Limited_Controlled.
1672 -- Is_Controlling_Formal (Flag97)
1673 -- Present in all Formal_Kind entity. Marks the controlling parameters
1674 -- of dispatching operations.
1676 -- Is_CPP_Class (Flag74)
1677 -- Present in all type entities, set only for tagged and untagged
1678 -- record types to which the pragma CPP_Class has been applied.
1680 -- Is_Decimal_Fixed_Point_Type (synthesized)
1681 -- Applies to all type entities, true for decimal fixed point
1682 -- types and subtypes.
1684 -- Is_Derived_Type (synthesized)
1685 -- Applies to all type entities. Determine if given entity is a
1688 -- Is_Destructor (Flag77)
1689 -- Present in function and procedure entities. Set if a pragma
1690 -- CPP_Destructor applies to the subprogram.
1692 -- Is_Discrete_Type (synthesized)
1693 -- Applies to all entities, true for all discrete types and subtypes
1695 -- Is_Discrete__Or_Fixed_Point_Type (synthesized)
1696 -- Applies to all entities, true for all discrete types and subtypes
1697 -- and all fixed-point types and subtypes.
1699 -- Is_Discrim_SO_Function (Flag176)
1700 -- Present in all entities, set only in E_Function entities that Layout
1701 -- creates to compute discriminant-dependent dynamic size/offset values.
1703 -- Is_Dispatching_Operation (Flag6)
1704 -- Present in all entities. Set true for procedures, functions,
1705 -- generic procedures and generic functions if the corresponding
1706 -- operation is dispatching.
1708 -- Is_Dynamic_Scope (synthesized)
1709 -- Applies to all Entities. Returns True if the entity is a dynamic
1710 -- scope (i.e. a block, a subprogram a task_type or an entry).
1712 -- Is_Elementary_Type (synthesized)
1713 -- Applies to all entities, true for all elementary types and
1714 -- subtypes. Either Is_Composite_Type or Is_Elementary_Type (but
1715 -- not both) is true of any type.
1717 -- Is_Eliminated (Flag124)
1718 -- Present in type entities, subprogram entities, and object entities.
1719 -- Indicates that the corresponding entity has been eliminated by use
1720 -- of pragma Eliminate.
1722 -- Is_Enumeration_Type (synthesized)
1723 -- Present in all entities, true for enumeration types and subtypes
1725 -- Is_Entry (synthesized)
1726 -- Applies to all entities, True only for entry and entry family
1727 -- entities and False for all other entity kinds.
1729 -- Is_Entry_Formal (Flag52)
1730 -- Present in all entities. Set only for entry formals (which can
1731 -- only be in, in-out or out parameters). This flag is used to speed
1732 -- up the test for the need to replace references in Exp_Ch2.
1734 -- Is_Exported (Flag99)
1735 -- Present in all entities. Set if the entity is exported. For now we
1736 -- only allow the export of constants, exceptions, functions, procedures
1737 -- and variables, but that may well change later on. Exceptions can only
1738 -- be exported in the OpenVMS and Java VM implementations of GNAT.
1740 -- Is_First_Subtype (Flag70)
1741 -- Present in all entities. True for first subtypes (RM 3.2.1(6)),
1742 -- i.e. the entity in the type declaration that introduced the type.
1743 -- This may be the base type itself (e.g. for record declarations and
1744 -- enumeration type declarations), or it may be the first subtype of
1745 -- an anonymous base type (e.g. for integer type declarations or
1746 -- constrained array declarations).
1748 -- Is_Fixed_Point_Type (synthesized)
1749 -- Applies to all entities, true for decimal and ordinary fixed
1750 -- point types and subtypes
1752 -- Is_Floating_Point_Type (synthesized)
1753 -- Applies to all entities, true for float types and subtypes
1755 -- Is_Formal (synthesized)
1756 -- Applies to all entities, true for IN, IN OUT and OUT parameters
1758 -- Is_Formal_Subprogram (Flag111)
1759 -- Defined on all entities, true for generic formal subprograms.
1761 -- Is_For_Access_Subtype (Flag118)
1762 -- Present in E_Private_Subtype and E_Record_Subtype entities.
1763 -- Means the sole purpose of the type is to be designated by an
1764 -- Access_Subtype and hence should not be expanded into components
1765 -- because the type may not have been found or frozen yet.
1767 -- Is_Frozen (Flag4)
1768 -- Present in all type entities. Set if the type has been frozen.
1770 -- Is_Generic_Actual_Type (Flag94)
1771 -- Present in the subtype declaration that renames the generic formal
1772 -- as a subtype of the actual. Guarantees that the subtype is not static
1773 -- within the instance.
1775 -- Is_Generic_Instance (Flag130)
1776 -- Present in all entities. Set to indicate that the entity is an
1777 -- instance of a generic unit.
1779 -- Is_Generic_Type (Flag13)
1780 -- Present in types which are generic formal types. Such types have an
1781 -- Ekind that corresponds to their classification, so the Ekind cannot
1782 -- be used to identify generic types.
1784 -- Is_Generic_Unit (synthesized)
1785 -- Applies to all entities. Yields True for a generic unit (generic
1786 -- package, generic function, generic procedure), and False for all
1789 -- Is_Hidden (Flag57)
1790 -- Present in all entities. Set true for all entities declared in the
1791 -- private part or body of a package. Also marks generic formals of a
1792 -- formal package declared without a box. For library level entities,
1793 -- this flag is set if the entity is not publicly visible.
1795 -- Is_Hidden_Open_Scope (Flag171)
1796 -- Present in all entities. Set true for a scope that contains the
1797 -- instantiation of a child unit, and whose entities are not visible
1798 -- during analysis of the instance.
1800 -- Is_Immediately_Visible (Flag7)
1801 -- Present in all entities. Set if entity is immediately visible, i.e.
1802 -- is defined in some currently open scope (RM 8.3(4)).
1804 -- Is_Imported (Flag24)
1805 -- Present in all entities. Set if the entity is imported. For now we
1806 -- only allow the import of exceptions, functions, procedures, packages.
1807 -- and variables. Exceptions can only be imported in the OpenVMS and
1808 -- Java VM implementations of GNAT. Packages and types can only be
1809 -- imported in the Java VM implementation.
1811 -- Is_Incomplete_Or_Private_Type (synthesized)
1812 -- Applies to all entities, true for private and incomplete types
1814 -- Is_Indefinite_Subtype (synthesized)
1815 -- Applies to all entities for types and subtypes. Determines if given
1816 -- entity is an unconstrained array type or subtype, a discriminated
1817 -- record type or subtype with no initial discriminant values or a
1818 -- class wide type or subtype.
1820 -- Is_Inlined (Flag11)
1821 -- Present in all entities. Set for functions and procedures which are
1822 -- to be inlined. For subprograms created during expansion, this flag
1823 -- may be set directly by the expander to request inlining. Also set
1824 -- for packages that contain inlined subprograms, whose bodies must be
1825 -- be compiled. Is_Inlined is also set on generic subprograms and is
1826 -- inherited by their instances. It is also set on the body entities
1827 -- of inlined subprograms. See also Has_Pragma_Inline.
1829 -- Is_Instantiated (Flag126)
1830 -- Present in generic packages and generic subprograms. Set if the unit
1831 -- is instantiated from somewhere in the extended main source unit. This
1832 -- flag is used to control warnings about the unit being uninstantiated.
1833 -- Also set in a package that is used as an actual for a generic package
1834 -- formal in an instantiation. Also set on a parent instance, in the
1835 -- instantiation of a child, which is implicitly declared in the parent.
1837 -- Is_Integer_Type (synthesized)
1838 -- Applies to all entities, true for integer types and subtypes
1840 -- Is_Internal (Flag17)
1841 -- Present in all entities. Set to indicate an entity created during
1842 -- semantic processing (e.g. an implicit type). Need more documentation
1845 -- Is_Interrupt_Handler (Flag89)
1846 -- Present in protected procedures. Set if a pragma Interrupt_Handler
1847 -- applies to the procedure (which must be parameterless).
1849 -- Is_Intrinsic_Subprogram (Flag64)
1850 -- Present in functions and procedures. It is set if a valid pragma
1851 -- Interface or Import is present for this subprogram specifying pragma
1852 -- Intrinsic. Valid means that the name and profile of the subprogram
1853 -- match the requirements of one of the recognized intrinsic subprograms
1854 -- (see package Sem_Intr for details). Note: the value of Convention for
1855 -- such an entity will be set to Convention_Intrinsic, but it is the
1856 -- setting of Is_Intrinsic_Subprogram, NOT simply having convention set
1857 -- to intrinsic, which causes intrinsic code to be generated.
1859 -- Is_Itype (Flag91)
1860 -- Present in all entities, set for Itypes. If it is set, then the
1861 -- declaration for the type does not appear explicitly in the tree.
1862 -- Instead gigi will elaborate the type when it is first used.
1863 -- Has_Delayed_Freeze can be set for Itypes, and the meaning is that
1864 -- the first use (the one which causes the type to be defined) will
1865 -- be the freeze node. Note that an important restriction on Itypes
1866 -- is that the first use of such a type (the one that causes it to be
1867 -- defined) must be in the same scope as the type.
1869 -- Is_Known_Valid (Flag170)
1870 -- Present in all entities. Relevant for types (and subtype) and
1871 -- for objects (and enumeration literals) of a discrete type.
1873 -- The purpose of this flag is to implement the requirement stated
1874 -- in (RM 13.9.1(9-11)) which require that the use of possibly invalid
1875 -- values may not cause programs to become erroneous. See the function
1876 -- Exp_Util.Expr_Known_Valid for further details. Note that the setting
1877 -- is conservative, in the sense that if the flag is set, it must be
1878 -- right. If the flag is not set, nothing is known about the validity.
1880 -- For enumeration literals, the flag is always set, since clearly
1881 -- an enumeration literal represents a valid value. Range checks
1882 -- where necessary will ensure that this valid value is appropriate.
1884 -- For objects, the flag indicates the state of knowledge about the
1885 -- current value of the object. This may be modified during expansion,
1886 -- and thus the final value is not relevant to gigi.
1888 -- For types and subtypes, the flag is set if all possible bit patterns
1889 -- of length Object_Size (i.e. Esize of the type) represent valid values
1890 -- of the type. In general for such tytpes, all values are valid, the
1891 -- only exception being the case where an object of the type has an
1892 -- explicit size that is greater than Object_Size.
1894 -- For non-discrete objects, the setting of the Is_Known_Valid flag is
1895 -- not defined, and is not relevant, since the considerations of the
1896 -- requirement in (RM 13.9.1(9-11)) do not apply.
1898 -- Is_Limited_Composite (Flag106)
1899 -- Present in all entities. True for composite types that have a
1900 -- limited component. Used to enforce the rule that operations on
1901 -- the composite type that depend on the full view of the component
1902 -- do not become visible until the immediate scope of the composite
1903 -- type itself (RM 7.3.1 (5)).
1905 -- Is_Limited_Record (Flag25)
1906 -- Present in all entities. Set to true for record (sub)types if the
1907 -- record is declared to be limited. Note that this flag is not set
1908 -- simply because some components of the record are limited.
1910 -- Is_Limited_Type (synthesized)
1911 -- Applies to all entities. True if entity is a limited type (limited
1912 -- private type, task type, protected type, composite containing a
1913 -- limited component, or a subtype of any of these types).
1915 -- Is_Machine_Code_Subprogram (Flag137)
1916 -- Present in subprogram entities. Set to indicate that the subprogram
1917 -- is a machine code subprogram (i.e. its body includes at least one
1918 -- code statement). Also indicates that all necessary semantic checks
1919 -- as required by RM 13.8 have been performed.
1921 -- Is_Non_Static_Subtype (Flag109)
1922 -- This flag is present in all type and subtype entities. It is set in
1923 -- some (but not all) cases in which a subtype is known to be non-static.
1924 -- Before this flag was added, the computation of whether a subtype was
1925 -- static was entirely synthesized, by looking at the bounds, and the
1926 -- immediate subtype parent. However, this method does not work for some
1927 -- Itypes that have no parent set (and the only way to find the immediate
1928 -- subtype parent is to go through the tree). For now, this flay is set
1929 -- conservatively, i.e. if it is set then for sure the subtype is non-
1930 -- static, but if it is not set, then the type may or may not be static.
1931 -- Thus the test for a static subtype is that this flag is clear AND
1932 -- that the bounds are static AND that the parent subtype (if available
1933 -- to be tested) is static. Eventually we should make sure this flag
1934 -- is always set right, at which point, these comments can be removed,
1935 -- and the tests for static subtypes greatly simplified.
1937 -- Is_Null_Init_Proc (Flag178)
1938 -- Present in procedure entities. Set for generated init_proc procedures
1939 -- (used to initialize composite types), if the code for the procedure
1940 -- is null (i.e. is a return and nothing else). Such null initialization
1941 -- procedures are generated in case some client is compiled using the
1942 -- Initialize_Scalars pragma, generating a call to this null procedure,
1943 -- but there is no need to call such procedures within a compilation
1944 -- unit, and this flag is used to suppress such calls.
1946 -- Is_Numeric_Type (synthesized)
1947 -- Applies to all entities, true for all numeric types and subtypes
1948 -- (integer, fixed, float).
1950 -- Is_Object (synthesized)
1951 -- Applies to all entities, true for entities representing objects,
1952 -- including generic formal parameters.
1954 -- Is_Optional_Parameter (Flag134)
1955 -- Present in parameter entities. Set if the parameter is specified as
1956 -- optional by use of a First_Optional_Parameter argument to one of the
1957 -- extended Import pragmas. Can only be set for OpenVMS versions of GNAT.
1959 -- Is_Ordinary_Fixed_Point_Type (synthesized)
1960 -- Applies to all entities, true for ordinary fixed point types
1963 -- Is_Package (synthesized)
1964 -- Applies to all entities. True for packages and generic packages.
1965 -- False for all other entities.
1967 -- Is_Package_Body_Entity (Flag160)
1968 -- Present in all entities. Set for entities defined at the top level
1969 -- of a package body. Used to control externally generated names.
1971 -- Is_Packed (Flag51) [implementation base type only]
1972 -- Present in all type entities. This flag is set only for record and
1973 -- array types which have a packed representation. There are three
1974 -- cases which cause packing:
1976 -- 1. Explicit use of pragma Pack for an array of package components
1977 -- 2. Explicit use of pragma Pack to pack a record
1978 -- 4. Setting Component_Size of an array to a bit-packable value
1979 -- 3. Indexing an array with a non-standard enumeration type.
1981 -- For records, Is_Packed is always set if Has_Pack_Pragma is set,
1982 -- and can also be set on its own in a derived type which inherited
1983 -- its packed status.
1985 -- For arrays, Is_Packed is set if an array is bit packed (i.e. the
1986 -- component size is known at compile time and is 1-7, 9-15 or 17-31),
1987 -- or if the array has one or more index types that are enumeration
1988 -- types with non-standard representations (in GNAT, we store such
1989 -- arrays compactly, using the Pos of the enumeration type value).
1991 -- As for the case of records, Is_Packed can be set on its own for a
1992 -- derived type, with the same dual before/after freeze meaning.
1993 -- Is_Packed can also be set as the result of an explicit component
1994 -- size clause that specifies an appropriate component size.
1996 -- In the bit packed array case, Is_Bit_Packed_Array will be set in
1997 -- the bit packed case once the array type is frozen.
1999 -- Before an array type is frozen, Is_Packed will always be set if
2000 -- Has_Pack_Pragma is set. Before the freeze point, it is not possible
2001 -- to know the component size, since the component type is not frozen
2002 -- until the array type is frozen. Thus Is_Packed for an array type
2003 -- before it is frozen means that packed is required. Then if it turns
2004 -- out that the component size is not suitable for bit packing, the
2005 -- Is_Packed flag gets turned off.
2007 -- Is_Packed_Array_Type (Flag138)
2008 -- Present in all entities. This flag is set on the entity for the type
2009 -- used to implement a packed array (either a modular type, or a subtype
2010 -- of Packed_Bytes{1,2,4} as appropriate). The flag is set if and only
2011 -- if the type appears in the Packed_Array_Type field of some other type
2012 -- entity. It is used by Gigi to activate the special processing for such
2013 -- types (unchecked conversions that would not otherwise be allowed are
2014 -- allowed for such types).
2016 -- Is_Potentially_Use_Visible (Flag9)
2017 -- Present in all entities. Set if entity is potentially use visible,
2018 -- i.e. it is defined in a package that appears in a currently active
2019 -- use clause (RM 8.4(8)). Note that potentially use visible entities
2020 -- are not necessarily use visible (RM 8.4(9-11)).
2022 -- Is_Preelaborated (Flag59)
2023 -- Present in all entities, set in E_Package and E_Generic_Package
2024 -- entities to which a pragma Preelaborate is applied, and also in
2025 -- all entities within such packages. Note that the fact that this
2026 -- flag is set does not necesarily mean that no elaboration code is
2027 -- generated for the package.
2029 -- Is_Private_Composite (Flag107)
2030 -- Present in composite types that have a private component. Used to
2031 -- enforce the rule that operations on the composite type that depend
2032 -- on the fulll view of the component, do not become visible until the
2033 -- immediate scope of the composite type itself (7.3.1 (5)). Both this
2034 -- flag and Is_Limited_Composite are needed.
2036 -- Is_Private_Descendant (Flag53)
2037 -- Present in entities that can represent library units (packages,
2038 -- functions, procedures). Set if the library unit is itself a private
2039 -- child unit, or if it is the descendent of a private child unit.
2041 -- Is_Private_Type (synthesized)
2042 -- Applies to all entities, true for private types and subtypes,
2043 -- as well as for record with private types as subtypes
2045 -- Is_Protected_Type (synthesized)
2046 -- Applies to all entities, true for protected types and subtypes
2048 -- Is_Psected (Flag153)
2049 -- Present in entities for objects, true if a valid Psect_Object
2050 -- pragma applies to the object. Used to detect duplicate pragmas.
2052 -- Is_Public (Flag10)
2053 -- Present in all entities. Set to indicate that an entity defined in
2054 -- one compilation unit can be referenced from other compilation units.
2055 -- If this reference causes a reference in the generated variable, for
2056 -- example in the case of a variable name, then Gigi will generate an
2057 -- appropriate external name for use by the linker.
2059 -- Is_Protected_Private (synthesized)
2060 -- Applies to a record component. Returns true if this component
2061 -- is used to represent a private declaration of a protected type.
2063 -- Is_Protected_Record_Type (synthesized)
2064 -- Applies to all entities, true if Is_Concurrent_Record_Type
2065 -- Corresponding_Concurrent_Type is a protected type.
2068 -- Present in all entities. Set in all entities of a unit to which a
2069 -- pragma Pure is applied, and also set for the entity of the unit
2070 -- itself. In addition, this flag may be set for any other functions
2071 -- or procedures that are known to be side effect free, so in the case
2072 -- of subprograms, the Is_Pure flag may be used by the optimizer to
2073 -- imply that it can assume freedom from side effects (other than those
2074 -- resulting from assignment to out parameters, or to objects designated
2075 -- by access parameters).
2077 -- Is_Real_Type (synthesized)
2078 -- Applies to all entities, true for real types and subtypes
2080 -- Is_Record_Type (synthesized)
2081 -- Applies to all entities, true for record types and subtypes,
2082 -- includes class-wide types and subtypes (which are also records)
2084 -- Is_Remote_Call_Interface (Flag62)
2085 -- Present in all entities, set in E_Package and E_Generic_Package
2086 -- entities to which a pragma Remote_Call_Interace is applied, and
2087 -- also in all entities within such packages.
2089 -- Is_Remote_Types (Flag61)
2090 -- Present in all entities, set in E_Package and E_Generic_Package
2091 -- entities to which a pragma Remote_Types is applied, and also in
2092 -- all entities within such packages.
2094 -- Is_Renaming_Of_Object (Flag112)
2095 -- Present in all entities, set only for a variable or constant for
2096 -- which the Renamed_Object field is non-empty and for which the
2097 -- renaming is handled by the front end, by macro substitution of
2098 -- a copy of the (evaluated) name tree whereever the variable is used.
2100 -- Is_Return_By_Reference_Type (synthesized)
2101 -- Applies to all type entities. True if the type is required to
2102 -- be returned by reference, as defined in 6.5(11-16).
2104 -- Is_Scalar_Type (synthesized)
2105 -- Applies to all entities, true for scalar types and subtypes
2107 -- Is_Shared_Passive (Flag60)
2108 -- Present in all entities, set in E_Package and E_Generic_Package
2109 -- entities to which a pragma Shared_Passive is applied, and also in
2110 -- all entities within such packages.
2112 -- Is_Statically_Allocated (Flag28)
2113 -- Present in all entities. This can only be set True for exception,
2114 -- variable, constant, and type/subtype entities. If the flag is set,
2115 -- then the variable or constant must be allocated statically rather
2116 -- than on the local stack frame. For exceptions, the meaning is that
2117 -- the exception data should be allocated statically (and indeed this
2118 -- flag is always set for exceptions, since exceptions do not have
2119 -- local scope). For a type, the meaning is that the type must be
2120 -- elaborated at the global level rather than locally. No type marked
2121 -- with this flag may depend on a local variable, or on any other type
2122 -- which does not also have this flag set to True. For a variable or
2123 -- or constant, if the flag is set, then the type of the object must
2124 -- either be declared at the library level, or it must also have the
2125 -- flag set (since to allocate the oject statically, its type must
2126 -- also be elaborated globally).
2128 -- Is_Subprogram (synthesized)
2129 -- Applies to all entities, true for bodies of functions, procedures
2132 -- Is_String_Type (synthesized)
2133 -- Applies to all type entities. Determines if the given type is a
2134 -- string type, i.e. it is directly a string type or string subtype,
2135 -- or a string slice type, or an array type with one dimension and a
2136 -- component type that is a character type.
2139 -- Present in E_Component. For regular tagged type this flag is set on
2140 -- the tag component (whose name is Name_uTag) and for CPP_Class tagged
2141 -- types, this flag marks the pointer to the main vtable (i.e. the one
2142 -- to be extended by derivation)
2144 -- Is_Tagged_Type (Flag55)
2145 -- Present in all entities, true for an entity for a tagged type.
2147 -- Is_Task_Record_Type (synthesized)
2148 -- Applies to all entities, true if Is_Concurrent_Record_Type
2149 -- Corresponding_Concurrent_Type is a task type.
2151 -- Is_Task_Type (synthesized)
2152 -- Applies to all entities, true for task types and subtypes
2154 -- Is_True_Constant (Flag163)
2155 -- This flag is set in constants and variables which have an initial
2156 -- value specified but which are never assigned, partially or in the
2157 -- whole. For variables, it means that the variable was initialized
2158 -- but never modified, and hence can be treated as a constant by the
2159 -- code generator. For a constant, it means that the constant was not
2160 -- modified by generated code (e.g. to set a discriminant in an init
2161 -- proc). Assignments by user or generated code will reset this flag.
2163 -- Is_Type (synthesized)
2164 -- Applies to all entities, true for a type entity
2166 -- Is_Unchecked_Union (Flag117)
2167 -- Present in all entities. Set only in record types to which the
2168 -- pragma Unchecked_Union has been validly applied.
2170 -- Is_Unsigned_Type (Flag144)
2171 -- Present in all types, but can be set only for discrete and fixed-point
2172 -- type and subtype entities. This flag is only valid if the entity is
2173 -- frozen. If set it indicates that the representation is known to be
2174 -- unsigned (i.e. that no negative values appear in the range). This is
2175 -- normally just a reflection of the lower bound of the subtype or base
2176 -- type, but there is one case in which the setting is non-obvious,
2177 -- namely the case of an unsigned subtype of a signed type from which
2178 -- a further subtype is obtained using variable bounds. This further
2179 -- subtype is still unsigned, but this cannot be determined by looking
2180 -- at its bounds or the bounds of the corresponding base type.
2182 -- Is_Valued_Procedure (Flag127)
2183 -- Present in procedure entities. Set if an Import_Valued_Procedure
2184 -- or Export_Valued_Procedure pragma applies to the procedure entity.
2186 -- Is_Visible_Child_Unit (Flag116)
2187 -- Present in compilation units that are child units. Once compiled,
2188 -- child units remain chained to the entities in the parent unit, and
2189 -- a separate flag must be used to indicate whether the names are
2190 -- visible by selected notation, or not.
2192 -- Is_VMS_Exception (Flag133)
2193 -- Present in all entities. Set only for exception entities where the
2194 -- exception was specified in an Import_Exception or Export_Exception
2195 -- pragma with the VMS option for Form. See description of these pragmas
2196 -- for details. This flag can only be set in OpenVMS versions of GNAT.
2198 -- Is_Volatile (Flag16)
2199 -- Present in all type entities, and also in constants, components and
2200 -- variables. Set if a pragma Volatile applies to the entity. Also set
2201 -- if pragma Shared or pragma Atomic applies to entity. In the case of
2202 -- private or incomplete types, this flag is set in both the private
2205 -- Is_Wrapper_Package (synthesized)
2206 -- Present in package entities. Indicates that the package has been
2207 -- created as a wrapper for a subprogram instantiation.
2209 -- Last_Entity (Node20)
2210 -- Present in all entities which act as scopes to which a list of
2211 -- associated entities is attached (blocks, class subtypes and types,
2212 -- entries, functions, loops, packages, procedures, protected objects,
2213 -- record types and subtypes, private types, task types and subtypes).
2214 -- Points to a the last entry in the list of associated entities chained
2215 -- through the Next_Entity field. Empty if no entities are chained.
2217 -- Lit_Indexes (Node15)
2218 -- Present in enumeration types and subtypes. Non-empty only for the
2219 -- case of an enumeration root type, where it contains the entity for
2220 -- the generated indexes entity. See unit Exp_Imgv for full details of
2221 -- the nature and use of this entity for implkementing the Image and
2222 -- Value attributes for the enumeration type in question.
2224 -- Lit_Strings (Node16)
2225 -- Present in enumeration types and subtypes. Non-empty only for the
2226 -- case of an enumeration root type, where it contains the entity for
2227 -- the literals string entity. See unit Exp_Imgv for full details of
2228 -- the nature and use of this entity for implementing the Image and
2229 -- Value attributes for the enumeration type in question.
2231 -- Machine_Radix_10 (Flag84)
2232 -- Present in decimal types and subtypes, set if the Machine_Radix
2233 -- is 10, as the result of the specification of a machine radix
2234 -- representation clause. Note that it is possible for this flag
2235 -- to be set without having Has_Machine_Radix_Clause True. This
2236 -- happens when a type is derived from a type with a clause present.
2238 -- Master_Id (Node17)
2239 -- Present in access types and subtypes. Empty unless Has_Task is
2240 -- set for the designated type, in which case it points to the entity
2241 -- for the Master_Id for the access type master.
2243 -- Materialize_Entity (Flag168)
2244 -- Present in all entities. Set only for constant or renamed entities
2245 -- which should be materialized for debugging purposes. In the case of
2246 -- a constant, a memory location should be allocated containing the
2247 -- value. In the case of a renaming, a memory location containing the
2248 -- renamed address should be allocated.
2250 -- Mechanism (Uint8) (returned as Mechanism_Type)
2251 -- Present in functions and non-generic formal parameters. Indicates
2252 -- the mechanism to be used for the function return or for the formal
2253 -- parameter. See separate section on passing mechanisms.
2255 -- Modulus (Uint17) [base type only]
2256 -- Present in modular types. Contains the modulus. For the binary
2257 -- case, this will be a power of 2, but if Non_Binary_Modulus is
2258 -- set, then it will not be a power of 2.
2260 -- Needs_Debug_Info (Flag147)
2261 -- Present in all entities. Set if the entity requires debugging
2262 -- information to be generated. This is true of all entities that
2263 -- have Comes_From_Source set, and also transitively for entities
2264 -- associated with such components (e.g. their types). It is true
2265 -- for all entities in Debug_Generated_Code mode (-gnatD switch).
2267 -- Needs_No_Actuals (Flag22)
2268 -- Present in callable entities (subprograms, entries, access to
2269 -- subprograms) which can be called without actuals because all of
2270 -- their formals (if any) have default values. This flag simplifies the
2271 -- resolution of the syntactic ambiguity involving a call to these
2272 -- entities when the return type is an array type, and a call can be
2273 -- interpreted as an indexing of the result of the call. It is also
2274 -- used to resolve various cases of entry calls.
2276 -- Not_Source_Assigned (Flag115)
2277 -- Present in all entities, but relevant only for variables and
2278 -- parameters. This flag is set if the object is never assigned a
2279 -- value in user code and was not fully initialized at declaration
2280 -- time. Note however, that an access variable is not considered
2281 -- fully initialized in this sense.
2283 -- This flag is only for the purposes of issuing warnings, it must not
2284 -- be used by the code generator to indicate that the variable is in
2285 -- fact a constant, since some assignments in generated code do not
2286 -- count (for example, the call to an init_proc to assign some but
2287 -- not all of the fields in a patially initialized record). The code
2288 -- generator should instead use the flag Is_True_Constant.
2290 -- In variables and out parameters, if this flag is set after full
2291 -- processing of the corresponding declarative unit, it indicates that
2292 -- the variable or parameter was never set, and a warning message can
2295 -- Note: this flag is initially set, and then cleared on encountering
2296 -- any construct that might conceivably legitimately set the value.
2297 -- Thus during the analysis of a declarative region and its associated
2298 -- statement sequence, the meaning of the flag is "not assigned yet",
2299 -- and once this analysis is complete the flag means "never assigned".
2301 -- Note: for variables appearing in package declarations, this flag
2302 -- is never set. That is because there is no way to tell if some
2303 -- client modifies the variable (or in the case of variables in the
2304 -- private part, if some child unit modifies the variables).
2306 -- Note: in the case of renamed objects, the flag must be set in the
2307 -- ultimate renamed object. Clients noting a possible modification
2308 -- should use the Note_Possible_Modification procedure in Sem_Util
2309 -- rather than Set_Not_Source_Assigned precisely to deal properly with
2310 -- the renaming possibility.
2312 -- Next_Component (synthesized)
2313 -- Applies to record components. Returns the next component by
2314 -- following the chain of declared entities until one is found which
2315 -- corresponds to a component (Ekind is E_Component). Any internal types
2316 -- generated from the subtype indications of the record components are
2317 -- skipped. Returns Empty if no more components.
2319 -- Next_Discriminant (synthesized)
2320 -- Applies to discriminants returned by First/Next_Discriminant.
2321 -- Returns the next language-defined (ie: perhaps non-girder)
2322 -- discriminant by following the chain of declared entities as long as
2323 -- the kind of the entity corresponds to a discriminant. Note that the
2324 -- discriminants might be the only components of the record.
2325 -- Returns Empty if there are no more.
2327 -- Next_Entity (Node2)
2328 -- Present in all entities. The entities of a scope are chained, with
2329 -- the head of the list being in the First_Entity field of the scope
2330 -- entity. All entities use the Next_Entity field as a forward pointer
2331 -- for this list, with Empty indicating the end of the list. Since this
2332 -- field is in the base part of the entity, the access routines for this
2333 -- field are in Sinfo.
2335 -- Next_Formal (synthesized)
2336 -- Applies to the entity for a formal parameter. Returns the next
2337 -- formal parameter of the subprogram or subprogram type. Returns
2338 -- Empty if there are no more formals.
2340 -- Next_Formal_With_Extras (synthesized)
2341 -- Applies to the entity for a formal parameter. Returns the next
2342 -- formal parameter of the subprogram or subprogram type. Returns
2343 -- Empty if there are no more formals. The list returned includes
2344 -- all the extra formals (see description of Extra_Formal field)
2346 -- Next_Girder_Discriminant (synthesized)
2347 -- Applies to discriminants. Set only for a discriminant returned by
2348 -- a call to First/Next_Girder_Discriminant. Returns next girder
2349 -- discriminant, if there are more (see complete description in
2350 -- First_Girder_Discriminant), or Empty if there are no more.
2352 -- Next_Index (synthesized)
2353 -- Applies to array types and subtypes and to string types and
2354 -- subtypes. Yields the next index. The first index is obtained by
2355 -- using the First_Index attribute, and then subsequent indexes are
2356 -- obtained by applying Next_Index to the previous index. Empty is
2357 -- returned to indicate that there are no more indexes. Note that
2358 -- unlike most attributes in this package, Next_Index applies to
2359 -- nodes for the indexes, not to entities.
2361 -- Next_Inlined_Subprogram (Node12)
2362 -- Present in subprograms. Used to chain inlined subprograms used in
2363 -- the current compilation, in the order in which they must be compiled
2364 -- by Gigi to insure that all inlinings are performed.
2366 -- Next_Literal (synthesized)
2367 -- Applies to enumeration literals, returns the next literal, or
2368 -- Empty if applied to the last literal. This is actually a synonym
2369 -- for Next, but its use is preferred in this context.
2371 -- Non_Binary_Modulus (Flag58) [base type only]
2372 -- Present in modular integer types. Set if the modulus for the type
2373 -- is other than a power of 2.
2375 -- Nonzero_Is_True (Flag162) [base type only]
2376 -- Present in enumeration types. True if any non-zero value is to be
2377 -- interpreted as true. Currently this is set true for derived Boolean
2378 -- types which have a convention of C, C++ or Fortran.
2380 -- No_Pool_Assigned (Flag131) [root type only]
2381 -- Present in access types. Set if a storage size clause applies to
2382 -- the variable with a compile time known value of zero. This flag is
2383 -- used to generate warnings if any attempt is made to allocate an
2384 -- instance of such an access type.
2386 -- No_Return (Flag113)
2387 -- Present in procedure and generic procedure entries. Indicates that
2388 -- a pragma No_Return applies to the procedure.
2390 -- Normalized_First_Bit (Uint8)
2391 -- Present in components and discriminants. Indicates the normalized
2392 -- value of First_Bit for the component, i.e. the offset within the
2393 -- lowest addressed storage unit containing part or all of the field.
2395 -- Normalized_Position (Uint9)
2396 -- Present in components and discriminants. Indicates the normalized
2397 -- value of Position for the component, i.e. the offset in storage
2398 -- units from the start of the record to the lowest addressed storage
2399 -- unit containing part or all of the field.
2401 -- Normalized_Position_Max (Uint10)
2402 -- Present in components and discriminants. For almost all cases, this
2403 -- is the same as Normalized_Position. The one exception is for the case
2404 -- of a discriminated record containing one or more arrays whose length
2405 -- depends on discriminants. In this case, the Normalized_Position_Max
2406 -- field represents the maximum possible value of Normalized_Position
2407 -- assuming min/max values for discriminant subscripts in all fields.
2408 -- This is used by Layout in front end layout mode to properly computed
2409 -- the maximum size such records (needed for allocation purposes when
2410 -- there are default discriminants, and also for the 'Size value).
2412 -- Number_Dimensions (synthesized)
2413 -- Applies to array types and subtypes. Returns the number of dimensions
2414 -- of the array type or subtype as a value of type Pos.
2416 -- Number_Discriminants (synthesized)
2417 -- Applies to all types with discriminants. Yields the number of
2418 -- discriminants as a value of type Pos.
2420 -- Number_Entries (synthesized)
2421 -- Applies to concurrent types. Returns the number of entries that are
2422 -- declared within the task or protected definition for the type.
2424 -- Number_Formals (synthesized)
2425 -- Applies to subprograms and subprogram types. Yields the number of
2426 -- formals as a value of type Pos.
2428 -- Object_Ref (Node17)
2429 -- Present in protected bodies. This is an implicit prival for the
2430 -- Protection object associated with a protected object. See Prival
2431 -- for further details on the use of privals.
2433 -- Original_Record_Component (Node22)
2434 -- Present in components, including discriminants. The usage depends
2435 -- on whether the record is a base type and whether it is tagged.
2437 -- In base tagged types:
2438 -- When the component is inherited in a record extension, it points
2439 -- to the original component (the entity of the ancestor component
2440 -- which is not itself inherited) otherwise it points to itself.
2441 -- Gigi uses this attribute to implement the automatic dereference in
2442 -- the extension and to apply the transformation:
2444 -- Rec_Ext.Comp -> Rec_Ext.Parent. ... .Parent.Comp
2446 -- In base non-tagged types:
2447 -- Always points to itself except for non-girder discriminants, where
2448 -- it points to the girder discriminant it renames.
2450 -- In subtypes (tagged and untagged):
2451 -- Points to the component in the base type.
2453 -- Packed_Array_Type (Node23)
2454 -- Present in array types and subtypes, including the string literal
2455 -- subtype case, if the corresponding type is packed (either bit packed
2456 -- or packed to eliminate holes in non-contiguous enumeration type
2457 -- index types). References the type used to represent the packed array,
2458 -- which is either a modular type for short static arrays, or an
2459 -- array of System.Unsigned. Note that in some situations (internal
2460 -- types, and references to fields of variant records), it is not
2461 -- always possible to construct this type in advance of its use. If
2462 -- Packed_Array_Type is empty, then the necessary type is declared
2463 -- on the fly for each reference to the array.
2465 -- Parameter_Mode (synthesized)
2466 -- Applies to formal parameter entities. This is a synonym for Ekind,
2467 -- used when obtaining the formal kind of a formal parameter (the result
2468 -- is one of E_[In/Out/In_Out]_Paramter)
2470 -- Parent_Subtype (Node19)
2471 -- Present in E_Record_Type. Points to the subtype to use for a
2472 -- field that references the parent record. This is used by Gigi to
2473 -- construct such a field.
2475 -- Primitive_Operations (Elist15)
2476 -- Present in tagged record types and subtypes and in tagged private
2477 -- types. Points to an element list of entities for primitive operations
2478 -- for the tagged type. Not present (and not set) in untagged types (it
2479 -- is an error to reference the primitive operations field of a type
2480 -- that is not tagged).
2482 -- Private_Dependents (Elist18)
2483 -- Present in private (sub)types. Records the subtypes of the
2484 -- private type, derivations from it, and records and arrays
2485 -- with components dependent on the type.
2487 -- The subtypes are traversed when installing and deinstalling
2488 -- (the full view of) a private type in order to ensure correct
2489 -- view of the subtypes.
2491 -- Used in similar fashion for incomplete types: holds list of subtypes
2492 -- of these incomplete types that have discriminant constraints. The
2493 -- full views of these subtypes are constructed when the full view of
2494 -- the incomplete type is processed.
2496 -- In addition, if the incomplete type is the designated type in an
2497 -- access definition for an access parameter, the operation may be
2498 -- a dispatching primitive operation, which is only known when the full
2499 -- declaration of the type is seen. Subprograms that have such an
2500 -- access parameter are also placed in the list of private_dependents.
2503 -- Present in components. Used for representing private declarations
2504 -- of protected objects (private formal: by analogy to Discriminal_Link).
2505 -- Empty unless the synthesized Is_Protected_Private attribute is
2506 -- true. The entity used as a formal parameter that corresponds to
2507 -- the to the private declaration in protected operations. See
2508 -- "Private data in protected objects" for details.
2510 -- Privals_Chain (Elist23)
2511 -- Present in protected operations (subprograms and entries). Links
2512 -- all occurrences of the Privals in the body of the operation, in
2513 -- order to patch their types at the end of their expansion. See
2514 -- "Private data in protected objects" for details.
2516 -- Private_View (Node22)
2517 -- For each private type, three entities are allocated, the private view,
2518 -- the full view, and the shadow entity. The shadow entity contains a
2519 -- copy of the private view and is used for restoring the proper private
2520 -- view after a region in which the full view is visible (and is copied
2521 -- into the entity normally used for the private view during this period
2522 -- of visibility). The Private_View field is self-referential when the
2523 -- private view lives in its normal entity, but in the copy that is made
2524 -- in the shadow entity, it points to the proper location in which to
2525 -- restore the private view saved in the shadow.
2527 -- Protected_Formal (Node22)
2528 -- Present in formal parameters (in, in out and out parameters). Used
2529 -- only for formals of protected operations. References corresponding
2530 -- formal parameter in the unprotected version of the operation that
2531 -- is created during expansion.
2533 -- Protected_Body_Subprogram (Node11)
2534 -- Present in protected operations. References the entity for the
2535 -- subprogram which implements the body of the operation.
2537 -- Protected_Operation (Node23)
2538 -- Present in components. Used for representing private declarations
2539 -- of protected objects. Empty unless the synthesized attribute
2540 -- Is_Protected_Private is True. This is the entity corresponding
2541 -- to the body of the protected operation currently being analyzed,
2542 -- and which will eventually use the current Prival associated with
2543 -- this component to refer to the renaming of a private object
2544 -- component. As soon as the expander generates this renaming, this
2545 -- attribute is changed to refer to the next protected subprogram.
2546 -- See "Private data in protected objects" for details.
2548 -- Reachable (Flag49)
2549 -- Present in labels. The flag is set over the range of statements in
2550 -- which a goto to that label is legal.
2552 -- Referenced (Flag156)
2553 -- Present in all entities, set if the entity is referenced.
2555 -- Referenced_Object (Node10)
2556 -- Present in all type entities. Set non-Empty only for type entities
2557 -- constructed for unconstrained objects, or objects that depend on
2558 -- discriminants. Points to the expression from which the actual
2559 -- subtype of the object can be evaluated.
2561 -- Register_Exception_Call (Node20)
2562 -- Present in exception entities. When an exception is declared,
2563 -- a call is expanded to Register_Exception. This field points to
2564 -- the expanded N_Procedure_Call_Statement node for this call. It
2565 -- is used for Import/Export_Exception processing to modify the
2566 -- register call to make appropriate entries in the special tables
2567 -- used for handling these pragmas at runtime.
2569 -- Related_Array_Object (Node19)
2570 -- Present in array types and subtypes. Used only for the base type
2571 -- and subtype created for an anonymous array object. Set to point
2572 -- to the entity of the corresponding array object. Currently used
2573 -- only for type-related error messages.
2575 -- Related_Instance (Node15)
2576 -- Present in the wrapper packages created for subprogram instances.
2577 -- The internal subprogram that implements the instance is inside the
2578 -- wrapper package, but for debugging purposes its external symbol
2579 -- must correspond to the name and scope of the related instance.
2581 -- Renamed_Entity (Node18)
2582 -- Present in exceptions, packages and generic units that are defined
2583 -- by a renaming declaration. Denotes the renamed entity, or transit-
2584 -- itively the ultimate renamed entity if there is a chain of renaming
2587 -- Renamed_Object (Node18)
2588 -- Present in all objects (constants, variables, components, formal
2589 -- parameters, generic formal parameters, and loop parameters. Set
2590 -- non-Empty if the object was declared by a renaming declaration, in
2591 -- which case it references the tree node for the name of the renamed
2592 -- object. This is only possible for the variable and constant cases.
2593 -- For formal parameters, this field is used in the course of inline
2594 -- expansion, to map the formals of a subprogram into the corresponding
2595 -- actuals. The field is Empty otherwise.
2597 -- Renaming_Map (Uint9)
2598 -- Present in generic subprograms, generic packages, and their
2599 -- instances. Also present in the instances of the corresponding
2600 -- bodies. Denotes the renaming map (generic entities => instance
2601 -- entities) used to construct the instance by givin an index into
2602 -- the tables used to represent these maps. See Sem_Ch12 for further
2603 -- details. The maps for package instances are also used when the
2604 -- instance is the actual corresponding to a formal package.
2606 -- Return_Present (Flag54)
2607 -- Present in function and generic function entities. Set if the
2608 -- function contains a return statement (used for error checking).
2609 -- This flag can also be set in procedure and generic procedure
2610 -- entities (for convenience in setting it), but is only tested
2611 -- for the function case.
2613 -- Returns_By_Ref (Flag90)
2614 -- Present in function entities, to indicate that the function
2615 -- returns the result by reference, either because its return typ is a
2616 -- by-reference-type or because it uses explicitly the secondary stack.
2618 -- Reverse_Bit_Order (Flag164)
2619 -- Present in all record type entities. Set if a valid pragma an
2620 -- attribute represention clause for Bit_Order has reversed the order
2621 -- of bits from the default value. When this flag is set, a component
2622 -- clause must specify a set of bits entirely contained in a single
2626 -- Present in all type and subtype entities. Contains the value of
2627 -- type'Size as defined in the RM. See also the Esize field and
2628 -- and the description on "Handling of Type'Size Values". A value
2629 -- of zero for in this field for a non-discrete type means that
2630 -- the front end has not yet determined the size value. For the
2631 -- case of a discrete type, this field is always set by the front
2632 -- end and zero is a legitimate value for a type with one value.
2634 -- Root_Type (synthesized)
2635 -- Applies to all type entities. For class-wide types, return the root
2636 -- type of the class covered by the CW type, otherwise returns the
2637 -- ultimate derivation ancestor of the given type. This function
2638 -- preserves the view, i.e. the Root_Type of a partial view is the
2639 -- partial view of the ulimate ancestor, the Root_Type of a full view
2640 -- is the full view of the ultimate ancestor. Note that this function
2641 -- does not correspond exactly to the use of root type in the RM, since
2642 -- in the RM root type applies to a class of types, not to a type.
2644 -- Scalar_Range (Node20)
2645 -- Present in all scalar types (including modular types, where the
2646 -- bounds are 0 .. modulus - 1). References a node in the tree that
2647 -- contains the bounds for the range. Note that this information
2648 -- could be obtained by rummaging around the tree, but it is more
2649 -- convenient to have it immediately at hand in the entity. The
2650 -- contents of Scalar_Range can either be an N_Subtype_Indication
2651 -- node (with a constraint), or a Range node, but not a simple
2652 -- subtype reference (a subtype is converted into a range).
2654 -- Scale_Value (Uint15)
2655 -- Present in decimal fixed-point types and subtypes. Contains the scale
2656 -- for the type (i.e. the value of type'Scale = the number of decimal
2657 -- digits after the decimal point).
2660 -- Present in all entities. Points to the entity for the scope (block,
2661 -- loop, subprogram, package etc.) in which the entity is declared.
2662 -- Since this field is in the base part of the entity node, the access
2663 -- routines for this field are in Sinfo.
2665 -- Scope_Depth (synth)
2666 -- Applies to program units, blocks, concurrent types and entries,
2667 -- and also to record types, i.e. to any entity that can appear on
2668 -- the scope stack. Yields the scope depth value, which for those
2669 -- entities other than records is simply the scope depth value,
2670 -- for record entities, it is the Scope_Depth of the record scope.
2672 -- Scope_Depth_Value (Uint22)
2673 -- Present in program units, blocks, concurrent types and entries.
2674 -- Indicates the number of scopes that statically enclose the
2675 -- declaration of the unit or type. Library units have a depth of zero.
2676 -- Note that record types can act as scopes but do NOT have this field
2677 -- set (see Scope_Depth above)
2679 -- Scope_Depth_Set (synthesized)
2680 -- Applies to a special predicate function that returns a Boolean value
2681 -- indicating whether or not the Scope_Depth field has been set. It
2682 -- is needed, since returns an invalid value in this case!
2684 -- Sec_Stack_Needed_For_Return (Flag167)
2685 -- Present in scope entities (blocks,functions, procedures, tasks,
2686 -- entries). Set to True when secondary stack is used to hold
2687 -- the returned value of a function and thus should not be
2688 -- released on scope exit.
2690 -- Shadow_Entities (List14)
2691 -- Present in package and generic package entities. Points to a list
2692 -- of entities that correspond to private types. For each private type
2693 -- a shadow entity is created that holds a copy of the private view.
2694 -- In regions of the program where the full views of these private
2695 -- entities are visible, the full view is copied into the entity that
2696 -- is normally used to hold the private view, but the shadow entity
2697 -- copy is unchanged. The shadow entities are then used to restore the
2698 -- original private views at the end of the region. This list is a
2699 -- standard format list (i.e. First (Shadow_Entities) is the first
2700 -- entry and subsequent entries are obtained using Next.
2702 -- Shared_Var_Assign_Proc (Node22)
2703 -- Present in variables. Set non-Empty only if Is_Shared_Passive is
2704 -- set, in which case this is the entity for the shared memory assign
2705 -- routine. See Exp_Smem for full details.
2707 -- Shared_Var_Read_Proc (Node15)
2708 -- Present in variables. Set non-Empty only if Is_Shared_Passive is
2709 -- set, in which case this is the entity for the shared memory read
2710 -- routine. See Exp_Smem for full details.
2712 -- Size_Check_Code (Node9)
2713 -- Present in constants and variables. Normally Empty. Set if code is
2714 -- generated to check the size of the variable. This field is used to
2715 -- suppress this code if a subsequent address clause is encountered.
2717 -- Size_Clause (synthesized)
2718 -- Applies to all entities. If a size clause is present in the rep
2719 -- item chain for an entity then the attribute definition clause node
2720 -- for the size clause is returned. Otherwise Size_Clause returns Empty
2721 -- if no item is present. Usually this is only meaningful if the flag
2722 -- Has_Size_Clause is set. This is because when the representation item
2723 -- chain is copied for a derived type, it can inherit a size clause that
2724 -- is not applicable to the entity.
2726 -- Size_Depends_On_Discriminant (Flag177)
2727 -- Present in all entities for types and subtypes. Indicates that the
2728 -- size of the type depends on the value of one or more discriminants.
2729 -- Currently, this flag is only set in front end layout mode for arrays
2730 -- which have one or more bounds depending on a discriminant value.
2732 -- Size_Known_At_Compile_Time (Flag92)
2733 -- Present in all entities for types and subtypes. Indicates that the
2734 -- size of objects of the type is known at compile time. This flag is
2735 -- used to optimize some generated code sequences, and also to enable
2736 -- some error checks (e.g. disallowing component clauses on variable
2737 -- length objects. It is set conservatively (i.e. if it is True, the
2738 -- size is certainly known at compile time, if it is False, then the
2739 -- size may or may not be known at compile time, but the code will
2740 -- assume that it is not known).
2742 -- Small_Value (Ureal21)
2743 -- Present in fixed point types. Points to the universal real for the
2744 -- Small of the type, either as given in a representation clause, or
2745 -- as computed (as a power of two) by the compiler.
2747 -- Spec_Entity (Node19)
2748 -- Present in package body entities. Points to corresponding package
2749 -- spec entity. Also present in subprogram body parameters in the
2750 -- case where there is a separate spec, where this field references
2751 -- the corresponding parameter entities in the spec.
2753 -- Storage_Size_Variable (Node15) [implementation base type only]
2754 -- Present in access types and task type entities. This flag is set
2755 -- if a valid and effective pragma Storage_Size applies to the base
2756 -- type. Points to the entity for a variable that is created to
2757 -- hold the value given in a Storage_Size pragma for an access
2758 -- collection or a task type. Note that in the access type case,
2759 -- this field is present only in the root type (since derived types
2760 -- share the same storage pool).
2762 -- Strict_Alignment (Flag145) [implementation base type only]
2763 -- Present in all type entities. Indicates that some containing part
2764 -- is either aliased or tagged. This prohibits packing the object
2765 -- tighter than its natural size and alignment.
2767 -- String_Literal_Length (Uint16)
2768 -- Present in string literal subtypes (which are created to correspond
2769 -- to string literals in the program). Contains the length of the string
2772 -- String_Literal_Low_Bound (Node15)
2773 -- Present in string literal subtypes (which are created to correspond
2774 -- to string literals in the program). Contains an expression whose
2775 -- value represents the low bound of the literal. This is a copy of
2776 -- the low bound of the applicable index constraint if there is one,
2777 -- or a copy of the low bound of the index base type if not.
2779 -- Suppress_Access_Checks (Flag31)
2780 -- Present in all entities. Set if access checks associated with this
2781 -- entity are to be suppressed (see separate section on "Handling of
2782 -- Check Suppression")
2784 -- Suppress_Accessibility_Checks (Flag32)
2785 -- Present in all entities. Set if accessibility checks associated with
2786 -- this entity are to be suppressed (see separate section on "Handling
2787 -- of Check Suppression")
2789 -- Suppress_Discriminant_Checks (Flag33)
2790 -- Present in all entities. Set if discriminant checks associated with
2791 -- this entity are to be suppressed (see separate section on "Handling
2792 -- of Check Suppression")
2794 -- Suppress_Division_Checks (Flag34)
2795 -- Present in all entities. Set if division checks associated with
2796 -- this entity are to be suppressed (see separate section on "Handling
2797 -- of Check Suppression")
2799 -- Suppress_Elaboration_Checks (Flag35)
2800 -- Present in all entities. Set if elaboration checks associated with
2801 -- this entity are to be suppressed (see separate section on "Handling
2802 -- of Check Suppression")
2804 -- Suppress_Elaboration_Warnings (Flag148)
2805 -- Present in all entities. Set if a pragma Suppress Elaboration_Checks
2806 -- is applied specifically to the entity. If set on a subprogram, all
2807 -- elaboration warnings for calls to the subprogram are suppressed. If
2808 -- set on a package, then all elaboration warnings for calls to any
2809 -- subprograms in the package are suppressed.
2811 -- Suppress_Index_Checks (Flag36)
2812 -- Present in all entities. Set if index checks associated with this
2813 -- entity are to be suppressed (see separate section on "Handling of
2814 -- Check Suppression")
2816 -- Suppress_Init_Proc (Flag105) [base type only]
2817 -- Present in all type entities. Set to suppress the generation of
2818 -- initialization procedures where they are known to be not needed.
2819 -- For example, the enumeration image table entity uses this flag.
2821 -- Suppress_Length_Checks (Flag37)
2822 -- Present in all entities. Set if length checks associated with this
2823 -- entity are to be suppressed (see separate section on "Handling of
2824 -- Check Suppression")
2826 -- Suppress_Overflow_Checks (Flag38)
2827 -- Present in all entities. Set if overflow checks associated with
2828 -- this entity are to be suppressed (see separate section on "Handling
2829 -- of Check Suppression")
2831 -- Suppress_Range_Checks (Flag39)
2832 -- Present in all entities. Set if range checks associated with this
2833 -- entity are to be suppressed (see separate section on "Handling of
2834 -- Check Suppression")
2836 -- Suppress_Storage_Checks (Flag40)
2837 -- Present in all entities. Set if storage checks associated with
2838 -- this entity are to be suppressed (see separate section on "Handling
2839 -- of Check Suppression")
2841 -- Suppress_Style_Checks (Flag165)
2842 -- Present in all entities. Suppresses any style checks specifically
2843 -- associated with the given entity if set.
2845 -- Suppress_Tag_Checks (Flag41)
2846 -- Present in all entities. Set if tag checks associated with this
2847 -- entity are to be suppressed (see separate section on "Handling of
2848 -- Check Suppression")
2850 -- Tag_Component (synthesized)
2851 -- Applies to tagged record types, returns the entity for the _Tag
2852 -- field in this record, which must be present.
2854 -- Type_High_Bound (synthesized)
2855 -- Applies to scalar types. Returns the tree node (Node_Id) that
2856 -- contains the high bound of a scalar type. The returned value is a
2857 -- literal for a base type, but may be an expression in the case of a
2858 -- scalar type with dynamic bounds. Note that in the case of a fixed
2859 -- point type, the high bound is in units of small, and is an integer.
2861 -- Type_Low_Bound (synthesized)
2862 -- Applies to scalar types. Returns the tree node (Node_Id) that
2863 -- contains the low bound of a scalar type. The returned value is a
2864 -- literal for a base type, but may be an expression in the case of a
2865 -- scalar type with dynamic bounds. Note that in the case of a fixed
2866 -- point type, the low bound is in units of small, and is an integer.
2868 -- Underlying_Full_View (Node19)
2869 -- Present in private subtypes that are the completion of other private
2870 -- types, or in private types that are derived from private subtypes.
2871 -- If the full view of a private type T is derived from another
2872 -- private type with discriminants Td, the full view of T is also
2873 -- private, and there is no way to attach to it a further full view that
2874 -- would convey the structure of T to the back end. The Underlying_Full_
2875 -- View is an attribute of the full view that is a subtype of Td with
2876 -- the same constraint as the declaration for T. The declaration for this
2877 -- subtype is built at the point of the declaration of T, either as a
2878 -- completion, or as a subtype declaration where the base type is private
2879 -- and has a private completion. If Td is already constrained, then its
2880 -- full view can serve directly as the full view of T.
2882 -- Underlying_Type (synthesized)
2883 -- Applies to all entities. This is the identity function except in
2884 -- the case where it is applied to an incomplete or private type,
2885 -- in which case it is the underlying type of the type declared by
2886 -- the completion, or Empty if the completion has not yet been
2887 -- encountered and analyzed.
2889 -- Note: the reason this attribute applies to all entities, and not
2890 -- just types, is to legitimize code where Underlying_Type is applied
2891 -- to an entity which may or may not be a type, with the intent that
2892 -- if it is a type, its underlying type is taken.
2894 -- Unset_Reference (Node16)
2895 -- Present in variables and out parameters. This is normally Empty.
2896 -- It is set to point to an identifier that represents a reference
2897 -- to the entity before any value has been set. Only the first such
2898 -- reference is identified. This field is used to generate a warning
2899 -- message if necessary (see Sem_Warn.Check_Unset_Reference).
2901 -- Uses_Sec_Stack (Flag95)
2902 -- Present in scope entities (blocks,functions, procedures, tasks,
2903 -- entries). Set to True when secondary stack is used in this scope and
2904 -- must be released on exit unless Sec_Stack_Needed_For_Return is set.
2906 -- Vax_Float (Flag151) [base type only]
2907 -- Present in all type entities. Set only on the base type of float
2908 -- types with Vax format. The particular format is determined by the
2909 -- Digits_Value value which is 6,9,15 for F_Float, D_Float, G_Float.
2911 -- Warnings_Off (Flag96)
2912 -- Present in all entities. Set if a pragma Warnings (Off, entity-name)
2913 -- is used to suppress warnings for a given entity. It is also used by
2914 -- the compiler in some situations to kill spurious warnings.
2920 -- The following three entity kinds are introduced by the corresponding
2921 -- type definitions:
2923 -- E_Access_Type, E_General_Access_Type, E_Anonymous_Access_Type.
2925 -- In addition, we define the kind E_Allocator_Type to label
2926 -- allocators. This is because special resolution rules apply to this
2927 -- construct. Eventually the constructs are labeled with the access
2928 -- type imposed by the context. Gigi should never see the type
2931 -- Similarly, the type E_Access_Attribute_Type is used as the initial
2932 -- kind associated with an access attribute. After resolution a specific
2933 -- access type will be established as determined by the context.
2935 -- Finally, the type Any_Access is used to label -null- during type
2936 -- resolution. Any_Access is also replaced by the context type after
2939 --------------------------------
2940 -- Classification of Entities --
2941 --------------------------------
2943 -- The classification of program entities which follows is a refinement of
2944 -- the list given in RM 3.1(1). E.g., separate entities denote subtypes of
2945 -- different type classes. Ada 95 entities include class wide types,
2946 -- protected types, subprogram types, generalized access types, generic
2947 -- formal derived types and generic formal packages.
2949 -- The order chosen for these kinds allows us to classify related entities
2950 -- so that they are contiguous. As a result, they do not appear in the
2951 -- exact same order as their order of first appearance in the LRM (For
2952 -- example, private types are listed before packages). The contiguity
2953 -- allows us to define useful subtypes (see below) such as type entities,
2954 -- overloaded entities, etc.
2956 -- Each entity (explicitly or implicitly declared) has a kind, which is
2957 -- a value of the following type:
2959 type Entity_Kind is (
2962 -- The initial Ekind value for a newly created entity. Also used as
2963 -- the Ekind for Standard_Void_Type, a type entity in Standard used
2964 -- as a dummy type for the return type of a procedure (the reason we
2965 -- create this type is to share the circuits for performing overload
2966 -- resolution on calls).
2973 -- Variables created by an object declaration with no constant keyword
2976 -- Components of a record declaration, private declarations of
2977 -- protected objects.
2980 -- Constants created by an object declaration with a constant keyword
2983 -- A discriminant, created by the use of a discriminant in a type
2987 -- A loop parameter created by a for loop
2989 ------------------------
2990 -- Parameter Entities --
2991 ------------------------
2993 -- Parameters are also objects
2996 -- An in parameter of a subprogram or entry
2999 -- An out parameter of a subprogram or entry
3002 -- An in-out parameter of a subprogram or entry
3004 --------------------------------
3005 -- Generic Parameter Entities --
3006 --------------------------------
3008 -- Generic parameters are also objects
3010 E_Generic_In_Out_Parameter,
3011 -- A generic in out parameter, created by the use of a generic in out
3012 -- parameter in a generic declaration.
3014 E_Generic_In_Parameter,
3015 -- A generic in parameter, created by the use of a generic in
3016 -- parameter in a generic declaration.
3023 -- Named numbers created by a number declaration with an integer value
3026 -- Named numbers created by a number declaration with a real value
3028 -----------------------
3029 -- Enumeration Types --
3030 -----------------------
3033 -- Enumeration types, created by an enumeration type declaration
3035 E_Enumeration_Subtype,
3036 -- Enumeration subtypes, created by an explicit or implicit subtype
3037 -- declaration applied to an enumeration type or subtype.
3043 E_Signed_Integer_Type,
3044 -- Signed integer type, used for the anonymous base type of the
3045 -- integer subtype created by an integer type declaration.
3047 E_Signed_Integer_Subtype,
3048 -- Signed integer subtype, created by either an integer subtype or
3049 -- integer type declaration (in the latter case an integer type is
3050 -- created for the base type, and this is the first named subtype).
3052 E_Modular_Integer_Type,
3053 -- Modular integer type, used for the anonymous base type of the
3054 -- integer subtype created by a modular integer type declaration.
3056 E_Modular_Integer_Subtype,
3057 -- Modular integer subtype, created by either an modular subtype
3058 -- or modular type declaration (in the latter case a modular type
3059 -- is created for the base type, and this is the first named subtype).
3061 E_Ordinary_Fixed_Point_Type,
3062 -- Ordinary fixed type, used for the anonymous base type of the
3063 -- fixed subtype created by an ordinary fixed point type declaration.
3065 E_Ordinary_Fixed_Point_Subtype,
3066 -- Ordinary fixed point subtype, created by either an ordinary fixed
3067 -- point subtype or ordinary fixed point type declaration (in the
3068 -- latter case a fixed point type is created for the base type, and
3069 -- this is the first named subtype).
3071 E_Decimal_Fixed_Point_Type,
3072 -- Decimal fixed type, used for the anonymous base type of the decimal
3073 -- fixed subtype created by an ordinary fixed point type declaration.
3075 E_Decimal_Fixed_Point_Subtype,
3076 -- Decimal fixed point subtype, created by either a decimal fixed point
3077 -- subtype or decimal fixed point type declaration (in the latter case
3078 -- a fixed point type is created for the base type, and this is the
3079 -- first named subtype).
3081 E_Floating_Point_Type,
3082 -- Floating point type, used for the anonymous base type of the
3083 -- floating point subtype created by a floating point type declaration.
3085 E_Floating_Point_Subtype,
3086 -- Floating point subtype, created by either a floating point subtype
3087 -- or floating point type declaration (in the latter case a floating
3088 -- point type is created for the base type, and this is the first
3096 -- An access type created by an access type declaration with no all
3097 -- keyword present. Note that the predefined type Any_Access, which
3098 -- has E_Access_Type Ekind, is used to label NULL in the upwards pass
3099 -- of type analysis, to be replaced by the true access type in the
3100 -- downwards resolution pass.
3103 -- An access subtype created by a subtype declaration for any access
3104 -- type (whether or not it is a general access type).
3106 E_Access_Attribute_Type,
3107 -- An access type created for an access attribute (such as 'Access,
3108 -- 'Unrestricted_Access and Unchecked_Access)
3111 -- A special internal type used to label allocators and attribute
3112 -- references using 'Access. This is needed because special resolution
3113 -- rules apply to these constructs. On the resolution pass, this type
3114 -- is always replaced by the actual access type, so Gigi should never
3115 -- see types with this Ekind.
3117 E_General_Access_Type,
3118 -- An access type created by an access type declaration with the all
3121 E_Access_Subprogram_Type,
3122 -- An access to subprogram type, created by an access to subprogram
3125 E_Access_Protected_Subprogram_Type,
3126 -- An access to a protected subprogram, created by the corresponding
3127 -- declaration. Values of such a type denote both a protected object
3128 -- and a protected operation within, and have different compile-time
3129 -- and run-time properties than other access to subprograms.
3131 E_Anonymous_Access_Type,
3132 -- An anonymous access type created by an access parameter or access
3135 ---------------------
3136 -- Composite Types --
3137 ---------------------
3140 -- An array type created by an array type declaration. Includes all
3141 -- cases of arrays, except for string types.
3144 -- An array subtype, created by an explicit array subtype declaration,
3145 -- or the use of an anonymous array subtype.
3148 -- A string type, i.e. an array type whose component type is a character
3149 -- type, and for which string literals can thus be written.
3152 -- A string subtype, created by an explicit subtype declaration for a
3153 -- string type, or the use of an anonymous subtype of a string type,
3155 E_String_Literal_Subtype,
3156 -- A special string subtype, used only to describe the type of a string
3157 -- literal (will always be one dimensional, with literal bounds).
3160 -- A class wide type, created by any tagged type declaration (i.e. if
3161 -- a tagged type is declared, the corresponding class type is always
3162 -- created, using this Ekind value).
3164 E_Class_Wide_Subtype,
3165 -- A subtype of a class wide type, created by a subtype declaration
3166 -- used to declare a subtype of a class type.
3169 -- A record type, created by a record type declaration
3172 -- A record subtype, created by a record subtype declaration.
3174 E_Record_Type_With_Private,
3175 -- Used for types defined by a private extension declaration. Includes
3176 -- the fields for both private types and for record types (with the
3177 -- sole exception of Corresponding_Concurrent_Type which is obviously
3178 -- not needed). This entity is considered to be both a record type and
3181 E_Record_Subtype_With_Private,
3182 -- A subtype of a type defined by a private extension declaration.
3185 -- A private type, created by a private type declaration that does
3186 -- not have the keyword limited.
3189 -- A subtype of a private type, created by a subtype declaration used
3190 -- to declare a subtype of a private type.
3192 E_Limited_Private_Type,
3193 -- A limited private type, created by a private type declaration that
3194 -- has the keyword limited.
3196 E_Limited_Private_Subtype,
3197 -- A subtype of a limited private type, created by a subtype declaration
3198 -- used to declare a subtype of a limited private type.
3201 -- An incomplete type, created by an incomplete type declaration
3204 -- A task type, created by a task type declaration. An entity with this
3205 -- Ekind is also created to describe the anonymous type of a task that
3206 -- is created by a single task declaration.
3209 -- A subtype of a task type, created by a subtype declaration used to
3210 -- declare a subtype of a task type.
3213 -- A protected type, created by a protected type declaration. An entity
3214 -- with this Ekind is also created to describe the anonymous type of
3215 -- a protected object created by a single protected declaration.
3217 E_Protected_Subtype,
3218 -- A subtype of a protected type, created by a subtype declaration used
3219 -- to declare a subtype of a protected type.
3226 -- The type of an exception created by an exception declaration
3229 -- This is the designated type of an Access_To_Subprogram. Has type
3230 -- and signature like a subprogram entity, so can appear in calls,
3231 -- which are resolved like regular calls, except that such an entity
3232 -- is not overloadable.
3234 ---------------------------
3235 -- Overloadable Entities --
3236 ---------------------------
3238 E_Enumeration_Literal,
3239 -- An enumeration literal, created by the use of the literal in an
3240 -- enumeration type definition.
3243 -- A function, created by a function declaration or a function body
3244 -- that acts as its own declaration.
3247 -- A predefined operator, appearing in Standard, or an implicitly
3248 -- defined concatenation operator created whenever an array is
3249 -- declared. We do not make normal derived operators explicit in
3250 -- the tree, but the concatenation operators are made explicit.
3253 -- A procedure, created by a procedure declaration or a procedure
3254 -- body that acts as its own declaration.
3257 -- An entry, created by an entry declaration in a task or protected
3260 --------------------
3261 -- Other Entities --
3262 --------------------
3265 -- An entry family, created by an entry family declaration in a
3266 -- task or protected type definition.
3269 -- A block identifier, created by an explicit or implicit label on
3270 -- a block or declare statement.
3272 E_Entry_Index_Parameter,
3273 -- An entry index parameter created by an entry index specification
3274 -- for the body of a protected entry family.
3277 -- An exception created by an exception declaration. The exception
3278 -- itself uses E_Exception for the Ekind, the implicit type that is
3279 -- created to represent its type uses the Ekind E_Exception_Type.
3282 -- A generic function. This is the entity for a generic function
3283 -- created by a generic subprogram declaration.
3286 -- A generic package, this is the entity for a generic package created
3287 -- by a generic package declaration.
3289 E_Generic_Procedure,
3290 -- A generic function. This is the entity for a generic procedure
3291 -- created by a generic subprogram declaration.
3294 -- The defining entity for a label. Note that this is created by the
3295 -- implicit label declaration, not the occurrence of the label itself,
3296 -- which is simply a direct name referring to the label.
3299 -- A loop identifier, created by an explicit or implicit label on a
3303 -- A package, created by a package declaration
3306 -- A package body. This entity serves only limited functions, since
3307 -- most semantic analysis uses the package entity (E_Package). However
3308 -- there are some attributes that are significant for the body entity.
3309 -- For example, collection of exception handlers.
3312 -- A protected object, created by an object declaration that declares
3313 -- an object of a protected type.
3316 -- A protected body. This entity serves almost no function, since all
3317 -- semantic analysis uses the protected entity (E_Protected_Type)
3320 -- A task body. This entity serves almost no function, since all
3321 -- semantic analysis uses the protected entity (E_Task_Type).
3324 -- A subprogram body. Used when a subprogram has a separate declaration
3325 -- to represent the entity for the body. This entity serves almost no
3326 -- function, since all semantic analysis uses the subprogram entity
3327 -- for the declaration (E_Function or E_Procedure).
3330 for Entity_Kind'Size use 8;
3331 -- The data structures in Atree assume this!
3333 --------------------------
3334 -- Subtype Declarations --
3335 --------------------------
3337 -- The above entities are arranged so that they can be conveniently
3338 -- grouped into subtype ranges. Note that for each of the xxx_KInd
3339 -- ranges defined below, there is a corresponding Is_xxx.. predicate
3340 -- which is to be used in preference to direct range tests using the
3341 -- subtype name. However, the subtype names are available for direct
3342 -- use, e.g. as choices in case statements.
3344 subtype Access_Kind is Entity_Kind range
3347 -- E_Access_Attribute_Type
3349 -- E_General_Access_Type
3350 -- E_Access_Subprogram_Type
3351 -- E_Access_Protected_Subprogram_Type
3352 E_Anonymous_Access_Type;
3354 subtype Array_Kind is Entity_Kind range
3359 E_String_Literal_Subtype;
3361 subtype Class_Wide_Kind is Entity_Kind range
3362 E_Class_Wide_Type ..
3363 E_Class_Wide_Subtype;
3365 subtype Composite_Kind is Entity_Kind range
3370 -- E_String_Literal_Subtype
3371 -- E_Class_Wide_Type
3372 -- E_Class_Wide_Subtype
3375 -- E_Record_Type_With_Private
3376 -- E_Record_Subtype_With_Private
3378 -- E_Private_Subtype
3379 -- E_Limited_Private_Type
3380 -- E_Limited_Private_Subtype
3381 -- E_Incomplete_Type
3384 -- E_Protected_Type,
3385 E_Protected_Subtype;
3387 subtype Concurrent_Kind is Entity_Kind range
3390 -- E_Protected_Type,
3391 E_Protected_Subtype;
3393 subtype Concurrent_Body_Kind is Entity_Kind range
3397 subtype Decimal_Fixed_Point_Kind is Entity_Kind range
3398 E_Decimal_Fixed_Point_Type ..
3399 E_Decimal_Fixed_Point_Subtype;
3401 subtype Digits_Kind is Entity_Kind range
3402 E_Decimal_Fixed_Point_Type ..
3403 -- E_Decimal_Fixed_Point_Subtype
3404 -- E_Floating_Point_Type
3405 E_Floating_Point_Subtype;
3407 subtype Discrete_Kind is Entity_Kind range
3408 E_Enumeration_Type ..
3409 -- E_Enumeration_Subtype
3410 -- E_Signed_Integer_Type
3411 -- E_Signed_Integer_Subtype
3412 -- E_Modular_Integer_Type
3413 E_Modular_Integer_Subtype;
3415 subtype Discrete_Or_Fixed_Point_Kind is Entity_Kind range
3416 E_Enumeration_Type ..
3417 -- E_Enumeration_Subtype
3418 -- E_Signed_Integer_Type
3419 -- E_Signed_Integer_Subtype
3420 -- E_Modular_Integer_Type
3421 -- E_Modular_Integer_Subtype
3422 -- E_Ordinary_Fixed_Point_Type
3423 -- E_Ordinary_Fixed_Point_Subtype
3424 -- E_Decimal_Fixed_Point_Type
3425 E_Decimal_Fixed_Point_Subtype;
3427 subtype Elementary_Kind is Entity_Kind range
3428 E_Enumeration_Type ..
3429 -- E_Enumeration_Subtype
3430 -- E_Signed_Integer_Type
3431 -- E_Signed_Integer_Subtype
3432 -- E_Modular_Integer_Type
3433 -- E_Modular_Integer_Subtype
3434 -- E_Ordinary_Fixed_Point_Type
3435 -- E_Ordinary_Fixed_Point_Subtype
3436 -- E_Decimal_Fixed_Point_Type
3437 -- E_Decimal_Fixed_Point_Subtype
3438 -- E_Floating_Point_Type
3439 -- E_Floating_Point_Subtype
3442 -- E_Access_Attribute_Type
3444 -- E_General_Access_Type
3445 -- E_Access_Subprogram_Type
3446 -- E_Access_Protected_Subprogram_Type
3447 E_Anonymous_Access_Type;
3449 subtype Enumeration_Kind is Entity_Kind range
3450 E_Enumeration_Type ..
3451 E_Enumeration_Subtype;
3453 subtype Entry_Kind is Entity_Kind range
3457 subtype Fixed_Point_Kind is Entity_Kind range
3458 E_Ordinary_Fixed_Point_Type ..
3459 -- E_Ordinary_Fixed_Point_Subtype
3460 -- E_Decimal_Fixed_Point_Type
3461 E_Decimal_Fixed_Point_Subtype;
3463 subtype Float_Kind is Entity_Kind range
3464 E_Floating_Point_Type ..
3465 E_Floating_Point_Subtype;
3467 subtype Formal_Kind is Entity_Kind range
3472 subtype Generic_Unit_Kind is Entity_Kind range
3473 E_Generic_Function ..
3474 -- E_Generic_Package,
3475 E_Generic_Procedure;
3477 subtype Incomplete_Or_Private_Kind is Entity_Kind range
3478 E_Record_Type_With_Private ..
3479 -- E_Record_Subtype_With_Private
3481 -- E_Private_Subtype
3482 -- E_Limited_Private_Type
3483 -- E_Limited_Private_Subtype
3486 subtype Integer_Kind is Entity_Kind range
3487 E_Signed_Integer_Type ..
3488 -- E_Signed_Integer_Subtype
3489 -- E_Modular_Integer_Type
3490 E_Modular_Integer_Subtype;
3492 subtype Modular_Integer_Kind is Entity_Kind range
3493 E_Modular_Integer_Type ..
3494 E_Modular_Integer_Subtype;
3496 subtype Named_Kind is Entity_Kind range
3500 subtype Numeric_Kind is Entity_Kind range
3501 E_Signed_Integer_Type ..
3502 -- E_Signed_Integer_Subtype
3503 -- E_Modular_Integer_Type
3504 -- E_Modular_Integer_Subtype
3505 -- E_Ordinary_Fixed_Point_Type
3506 -- E_Ordinary_Fixed_Point_Subtype
3507 -- E_Decimal_Fixed_Point_Type
3508 -- E_Decimal_Fixed_Point_Subtype
3509 -- E_Floating_Point_Type
3510 E_Floating_Point_Subtype;
3512 subtype Object_Kind is Entity_Kind range
3520 -- E_In_Out_Parameter
3521 -- E_Generic_In_Out_Parameter
3522 E_Generic_In_Parameter;
3524 subtype Ordinary_Fixed_Point_Kind is Entity_Kind range
3525 E_Ordinary_Fixed_Point_Type ..
3526 E_Ordinary_Fixed_Point_Subtype;
3528 subtype Overloadable_Kind is Entity_Kind range
3529 E_Enumeration_Literal ..
3535 subtype Private_Kind is Entity_Kind range
3536 E_Record_Type_With_Private ..
3537 -- E_Record_Subtype_With_Private
3539 -- E_Private_Subtype
3540 -- E_Limited_Private_Type
3541 E_Limited_Private_Subtype;
3543 subtype Protected_Kind is Entity_Kind range
3545 E_Protected_Subtype;
3547 subtype Real_Kind is Entity_Kind range
3548 E_Ordinary_Fixed_Point_Type ..
3549 -- E_Ordinary_Fixed_Point_Subtype
3550 -- E_Decimal_Fixed_Point_Type
3551 -- E_Decimal_Fixed_Point_Subtype
3552 -- E_Floating_Point_Type
3553 E_Floating_Point_Subtype;
3555 subtype Record_Kind is Entity_Kind range
3556 E_Class_Wide_Type ..
3557 -- E_Class_Wide_Subtype
3560 -- E_Record_Type_With_Private
3561 E_Record_Subtype_With_Private;
3563 subtype Scalar_Kind is Entity_Kind range
3564 E_Enumeration_Type ..
3565 -- E_Enumeration_Subtype
3566 -- E_Signed_Integer_Type
3567 -- E_Signed_Integer_Subtype
3568 -- E_Modular_Integer_Type
3569 -- E_Modular_Integer_Subtype
3570 -- E_Ordinary_Fixed_Point_Type
3571 -- E_Ordinary_Fixed_Point_Subtype
3572 -- E_Decimal_Fixed_Point_Type
3573 -- E_Decimal_Fixed_Point_Subtype
3574 -- E_Floating_Point_Type
3575 E_Floating_Point_Subtype;
3577 subtype String_Kind is Entity_Kind range
3580 E_String_Literal_Subtype;
3582 subtype Subprogram_Kind is Entity_Kind range
3587 subtype Signed_Integer_Kind is Entity_Kind range
3588 E_Signed_Integer_Type ..
3589 E_Signed_Integer_Subtype;
3591 subtype Task_Kind is Entity_Kind range
3595 subtype Type_Kind is Entity_Kind range
3596 E_Enumeration_Type ..
3597 -- E_Enumeration_Subtype
3598 -- E_Signed_Integer_Type
3599 -- E_Signed_Integer_Subtype
3600 -- E_Modular_Integer_Type
3601 -- E_Modular_Integer_Subtype
3602 -- E_Ordinary_Fixed_Point_Type
3603 -- E_Ordinary_Fixed_Point_Subtype
3604 -- E_Decimal_Fixed_Point_Type
3605 -- E_Decimal_Fixed_Point_Subtype
3606 -- E_Floating_Point_Type
3607 -- E_Floating_Point_Subtype
3610 -- E_Access_Attribute_Type
3611 -- E_Allocator_Type,
3612 -- E_General_Access_Type
3613 -- E_Access_Subprogram_Type,
3614 -- E_Access_Protected_Subprogram_Type
3615 -- E_Anonymous_Access_Type
3620 -- E_String_Literal_Subtype
3621 -- E_Class_Wide_Subtype
3622 -- E_Class_Wide_Type
3625 -- E_Record_Type_With_Private
3626 -- E_Record_Subtype_With_Private
3628 -- E_Private_Subtype
3629 -- E_Limited_Private_Type
3630 -- E_Limited_Private_Subtype
3631 -- E_Incomplete_Type
3635 -- E_Protected_Subtype
3639 --------------------------------------------------------
3640 -- Description of Defined Attributes for Entity_Kinds --
3641 --------------------------------------------------------
3643 -- For each enumeration value defined in Entity_Kind we list all the
3644 -- attributes defined in Einfo which can legally be applied to an entity
3645 -- of that kind. The implementation of the attribute functions (and for
3646 -- non-synthesized attributes, or the corresponding set procedures) are
3647 -- in the Einfo body.
3649 -- The following attributes apply to all entities
3654 -- Next_Entity (Node2)
3658 -- First_Rep_Item (Node6)
3659 -- Freeze_Node (Node7)
3661 -- Address_Taken (Flag104)
3662 -- Debug_Info_Off (Flag166)
3663 -- Has_Convention_Pragma (Flag119)
3664 -- Has_Delayed_Freeze (Flag18)
3665 -- Has_Fully_Qualified_Name (Flag173)
3666 -- Has_Gigi_Rep_Item (Flag82)
3667 -- Has_Homonym (Flag56)
3668 -- Has_Pragma_Elaborate_Body (Flag150)
3669 -- Has_Pragma_Inline (Flag157)
3670 -- Has_Private_Declaration (Flag155)
3671 -- Has_Qualified_Name (Flag161)
3672 -- Has_Unknown_Discriminants (Flag72)
3673 -- Is_Bit_Packed_Array (Flag122)
3674 -- Is_Child_Unit (Flag73)
3675 -- Is_Compilation_Unit (Flag149)
3676 -- Is_Completely_Hidden (Flag103)
3677 -- Is_Discrim_SO_Function (Flag176)
3678 -- Is_Dispatching_Operation (Flag6)
3679 -- Is_Exported (Flag99)
3680 -- Is_First_Subtype (Flag70)
3681 -- Is_Formal_Subprogram (Flag111)
3682 -- Is_Generic_Instance (Flag130)
3683 -- Is_Hidden (Flag57)
3684 -- Is_Hidden_Open_Scope (Flag171)
3685 -- Is_Immediately_Visible (Flag7)
3686 -- Is_Imported (Flag24)
3687 -- Is_Inlined (Flag11)
3688 -- Is_Internal (Flag17)
3689 -- Is_Itype (Flag91)
3690 -- Is_Known_Valid (Flag170)
3691 -- Is_Limited_Composite (Flag106)
3692 -- Is_Limited_Record (Flag25)
3693 -- Is_Package_Body_Entity (Flag160)
3694 -- Is_Packed_Array_Type (Flag138)
3695 -- Is_Potentially_Use_Visible (Flag9)
3696 -- Is_Preelaborated (Flag59)
3697 -- Is_Public (Flag10)
3699 -- Is_Remote_Call_Interface (Flag62)
3700 -- Is_Remote_Types (Flag61)
3701 -- Is_Shared_Passive (Flag60)
3702 -- Is_Statically_Allocated (Flag28)
3703 -- Is_Unchecked_Union (Flag117)
3704 -- Is_VMS_Exception (Flag133)
3705 -- Materialize_Entity (Flag168)
3706 -- Needs_Debug_Info (Flag147)
3707 -- Referenced (Flag156)
3708 -- Suppress_Access_Checks (Flag31)
3709 -- Suppress_Accessibility_Checks (Flag32)
3710 -- Suppress_Discriminant_Checks (Flag33)
3711 -- Suppress_Division_Checks (Flag34)
3712 -- Suppress_Elaboration_Checks (Flag35)
3713 -- Suppress_Elaboration_Warnings (Flag148)
3714 -- Suppress_Index_Checks (Flag36)
3715 -- Suppress_Length_Checks (Flag37)
3716 -- Suppress_Overflow_Checks (Flag38)
3717 -- Suppress_Range_Checks (Flag39)
3718 -- Suppress_Storage_Checks (Flag40)
3719 -- Suppress_Style_Checks (Flag165)
3720 -- Suppress_Tag_Checks (Flag41)
3722 -- Declaration_Node (synth)
3723 -- Enclosing_Dynamic_Scope (synth)
3724 -- Has_Foreign_Convention (synth)
3725 -- Is_Dynamic_Scope (synth)
3726 -- Is_Generic_Unit (synth)
3727 -- Is_Limited_Type (synth)
3728 -- Underlying_Type (synth)
3729 -- all classification attributes (synth)
3731 -- The following list of access functions applies to all entities for
3732 -- types and subtypes. References to this list appear subsequently as
3733 -- as "(plus type attributes)" for each appropriate Entity_Kind.
3735 -- Associated_Node_For_Itype (Node8)
3736 -- Class_Wide_Type (Node9)
3737 -- Referenced_Object (Node10)
3738 -- Full_View (Node11)
3741 -- Alignment (Uint14)
3743 -- Depends_On_Private (Flag14)
3744 -- Discard_Names (Flag88)
3745 -- Finalize_Storage_Only (Flag158) (base type only)
3746 -- From_With_Type (Flag159)
3747 -- Has_Aliased_Components (Flag135)
3748 -- Has_Alignment_Clause (Flag46)
3749 -- Has_Atomic_Components (Flag86) (base type only)
3750 -- Has_Complex_Representation (Flag140) (base type only)
3751 -- Has_Discriminants (Flag5)
3752 -- Has_Non_Standard_Rep (Flag75)
3753 -- Has_Object_Size_Clause (Flag172)
3754 -- Has_Primitive_Operations (Flag120) (base type only)
3755 -- Has_Size_Clause (Flag29)
3756 -- Has_Specified_Layout (Flag100) (base type only)
3757 -- Has_Task (Flag30) (base type only)
3758 -- Has_Unchecked_Union (Flag123) (base type only)
3759 -- Has_Volatile_Components (Flag87) (base type only)
3761 -- Is_Abstract (Flag19)
3762 -- Is_Asynchronous (Flag81)
3763 -- Is_Atomic (Flag85)
3764 -- Is_Constr_Subt_For_U_Nominal (Flag80)
3765 -- Is_Constr_Subt_For_UN_Aliased (Flag141)
3766 -- Is_Controlled (Flag42) (base type only)
3767 -- Is_Eliminated (Flag124)
3768 -- Is_Frozen (Flag4)
3769 -- Is_Generic_Actual_Type (Flag94)
3770 -- Is_Generic_Type (Flag13)
3771 -- Is_Non_Static_Subtype (Flag109)
3772 -- Is_Packed (Flag51) (base type only)
3773 -- Is_Private_Composite (Flag107)
3774 -- Is_Renaming_Of_Object (Flag112)
3775 -- Is_Tagged_Type (Flag55)
3776 -- Is_Unsigned_Type (Flag144)
3777 -- Is_Volatile (Flag16)
3778 -- Size_Depends_On_Discriminant (Flag177)
3779 -- Size_Known_At_Compile_Time (Flag92)
3780 -- Strict_Alignment (Flag145)
3781 -- Suppress_Init_Proc (Flag105) (base type only)
3783 -- Alignment_Clause (synth)
3784 -- Ancestor_Subtype (synth)
3785 -- Base_Type (synth)
3786 -- First_Subtype (synth)
3787 -- Has_Private_Ancestor (synth)
3788 -- Implementation_Base_Type (synth)
3789 -- Is_By_Copy_Type (synth)
3790 -- Is_By_Reference_Type (synth)
3791 -- Is_Return_By_Reference_Type (synth)
3792 -- Root_Type (synth)
3793 -- Size_Clause (synth)
3795 ------------------------------------------
3796 -- Applicable attributes by entity kind --
3797 ------------------------------------------
3799 -- E_Access_Protected_Subprogram_Type
3800 -- Equivalent_Type (Node18)
3801 -- Directly_Designated_Type (Node20)
3802 -- Needs_No_Actuals (Flag22)
3803 -- (plus type attributes)
3805 -- E_Access_Subprogram_Type
3806 -- Equivalent_Type (Node18) (remote types only)
3807 -- Directly_Designated_Type (Node20)
3808 -- Needs_No_Actuals (Flag22)
3809 -- (plus type attributes)
3813 -- Storage_Size_Variable (Node15) (root type only)
3814 -- Master_Id (Node17)
3815 -- Directly_Designated_Type (Node20)
3816 -- Associated_Storage_Pool (Node22)
3817 -- Associated_Final_Chain (Node23)
3818 -- Has_Pragma_Controlled (Flag27) (base type only)
3819 -- Has_Storage_Size_Clause (Flag23) (root type only)
3820 -- Is_Access_Constant (Flag69)
3821 -- No_Pool_Assigned (Flag131) (root type only)
3822 -- (plus type attributes)
3824 -- E_Access_Attribute_Type
3825 -- Directly_Designated_Type (Node20)
3826 -- (plus type attributes)
3829 -- Directly_Designated_Type (Node20)
3830 -- (plus type attributes)
3832 -- E_Anonymous_Access_Type
3833 -- Storage_Size_Variable (Node15) ??? is this needed ???
3834 -- Directly_Designated_Type (Node20)
3835 -- (plus type attributes)
3839 -- First_Index (Node17)
3840 -- Related_Array_Object (Node19)
3841 -- Component_Type (Node20) (base type only)
3842 -- Component_Size (Uint22) (base type only)
3843 -- Packed_Array_Type (Node23)
3844 -- Component_Alignment (special) (base type only)
3845 -- Has_Component_Size_Clause (Flag68) (base type only)
3846 -- Has_Controlled_Component (Flag43) (base type only)
3847 -- Has_Pragma_Pack (Flag121) (base type only)
3848 -- Is_Aliased (Flag15)
3849 -- Is_Constrained (Flag12)
3850 -- Next_Index (synth)
3851 -- Number_Dimensions (synth)
3852 -- (plus type attributes)
3855 -- Block_Node (Node11)
3856 -- First_Entity (Node17)
3857 -- Last_Entity (Node20)
3858 -- Delay_Cleanups (Flag114)
3859 -- Discard_Names (Flag88)
3860 -- Finalization_Chain_Entity (Node19)
3861 -- Scope_Depth_Value (Uint22)
3862 -- Scope_Depth (synth)
3863 -- Entry_Cancel_Parameter (Node23)
3864 -- Has_Master_Entity (Flag21)
3865 -- Has_Nested_Block_With_Handler (Flag101)
3866 -- Sec_Stack_Needed_For_Return (Flag167)
3867 -- Uses_Sec_Stack (Flag95)
3869 -- E_Class_Wide_Type
3870 -- E_Class_Wide_Subtype
3871 -- Cloned_Subtype (Node16) (subtype case only)
3872 -- First_Entity (Node17)
3873 -- Equivalent_Type (Node18) (always Empty in type case)
3874 -- Last_Entity (Node20)
3875 -- Has_Controlled_Component (Flag43) (base type only)
3876 -- First_Component (synth)
3877 -- (plus type attributes)
3880 -- Normalized_First_Bit (Uint8)
3881 -- Normalized_Position (Uint9)
3882 -- Normalized_Position_Max (Uint10)
3883 -- Component_Bit_Offset (Uint11)
3885 -- Component_Clause (Node13)
3886 -- DT_Entry_Count (Uint15)
3887 -- Entry_Formal (Node16)
3889 -- Renamed_Object (Node18) (always Empty)
3890 -- Discriminant_Checking_Func (Node20)
3891 -- Interface_Name (Node21) (JGNAT usage only)
3892 -- Original_Record_Component (Node22)
3893 -- Protected_Operation (Node23)
3894 -- Has_Biased_Representation (Flag139)
3895 -- Has_Per_Object_Constraint (Flag154)
3896 -- Is_Atomic (Flag85)
3898 -- Is_Volatile (Flag16)
3899 -- Next_Component (synth)
3900 -- Is_Protected_Private (synth)
3904 -- Size_Check_Code (Node9)
3905 -- Discriminal_Link (Node10) (discriminals only)
3906 -- Full_View (Node11)
3908 -- Alignment (Uint14)
3909 -- Actual_Subtype (Node17)
3910 -- Renamed_Object (Node18)
3911 -- Interface_Name (Node21)
3912 -- Has_Alignment_Clause (Flag46)
3913 -- Has_Atomic_Components (Flag86)
3914 -- Has_Biased_Representation (Flag139)
3915 -- Has_Size_Clause (Flag29)
3916 -- Has_Volatile_Components (Flag87)
3917 -- Is_Atomic (Flag85)
3918 -- Is_Eliminated (Flag124)
3919 -- Is_Psected (Flag153)
3920 -- Is_True_Constant (Flag163)
3921 -- Is_Volatile (Flag16)
3922 -- Not_Source_Assigned (Flag115)
3923 -- Address_Clause (synth)
3924 -- Alignment_Clause (synth)
3925 -- Constant_Value (synth)
3926 -- Size_Clause (synth)
3928 -- E_Decimal_Fixed_Point_Type
3929 -- E_Decimal_Fixed_Subtype
3930 -- Scale_Value (Uint15)
3931 -- Digits_Value (Uint17)
3932 -- Scalar_Range (Node20)
3933 -- Delta_Value (Ureal18)
3934 -- Small_Value (Ureal21)
3935 -- Has_Machine_Radix_Clause (Flag83)
3936 -- Machine_Radix_10 (Flag84)
3937 -- Type_Low_Bound (synth)
3938 -- Type_High_Bound (synth)
3939 -- (plus type attributes)
3942 -- Normalized_First_Bit (Uint8)
3943 -- Normalized_Position (Uint9)
3944 -- Normalized_Position_Max (Uint10)
3945 -- Component_Bit_Offset (Uint11)
3947 -- Component_Clause (Node13)
3948 -- Discriminant_Number (Uint15)
3949 -- Discriminal (Node17)
3950 -- Renamed_Object (Node18) (always Empty)
3951 -- Corresponding_Discriminant (Node19)
3952 -- Discriminant_Default_Value (Node20)
3953 -- Interface_Name (Node21) (JGNAT usage only)
3954 -- Original_Record_Component (Node22)
3955 -- CR_Discriminant (Node23)
3956 -- Next_Discriminant (synth)
3957 -- Next_Girder_Discriminant (synth)
3961 -- Protected_Body_Subprogram (Node11)
3962 -- Barrier_Function (Node12)
3963 -- Entry_Parameters_Type (Node15)
3964 -- First_Entity (Node17)
3965 -- Alias (Node18) (Entry only. Always empty)
3966 -- Finalization_Chain_Entity (Node19)
3967 -- Last_Entity (Node20)
3968 -- Accept_Address (Elist21)
3969 -- Scope_Depth_Value (Uint22)
3970 -- Scope_Depth (synth)
3971 -- Privals_Chain (Elist23) (for a protected entry)
3972 -- Default_Expressions_Processed (Flag108)
3973 -- Entry_Accepted (Flag152)
3974 -- Is_AST_Entry (Flag132) (for entry only)
3975 -- Needs_No_Actuals (Flag22)
3976 -- Sec_Stack_Needed_For_Return (Flag167)
3977 -- Uses_Sec_Stack (Flag95)
3978 -- Address_Clause (synth)
3979 -- First_Formal (synth)
3980 -- Entry_Index_Type (synth)
3981 -- Number_Formals (synth)
3983 -- E_Entry_Index_Parameter
3984 -- Entry_Index_Constant (Node18)
3986 -- E_Enumeration_Literal
3987 -- Enumeration_Pos (Uint11)
3988 -- Enumeration_Rep (Uint12)
3989 -- Debug_Renaming_Link (Node13)
3991 -- Enumeration_Rep_Expr (Node22)
3992 -- Next_Literal (synth)
3994 -- E_Enumeration_Type
3995 -- E_Enumeration_Subtype
3996 -- Lit_Indexes (Node15) (root type only)
3997 -- Lit_Strings (Node16) (root type only)
3998 -- First_Literal (Node17)
3999 -- Scalar_Range (Node20)
4000 -- Enum_Pos_To_Rep (Node23) (type only, not subtype)
4001 -- Has_Biased_Representation (Flag139)
4002 -- Has_Enumeration_Rep_Clause (Flag66)
4003 -- Nonzero_Is_True (Flag162) (base type only)
4004 -- Type_Low_Bound (synth)
4005 -- Type_High_Bound (synth)
4006 -- (plus type attributes)
4009 -- Renamed_Entity (Node18)
4010 -- Register_Exception_Call (Node20)
4011 -- Interface_Name (Node21)
4012 -- Exception_Code (Uint22)
4013 -- Discard_Names (Flag88)
4014 -- Is_VMS_Exception (Flag133)
4017 -- Equivalent_Type (Node18)
4018 -- (plus type attributes)
4020 -- E_Floating_Point_Type
4021 -- E_Floating_Point_Subtype
4022 -- Digits_Value (Uint17)
4023 -- Type_Low_Bound (synth)
4024 -- Scalar_Range (Node20)
4025 -- Type_High_Bound (synth)
4026 -- (plus type attributes)
4029 -- E_Generic_Function
4030 -- Mechanism (Uint8) (returns Mechanism_Type)
4031 -- Renaming_Map (Uint9)
4032 -- Handler_Records (List10) (non-generic case only)
4033 -- Protected_Body_Subprogram (Node11)
4034 -- Next_Inlined_Subprogram (Node12)
4035 -- Corresponding_Equality (Node13) (implicit /= only)
4036 -- Elaboration_Entity (Node13) (all other cases)
4037 -- First_Optional_Parameter (Node14) (non-generic case only)
4038 -- DT_Position (Uint15)
4039 -- DTC_Entity (Node16)
4040 -- First_Entity (Node17)
4041 -- Alias (Node18) (non-generic case only)
4042 -- Renamed_Entity (Node18) (generic case only)
4043 -- Finalization_Chain_Entity (Node19)
4044 -- Last_Entity (Node20)
4045 -- Interface_Name (Node21)
4046 -- Scope_Depth_Value (Uint22)
4047 -- Scope_Depth (synth)
4048 -- Generic_Renamings (Elist23) (for an instance)
4049 -- Inner_Instances (Elist23) (for a generic function)
4050 -- Privals_Chain (Elist23) (for a protected function)
4051 -- Elaboration_Entity_Required (Flag174)
4052 -- Function_Returns_With_DSP (Flag169)
4053 -- Default_Expressions_Processed (Flag108)
4054 -- Delay_Cleanups (Flag114)
4055 -- Delay_Subprogram_Descriptors (Flag50)
4056 -- Discard_Names (Flag88)
4057 -- Elaborate_All_Desirable (Flag146)
4058 -- Has_Completion (Flag26)
4059 -- Has_Controlling_Result (Flag98)
4060 -- Has_Master_Entity (Flag21)
4061 -- Has_Missing_Return (Flag142)
4062 -- Has_Nested_Block_With_Handler (Flag101)
4063 -- Has_Pragma_Pure_Function (Flag179) (non-generic case only)
4064 -- Has_Recursive_Call (Flag143)
4065 -- Has_Subprogram_Descriptor (Flag93)
4066 -- Is_Abstract (Flag19)
4067 -- Is_Called (Flag102) (non-generic case only)
4068 -- Is_Constructor (Flag76)
4069 -- Is_Destructor (Flag77)
4070 -- Is_Discrim_SO_Function (Flag176)
4071 -- Is_Eliminated (Flag124)
4072 -- Is_Instantiated (Flag126) (generic case only)
4073 -- Is_Intrinsic_Subprogram (Flag64)
4074 -- Is_Machine_Code_Subprogram (Flag137) (non-generic case only)
4075 -- Is_Private_Descendant (Flag53)
4077 -- Is_Visible_Child_Unit (Flag116)
4078 -- Needs_No_Actuals (Flag22)
4079 -- Return_Present (Flag54)
4080 -- Returns_By_Ref (Flag90)
4081 -- Sec_Stack_Needed_For_Return (Flag167)
4082 -- Uses_Sec_Stack (Flag95)
4083 -- Address_Clause (synth)
4084 -- First_Formal (synth)
4085 -- Number_Formals (synth)
4087 -- E_General_Access_Type
4088 -- Storage_Size_Variable (Node15) (base type only)
4089 -- Master_Id (Node17)
4090 -- Directly_Designated_Type (Node20)
4091 -- Associated_Storage_Pool (Node22)
4092 -- Associated_Final_Chain (Node23)
4093 -- (plus type attributes)
4095 -- E_Generic_In_Parameter
4096 -- E_Generic_In_Out_Parameter
4097 -- Entry_Component (Node11)
4098 -- Actual_Subtype (Node17)
4099 -- Renamed_Object (Node18) (always Empty)
4100 -- Default_Value (Node20)
4101 -- Protected_Formal (Node22)
4102 -- Is_Controlling_Formal (Flag97)
4103 -- Is_Entry_Formal (Flag52)
4104 -- Parameter_Mode (synth)
4106 -- E_Incomplete_Type
4107 -- Private_Dependents (Elist18)
4108 -- Discriminant_Constraint (Elist21)
4109 -- Girder_Constraint (Elist23)
4110 -- First_Discriminant (synth)
4111 -- First_Girder_Discriminant (synth)
4112 -- (plus type attributes)
4115 -- E_In_Out_Parameter
4117 -- Mechanism (Uint8) (returns Mechanism_Type)
4118 -- Discriminal_Link (Node10) (discriminals only)
4119 -- Entry_Component (Node11)
4121 -- Extra_Accessibility (Node13)
4122 -- Alignment (Uint14)
4123 -- Extra_Formal (Node15)
4124 -- Unset_Reference (Node16)
4125 -- Actual_Subtype (Node17)
4126 -- Renamed_Object (Node18)
4127 -- Spec_Entity (Node19)
4128 -- Default_Value (Node20)
4129 -- Default_Expr_Function (Node21)
4130 -- Protected_Formal (Node22)
4131 -- Extra_Constrained (Node23)
4132 -- Is_Controlling_Formal (Flag97)
4133 -- Is_Entry_Formal (Flag52)
4134 -- Is_Optional_Parameter (Flag134)
4135 -- Not_Source_Assigned (Flag115)
4136 -- Parameter_Mode (synth)
4139 -- Enclosing_Scope (Node18)
4140 -- Reachable (Flag49)
4142 -- E_Limited_Private_Type
4143 -- E_Limited_Private_Subtype
4144 -- First_Entity (Node17)
4145 -- Private_Dependents (Elist18)
4146 -- Underlying_Full_View (Node19)
4147 -- Last_Entity (Node20)
4148 -- Discriminant_Constraint (Elist21)
4149 -- Private_View (Node22)
4150 -- Girder_Constraint (Elist23)
4151 -- Has_Completion (Flag26)
4152 -- Has_Completion_In_Body (Flag71)
4153 -- First_Discriminant (synth)
4154 -- First_Girder_Discriminant (synth)
4155 -- (plus type attributes)
4158 -- Has_Exit (Flag47)
4159 -- Has_Master_Entity (Flag21)
4160 -- Has_Nested_Block_With_Handler (Flag101)
4162 -- E_Modular_Integer_Type
4163 -- E_Modular_Integer_Subtype
4164 -- Modulus (Uint17) (base type only)
4165 -- Scalar_Range (Node20)
4166 -- Non_Binary_Modulus (Flag58) (base type only)
4167 -- Has_Biased_Representation (Flag139)
4168 -- Type_Low_Bound (synth)
4169 -- Type_High_Bound (synth)
4170 -- (plus type attributes)
4173 -- Constant_Value (synth)
4176 -- Constant_Value (synth)
4179 -- First_Entity (Node17)
4181 -- Last_Entity (Node20)
4182 -- Is_Machine_Code_Subprogram (Flag137)
4184 -- Is_Intrinsic_Subprogram (Flag64)
4185 -- Default_Expressions_Processed (Flag108)
4186 -- Has_Pragma_Pure_Function (Flag179)
4188 -- E_Ordinary_Fixed_Point_Type
4189 -- E_Ordinary_Fixed_Point_Subtype
4190 -- Delta_Value (Ureal18)
4191 -- Scalar_Range (Node20)
4192 -- Small_Value (Ureal21)
4193 -- Has_Small_Clause (Flag67)
4194 -- Type_Low_Bound (synth)
4195 -- Type_High_Bound (synth)
4196 -- (plus type attributes)
4199 -- E_Generic_Package
4200 -- Dependent_Instances (Elist8) (for an instance)
4201 -- Renaming_Map (Uint9)
4202 -- Handler_Records (List10) (non-generic case only)
4203 -- Associated_Formal_Package (Node12)
4204 -- Elaboration_Entity (Node13)
4205 -- Shadow_Entities (List14)
4206 -- Related_Instance (Node15) (non-generic case only)
4207 -- First_Private_Entity (Node16)
4208 -- First_Entity (Node17)
4209 -- Renamed_Entity (Node18)
4210 -- Body_Entity (Node19)
4211 -- Last_Entity (Node20)
4212 -- Interface_Name (Node21)
4213 -- Scope_Depth_Value (Uint22)
4214 -- Scope_Depth (synth)
4215 -- Generic_Renamings (Elist23) (for an instance)
4216 -- Inner_Instances (Elist23) (generic case only)
4217 -- Delay_Subprogram_Descriptors (Flag50)
4218 -- Discard_Names (Flag88)
4219 -- Elaborate_All_Desirable (Flag146)
4220 -- Elaboration_Entity_Required (Flag174)
4221 -- From_With_Type (Flag159)
4222 -- Has_All_Calls_Remote (Flag79)
4223 -- Has_Completion (Flag26)
4224 -- Has_Forward_Instantiation (Flag175)
4225 -- Has_Master_Entity (Flag21)
4226 -- Has_Subprogram_Descriptor (Flag93)
4227 -- In_Package_Body (Flag48)
4228 -- In_Private_Part (Flag45)
4230 -- Is_Instantiated (Flag126)
4231 -- Is_Private_Descendant (Flag53)
4232 -- Is_Visible_Child_Unit (Flag116)
4233 -- Is_Wrapper_Package (synth) (non-generic case only)
4236 -- Handler_Records (List10) (non-generic case only)
4237 -- First_Entity (Node17)
4238 -- Spec_Entity (Node19)
4239 -- Last_Entity (Node20)
4240 -- Scope_Depth_Value (Uint22)
4241 -- Scope_Depth (synth)
4242 -- Delay_Subprogram_Descriptors (Flag50)
4243 -- Has_Subprogram_Descriptor (Flag93)
4246 -- E_Private_Subtype
4247 -- Primitive_Operations (Elist15)
4248 -- First_Entity (Node17)
4249 -- Private_Dependents (Elist18)
4250 -- Underlying_Full_View (Node19)
4251 -- Last_Entity (Node20)
4252 -- Discriminant_Constraint (Elist21)
4253 -- Private_View (Node22)
4254 -- Girder_Constraint (Elist23)
4255 -- Has_Completion (Flag26)
4256 -- Has_Completion_In_Body (Flag71)
4257 -- Is_Controlled (Flag42) (base type only)
4258 -- Is_For_Access_Subtype (Flag118) (subtype only)
4259 -- First_Discriminant (synth)
4260 -- First_Girder_Discriminant (synth)
4261 -- (plus type attributes)
4264 -- E_Generic_Procedure
4265 -- Renaming_Map (Uint9)
4266 -- Handler_Records (List10) (non-generic case only)
4267 -- Protected_Body_Subprogram (Node11)
4268 -- Next_Inlined_Subprogram (Node12)
4269 -- Elaboration_Entity (Node13)
4270 -- First_Optional_Parameter (Node14) (non-generic case only)
4271 -- DT_Position (Uint15)
4272 -- DTC_Entity (Node16)
4273 -- First_Entity (Node17)
4274 -- Alias (Node18) (non-generic case only)
4275 -- Renamed_Entity (Node18) (generic case only)
4276 -- Finalization_Chain_Entity (Node19)
4277 -- Last_Entity (Node20)
4278 -- Interface_Name (Node21)
4279 -- Scope_Depth_Value (Uint22)
4280 -- Scope_Depth (synth)
4281 -- Generic_Renamings (Elist23) (for an instance)
4282 -- Inner_Instances (Elist23) (for a generic procedure)
4283 -- Privals_Chain (Elist23) (for a protected procedure)
4284 -- Elaboration_Entity_Required (Flag174)
4285 -- Function_Returns_With_DSP (Flag169) (always False for procedure)
4286 -- Default_Expressions_Processed (Flag108)
4287 -- Delay_Cleanups (Flag114)
4288 -- Delay_Subprogram_Descriptors (Flag50)
4289 -- Discard_Names (Flag88)
4290 -- Elaborate_All_Desirable (Flag146)
4291 -- Has_Completion (Flag26)
4292 -- Has_Master_Entity (Flag21)
4293 -- Has_Nested_Block_With_Handler (Flag101)
4294 -- Has_Pragma_Pure_Function (Flag179) (non-generic case only)
4295 -- Has_Subprogram_Descriptor (Flag93)
4296 -- Is_Visible_Child_Unit (Flag116)
4297 -- Is_Abstract (Flag19)
4298 -- Is_Asynchronous (Flag81)
4299 -- Is_Called (Flag102) (non-generic subprogram)
4300 -- Is_Constructor (Flag76)
4301 -- Is_Destructor (Flag77)
4302 -- Is_Eliminated (Flag124)
4303 -- Is_Instantiated (Flag126) (generic case only)
4304 -- Is_Interrupt_Handler (Flag89)
4305 -- Is_Intrinsic_Subprogram (Flag64)
4306 -- Is_Machine_Code_Subprogram (Flag137) (non-generic case only)
4307 -- Is_Null_Init_Proc (Flag178)
4308 -- Is_Private_Descendant (Flag53)
4310 -- Is_Valued_Procedure (Flag127)
4311 -- Is_Visible_Child_Unit (Flag116)
4312 -- Needs_No_Actuals (Flag22)
4313 -- No_Return (Flag113)
4314 -- Sec_Stack_Needed_For_Return (Flag167)
4315 -- Address_Clause (synth)
4316 -- First_Formal (synth)
4317 -- Number_Formals (synth)
4320 -- Object_Ref (Node17)
4321 -- (any others??? First/Last Entity, Scope_Depth???)
4323 -- E_Protected_Object
4326 -- E_Protected_Subtype
4327 -- Entry_Bodies_Array (Node15)
4328 -- First_Private_Entity (Node16)
4329 -- First_Entity (Node17)
4330 -- Corresponding_Record_Type (Node18)
4331 -- Finalization_Chain_Entity (Node19)
4332 -- Last_Entity (Node20)
4333 -- Discriminant_Constraint (Elist21)
4334 -- Scope_Depth_Value (Uint22)
4335 -- Scope_Depth (synth)
4336 -- Girder_Constraint (Elist23)
4337 -- Has_Controlled_Component (Flag43) (base type only)
4338 -- Has_Interrupt_Handler (synth)
4339 -- Sec_Stack_Needed_For_Return (Flag167) ???
4340 -- Uses_Sec_Stack (Flag95) ???
4341 -- Has_Entries (synth)
4342 -- Number_Entries (synth)
4346 -- Primitive_Operations (Elist15)
4347 -- Access_Disp_Table (Node16) (base type only)
4348 -- Cloned_Subtype (Node16) (subtype case only)
4349 -- First_Entity (Node17)
4350 -- Corresponding_Concurrent_Type (Node18)
4351 -- Parent_Subtype (Node19)
4352 -- Last_Entity (Node20)
4353 -- Discriminant_Constraint (Elist21)
4354 -- Corresponding_Remote_Type (Node22) (base type only)
4355 -- Girder_Constraint (Elist23)
4356 -- Component_Alignment (special) (base type only)
4357 -- C_Pass_By_Copy (Flag125) (base type only)
4358 -- Has_Controlled_Component (Flag43) (base type only)
4359 -- Has_External_Tag_Rep_Clause (Flag110)
4360 -- Has_Record_Rep_Clause (Flag65)
4361 -- Is_Concurrent_Record_Type (Flag20)
4362 -- Is_Constrained (Flag12)
4363 -- Is_Controlled (Flag42) (base type only)
4364 -- Reverse_Bit_Order (Flag164) (base type only)
4365 -- First_Component (synth)
4366 -- First_Discriminant (synth)
4367 -- First_Girder_Discriminant (synth)
4368 -- Tag_Component (synth)
4369 -- (plus type attributes)
4371 -- E_Record_Type_With_Private
4372 -- E_Record_Subtype_With_Private
4373 -- Primitive_Operations (Elist15)
4374 -- Access_Disp_Table (Node16) (base type only)
4375 -- First_Entity (Node17)
4376 -- Private_Dependents (Elist18)
4377 -- Underlying_Full_View (Node19)
4378 -- Last_Entity (Node20)
4379 -- Discriminant_Constraint (Elist21)
4380 -- Private_View (Node22)
4381 -- Girder_Constraint (Elist23)
4382 -- Has_Completion (Flag26)
4383 -- Has_Completion_In_Body (Flag71)
4384 -- Has_Controlled_Component (Flag43) (base type only)
4385 -- Has_Record_Rep_Clause (Flag65)
4386 -- Has_External_Tag_Rep_Clause (Flag110)
4387 -- Is_Concurrent_Record_Type (Flag20)
4388 -- Is_Constrained (Flag12)
4389 -- Is_Controlled (Flag42) (base type only)
4390 -- Reverse_Bit_Order (Flag164) (base type only)
4391 -- First_Component (synth)
4392 -- First_Discriminant (synth)
4393 -- First_Girder_Discriminant (synth)
4394 -- Tag_Component (synth)
4395 -- (plus type attributes)
4397 -- E_Signed_Integer_Type
4398 -- E_Signed_Integer_Subtype
4399 -- Scalar_Range (Node20)
4400 -- Has_Biased_Representation (Flag139)
4401 -- Type_Low_Bound (synth)
4402 -- Type_High_Bound (synth)
4403 -- (plus type attributes)
4407 -- First_Index (Node17)
4408 -- Component_Type (Node20) (base type only)
4409 -- Is_Constrained (Flag12)
4410 -- Next_Index (synth)
4411 -- Number_Dimensions (synth)
4412 -- (plus type attributes)
4414 -- E_String_Literal_Subtype
4415 -- String_Literal_Low_Bound (Node15)
4416 -- String_Literal_Length (Uint16)
4417 -- First_Index (Node17) (always Empty)
4418 -- Component_Type (Node20) (base type only)
4419 -- Packed_Array_Type (Node23)
4420 -- (plus type attributes)
4422 -- E_Subprogram_Body
4423 -- First_Entity (Node17)
4424 -- Last_Entity (Node20)
4425 -- Scope_Depth_Value (Uint22)
4426 -- Scope_Depth (synth)
4428 -- E_Subprogram_Type
4429 -- Directly_Designated_Type (Node20)
4430 -- First_Formal (synth)
4431 -- Number_Formals (synth)
4432 -- Function_Returns_With_DSP (Flag169)
4433 -- (plus type attributes)
4436 -- (any others??? First/Last Entity, Scope_Depth???)
4440 -- Storage_Size_Variable (Node15) (base type only)
4441 -- First_Private_Entity (Node16)
4442 -- First_Entity (Node17)
4443 -- Corresponding_Record_Type (Node18)
4444 -- Finalization_Chain_Entity (Node19)
4445 -- Last_Entity (Node20)
4446 -- Discriminant_Constraint (Elist21)
4447 -- Scope_Depth_Value (Uint22)
4448 -- Scope_Depth (synth)
4449 -- Girder_Constraint (Elist23)
4450 -- Delay_Cleanups (Flag114)
4451 -- Has_Master_Entity (Flag21)
4452 -- Has_Storage_Size_Clause (Flag23) (base type only)
4453 -- Uses_Sec_Stack (Flag95) ???
4454 -- Sec_Stack_Needed_For_Return (Flag167) ???
4455 -- Has_Entries (synth)
4456 -- Number_Entries (synth)
4457 -- (plus type attributes)
4460 -- Hiding_Loop_Variable (Node8)
4461 -- Size_Check_Code (Node9)
4463 -- Extra_Accessibility (Node13)
4464 -- Alignment (Uint14)
4465 -- Shared_Var_Read_Proc (Node15)
4466 -- Unset_Reference (Node16)
4467 -- Actual_Subtype (Node17)
4468 -- Renamed_Object (Node18)
4469 -- Interface_Name (Node21)
4470 -- Shared_Var_Assign_Proc (Node22)
4471 -- Extra_Constrained (Node23)
4472 -- Has_Alignment_Clause (Flag46)
4473 -- Has_Atomic_Components (Flag86)
4474 -- Has_Biased_Representation (Flag139)
4475 -- Has_Size_Clause (Flag29)
4476 -- Has_Volatile_Components (Flag87)
4477 -- Is_Atomic (Flag85)
4478 -- Is_Eliminated (Flag124)
4479 -- Is_Psected (Flag153)
4480 -- Is_Shared_Passive (Flag60)
4481 -- Is_True_Constant (Flag163)
4482 -- Is_Volatile (Flag16)
4483 -- Not_Source_Assigned (Flag115)
4484 -- Address_Clause (synth)
4485 -- Alignment_Clause (synth)
4486 -- Size_Clause (synth)
4489 -- Since E_Void is the initial Ekind value of an entity when it is first
4490 -- created, one might expect that no attributes would be defined on such
4491 -- an entity until its Ekind field is set. However, in practice, there
4492 -- are many instances in which fields of an E_Void entity are set in the
4493 -- code prior to setting the Ekind field. This is not well documented or
4494 -- well controlled, and needs cleaning up later. Meanwhile, the access
4495 -- procedures in the body of Einfo permit many, but not all, attributes
4496 -- to be applied to an E_Void entity, precisely so that this kind of
4497 -- pre-setting of attributes works. This is really a hole in the dynamic
4498 -- type checking, since there is no assurance that the eventual Ekind
4499 -- value will be appropriate for the attributes set, and the consequence
4500 -- is that the dynamic type checking in the Einfo body is unnecessarily
4501 -- weak. To be looked at systematically some time ???
4503 ---------------------------------
4504 -- Component_Alignment Control --
4505 ---------------------------------
4507 -- There are four types of alignment possible for array and record
4508 -- types, and a field in the type entities contains a value of the
4509 -- following type indicating which alignment choice applies. For full
4510 -- details of the meaning of these aligment types, see description
4511 -- of the Component_Alignment pragma
4513 type Component_Alignment_Kind is (
4514 Calign_Default, -- default alignment
4515 Calign_Component_Size, -- natural alignment for component size
4516 Calign_Component_Size_4, -- natural for size <= 4, 4 for size >= 4
4517 Calign_Storage_Unit); -- all components byte aligned
4523 -- In addition to attributes that are stored as plain data, other
4524 -- attributes are procedural, and require some small amount of
4525 -- computation. Of course, from the point of view of a user of this
4526 -- package, the distinction is not visible (even the field information
4527 -- provided below should be disregarded, as it is subject to change
4528 -- without notice!). A number of attributes appear as lists: lists of
4529 -- formals, lists of actuals, of discriminants, etc. For these, pairs
4530 -- of functions are defined, which take the form:
4532 -- function First_Thing (E : Enclosing_Construct) return Thing;
4533 -- function Next_Thing (T : Thing) return Thing;
4535 -- The end of iteration is always signaled by a value of Empty, so that
4536 -- loops over these chains invariably have the form:
4540 -- This := First_Thing (E);
4542 -- while Present (This) loop
4543 -- Do_Something_With (This);
4545 -- This := Next_Thing (This);
4548 -----------------------------------
4549 -- Handling of Check Suppression --
4550 -----------------------------------
4552 -- There are three ways that checks can be suppressed:
4554 -- 1. At the command line level. Package Opt contains global Boolean
4555 -- flags with names Suppress_Options.xxx_Checks, where xxx is the
4556 -- name of one of the checks that can be suppressed (excluding
4557 -- All_Checks, which is simply reflected by setting all the
4558 -- individual flags)
4560 -- 2. At the scope level. The body of Sem contains flags with names
4561 -- Suppress.xxx_Checks which are set to indicate that the given
4562 -- check is suppressed for the current scope. These flags are
4563 -- saved in the scope stack on entry to a scope and restored on
4564 -- exit from the scope.
4566 -- 3. At the entity level. Each entity contains a set of flags named
4567 -- Suppress_xxx_Checks which suppress the given check for that
4568 -- particularly entity (of course not all flags are meaningful for
4571 -------------------------------
4572 -- Handling of Discriminants --
4573 -------------------------------
4575 -- During semantic processing, discriminants are separate entities which
4576 -- reflect the semantic properties and allowed usage of discriminants in
4579 -- In the case of discriminants used as bounds, the references are handled
4580 -- directly, since special processing is needed in any case. However, there
4581 -- are two circumstances in which discriminants are referenced in a quite
4582 -- general manner, like any other variables:
4584 -- In initialization expressions for records. Note that the expressions
4585 -- used in Priority, Storage_Size, and Task_Info pragmas are effectively
4586 -- in this category, since these pragmas are converted to initialized
4587 -- record fields in the Corresponding_Record_Type.
4589 -- In task and protected bodies, where the discriminant values may be
4590 -- referenced freely within these bodies. Discriminants can also appear
4591 -- in bounds of entry families and in defaults of operations.
4593 -- In both these cases, the discriminants must be treated essentially as
4594 -- objects. The following approach is used to simplify and minimize the
4595 -- special processing that is required.
4597 -- When a record type with discriminants is processed, the semantic
4598 -- processing creates the entities for the discriminants. It also creates
4599 -- an additional set of entities, called discriminals, one for each of
4600 -- the discriminants, and the Discriminal field of the discriminant entity
4601 -- points to this additional entity, which is initially created as an
4602 -- uninitialized (E_Void) entity.
4604 -- During expansion of expressions, any discriminant reference is replaced
4605 -- by a reference to the corresponding discriminal. When the initialization
4606 -- procedure for the record is created (there will always be one, since
4607 -- discriminants are present, see Exp_Ch3 for further details), the
4608 -- discriminals are used as the entities for the formal parameters of
4609 -- this initialization procedure. The references to these discriminants
4610 -- have already been replaced by references to these discriminals, which
4611 -- are now the formal parameters corresponding to the required objects.
4613 -- In the case of a task or protected body, the semantics similarly
4614 -- creates a set of discriminals for the discriminants of the task or
4615 -- protected type. When the procedure is created for the task body,
4616 -- the parameter passed in is a reference to the task value type, which
4617 -- contains the required discriminant values. The expander creates a
4618 -- set of declarations of the form:
4620 -- discriminal : constant dtype renames _Task.discriminant;
4622 -- where discriminal is the discriminal entity referenced by the task
4623 -- discriminant, and _Task is the task value passed in as the parameter.
4624 -- Again, any references to discriminants in the task body have been
4625 -- replaced by the discriminal reference, which is now an object that
4626 -- contains the required value.
4628 -- This approach for tasks means that two sets of discriminals are needed
4629 -- for a task type, one for the initialization procedure, and one for the
4630 -- task body. This works out nicely, since the semantics allocates one set
4631 -- for the task itself, and one set for the corresponding record.
4633 -- The one bit of trickiness arises in making sure that the right set of
4634 -- discriminals is used at the right time. First the task definition is
4635 -- processed. Any references to discriminants here are replaced by the
4636 -- the corresponding *task* discriminals (the record type doesn't even
4637 -- exist yet, since it is constructed as part of the expansion of the
4638 -- task declaration, which happens after the semantic processing of the
4639 -- task definition). The discriminants to be used for the corresponding
4640 -- record are created at the same time as the other discriminals, and
4641 -- held in the CR_Discriminant field of the discriminant. A use of the
4642 -- discriminant in a bound for an entry family is replaced with the CR_
4643 -- discriminant because it controls the bound of the entry queue array
4644 -- which is a component of the corresponding record.
4646 -- Just before the record initialization routine is constructed, the
4647 -- expander exchanges the task and record discriminals. This has two
4648 -- effects. First the generation of the record initialization routine
4649 -- uses the discriminals that are now on the record, which is the set
4650 -- that used to be on the task, which is what we want.
4652 -- Second, a new set of (so far unused) discriminals is now on the task
4653 -- discriminants, and it is this set that will be used for expanding the
4654 -- task body, and also for the discriminal declarations at the start of
4657 ---------------------------------------
4658 -- Private data in protected objects --
4659 ---------------------------------------
4661 -- Private object declarations in protected types pose problems
4662 -- similar to those of discriminants. They are expanded to components
4663 -- of a record which is passed as the parameter "_object" to expanded
4664 -- forms of all protected operations. As with discriminants, timing
4665 -- of this expansion is a problem. The sequence of statements for a
4666 -- protected operation is expanded before the operation itself, so the
4667 -- formal parameter for the record object containing the private data
4668 -- does not exist when the references to that data are expanded.
4670 -- For this reason, private data is handled in the same way as
4671 -- discriminants, expanding references to private data in protected
4672 -- operations (which appear as components) to placeholders which will
4673 -- eventually become renamings of the private selected components
4674 -- of the "_object" formal parameter. These placeholders are called
4675 -- "privals", by analogy to the "discriminals" used to implement
4676 -- discriminants. They are attached to the component declaration nodes
4677 -- representing the private object declarations of the protected type.
4679 -- As with discriminals, each protected subprogram needs a unique set
4680 -- of privals, since they must refer to renamings of components of a
4681 -- formal parameter of that operation. Entry bodies need another set,
4682 -- which they all share and which is associated with renamings in the
4683 -- Service_Entries procedure for the protected type (this is not yet
4684 -- implemented???). This means that we must associate a new set of
4685 -- privals (and discriminals) with the private declarations after
4686 -- the body of a protected subprogram is processed.
4688 -- The last complication is the presence of discriminants and discriminated
4689 -- components. In the corresponding record, the components are constrained
4690 -- by the discriminants of the record, but within each protected operation
4691 -- they are constrained by the discriminants of the actual. The actual
4692 -- subtypes of those components are constructed as for other unconstrained
4693 -- formals, but the privals are created before the formal object is added
4694 -- to the parameter list of the protected operation, so they carry the
4695 -- nominal subtype of the original component. After the protected operation
4696 -- is actually created (in the expansion of the protected body) we must
4697 -- patch the types of each prival occurrence with the proper actual subtype
4698 -- which is by now set. The Privals_Chain is used for this patching.
4704 -- The following type synonyms are used to tidy up the function and
4705 -- procedure declarations that follow, and also to make it possible
4706 -- to meet the requirement for the XEINFO utility that all function
4707 -- specs must fit on a single source line.
4709 subtype B is Boolean;
4710 subtype C is Component_Alignment_Kind;
4711 subtype E is Entity_Id;
4712 subtype M is Mechanism_Type;
4713 subtype N is Node_Id;
4716 subtype L is Elist_Id;
4717 subtype S is List_Id;
4719 ---------------------------------
4720 -- Attribute Access Functions --
4721 ---------------------------------
4723 -- All attributes are manipulated through a procedural interface. This
4724 -- section contains the functions used to obtain attribute values which
4725 -- correspond to values in fields or flags in the entity itself.
4727 function Accept_Address (Id : E) return L;
4728 function Access_Disp_Table (Id : E) return E;
4729 function Actual_Subtype (Id : E) return E;
4730 function Address_Taken (Id : E) return B;
4731 function Alias (Id : E) return E;
4732 function Alignment (Id : E) return U;
4733 function Associated_Final_Chain (Id : E) return E;
4734 function Associated_Formal_Package (Id : E) return E;
4735 function Associated_Node_For_Itype (Id : E) return N;
4736 function Associated_Storage_Pool (Id : E) return E;
4737 function Barrier_Function (Id : E) return N;
4738 function Block_Node (Id : E) return N;
4739 function Body_Entity (Id : E) return E;
4740 function CR_Discriminant (Id : E) return E;
4741 function C_Pass_By_Copy (Id : E) return B;
4742 function Class_Wide_Type (Id : E) return E;
4743 function Cloned_Subtype (Id : E) return E;
4744 function Component_Alignment (Id : E) return C;
4745 function Component_Clause (Id : E) return N;
4746 function Component_Bit_Offset (Id : E) return U;
4747 function Component_Size (Id : E) return U;
4748 function Component_Type (Id : E) return E;
4749 function Corresponding_Concurrent_Type (Id : E) return E;
4750 function Corresponding_Discriminant (Id : E) return E;
4751 function Corresponding_Equality (Id : E) return E;
4752 function Corresponding_Record_Type (Id : E) return E;
4753 function Corresponding_Remote_Type (Id : E) return E;
4754 function Debug_Info_Off (Id : E) return B;
4755 function Debug_Renaming_Link (Id : E) return E;
4756 function DTC_Entity (Id : E) return E;
4757 function DT_Entry_Count (Id : E) return U;
4758 function DT_Position (Id : E) return U;
4759 function Default_Expr_Function (Id : E) return E;
4760 function Default_Expressions_Processed (Id : E) return B;
4761 function Default_Value (Id : E) return N;
4762 function Delay_Cleanups (Id : E) return B;
4763 function Delay_Subprogram_Descriptors (Id : E) return B;
4764 function Delta_Value (Id : E) return R;
4765 function Dependent_Instances (Id : E) return L;
4766 function Depends_On_Private (Id : E) return B;
4767 function Digits_Value (Id : E) return U;
4768 function Directly_Designated_Type (Id : E) return E;
4769 function Discard_Names (Id : E) return B;
4770 function Discriminal (Id : E) return E;
4771 function Discriminal_Link (Id : E) return E;
4772 function Discriminant_Checking_Func (Id : E) return E;
4773 function Discriminant_Constraint (Id : E) return L;
4774 function Discriminant_Default_Value (Id : E) return N;
4775 function Discriminant_Number (Id : E) return U;
4776 function Elaborate_All_Desirable (Id : E) return B;
4777 function Elaboration_Entity (Id : E) return E;
4778 function Elaboration_Entity_Required (Id : E) return B;
4779 function Enclosing_Scope (Id : E) return E;
4780 function Entry_Accepted (Id : E) return B;
4781 function Entry_Bodies_Array (Id : E) return E;
4782 function Entry_Cancel_Parameter (Id : E) return E;
4783 function Entry_Component (Id : E) return E;
4784 function Entry_Formal (Id : E) return E;
4785 function Entry_Index_Constant (Id : E) return E;
4786 function Entry_Index_Type (Id : E) return E;
4787 function Entry_Parameters_Type (Id : E) return E;
4788 function Enum_Pos_To_Rep (Id : E) return E;
4789 function Enumeration_Pos (Id : E) return U;
4790 function Enumeration_Rep (Id : E) return U;
4791 function Enumeration_Rep_Expr (Id : E) return N;
4792 function Equivalent_Type (Id : E) return E;
4793 function Esize (Id : E) return U;
4794 function Exception_Code (Id : E) return U;
4795 function Extra_Accessibility (Id : E) return E;
4796 function Extra_Constrained (Id : E) return E;
4797 function Extra_Formal (Id : E) return E;
4798 function Finalization_Chain_Entity (Id : E) return E;
4799 function Finalize_Storage_Only (Id : E) return B;
4800 function First_Entity (Id : E) return E;
4801 function First_Index (Id : E) return N;
4802 function First_Literal (Id : E) return E;
4803 function First_Optional_Parameter (Id : E) return E;
4804 function First_Private_Entity (Id : E) return E;
4805 function First_Rep_Item (Id : E) return N;
4806 function Freeze_Node (Id : E) return N;
4807 function From_With_Type (Id : E) return B;
4808 function Full_View (Id : E) return E;
4809 function Function_Returns_With_DSP (Id : E) return B;
4810 function Generic_Renamings (Id : E) return L;
4811 function Girder_Constraint (Id : E) return L;
4812 function Handler_Records (Id : E) return S;
4813 function Has_Aliased_Components (Id : E) return B;
4814 function Has_Alignment_Clause (Id : E) return B;
4815 function Has_All_Calls_Remote (Id : E) return B;
4816 function Has_Atomic_Components (Id : E) return B;
4817 function Has_Biased_Representation (Id : E) return B;
4818 function Has_Completion (Id : E) return B;
4819 function Has_Completion_In_Body (Id : E) return B;
4820 function Has_Complex_Representation (Id : E) return B;
4821 function Has_Component_Size_Clause (Id : E) return B;
4822 function Has_Controlled_Component (Id : E) return B;
4823 function Has_Controlling_Result (Id : E) return B;
4824 function Has_Convention_Pragma (Id : E) return B;
4825 function Has_Delayed_Freeze (Id : E) return B;
4826 function Has_Discriminants (Id : E) return B;
4827 function Has_Enumeration_Rep_Clause (Id : E) return B;
4828 function Has_Exit (Id : E) return B;
4829 function Has_External_Tag_Rep_Clause (Id : E) return B;
4830 function Has_Fully_Qualified_Name (Id : E) return B;
4831 function Has_Gigi_Rep_Item (Id : E) return B;
4832 function Has_Homonym (Id : E) return B;
4833 function Has_Interrupt_Handler (Id : E) return B;
4834 function Has_Machine_Radix_Clause (Id : E) return B;
4835 function Has_Master_Entity (Id : E) return B;
4836 function Has_Missing_Return (Id : E) return B;
4837 function Has_Nested_Block_With_Handler (Id : E) return B;
4838 function Has_Forward_Instantiation (Id : E) return B;
4839 function Has_Non_Standard_Rep (Id : E) return B;
4840 function Has_Object_Size_Clause (Id : E) return B;
4841 function Has_Per_Object_Constraint (Id : E) return B;
4842 function Has_Pragma_Controlled (Id : E) return B;
4843 function Has_Pragma_Elaborate_Body (Id : E) return B;
4844 function Has_Pragma_Inline (Id : E) return B;
4845 function Has_Pragma_Pack (Id : E) return B;
4846 function Has_Pragma_Pure_Function (Id : E) return B;
4847 function Has_Primitive_Operations (Id : E) return B;
4848 function Has_Qualified_Name (Id : E) return B;
4849 function Has_Record_Rep_Clause (Id : E) return B;
4850 function Has_Recursive_Call (Id : E) return B;
4851 function Has_Size_Clause (Id : E) return B;
4852 function Has_Small_Clause (Id : E) return B;
4853 function Has_Specified_Layout (Id : E) return B;
4854 function Has_Storage_Size_Clause (Id : E) return B;
4855 function Has_Subprogram_Descriptor (Id : E) return B;
4856 function Has_Task (Id : E) return B;
4857 function Has_Unchecked_Union (Id : E) return B;
4858 function Has_Unknown_Discriminants (Id : E) return B;
4859 function Has_Volatile_Components (Id : E) return B;
4860 function Homonym (Id : E) return E;
4861 function Hiding_Loop_Variable (Id : E) return E;
4862 function In_Package_Body (Id : E) return B;
4863 function In_Private_Part (Id : E) return B;
4864 function In_Use (Id : E) return B;
4865 function Inner_Instances (Id : E) return L;
4866 function Interface_Name (Id : E) return N;
4867 function Is_AST_Entry (Id : E) return B;
4868 function Is_Abstract (Id : E) return B;
4869 function Is_Access_Constant (Id : E) return B;
4870 function Is_Aliased (Id : E) return B;
4871 function Is_Asynchronous (Id : E) return B;
4872 function Is_Atomic (Id : E) return B;
4873 function Is_Bit_Packed_Array (Id : E) return B;
4874 function Is_CPP_Class (Id : E) return B;
4875 function Is_Called (Id : E) return B;
4876 function Is_Character_Type (Id : E) return B;
4877 function Is_Child_Unit (Id : E) return B;
4878 function Is_Compilation_Unit (Id : E) return B;
4879 function Is_Completely_Hidden (Id : E) return B;
4880 function Is_Constr_Subt_For_UN_Aliased (Id : E) return B;
4881 function Is_Constr_Subt_For_U_Nominal (Id : E) return B;
4882 function Is_Constrained (Id : E) return B;
4883 function Is_Constructor (Id : E) return B;
4884 function Is_Controlled (Id : E) return B;
4885 function Is_Controlling_Formal (Id : E) return B;
4886 function Is_Destructor (Id : E) return B;
4887 function Is_Discrim_SO_Function (Id : E) return B;
4888 function Is_Dispatching_Operation (Id : E) return B;
4889 function Is_Eliminated (Id : E) return B;
4890 function Is_Entry_Formal (Id : E) return B;
4891 function Is_Exported (Id : E) return B;
4892 function Is_First_Subtype (Id : E) return B;
4893 function Is_For_Access_Subtype (Id : E) return B;
4894 function Is_Frozen (Id : E) return B;
4895 function Is_Generic_Instance (Id : E) return B;
4896 function Is_Hidden (Id : E) return B;
4897 function Is_Hidden_Open_Scope (Id : E) return B;
4898 function Is_Immediately_Visible (Id : E) return B;
4899 function Is_Imported (Id : E) return B;
4900 function Is_Inlined (Id : E) return B;
4901 function Is_Instantiated (Id : E) return B;
4902 function Is_Internal (Id : E) return B;
4903 function Is_Interrupt_Handler (Id : E) return B;
4904 function Is_Intrinsic_Subprogram (Id : E) return B;
4905 function Is_Itype (Id : E) return B;
4906 function Is_Known_Valid (Id : E) return B;
4907 function Is_Limited_Composite (Id : E) return B;
4908 function Is_Machine_Code_Subprogram (Id : E) return B;
4909 function Is_Non_Static_Subtype (Id : E) return B;
4910 function Is_Null_Init_Proc (Id : E) return B;
4911 function Is_Optional_Parameter (Id : E) return B;
4912 function Is_Package_Body_Entity (Id : E) return B;
4913 function Is_Packed (Id : E) return B;
4914 function Is_Packed_Array_Type (Id : E) return B;
4915 function Is_Potentially_Use_Visible (Id : E) return B;
4916 function Is_Preelaborated (Id : E) return B;
4917 function Is_Private_Composite (Id : E) return B;
4918 function Is_Private_Descendant (Id : E) return B;
4919 function Is_Psected (Id : E) return B;
4920 function Is_Public (Id : E) return B;
4921 function Is_Pure (Id : E) return B;
4922 function Is_Remote_Call_Interface (Id : E) return B;
4923 function Is_Remote_Types (Id : E) return B;
4924 function Is_Renaming_Of_Object (Id : E) return B;
4925 function Is_Shared_Passive (Id : E) return B;
4926 function Is_Statically_Allocated (Id : E) return B;
4927 function Is_Tag (Id : E) return B;
4928 function Is_Tagged_Type (Id : E) return B;
4929 function Is_True_Constant (Id : E) return B;
4930 function Is_Unchecked_Union (Id : E) return B;
4931 function Is_Unsigned_Type (Id : E) return B;
4932 function Is_VMS_Exception (Id : E) return B;
4933 function Is_Valued_Procedure (Id : E) return B;
4934 function Is_Visible_Child_Unit (Id : E) return B;
4935 function Is_Volatile (Id : E) return B;
4936 function Is_Wrapper_Package (Id : E) return B;
4937 function Last_Entity (Id : E) return E;
4938 function Lit_Indexes (Id : E) return E;
4939 function Lit_Strings (Id : E) return E;
4940 function Machine_Radix_10 (Id : E) return B;
4941 function Master_Id (Id : E) return E;
4942 function Materialize_Entity (Id : E) return B;
4943 function Mechanism (Id : E) return M;
4944 function Modulus (Id : E) return U;
4945 function Needs_Debug_Info (Id : E) return B;
4946 function Needs_No_Actuals (Id : E) return B;
4947 function Next_Inlined_Subprogram (Id : E) return E;
4948 function No_Pool_Assigned (Id : E) return B;
4949 function No_Return (Id : E) return B;
4950 function Non_Binary_Modulus (Id : E) return B;
4951 function Nonzero_Is_True (Id : E) return B;
4952 function Normalized_First_Bit (Id : E) return U;
4953 function Normalized_Position (Id : E) return U;
4954 function Normalized_Position_Max (Id : E) return U;
4955 function Not_Source_Assigned (Id : E) return B;
4956 function Object_Ref (Id : E) return E;
4957 function Original_Record_Component (Id : E) return E;
4958 function Packed_Array_Type (Id : E) return E;
4959 function Parent_Subtype (Id : E) return E;
4960 function Primitive_Operations (Id : E) return L;
4961 function Prival (Id : E) return E;
4962 function Privals_Chain (Id : E) return L;
4963 function Private_Dependents (Id : E) return L;
4964 function Private_View (Id : E) return N;
4965 function Protected_Body_Subprogram (Id : E) return E;
4966 function Protected_Formal (Id : E) return E;
4967 function Protected_Operation (Id : E) return E;
4968 function RM_Size (Id : E) return U;
4969 function Reachable (Id : E) return B;
4970 function Referenced (Id : E) return B;
4971 function Referenced_Object (Id : E) return N;
4972 function Register_Exception_Call (Id : E) return N;
4973 function Related_Array_Object (Id : E) return E;
4974 function Related_Instance (Id : E) return E;
4975 function Renamed_Entity (Id : E) return N;
4976 function Renamed_Object (Id : E) return N;
4977 function Renaming_Map (Id : E) return U;
4978 function Return_Present (Id : E) return B;
4979 function Returns_By_Ref (Id : E) return B;
4980 function Reverse_Bit_Order (Id : E) return B;
4981 function Scalar_Range (Id : E) return N;
4982 function Scale_Value (Id : E) return U;
4983 function Scope_Depth_Value (Id : E) return U;
4984 function Sec_Stack_Needed_For_Return (Id : E) return B;
4985 function Shadow_Entities (Id : E) return S;
4986 function Shared_Var_Assign_Proc (Id : E) return E;
4987 function Shared_Var_Read_Proc (Id : E) return E;
4988 function Size_Check_Code (Id : E) return N;
4989 function Size_Known_At_Compile_Time (Id : E) return B;
4990 function Size_Depends_On_Discriminant (Id : E) return B;
4991 function Small_Value (Id : E) return R;
4992 function Spec_Entity (Id : E) return E;
4993 function Storage_Size_Variable (Id : E) return E;
4994 function Strict_Alignment (Id : E) return B;
4995 function String_Literal_Length (Id : E) return U;
4996 function String_Literal_Low_Bound (Id : E) return N;
4997 function Suppress_Access_Checks (Id : E) return B;
4998 function Suppress_Accessibility_Checks (Id : E) return B;
4999 function Suppress_Discriminant_Checks (Id : E) return B;
5000 function Suppress_Division_Checks (Id : E) return B;
5001 function Suppress_Elaboration_Checks (Id : E) return B;
5002 function Suppress_Elaboration_Warnings (Id : E) return B;
5003 function Suppress_Index_Checks (Id : E) return B;
5004 function Suppress_Init_Proc (Id : E) return B;
5005 function Suppress_Length_Checks (Id : E) return B;
5006 function Suppress_Overflow_Checks (Id : E) return B;
5007 function Suppress_Range_Checks (Id : E) return B;
5008 function Suppress_Storage_Checks (Id : E) return B;
5009 function Suppress_Style_Checks (Id : E) return B;
5010 function Suppress_Tag_Checks (Id : E) return B;
5011 function Underlying_Full_View (Id : E) return E;
5012 function Unset_Reference (Id : E) return N;
5013 function Uses_Sec_Stack (Id : E) return B;
5014 function Vax_Float (Id : E) return B;
5015 function Warnings_Off (Id : E) return B;
5017 -------------------------------
5018 -- Classification Attributes --
5019 -------------------------------
5021 -- These functions provide a convenient functional notation for testing
5022 -- whether an Ekind value belongs to a specified kind, for example the
5023 -- function Is_Elementary_Type tests if its argument is in Elementary_Kind.
5024 -- In some cases, the test is of an entity attribute (e.g. in the case of
5025 -- Is_Generic_Type where the Ekind does not provide the needed information)
5027 function Is_Access_Type (Id : E) return B;
5028 function Is_Array_Type (Id : E) return B;
5029 function Is_Class_Wide_Type (Id : E) return B;
5030 function Is_Composite_Type (Id : E) return B;
5031 function Is_Concurrent_Body (Id : E) return B;
5032 function Is_Concurrent_Record_Type (Id : E) return B;
5033 function Is_Concurrent_Type (Id : E) return B;
5034 function Is_Decimal_Fixed_Point_Type (Id : E) return B;
5035 function Is_Digits_Type (Id : E) return B;
5036 function Is_Discrete_Or_Fixed_Point_Type (Id : E) return B;
5037 function Is_Discrete_Type (Id : E) return B;
5038 function Is_Elementary_Type (Id : E) return B;
5039 function Is_Entry (Id : E) return B;
5040 function Is_Enumeration_Type (Id : E) return B;
5041 function Is_Fixed_Point_Type (Id : E) return B;
5042 function Is_Floating_Point_Type (Id : E) return B;
5043 function Is_Formal (Id : E) return B;
5044 function Is_Formal_Subprogram (Id : E) return B;
5045 function Is_Generic_Actual_Type (Id : E) return B;
5046 function Is_Generic_Type (Id : E) return B;
5047 function Is_Generic_Unit (Id : E) return B;
5048 function Is_Incomplete_Or_Private_Type (Id : E) return B;
5049 function Is_Integer_Type (Id : E) return B;
5050 function Is_Limited_Record (Id : E) return B;
5051 function Is_Modular_Integer_Type (Id : E) return B;
5052 function Is_Named_Number (Id : E) return B;
5053 function Is_Numeric_Type (Id : E) return B;
5054 function Is_Object (Id : E) return B;
5055 function Is_Ordinary_Fixed_Point_Type (Id : E) return B;
5056 function Is_Overloadable (Id : E) return B;
5057 function Is_Private_Type (Id : E) return B;
5058 function Is_Protected_Type (Id : E) return B;
5059 function Is_Real_Type (Id : E) return B;
5060 function Is_Record_Type (Id : E) return B;
5061 function Is_Scalar_Type (Id : E) return B;
5062 function Is_Signed_Integer_Type (Id : E) return B;
5063 function Is_Subprogram (Id : E) return B;
5064 function Is_Task_Type (Id : E) return B;
5065 function Is_Type (Id : E) return B;
5067 -------------------------------------
5068 -- Synthesized Attribute Functions --
5069 -------------------------------------
5071 -- The functions in this section synthesize attributes from the tree,
5072 -- so they do not correspond to defined fields in the entity itself.
5074 function Address_Clause (Id : E) return N;
5075 function Alignment_Clause (Id : E) return N;
5076 function Ancestor_Subtype (Id : E) return E;
5077 function Base_Type (Id : E) return E;
5078 function Constant_Value (Id : E) return N;
5079 function Declaration_Node (Id : E) return N;
5080 function Designated_Type (Id : E) return E;
5081 function Enclosing_Dynamic_Scope (Id : E) return E;
5082 function First_Component (Id : E) return E;
5083 function First_Discriminant (Id : E) return E;
5084 function First_Formal (Id : E) return E;
5085 function First_Girder_Discriminant (Id : E) return E;
5086 function First_Subtype (Id : E) return E;
5087 function Has_Attach_Handler (Id : E) return B;
5088 function Has_Entries (Id : E) return B;
5089 function Has_Foreign_Convention (Id : E) return B;
5090 function Has_Private_Ancestor (Id : E) return B;
5091 function Has_Private_Declaration (Id : E) return B;
5092 function Implementation_Base_Type (Id : E) return E;
5093 function Is_Always_Inlined (Id : E) return B;
5094 function Is_Boolean_Type (Id : E) return B;
5095 function Is_By_Copy_Type (Id : E) return B;
5096 function Is_By_Reference_Type (Id : E) return B;
5097 function Is_Derived_Type (Id : E) return B;
5098 function Is_Dynamic_Scope (Id : E) return B;
5099 function Is_Indefinite_Subtype (Id : E) return B;
5100 function Is_Limited_Type (Id : E) return B;
5101 function Is_Package (Id : E) return B;
5102 function Is_Protected_Private (Id : E) return B;
5103 function Is_Protected_Record_Type (Id : E) return B;
5104 function Is_Return_By_Reference_Type (Id : E) return B;
5105 function Is_String_Type (Id : E) return B;
5106 function Is_Task_Record_Type (Id : E) return B;
5107 function Next_Component (Id : E) return E;
5108 function Next_Discriminant (Id : E) return E;
5109 function Next_Formal (Id : E) return E;
5110 function Next_Formal_With_Extras (Id : E) return E;
5111 function Next_Girder_Discriminant (Id : E) return E;
5112 function Next_Literal (Id : E) return E;
5113 function Number_Dimensions (Id : E) return Pos;
5114 function Number_Discriminants (Id : E) return Pos;
5115 function Number_Entries (Id : E) return Nat;
5116 function Number_Formals (Id : E) return Pos;
5117 function Parameter_Mode (Id : E) return Formal_Kind;
5118 function Root_Type (Id : E) return E;
5119 function Scope_Depth_Set (Id : E) return B;
5120 function Size_Clause (Id : E) return N;
5121 function Tag_Component (Id : E) return E;
5122 function Type_High_Bound (Id : E) return N;
5123 function Type_Low_Bound (Id : E) return N;
5124 function Underlying_Type (Id : E) return E;
5126 ----------------------------------------------
5127 -- Type Representation Attribute Predicates --
5128 ----------------------------------------------
5130 -- These predicates test the setting of the indicated attribute. If
5131 -- the value has been set, then Known is True, and Unknown is False.
5132 -- If no value is set, then Known is False and Unknown is True. The
5133 -- Known_Static predicate is true only if the value is set (Known)
5134 -- and is set to a compile time known value. Note that in the case
5135 -- of Alignment and Normalized_First_Bit, dynamic values are not
5136 -- possible, so we do not need a separate Known_Static calls in
5137 -- these cases. The not set (unknown values are as follows:
5140 -- Component_Size Uint_0
5141 -- Component_Bit_Offset No_Uint
5142 -- Digits_Value Uint_0
5144 -- Normalized_First_Bit No_Uint
5145 -- Normalized_Position No_Uint
5146 -- Normalized_Position_Max No_Uint
5149 -- It would be cleaner to use No_Uint in all these cases, but historically
5150 -- we chose to use Uint_0 at first, and the change over will take time ???
5151 -- This is particularly true for the RM_Size field, where a value of zero
5152 -- is legitimate. We deal with this by a nasty kludge that knows that the
5153 -- value is always known static for discrete types (and no other types can
5154 -- have an RM_Size value of zero).
5156 function Known_Alignment (E : Entity_Id) return B;
5157 function Known_Component_Bit_Offset (E : Entity_Id) return B;
5158 function Known_Component_Size (E : Entity_Id) return B;
5159 function Known_Esize (E : Entity_Id) return B;
5160 function Known_Normalized_First_Bit (E : Entity_Id) return B;
5161 function Known_Normalized_Position (E : Entity_Id) return B;
5162 function Known_Normalized_Position_Max (E : Entity_Id) return B;
5163 function Known_RM_Size (E : Entity_Id) return B;
5165 function Known_Static_Component_Bit_Offset (E : Entity_Id) return B;
5166 function Known_Static_Component_Size (E : Entity_Id) return B;
5167 function Known_Static_Esize (E : Entity_Id) return B;
5168 function Known_Static_Normalized_Position (E : Entity_Id) return B;
5169 function Known_Static_Normalized_Position_Max (E : Entity_Id) return B;
5170 function Known_Static_RM_Size (E : Entity_Id) return B;
5172 function Unknown_Alignment (E : Entity_Id) return B;
5173 function Unknown_Component_Bit_Offset (E : Entity_Id) return B;
5174 function Unknown_Component_Size (E : Entity_Id) return B;
5175 function Unknown_Esize (E : Entity_Id) return B;
5176 function Unknown_Normalized_First_Bit (E : Entity_Id) return B;
5177 function Unknown_Normalized_Position (E : Entity_Id) return B;
5178 function Unknown_Normalized_Position_Max (E : Entity_Id) return B;
5179 function Unknown_RM_Size (E : Entity_Id) return B;
5181 ------------------------------
5182 -- Attribute Set Procedures --
5183 ------------------------------
5185 procedure Set_Accept_Address (Id : E; V : L);
5186 procedure Set_Access_Disp_Table (Id : E; V : E);
5187 procedure Set_Actual_Subtype (Id : E; V : E);
5188 procedure Set_Address_Taken (Id : E; V : B := True);
5189 procedure Set_Alias (Id : E; V : E);
5190 procedure Set_Alignment (Id : E; V : U);
5191 procedure Set_Associated_Final_Chain (Id : E; V : E);
5192 procedure Set_Associated_Formal_Package (Id : E; V : E);
5193 procedure Set_Associated_Node_For_Itype (Id : E; V : N);
5194 procedure Set_Associated_Storage_Pool (Id : E; V : E);
5195 procedure Set_Barrier_Function (Id : E; V : N);
5196 procedure Set_Block_Node (Id : E; V : N);
5197 procedure Set_Body_Entity (Id : E; V : E);
5198 procedure Set_CR_Discriminant (Id : E; V : E);
5199 procedure Set_C_Pass_By_Copy (Id : E; V : B := True);
5200 procedure Set_Class_Wide_Type (Id : E; V : E);
5201 procedure Set_Cloned_Subtype (Id : E; V : E);
5202 procedure Set_Component_Alignment (Id : E; V : C);
5203 procedure Set_Component_Bit_Offset (Id : E; V : U);
5204 procedure Set_Component_Clause (Id : E; V : N);
5205 procedure Set_Component_Size (Id : E; V : U);
5206 procedure Set_Component_Type (Id : E; V : E);
5207 procedure Set_Corresponding_Concurrent_Type (Id : E; V : E);
5208 procedure Set_Corresponding_Discriminant (Id : E; V : E);
5209 procedure Set_Corresponding_Equality (Id : E; V : E);
5210 procedure Set_Corresponding_Record_Type (Id : E; V : E);
5211 procedure Set_Corresponding_Remote_Type (Id : E; V : E);
5212 procedure Set_Debug_Info_Off (Id : E; V : B := True);
5213 procedure Set_Debug_Renaming_Link (Id : E; V : E);
5214 procedure Set_DTC_Entity (Id : E; V : E);
5215 procedure Set_DT_Entry_Count (Id : E; V : U);
5216 procedure Set_DT_Position (Id : E; V : U);
5217 procedure Set_Default_Expr_Function (Id : E; V : E);
5218 procedure Set_Default_Expressions_Processed (Id : E; V : B := True);
5219 procedure Set_Default_Value (Id : E; V : N);
5220 procedure Set_Delay_Cleanups (Id : E; V : B := True);
5221 procedure Set_Delay_Subprogram_Descriptors (Id : E; V : B := True);
5222 procedure Set_Delta_Value (Id : E; V : R);
5223 procedure Set_Dependent_Instances (Id : E; V : L);
5224 procedure Set_Depends_On_Private (Id : E; V : B := True);
5225 procedure Set_Digits_Value (Id : E; V : U);
5226 procedure Set_Directly_Designated_Type (Id : E; V : E);
5227 procedure Set_Discard_Names (Id : E; V : B := True);
5228 procedure Set_Discriminal (Id : E; V : E);
5229 procedure Set_Discriminal_Link (Id : E; V : E);
5230 procedure Set_Discriminant_Checking_Func (Id : E; V : E);
5231 procedure Set_Discriminant_Constraint (Id : E; V : L);
5232 procedure Set_Discriminant_Default_Value (Id : E; V : N);
5233 procedure Set_Discriminant_Number (Id : E; V : U);
5234 procedure Set_Elaborate_All_Desirable (Id : E; V : B := True);
5235 procedure Set_Elaboration_Entity (Id : E; V : E);
5236 procedure Set_Elaboration_Entity_Required (Id : E; V : B := True);
5237 procedure Set_Enclosing_Scope (Id : E; V : E);
5238 procedure Set_Entry_Accepted (Id : E; V : B := True);
5239 procedure Set_Entry_Bodies_Array (Id : E; V : E);
5240 procedure Set_Entry_Cancel_Parameter (Id : E; V : E);
5241 procedure Set_Entry_Component (Id : E; V : E);
5242 procedure Set_Entry_Formal (Id : E; V : E);
5243 procedure Set_Entry_Index_Constant (Id : E; V : E);
5244 procedure Set_Entry_Parameters_Type (Id : E; V : E);
5245 procedure Set_Enum_Pos_To_Rep (Id : E; V : E);
5246 procedure Set_Enumeration_Pos (Id : E; V : U);
5247 procedure Set_Enumeration_Rep (Id : E; V : U);
5248 procedure Set_Enumeration_Rep_Expr (Id : E; V : N);
5249 procedure Set_Equivalent_Type (Id : E; V : E);
5250 procedure Set_Esize (Id : E; V : U);
5251 procedure Set_Exception_Code (Id : E; V : U);
5252 procedure Set_Extra_Accessibility (Id : E; V : E);
5253 procedure Set_Extra_Constrained (Id : E; V : E);
5254 procedure Set_Extra_Formal (Id : E; V : E);
5255 procedure Set_Finalization_Chain_Entity (Id : E; V : E);
5256 procedure Set_Finalize_Storage_Only (Id : E; V : B := True);
5257 procedure Set_First_Entity (Id : E; V : E);
5258 procedure Set_First_Index (Id : E; V : N);
5259 procedure Set_First_Literal (Id : E; V : E);
5260 procedure Set_First_Optional_Parameter (Id : E; V : E);
5261 procedure Set_First_Private_Entity (Id : E; V : E);
5262 procedure Set_First_Rep_Item (Id : E; V : N);
5263 procedure Set_Freeze_Node (Id : E; V : N);
5264 procedure Set_From_With_Type (Id : E; V : B := True);
5265 procedure Set_Full_View (Id : E; V : E);
5266 procedure Set_Function_Returns_With_DSP (Id : E; V : B := True);
5267 procedure Set_Generic_Renamings (Id : E; V : L);
5268 procedure Set_Girder_Constraint (Id : E; V : L);
5269 procedure Set_Handler_Records (Id : E; V : S);
5270 procedure Set_Has_Aliased_Components (Id : E; V : B := True);
5271 procedure Set_Has_Alignment_Clause (Id : E; V : B := True);
5272 procedure Set_Has_All_Calls_Remote (Id : E; V : B := True);
5273 procedure Set_Has_Atomic_Components (Id : E; V : B := True);
5274 procedure Set_Has_Biased_Representation (Id : E; V : B := True);
5275 procedure Set_Has_Completion (Id : E; V : B := True);
5276 procedure Set_Has_Completion_In_Body (Id : E; V : B := True);
5277 procedure Set_Has_Complex_Representation (Id : E; V : B := True);
5278 procedure Set_Has_Component_Size_Clause (Id : E; V : B := True);
5279 procedure Set_Has_Controlled_Component (Id : E; V : B := True);
5280 procedure Set_Has_Controlling_Result (Id : E; V : B := True);
5281 procedure Set_Has_Convention_Pragma (Id : E; V : B := True);
5282 procedure Set_Has_Delayed_Freeze (Id : E; V : B := True);
5283 procedure Set_Has_Discriminants (Id : E; V : B := True);
5284 procedure Set_Has_Enumeration_Rep_Clause (Id : E; V : B := True);
5285 procedure Set_Has_Exit (Id : E; V : B := True);
5286 procedure Set_Has_External_Tag_Rep_Clause (Id : E; V : B := True);
5287 procedure Set_Has_Fully_Qualified_Name (Id : E; V : B := True);
5288 procedure Set_Has_Gigi_Rep_Item (Id : E; V : B := True);
5289 procedure Set_Has_Homonym (Id : E; V : B := True);
5290 procedure Set_Has_Machine_Radix_Clause (Id : E; V : B := True);
5291 procedure Set_Has_Master_Entity (Id : E; V : B := True);
5292 procedure Set_Has_Missing_Return (Id : E; V : B := True);
5293 procedure Set_Has_Nested_Block_With_Handler (Id : E; V : B := True);
5294 procedure Set_Has_Forward_Instantiation (Id : E; V : B := True);
5295 procedure Set_Has_Non_Standard_Rep (Id : E; V : B := True);
5296 procedure Set_Has_Object_Size_Clause (Id : E; V : B := True);
5297 procedure Set_Has_Per_Object_Constraint (Id : E; V : B := True);
5298 procedure Set_Has_Pragma_Controlled (Id : E; V : B := True);
5299 procedure Set_Has_Pragma_Elaborate_Body (Id : E; V : B := True);
5300 procedure Set_Has_Pragma_Inline (Id : E; V : B := True);
5301 procedure Set_Has_Pragma_Pack (Id : E; V : B := True);
5302 procedure Set_Has_Pragma_Pure_Function (Id : E; V : B := True);
5303 procedure Set_Has_Primitive_Operations (Id : E; V : B := True);
5304 procedure Set_Has_Private_Declaration (Id : E; V : B := True);
5305 procedure Set_Has_Qualified_Name (Id : E; V : B := True);
5306 procedure Set_Has_Record_Rep_Clause (Id : E; V : B := True);
5307 procedure Set_Has_Recursive_Call (Id : E; V : B := True);
5308 procedure Set_Has_Size_Clause (Id : E; V : B := True);
5309 procedure Set_Has_Small_Clause (Id : E; V : B := True);
5310 procedure Set_Has_Specified_Layout (Id : E; V : B := True);
5311 procedure Set_Has_Storage_Size_Clause (Id : E; V : B := True);
5312 procedure Set_Has_Subprogram_Descriptor (Id : E; V : B := True);
5313 procedure Set_Has_Task (Id : E; V : B := True);
5314 procedure Set_Has_Unchecked_Union (Id : E; V : B := True);
5315 procedure Set_Has_Unknown_Discriminants (Id : E; V : B := True);
5316 procedure Set_Has_Volatile_Components (Id : E; V : B := True);
5317 procedure Set_Hiding_Loop_Variable (Id : E; V : E);
5318 procedure Set_Homonym (Id : E; V : E);
5319 procedure Set_In_Package_Body (Id : E; V : B := True);
5320 procedure Set_In_Private_Part (Id : E; V : B := True);
5321 procedure Set_In_Use (Id : E; V : B := True);
5322 procedure Set_Inner_Instances (Id : E; V : L);
5323 procedure Set_Interface_Name (Id : E; V : N);
5324 procedure Set_Is_AST_Entry (Id : E; V : B := True);
5325 procedure Set_Is_Abstract (Id : E; V : B := True);
5326 procedure Set_Is_Access_Constant (Id : E; V : B := True);
5327 procedure Set_Is_Aliased (Id : E; V : B := True);
5328 procedure Set_Is_Asynchronous (Id : E; V : B := True);
5329 procedure Set_Is_Atomic (Id : E; V : B := True);
5330 procedure Set_Is_Bit_Packed_Array (Id : E; V : B := True);
5331 procedure Set_Is_CPP_Class (Id : E; V : B := True);
5332 procedure Set_Is_Called (Id : E; V : B := True);
5333 procedure Set_Is_Character_Type (Id : E; V : B := True);
5334 procedure Set_Is_Child_Unit (Id : E; V : B := True);
5335 procedure Set_Is_Compilation_Unit (Id : E; V : B := True);
5336 procedure Set_Is_Completely_Hidden (Id : E; V : B := True);
5337 procedure Set_Is_Concurrent_Record_Type (Id : E; V : B := True);
5338 procedure Set_Is_Constr_Subt_For_UN_Aliased (Id : E; V : B := True);
5339 procedure Set_Is_Constr_Subt_For_U_Nominal (Id : E; V : B := True);
5340 procedure Set_Is_Constrained (Id : E; V : B := True);
5341 procedure Set_Is_Constructor (Id : E; V : B := True);
5342 procedure Set_Is_Controlled (Id : E; V : B := True);
5343 procedure Set_Is_Controlling_Formal (Id : E; V : B := True);
5344 procedure Set_Is_Destructor (Id : E; V : B := True);
5345 procedure Set_Is_Discrim_SO_Function (Id : E; V : B := True);
5346 procedure Set_Is_Dispatching_Operation (Id : E; V : B := True);
5347 procedure Set_Is_Eliminated (Id : E; V : B := True);
5348 procedure Set_Is_Entry_Formal (Id : E; V : B := True);
5349 procedure Set_Is_Exported (Id : E; V : B := True);
5350 procedure Set_Is_First_Subtype (Id : E; V : B := True);
5351 procedure Set_Is_For_Access_Subtype (Id : E; V : B := True);
5352 procedure Set_Is_Formal_Subprogram (Id : E; V : B := True);
5353 procedure Set_Is_Frozen (Id : E; V : B := True);
5354 procedure Set_Is_Generic_Actual_Type (Id : E; V : B := True);
5355 procedure Set_Is_Generic_Instance (Id : E; V : B := True);
5356 procedure Set_Is_Generic_Type (Id : E; V : B := True);
5357 procedure Set_Is_Hidden (Id : E; V : B := True);
5358 procedure Set_Is_Hidden_Open_Scope (Id : E; V : B := True);
5359 procedure Set_Is_Immediately_Visible (Id : E; V : B := True);
5360 procedure Set_Is_Imported (Id : E; V : B := True);
5361 procedure Set_Is_Inlined (Id : E; V : B := True);
5362 procedure Set_Is_Instantiated (Id : E; V : B := True);
5363 procedure Set_Is_Internal (Id : E; V : B := True);
5364 procedure Set_Is_Interrupt_Handler (Id : E; V : B := True);
5365 procedure Set_Is_Intrinsic_Subprogram (Id : E; V : B := True);
5366 procedure Set_Is_Itype (Id : E; V : B := True);
5367 procedure Set_Is_Known_Valid (Id : E; V : B := True);
5368 procedure Set_Is_Limited_Composite (Id : E; V : B := True);
5369 procedure Set_Is_Limited_Record (Id : E; V : B := True);
5370 procedure Set_Is_Machine_Code_Subprogram (Id : E; V : B := True);
5371 procedure Set_Is_Non_Static_Subtype (Id : E; V : B := True);
5372 procedure Set_Is_Null_Init_Proc (Id : E; V : B := True);
5373 procedure Set_Is_Optional_Parameter (Id : E; V : B := True);
5374 procedure Set_Is_Package_Body_Entity (Id : E; V : B := True);
5375 procedure Set_Is_Packed (Id : E; V : B := True);
5376 procedure Set_Is_Packed_Array_Type (Id : E; V : B := True);
5377 procedure Set_Is_Potentially_Use_Visible (Id : E; V : B := True);
5378 procedure Set_Is_Preelaborated (Id : E; V : B := True);
5379 procedure Set_Is_Private_Composite (Id : E; V : B := True);
5380 procedure Set_Is_Private_Descendant (Id : E; V : B := True);
5381 procedure Set_Is_Psected (Id : E; V : B := True);
5382 procedure Set_Is_Public (Id : E; V : B := True);
5383 procedure Set_Is_Pure (Id : E; V : B := True);
5384 procedure Set_Is_Remote_Call_Interface (Id : E; V : B := True);
5385 procedure Set_Is_Remote_Types (Id : E; V : B := True);
5386 procedure Set_Is_Renaming_Of_Object (Id : E; V : B := True);
5387 procedure Set_Is_Shared_Passive (Id : E; V : B := True);
5388 procedure Set_Is_Statically_Allocated (Id : E; V : B := True);
5389 procedure Set_Is_Tag (Id : E; V : B := True);
5390 procedure Set_Is_Tagged_Type (Id : E; V : B := True);
5391 procedure Set_Is_True_Constant (Id : E; V : B := True);
5392 procedure Set_Is_Unchecked_Union (Id : E; V : B := True);
5393 procedure Set_Is_Unsigned_Type (Id : E; V : B := True);
5394 procedure Set_Is_VMS_Exception (Id : E; V : B := True);
5395 procedure Set_Is_Valued_Procedure (Id : E; V : B := True);
5396 procedure Set_Is_Visible_Child_Unit (Id : E; V : B := True);
5397 procedure Set_Is_Volatile (Id : E; V : B := True);
5398 procedure Set_Last_Entity (Id : E; V : E);
5399 procedure Set_Lit_Indexes (Id : E; V : E);
5400 procedure Set_Lit_Strings (Id : E; V : E);
5401 procedure Set_Machine_Radix_10 (Id : E; V : B := True);
5402 procedure Set_Master_Id (Id : E; V : E);
5403 procedure Set_Materialize_Entity (Id : E; V : B := True);
5404 procedure Set_Mechanism (Id : E; V : M);
5405 procedure Set_Modulus (Id : E; V : U);
5406 procedure Set_Needs_Debug_Info (Id : E; V : B := True);
5407 procedure Set_Needs_No_Actuals (Id : E; V : B := True);
5408 procedure Set_Next_Inlined_Subprogram (Id : E; V : E);
5409 procedure Set_No_Pool_Assigned (Id : E; V : B := True);
5410 procedure Set_No_Return (Id : E; V : B := True);
5411 procedure Set_Non_Binary_Modulus (Id : E; V : B := True);
5412 procedure Set_Nonzero_Is_True (Id : E; V : B := True);
5413 procedure Set_Normalized_First_Bit (Id : E; V : U);
5414 procedure Set_Normalized_Position (Id : E; V : U);
5415 procedure Set_Normalized_Position_Max (Id : E; V : U);
5416 procedure Set_Not_Source_Assigned (Id : E; V : B := True);
5417 procedure Set_Object_Ref (Id : E; V : E);
5418 procedure Set_Original_Record_Component (Id : E; V : E);
5419 procedure Set_Packed_Array_Type (Id : E; V : E);
5420 procedure Set_Parent_Subtype (Id : E; V : E);
5421 procedure Set_Primitive_Operations (Id : E; V : L);
5422 procedure Set_Prival (Id : E; V : E);
5423 procedure Set_Privals_Chain (Id : E; V : L);
5424 procedure Set_Private_Dependents (Id : E; V : L);
5425 procedure Set_Private_View (Id : E; V : N);
5426 procedure Set_Protected_Body_Subprogram (Id : E; V : E);
5427 procedure Set_Protected_Formal (Id : E; V : E);
5428 procedure Set_Protected_Operation (Id : E; V : N);
5429 procedure Set_RM_Size (Id : E; V : U);
5430 procedure Set_Reachable (Id : E; V : B := True);
5431 procedure Set_Referenced (Id : E; V : B := True);
5432 procedure Set_Referenced_Object (Id : E; V : N);
5433 procedure Set_Register_Exception_Call (Id : E; V : N);
5434 procedure Set_Related_Array_Object (Id : E; V : E);
5435 procedure Set_Related_Instance (Id : E; V : E);
5436 procedure Set_Renamed_Entity (Id : E; V : N);
5437 procedure Set_Renamed_Object (Id : E; V : N);
5438 procedure Set_Renaming_Map (Id : E; V : U);
5439 procedure Set_Return_Present (Id : E; V : B := True);
5440 procedure Set_Returns_By_Ref (Id : E; V : B := True);
5441 procedure Set_Reverse_Bit_Order (Id : E; V : B := True);
5442 procedure Set_Scalar_Range (Id : E; V : N);
5443 procedure Set_Scale_Value (Id : E; V : U);
5444 procedure Set_Scope_Depth_Value (Id : E; V : U);
5445 procedure Set_Sec_Stack_Needed_For_Return (Id : E; V : B := True);
5446 procedure Set_Shadow_Entities (Id : E; V : S);
5447 procedure Set_Shared_Var_Assign_Proc (Id : E; V : E);
5448 procedure Set_Shared_Var_Read_Proc (Id : E; V : E);
5449 procedure Set_Size_Check_Code (Id : E; V : N);
5450 procedure Set_Size_Depends_On_Discriminant (Id : E; V : B := True);
5451 procedure Set_Size_Known_At_Compile_Time (Id : E; V : B := True);
5452 procedure Set_Small_Value (Id : E; V : R);
5453 procedure Set_Spec_Entity (Id : E; V : E);
5454 procedure Set_Storage_Size_Variable (Id : E; V : E);
5455 procedure Set_Strict_Alignment (Id : E; V : B := True);
5456 procedure Set_String_Literal_Length (Id : E; V : U);
5457 procedure Set_String_Literal_Low_Bound (Id : E; V : N);
5458 procedure Set_Suppress_Access_Checks (Id : E; V : B := True);
5459 procedure Set_Suppress_Accessibility_Checks (Id : E; V : B := True);
5460 procedure Set_Suppress_Discriminant_Checks (Id : E; V : B := True);
5461 procedure Set_Suppress_Division_Checks (Id : E; V : B := True);
5462 procedure Set_Suppress_Elaboration_Checks (Id : E; V : B := True);
5463 procedure Set_Suppress_Elaboration_Warnings (Id : E; V : B := True);
5464 procedure Set_Suppress_Index_Checks (Id : E; V : B := True);
5465 procedure Set_Suppress_Init_Proc (Id : E; V : B := True);
5466 procedure Set_Suppress_Length_Checks (Id : E; V : B := True);
5467 procedure Set_Suppress_Overflow_Checks (Id : E; V : B := True);
5468 procedure Set_Suppress_Range_Checks (Id : E; V : B := True);
5469 procedure Set_Suppress_Storage_Checks (Id : E; V : B := True);
5470 procedure Set_Suppress_Style_Checks (Id : E; V : B := True);
5471 procedure Set_Suppress_Tag_Checks (Id : E; V : B := True);
5472 procedure Set_Underlying_Full_View (Id : E; V : E);
5473 procedure Set_Unset_Reference (Id : E; V : N);
5474 procedure Set_Uses_Sec_Stack (Id : E; V : B := True);
5475 procedure Set_Vax_Float (Id : E; V : B := True);
5476 procedure Set_Warnings_Off (Id : E; V : B := True);
5478 -----------------------------------
5479 -- Field Initialization Routines --
5480 -----------------------------------
5482 -- These routines are overloadings of some of the above Set procedures
5483 -- where the argument is normally a Uint. The overloadings take an Int
5484 -- parameter instead, and appropriately convert it. There are also
5485 -- versions that implicitly initialize to the appropriate "not set"
5486 -- value. The not set (unknown) values are as follows:
5489 -- Component_Size Uint_0
5490 -- Component_Bit_Offset No_Uint
5491 -- Digits_Value Uint_0
5493 -- Normalized_First_Bit No_Uint
5494 -- Normalized_Position No_Uint
5495 -- Normalized_Position_Max No_Uint
5498 -- It would be cleaner to use No_Uint in all these cases, but historically
5499 -- we chose to use Uint_0 at first, and the change over will take time ???
5500 -- This is particularly true for the RM_Size field, where a value of zero
5501 -- is legitimate and causes some kludges around the code.
5503 procedure Init_Alignment (Id : E; V : Int);
5504 procedure Init_Component_Size (Id : E; V : Int);
5505 procedure Init_Component_Bit_Offset (Id : E; V : Int);
5506 procedure Init_Digits_Value (Id : E; V : Int);
5507 procedure Init_Esize (Id : E; V : Int);
5508 procedure Init_Normalized_First_Bit (Id : E; V : Int);
5509 procedure Init_Normalized_Position (Id : E; V : Int);
5510 procedure Init_Normalized_Position_Max (Id : E; V : Int);
5511 procedure Init_RM_Size (Id : E; V : Int);
5513 procedure Init_Alignment (Id : E);
5514 procedure Init_Component_Size (Id : E);
5515 procedure Init_Component_Bit_Offset (Id : E);
5516 procedure Init_Digits_Value (Id : E);
5517 procedure Init_Esize (Id : E);
5518 procedure Init_Normalized_First_Bit (Id : E);
5519 procedure Init_Normalized_Position (Id : E);
5520 procedure Init_Normalized_Position_Max (Id : E);
5521 procedure Init_RM_Size (Id : E);
5523 procedure Init_Size_Align (Id : E);
5524 -- This procedure initializes both size fields and the alignment
5525 -- field to all be Unknown.
5527 procedure Init_Size (Id : E; V : Int);
5528 -- Initialize both the Esize and RM_Size fields of E to V
5530 procedure Init_Component_Location (Id : E);
5531 -- Initializes all fields describing the location of a component
5532 -- (Normalized_Position, Component_Bit_Offset, Normalized_First_Bit,
5533 -- Normalized_Position_Max, Esize) to all be Unknown.
5539 -- The call to Next_xxx (obj) is equivalent to obj := Next_xxx (obj)
5540 -- We define the set of Proc_Next_xxx routines simply for the purposes
5541 -- of inlining them without necessarily inlining the function.
5543 procedure Proc_Next_Component (N : in out Node_Id);
5544 procedure Proc_Next_Discriminant (N : in out Node_Id);
5545 procedure Proc_Next_Formal (N : in out Node_Id);
5546 procedure Proc_Next_Formal_With_Extras (N : in out Node_Id);
5547 procedure Proc_Next_Girder_Discriminant (N : in out Node_Id);
5548 procedure Proc_Next_Index (N : in out Node_Id);
5549 procedure Proc_Next_Inlined_Subprogram (N : in out Node_Id);
5550 procedure Proc_Next_Literal (N : in out Node_Id);
5552 pragma Inline (Proc_Next_Component);
5553 pragma Inline (Proc_Next_Discriminant);
5554 pragma Inline (Proc_Next_Formal);
5555 pragma Inline (Proc_Next_Formal_With_Extras);
5556 pragma Inline (Proc_Next_Girder_Discriminant);
5557 pragma Inline (Proc_Next_Index);
5558 pragma Inline (Proc_Next_Inlined_Subprogram);
5559 pragma Inline (Proc_Next_Literal);
5561 procedure Next_Component (N : in out Node_Id)
5562 renames Proc_Next_Component;
5564 procedure Next_Discriminant (N : in out Node_Id)
5565 renames Proc_Next_Discriminant;
5567 procedure Next_Formal (N : in out Node_Id)
5568 renames Proc_Next_Formal;
5570 procedure Next_Formal_With_Extras (N : in out Node_Id)
5571 renames Proc_Next_Formal_With_Extras;
5573 procedure Next_Girder_Discriminant (N : in out Node_Id)
5574 renames Proc_Next_Girder_Discriminant;
5576 procedure Next_Index (N : in out Node_Id)
5577 renames Proc_Next_Index;
5579 procedure Next_Inlined_Subprogram (N : in out Node_Id)
5580 renames Proc_Next_Inlined_Subprogram;
5582 procedure Next_Literal (N : in out Node_Id)
5583 renames Proc_Next_Literal;
5585 -------------------------------
5586 -- Miscellaneous Subprograms --
5587 -------------------------------
5589 procedure Append_Entity (Id : Entity_Id; V : Entity_Id);
5590 -- Add an entity to the list of entities declared in the scope V
5592 function Is_Entity_Name (N : Node_Id) return Boolean;
5593 -- Test if the node N is the name of an entity (i.e. is an identifier,
5594 -- expanded name, or an attribute reference that returns an entity).
5596 function Next_Index (Id : Node_Id) return Node_Id;
5597 -- Given an index from a previous call to First_Index or Next_Index,
5598 -- returns a node representing the occurrence of the next index subtype,
5599 -- or Empty if there are no more index subtypes.
5601 function Scope_Depth (Id : Entity_Id) return Uint;
5602 -- Returns the scope depth value of the Id, unless the Id is a record
5603 -- type, in which case it returns the scope depth of the record scope.
5605 function Subtype_Kind (K : Entity_Kind) return Entity_Kind;
5606 -- Given an entity_kind K this function returns the entity_kind
5607 -- corresponding to subtype kind of the type represented by K. For
5608 -- example if K is E_Signed_Integer_Type then E_Signed_Integer_Subtype
5609 -- is returned. If K is already a subtype kind it itself is returned. An
5610 -- internal error is generated if no such correspondence exists for K.
5612 ----------------------------------
5613 -- Debugging Output Subprograms --
5614 ----------------------------------
5616 procedure Write_Entity_Flags (Id : Entity_Id; Prefix : String);
5617 -- Writes a series of entries giving a line for each flag that is
5618 -- set to True. Each line is prefixed by the given string
5620 procedure Write_Entity_Info (Id : Entity_Id; Prefix : String);
5621 -- A debugging procedure to write out information about an entity
5623 procedure Write_Field6_Name (Id : Entity_Id);
5624 procedure Write_Field7_Name (Id : Entity_Id);
5625 procedure Write_Field8_Name (Id : Entity_Id);
5626 procedure Write_Field9_Name (Id : Entity_Id);
5627 procedure Write_Field10_Name (Id : Entity_Id);
5628 procedure Write_Field11_Name (Id : Entity_Id);
5629 procedure Write_Field12_Name (Id : Entity_Id);
5630 procedure Write_Field13_Name (Id : Entity_Id);
5631 procedure Write_Field14_Name (Id : Entity_Id);
5632 procedure Write_Field15_Name (Id : Entity_Id);
5633 procedure Write_Field16_Name (Id : Entity_Id);
5634 procedure Write_Field17_Name (Id : Entity_Id);
5635 procedure Write_Field18_Name (Id : Entity_Id);
5636 procedure Write_Field19_Name (Id : Entity_Id);
5637 procedure Write_Field20_Name (Id : Entity_Id);
5638 procedure Write_Field21_Name (Id : Entity_Id);
5639 procedure Write_Field22_Name (Id : Entity_Id);
5640 procedure Write_Field23_Name (Id : Entity_Id);
5641 -- These routines are used to output a nice symbolic name for the given
5642 -- field, depending on the Ekind. No blanks or end of lines are output,
5643 -- just the characters of the field name.
5645 --------------------
5646 -- Inline Pragmas --
5647 --------------------
5649 -- Note that these inline pragmas are referenced by the XEINFO utility
5650 -- program in preparing the corresponding C header, and only those
5651 -- subprograms meeting the requirements documented in the section on
5652 -- XEINFO may be referenced in this section.
5654 pragma Inline (Accept_Address);
5655 pragma Inline (Access_Disp_Table);
5656 pragma Inline (Actual_Subtype);
5657 pragma Inline (Address_Taken);
5658 pragma Inline (Alias);
5659 pragma Inline (Alignment);
5660 pragma Inline (Associated_Final_Chain);
5661 pragma Inline (Associated_Formal_Package);
5662 pragma Inline (Associated_Node_For_Itype);
5663 pragma Inline (Associated_Storage_Pool);
5664 pragma Inline (Barrier_Function);
5665 pragma Inline (Block_Node);
5666 pragma Inline (Body_Entity);
5667 pragma Inline (CR_Discriminant);
5668 pragma Inline (C_Pass_By_Copy);
5669 pragma Inline (Class_Wide_Type);
5670 pragma Inline (Cloned_Subtype);
5671 pragma Inline (Component_Bit_Offset);
5672 pragma Inline (Component_Clause);
5673 pragma Inline (Component_Size);
5674 pragma Inline (Component_Type);
5675 pragma Inline (Corresponding_Concurrent_Type);
5676 pragma Inline (Corresponding_Discriminant);
5677 pragma Inline (Corresponding_Equality);
5678 pragma Inline (Corresponding_Record_Type);
5679 pragma Inline (Corresponding_Remote_Type);
5680 pragma Inline (Debug_Info_Off);
5681 pragma Inline (Debug_Renaming_Link);
5682 pragma Inline (DTC_Entity);
5683 pragma Inline (DT_Entry_Count);
5684 pragma Inline (DT_Position);
5685 pragma Inline (Default_Expr_Function);
5686 pragma Inline (Default_Expressions_Processed);
5687 pragma Inline (Default_Value);
5688 pragma Inline (Delay_Cleanups);
5689 pragma Inline (Delay_Subprogram_Descriptors);
5690 pragma Inline (Delta_Value);
5691 pragma Inline (Dependent_Instances);
5692 pragma Inline (Depends_On_Private);
5693 pragma Inline (Digits_Value);
5694 pragma Inline (Directly_Designated_Type);
5695 pragma Inline (Discard_Names);
5696 pragma Inline (Discriminal);
5697 pragma Inline (Discriminal_Link);
5698 pragma Inline (Discriminant_Checking_Func);
5699 pragma Inline (Discriminant_Constraint);
5700 pragma Inline (Discriminant_Default_Value);
5701 pragma Inline (Discriminant_Number);
5702 pragma Inline (Elaborate_All_Desirable);
5703 pragma Inline (Elaboration_Entity);
5704 pragma Inline (Elaboration_Entity_Required);
5705 pragma Inline (Enclosing_Scope);
5706 pragma Inline (Entry_Accepted);
5707 pragma Inline (Entry_Bodies_Array);
5708 pragma Inline (Entry_Cancel_Parameter);
5709 pragma Inline (Entry_Component);
5710 pragma Inline (Entry_Formal);
5711 pragma Inline (Entry_Index_Constant);
5712 pragma Inline (Entry_Index_Type);
5713 pragma Inline (Entry_Parameters_Type);
5714 pragma Inline (Enum_Pos_To_Rep);
5715 pragma Inline (Enumeration_Pos);
5716 pragma Inline (Enumeration_Rep);
5717 pragma Inline (Enumeration_Rep_Expr);
5718 pragma Inline (Equivalent_Type);
5719 pragma Inline (Esize);
5720 pragma Inline (Exception_Code);
5721 pragma Inline (Extra_Accessibility);
5722 pragma Inline (Extra_Constrained);
5723 pragma Inline (Extra_Formal);
5724 pragma Inline (Finalization_Chain_Entity);
5725 pragma Inline (First_Entity);
5726 pragma Inline (First_Index);
5727 pragma Inline (First_Literal);
5728 pragma Inline (First_Optional_Parameter);
5729 pragma Inline (First_Private_Entity);
5730 pragma Inline (First_Rep_Item);
5731 pragma Inline (Freeze_Node);
5732 pragma Inline (From_With_Type);
5733 pragma Inline (Full_View);
5734 pragma Inline (Function_Returns_With_DSP);
5735 pragma Inline (Generic_Renamings);
5736 pragma Inline (Girder_Constraint);
5737 pragma Inline (Handler_Records);
5738 pragma Inline (Has_Aliased_Components);
5739 pragma Inline (Has_Alignment_Clause);
5740 pragma Inline (Has_All_Calls_Remote);
5741 pragma Inline (Has_Atomic_Components);
5742 pragma Inline (Has_Biased_Representation);
5743 pragma Inline (Has_Completion);
5744 pragma Inline (Has_Completion_In_Body);
5745 pragma Inline (Has_Complex_Representation);
5746 pragma Inline (Has_Component_Size_Clause);
5747 pragma Inline (Has_Controlled_Component);
5748 pragma Inline (Has_Controlling_Result);
5749 pragma Inline (Has_Convention_Pragma);
5750 pragma Inline (Has_Delayed_Freeze);
5751 pragma Inline (Has_Discriminants);
5752 pragma Inline (Has_Enumeration_Rep_Clause);
5753 pragma Inline (Has_Exit);
5754 pragma Inline (Has_External_Tag_Rep_Clause);
5755 pragma Inline (Has_Fully_Qualified_Name);
5756 pragma Inline (Has_Gigi_Rep_Item);
5757 pragma Inline (Has_Homonym);
5758 pragma Inline (Has_Machine_Radix_Clause);
5759 pragma Inline (Has_Master_Entity);
5760 pragma Inline (Has_Missing_Return);
5761 pragma Inline (Has_Nested_Block_With_Handler);
5762 pragma Inline (Has_Forward_Instantiation);
5763 pragma Inline (Has_Non_Standard_Rep);
5764 pragma Inline (Has_Object_Size_Clause);
5765 pragma Inline (Has_Per_Object_Constraint);
5766 pragma Inline (Has_Pragma_Controlled);
5767 pragma Inline (Has_Pragma_Elaborate_Body);
5768 pragma Inline (Has_Pragma_Inline);
5769 pragma Inline (Has_Pragma_Pack);
5770 pragma Inline (Has_Pragma_Pure_Function);
5771 pragma Inline (Has_Primitive_Operations);
5772 pragma Inline (Has_Private_Declaration);
5773 pragma Inline (Has_Qualified_Name);
5774 pragma Inline (Has_Record_Rep_Clause);
5775 pragma Inline (Has_Recursive_Call);
5776 pragma Inline (Has_Size_Clause);
5777 pragma Inline (Has_Small_Clause);
5778 pragma Inline (Has_Specified_Layout);
5779 pragma Inline (Has_Storage_Size_Clause);
5780 pragma Inline (Has_Subprogram_Descriptor);
5781 pragma Inline (Has_Task);
5782 pragma Inline (Has_Unchecked_Union);
5783 pragma Inline (Has_Unknown_Discriminants);
5784 pragma Inline (Has_Volatile_Components);
5785 pragma Inline (Hiding_Loop_Variable);
5786 pragma Inline (Homonym);
5787 pragma Inline (In_Package_Body);
5788 pragma Inline (In_Private_Part);
5789 pragma Inline (In_Use);
5790 pragma Inline (Inner_Instances);
5791 pragma Inline (Interface_Name);
5792 pragma Inline (Is_AST_Entry);
5793 pragma Inline (Is_Abstract);
5794 pragma Inline (Is_Access_Constant);
5795 pragma Inline (Is_Access_Type);
5796 pragma Inline (Is_Aliased);
5797 pragma Inline (Is_Array_Type);
5798 pragma Inline (Is_Asynchronous);
5799 pragma Inline (Is_Atomic);
5800 pragma Inline (Is_Bit_Packed_Array);
5801 pragma Inline (Is_CPP_Class);
5802 pragma Inline (Is_Called);
5803 pragma Inline (Is_Character_Type);
5804 pragma Inline (Is_Child_Unit);
5805 pragma Inline (Is_Class_Wide_Type);
5806 pragma Inline (Is_Compilation_Unit);
5807 pragma Inline (Is_Completely_Hidden);
5808 pragma Inline (Is_Composite_Type);
5809 pragma Inline (Is_Concurrent_Body);
5810 pragma Inline (Is_Concurrent_Record_Type);
5811 pragma Inline (Is_Concurrent_Type);
5812 pragma Inline (Is_Constr_Subt_For_UN_Aliased);
5813 pragma Inline (Is_Constr_Subt_For_U_Nominal);
5814 pragma Inline (Is_Constrained);
5815 pragma Inline (Is_Constructor);
5816 pragma Inline (Is_Controlled);
5817 pragma Inline (Is_Controlling_Formal);
5818 pragma Inline (Is_Decimal_Fixed_Point_Type);
5819 pragma Inline (Is_Destructor);
5820 pragma Inline (Is_Discrim_SO_Function);
5821 pragma Inline (Is_Digits_Type);
5822 pragma Inline (Is_Discrete_Or_Fixed_Point_Type);
5823 pragma Inline (Is_Discrete_Type);
5824 pragma Inline (Is_Dispatching_Operation);
5825 pragma Inline (Is_Elementary_Type);
5826 pragma Inline (Is_Eliminated);
5827 pragma Inline (Is_Entry);
5828 pragma Inline (Is_Entry_Formal);
5829 pragma Inline (Is_Enumeration_Type);
5830 pragma Inline (Is_Exported);
5831 pragma Inline (Is_First_Subtype);
5832 pragma Inline (Is_Fixed_Point_Type);
5833 pragma Inline (Is_Floating_Point_Type);
5834 pragma Inline (Is_For_Access_Subtype);
5835 pragma Inline (Is_Formal);
5836 pragma Inline (Is_Formal_Subprogram);
5837 pragma Inline (Is_Frozen);
5838 pragma Inline (Is_Generic_Actual_Type);
5839 pragma Inline (Is_Generic_Instance);
5840 pragma Inline (Is_Generic_Type);
5841 pragma Inline (Is_Generic_Unit);
5842 pragma Inline (Is_Hidden);
5843 pragma Inline (Is_Hidden_Open_Scope);
5844 pragma Inline (Is_Immediately_Visible);
5845 pragma Inline (Is_Imported);
5846 pragma Inline (Is_Incomplete_Or_Private_Type);
5847 pragma Inline (Is_Inlined);
5848 pragma Inline (Is_Instantiated);
5849 pragma Inline (Is_Integer_Type);
5850 pragma Inline (Is_Internal);
5851 pragma Inline (Is_Interrupt_Handler);
5852 pragma Inline (Is_Intrinsic_Subprogram);
5853 pragma Inline (Is_Itype);
5854 pragma Inline (Is_Known_Valid);
5855 pragma Inline (Is_Limited_Composite);
5856 pragma Inline (Is_Limited_Record);
5857 pragma Inline (Is_Machine_Code_Subprogram);
5858 pragma Inline (Is_Modular_Integer_Type);
5859 pragma Inline (Is_Named_Number);
5860 pragma Inline (Is_Non_Static_Subtype);
5861 pragma Inline (Is_Null_Init_Proc);
5862 pragma Inline (Is_Numeric_Type);
5863 pragma Inline (Is_Object);
5864 pragma Inline (Is_Optional_Parameter);
5865 pragma Inline (Is_Package_Body_Entity);
5866 pragma Inline (Is_Ordinary_Fixed_Point_Type);
5867 pragma Inline (Is_Overloadable);
5868 pragma Inline (Is_Packed);
5869 pragma Inline (Is_Packed_Array_Type);
5870 pragma Inline (Is_Potentially_Use_Visible);
5871 pragma Inline (Is_Preelaborated);
5872 pragma Inline (Is_Private_Composite);
5873 pragma Inline (Is_Private_Descendant);
5874 pragma Inline (Is_Private_Type);
5875 pragma Inline (Is_Protected_Type);
5876 pragma Inline (Is_Psected);
5877 pragma Inline (Is_Public);
5878 pragma Inline (Is_Pure);
5879 pragma Inline (Is_Real_Type);
5880 pragma Inline (Is_Record_Type);
5881 pragma Inline (Is_Remote_Call_Interface);
5882 pragma Inline (Is_Remote_Types);
5883 pragma Inline (Is_Renaming_Of_Object);
5884 pragma Inline (Is_Scalar_Type);
5885 pragma Inline (Is_Shared_Passive);
5886 pragma Inline (Is_Signed_Integer_Type);
5887 pragma Inline (Is_Statically_Allocated);
5888 pragma Inline (Is_Subprogram);
5889 pragma Inline (Is_Tag);
5890 pragma Inline (Is_Tagged_Type);
5891 pragma Inline (Is_True_Constant);
5892 pragma Inline (Is_Task_Type);
5893 pragma Inline (Is_Type);
5894 pragma Inline (Is_Unchecked_Union);
5895 pragma Inline (Is_Unsigned_Type);
5896 pragma Inline (Is_VMS_Exception);
5897 pragma Inline (Is_Valued_Procedure);
5898 pragma Inline (Is_Visible_Child_Unit);
5899 pragma Inline (Is_Volatile);
5900 pragma Inline (Last_Entity);
5901 pragma Inline (Lit_Indexes);
5902 pragma Inline (Lit_Strings);
5903 pragma Inline (Machine_Radix_10);
5904 pragma Inline (Master_Id);
5905 pragma Inline (Materialize_Entity);
5906 pragma Inline (Mechanism);
5907 pragma Inline (Modulus);
5908 pragma Inline (Needs_Debug_Info);
5909 pragma Inline (Needs_No_Actuals);
5910 pragma Inline (Next_Index);
5911 pragma Inline (Next_Inlined_Subprogram);
5912 pragma Inline (Next_Literal);
5913 pragma Inline (No_Pool_Assigned);
5914 pragma Inline (No_Return);
5915 pragma Inline (Non_Binary_Modulus);
5916 pragma Inline (Nonzero_Is_True);
5917 pragma Inline (Normalized_First_Bit);
5918 pragma Inline (Normalized_Position);
5919 pragma Inline (Normalized_Position_Max);
5920 pragma Inline (Not_Source_Assigned);
5921 pragma Inline (Object_Ref);
5922 pragma Inline (Original_Record_Component);
5923 pragma Inline (Packed_Array_Type);
5924 pragma Inline (Parameter_Mode);
5925 pragma Inline (Parent_Subtype);
5926 pragma Inline (Primitive_Operations);
5927 pragma Inline (Prival);
5928 pragma Inline (Privals_Chain);
5929 pragma Inline (Private_Dependents);
5930 pragma Inline (Private_View);
5931 pragma Inline (Protected_Body_Subprogram);
5932 pragma Inline (Protected_Formal);
5933 pragma Inline (Protected_Operation);
5934 pragma Inline (RM_Size);
5935 pragma Inline (Reachable);
5936 pragma Inline (Referenced);
5937 pragma Inline (Referenced_Object);
5938 pragma Inline (Register_Exception_Call);
5939 pragma Inline (Related_Array_Object);
5940 pragma Inline (Related_Instance);
5941 pragma Inline (Renamed_Entity);
5942 pragma Inline (Renamed_Object);
5943 pragma Inline (Renaming_Map);
5944 pragma Inline (Return_Present);
5945 pragma Inline (Returns_By_Ref);
5946 pragma Inline (Reverse_Bit_Order);
5947 pragma Inline (Scalar_Range);
5948 pragma Inline (Scale_Value);
5949 pragma Inline (Scope_Depth_Value);
5950 pragma Inline (Sec_Stack_Needed_For_Return);
5951 pragma Inline (Shadow_Entities);
5952 pragma Inline (Shared_Var_Assign_Proc);
5953 pragma Inline (Shared_Var_Read_Proc);
5954 pragma Inline (Size_Check_Code);
5955 pragma Inline (Size_Depends_On_Discriminant);
5956 pragma Inline (Size_Known_At_Compile_Time);
5957 pragma Inline (Small_Value);
5958 pragma Inline (Spec_Entity);
5959 pragma Inline (Storage_Size_Variable);
5960 pragma Inline (Strict_Alignment);
5961 pragma Inline (String_Literal_Length);
5962 pragma Inline (String_Literal_Low_Bound);
5963 pragma Inline (Suppress_Access_Checks);
5964 pragma Inline (Suppress_Accessibility_Checks);
5965 pragma Inline (Suppress_Discriminant_Checks);
5966 pragma Inline (Suppress_Division_Checks);
5967 pragma Inline (Suppress_Elaboration_Checks);
5968 pragma Inline (Suppress_Elaboration_Warnings);
5969 pragma Inline (Suppress_Index_Checks);
5970 pragma Inline (Suppress_Init_Proc);
5971 pragma Inline (Suppress_Length_Checks);
5972 pragma Inline (Suppress_Overflow_Checks);
5973 pragma Inline (Suppress_Range_Checks);
5974 pragma Inline (Suppress_Storage_Checks);
5975 pragma Inline (Suppress_Style_Checks);
5976 pragma Inline (Suppress_Tag_Checks);
5977 pragma Inline (Underlying_Full_View);
5978 pragma Inline (Unset_Reference);
5979 pragma Inline (Uses_Sec_Stack);
5980 pragma Inline (Vax_Float);
5981 pragma Inline (Warnings_Off);
5983 pragma Inline (Init_Alignment);
5984 pragma Inline (Init_Component_Bit_Offset);
5985 pragma Inline (Init_Component_Size);
5986 pragma Inline (Init_Digits_Value);
5987 pragma Inline (Init_Esize);
5988 pragma Inline (Init_RM_Size);
5990 pragma Inline (Known_Alignment);
5991 pragma Inline (Known_Component_Bit_Offset);
5992 pragma Inline (Known_Component_Size);
5993 pragma Inline (Known_Esize);
5995 pragma Inline (Known_Static_Component_Size);
5996 pragma Inline (Known_Static_Esize);
5998 pragma Inline (Unknown_Alignment);
5999 pragma Inline (Unknown_Component_Bit_Offset);
6000 pragma Inline (Unknown_Component_Size);
6001 pragma Inline (Unknown_Esize);
6003 pragma Inline (Set_Accept_Address);
6004 pragma Inline (Set_Access_Disp_Table);
6005 pragma Inline (Set_Actual_Subtype);
6006 pragma Inline (Set_Address_Taken);
6007 pragma Inline (Set_Alias);
6008 pragma Inline (Set_Alignment);
6009 pragma Inline (Set_Associated_Final_Chain);
6010 pragma Inline (Set_Associated_Formal_Package);
6011 pragma Inline (Set_Associated_Node_For_Itype);
6012 pragma Inline (Set_Associated_Storage_Pool);
6013 pragma Inline (Set_Barrier_Function);
6014 pragma Inline (Set_Block_Node);
6015 pragma Inline (Set_Body_Entity);
6016 pragma Inline (Set_CR_Discriminant);
6017 pragma Inline (Set_C_Pass_By_Copy);
6018 pragma Inline (Set_Class_Wide_Type);
6019 pragma Inline (Set_Cloned_Subtype);
6020 pragma Inline (Set_Component_Bit_Offset);
6021 pragma Inline (Set_Component_Clause);
6022 pragma Inline (Set_Component_Size);
6023 pragma Inline (Set_Component_Type);
6024 pragma Inline (Set_Corresponding_Concurrent_Type);
6025 pragma Inline (Set_Corresponding_Discriminant);
6026 pragma Inline (Set_Corresponding_Equality);
6027 pragma Inline (Set_Corresponding_Record_Type);
6028 pragma Inline (Set_Corresponding_Remote_Type);
6029 pragma Inline (Set_Debug_Info_Off);
6030 pragma Inline (Set_Debug_Renaming_Link);
6031 pragma Inline (Set_DTC_Entity);
6032 pragma Inline (Set_DT_Position);
6033 pragma Inline (Set_Default_Expr_Function);
6034 pragma Inline (Set_Default_Expressions_Processed);
6035 pragma Inline (Set_Default_Value);
6036 pragma Inline (Set_Delay_Cleanups);
6037 pragma Inline (Set_Delay_Subprogram_Descriptors);
6038 pragma Inline (Set_Delta_Value);
6039 pragma Inline (Set_Dependent_Instances);
6040 pragma Inline (Set_Depends_On_Private);
6041 pragma Inline (Set_Digits_Value);
6042 pragma Inline (Set_Directly_Designated_Type);
6043 pragma Inline (Set_Discard_Names);
6044 pragma Inline (Set_Discriminal);
6045 pragma Inline (Set_Discriminal_Link);
6046 pragma Inline (Set_Discriminant_Checking_Func);
6047 pragma Inline (Set_Discriminant_Constraint);
6048 pragma Inline (Set_Discriminant_Default_Value);
6049 pragma Inline (Set_Discriminant_Number);
6050 pragma Inline (Set_Elaborate_All_Desirable);
6051 pragma Inline (Set_Elaboration_Entity);
6052 pragma Inline (Set_Elaboration_Entity_Required);
6053 pragma Inline (Set_Enclosing_Scope);
6054 pragma Inline (Set_Entry_Accepted);
6055 pragma Inline (Set_Entry_Bodies_Array);
6056 pragma Inline (Set_Entry_Cancel_Parameter);
6057 pragma Inline (Set_Entry_Component);
6058 pragma Inline (Set_Entry_Formal);
6059 pragma Inline (Set_Entry_Parameters_Type);
6060 pragma Inline (Set_Enum_Pos_To_Rep);
6061 pragma Inline (Set_Enumeration_Pos);
6062 pragma Inline (Set_Enumeration_Rep);
6063 pragma Inline (Set_Enumeration_Rep_Expr);
6064 pragma Inline (Set_Equivalent_Type);
6065 pragma Inline (Set_Esize);
6066 pragma Inline (Set_Exception_Code);
6067 pragma Inline (Set_Extra_Accessibility);
6068 pragma Inline (Set_Extra_Constrained);
6069 pragma Inline (Set_Extra_Formal);
6070 pragma Inline (Set_Finalization_Chain_Entity);
6071 pragma Inline (Set_First_Entity);
6072 pragma Inline (Set_First_Index);
6073 pragma Inline (Set_First_Literal);
6074 pragma Inline (Set_First_Optional_Parameter);
6075 pragma Inline (Set_First_Private_Entity);
6076 pragma Inline (Set_First_Rep_Item);
6077 pragma Inline (Set_Freeze_Node);
6078 pragma Inline (Set_From_With_Type);
6079 pragma Inline (Set_Full_View);
6080 pragma Inline (Set_Function_Returns_With_DSP);
6081 pragma Inline (Set_Generic_Renamings);
6082 pragma Inline (Set_Girder_Constraint);
6083 pragma Inline (Set_Handler_Records);
6084 pragma Inline (Set_Has_Aliased_Components);
6085 pragma Inline (Set_Has_Alignment_Clause);
6086 pragma Inline (Set_Has_All_Calls_Remote);
6087 pragma Inline (Set_Has_Atomic_Components);
6088 pragma Inline (Set_Has_Biased_Representation);
6089 pragma Inline (Set_Has_Completion);
6090 pragma Inline (Set_Has_Completion_In_Body);
6091 pragma Inline (Set_Has_Complex_Representation);
6092 pragma Inline (Set_Has_Component_Size_Clause);
6093 pragma Inline (Set_Has_Controlled_Component);
6094 pragma Inline (Set_Has_Controlling_Result);
6095 pragma Inline (Set_Has_Convention_Pragma);
6096 pragma Inline (Set_Has_Delayed_Freeze);
6097 pragma Inline (Set_Has_Discriminants);
6098 pragma Inline (Set_Has_Enumeration_Rep_Clause);
6099 pragma Inline (Set_Has_Exit);
6100 pragma Inline (Set_Has_External_Tag_Rep_Clause);
6101 pragma Inline (Set_Has_Fully_Qualified_Name);
6102 pragma Inline (Set_Has_Gigi_Rep_Item);
6103 pragma Inline (Set_Has_Homonym);
6104 pragma Inline (Set_Has_Machine_Radix_Clause);
6105 pragma Inline (Set_Has_Master_Entity);
6106 pragma Inline (Set_Has_Missing_Return);
6107 pragma Inline (Set_Has_Nested_Block_With_Handler);
6108 pragma Inline (Set_Has_Forward_Instantiation);
6109 pragma Inline (Set_Has_Non_Standard_Rep);
6110 pragma Inline (Set_Has_Object_Size_Clause);
6111 pragma Inline (Set_Has_Per_Object_Constraint);
6112 pragma Inline (Set_Has_Pragma_Controlled);
6113 pragma Inline (Set_Has_Pragma_Elaborate_Body);
6114 pragma Inline (Set_Has_Pragma_Inline);
6115 pragma Inline (Set_Has_Pragma_Pack);
6116 pragma Inline (Set_Has_Pragma_Pure_Function);
6117 pragma Inline (Set_Has_Primitive_Operations);
6118 pragma Inline (Set_Has_Private_Declaration);
6119 pragma Inline (Set_Has_Qualified_Name);
6120 pragma Inline (Set_Has_Record_Rep_Clause);
6121 pragma Inline (Set_Has_Recursive_Call);
6122 pragma Inline (Set_Has_Size_Clause);
6123 pragma Inline (Set_Has_Small_Clause);
6124 pragma Inline (Set_Has_Specified_Layout);
6125 pragma Inline (Set_Has_Storage_Size_Clause);
6126 pragma Inline (Set_Has_Subprogram_Descriptor);
6127 pragma Inline (Set_Has_Task);
6128 pragma Inline (Set_Has_Unchecked_Union);
6129 pragma Inline (Set_Has_Unknown_Discriminants);
6130 pragma Inline (Set_Has_Volatile_Components);
6131 pragma Inline (Set_Hiding_Loop_Variable);
6132 pragma Inline (Set_Homonym);
6133 pragma Inline (Set_In_Package_Body);
6134 pragma Inline (Set_In_Private_Part);
6135 pragma Inline (Set_In_Use);
6136 pragma Inline (Set_Inner_Instances);
6137 pragma Inline (Set_Interface_Name);
6138 pragma Inline (Set_Is_AST_Entry);
6139 pragma Inline (Set_Is_Abstract);
6140 pragma Inline (Set_Is_Access_Constant);
6141 pragma Inline (Set_Is_Aliased);
6142 pragma Inline (Set_Is_Asynchronous);
6143 pragma Inline (Set_Is_Atomic);
6144 pragma Inline (Set_Is_Bit_Packed_Array);
6145 pragma Inline (Set_Is_CPP_Class);
6146 pragma Inline (Set_Is_Called);
6147 pragma Inline (Set_Is_Character_Type);
6148 pragma Inline (Set_Is_Child_Unit);
6149 pragma Inline (Set_Is_Compilation_Unit);
6150 pragma Inline (Set_Is_Completely_Hidden);
6151 pragma Inline (Set_Is_Concurrent_Record_Type);
6152 pragma Inline (Set_Is_Constr_Subt_For_U_Nominal);
6153 pragma Inline (Set_Is_Constr_Subt_For_UN_Aliased);
6154 pragma Inline (Set_Is_Constrained);
6155 pragma Inline (Set_Is_Constructor);
6156 pragma Inline (Set_Is_Controlled);
6157 pragma Inline (Set_Is_Controlling_Formal);
6158 pragma Inline (Set_Is_Destructor);
6159 pragma Inline (Set_Is_Discrim_SO_Function);
6160 pragma Inline (Set_Is_Dispatching_Operation);
6161 pragma Inline (Set_Is_Eliminated);
6162 pragma Inline (Set_Is_Entry_Formal);
6163 pragma Inline (Set_Is_Exported);
6164 pragma Inline (Set_Is_First_Subtype);
6165 pragma Inline (Set_Is_For_Access_Subtype);
6166 pragma Inline (Set_Is_Formal_Subprogram);
6167 pragma Inline (Set_Is_Frozen);
6168 pragma Inline (Set_Is_Generic_Actual_Type);
6169 pragma Inline (Set_Is_Generic_Instance);
6170 pragma Inline (Set_Is_Generic_Type);
6171 pragma Inline (Set_Is_Hidden);
6172 pragma Inline (Set_Is_Hidden_Open_Scope);
6173 pragma Inline (Set_Is_Immediately_Visible);
6174 pragma Inline (Set_Is_Imported);
6175 pragma Inline (Set_Is_Inlined);
6176 pragma Inline (Set_Is_Instantiated);
6177 pragma Inline (Set_Is_Internal);
6178 pragma Inline (Set_Is_Interrupt_Handler);
6179 pragma Inline (Set_Is_Intrinsic_Subprogram);
6180 pragma Inline (Set_Is_Itype);
6181 pragma Inline (Set_Is_Known_Valid);
6182 pragma Inline (Set_Is_Limited_Composite);
6183 pragma Inline (Set_Is_Limited_Record);
6184 pragma Inline (Set_Is_Machine_Code_Subprogram);
6185 pragma Inline (Set_Is_Non_Static_Subtype);
6186 pragma Inline (Set_Is_Null_Init_Proc);
6187 pragma Inline (Set_Is_Optional_Parameter);
6188 pragma Inline (Set_Is_Package_Body_Entity);
6189 pragma Inline (Set_Is_Packed);
6190 pragma Inline (Set_Is_Packed_Array_Type);
6191 pragma Inline (Set_Is_Potentially_Use_Visible);
6192 pragma Inline (Set_Is_Preelaborated);
6193 pragma Inline (Set_Is_Private_Composite);
6194 pragma Inline (Set_Is_Private_Descendant);
6195 pragma Inline (Set_Is_Psected);
6196 pragma Inline (Set_Is_Public);
6197 pragma Inline (Set_Is_Pure);
6198 pragma Inline (Set_Is_Remote_Call_Interface);
6199 pragma Inline (Set_Is_Remote_Types);
6200 pragma Inline (Set_Is_Renaming_Of_Object);
6201 pragma Inline (Set_Is_Shared_Passive);
6202 pragma Inline (Set_Is_Statically_Allocated);
6203 pragma Inline (Set_Is_Tag);
6204 pragma Inline (Set_Is_Tagged_Type);
6205 pragma Inline (Set_Is_True_Constant);
6206 pragma Inline (Set_Is_Unchecked_Union);
6207 pragma Inline (Set_Is_Unsigned_Type);
6208 pragma Inline (Set_Is_VMS_Exception);
6209 pragma Inline (Set_Is_Valued_Procedure);
6210 pragma Inline (Set_Is_Visible_Child_Unit);
6211 pragma Inline (Set_Is_Volatile);
6212 pragma Inline (Set_Last_Entity);
6213 pragma Inline (Set_Lit_Indexes);
6214 pragma Inline (Set_Lit_Strings);
6215 pragma Inline (Set_Machine_Radix_10);
6216 pragma Inline (Set_Master_Id);
6217 pragma Inline (Set_Materialize_Entity);
6218 pragma Inline (Set_Mechanism);
6219 pragma Inline (Set_Modulus);
6220 pragma Inline (Set_Needs_Debug_Info);
6221 pragma Inline (Set_Needs_No_Actuals);
6222 pragma Inline (Set_Next_Inlined_Subprogram);
6223 pragma Inline (Set_No_Pool_Assigned);
6224 pragma Inline (Set_No_Return);
6225 pragma Inline (Set_Non_Binary_Modulus);
6226 pragma Inline (Set_Nonzero_Is_True);
6227 pragma Inline (Set_Normalized_First_Bit);
6228 pragma Inline (Set_Normalized_Position);
6229 pragma Inline (Set_Normalized_Position_Max);
6230 pragma Inline (Set_Not_Source_Assigned);
6231 pragma Inline (Set_Object_Ref);
6232 pragma Inline (Set_Original_Record_Component);
6233 pragma Inline (Set_Packed_Array_Type);
6234 pragma Inline (Set_Parent_Subtype);
6235 pragma Inline (Set_Primitive_Operations);
6236 pragma Inline (Set_Prival);
6237 pragma Inline (Set_Privals_Chain);
6238 pragma Inline (Set_Private_Dependents);
6239 pragma Inline (Set_Private_View);
6240 pragma Inline (Set_Protected_Body_Subprogram);
6241 pragma Inline (Set_Protected_Formal);
6242 pragma Inline (Set_Protected_Operation);
6243 pragma Inline (Set_RM_Size);
6244 pragma Inline (Set_Reachable);
6245 pragma Inline (Set_Referenced);
6246 pragma Inline (Set_Referenced_Object);
6247 pragma Inline (Set_Register_Exception_Call);
6248 pragma Inline (Set_Related_Array_Object);
6249 pragma Inline (Set_Related_Instance);
6250 pragma Inline (Set_Renamed_Entity);
6251 pragma Inline (Set_Renamed_Object);
6252 pragma Inline (Set_Renaming_Map);
6253 pragma Inline (Set_Return_Present);
6254 pragma Inline (Set_Returns_By_Ref);
6255 pragma Inline (Set_Reverse_Bit_Order);
6256 pragma Inline (Set_Scalar_Range);
6257 pragma Inline (Set_Scale_Value);
6258 pragma Inline (Set_Scope_Depth_Value);
6259 pragma Inline (Set_Sec_Stack_Needed_For_Return);
6260 pragma Inline (Set_Shadow_Entities);
6261 pragma Inline (Set_Shared_Var_Assign_Proc);
6262 pragma Inline (Set_Shared_Var_Read_Proc);
6263 pragma Inline (Set_Size_Check_Code);
6264 pragma Inline (Set_Size_Depends_On_Discriminant);
6265 pragma Inline (Set_Size_Known_At_Compile_Time);
6266 pragma Inline (Set_Small_Value);
6267 pragma Inline (Set_Spec_Entity);
6268 pragma Inline (Set_Storage_Size_Variable);
6269 pragma Inline (Set_Strict_Alignment);
6270 pragma Inline (Set_String_Literal_Length);
6271 pragma Inline (Set_String_Literal_Low_Bound);
6272 pragma Inline (Set_Suppress_Access_Checks);
6273 pragma Inline (Set_Suppress_Accessibility_Checks);
6274 pragma Inline (Set_Suppress_Discriminant_Checks);
6275 pragma Inline (Set_Suppress_Division_Checks);
6276 pragma Inline (Set_Suppress_Elaboration_Checks);
6277 pragma Inline (Set_Suppress_Elaboration_Warnings);
6278 pragma Inline (Set_Suppress_Index_Checks);
6279 pragma Inline (Set_Suppress_Init_Proc);
6280 pragma Inline (Set_Suppress_Length_Checks);
6281 pragma Inline (Set_Suppress_Overflow_Checks);
6282 pragma Inline (Set_Suppress_Range_Checks);
6283 pragma Inline (Set_Suppress_Storage_Checks);
6284 pragma Inline (Set_Suppress_Style_Checks);
6285 pragma Inline (Set_Suppress_Tag_Checks);
6286 pragma Inline (Set_Underlying_Full_View);
6287 pragma Inline (Set_Unset_Reference);
6288 pragma Inline (Set_Uses_Sec_Stack);
6289 pragma Inline (Set_Vax_Float);
6290 pragma Inline (Set_Warnings_Off);
6292 -- END XEINFO INLINES
6294 -- The following Inline pragmas are *not* read by xeinfo when building
6295 -- the C version of this interface automatically (so the C version will
6296 -- end up making out of line calls). The pragma scan in xeinfo will be
6297 -- terminated on encountering the END XEINFO INLINES line. We inline
6298 -- things here which are small, but not of the canonical attribute
6299 -- access/set format that can be handled by xeinfo.
6301 pragma Inline (Is_Package);
6302 pragma Inline (Is_Wrapper_Package);
6303 pragma Inline (Known_RM_Size);
6304 pragma Inline (Known_Static_Component_Bit_Offset);
6305 pragma Inline (Known_Static_RM_Size);
6306 pragma Inline (Scope_Depth);
6307 pragma Inline (Scope_Depth_Set);
6308 pragma Inline (Unknown_RM_Size);