Google Git
Sign in
gnu / gcc / 57ea00136418991e847e46a6946a81a1df70c9a4 / . / gcc / ada / einfo.ads
blob: cff7039b23f66a9a39651be4fb00996b1891764d [file] [log] [blame]
------------------------------------------------------------------------------
-- --
-- GNAT COMPILER COMPONENTS --
-- --
-- E I N F O --
-- --
-- S p e c --
-- --
-- Copyright (C) 1992-2003 Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 2, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
-- Public License distributed with GNAT; see file COPYING. If not, write --
-- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
-- MA 02111-1307, USA. --
-- --
-- As a special exception, if other files instantiate generics from this --
-- unit, or you link this unit with other files to produce an executable, --
-- this unit does not by itself cause the resulting executable to be --
-- covered by the GNU General Public License. This exception does not --
-- however invalidate any other reasons why the executable file might be --
-- covered by the GNU Public License. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
with Snames; use Snames;
with Types; use Types;
with Uintp; use Uintp;
with Urealp; use Urealp;
package Einfo is
-- This package defines the annotations to the abstract syntax tree that
-- are needed to support semantic processing of an Ada compilation.
-- These annotations are for the most part attributes of declared entities,
-- and they correspond to conventional symbol table information. Other
-- attributes include sets of meanings for overloaded names, possible
-- types for overloaded expressions, flags to indicate deferred constants,
-- incomplete types, etc. These attributes are stored in available fields
-- in tree nodes (i.e. fields not used by the parser, as defined by the
-- Sinfo package specification), and accessed by means of a set of
-- subprograms which define an abstract interface.
-- There are two kinds of semantic information
-- First, the tree nodes with the following Nkind values:
-- N_Defining_Identifier
-- N_Defining_Character_Literal
-- N_Defining_Operator_Symbol
-- are called Entities, and constitute the information that would often
-- be stored separately in a symbol table. These nodes are all extended
-- to provide extra space, and contain fields which depend on the entity
-- kind, as defined by the contents of the Ekind field. The use of the
-- Ekind field, and the associated fields in the entity, are defined
-- in this package, as are the access functions to these fields.
-- Second, in some cases semantic information is stored directly in other
-- kinds of nodes, e.g. the Etype field, used to indicate the type of an
-- expression. The access functions to these fields are defined in the
-- Sinfo package, but their full documentation is to be found in
-- the Einfo package specification.
-- Declaration processing places information in the nodes of their defining
-- identifiers. Name resolution places in all other occurrences of an
-- identifier a pointer to the corresponding defining occurrence.
--------------------------------
-- The XEINFO Utility Program --
--------------------------------
-- XEINFO is a utility program which automatically produces a C header file,
-- a-xeinfo.h from the spec and body of package Einfo. It reads the input
-- files einfo.ads and einfo.adb and produces the output file a-xeinfo.h.
-- In order for this utility program to operate correctly, the form of the
-- einfo.ads and einfo.adb files must meet certain requirements and be laid
-- out in a specific manner.
-- The general form of einfo.ads is as follows:
-- type declaration for type Entity_Kind
-- subtype declarations declaring subranges of Entity_Kind
-- subtype declarations declaring synonyms for some standard types
-- function specs for attributes
-- procedure specs
-- pragma Inline declarations
-- This order must be observed. There are no restrictions on the procedures,
-- since the C header file only includes functions (Gigi is not allowed to
-- modify the generated tree). However, functions are required to have headers
-- that fit on a single line.
-- XEINFO reads and processes the function specs and the pragma Inlines. For
-- functions that are declared as inlined, XEINFO reads the corresponding body
-- from xeinfo.adb, and processes it into C code. This results in some strict
-- restrictions on which functions can be inlined:
-- The function spec must be on a single line
-- There can only be a single statement, contained on a single line,
-- not counting any pragma Assert statements.
-- This single statement must either by a function call with simple,
-- single token arguments, or it must be a membership test of the form
-- a in b, where a and b are single tokens.
-- For functions that are not inlined, there is no restriction on the body,
-- and XEINFO generates a direct reference in the C header file which allows
-- the C code in Gigi to directly call the corresponding Ada body.
----------------------------------
-- Handling of Type'Size Values --
----------------------------------
-- The Ada 95 RM contains some rather peculiar (to us!) rules on the value
-- of type'Size (see RM 13.3(55)). We have found that attempting to use
-- these RM Size values generally, and in particular for determining the
-- default size of objects, creates chaos, and major incompatibilies in
-- existing code.
-- We proceed as follows, for discrete and fixed-point subtypes, we have
-- two separate sizes for each subtype:
-- The Object_Size, which is used for determining the default size of
-- objects and components. This size value can be referred to using the
-- Object_Size attribute. The phrase "is used" here means that it is
-- the basis of the determination of the size. The backend is free to
-- pad this up if necessary for efficiency, e.g. an 8-bit stand-alone
-- character might be stored in 32 bits on a machine with no efficient
-- byte access instructions such as the Alpha.
-- The default rules for the value of Object_Size for fixed-point and
-- discrete types are as follows:
-- The Object_Size for base subtypes reflect the natural hardware
-- size in bits (see Ttypes and Cstand for integer types). For
-- enumeration and fixed-point base subtypes have 8. 16. 32 or 64
-- bits for this size, depending on the range of values to be stored.
-- The Object_Size of a subtype is the same as the Object_Size of
-- the subtype from which it is obtained.
-- The Object_Size of a derived base type is copied from the parent
-- base type, and the Object_Size of a derived first subtype is copied
-- from the parent first subtype.
-- The Value_Size which is the number of bits required to store a value
-- of the type. This size can be referred to using the Value_Size
-- attribute. This value is used to determine how tightly to pack
-- records or arrays with components of this type, and also affects
-- the semantics of unchecked conversion (unchecked conversions where
-- the Value_Size values differ generate a warning, and are potentially
-- target dependent).
-- The default rule for the value of Value_Size are as follows:
-- The Value_Size for a base subtype is the minimum number of bits
-- required to store all values of the type (including the sign bit
-- only if negative values are possible).
-- If a subtype statically matches the first subtype, then it has
-- by default the same Value_Size as the first subtype. This is a
-- consequence of RM 13.1(14) ("if two subtypes statically match,
-- then their subtype-specific aspects are the same".)
-- All other subtypes have a Value_Size corresponding to the minimum
-- number of bits required to store all values of the subtype. For
-- dynamic bounds, it is assumed that the value can range down or up
-- to the corresponding bound of the ancestor
-- The RM defined attribute Size corresponds to the Value_Size attribute.
-- The Size attribute may be defined for a first-named subtype. This sets
-- the Value_Size of the first-named subtype to the given value, and the
-- Object_Size of this first-named subtype to the given value padded up
-- to an appropriate boundary. It is a consequence of the default rules
-- above that this Object_Size will apply to all further subtypes. On the
-- otyher hand, Value_Size is affected only for the first subtype, any
-- dynamic subtypes obtained from it directly, and any statically matching
-- subtypes. The Value_Size of any other static subtypes is not affected.
-- Value_Size and Object_Size may be explicitly set for any subtype using
-- an attribute definition clause. Note that the use of these attributes
-- can cause the RM 13.1(14) rule to be violated. If two access types
-- reference aliased objects whose subtypes have differing Object_Size
-- values as a result of explicit attribute definition clauses, then it
-- is erroneous to convert from one access subtype to the other.
-- At the implementation level, Esize stores the Object_Size and the
-- RM_Size field stores the Value_Size (and hence the value of the
-- Size attribute, which, as noted above, is equivalent to Value_Size).
-- To get a feel for the difference, consider the following examples (note
-- that in each case the base is short_short_integer with a size of 8):
-- Object_Size Value_Size
-- type x1 is range 0..5; 8 3
-- type x2 is range 0..5;
-- for x2'size use 12; 12 12
-- subtype x3 is x2 range 0 .. 3; 12 2
-- subtype x4 is x2'base range 0 .. 10; 8 4
-- subtype x5 is x2 range 0 .. dynamic; 12 (7)
-- subtype x6 is x2'base range 0 .. dynamic; 8 (7)
-- Note: the entries marked (7) are not actually specified by the Ada 95 RM,
-- but it seems in the spirit of the RM rules to allocate the minimum number
-- of bits known to be large enough to hold the given range of values.
-- So far, so good, but GNAT has to obey the RM rules, so the question is
-- under what conditions must the RM Size be used. The following is a list
-- of the occasions on which the RM Size must be used:
-- Component size for packed arrays or records
-- Value of the attribute Size for a type
-- Warning about sizes not matching for unchecked conversion
-- The RM_Size field keeps track of the RM Size as needed in these
-- three situations.
-- For types other than discrete and fixed-point types, the Object_Size
-- and Value_Size are the same (and equivalent to the RM attribute Size).
-- Only Size may be specified for such types.
-----------------------
-- Entity Attributes --
-----------------------
-- This section contains a complete list of the attributes that are defined
-- on entities. Some attributes apply to all entities, others only to certain
-- kinds of entities. In the latter case the attribute should only be set or
-- accessed if the Ekind field indicates an appropriate entity.
-- There are two kinds of attributes that apply to entities, stored and
-- synthesized. Stored attributes correspond to a field or flag in the entity
-- itself. Such attributes are identified in the table below by giving the
-- field or flag in the attribute that is used to hold the attribute value.
-- Synthesized attributes are not stored directly, but are rather computed as
-- needed from other attributes, or from information in the tree. These are
-- marked "synthesized" in the table below. The stored attributes have both
-- access functions and set procedures to set the corresponding values, while
-- synthesized attributes have only access functions.
-- Note: in the case of Node, Uint, or Elist fields, there are cases where
-- the same physical field is used for different purposes in different
-- entities, so these access functions should only be referenced for the
-- class of entities in which they are defined as being present. Flags are
-- not overlapped in this way, but nevertheless as a matter of style and
-- abstraction (which may or may not be checked by assertions in the body),
-- this restriction should be observed for flag fields as well.
-- Note: certain of the attributes on types apply only to base types, and
-- are so noted by the notation [base type only]. These are cases where the
-- attribute of any subtype is the same as the attribute of the base type.
-- The attribute can be referenced on a subtype (and automatically retrieves
-- the value from the base type). However, it is an error to try to set the
-- attribute on other than the base type, and if assertions are enabled,
-- an attempt to set the attribute on a subtype will raise an assert error.
-- Other attributes are noted as applying the implementation base type only.
-- These are representation attributes which must always apply to a full
-- non-private type, and where the attributes are always on the full type.
-- The attribute can be referenced on a subtype (and automatically retries
-- the value from the implementation base type). However, it is an error
-- to try to set the attribute on other than the implementation base type,
-- and if assertions are enabled, an attempt to set the attribute on a
-- subtype will raise an assert error.
-- Accept_Address (Elist21)
-- Present in entries. If an accept has a statement sequence, then an
-- address variable is created, which is used to hold the address of the
-- parameters, as passed by the runtime. Accept_Address holds an element
-- list which represents a stack of entities for these address variables.
-- The current entry is the top of the stack, which is the last element
-- on the list. A stack is required to handle the case of nested select
-- statements referencing the same entry.
-- Actual_Subtype (Node17)
-- Present in variables, constants, and formal parameters. This is the
-- subtype imposed by the value of the object, as opposed to its nominal
-- subtype, which is imposed by the declaration. The actual subtype
-- differs from the nominal one when the latter is indefinite (as in the
-- case of an unconstrained formal parameter, or a variable declared
-- with an unconstrained type and an initial value). The nominal subtype
-- is the Etype entry for the entity. The Actual_Subtype field is set
-- only if the actual subtype differs from the nominal subtype. If the
-- actual and nominal subtypes are the same, then the Actual_Subtype
-- field is Empty, and Etype indicates both types.
--
-- For objects, the Actual_Subtype is set only if this is a discriminated
-- type. For arrays, the bounds of the expression are obtained and the
-- Etype of the object is directly the constrained subtype. This is
-- rather irregular, and the semantic checks that depend on the nominal
-- subtype being unconstrained use flag Is_Constr_Subt_For_U_Nominal(qv).
-- Access_Disp_Table (Node16) [implementation base type only]
-- Present in record type entities. For a tagged type, points to the
-- dispatch table associated with the tagged type. For a non-tagged
-- record, contains Empty.
-- Address_Clause (synthesized)
-- Applies to entries, objects and subprograms. Set if an address clause
-- is present which references the object or subprogram and points to
-- the N_Attribute_Definition_Clause node. Empty if no Address clause.
-- The expression in the address clause is always a constant that is
-- defined before the entity to which the address clause applies.
-- Note: Gigi references this field in E_Task_Type entities???
-- Address_Taken (Flag104)
-- Present in all entities. Set if the Address or Unrestricted_Access
-- attribute is applied directly to the entity, i.e. the entity is the
-- entity of the prefix of the attribute reference. Used by Gigi to
-- make sure that the address can be meaningfully taken.
-- Alias (Node18)
-- Present in overloaded entities (literals, subprograms, entries).
-- Points to parent subprogram of a derived subprogram. Also used for
-- a subprogram renaming, where it points to the renamed subprogram.
-- Always empty for entries.
-- Alignment (Uint14)
-- Present in entities for types and also in constants, variables,
-- loop parameters, and formal parameters. This indicates the desired
-- alignment for a type, or the actual alignment for an object. A value
-- of zero (Uint_0) indicates that the alignment has not been set yet.
-- The alignment can be set by an explicit alignment clause, or set by
-- the front-end in package Layout, or set by the back-end as part of
-- the back end back-annotation process. The alignment field is also
-- present in E_Exception entities, but there it is used only by the
-- back-end for back annotation.
-- Alignment_Clause (synthesized)
-- Appllies to all entities for types and objects. If an alignment
-- attribute definition clause is present for the entity, then this
-- function returns the N_Attribute_Definition clause that specifies the
-- alignment. If no alignment clause applies to the type, then the call
-- to this function returns Empty. Note that the call can return a
-- non-Empty value even if Has_Alignment_Clause is not set (happens with
-- subtype and derived type declarations). Note also that a record
-- definition clause with an (obsolescent) mod clause is converted
-- into an attribute definition clause for this purpose.
-- Ancestor_Subtype (synthesized)
-- Applies to all type and subtype entities. If the argument is a
-- subtype then it returns the subtype or type from which the subtype
-- was obtained, otherwise it returns Empty.
-- Associated_Formal_Package (Node12)
-- Present in packages that are the actuals of formal_packages. Points
-- to the entity in the declaration for the formal package.
-- Associated_Node_For_Itype (Node8)
-- Present in all type and subtype entities. Set non-Empty only for
-- Itypes. Set to point to the associated node for the Itype, i.e.
-- the node whose elaboration generated the Itype. This is used for
-- copying trees, to determine whether or not to copy an Itype.
-- Associated_Storage_Pool (Node22) [root type only]
-- Present in simple and general access type entities. References the
-- storage pool to be used for the corresponding collection. A value of
-- Empty means that the default pool is to be used. This is present
-- only in the root type, since derived types must have the same pool
-- as the parent type.
-- Associated_Final_Chain (Node23)
-- Present in simple and general access type entities. References the
-- List_Controller object that holds the finalization chain on which
-- are attached dynamically allocated objects referenced by the access
-- type. Empty when the access type cannot reference a controlled object.
-- Barrier_Function (Node12)
-- Present in protected entries and entry families. This is the
-- subprogram declaration for the body of the function that returns
-- the value of the entry barrier.
-- Base_Type (synthesized)
-- Applies to all type entities. Returns the base type of a type or
-- subtype. The base type of a type is the type itself. The base type
-- of a subtype is the type that it constrains (which is always a type
-- entity, not some other subtype). Note that in the case of a subtype
-- of a private type, it is possible for the base type attribute to
-- return a private type, even if the subtype to which it applies is
-- non-private. See also Implementation_Base_Type. Note: it is allowed
-- to apply Base_Type to other than a type, in which case it simply
-- returns the entity unchanged.
-- Block_Node (Node11)
-- Present in block entities. Points to the identifier in the
-- Block_Statement itself. Used when retrieving the block construct
-- for finalization purposes, The block entity has an implicit label
-- declaration in the enclosing declarative part, and has otherwise
-- no direct connection in the tree with the block statement. The
-- link is to the identifier (which is an occurence of the entity)
-- and not to the block_statement itself, because the statement may
-- be rewritten, e.g. in the process of removing dead code.
-- Body_Entity (Node19)
-- Present in package and generic package entities, points to the
-- corresponding package body entity if one is present.
-- Body_Needed_For_SAL (Flag40)
-- Present in package and subprogram entities that are compilation
-- units. Indicates that the source for the body must be included
-- when the unit is part of a standalone library.
-- C_Pass_By_Copy (Flag125) [implementation base type only]
-- Present in record types. Set if a pragma Convention for the record
-- type specifies convention C_Pass_By_Copy. This convention name is
-- treated as identical in all respects to convention C, except that
-- if it is specified for a record type, then the C_Pass_By_Copy flag
-- is set, and if a foreign convention subprogram has a formal of the
-- corresponding type, then the parameter passing mechanism will be
-- set to By_Copy (unless specifically overridden by an Import or
-- Export pragma).
-- Can_Never_Be_Null (Flag38)
-- This flag is present in all entities, but can only be set in an
-- object which can never have a null value. This is used to avoid
-- unncessary resetting of the Is_Known_Non_Null flag for such
-- entities. The cases where this is set True are constant access
-- values initialized to a non-null value, and access parameters.
-- Chars (Name1)
-- Present in all entities. This field contains an entry into the names
-- table that has the character string of the identifier, character
-- literal or operator symbol. See Namet for further details. Note that
-- throughout the processing of the front end, this name is the simple
-- unqualified name. However, just before gigi is called, a call is made
-- to Qualify_All_Entity_Names. This causes entity names to be qualified
-- using the encoding described in exp_dbug.ads, and from that point on
-- (including post gigi steps such as cross-reference generation), the
-- entities will contain the encoded qualified names.
-- Checks_May_Be_Suppressed (Flag31)
-- Present in all entities. Set if a pragma Suppress or Unsuppress
-- mentions the entity specifically in the second argument. If this
-- flag is set the the Global_Entity_Suppress and Local_Entity_Suppress
-- tables must be consulted to determine if the is actually an active
-- Suppress or Unsuppress pragma that applies to the entity.
-- Class_Wide_Type (Node9)
-- Present in all type entities. For a tagged type or subtype, returns
-- the corresponding implicitly declared class-wide type. Set to Empty
-- for non-tagged types.
-- Cloned_Subtype (Node16)
-- Present in E_Record_Subtype and E_Class_Wide_Subtype entities.
-- Each such entity can either have a Discriminant_Constraint, in
-- which case it represents a distinct type from the base type (and
-- will have a list of components and discrimants in the list headed by
-- First_Entity) or else no such constraint, in which case it will be a
-- copy of the base type.
--
-- o Each element of the list in First_Entity is copied from the base
-- type; in that case, this field is Empty.
--
-- o The list in First_Entity is shared with the base type; in that
-- case, this field points to that entity.
--
-- A record or classwide subtype may also be a copy of some other
-- subtype and share the entities in the First_Entity with that subtype.
-- In that case, this field points to that subtype.
--
-- For E_Class_Wide_Subtype, the presence of Equivalent_Type overrides
-- this field. Note that this field ONLY appears in subtype entries, not
-- in type entries, it is not present, and it is an error to reference
-- Cloned_Subtype in an E_Record_Type or E_Class_Wide_Type entity.
-- Comes_From_Source
-- This flag appears on all nodes, including entities, and indicates
-- that the node was created by the scanner or parser from the original
-- source. Thus for entities, it indicates that the entity is defined
-- in the original source program.
-- Component_Alignment (special field) [base type only]
-- Present in array and record entities. Contains a value of type
-- Component_Alignment_Kind indicating the alignment of components.
-- Set to Calign_Default normally, but can be overridden by use of
-- the Component_Alignment pragma. Note: this field is currently
-- stored in a non-standard way, see body for details.
-- Component_Bit_Offset (Uint11)
-- Present in record components (E_Component, E_Discriminant) if a
-- component clause applies to the component. First bit position of
-- given component, computed from the first bit and position values
-- given in the component clause. A value of No_Uint means that the
-- value is not yet known. The value can be set by the appearence of
-- an explicit component clause in a record representation clause,
-- or it can be set by the front-end in package Layout, or it can be
-- set by the backend. By the time backend processing is completed,
-- this field is always set. A negative value is used to represent
-- a value which is not known at compile time, and must be computed
-- at run-time (this happens if fields of a record have variable
-- lengths). See package Layout for details of these values.
--
-- Note: this field is obsolescent, to be eventually replaced entirely
-- by Normalized_First_Bit and Normalized_Position, but for the moment,
-- gigi is still using (and back annotating) this field, and gigi does
-- not know about the new fields. For the front end layout case, the
-- Component_Bit_Offset field is only set if it is static, and otherwise
-- the new Normalized_First_Bit and Normalized_Position fields are used.
-- Component_Clause (Node13)
-- Present in record components and discriminants. If a record
-- representation clause is present for the corresponding record
-- type a that specifies a position for the component, then the
-- Component_Clause field of the E_Component entity points to the
-- N_Component_Clause node. Set to Empty if no record representation
-- clause was present, or if there was no specification for this
-- component.
-- Component_Size (Uint22) [implementation base type only]
-- Present in array types. It contains the component size value for
-- the array. A value of zero means that the value is not yet set.
-- The value can be set by the use of a component size clause, or
-- by the front end in package Layout, or by the backend. A negative
-- value is used to represent a value which is not known at compile
-- time, and must be computed at run-time (this happens if the type
-- of the component has a variable length size). See package Layout
-- for details of these values.
-- Component_Type (Node20) [implementation base type only]
-- Present in array types and string types. References component type.
-- Constant_Value (synthesized)
-- Applies to variables, constants, named integers, and named reals.
-- Obtains the initialization expression for the entity. Will return
-- Empty for for a deferred constant whose full view is not available
-- or in some other cases of internal entities, which cannot be treated
-- as constants from the point of view of constant folding. Empty is
-- also returned for variables with no initialization expression.
-- Corresponding_Concurrent_Type (Node18)
-- Present in record types that are constructed by the expander to
-- represent task and protected types (Is_Concurrent_Record_Type flag
-- set True). Points to the entity for the corresponding task type or
-- protected type.
-- Corresponding_Discriminant (Node19)
-- Present in discriminants of a derived type, when the discriminant is
-- used to constrain a discriminant of the parent type. Points to the
-- corresponding discriminant in the parent type. Otherwise it is Empty.
-- Corresponding_Equality (Node13)
-- Present in function entities for implicit inequality operators.
-- Denotes the explicit or derived equality operation that creates
-- the implicit inequality. Note that this field is not present in
-- other function entities, only in implicit inequality routines,
-- where Comes_From_Source is always False.
-- Corresponding_Record_Type (Node18)
-- Present in protected and task types and subtypes. References the
-- entity for the corresponding record type constructed by the expander
-- (see Exp_Ch9). This type is used to represent values of the task type.
-- Corresponding_Remote_Type (Node22)
-- Present in record types that describe the fat pointer structure for
-- Remote_Access_To_Subrogram types. References the original access type.
-- CR_Discriminant (Node23)
-- Present in discriminants of concurrent types. Denotes the homologous
-- discriminant of the corresponding record type. The CR_Discriminant is
-- created at the same time as the discriminal, and used to replace
-- occurrences of the discriminant within the type declaration.
-- Current_Value (Node9)
-- Present in E_Variable, E_Out_Parameter and E_In_Out_Parameter
-- entities. Set non-Empty if the (constant) current value of the
-- variable is known. This value is valid only for references from
-- the same sequential scope as the entity. The sequential scope
-- of an entity includes the immediate scope and any contained
-- scopes that are package specs, package bodies, or blocks (at
-- any nesting level). For convenience in coding, this field is
-- also present in other object entities (E_Loop_Parameter and
-- E_In_Parameter and E_Constant), but is not used to hold a
-- constant value, since value tracking is not needed in this case.
--
-- Another related use of this field is to record information
-- about the value obtained from an IF statement condition.
-- If the IF/ELSIF condition has the form "[NOT] OBJ RELOP VAL",
-- where OBJ is a reference to an entity with a Current_Value field,
-- RELOP is one of the six relational operators, and VAL is a compile-
-- time known valoue, then the Current_Value field if OBJ is set to
-- point to the N_If_Statement or N_Elsif_Part node of the relevant
-- construct. For more details on this usage, see the procedure
-- Exp_Util.Get_Current_Value_Condition.
-- Debug_Info_Off (Flag166)
-- Present in all entities. Set if a pragma Suppress_Debug_Info applies
-- to the entity, or if internal processing in the compiler determines
-- that suppression of debug information is desirable. Note that this
-- flag is only for use by the front end as part of the processing for
-- determining if Needs_Debug_Info should be set. The back end should
-- always test Needs_Debug_Info, it should never test Debug_Info_Off.
-- Debug_Renaming_Link (Node13)
-- Used to link the enumeration literal of a debug renaming declaration
-- to the renamed entity. See Exp_Dbug.Debug_Renaming_Declaration for
-- details of the use of this field.
-- Declaration_Node (synthesized)
-- Applies to all entities. Returns the tree node for the declaration
-- that declared the entity. Normally this is just the Parent of the
-- entity. One exception arises with child units, where the parent of
-- the entity is a selected component or a defining program unit name.
-- Another exception is that if the entity is an incomplete type that
-- has been completed, then we obtain the declaration node denoted by
-- the full type, i.e. the full type declaration node.
-- Default_Expr_Function (Node21)
-- Present in parameters. It holds the entity of the parameterless
-- function that is built to evaluate the default expression if it is
-- more complex than a simple identifier or literal. For the latter
-- simple cases or if there is no default value, this field is Empty.
-- Default_Expressions_Processed (Flag108)
-- A flag in subprograms (functions, operators, procedures) and in
-- entries and entry families used to indicate that default expressions
-- have been processed and to avoid multiple calls to process the
-- default expressions (see Freeze.Process_Default_Expressions), which
-- would not only waste time, but also generate false error messages.
-- Default_Value (Node20)
-- Present in formal parameters. Points to the node representing the
-- expression for the default value for the parameter. Empty if the
-- parameter has no default value (which is always the case for OUT
-- and IN OUT parameters in the absence of errors).
-- Delay_Cleanups (Flag114)
-- Present in entities that have finalization lists (subprograms
-- blocks, and tasks). Set if there are pending generic body
-- instantiations for the corresponding entity. If this flag is
-- set, then generation of cleanup actions for the corresponding
-- entity must be delayed, since the insertion of the generic body
-- may affect cleanup generation (see Inline for further details).
-- Delay_Subprogram_Descriptors (Flag50)
-- Present in entities for which exception subprogram descriptors
-- are generated (subprograms, package declarations and package
-- bodies). Present if there are pending generic body instantiations
-- for the corresponding entity. If this flag is set, then generation
-- of the subprogram descriptor for the corresponding enities must
-- be delayed, since the insertion of the generic body may add entries
-- to the list of handlers.
--
-- Note: for subprograms, Delay_Subprogram_Descriptors is set if and
-- only if Delay_Cleanups is set. But Delay_Cleanups can be set for a
-- a block (in which case Delay_Subprogram_Descriptors is set for the
-- containing subprogram). In addition Delay_Subprogram_Descriptors is
-- set for a library level package declaration or body which contains
-- delayed instantiations (in this case the descriptor refers to the
-- enclosing elaboration procedure).
-- Delta_Value (Ureal18)
-- Present in fixed and decimal types. Points to a universal real
-- that holds value of delta for the type, as given in the declaration
-- or as inherited by a subtype or derived type.
-- Dependent_Instances (Elist8)
-- Present in packages that are instances. Holds list of instances
-- of inner generics. Used to place freeze nodes for those instances
-- after that of the current one, i.e. after the corresponding generic
-- bodies.
-- Depends_On_Private (Flag14)
-- Present in all type entities. Set if the type is private or if it
-- depends on a private type.
-- Designated_Type (synthesized)
-- Applies to access types. Returns the designated type. Differs
-- from Directly_Designated_Type in that if the access type refers
-- to an incomplete type, and the full type is available, then this
-- full type is returned instead of the incomplete type.
-- Digits_Value (Uint17)
-- Present in floating point types and subtypes and decimal types and
-- subtypes. Contains the Digits value specified in the declaration.
-- Directly_Designated_Type (Node20)
-- Present in access types. This field points to the type that is
-- directly designated by the access type. In the case of an access
-- type to an incomplete type, this field references the incomplete
-- type. Note that in the semantic processing, what is useful in
-- nearly all cases is the full type designated by the access type.
-- The function Designated_Type obtains this full type in the case of
-- access to an incomplete type.
-- Discard_Names (Flag88)
-- Present in types and exception entities. Set if pragma Discard_Names
-- applies to the entity. It is also set for declarative regions and
-- package specs for which a Discard_Names pragma with zero arguments
-- has been encountered. The purpose of setting this flag is to be able
-- to set the Discard_Names attribute on enumeration types declared
-- after the pragma within the same declarative region. This flag is
-- set to False if a Keep_Names pragma appears for an enumeration type.
-- Discriminal (Node17)
-- Present in discriminants (Discriminant formal: GNAT's first
-- coinage). The entity used as a formal parameter that corresponds
-- to a discriminant. See section "Handling of Discriminants" for
-- full details of the use of discriminals.
-- Discriminal_Link (Node10)
-- Present in discriminals (which have an Ekind of E_In_Parameter,
-- or E_Constant), points back to corresponding discriminant.
-- Discriminant_Checking_Func (Node20)
-- Present in components. Points to the defining identifier of the
-- function built by the expander returns a Boolean indicating whether
-- the given record component exists for the current discriminant
-- values.
-- Discriminant_Constraint (Elist21)
-- Present in entities whose Has_Discriminants flag is set (concurrent
-- types, subtypes, record types and subtypes, private types and
-- subtypes, limited private types and subtypes and incomplete types).
-- It is an error to reference the Discriminant_Constraint field if
-- Has_Discriminants is False.
--
-- If the Is_Constrained flag is set, Discriminant_Constraint points
-- to an element list containing the discriminant constraints in the
-- same order in which the discriminants are declared.
--
-- If the Is_Constrained flag is not set but the discriminants of the
-- unconstrained type have default initial values then this field
-- points to an element list giving these default initial values in
-- the same order in which the discriminants are declared. Note that
-- in this case the entity cannot be a tagged record type, because
-- discriminants in this case cannot have defaults.
--
-- If the entity is a tagged record implicit type, then this field is
-- inherited from the first subtype (so that the itype is subtype
-- conformant with its first subtype, which is needed when the first
-- subtype overrides primitive operations inherited by the implicit
-- base type).
--
-- In all other cases Discriminant_Constraint contains the empty
-- Elist (ie it is initialized with a call to New_Elmt_List).
-- Discriminant_Default_Value (Node20)
-- Present in discriminants. Points to the node representing the
-- expression for the default value of the discriminant. Set to
-- Empty if the discriminant has no default value.
-- Discriminant_Number (Uint15)
-- Present in discriminants. Gives the ranking of a discriminant in
-- the list of discriminants of the type, i.e. a sequential integer
-- index starting at 1 and ranging up to Number_Discriminants.
-- DTC_Entity (Node16)
-- Present in function and procedure entities. Set to Empty unless
-- the subprogram is dispatching in which case it references the
-- Dispatch Table pointer Component. That is to say the component _tag
-- for regular Ada tagged types, for CPP_Class types and their
-- descendants this field points to the component entity in the record
-- that is the Vtable pointer for the Vtable containing the entry that
-- references the subprogram.
-- DT_Entry_Count (Uint15)
-- Present in E_Component entities. Only used for component marked
-- Is_Tag. Store the number of entries in the Vtable (or Dispatch Table)
-- DT_Position (Uint15)
-- Present in function and procedure entities which are dispatching
-- (should not be referenced without first checking that flag
-- Is_Dispatching_Operation is True). Contains the offset into
-- the Vtable for the entry that references the subprogram.
-- Ekind (Ekind)
-- Present in all entities. Contains a value of the enumeration type
-- Entity_Kind declared in a subsequent section in this spec.
-- Elaborate_All_Desirable (Flag146)
-- Present in package and subprogram entities, and in generic package
-- and subprogram entities. Set if internal analysis of a client that
-- with's this unit determines that Elaborate_All is desirable, i.e.
-- that there is a possibility that Program_Error may be raised if
-- Elaborate_All conditions cannot be met.
-- Elaboration_Entity (Node13)
-- Present in generic and non-generic package and subprogram
-- entities. This is a boolean entity associated with the unit that
-- is initiallly set to False, and is set True when the unit is
-- elaborated. This is used for two purposes. First, it is used to
-- implement required access before elaboration checks (the flag
-- must be true to call a subprogram at elaboration time). Second,
-- it is used to guard against repeated execution of the generated
-- elaboration code.
--
-- Note that we always allocate this flag, and set this field, but
-- we do not always actually use it. It is only used if it is needed
-- for access-before-elaboration use (see Elaboration_Entity_Required
-- flag) or if either the spec or the body has elaboration code. If
-- neither of these two conditions holds, then the entity is still
-- allocated (since we don't know early enough whether or not there
-- is elaboration code), but is simply not used for any purpose.
-- Elaboration_Entity_Required (Flag174)
-- Present in generics and non-generic package and subprogram
-- entities. Set only if Elaboration_Entity is non-Empty to indicate
-- that the boolean is required to be set even if there is no other
-- elaboration code. This occurs when the Elaboration_Entity flag
-- is used for required access-before-elaboration checking. If the
-- flag is only for preventing multiple execution of the elaboration
-- code, then if there is no other elaboration code, obviously there
-- is no need to set the flag.
-- Enclosing_Dynamic_Scope (synthesized)
-- Appliesa to all entities. Returns the closest dynamic scope in which
-- the entity is declared or Standard_Standard for library-level entities
-- Enclosing_Scope (Node18)
-- Present in labels. Denotes the innermost enclosing construct that
-- contains the label. Identical to the scope of the label, except for
-- labels declared in the body of an accept statement, in which case the
-- entry_name is the Enclosing_Scope. Used to validate goto's within
-- accept statements.
-- Entry_Accepted (Flag152)
-- Present in E_Entry and E_Entry_Family entities. Set if there is
-- at least one accept for this entry in the task body. Used to
-- generate warnings for missing accepts.
-- Entry_Bodies_Array (Node15)
-- Present in protected types for which Has_Entries is true.
-- This is the defining identifier for the array of entry body
-- action procedures and barrier functions used by the runtime to
-- execute the user code associated with each entry.
-- Entry_Cancel_Parameter (Node23)
-- Present in blocks. This only applies to a block statement for
-- which the Is_Asynchronous_Call_Block flag is set. It
-- contains the defining identifier of an object that must be
-- passed to the Cancel_Task_Entry_Call or Cancel_Protected_Entry_Call
-- call in the cleanup handler added to the block by
-- Exp_Ch7.Expand_Cleanup_Actions. This parameter is a Boolean
-- object for task entry calls and a Communications_Block object
-- in the case of protected entry calls. In both cases the objects
-- are declared in outer scopes to this block.
-- Entry_Component (Node11)
-- Present in formal parameters (in, in out and out parameters). Used
-- only for formals of entries. References the corresponding component
-- of the entry parameter record for the entry.
-- Entry_Formal (Node16)
-- Present in components of the record built to correspond to entry
-- parameters. This field points from the component to the formal. It
-- is the back pointer corresponding to Entry_Component.
-- Entry_Index_Constant (Node18)
-- Present in an entry index parameter. This is an identifier that
-- eventually becomes the name of a constant representing the index
-- of the entry family member whose entry body is being executed. Used
-- to expand references to the entry index specification identifier.
-- Entry_Index_Type (synthesized)
-- Applies to an entry family. Denotes Etype of the subtype indication
-- in the entry declaration. Used to resolve the index expression in an
-- accept statement for a member of the family, and in the prefix of
-- 'COUNT when it applies to a family member.
-- Entry_Parameters_Type (Node15)
-- Present in entries. Points to the access-to-record type that is
-- constructed by the expander to hold a reference to the parameter
-- values. This reference is manipulated (as an address) by the
-- tasking runtime. The designated record represents a packaging
-- up of the entry parameters (see Exp_Ch9.Expand_N_Entry_Declaration
-- for further details). Entry_Parameters_Type is Empty if the entry
-- has no parameters.
-- Enumeration_Pos (Uint11)
-- Present in enumeration literals. Contains the position number
-- corresponding to the value of the enumeration literal.
-- Enumeration_Rep (Uint12)
-- Present in enumeration literals. Contains the representation that
-- corresponds to the value of the enumeration literal. Note that
-- this is normally the same as Enumeration_Pos except in the presence
-- of representation clauses, where Pos will still represent the
-- position of the literal within the type and Rep will have be the
-- value given in the representation clause.
-- Enumeration_Rep_Expr (Node22)
-- Present in enumeration literals. Points to the expression in an
-- associated enumeration rep clause that provides the representation
-- value for this literal. Empty if no enumeration rep clause for this
-- literal (or if rep clause does not have an entry for this literal,
-- an error situation). This is also used to catch duplicate entries
-- for the same literal.
-- Enum_Pos_To_Rep (Node23)
-- Present in enumeration types (but not enumeration subtypes). Set to
-- Empty unless the enumeration type has a non-standard representation
-- (i.e. at least one literal has a representation value different from
-- its pos value). In this case, Enum_Pos_To_Rep is the entity for an
-- array constructed when the type is frozen that maps Pos values to
-- corresponding Rep values. The index type of this array is Natural,
-- and the component type is a suitable integer type that holds the
-- full range of representation values.
-- Equivalent_Type (Node18)
-- Present in class wide types and subtypes, access to protected
-- subprogram types, and in exception_types. For a classwide type, it
-- is always Empty. For a class wide subtype, it points to an entity
-- created by the expander which gives Gigi an easily understandable
-- equivalent of the class subtype with a known size (given by an
-- initial value). See Exp_Util.Expand_Class_Wide_Subtype for further
-- details. For E_exception_type, this points to the record containing
-- the data necessary to represent exceptions (for further details, see
-- System.Standard_Library. For access_to_protected subprograms, it
-- denotes a record that holds pointers to the operation and to the
-- protected object. For remote Access_To_Subprogram types, it denotes
-- the record that is the fat pointer representation of an RAST.
-- Esize (Uint12)
-- Present in all types and subtypes, and also for components, constants,
-- and variables. Contains the Object_Size of the type or of the object.
-- A value of zero indicates that the value is not yet known.
--
-- For the case of components where a component clause is present, the
-- value is the value from the component clause, which must be non-
-- negative (but may be zero, which is acceptable for the case of
-- a type with only one possible value). It is also possible for Esize
-- of a component to be set without a component clause present, which
-- means that the component size is specified, but not the position.
-- See also RM_Size and the section on "Handling of Type'Size Values".
-- During gigi processing, the value is back annotated for all zero
-- values, so that after the call to gigi, the value is properly set.
-- Etype (Node5)
-- Present in all entities. Represents the type of the entity, which
-- is itself another entity. For a type entity, points to the parent
-- type for a derived type, or if the type is not derived, points to
-- itself. For a subtype entity, Etype points to the base type. For
-- a class wide type, points to the parent type. For a subprogram or
-- subprogram type, Etype has the return type of a function or is set
-- to Standard_Void_Type to represent a procedure.
-- Exception_Code (Uint22)
-- Present in exception entitites. Set to zero unless either an
-- Import_Exception or Export_Exception pragma applies to the
-- pragma and specifies a Code value. See description of these
-- pragmas for details. Note that this field is relevant only if
-- Is_VMS_Exception is set.
-- Extra_Formal (Node15)
-- Present in formal parameters in the non-generic case. Certain
-- parameters require extra implicit information to be passed
-- (e.g. the flag indicating if an unconstrained variant record
-- argument is constrained, and the accessibility level for
-- access parameters. See description of Extra_Constrained,
-- Extra_Accessibility fields for further details. Extra formal
-- parameters are constructed to represent these values, and
-- chained to the end of the list of formals using the
-- Extra_Formal field (i.e. the Extra_Formal field of the last
-- "real" formal points to the first extra formal, and the
-- Extra_Formal field of each extra formal points to the next
-- one, with Empty indicating the end of the list of extra
-- formals.
-- Extra_Accessibility (Node13)
-- Present in formal parameters in the non-generic case if
-- expansion is active. Normally Empty, but if a parameter is
-- one for which a dynamic accessibility check is required, then
-- an extra formal of type Natural is created (see description
-- of field Extra_Formal), and the Extra_Accessibility field of
-- the formal parameter points to the entity for this extra
-- formal. Also present in variables when compiling receiving
-- stubs. In this case, a non Empty value means that this
-- variable's accessibility depth has been transmitted by the
-- caller and must be retrieved through the entity designed by
-- this field instead of being computed.
-- Extra_Constrained (Node23)
-- Present in formal parameters in the non-generic case if
-- expansion is active. Normally Empty, but if a parameter is
-- one for which a dynamic indication of its constrained status
-- is required, then an extra formal of type Boolean is created
-- (see description of field Extra_Formal), and the
-- Extra_Constrained field of the formal parameter points to the
-- entity for this extra formal. Also present in variables when
-- compiling receiving stubs. In this case, a non empty value
-- means that this variable's constrained status has been
-- transmitted by the caller and must be retrieved through the
-- entity designed by this field instead of being computed.
-- Finalization_Chain_Entity (Node19)
-- Present in scopes which can have finalizable entities (blocks,
-- functions, procedures, tasks, entries). When this field is empty it
-- means that there are no finalization actions to perform on exit of the
-- scope. When this field contains 'Error', it means that no
-- finalization actions should happen at this level and the
-- finalization chain of a parent scope shall be used (??? this is
-- an improper use of 'Error' and should be changed). otherwise it
-- contains an entity of type Finalizable_Ptr that is the head of the
-- list of objects to finalize on exit. See "Finalization Management"
-- section in exp_ch7.adb for more details.
-- Finalize_Storage_Only (Flag158) [base type only]
-- Present in all types. Set on direct controlled types to which a
-- valid Finalize_Storage_Only pragma applies. This flag is also set on
-- composite types when they have at least one controlled component and
-- all their controlled components are Finalize_Storage_Only. It is also
-- inherited by type derivation except for direct controlled types where
-- the Finalize_Storage_Only pragma is required at each level of
-- derivation.
-- First_Component (synthesized)
-- Applies to record types. Returns the first component by following
-- the chain of declared entities for the record until a component
-- is found (one with an Ekind of E_Component). The discriminants are
-- skipped. If the record is null, then Empty is returned.
-- First_Discriminant (synthesized)
-- Applies to types with discriminants. The discriminants are the
-- first entities declared in the type, so normally this is equivalent
-- to First_Entity. The exception arises for tagged types, where the
-- tag itself is prepended to the front of the entity chain, so the
-- First_Discriminant function steps past the tag if it is present.
-- First_Entity (Node17)
-- Present in all entities which act as scopes to which a list of
-- associated entities is attached (blocks, class subtypes and types,
-- entries, functions, loops, packages, procedures, protected objects,
-- record types and subtypes, private types, task types and subtypes).
-- Points to a list of associated entities using the Next_Entity field
-- as a chain pointer with Empty marking the end of the list.
-- First_Formal (synthesized)
-- Applies to subprograms and subprogram types, and also in entries
-- and entry families. Returns first formal of the subprogram or entry.
-- The formals are the first entities declared in a subprogram or in
-- a subprogram type (the designated type of an Access_To_Subprogram
-- definition) or in an entry.
-- First_Index (Node17)
-- Present in array types and subtypes and in string types and subtypes.
-- By introducing implicit subtypes for the index constraints, we have
-- the same structure for constrained and unconstrained arrays, subtype
-- marks and discrete ranges are both represented by a subtype. This
-- function returns the tree node corresponding to an occurrence of the
-- first index (NOT the entity for the type). Subsequent indexes are
-- obtained using Next_Index. Note that this field is present for the
-- case of string literal subtypes, but is always Empty.
-- First_Literal (Node17)
-- Present in all enumeration types, including character and boolean
-- types. This field points to the first enumeration literal entity
-- for the type (i.e. it is set to First (Literals (N)) where N is
-- the enumeration type definition node. A special case occurs with
-- standard character and wide character types, where this field is
-- Empty, since there are no enumeration literal lists in these cases.
-- Note that this field is set in enumeration subtypes, but it still
-- points to the first literal of the base type in this case.
-- First_Optional_Parameter (Node14)
-- Present in (non-generic) function and procedure entities. Set to a
-- non-null value only if a pragma Import_Function, Import_Procedure
-- or Import_Valued_Procedure specifies a First_Optional_Parameter
-- argument, in which case this field points to the parameter entity
-- corresponding to the specified parameter.
-- First_Private_Entity (Node16)
-- Present in all entities containing private parts (packages,
-- protected types and subtypes, task types and subtypes). The
-- entities on the entity chain are in order of declaration, so the
-- entries for private entities are at the end of the chain. This
-- field points to the first entity for the private part. It is
-- Empty if there are no entities declared in the private part or
-- if there is no private part.
-- First_Rep_Item (Node6)
-- Present in all entities. If non-empty, points to a linked list of
-- representation pragmas nodes and representation clause nodes that
-- apply to the entity, linked using Next_Rep_Item, with Empty marking
-- the end of the list. In the case of derived types and subtypes, the
-- new entity inherits the chain at the point of declaration. This
-- means that it is possible to have multiple instances of the same
-- kind of rep item on the chain, in which case it is the first one
-- that applies to the entity.
--
-- For most representation items, the representation information is
-- reflected in other fields and flags in the entity. For example if
-- a record representation clause is present, the component entities
-- reflect the specified information. However, there are some items
-- that are only reflected in the chain. These include:
--
-- Alignment attribute definition clause
-- Machine_Attribute pragma
-- Link_Alias pragma
-- Link-Section pragma
-- Weak_External pragma
--
-- If any of these items are present, then the flag Has_Gigi_Rep_Item
-- is set, indicating that Gigi should search the chain.
--
-- Other representation items are included in the chain so that error
-- messages can easily locate the relevant nodes for posting errors.
-- Note in particular that size clauses are present only for this
-- purpose, and should only be accessed if Has_Size_Clause is set.
-- First_Stored_Discriminant (synthesized)
-- Applies to types with discriminants. Gives the first discriminant
-- stored in the object. In many cases, these are the same as the
-- normal visible discriminants for the type, but in the case of
-- renamed discriminants, this is not always the case.
--
-- For tagged types, and untagged types which are root types or
-- derived types but which do not rename discriminants in their
-- root type, the stored discriminants are the same as the actual
-- discriminants of the type, and hence this function is the same
-- as First_Discriminant.
--
-- For derived non-tagged types that rename discriminants in the root
-- type this is the first of the discriminants that occurr in the
-- root type. To be precise, in this case stored discriminants are
-- entities attached to the entity chain of the derived type which
-- are a copy of the discriminants of the root type. Furthermore their
-- Is_Completely_Hidden flag is set since although they are actually
-- stored in the object, they are not in the set of discriminants that
-- is visble in the type.
--
-- For derived untagged types, stored discriminants are the real
-- discriminants from Gigi's standpoint, i.e. those that will be
-- stored in actual objects of the type.
-- First_Subtype (synthesized)
-- Applies to all types and subtypes. For types, yields the first
-- subtype of the type. For subtypes, yields the first subtype of
-- the base type of the subtype.
-- Freeze_Node (Node7)
-- Present in all entities. If there is an associated freeze node for
-- the entity, this field references this freeze node. If no freeze
-- node is associated with the entity, then this field is Empty. See
-- package Freeze for further details.
-- From_With_Type (Flag159)
-- Present in package and type entities. Indicates that the entity
-- appears in a With_Type clause in the context of some other unit,
-- either as the prefix (which must be a package), or as a type name.
-- The package can only be used to retrieve such a type, and the type
-- can be used only in component declarations and access definitions.
-- The With_Type clause is used to construct mutually recursive
-- types, i.e. record types (Java classes) that hold pointers to each
-- other. If such a type is an access type, it has no explicit freeze
-- node, so that the back-end does not attempt to elaborate it.
-- Currently this flag is also used to implement Ada0Y (AI-50217).
-- It will be renamed to From_Limited_With after removal of the current
-- GNAT with_type clause???
-- Full_View (Node11)
-- Present in all type and subtype entities and in deferred constants.
-- References the entity for the corresponding full type declaration.
-- For all types other than private and incomplete types, this field
-- always contains Empty. See also Underlying_Type.
-- Function_Returns_With_DSP (Flag169)
-- Present in all subprogram entities, and type entities for access
-- to subprogram values. Set True if the function (or referenced
-- function in the case of an access value) returns with using the
-- DSP (depressed stack pointer) approach. This can only be set
-- True if Targparm.Functions_Return_By_DSP_On_Target is True and
-- the function returns a value of a type whose size is not known
-- at compile time.
-- Generic_Homonym (Node11)
-- Present in generic packages. The generic homonym is the entity of
-- a renaming declaration inserted in every generic unit. It is used
-- to resolve the name of a local entity that is given by a qualified
-- name, when the generic entity itself is hidden by a local name.
-- Generic_Renamings (Elist23)
-- Present in package and subprogram instances. Holds mapping that
-- associates generic parameters with the corresponding instances, in
-- those cases where the instance is an entity.
-- Handler_Records (List10)
-- Present in subprogram and package entities. Points to a list of
-- identifiers referencing the handler record entities for the
-- corresponding unit.
-- Has_Aliased_Components (Flag135) [implementation base type only]
-- Present in array type entities. Indicates that the component type
-- of the array is aliased.
-- Has_Alignment_Clause (Flag46)
-- Present in all type entities and objects. Indicates if an alignment
-- clause has been given for the entity. If set, then Alignment_Clause
-- returns the N_Attribute_Definition node for the alignment attribute
-- definition clause. Note that it is possible for this flag to be False
-- even when Alignment_Clause returns non_Empty (this happens in the case
-- of derived type declarations).
-- Has_All_Calls_Remote (Flag79)
-- Present in all library unit entities. Set true if the library unit
-- has an All_Calls_Remote pragma. Note that such entities must also
-- be RCI entities, so the flag Is_Remote_Call_Interface will always
-- be set if this flag is set.
-- Has_Atomic_Components (Flag86) [implementation base type only]
-- Present in all types and objects. Set only for an array type or
-- an array object if a valid pragma Atomic_Components applies to the
-- type or object. Note that in the case of an object, this flag is
-- only set on the object if there was an explicit pragma for the
-- object. In other words, the proper test for whether an object has
-- atomic components is to see if either the object or its base type
-- has this flag set. Note that in the case of a type, the pragma will
-- be chained to the rep item chain of the first subtype in the usual
-- manner.
-- Has_Attach_Handler (synthesized)
-- Applies to record types that are constructed by the expander to
-- represent protected types. Returns True if there is at least one
-- Attach_Handler pragma in the corresponding specification.
-- Has_Biased_Representation (Flag139)
-- Present in discrete types (where it applies to the type'size value),
-- and to objects (both stand-alone and components), where it applies to
-- the size of the object from a size or record component clause. In
-- all cases it indicates that the size in question is smaller than
-- would normally be required, but that the size requirement can be
-- satisfied by using a biased representation, in which stored values
-- have the low bound (Expr_Value (Type_Low_Bound (T)) subtracted to
-- reduce the required size. For example, a type with a range of 1..2
-- takes one bit, using 0 to represent 1 and 1 to represent 2.
--
-- Note that in the object and component cases, the flag is only set
-- if the type is unbiased, but the object specifies a smaller size
-- than the size of the type, forcing biased representation for the
-- object, but the subtype is still an unbiased type.
-- Has_Completion (Flag26)
-- Present in all entities that require a completion (functions,
-- procedures, private types, limited private types, incomplete types,
-- and packages that require a body). Set if the completion has been
-- encountered and analyzed.
-- Has_Completion_In_Body (Flag71)
-- Present in "Taft amendment types" that is to say incomplete types
-- whose full declaration appears in the package body.
-- Has_Complex_Representation (Flag140) [implementation base type only]
-- Present in all type entities. Set only for a record base type to
-- which a valid pragma Complex_Representation applies.
-- Has_Component_Size_Clause (Flag68) [implementation base type only]
-- Present in all type entities. Set if a component size clause is
-- present for the given type. Note that this flag can be False even
-- if Component_Size is non-zero (happens in the case of derived types).
-- Has_Contiguous_Rep (Flag181)
-- Present in enumeration types. True if the type as a representation
-- clause whose entries are successive integers.
-- Has_Controlling_Result (Flag98)
-- Present in E_Function entities. True if The function is a primitive
-- function of a tagged type which can dispatch on result
-- Has_Controlled_Component (Flag43) [base type only]
-- Present in composite type entities. Indicates that the type has a
-- component that either is a controlled type, or itself contains a
-- controlled component (i.e. either Has_Controlled_Component or
-- Is_Controlled is set for at least one component).
-- Has_Convention_Pragma (Flag119)
-- Present in an entity for which a Convention, Import, or Export
-- pragma has been given. Used to prevent more than one such pragma
-- appearing for a given entity (RM B.1(45)).
-- Has_Delayed_Freeze (Flag18)
-- Present in all entities. Set to indicate that an explicit freeze
-- node must be generated for the entity at its freezing point. See
-- separate section ("Delayed Freezing and Elaboration") for details.
-- Has_Discriminants (Flag5)
-- Present in all types and subtypes. For types that are allowed to have
-- discriminants (record types and subtypes, task types and subtypes,
-- protected types and subtypes, private types, limited private types,
-- and incomplete types), indicates if the corresponding type or subtype
-- has a known discriminant part. Always false for all other types.
-- Has_Entries (synthesized)
-- Applies to concurrent types. True if any entries are declared
-- within the task or protected definition for the type.
-- Has_Enumeration_Rep_Clause (Flag66)
-- Present in enumeration types. Set if an enumeration representation
-- clause has been given for this enumeration type. Used to prevent more
-- than one enumeration representation clause for a given type. Note
-- that this does not imply a representation with holes, since the rep
-- clause may merely confirm the default 0..N representation.
-- Has_External_Tag_Rep_Clause (Flag110)
-- Present in tagged types. Set if an external_tag rep. clause has been
-- given for this type. Use to avoid the generation of the default
-- external_tag.
-- Has_Exit (Flag47)
-- Present in loop entities. Set if the loop contains an exit statement.
-- Has_Foreign_Convention (synthesized)
-- Applies to all entities. Determines if the Convention for the
-- entity is a foreign convention (i.e. is other than Convention_Ada,
-- Convention_Intrinsic, Convention_Entry or Convention_Protected).
-- Has_Forward_Instantiation (Flag175)
-- Present in package entities. Set true for packages that contain
-- instantiations of local generic entities, before the corresponding
-- generic body has been seen. If a package has a forward instantiation,
-- we cannot inline subprograms appearing in the same package because
-- the placement requirements of the instance will conflict with the
-- linear elaboration of front-end inlining.
-- Has_Fully_Qualified_Name (Flag173)
-- Present in all entities. Set True if the name in the Chars field
-- has been replaced by the fully qualified name, as used for debug
-- output. See Exp_Dbug for a full description of the use of this
-- flag and also the related flag Has_Qualified_Name.
-- Has_Gigi_Rep_Item (Flag82)
-- This flag is set if the rep item chain (referenced by First_Rep_Item
-- and linked through the Next_Rep_Item chain contains a representation
-- item that needs to be specially processed by Gigi, i.e. one of the
-- following items:
--
-- Machine_Attribute pragma
-- Linker_Alias pragma
-- Linker_Section pragma
-- Weak_External pragma
--
-- If this flag is set, then Gigi should scan the rep item chain to
-- process any of these items that appear. At least one such item will
-- be present.
-- Has_Homonym (Flag56)
-- Present in all entities. Set if an entity has a homonym in the same
-- scope. Used by Gigi to generate unique names for such entities.
-- Has_Interrupt_Handler (synthesized)
-- Applies to all protected type entities. Set if the protected type
-- definition contains at least one procedure to which a pragma
-- Interrupt_Handler applies.
-- Has_Machine_Radix_Clause (Flag83)
-- Present in decimal types and subtypes, set if a Machine_Radix
-- representation clause is present. This flag is used to detect
-- the error of multiple machine radix clauses for a single type.
-- Has_Master_Entity (Flag21)
-- Present in entities that can appear in the scope stack (see spec
-- of Sem). It is set if a task master entity (_master) has been
-- declared and initialized in the corresponding scope.
-- Has_Missing_Return (Flag142)
-- Present in functions and generic functions. Set if there is one or
-- more missing return statements in the function. This is used to
-- control wrapping of the body in Exp_Ch6 to ensure that the program
-- error exeption is correctly raised in this case at runtime.
-- Has_Nested_Block_With_Handler (Flag101)
-- Present in scope entities. Set if there is a nested block within the
-- scope that has an exception handler and the two scopes are in the
-- same procedure. This is used by the backend for controlling certain
-- optimizations to ensure that they are consistent with exceptions.
-- See documentation in Gigi for further details.
-- Has_Non_Standard_Rep (Flag75) [implementation base type only]
-- Present in all type entities. Set when some representation clause
-- or pragma causes the representation of the item to be significantly
-- modified. In this category are changes of small or radix for a
-- fixed-point type, change of component size for an array, and record
-- or enumeration representation clauses, as well as packed pragmas.
-- All other representation clauses (e.g. Size and Alignment clauses)
-- are not considered to be significant since they do not affect
-- stored bit patterns.
-- Has_Object_Size_Clause (Flag172)
-- Present in entities for types and subtypes. Set if an Object_Size
-- clause has been processed for the type Used to prevent multiple
-- Object_Size clauses for a given entity.
-- Has_Per_Object_Constraint (Flag154)
-- Present in E_Component entities, true if the subtype of the
-- component has a per object constraint, i.e. an actual discriminant
-- value of the form T'Access, where T is the enclosing type.
-- Has_Pragma_Controlled (Flag27) [implementation base type only]
-- Present in access type entities. It is set if a pragma Controlled
-- applies to the access type.
-- Has_Pragma_Elaborate_Body (Flag150)
-- Present in all entities. Set in compilation unit entities if a
-- pragma Elaborate_Body applies to the compilation unit.
-- Has_Pragma_Inline (Flag157)
-- Present in all entities. Set for functions and procedures for which
-- a pragma Inline or Inline_Always applies to the subprogram. Note
-- that this flag can be set even if Is_Inlined is not set. This
-- happens for pragma Inline (if Inline_Active is False). In other
-- words, the flag Has_Pragma_Inline represents the formal semantic
-- status, and is used for checking semantic correctness.
-- The flag Is_Inlined indicates whether inlining is actually active
-- for the entity.
-- Has_Pragma_Pack (Flag121) [implementation base type only]
-- Present in all entities. It indicates that a valid pragma Pack was
-- was given for the type. Note that this flag is not inherited by a
-- derived type. See also the Is_Packed flag.
-- Has_Pragma_Pure_Function (Flag179)
-- Present in subprogram entities. It indicates that a valid pragma
-- Pure_Function was given for the entity. In some cases, we need to
-- know that Is_Pure was explicitly set using this pragma.
-- Has_Pragma_Unreferenced (Flag180)
-- Present in all entities. Set if a valid pragma Unreferenced applies
-- to the pragma, indicating that no warning should be given if the
-- entity has no references, but a warning should be given if it is
-- in fact referenced.
-- Has_Primitive_Operations (Flag120) [base type only]
-- Present in all type entities. Set if at least one primitive operation
-- is defined for the type.
-- Has_Private_Ancestor (synthesized)
-- Applies to all type and subtype entities. Returns True if at least
-- one ancestor is private, and otherwise False if there are no private
-- ancestors.
-- Has_Private_Declaration (Flag155)
-- Present in all entities. Returns True if it is the defining entity
-- of a private type declaration or its corresponding full declaration.
-- This flag is thus preserved when the full and the partial views are
-- exchanged, to indicate if a full type declaration is a completion.
-- Used for semantic checks in E.4 (18), and elsewhere.
-- Has_Qualified_Name (Flag161)
-- Present in all entities. Set True if the name in the Chars field
-- has been replaced by its qualified name, as used for debug output.
-- See Exp_Dbug for a full description of qualification requirements.
-- For some entities, the name is the fully qualified name, but there
-- are exceptions. In particular, for local variables in procedures,
-- we do not include the procedure itself or higher scopes. See also
-- the flag Has_Fully_Qualified_Name, which is set if the name does
-- indeed include the fully qualified name.
-- Has_Record_Rep_Clause (Flag65) [implementation base type only]
-- Present in record types. Set if a record representation clause has
-- been given for this record type. Used to prevent more than one such
-- clause for a given record type. Note that this is initially cleared
-- for a derived type, even though the representation is inherited. See
-- also the flag Has_Specified_Layout.
-- Has_Recursive_Call (Flag143)
-- Present in procedures. Set if a direct parameterless recursive call
-- is detected while analyzing the body. Used to activate some error
-- checks for infinite recursion.
-- Has_Size_Clause (Flag29)
-- Present in entities for types and objects. Set if a size clause is
-- present for the entity. Used to prevent multiple Size clauses for a
-- given entity. Note that it is always initially cleared for a derived
-- type, even though the Size for such a type is inherited from a Size
-- clause given for the parent type.
-- Has_Small_Clause (Flag67)
-- Present in ordinary fixed point types (but not subtypes). Indicates
-- that a small clause has been given for the entity. Used to prevent
-- multiple Small clauses for a given entity. Note that it is always
-- initially cleared for a derived type, even though the Small for such
-- a type is inherited from a Small clause given for the parent type.
-- Has_Specified_Layout (Flag100) [implementation base type only]
-- Present in all type entities. Set for a record type or subtype if
-- the record layout has been specified by a record representation
-- clause. Note that this differs from the flag Has_Record_Rep_Clause
-- in that it is inherited by a derived type. Has_Record_Rep_Clause is
-- used to indicate that the type is mentioned explicitly in a record
-- representation clause, and thus is not inherited by a derived type.
-- This flag is always False for non-record types.
-- Has_Storage_Size_Clause (Flag23) [implementation base type only]
-- Present in task types and access types. It is set if a Storage_Size
-- clause is present for the type. Used to prevent multiple clauses for
-- one type. Note that this flag is initially cleared for a derived type
-- even though the Storage_Size for such a type is inherited from a
-- Storage_Size clause given for the parent type. Note that in the case
-- of access types, this flag is present only in the root type, since a
-- storage size clause cannot be given to a derived type.
-- Has_Subprogram_Descriptor (Flag93)
-- This flag is set on entities for which zero-cost exception subprogram
-- descriptors can be generated (subprograms and library level package
-- declarations and bodies). It indicates that a subprogram descriptor
-- has been generated, and is used to suppress generation of multiple
-- descriptors (e.g. when instantiating generic bodies).
-- Has_Task (Flag30) [base type only]
-- Present in all type entities. Set on task types themselves, and also
-- (recursively) on any composite type which has a component for which
-- Has_Task is set. The meaning is that an allocator of such an object
-- must create the required tasks. Note that the flag is not set on
-- access types, even if they designate an object that Has_Task.
-- Has_Unchecked_Union (Flag123) [base type only]
-- Present in all type entities. Set on unchecked unions themselves
-- and (recursively) on any composite type which has a component for
-- which Has_Unchecked_Union is set. The meaning is that a comparison
-- operation for the type is not permitted. Note that the flag is not
-- set on access types, even if they designate an object that has
-- the flag Has_Unchecked_Union set.
-- Has_Unknown_Discriminants (Flag72)
-- Present in all type entities. Types can have unknown discriminants
-- either from their declaration or through type derivation. The use
-- of this flag exactly meets the spec in RM 3.7(26). Note that all
-- class-wide types are considered to have unknown discriminants.
-- Has_Volatile_Components (Flag87) [implementation base type only]
-- Present in all types and objects. Set only for an array type or
-- array object if a valid pragma Volatile_Components or a valid
-- pragma Atomic_Components applies to the type or object. Note that
-- in the case of an object, this flag is only set on the object if
-- there was an explicit pragma for the object. In other words, the
-- proper test for whether an object has volatile components is to
-- see if either the object or its base type has this flag set. Note
-- that in the case of a type the pragma will be chained to the rep
-- item chain of the first subtype in the usual manner.
-- Has_Xref_Entry (Flag182)
-- This flag is set if an entity has an entry in the Xref information
-- generated in ali files. This is true for all source entities in the
-- extended main source file. It is also true of entities in other
-- packages that are referenced directly or indirectly from the main
-- source file (indirect reference occurs when the main source file
-- references an entity with a type reference. See package Lib.Xref
-- for further details).
-- Hiding_Loop_Variable (Node8)
-- Present in variables. Set only if a variable of a discrete type is
-- hidden by a loop variable in the same local scope, in which case
-- the Hiding_Loop_Variable field of the hidden variable points to
-- the E_Loop_Parameter entity doing the hiding. Used in processing
-- warning messages if the hidden variable turns out to be unused
-- or is referenced without being set.
-- Homonym (Node4)
-- Present in all entities. Link for list of entities that have the
-- same source name and that are declared in the same or enclosing
-- scopes. Homonyms in the same scope are overloaded. Used for name
-- resolution and for the generation of debugging information.
-- Implementation_Base_Type (synthesized)
-- Applies to all types. Similar to Base_Type, but never returns a
-- private type when applied to a non-private type. Instead in this
-- case, it always returns the Representation_Type of the base type
-- in this case, so that we still have a concrete type. Note: it is
-- allowed to apply Implementation_Base_Type to other than a type,
-- in which case it simply returns the entity unchanged.
-- In_Package_Body (Flag48)
-- Set on the entity that denotes the package (the defining occurrence
-- of the package declaration) while analyzing and expanding the package
-- body. Reset on completion of analysis/expansion.
-- In_Private_Part (Flag45)
-- Present in package entities. Flag is set to indicate that the
-- private part is being analyzed. The flag is reset at the end of the
-- package declaration.
-- Inner_Instances (Elist23)
-- Present in generic units. Contains element list of units that are
-- instantiated within the given generic. Used to diagnose circular
-- instantiations.
-- Interface_Name (Node21)
-- Present in exceptions, functions, procedures, variables, constants,
-- and packages. Set to Empty unless an export, import, or interface
-- name pragma has explicitly specified an external name, in which
-- case it references an N_String_Literal node for the specified
-- exteral name. In the case of exceptions, the field is set by
-- Import_Exception/Export_Exception (which can be used in OpenVMS
-- versions only). Note that if this field is Empty, and Is_Imported
-- or Is_Exported is set, then the default interface name is the name
-- of the entity, cased in a manner that is appropriate to the system
-- in use. Note that Interface_Name is ignored if an address clause
-- is present (since it is meaningless in this case).
--
-- An additional special case usage of this field is in JGNAT for
-- E_Component and E_Discriminant. JGNAT allows these entities to
-- be imported by specifying pragma Import within a component's
-- containing record definition. This supports interfacing to
-- object fields defined within Java classes, and such pragmas
-- are generated by the jvm2ada binding generator tool whenever
-- it processes classes with public object fields. A pragma Import
-- for a component can define the External_Name of the imported
-- Java field (which is generally needed, because Java names are
-- case sensitive).
--
-- In_Use (Flag8)
-- Present in packages and types. Set when analyzing a use clause for
-- the corresponding entity. Reset at end of corresponding declarative
-- part. The flag on a type is also used to determine the visibility of
-- the primitive operators of the type.
-- Is_Abstract (Flag19)
-- Present in all types, and also for functions and procedures. Set
-- for abstract types and abstract subprograms.
-- Is_Access_Constant (Flag69)
-- Present in access types and subtypes. Indicates that the keyword
-- constant was present in the access type definition.
-- Is_Access_Type (synthesized)
-- Applies to all entities, true for access types and subtypes
-- Is_Aliased (Flag15)
-- Present in objects whose declarations carry the keyword aliased,
-- and on record components that have the keyword.
-- Is_Always_Inlined (synthesized)
-- Present in subprograms. True if there is a pragma Inline_Always for
-- the subprogram.
-- Is_AST_Entry (Flag132)
-- Present in entry entities. Set if a valid pragma AST_Entry applies
-- to the entry. This flag can only be set in OpenVMS versions of GNAT.
-- Note: we also allow the flag to appear in entry families, but given
-- the current implementation of the pragma AST_Entry, this flag will
-- always be False in entry families.
-- Is_Atomic (Flag85)
-- Present in all type entities, and also in constants, components and
-- variables. Set if a pragma Atomic or Shared applies to the entity.
-- In the case of private and incomplete types, this flag is set in
-- both the partial view and the full view.
-- Is_Array_Type (synthesized)
-- Applies to all entities, true for array types and subtypes
-- Is_Asynchronous (Flag81)
-- Present in all type entities and in procedure entities. Set
-- if a pragma Asynchronous applies to the entity.
-- Is_Bit_Packed_Array (Flag122) [implementation base type only]
-- Present in all entities. This flag is set for a packed array
-- type that is bit packed (i.e. the component size is known by the
-- front end and is in the range 1-7, 9-15, 17-31, or 33-63). Is_Packed
-- is always set if Is_Bit_Packed_Array is set, but it is possible for
-- Is_Packed to be set without Is_Bit_Packed_Array for the case of an
-- array having one or more index types that are enumeration types
-- with non-standard enumeration representations.
-- Is_Boolean_Type (synthesized)
-- Applies to all entities, true for boolean types and subtypes,
-- i.e. Standard.Boolean and all types ultimately derived from it.
-- Is_By_Copy_Type (synthesized)
-- Applies to all type entities. Returns true if the entity is
-- a by copy type (RM 6.2(3)).
-- Is_By_Reference_Type (synthesized)
-- Applies to all type entities. True if the type is required to
-- be passed by reference, as defined in (RM 6.2(4-9)).
-- Is_Called (Flag102)
-- Present in subprograms. Returns true if the subprogram is called
-- in the unit being compiled or in a unit in the context. Used for
-- inlining.
-- Is_Character_Type (Flag63)
-- Present in all entities, true for character types and subtypes,
-- i.e. enumeration types that have at least one character literal.
-- Is_Child_Unit (Flag73)
-- Present in all entities. Set only for defining entities of program
-- units that are child units (but False for subunits).
-- Is_Class_Wide_Type (synthesized)
-- Applies to all entities, true for class wide types and subtypes
-- Is_Class_Wide_Equivalent_Type (Flag35)
-- Present in record types and subtypes. Set to True, if the type acts
-- as a class-wide equivalent type, i.e. the Equivalent_Type field of
-- some class-wide subtype entity references this record type.
-- Is_Compilation_Unit (Flag149)
-- Present in all entities. Set if the entity is a package or subprogram
-- entity for a compilation unit other than a subunit (since we treat
-- subunits as part of the same compilation operation as the ultimate
-- parent, we do not consider them to be separate units for this flag).
-- Is_Completely_Hidden (Flag103)
-- A flag set on an E_Discriminant entity. This flag can be set only
-- for girder discriminants of untagged types. When set, the entity
-- is a girder discriminant of a derived untagged type which is not
-- directly visible in the derived type because the derived type or
-- one of its ancestors have renamed the discriminants in the root
-- type. Note that there are girder discriminants which are not
-- Completely_Hidden (e.g. the discriminants of a root type).
-- Is_Composite_Type (synthesized)
-- Applies to all entities, true for all composite types and
-- subtypes. Either Is_Composite_Type or Is_Elementary_Type (but
-- not both) is true of any type.
-- Is_Concurrent_Record_Type (Flag20)
-- Present in record types and subtypes. Set if the type was created
-- by the expander to represent a task or protected type. For every
-- concurrent type, such as record type is constructed, and task and
-- protected objects are instances of this record type at runtime
-- (Gigi will replace declarations of the concurrent type using the
-- declarations of the corresponding record type). See package Exp_Ch9
-- for further details.
-- Is_Concurrent_Type (synthesized)
-- Applies to all entities, true for task types and subtypes and
-- for protected types and subtypes.
-- Is_Constrained (Flag12)
-- Present in types or subtypes which may have index, discriminant
-- or range constraint (i.e. array types and subtypes, record types
-- and subtypes, string types and subtypes, and all numeric types).
-- Set if the type or subtype is constrained.
-- Is_Constr_Subt_For_U_Nominal (Flag80)
-- Present in all types and subtypes. Set true only for the constructed
-- subtype of an object whose nominal subtype is unconstrained. Note
-- that the constructed subtype itself will be constrained.
-- Is_Constr_Subt_For_UN_Aliased (Flag141)
-- This flag can only be set if Is_Constr_Subt_For_U_Nominal is set. It
-- indicates that in addition the object concerned is aliased. This flag
-- is used by Gigi to determine whether a template must be constructed.
-- Is_Constructor (Flag76)
-- Present in function and procedure entities. Set if a pragma
-- CPP_Constructor applies to the subprogram.
-- Is_Controlled (Flag42) [base type only]
-- Present in all type entities. Indicates that the type is controlled,
-- i.e. is either a descendant of Ada.Finalization.Controlled or of
-- Ada.Finalization.Limited_Controlled.
-- Is_Controlling_Formal (Flag97)
-- Present in all Formal_Kind entity. Marks the controlling parameters
-- of dispatching operations.
-- Is_CPP_Class (Flag74)
-- Present in all type entities, set only for tagged and untagged
-- record types to which the pragma CPP_Class has been applied.
-- Is_Decimal_Fixed_Point_Type (synthesized)
-- Applies to all type entities, true for decimal fixed point
-- types and subtypes.
-- Is_Derived_Type (synthesized)
-- Applies to all type entities. Determine if given entity is a
-- derived type
-- Is_Discrete_Type (synthesized)
-- Applies to all entities, true for all discrete types and subtypes
-- Is_Discrete__Or_Fixed_Point_Type (synthesized)
-- Applies to all entities, true for all discrete types and subtypes
-- and all fixed-point types and subtypes.
-- Is_Discrim_SO_Function (Flag176)
-- Present in all entities, set only in E_Function entities that Layout
-- creates to compute discriminant-dependent dynamic size/offset values.
-- Is_Dispatching_Operation (Flag6)
-- Present in all entities. Set true for procedures, functions,
-- generic procedures and generic functions if the corresponding
-- operation is dispatching.
-- Is_Dynamic_Scope (synthesized)
-- Applies to all Entities. Returns True if the entity is a dynamic
-- scope (i.e. a block, a subprogram a task_type or an entry).
-- Is_Elementary_Type (synthesized)
-- Applies to all entities, true for all elementary types and
-- subtypes. Either Is_Composite_Type or Is_Elementary_Type (but
-- not both) is true of any type.
-- Is_Eliminated (Flag124)
-- Present in type entities, subprogram entities, and object entities.
-- Indicates that the corresponding entity has been eliminated by use
-- of pragma Eliminate. Also used to mark subprogram entities whose
-- declaration and body are within unreachable code that is removed.
-- Is_Enumeration_Type (synthesized)
-- Present in all entities, true for enumeration types and subtypes
-- Is_Entry (synthesized)
-- Applies to all entities, True only for entry and entry family
-- entities and False for all other entity kinds.
-- Is_Entry_Formal (Flag52)
-- Present in all entities. Set only for entry formals (which can
-- only be in, in-out or out parameters). This flag is used to speed
-- up the test for the need to replace references in Exp_Ch2.
-- Is_Exported (Flag99)
-- Present in all entities. Set if the entity is exported. For now we
-- only allow the export of constants, exceptions, functions, procedures
-- and variables, but that may well change later on. Exceptions can only
-- be exported in the OpenVMS and Java VM implementations of GNAT.
-- Is_First_Subtype (Flag70)
-- Present in all entities. True for first subtypes (RM 3.2.1(6)),
-- i.e. the entity in the type declaration that introduced the type.
-- This may be the base type itself (e.g. for record declarations and
-- enumeration type declarations), or it may be the first subtype of
-- an anonymous base type (e.g. for integer type declarations or
-- constrained array declarations).
-- Is_Fixed_Point_Type (synthesized)
-- Applies to all entities, true for decimal and ordinary fixed
-- point types and subtypes
-- Is_Floating_Point_Type (synthesized)
-- Applies to all entities, true for float types and subtypes
-- Is_Formal (synthesized)
-- Applies to all entities, true for IN, IN OUT and OUT parameters
-- Is_Formal_Subprogram (Flag111)
-- Defined on all entities, true for generic formal subprograms.
-- Is_For_Access_Subtype (Flag118)
-- Present in E_Private_Subtype and E_Record_Subtype entities.
-- Means the sole purpose of the type is to be designated by an
-- Access_Subtype and hence should not be expanded into components
-- because the type may not have been found or frozen yet.
-- Is_Frozen (Flag4)
-- Present in all type entities. Set if the type has been frozen.
-- Is_Generic_Actual_Type (Flag94)
-- Present in the subtype declaration that renames the generic formal
-- as a subtype of the actual. Guarantees that the subtype is not static
-- within the instance.
-- Is_Generic_Instance (Flag130)
-- Present in all entities. Set to indicate that the entity is an
-- instance of a generic unit.
-- Is_Generic_Subprogram (synthesized)
-- Applies to all entities. Yields True for a generic subprogram
-- (generic function, generic subprogram), False for all other entities.
-- Is_Generic_Type (Flag13)
-- Present in all types and subtypes. Set for types which are generic
-- formal types. Such types have an Ekind that corresponds to their
-- classification, so the Ekind cannot be used to identify generic types.
-- Is_Generic_Unit (synthesized)
-- Applies to all entities. Yields True for a generic unit (generic
-- package, generic function, generic procedure), and False for all
-- other entities.
-- Is_Hidden (Flag57)
-- Present in all entities. Set true for all entities declared in the
-- private part or body of a package. Also marks generic formals of a
-- formal package declared without a box. For library level entities,
-- this flag is set if the entity is not publicly visible.
-- Is_Hidden_Open_Scope (Flag171)
-- Present in all entities. Set true for a scope that contains the
-- instantiation of a child unit, and whose entities are not visible
-- during analysis of the instance.
-- Is_Immediately_Visible (Flag7)
-- Present in all entities. Set if entity is immediately visible, i.e.
-- is defined in some currently open scope (RM 8.3(4)).
-- Is_Imported (Flag24)
-- Present in all entities. Set if the entity is imported. For now we
-- only allow the import of exceptions, functions, procedures, packages.
-- and variables. Exceptions can only be imported in the OpenVMS and
-- Java VM implementations of GNAT. Packages and types can only be
-- imported in the Java VM implementation.
-- Is_Incomplete_Or_Private_Type (synthesized)
-- Applies to all entities, true for private and incomplete types
-- Is_Indefinite_Subtype (synthesized)
-- Applies to all entities for types and subtypes. Determines if given
-- entity is an unconstrained array type or subtype, a discriminated
-- record type or subtype with no initial discriminant values or a
-- class wide type or subtype.
-- Is_Inlined (Flag11)
-- Present in all entities. Set for functions and procedures which are
-- to be inlined. For subprograms created during expansion, this flag
-- may be set directly by the expander to request inlining. Also set
-- for packages that contain inlined subprograms, whose bodies must be
-- be compiled. Is_Inlined is also set on generic subprograms and is
-- inherited by their instances. It is also set on the body entities
-- of inlined subprograms. See also Has_Pragma_Inline.
-- Is_Instantiated (Flag126)
-- Present in generic packages and generic subprograms. Set if the unit
-- is instantiated from somewhere in the extended main source unit. This
-- flag is used to control warnings about the unit being uninstantiated.
-- Also set in a package that is used as an actual for a generic package
-- formal in an instantiation. Also set on a parent instance, in the
-- instantiation of a child, which is implicitly declared in the parent.
-- Is_Integer_Type (synthesized)
-- Applies to all entities, true for integer types and subtypes
-- Is_Internal (Flag17)
-- Present in all entities. Set to indicate an entity created during
-- semantic processing (e.g. an implicit type). Need more documentation
-- on this one! ???
-- Is_Interrupt_Handler (Flag89)
-- Present in procedures. Set if a pragma Interrupt_Handler applies
-- to the procedure. The procedure must be parameterless, and on all
-- targets except AAMP it must be a protected procedure.
-- Is_Intrinsic_Subprogram (Flag64)
-- Present in functions and procedures. It is set if a valid pragma
-- Interface or Import is present for this subprogram specifying pragma
-- Intrinsic. Valid means that the name and profile of the subprogram
-- match the requirements of one of the recognized intrinsic subprograms
-- (see package Sem_Intr for details). Note: the value of Convention for
-- such an entity will be set to Convention_Intrinsic, but it is the
-- setting of Is_Intrinsic_Subprogram, NOT simply having convention set
-- to intrinsic, which causes intrinsic code to be generated.
-- Is_Itype (Flag91)
-- Present in all entities, set for Itypes. If it is set, then the
-- declaration for the type does not appear explicitly in the tree.
-- Instead gigi will elaborate the type when it is first used.
-- Has_Delayed_Freeze can be set for Itypes, and the meaning is that
-- the first use (the one which causes the type to be defined) will
-- be the freeze node. Note that an important restriction on Itypes
-- is that the first use of such a type (the one that causes it to be
-- defined) must be in the same scope as the type.
-- Is_Known_Non_Null (Flag37)
-- Present in all entities. Relevant (and can be set True) only for
-- objects of an access type. It is set if the object is currently
-- known to have a non-null value (meaning that no access checks
-- are needed). The indication can for eample3 come from assignment
-- of an access parameter or an allocator.
--
-- Note: this flag is set according to the sequential flow of the
-- program, watching the current value of the variable. However,
-- this processing can cases of changing the value of an aliased
-- or constant object, so even if this flag is set, it should not
-- be believed if the variable is aliased or volatile. It would
-- be a little neater to avoid the flag being set in the first
-- place in such cases, but that's trickier, and there is only
-- one place that tests the value anyway.
--
-- The flag is dynamically set and reset as semantic analysis and
-- expansion proceeds. Its value is meaningless once the tree is
-- fully constructed, since it simply indicates the last state.
-- Thus this flag has no meaning to the back end.
-- Is_Known_Valid (Flag170)
-- Present in all entities. Relevant for types (and subtype) and
-- for objects (and enumeration literals) of a discrete type.
--
-- The purpose of this flag is to implement the requirement stated
-- in (RM 13.9.1(9-11)) which require that the use of possibly invalid
-- values may not cause programs to become erroneous. See the function
-- Exp_Util.Expr_Known_Valid for further details. Note that the setting
-- is conservative, in the sense that if the flag is set, it must be
-- right. If the flag is not set, nothing is known about the validity.
--
-- For enumeration literals, the flag is always set, since clearly
-- an enumeration literal represents a valid value. Range checks
-- where necessary will ensure that this valid value is appropriate.
--
-- For objects, the flag indicates the state of knowledge about the
-- current value of the object. This may be modified during expansion,
-- and thus the final value is not relevant to gigi.
--
-- For types and subtypes, the flag is set if all possible bit patterns
-- of length Object_Size (i.e. Esize of the type) represent valid values
-- of the type. In general for such tytpes, all values are valid, the
-- only exception being the case where an object of the type has an
-- explicit size that is greater than Object_Size.
--
-- For non-discrete objects, the setting of the Is_Known_Valid flag is
-- not defined, and is not relevant, since the considerations of the
-- requirement in (RM 13.9.1(9-11)) do not apply.
--
-- The flag is dynamically set and reset as semantic analysis and
-- expansion proceeds. Its value is meaningless once the tree is
-- fully constructed, since it simply indicates the last state.
-- Thus this flag has no meaning to the back end.
-- Is_Limited_Composite (Flag106)
-- Present in all entities. True for composite types that have a
-- limited component. Used to enforce the rule that operations on
-- the composite type that depend on the full view of the component
-- do not become visible until the immediate scope of the composite
-- type itself (RM 7.3.1 (5)).
-- Is_Limited_Record (Flag25)
-- Present in all entities. Set to true for record (sub)types if the
-- record is declared to be limited. Note that this flag is not set
-- simply because some components of the record are limited.
-- Is_Limited_Type (synthesized)
-- Applies to all entities. True if entity is a limited type (limited
-- private type, task type, protected type, composite containing a
-- limited component, or a subtype of any of these types).
-- Is_Machine_Code_Subprogram (Flag137)
-- Present in subprogram entities. Set to indicate that the subprogram
-- is a machine code subprogram (i.e. its body includes at least one
-- code statement). Also indicates that all necessary semantic checks
-- as required by RM 13.8(3) have been performed.
-- Is_Modular_Integer_Type (synthesized)
-- Applies to all entities. True if entity is a modular integer type
-- Is_Non_Static_Subtype (Flag109)
-- This flag is present in all type and subtype entities. It is set in
-- some (but not all) cases in which a subtype is known to be non-static.
-- Before this flag was added, the computation of whether a subtype was
-- static was entirely synthesized, by looking at the bounds, and the
-- immediate subtype parent. However, this method does not work for some
-- Itypes that have no parent set (and the only way to find the immediate
-- subtype parent is to go through the tree). For now, this flay is set
-- conservatively, i.e. if it is set then for sure the subtype is non-
-- static, but if it is not set, then the type may or may not be static.
-- Thus the test for a static subtype is that this flag is clear AND
-- that the bounds are static AND that the parent subtype (if available
-- to be tested) is static. Eventually we should make sure this flag
-- is always set right, at which point, these comments can be removed,
-- and the tests for static subtypes greatly simplified.
-- Is_Null_Init_Proc (Flag178)
-- Present in procedure entities. Set for generated init proc procedures
-- (used to initialize composite types), if the code for the procedure
-- is null (i.e. is a return and nothing else). Such null initialization
-- procedures are generated in case some client is compiled using the
-- Initialize_Scalars pragma, generating a call to this null procedure,
-- but there is no need to call such procedures within a compilation
-- unit, and this flag is used to suppress such calls.
-- Is_Numeric_Type (synthesized)
-- Applies to all entities, true for all numeric types and subtypes
-- (integer, fixed, float).
-- Is_Object (synthesized)
-- Applies to all entities, true for entities representing objects,
-- including generic formal parameters.
-- Is_Optional_Parameter (Flag134)
-- Present in parameter entities. Set if the parameter is specified as
-- optional by use of a First_Optional_Parameter argument to one of the
-- extended Import pragmas. Can only be set for OpenVMS versions of GNAT.
-- Is_Ordinary_Fixed_Point_Type (synthesized)
-- Applies to all entities, true for ordinary fixed point types
-- and subtypes
-- Is_Overriding_Operation (Flag39)
-- Present in subprograms. Set if the subprogram is a primitive
-- operation of a derived type, that overrides an inherited operation.
-- Is_Package (synthesized)
-- Applies to all entities. True for packages and generic packages.
-- False for all other entities.
-- Is_Package_Body_Entity (Flag160)
-- Present in all entities. Set for entities defined at the top level
-- of a package body. Used to control externally generated names.
-- Is_Packed (Flag51) [implementation base type only]
-- Present in all type entities. This flag is set only for record and
-- array types which have a packed representation. There are three
-- cases which cause packing:
--
-- 1. Explicit use of pragma Pack for an array of package components
-- 2. Explicit use of pragma Pack to pack a record
-- 4. Setting Component_Size of an array to a bit-packable value
-- 3. Indexing an array with a non-standard enumeration type.
--
-- For records, Is_Packed is always set if Has_Pack_Pragma is set,
-- and can also be set on its own in a derived type which inherited
-- its packed status.
--
-- For arrays, Is_Packed is set if an array is bit packed (i.e. the
-- component size is known at compile time and is 1-7, 9-15 or 17-31),
-- or if the array has one or more index types that are enumeration
-- types with non-standard representations (in GNAT, we store such
-- arrays compactly, using the Pos of the enumeration type value).
--
-- As for the case of records, Is_Packed can be set on its own for a
-- derived type, with the same dual before/after freeze meaning.
-- Is_Packed can also be set as the result of an explicit component
-- size clause that specifies an appropriate component size.
--
-- In the bit packed array case, Is_Bit_Packed_Array will be set in
-- the bit packed case once the array type is frozen.
--
-- Before an array type is frozen, Is_Packed will always be set if
-- Has_Pack_Pragma is set. Before the freeze point, it is not possible
-- to know the component size, since the component type is not frozen
-- until the array type is frozen. Thus Is_Packed for an array type
-- before it is frozen means that packed is required. Then if it turns
-- out that the component size is not suitable for bit packing, the
-- Is_Packed flag gets turned off.
-- Is_Packed_Array_Type (Flag138)
-- Present in all entities. This flag is set on the entity for the type
-- used to implement a packed array (either a modular type, or a subtype
-- of Packed_Bytes{1,2,4} as appropriate). The flag is set if and only
-- if the type appears in the Packed_Array_Type field of some other type
-- entity. It is used by Gigi to activate the special processing for such
-- types (unchecked conversions that would not otherwise be allowed are
-- allowed for such types). If the Is_Packed_Array_Type flag is set in
-- an entity, then the Original_Array_Type field of this entity points
-- to the original array type for which this is the packed array type.
-- Is_Potentially_Use_Visible (Flag9)
-- Present in all entities. Set if entity is potentially use visible,
-- i.e. it is defined in a package that appears in a currently active
-- use clause (RM 8.4(8)). Note that potentially use visible entities
-- are not necessarily use visible (RM 8.4(9-11)).
-- Is_Preelaborated (Flag59)
-- Present in all entities, set in E_Package and E_Generic_Package
-- entities to which a pragma Preelaborate is applied, and also in
-- all entities within such packages. Note that the fact that this
-- flag is set does not necesarily mean that no elaboration code is
-- generated for the package.
-- Is_Private_Composite (Flag107)
-- Present in composite types that have a private component. Used to
-- enforce the rule that operations on the composite type that depend
-- on the fulll view of the component, do not become visible until the
-- immediate scope of the composite type itself (7.3.1 (5)). Both this
-- flag and Is_Limited_Composite are needed.
-- Is_Private_Descendant (Flag53)
-- Present in entities that can represent library units (packages,
-- functions, procedures). Set if the library unit is itself a private
-- child unit, or if it is the descendent of a private child unit.
-- Is_Private_Type (synthesized)
-- Applies to all entities, true for private types and subtypes,
-- as well as for record with private types as subtypes
-- Is_Protected_Type (synthesized)
-- Applies to all entities, true for protected types and subtypes
-- Is_Psected (Flag153)
-- Present in entities for objects, true if a valid Psect_Object
-- pragma applies to the object. Used to detect duplicate pragmas.
-- Is_Public (Flag10)
-- Present in all entities. Set to indicate that an entity defined in
-- one compilation unit can be referenced from other compilation units.
-- If this reference causes a reference in the generated variable, for
-- example in the case of a variable name, then Gigi will generate an
-- appropriate external name for use by the linker.
-- Is_Protected_Private (synthesized)
-- Applies to a record component. Returns true if this component
-- is used to represent a private declaration of a protected type.
-- Is_Protected_Record_Type (synthesized)
-- Applies to all entities, true if Is_Concurrent_Record_Type
-- Corresponding_Concurrent_Type is a protected type.
-- Is_Pure (Flag44)
-- Present in all entities. Set in all entities of a unit to which a
-- pragma Pure is applied, and also set for the entity of the unit
-- itself. In addition, this flag may be set for any other functions
-- or procedures that are known to be side effect free, so in the case
-- of subprograms, the Is_Pure flag may be used by the optimizer to
-- imply that it can assume freedom from side effects (other than those
-- resulting from assignment to out parameters, or to objects designated
-- by access parameters).
-- Is_Real_Type (synthesized)
-- Applies to all entities, true for real types and subtypes
-- Is_Record_Type (synthesized)
-- Applies to all entities, true for record types and subtypes,
-- includes class-wide types and subtypes (which are also records)
-- Is_Remote_Call_Interface (Flag62)
-- Present in all entities, set in E_Package and E_Generic_Package
-- entities to which a pragma Remote_Call_Interace is applied, and
-- also in all entities within such packages.
-- Is_Remote_Types (Flag61)
-- Present in all entities, set in E_Package and E_Generic_Package
-- entities to which a pragma Remote_Types is applied, and also in
-- all entities within such packages.
-- Is_Renaming_Of_Object (Flag112)
-- Present in all entities, set only for a variable or constant for
-- which the Renamed_Object field is non-empty and for which the
-- renaming is handled by the front end, by macro substitution of
-- a copy of the (evaluated) name tree whereever the variable is used.
-- Is_Return_By_Reference_Type (synthesized)
-- Applies to all type entities. True if the type is required to
-- be returned by reference, as defined in 6.5(11-16).
-- Is_Scalar_Type (synthesized)
-- Applies to all entities, true for scalar types and subtypes
-- Is_Shared_Passive (Flag60)
-- Present in all entities, set in E_Package and E_Generic_Package
-- entities to which a pragma Shared_Passive is applied, and also in
-- all entities within such packages.
-- Is_Statically_Allocated (Flag28)
-- Present in all entities. This can only be set True for exception,
-- variable, constant, and type/subtype entities. If the flag is set,
-- then the variable or constant must be allocated statically rather
-- than on the local stack frame. For exceptions, the meaning is that
-- the exception data should be allocated statically (and indeed this
-- flag is always set for exceptions, since exceptions do not have
-- local scope). For a type, the meaning is that the type must be
-- elaborated at the global level rather than locally. No type marked
-- with this flag may depend on a local variable, or on any other type
-- which does not also have this flag set to True. For a variable or
-- or constant, if the flag is set, then the type of the object must
-- either be declared at the library level, or it must also have the
-- flag set (since to allocate the oject statically, its type must
-- also be elaborated globally).
-- Is_Subprogram (synthesized)
-- Applies to all entities, true for bodies of functions, procedures
-- and operators.
-- Is_String_Type (synthesized)
-- Applies to all type entities. Determines if the given type is a
-- string type, i.e. it is directly a string type or string subtype,
-- or a string slice type, or an array type with one dimension and a
-- component type that is a character type.
-- Is_Tag (Flag78)
-- Present in E_Component. For regular tagged type this flag is set on
-- the tag component (whose name is Name_uTag) and for CPP_Class tagged
-- types, this flag marks the pointer to the main vtable (i.e. the one
-- to be extended by derivation)
-- Is_Tagged_Type (Flag55)
-- Present in all entities, true for an entity for a tagged type.
-- Is_Task_Record_Type (synthesized)
-- Applies to all entities, true if Is_Concurrent_Record_Type
-- Corresponding_Concurrent_Type is a task type.
-- Is_Task_Type (synthesized)
-- Applies to all entities, true for task types and subtypes
-- Is_Thread_Body (Flag77)
-- Applies to subprogram entities. Set if a valid Thread_Body pragma
-- applies to this subprogram, which is thus a thread body.
-- Is_True_Constant (Flag163)
-- This flag is set in constants and variables which have an initial
-- value specified but which are never assigned, partially or in the
-- whole. For variables, it means that the variable was initialized
-- but never modified, and hence can be treated as a constant by the
-- code generator. For a constant, it means that the constant was not
-- modified by generated code (e.g. to set a discriminant in an init
-- proc). Assignments by user or generated code will reset this flag.
--
-- Note: there is one situation in which the back end does not permit
-- this flag to be set, even if no assignments are generated. This is
-- the case of an object of a record or array type which is initialized
-- with an aggregate, and is itself used as the expression initializing
-- an atomic object, or the right hand side of an assignment to an atomic
-- object. In this case the object must not have Is_True_Constant set,
-- even though no assignments are generated (the reason for this is that
-- the back end must not optimize the object away, because that would
-- violate the restriction on aggregates in these positions).
-- Is_Type (synthesized)
-- Applies to all entities, true for a type entity
-- Is_Unchecked_Union (Flag117)
-- Present in all entities. Set only in record types to which the
-- pragma Unchecked_Union has been validly applied.
-- Is_Unsigned_Type (Flag144)
-- Present in all types, but can be set only for discrete and fixed-point
-- type and subtype entities. This flag is only valid if the entity is
-- frozen. If set it indicates that the representation is known to be
-- unsigned (i.e. that no negative values appear in the range). This is
-- normally just a reflection of the lower bound of the subtype or base
-- type, but there is one case in which the setting is non-obvious,
-- namely the case of an unsigned subtype of a signed type from which
-- a further subtype is obtained using variable bounds. This further
-- subtype is still unsigned, but this cannot be determined by looking
-- at its bounds or the bounds of the corresponding base type.
-- Is_Valued_Procedure (Flag127)
-- Present in procedure entities. Set if an Import_Valued_Procedure
-- or Export_Valued_Procedure pragma applies to the procedure entity.
-- Is_Visible_Child_Unit (Flag116)
-- Present in compilation units that are child units. Once compiled,
-- child units remain chained to the entities in the parent unit, and
-- a separate flag must be used to indicate whether the names are
-- visible by selected notation, or not.
-- Is_VMS_Exception (Flag133)
-- Present in all entities. Set only for exception entities where the
-- exception was specified in an Import_Exception or Export_Exception
-- pragma with the VMS option for Form. See description of these pragmas
-- for details. This flag can only be set in OpenVMS versions of GNAT.
-- Is_Volatile (Flag16)
-- Present in all type entities, and also in constants, components and
-- variables. Set if a pragma Volatile applies to the entity. Also set
-- if pragma Shared or pragma Atomic applies to entity. In the case of
-- private or incomplete types, this flag is set in both the private
-- and full view. The flag is not set reliably on private subtypes,
-- and is always retrieved from the base type (but this is not a base-
-- type-only attribute because it applies to other entities). Note that
-- the back end should use Treat_As_Volatile, rather than Is_Volatile
-- to indicate code generation requirements for volatile variables.
-- Similarly, any front end test which is concerned with suppressing
-- optimizations on volatile objects should test Treat_As_Volatile
-- rather than testing this flag.
-- Is_Wrapper_Package (synthesized)
-- Present in package entities. Indicates that the package has been
-- created as a wrapper for a subprogram instantiation.
-- Kill_Elaboration_Checks (Flag32)
-- Present in all entities. Set by the expander to kill elaboration
-- checks which are known not to be needed. Equivalent in effect to
-- the use of pragma Supress (Elaboration_Checks) for that entity
-- except that the effect is permanent and cannot be undone by a
-- subsequent pragma Unsuppress.
-- Kill_Range_Checks (Flag33)
-- Present in all entities. Set by the expander to kill elaboration
-- checks which are known not to be needed. Equivalent in effect to
-- the use of pragma Supress (Range_Checks) for that entity except
-- that the result is permanent and cannot be undone by a subsequent
-- pragma Unsuppress.
-- Kill_Tag_Checks (Flag34)
-- Present in all entities. Set by the expander to kill elaboration
-- checks which are known not to be needed. Equivalent in effect to
-- the use of pragma Supress (Tag_Checks) for that entity except
-- that the result is permanent and cannot be undone by a subsequent
-- pragma Unsuppress.
-- Last_Entity (Node20)
-- Present in all entities which act as scopes to which a list of
-- associated entities is attached (blocks, class subtypes and types,
-- entries, functions, loops, packages, procedures, protected objects,
-- record types and subtypes, private types, task types and subtypes).
-- Points to a the last entry in the list of associated entities chained
-- through the Next_Entity field. Empty if no entities are chained.
-- Limited_Views (Elist23)
-- Present in non-generic package entities that are not instances.
-- The elements of this list are the shadow entities created for the
-- types and local packages that are declared in a package that appears
-- in a limited_with clause (Ada0Y: AI-50217)
-- Lit_Indexes (Node15)
-- Present in enumeration types and subtypes. Non-empty only for the
-- case of an enumeration root type, where it contains the entity for
-- the generated indexes entity. See unit Exp_Imgv for full details of
-- the nature and use of this entity for implkementing the Image and
-- Value attributes for the enumeration type in question.
--
-- Lit_Strings (Node16)
-- Present in enumeration types and subtypes. Non-empty only for the
-- case of an enumeration root type, where it contains the entity for
-- the literals string entity. See unit Exp_Imgv for full details of
-- the nature and use of this entity for implementing the Image and
-- Value attributes for the enumeration type in question.
-- Machine_Radix_10 (Flag84)
-- Present in decimal types and subtypes, set if the Machine_Radix
-- is 10, as the result of the specification of a machine radix
-- representation clause. Note that it is possible for this flag
-- to be set without having Has_Machine_Radix_Clause True. This
-- happens when a type is derived from a type with a clause present.
-- Master_Id (Node17)
-- Present in access types and subtypes. Empty unless Has_Task is
-- set for the designated type, in which case it points to the entity
-- for the Master_Id for the access type master.
-- Materialize_Entity (Flag168)
-- Present in all entities. Set only for constant or renamed entities
-- which should be materialized for debugging purposes. In the case of
-- a constant, a memory location should be allocated containing the
-- value. In the case of a renaming, a memory location containing the
-- renamed address should be allocated.
-- Mechanism (Uint8) (returned as Mechanism_Type)
-- Present in functions and non-generic formal parameters. Indicates
-- the mechanism to be used for the function return or for the formal
-- parameter. See separate section on passing mechanisms. This field
-- is also set (to the default value of zero) in a subprogram body
-- entity but not used in this context.
-- Modulus (Uint17) [base type only]
-- Present in modular types. Contains the modulus. For the binary
-- case, this will be a power of 2, but if Non_Binary_Modulus is
-- set, then it will not be a power of 2.
-- Needs_Debug_Info (Flag147)
-- Present in all entities. Set if the entity requires debugging
-- information to be generated. This is true of all entities that
-- have Comes_From_Source set, and also transitively for entities
-- associated with such components (e.g. their types). It is true
-- for all entities in Debug_Generated_Code mode (-gnatD switch).
-- This is the flag that the back end should check to determine
-- whether or not to generate debugging information for an entity.
-- Needs_No_Actuals (Flag22)
-- Present in callable entities (subprograms, entries, access to
-- subprograms) which can be called without actuals because all of
-- their formals (if any) have default values. This flag simplifies the
-- resolution of the syntactic ambiguity involving a call to these
-- entities when the return type is an array type, and a call can be
-- interpreted as an indexing of the result of the call. It is also
-- used to resolve various cases of entry calls.
-- Never_Set_In_Source (Flag115)
-- Present in all entities, but relevant only for variables and
-- parameters. This flag is set if the object is never assigned
-- a value in user source code, either by assignment or by the
-- use of an initial value, or by some other means.
-- This flag is only for the purposes of issuing warnings, it must not
-- be used by the code generator to indicate that the variable is in
-- fact a constant, since some assignments in generated code do not
-- count (for example, the call to an init proc to assign some but
-- not all of the fields in a partially initialized record). The code
-- generator should instead use the flag Is_True_Constant.
--
-- For the purposes of this warning, the default assignment of
-- access variables to null is not considered the assignment of
-- of a value (so the warning can be given for code that relies
-- on this initial null value, when no other value is ever set).
--
-- In variables and out parameters, if this flag is set after full
-- processing of the corresponding declarative unit, it indicates that
-- the variable or parameter was never set, and a warning message can
-- be issued.
--
-- Note: this flag is initially set, and then cleared on encountering
-- any construct that might conceivably legitimately set the value.
-- Thus during the analysis of a declarative region and its associated
-- statement sequence, the meaning of the flag is "not set yet", and
-- once this analysis is complete the flag means "never assigned".
-- Note: for variables appearing in package declarations, this flag
-- is never set. That is because there is no way to tell if some
-- client modifies the variable (or in the case of variables in the
-- private part, if some child unit modifies the variables).
-- Note: in the case of renamed objects, the flag must be set in the
-- ultimate renamed object. Clients noting a possible modification
-- should use the Note_Possible_Modification procedure in Sem_Util
-- rather than Set_Never_Set_In_Source precisely to deal properly with
-- the renaming possibility.
-- Next_Component (synthesized)
-- Applies to record components. Returns the next component by
-- following the chain of declared entities until one is found which
-- corresponds to a component (Ekind is E_Component). Any internal types
-- generated from the subtype indications of the record components are
-- skipped. Returns Empty if no more components.
-- Next_Discriminant (synthesized)
-- Applies to discriminants returned by First/Next_Discriminant.
-- Returns the next language-defined (ie: perhaps non-girder)
-- discriminant by following the chain of declared entities as long as
-- the kind of the entity corresponds to a discriminant. Note that the
-- discriminants might be the only components of the record.
-- Returns Empty if there are no more.
-- Next_Entity (Node2)
-- Present in all entities. The entities of a scope are chained, with
-- the head of the list being in the First_Entity field of the scope
-- entity. All entities use the Next_Entity field as a forward pointer
-- for this list, with Empty indicating the end of the list. Since this
-- field is in the base part of the entity, the access routines for this
-- field are in Sinfo.
-- Next_Formal (synthesized)
-- Applies to the entity for a formal parameter. Returns the next
-- formal parameter of the subprogram or subprogram type. Returns
-- Empty if there are no more formals.
-- Next_Formal_With_Extras (synthesized)
-- Applies to the entity for a formal parameter. Returns the next
-- formal parameter of the subprogram or subprogram type. Returns
-- Empty if there are no more formals. The list returned includes
-- all the extra formals (see description of Extra_Formal field)
-- Next_Girder_Discriminant (synthesized)
-- Applies to discriminants. Set only for a discriminant returned by
-- a call to First/Next_Girder_Discriminant. Returns next girder
-- discriminant, if there are more (see complete description in
-- First_Girder_Discriminant), or Empty if there are no more.
-- Next_Index (synthesized)
-- Applies to array types and subtypes and to string types and
-- subtypes. Yields the next index. The first index is obtained by
-- using the First_Index attribute, and then subsequent indexes are
-- obtained by applying Next_Index to the previous index. Empty is
-- returned to indicate that there are no more indexes. Note that
-- unlike most attributes in this package, Next_Index applies to
-- nodes for the indexes, not to entities.
-- Next_Inlined_Subprogram (Node12)
-- Present in subprograms. Used to chain inlined subprograms used in
-- the current compilation, in the order in which they must be compiled
-- by Gigi to insure that all inlinings are performed.
-- Next_Literal (synthesized)
-- Applies to enumeration literals, returns the next literal, or
-- Empty if applied to the last literal. This is actually a synonym
-- for Next, but its use is preferred in this context.
-- Non_Binary_Modulus (Flag58) [base type only]
-- Present in modular integer types. Set if the modulus for the type
-- is other than a power of 2.
-- Non_Limited_View (Node17)
-- Present in incomplete types that are the shadow entities created
-- when analyzing a limited_with_clause (Ada0Y: AI-50217). Points to
-- the defining entity in the original declaration.
-- Nonzero_Is_True (Flag162) [base type only]
-- Present in enumeration types. True if any non-zero value is to be
-- interpreted as true. Currently this is set true for derived Boolean
-- types which have a convention of C, C++ or Fortran.
-- No_Pool_Assigned (Flag131) [root type only]
-- Present in access types. Set if a storage size clause applies to
-- the variable with a compile time known value of zero. This flag is
-- used to generate warnings if any attempt is made to allocate or free
-- an instance of such an access type. This is set only in the root
-- type, since derived types must have the same pool.
-- No_Return (Flag113)
-- Present in procedure and generic procedure entries. Indicates that
-- a pragma No_Return applies to the procedure.
-- Normalized_First_Bit (Uint8)
-- Present in components and discriminants. Indicates the normalized
-- value of First_Bit for the component, i.e. the offset within the
-- lowest addressed storage unit containing part or all of the field.
-- Set to No_Uint if no first bit position is assigned yet.
-- Normalized_Position (Uint14)
-- Present in components and discriminants. Indicates the normalized
-- value of Position for the component, i.e. the offset in storage
-- units from the start of the record to the lowest addressed storage
-- unit containing part or all of the field.
-- Normalized_Position_Max (Uint10)
-- Present in components and discriminants. For almost all cases, this
-- is the same as Normalized_Position. The one exception is for the case
-- of a discriminated record containing one or more arrays whose length
-- depends on discriminants. In this case, the Normalized_Position_Max
-- field represents the maximum possible value of Normalized_Position
-- assuming min/max values for discriminant subscripts in all fields.
-- This is used by Layout in front end layout mode to properly computed
-- the maximum size such records (needed for allocation purposes when
-- there are default discriminants, and also for the 'Size value).
-- Number_Dimensions (synthesized)
-- Applies to array types and subtypes. Returns the number of dimensions
-- of the array type or subtype as a value of type Pos.
-- Number_Discriminants (synthesized)
-- Applies to all types with discriminants. Yields the number of
-- discriminants as a value of type Pos.
-- Number_Entries (synthesized)
-- Applies to concurrent types. Returns the number of entries that are
-- declared within the task or protected definition for the type.
-- Number_Formals (synthesized)
-- Applies to subprograms and subprogram types. Yields the number of
-- formals as a value of type Pos.
-- Original_Array_Type (Node21)
-- Present in modular types and array types and subtypes. Set only
-- if the Is_Packed_Array_Type flag is set, indicating that the type
-- is the implementation type for a packed array, and in this case it
-- points to the original array type for which this is the packed
-- array implementation type.
-- Object_Ref (Node17)
-- Present in protected bodies. This is an implicit prival for the
-- Protection object associated with a protected object. See Prival
-- for further details on the use of privals.
-- Original_Record_Component (Node22)
-- Present in components, including discriminants. The usage depends
-- on whether the record is a base type and whether it is tagged.
--
-- In base tagged types:
-- When the component is inherited in a record extension, it points
-- to the original component (the entity of the ancestor component
-- which is not itself inherited) otherwise it points to itself.
-- Gigi uses this attribute to implement the automatic dereference in
-- the extension and to apply the transformation:
--
-- Rec_Ext.Comp -> Rec_Ext.Parent. ... .Parent.Comp
--
-- In base non-tagged types:
-- Always points to itself except for non-girder discriminants, where
-- it points to the girder discriminant it renames.
--
-- In subtypes (tagged and untagged):
-- Points to the component in the base type.
-- Packed_Array_Type (Node23)
-- Present in array types and subtypes, including the string literal
-- subtype case, if the corresponding type is packed (either bit packed
-- or packed to eliminate holes in non-contiguous enumeration type
-- index types). References the type used to represent the packed array,
-- which is either a modular type for short static arrays, or an
-- array of System.Unsigned. Note that in some situations (internal
-- types, and references to fields of variant records), it is not
-- always possible to construct this type in advance of its use. If
-- Packed_Array_Type is empty, then the necessary type is declared
-- on the fly for each reference to the array.
-- Parameter_Mode (synthesized)
-- Applies to formal parameter entities. This is a synonym for Ekind,
-- used when obtaining the formal kind of a formal parameter (the result
-- is one of E_[In/Out/In_Out]_Paramter)
-- Parent_Subtype (Node19)
-- Present in E_Record_Type. Points to the subtype to use for a
-- field that references the parent record.
-- Primitive_Operations (Elist15)
-- Present in tagged record types and subtypes and in tagged private
-- types. Points to an element list of entities for primitive operations
-- for the tagged type. Not present (and not set) in untagged types (it
-- is an error to reference the primitive operations field of a type
-- that is not tagged).
-- Private_Dependents (Elist18)
-- Present in private (sub)types. Records the subtypes of the
-- private type, derivations from it, and records and arrays
-- with components dependent on the type.
--
-- The subtypes are traversed when installing and deinstalling
-- (the full view of) a private type in order to ensure correct
-- view of the subtypes.
--
-- Used in similar fashion for incomplete types: holds list of subtypes
-- of these incomplete types that have discriminant constraints. The
-- full views of these subtypes are constructed when the full view of
-- the incomplete type is processed.
-- In addition, if the incomplete type is the designated type in an
-- access definition for an access parameter, the operation may be
-- a dispatching primitive operation, which is only known when the full
-- declaration of the type is seen. Subprograms that have such an
-- access parameter are also placed in the list of private_dependents.
-- Prival (Node17)
-- Present in components. Used for representing private declarations
-- of protected objects (private formal: by analogy to Discriminal_Link).
-- Empty unless the synthesized Is_Protected_Private attribute is
-- true. The entity used as a formal parameter that corresponds to
-- the to the private declaration in protected operations. See
-- "Private data in protected objects" for details.
-- Privals_Chain (Elist23)
-- Present in protected operations (subprograms and entries). Links
-- all occurrences of the Privals in the body of the operation, in
-- order to patch their types at the end of their expansion. See
-- "Private data in protected objects" for details.
-- Private_View (Node22)
-- For each private type, three entities are allocated, the private view,
-- the full view, and the shadow entity. The shadow entity contains a
-- copy of the private view and is used for restoring the proper private
-- view after a region in which the full view is visible (and is copied
-- into the entity normally used for the private view during this period
-- of visibility). The Private_View field is self-referential when the
-- private view lives in its normal entity, but in the copy that is made
-- in the shadow entity, it points to the proper location in which to
-- restore the private view saved in the shadow.
-- Protected_Formal (Node22)
-- Present in formal parameters (in, in out and out parameters). Used
-- only for formals of protected operations. References corresponding
-- formal parameter in the unprotected version of the operation that
-- is created during expansion.
-- Protected_Body_Subprogram (Node11)
-- Present in protected operations. References the entity for the
-- subprogram which implements the body of the operation.
-- Protected_Operation (Node23)
-- Present in components. Used for representing private declarations
-- of protected objects. Empty unless the synthesized attribute
-- Is_Protected_Private is True. This is the entity corresponding
-- to the body of the protected operation currently being analyzed,
-- and which will eventually use the current Prival associated with
-- this component to refer to the renaming of a private object
-- component. As soon as the expander generates this renaming, this
-- attribute is changed to refer to the next protected subprogram.
-- See "Private data in protected objects" for details.
-- Reachable (Flag49)
-- Present in labels. The flag is set over the range of statements in
-- which a goto to that label is legal.
-- Referenced (Flag156)
-- Present in all entities, set if the entity is referenced, except
-- for the case of an appearence of a simple variable that is not a
-- renaming, as the left side of an assignment in which case the flag
-- Referenced_As_LHS is set instead.
-- Referenced_As_LHS (Flag36): This flag is set instead of
-- Referenced if a simple variable that is not a renaming appears as
-- the left side of an assignment. The reason we distinguish this kind
-- of reference is that we have a separate warning for variables that
-- are only assigned and never read.
-- Referenced_Object (Node10)
-- Present in all type entities. Set non-Empty only for type entities
-- constructed for unconstrained objects, or objects that depend on
-- discriminants. Points to the expression from which the actual
-- subtype of the object can be evaluated.
-- Register_Exception_Call (Node20)
-- Present in exception entities. When an exception is declared,
-- a call is expanded to Register_Exception. This field points to
-- the expanded N_Procedure_Call_Statement node for this call. It
-- is used for Import/Export_Exception processing to modify the
-- register call to make appropriate entries in the special tables
-- used for handling these pragmas at runtime.
-- Related_Array_Object (Node19)
-- Present in array types and subtypes. Used only for the base type
-- and subtype created for an anonymous array object. Set to point
-- to the entity of the corresponding array object. Currently used
-- only for type-related error messages.
-- Related_Instance (Node15)
-- Present in the wrapper packages created for subprogram instances.
-- The internal subprogram that implements the instance is inside the
-- wrapper package, but for debugging purposes its external symbol
-- must correspond to the name and scope of the related instance.
-- Renamed_Entity (Node18)
-- Present in exceptions, packages and generic units that are defined
-- by a renaming declaration. Denotes the renamed entity, or transit-
-- itively the ultimate renamed entity if there is a chain of renaming
-- declarations.
-- Renamed_Object (Node18)
-- Present in all objects (constants, variables, components, formal
-- parameters, generic formal parameters, and loop parameters). Set
-- non-Empty if the object was declared by a renaming declaration, in
-- which case it references the tree node for the name of the renamed
-- object. This is only possible for the variable and constant cases.
-- For formal parameters, this field is used in the course of inline
-- expansion, to map the formals of a subprogram into the corresponding
-- actuals. For formals of a task entry, it denotes the local renaming
-- that replaces the actual within the accept statement.
-- The field is Empty otherwise.
-- Renaming_Map (Uint9)
-- Present in generic subprograms, generic packages, and their
-- instances. Also present in the instances of the corresponding
-- bodies. Denotes the renaming map (generic entities => instance
-- entities) used to construct the instance by givin an index into
-- the tables used to represent these maps. See Sem_Ch12 for further
-- details. The maps for package instances are also used when the
-- instance is the actual corresponding to a formal package.
-- Return_Present (Flag54)
-- Present in function and generic function entities. Set if the
-- function contains a return statement (used for error checking).
-- This flag can also be set in procedure and generic procedure
-- entities (for convenience in setting it), but is only tested
-- for the function case.
-- Returns_By_Ref (Flag90)
-- Present in function entities, to indicate that the function
-- returns the result by reference, either because its return typ is a
-- by-reference-type or because it uses explicitly the secondary stack.
-- Reverse_Bit_Order (Flag164) [base type only]
-- Present in all record type entities. Set if a valid pragma an
-- attribute represention clause for Bit_Order has reversed the order
-- of bits from the default value. When this flag is set, a component
-- clause must specify a set of bits entirely contained in a single
-- storage unit.
-- RM_Size (Uint13)
-- Present in all type and subtype entities. Contains the value of
-- type'Size as defined in the RM. See also the Esize field and
-- and the description on "Handling of Type'Size Values". A value
-- of zero in this field for a non-discrete type means that
-- the front end has not yet determined the size value. For the
-- case of a discrete type, this field is always set by the front
-- end and zero is a legitimate value for a type with one value.
-- Root_Type (synthesized)
-- Applies to all type entities. For class-wide types, return the root
-- type of the class covered by the CW type, otherwise returns the
-- ultimate derivation ancestor of the given type. This function
-- preserves the view, i.e. the Root_Type of a partial view is the
-- partial view of the ulimate ancestor, the Root_Type of a full view
-- is the full view of the ultimate ancestor. Note that this function
-- does not correspond exactly to the use of root type in the RM, since
-- in the RM root type applies to a class of types, not to a type.
-- Scalar_Range (Node20)
-- Present in all scalar types (including modular types, where the
-- bounds are 0 .. modulus - 1). References a node in the tree that
-- contains the bounds for the range. Note that this information
-- could be obtained by rummaging around the tree, but it is more
-- convenient to have it immediately at hand in the entity. The
-- contents of Scalar_Range can either be an N_Subtype_Indication
-- node (with a constraint), or a Range node, but not a simple
-- subtype reference (a subtype is converted into a range).
-- Scale_Value (Uint15)
-- Present in decimal fixed-point types and subtypes. Contains the scale
-- for the type (i.e. the value of type'Scale = the number of decimal
-- digits after the decimal point).
-- Scope (Node3)
-- Present in all entities. Points to the entity for the scope (block,
-- loop, subprogram, package etc.) in which the entity is declared.
-- Since this field is in the base part of the entity node, the access
-- routines for this field are in Sinfo.
-- Scope_Depth (synth)
-- Applies to program units, blocks, concurrent types and entries,
-- and also to record types, i.e. to any entity that can appear on
-- the scope stack. Yields the scope depth value, which for those
-- entities other than records is simply the scope depth value,
-- for record entities, it is the Scope_Depth of the record scope.
-- Scope_Depth_Value (Uint22)
-- Present in program units, blocks, concurrent types and entries.
-- Indicates the number of scopes that statically enclose the
-- declaration of the unit or type. Library units have a depth of zero.
-- Note that record types can act as scopes but do NOT have this field
-- set (see Scope_Depth above)
-- Scope_Depth_Set (synthesized)
-- Applies to a special predicate function that returns a Boolean value
-- indicating whether or not the Scope_Depth field has been set. It
-- is needed, since returns an invalid value in this case!
-- Sec_Stack_Needed_For_Return (Flag167)
-- Present in scope entities (blocks,functions, procedures, tasks,
-- entries). Set to True when secondary stack is used to hold
-- the returned value of a function and thus should not be
-- released on scope exit.
-- Shadow_Entities (List14)
-- Present in package and generic package entities. Points to a list
-- of entities that correspond to private types. For each private type
-- a shadow entity is created that holds a copy of the private view.
-- In regions of the program where the full views of these private
-- entities are visible, the full view is copied into the entity that
-- is normally used to hold the private view, but the shadow entity
-- copy is unchanged. The shadow entities are then used to restore the
-- original private views at the end of the region. This list is a
-- standard format list (i.e. First (Shadow_Entities) is the first
-- entry and subsequent entries are obtained using Next.
-- Shared_Var_Assign_Proc (Node22)
-- Present in variables. Set non-Empty only if Is_Shared_Passive is
-- set, in which case this is the entity for the shared memory assign
-- routine. See Exp_Smem for full details.
-- Shared_Var_Read_Proc (Node15)
-- Present in variables. Set non-Empty only if Is_Shared_Passive is
-- set, in which case this is the entity for the shared memory read
-- routine. See Exp_Smem for full details.
-- Size_Check_Code (Node19)
-- Present in constants and variables. Normally Empty. Set if code is
-- generated to check the size of the object. This field is used to
-- suppress this code if a subsequent address clause is encountered.
-- Size_Clause (synthesized)
-- Applies to all entities. If a size clause is present in the rep
-- item chain for an entity then the attribute definition clause node
-- for the size clause is returned. Otherwise Size_Clause returns Empty
-- if no item is present. Usually this is only meaningful if the flag
-- Has_Size_Clause is set. This is because when the representation item
-- chain is copied for a derived type, it can inherit a size clause that
-- is not applicable to the entity.
-- Size_Depends_On_Discriminant (Flag177)
-- Present in all entities for types and subtypes. Indicates that the
-- size of the type depends on the value of one or more discriminants.
-- Currently, this flag is only set in front end layout mode for arrays
-- which have one or more bounds depending on a discriminant value.
-- Size_Known_At_Compile_Time (Flag92)
-- Present in all entities for types and subtypes. Indicates that the
-- size of objects of the type is known at compile time. This flag is
-- used to optimize some generated code sequences, and also to enable
-- some error checks (e.g. disallowing component clauses on variable
-- length objects. It is set conservatively (i.e. if it is True, the
-- size is certainly known at compile time, if it is False, then the
-- size may or may not be known at compile time, but the code will
-- assume that it is not known).
-- Small_Value (Ureal21)
-- Present in fixed point types. Points to the universal real for the
-- Small of the type, either as given in a representation clause, or
-- as computed (as a power of two) by the compiler.
-- Spec_Entity (Node19)
-- Present in package body entities. Points to corresponding package
-- spec entity. Also present in subprogram body parameters in the
-- case where there is a separate spec, where this field references
-- the corresponding parameter entities in the spec.
-- Storage_Size_Variable (Node15) [implementation base type only]
-- Present in access types and task type entities. This flag is set
-- if a valid and effective pragma Storage_Size applies to the base
-- type. Points to the entity for a variable that is created to
-- hold the value given in a Storage_Size pragma for an access
-- collection or a task type. Note that in the access type case,
-- this field is present only in the root type (since derived types
-- share the same storage pool).
-- Stored_Constraint (Elist23)
-- Present in entities that can have discriminants (concurrent types
-- subtypes, record types and subtypes, private types and subtypes,
-- limited private types and subtypes and incomplete types). Points
-- to an element list containing the expressions for each of the
-- stored discriminants for the record (sub)type.
-- Strict_Alignment (Flag145) [implementation base type only]
-- Present in all type entities. Indicates that some containing part
-- is either aliased or tagged. This prohibits packing the object
-- tighter than its natural size and alignment.
-- String_Literal_Length (Uint16)
-- Present in string literal subtypes (which are created to correspond
-- to string literals in the program). Contains the length of the string
-- literal.
-- String_Literal_Low_Bound (Node15)
-- Present in string literal subtypes (which are created to correspond
-- to string literals in the program). Contains an expression whose
-- value represents the low bound of the literal. This is a copy of
-- the low bound of the applicable index constraint if there is one,
-- or a copy of the low bound of the index base type if not.
-- Suppress_Elaboration_Warnings (Flag148)
-- Present in all entities, relevant only for subprogram entities. If
-- this flag is set then Sem_Elab will not generate elaboration warnings
-- for the subprogram. Suppression of such warnings is automatic for
-- subprograms for which elaboration checks are suppressed (without the
-- need to set this flag), but the flag is also set for various internal
-- entities (such as init procs) which are known not to generate any
-- possible access before elaboration. (we need a clear description of
-- how this flag differs in effect from Elaboration_Checks_Suppressed???)
-- Suppress_Init_Proc (Flag105) [base type only]
-- Present in all type entities. Set to suppress the generation of
-- initialization procedures where they are known to be not needed.
-- For example, the enumeration image table entity uses this flag.
-- Suppress_Style_Checks (Flag165)
-- Present in all entities. Suppresses any style checks specifically
-- associated with the given entity if set.
-- Tag_Component (synthesized)
-- Applies to tagged record types, returns the entity for the _Tag
-- field in this record, which must be present.
-- Treat_As_Volatile (Flag41)
-- Present in all type entities, and also in constants, components and
-- variables. Set if this entity is to be treated as volatile for code
-- generation purposes. Always set if Is_Volatile is set, but can also
-- be set as a result of situations (such as address overlays) where
-- the front end wishes to force volatile handling to inhibit aliasing
-- optimization which might be legally ok, but is undesirable. Note
-- that the back end always tests this flag rather than Is_Volatile.
-- The front end tests Is_Volatile if it is concerned with legality
-- checks associated with declared volatile variables, but if the test
-- is for the purposes of suppressing optimizations, then the front
-- end should test Treat_As_Volatile rather than Is_Volatile.
-- Type_High_Bound (synthesized)
-- Applies to scalar types. Returns the tree node (Node_Id) that
-- contains the high bound of a scalar type. The returned value is a
-- literal for a base type, but may be an expression in the case of a
-- scalar type with dynamic bounds. Note that in the case of a fixed
-- point type, the high bound is in units of small, and is an integer.
-- Type_Low_Bound (synthesized)
-- Applies to scalar types. Returns the tree node (Node_Id) that
-- contains the low bound of a scalar type. The returned value is a
-- literal for a base type, but may be an expression in the case of a
-- scalar type with dynamic bounds. Note that in the case of a fixed
-- point type, the low bound is in units of small, and is an integer.
-- Underlying_Full_View (Node19)
-- Present in private subtypes that are the completion of other private
-- types, or in private types that are derived from private subtypes.
-- If the full view of a private type T is derived from another
-- private type with discriminants Td, the full view of T is also
-- private, and there is no way to attach to it a further full view that
-- would convey the structure of T to the back end. The Underlying_Full_
-- View is an attribute of the full view that is a subtype of Td with
-- the same constraint as the declaration for T. The declaration for this
-- subtype is built at the point of the declaration of T, either as a
-- completion, or as a subtype declaration where the base type is private
-- and has a private completion. If Td is already constrained, then its
-- full view can serve directly as the full view of T.
-- Underlying_Type (synthesized)
-- Applies to all entities. This is the identity function except in
-- the case where it is applied to an incomplete or private type,
-- in which case it is the underlying type of the type declared by
-- the completion, or Empty if the completion has not yet been
-- encountered and analyzed.
--
-- Note: the reason this attribute applies to all entities, and not
-- just types, is to legitimize code where Underlying_Type is applied
-- to an entity which may or may not be a type, with the intent that
-- if it is a type, its underlying type is taken.
-- Unset_Reference (Node16)
-- Present in variables and out parameters. This is normally Empty.
-- It is set to point to an identifier that represents a reference
-- to the entity before any value has been set. Only the first such
-- reference is identified. This field is used to generate a warning
-- message if necessary (see Sem_Warn.Check_Unset_Reference).
-- Uses_Sec_Stack (Flag95)
-- Present in scope entities (blocks,functions, procedures, tasks,
-- entries). Set to True when secondary stack is used in this scope and
-- must be released on exit unless Sec_Stack_Needed_For_Return is set.
-- Vax_Float (Flag151) [base type only]
-- Present in all type entities. Set only on the base type of float
-- types with Vax format. The particular format is determined by the
-- Digits_Value value which is 6,9,15 for F_Float, D_Float, G_Float.
-- Warnings_Off (Flag96)
-- Present in all entities. Set if a pragma Warnings (Off, entity-name)
-- is used to suppress warnings for a given entity. It is also used by
-- the compiler in some situations to kill spurious warnings.
------------------
-- Access Kinds --
------------------
-- The following three entity kinds are introduced by the corresponding
-- type definitions:
-- E_Access_Type, E_General_Access_Type, E_Anonymous_Access_Type.
-- In addition, we define the kind E_Allocator_Type to label
-- allocators. This is because special resolution rules apply to this
-- construct. Eventually the constructs are labeled with the access
-- type imposed by the context. Gigi should never see the type
-- E_Allocator.
-- Similarly, the type E_Access_Attribute_Type is used as the initial
-- kind associated with an access attribute. After resolution a specific
-- access type will be established as determined by the context.
-- Finally, the type Any_Access is used to label -null- during type
-- resolution. Any_Access is also replaced by the context type after
-- resolution.
--------------------------------
-- Classification of Entities --
--------------------------------
-- The classification of program entities which follows is a refinement of
-- the list given in RM 3.1(1). E.g., separate entities denote subtypes of
-- different type classes. Ada 95 entities include class wide types,
-- protected types, subprogram types, generalized access types, generic
-- formal derived types and generic formal packages.
-- The order chosen for these kinds allows us to classify related entities
-- so that they are contiguous. As a result, they do not appear in the
-- exact same order as their order of first appearance in the LRM (For
-- example, private types are listed before packages). The contiguity
-- allows us to define useful subtypes (see below) such as type entities,
-- overloaded entities, etc.
-- Each entity (explicitly or implicitly declared) has a kind, which is
-- a value of the following type:
type Entity_Kind is (
E_Void,
-- The initial Ekind value for a newly created entity. Also used as
-- the Ekind for Standard_Void_Type, a type entity in Standard used
-- as a dummy type for the return type of a procedure (the reason we
-- create this type is to share the circuits for performing overload
-- resolution on calls).
-------------
-- Objects --
-------------
E_Variable,
-- Variables created by an object declaration with no constant keyword
E_Component,
-- Components of a record declaration, private declarations of
-- protected objects.
E_Constant,
-- Constants created by an object declaration with a constant keyword
E_Discriminant,
-- A discriminant, created by the use of a discriminant in a type
-- declaration.
E_Loop_Parameter,
-- A loop parameter created by a for loop
------------------------
-- Parameter Entities --
------------------------
-- Parameters are also objects
E_In_Parameter,
-- An in parameter of a subprogram or entry
E_Out_Parameter,
-- An out parameter of a subprogram or entry
E_In_Out_Parameter,
-- An in-out parameter of a subprogram or entry
--------------------------------
-- Generic Parameter Entities --
--------------------------------
-- Generic parameters are also objects
E_Generic_In_Out_Parameter,
-- A generic in out parameter, created by the use of a generic in out
-- parameter in a generic declaration.
E_Generic_In_Parameter,
-- A generic in parameter, created by the use of a generic in
-- parameter in a generic declaration.
-------------------
-- Named Numbers --
-------------------
E_Named_Integer,
-- Named numbers created by a number declaration with an integer value
E_Named_Real,
-- Named numbers created by a number declaration with a real value
-----------------------
-- Enumeration Types --
-----------------------
E_Enumeration_Type,
-- Enumeration types, created by an enumeration type declaration
E_Enumeration_Subtype,
-- Enumeration subtypes, created by an explicit or implicit subtype
-- declaration applied to an enumeration type or subtype.
-------------------
-- Numeric Types --
-------------------
E_Signed_Integer_Type,
-- Signed integer type, used for the anonymous base type of the
-- integer subtype created by an integer type declaration.
E_Signed_Integer_Subtype,
-- Signed integer subtype, created by either an integer subtype or
-- integer type declaration (in the latter case an integer type is
-- created for the base type, and this is the first named subtype).
E_Modular_Integer_Type,
-- Modular integer type, used for the anonymous base type of the
-- integer subtype created by a modular integer type declaration.
E_Modular_Integer_Subtype,
-- Modular integer subtype, created by either an modular subtype
-- or modular type declaration (in the latter case a modular type
-- is created for the base type, and this is the first named subtype).
E_Ordinary_Fixed_Point_Type,
-- Ordinary fixed type, used for the anonymous base type of the
-- fixed subtype created by an ordinary fixed point type declaration.
E_Ordinary_Fixed_Point_Subtype,
-- Ordinary fixed point subtype, created by either an ordinary fixed
-- point subtype or ordinary fixed point type declaration (in the
-- latter case a fixed point type is created for the base type, and
-- this is the first named subtype).
E_Decimal_Fixed_Point_Type,
-- Decimal fixed type, used for the anonymous base type of the decimal
-- fixed subtype created by an ordinary fixed point type declaration.
E_Decimal_Fixed_Point_Subtype,
-- Decimal fixed point subtype, created by either a decimal fixed point
-- subtype or decimal fixed point type declaration (in the latter case
-- a fixed point type is created for the base type, and this is the
-- first named subtype).
E_Floating_Point_Type,
-- Floating point type, used for the anonymous base type of the
-- floating point subtype created by a floating point type declaration.
E_Floating_Point_Subtype,
-- Floating point subtype, created by either a floating point subtype
-- or floating point type declaration (in the latter case a floating
-- point type is created for the base type, and this is the first
-- named subtype).
------------------
-- Access Types --
------------------
E_Access_Type,
-- An access type created by an access type declaration with no all
-- keyword present. Note that the predefined type Any_Access, which
-- has E_Access_Type Ekind, is used to label NULL in the upwards pass
-- of type analysis, to be replaced by the true access type in the
-- downwards resolution pass.
E_Access_Subtype,
-- An access subtype created by a subtype declaration for any access
-- type (whether or not it is a general access type).
E_Access_Attribute_Type,
-- An access type created for an access attribute (such as 'Access,
-- 'Unrestricted_Access and Unchecked_Access)
E_Allocator_Type,
-- A special internal type used to label allocators and attribute
-- references using 'Access. This is needed because special resolution
-- rules apply to these constructs. On the resolution pass, this type
-- is always replaced by the actual access type, so Gigi should never
-- see types with this Ekind.
E_General_Access_Type,
-- An access type created by an access type declaration with the all
-- keyword present.
E_Access_Subprogram_Type,
-- An access to subprogram type, created by an access to subprogram
-- declaration.
E_Access_Protected_Subprogram_Type,
-- An access to a protected subprogram, created by the corresponding
-- declaration. Values of such a type denote both a protected object
-- and a protected operation within, and have different compile-time
-- and run-time properties than other access to subprograms.
E_Anonymous_Access_Type,
-- An anonymous access type created by an access parameter or access
-- discriminant.
---------------------
-- Composite Types --
---------------------
E_Array_Type,
-- An array type created by an array type declaration. Includes all
-- cases of arrays, except for string types.
E_Array_Subtype,
-- An array subtype, created by an explicit array subtype declaration,
-- or the use of an anonymous array subtype.
E_String_Type,
-- A string type, i.e. an array type whose component type is a character
-- type, and for which string literals can thus be written.
E_String_Subtype,
-- A string subtype, created by an explicit subtype declaration for a
-- string type, or the use of an anonymous subtype of a string type,
E_String_Literal_Subtype,
-- A special string subtype, used only to describe the type of a string
-- literal (will always be one dimensional, with literal bounds).
E_Class_Wide_Type,
-- A class wide type, created by any tagged type declaration (i.e. if
-- a tagged type is declared, the corresponding class type is always
-- created, using this Ekind value).
E_Class_Wide_Subtype,
-- A subtype of a class wide type, created by a subtype declaration
-- used to declare a subtype of a class type.
E_Record_Type,
-- A record type, created by a record type declaration
E_Record_Subtype,
-- A record subtype, created by a record subtype declaration.
E_Record_Type_With_Private,
-- Used for types defined by a private extension declaration. Includes
-- the fields for both private types and for record types (with the
-- sole exception of Corresponding_Concurrent_Type which is obviously
-- not needed). This entity is considered to be both a record type and
-- a private type.
E_Record_Subtype_With_Private,
-- A subtype of a type defined by a private extension declaration.
E_Private_Type,
-- A private type, created by a private type declaration that does
-- not have the keyword limited.
E_Private_Subtype,
-- A subtype of a private type, created by a subtype declaration used
-- to declare a subtype of a private type.
E_Limited_Private_Type,
-- A limited private type, created by a private type declaration that
-- has the keyword limited.
E_Limited_Private_Subtype,
-- A subtype of a limited private type, created by a subtype declaration
-- used to declare a subtype of a limited private type.
E_Incomplete_Type,
-- An incomplete type, created by an incomplete type declaration
E_Task_Type,
-- A task type, created by a task type declaration. An entity with this
-- Ekind is also created to describe the anonymous type of a task that
-- is created by a single task declaration.
E_Task_Subtype,
-- A subtype of a task type, created by a subtype declaration used to
-- declare a subtype of a task type.
E_Protected_Type,
-- A protected type, created by a protected type declaration. An entity
-- with this Ekind is also created to describe the anonymous type of
-- a protected object created by a single protected declaration.
E_Protected_Subtype,
-- A subtype of a protected type, created by a subtype declaration used
-- to declare a subtype of a protected type.
-----------------
-- Other Types --
-----------------
E_Exception_Type,
-- The type of an exception created by an exception declaration
E_Subprogram_Type,
-- This is the designated type of an Access_To_Subprogram. Has type
-- and signature like a subprogram entity, so can appear in calls,
-- which are resolved like regular calls, except that such an entity
-- is not overloadable.
---------------------------
-- Overloadable Entities --
---------------------------
E_Enumeration_Literal,
-- An enumeration literal, created by the use of the literal in an
-- enumeration type definition.
E_Function,
-- A function, created by a function declaration or a function body
-- that acts as its own declaration.
E_Operator,
-- A predefined operator, appearing in Standard, or an implicitly
-- defined concatenation operator created whenever an array is
-- declared. We do not make normal derived operators explicit in
-- the tree, but the concatenation operators are made explicit.
E_Procedure,
-- A procedure, created by a procedure declaration or a procedure
-- body that acts as its own declaration.
E_Entry,
-- An entry, created by an entry declaration in a task or protected
-- object.
--------------------
-- Other Entities --
--------------------
E_Entry_Family,
-- An entry family, created by an entry family declaration in a
-- task or protected type definition.
E_Block,
-- A block identifier, created by an explicit or implicit label on
-- a block or declare statement.
E_Entry_Index_Parameter,
-- An entry index parameter created by an entry index specification
-- for the body of a protected entry family.
E_Exception,
-- An exception created by an exception declaration. The exception
-- itself uses E_Exception for the Ekind, the implicit type that is
-- created to represent its type uses the Ekind E_Exception_Type.
E_Generic_Function,
-- A generic function. This is the entity for a generic function
-- created by a generic subprogram declaration.
E_Generic_Procedure,
-- A generic function. This is the entity for a generic procedure
-- created by a generic subprogram declaration.
E_Generic_Package,
-- A generic package, this is the entity for a generic package created
-- by a generic package declaration.
E_Label,
-- The defining entity for a label. Note that this is created by the
-- implicit label declaration, not the occurrence of the label itself,
-- which is simply a direct name referring to the label.
E_Loop,
-- A loop identifier, created by an explicit or implicit label on a
-- loop statement.
E_Package,
-- A package, created by a package declaration
E_Package_Body,
-- A package body. This entity serves only limited functions, since
-- most semantic analysis uses the package entity (E_Package). However
-- there are some attributes that are significant for the body entity.
-- For example, collection of exception handlers.
E_Protected_Object,
-- A protected object, created by an object declaration that declares
-- an object of a protected type.
E_Protected_Body,
-- A protected body. This entity serves almost no function, since all
-- semantic analysis uses the protected entity (E_Protected_Type)
E_Task_Body,
-- A task body. This entity serves almost no function, since all
-- semantic analysis uses the protected entity (E_Task_Type).
E_Subprogram_Body
-- A subprogram body. Used when a subprogram has a separate declaration
-- to represent the entity for the body. This entity serves almost no
-- function, since all semantic analysis uses the subprogram entity
-- for the declaration (E_Function or E_Procedure).
);
for Entity_Kind'Size use 8;
-- The data structures in Atree assume this!
--------------------------
-- Subtype Declarations --
--------------------------
-- The above entities are arranged so that they can be conveniently
-- grouped into subtype ranges. Note that for each of the xxx_Kind
-- ranges defined below, there is a corresponding Is_xxx.. predicate
-- which is to be used in preference to direct range tests using the
-- subtype name. However, the subtype names are available for direct
-- use, e.g. as choices in case statements.
subtype Access_Kind is Entity_Kind range
E_Access_Type ..
-- E_Access_Subtype
-- E_Access_Attribute_Type
-- E_Allocator_Type
-- E_General_Access_Type
-- E_Access_Subprogram_Type
-- E_Access_Protected_Subprogram_Type
E_Anonymous_Access_Type;
subtype Array_Kind is Entity_Kind range
E_Array_Type ..
-- E_Array_Subtype
-- E_String_Type
-- E_String_Subtype
E_String_Literal_Subtype;
subtype Class_Wide_Kind is Entity_Kind range
E_Class_Wide_Type ..
E_Class_Wide_Subtype;
subtype Composite_Kind is Entity_Kind range
E_Array_Type ..
-- E_Array_Subtype
-- E_String_Type
-- E_String_Subtype
-- E_String_Literal_Subtype
-- E_Class_Wide_Type
-- E_Class_Wide_Subtype
-- E_Record_Type
-- E_Record_Subtype
-- E_Record_Type_With_Private
-- E_Record_Subtype_With_Private
-- E_Private_Type
-- E_Private_Subtype
-- E_Limited_Private_Type
-- E_Limited_Private_Subtype
-- E_Incomplete_Type
-- E_Task_Type
-- E_Task_Subtype,
-- E_Protected_Type,
E_Protected_Subtype;
subtype Concurrent_Kind is Entity_Kind range
E_Task_Type ..
-- E_Task_Subtype,
-- E_Protected_Type,
E_Protected_Subtype;
subtype Concurrent_Body_Kind is Entity_Kind range
E_Protected_Body ..
E_Task_Body;
subtype Decimal_Fixed_Point_Kind is Entity_Kind range
E_Decimal_Fixed_Point_Type ..
E_Decimal_Fixed_Point_Subtype;
subtype Digits_Kind is Entity_Kind range
E_Decimal_Fixed_Point_Type ..
-- E_Decimal_Fixed_Point_Subtype
-- E_Floating_Point_Type
E_Floating_Point_Subtype;
subtype Discrete_Kind is Entity_Kind range
E_Enumeration_Type ..
-- E_Enumeration_Subtype
-- E_Signed_Integer_Type
-- E_Signed_Integer_Subtype
-- E_Modular_Integer_Type
E_Modular_Integer_Subtype;
subtype Discrete_Or_Fixed_Point_Kind is Entity_Kind range
E_Enumeration_Type ..
-- E_Enumeration_Subtype
-- E_Signed_Integer_Type
-- E_Signed_Integer_Subtype
-- E_Modular_Integer_Type
-- E_Modular_Integer_Subtype
-- E_Ordinary_Fixed_Point_Type
-- E_Ordinary_Fixed_Point_Subtype
-- E_Decimal_Fixed_Point_Type
E_Decimal_Fixed_Point_Subtype;
subtype Elementary_Kind is Entity_Kind range
E_Enumeration_Type ..
-- E_Enumeration_Subtype
-- E_Signed_Integer_Type
-- E_Signed_Integer_Subtype
-- E_Modular_Integer_Type
-- E_Modular_Integer_Subtype
-- E_Ordinary_Fixed_Point_Type
-- E_Ordinary_Fixed_Point_Subtype
-- E_Decimal_Fixed_Point_Type
-- E_Decimal_Fixed_Point_Subtype
-- E_Floating_Point_Type
-- E_Floating_Point_Subtype
-- E_Access_Type
-- E_Access_Subtype
-- E_Access_Attribute_Type
-- E_Allocator_Type
-- E_General_Access_Type
-- E_Access_Subprogram_Type
-- E_Access_Protected_Subprogram_Type
E_Anonymous_Access_Type;
subtype Enumeration_Kind is Entity_Kind range
E_Enumeration_Type ..
E_Enumeration_Subtype;
subtype Entry_Kind is Entity_Kind range
E_Entry ..
E_Entry_Family;
subtype Fixed_Point_Kind is Entity_Kind range
E_Ordinary_Fixed_Point_Type ..
-- E_Ordinary_Fixed_Point_Subtype
-- E_Decimal_Fixed_Point_Type
E_Decimal_Fixed_Point_Subtype;
subtype Float_Kind is Entity_Kind range
E_Floating_Point_Type ..
E_Floating_Point_Subtype;
subtype Formal_Kind is Entity_Kind range
E_In_Parameter ..
-- E_Out_Parameter
E_In_Out_Parameter;
subtype Generic_Subprogram_Kind is Entity_Kind range
E_Generic_Function ..
E_Generic_Procedure;
subtype Generic_Unit_Kind is Entity_Kind range
E_Generic_Function ..
-- E_Generic_Procedure
E_Generic_Package;
subtype Incomplete_Or_Private_Kind is Entity_Kind range
E_Record_Type_With_Private ..
-- E_Record_Subtype_With_Private
-- E_Private_Type
-- E_Private_Subtype
-- E_Limited_Private_Type
-- E_Limited_Private_Subtype
E_Incomplete_Type;
subtype Integer_Kind is Entity_Kind range
E_Signed_Integer_Type ..
-- E_Signed_Integer_Subtype
-- E_Modular_Integer_Type
E_Modular_Integer_Subtype;
subtype Modular_Integer_Kind is Entity_Kind range
E_Modular_Integer_Type ..
E_Modular_Integer_Subtype;
subtype Named_Kind is Entity_Kind range
E_Named_Integer ..
E_Named_Real;
subtype Numeric_Kind is Entity_Kind range
E_Signed_Integer_Type ..
-- E_Signed_Integer_Subtype
-- E_Modular_Integer_Type
-- E_Modular_Integer_Subtype
-- E_Ordinary_Fixed_Point_Type
-- E_Ordinary_Fixed_Point_Subtype
-- E_Decimal_Fixed_Point_Type
-- E_Decimal_Fixed_Point_Subtype
-- E_Floating_Point_Type
E_Floating_Point_Subtype;
subtype Object_Kind is Entity_Kind range
E_Variable ..
-- E_Component
-- E_Constant
-- E_Discriminant
-- E_Loop_Parameter
-- E_In_Parameter
-- E_Out_Parameter
-- E_In_Out_Parameter
-- E_Generic_In_Out_Parameter
E_Generic_In_Parameter;
subtype Ordinary_Fixed_Point_Kind is Entity_Kind range
E_Ordinary_Fixed_Point_Type ..
E_Ordinary_Fixed_Point_Subtype;
subtype Overloadable_Kind is Entity_Kind range
E_Enumeration_Literal ..
-- E_Function
-- E_Operator
-- E_Procedure
E_Entry;
subtype Private_Kind is Entity_Kind range
E_Record_Type_With_Private ..
-- E_Record_Subtype_With_Private
-- E_Private_Type
-- E_Private_Subtype
-- E_Limited_Private_Type
E_Limited_Private_Subtype;
subtype Protected_Kind is Entity_Kind range
E_Protected_Type ..
E_Protected_Subtype;
subtype Real_Kind is Entity_Kind range
E_Ordinary_Fixed_Point_Type ..
-- E_Ordinary_Fixed_Point_Subtype
-- E_Decimal_Fixed_Point_Type
-- E_Decimal_Fixed_Point_Subtype
-- E_Floating_Point_Type
E_Floating_Point_Subtype;
subtype Record_Kind is Entity_Kind range
E_Class_Wide_Type ..
-- E_Class_Wide_Subtype
-- E_Record_Type
-- E_Record_Subtype
-- E_Record_Type_With_Private
E_Record_Subtype_With_Private;
subtype Scalar_Kind is Entity_Kind range
E_Enumeration_Type ..
-- E_Enumeration_Subtype
-- E_Signed_Integer_Type
-- E_Signed_Integer_Subtype
-- E_Modular_Integer_Type
-- E_Modular_Integer_Subtype
-- E_Ordinary_Fixed_Point_Type
-- E_Ordinary_Fixed_Point_Subtype
-- E_Decimal_Fixed_Point_Type
-- E_Decimal_Fixed_Point_Subtype
-- E_Floating_Point_Type
E_Floating_Point_Subtype;
subtype String_Kind is Entity_Kind range
E_String_Type ..
-- E_String_Subtype
E_String_Literal_Subtype;
subtype Subprogram_Kind is Entity_Kind range
E_Function ..
-- E_Operator
E_Procedure;
subtype Signed_Integer_Kind is Entity_Kind range
E_Signed_Integer_Type ..
E_Signed_Integer_Subtype;
subtype Task_Kind is Entity_Kind range
E_Task_Type ..
E_Task_Subtype;
subtype Type_Kind is Entity_Kind range
E_Enumeration_Type ..
-- E_Enumeration_Subtype
-- E_Signed_Integer_Type
-- E_Signed_Integer_Subtype
-- E_Modular_Integer_Type
-- E_Modular_Integer_Subtype
-- E_Ordinary_Fixed_Point_Type
-- E_Ordinary_Fixed_Point_Subtype
-- E_Decimal_Fixed_Point_Type
-- E_Decimal_Fixed_Point_Subtype
-- E_Floating_Point_Type
-- E_Floating_Point_Subtype
-- E_Access_Type
-- E_Access_Subtype
-- E_Access_Attribute_Type
-- E_Allocator_Type,
-- E_General_Access_Type
-- E_Access_Subprogram_Type,
-- E_Access_Protected_Subprogram_Type
-- E_Anonymous_Access_Type
-- E_Array_Type
-- E_Array_Subtype
-- E_String_Type
-- E_String_Subtype
-- E_String_Literal_Subtype
-- E_Class_Wide_Subtype
-- E_Class_Wide_Type
-- E_Record_Type
-- E_Record_Subtype
-- E_Record_Type_With_Private
-- E_Record_Subtype_With_Private
-- E_Private_Type
-- E_Private_Subtype
-- E_Limited_Private_Type
-- E_Limited_Private_Subtype
-- E_Incomplete_Type
-- E_Task_Type
-- E_Task_Subtype
-- E_Protected_Type
-- E_Protected_Subtype
-- E_Exception_Type
E_Subprogram_Type;
--------------------------------------------------------
-- Description of Defined Attributes for Entity_Kinds --
--------------------------------------------------------
-- For each enumeration value defined in Entity_Kind we list all the
-- attributes defined in Einfo which can legally be applied to an entity
-- of that kind. The implementation of the attribute functions (and for
-- non-synthesized attributes, or the corresponding set procedures) are
-- in the Einfo body.
-- The following attributes apply to all entities
-- Ekind (Ekind)
-- Chars (Name1)
-- Next_Entity (Node2)
-- Scope (Node3)
-- Homonym (Node4)
-- Etype (Node5)
-- First_Rep_Item (Node6)
-- Freeze_Node (Node7)
-- Address_Taken (Flag104)
-- Can_Never_Be_Null (Flag38)
-- Checks_May_Be_Suppressed (Flag31)
-- Debug_Info_Off (Flag166)
-- Has_Convention_Pragma (Flag119)
-- Has_Delayed_Freeze (Flag18)
-- Has_Fully_Qualified_Name (Flag173)
-- Has_Gigi_Rep_Item (Flag82)
-- Has_Homonym (Flag56)
-- Has_Pragma_Elaborate_Body (Flag150)
-- Has_Pragma_Inline (Flag157)
-- Has_Pragma_Unreferenced (Flag180)
-- Has_Private_Declaration (Flag155)
-- Has_Qualified_Name (Flag161)
-- Has_Unknown_Discriminants (Flag72)
-- Has_Xref_Entry (Flag182)
-- Is_Bit_Packed_Array (Flag122) (base type only)
-- Is_Child_Unit (Flag73)
-- Is_Compilation_Unit (Flag149)
-- Is_Completely_Hidden (Flag103)
-- Is_Discrim_SO_Function (Flag176)
-- Is_Dispatching_Operation (Flag6)
-- Is_Exported (Flag99)
-- Is_First_Subtype (Flag70)
-- Is_Formal_Subprogram (Flag111)
-- Is_Generic_Instance (Flag130)
-- Is_Hidden (Flag57)
-- Is_Hidden_Open_Scope (Flag171)
-- Is_Immediately_Visible (Flag7)
-- Is_Imported (Flag24)
-- Is_Inlined (Flag11)
-- Is_Internal (Flag17)
-- Is_Itype (Flag91)
-- Is_Known_Non_Null (Flag37)
-- Is_Known_Valid (Flag170)
-- Is_Limited_Composite (Flag106)
-- Is_Limited_Record (Flag25)
-- Is_Package_Body_Entity (Flag160)
-- Is_Packed_Array_Type (Flag138)
-- Is_Potentially_Use_Visible (Flag9)
-- Is_Preelaborated (Flag59)
-- Is_Public (Flag10)
-- Is_Pure (Flag44)
-- Is_Remote_Call_Interface (Flag62)
-- Is_Remote_Types (Flag61)
-- Is_Shared_Passive (Flag60)
-- Is_Statically_Allocated (Flag28)
-- Is_Unchecked_Union (Flag117)
-- Is_VMS_Exception (Flag133)
-- Kill_Elaboration_Checks (Flag32)
-- Kill_Range_Checks (Flag33)
-- Kill_Tag_Checks (Flag34)
-- Materialize_Entity (Flag168)
-- Needs_Debug_Info (Flag147)
-- Referenced (Flag156)
-- Referenced_As_LHS (Flag36)
-- Suppress_Elaboration_Warnings (Flag148)
-- Suppress_Style_Checks (Flag165)
-- Declaration_Node (synth)
-- Enclosing_Dynamic_Scope (synth)
-- Has_Foreign_Convention (synth)
-- Is_Dynamic_Scope (synth)
-- Is_Limited_Type (synth)
-- Underlying_Type (synth)
-- all classification attributes (synth)
-- The following list of access functions applies to all entities for
-- types and subtypes. References to this list appear subsequently as
-- as "(plus type attributes)" for each appropriate Entity_Kind.
-- Associated_Node_For_Itype (Node8)
-- Class_Wide_Type (Node9)
-- Referenced_Object (Node10)
-- Full_View (Node11)
-- Esize (Uint12)
-- RM_Size (Uint13)
-- Alignment (Uint14)
-- Depends_On_Private (Flag14)
-- Discard_Names (Flag88)
-- Finalize_Storage_Only (Flag158) (base type only)
-- From_With_Type (Flag159)
-- Has_Aliased_Components (Flag135) (base type only)
-- Has_Alignment_Clause (Flag46)
-- Has_Atomic_Components (Flag86) (base type only)
-- Has_Complex_Representation (Flag140) (base type only)
-- Has_Discriminants (Flag5)
-- Has_Non_Standard_Rep (Flag75) (base type only)
-- Has_Object_Size_Clause (Flag172)
-- Has_Primitive_Operations (Flag120) (base type only)
-- Has_Size_Clause (Flag29)
-- Has_Specified_Layout (Flag100) (base type only)
-- Has_Task (Flag30) (base type only)
-- Has_Unchecked_Union (Flag123) (base type only)
-- Has_Volatile_Components (Flag87) (base type only)
-- In_Use (Flag8)
-- Is_Abstract (Flag19)
-- Is_Asynchronous (Flag81)
-- Is_Atomic (Flag85)
-- Is_Constr_Subt_For_U_Nominal (Flag80)
-- Is_Constr_Subt_For_UN_Aliased (Flag141)
-- Is_Controlled (Flag42) (base type only)
-- Is_Eliminated (Flag124)
-- Is_Frozen (Flag4)
-- Is_Generic_Actual_Type (Flag94)
-- Is_Generic_Type (Flag13)
-- Is_Non_Static_Subtype (Flag109)
-- Is_Packed (Flag51) (base type only)
-- Is_Private_Composite (Flag107)
-- Is_Renaming_Of_Object (Flag112)
-- Is_Tagged_Type (Flag55)
-- Is_Unsigned_Type (Flag144)
-- Is_Volatile (Flag16)
-- Size_Depends_On_Discriminant (Flag177)
-- Size_Known_At_Compile_Time (Flag92)
-- Strict_Alignment (Flag145) (base type only)
-- Suppress_Init_Proc (Flag105) (base type only)
-- Treat_As_Volatile (Flag41)
-- Alignment_Clause (synth)
-- Ancestor_Subtype (synth)
-- Base_Type (synth)
-- First_Subtype (synth)
-- Has_Private_Ancestor (synth)
-- Implementation_Base_Type (synth)
-- Is_By_Copy_Type (synth)
-- Is_By_Reference_Type (synth)
-- Is_Return_By_Reference_Type (synth)
-- Root_Type (synth)
-- Size_Clause (synth)
------------------------------------------
-- Applicable attributes by entity kind --
------------------------------------------
-- E_Access_Protected_Subprogram_Type
-- Equivalent_Type (Node18)
-- Directly_Designated_Type (Node20)
-- Needs_No_Actuals (Flag22)
-- (plus type attributes)
-- E_Access_Subprogram_Type
-- Equivalent_Type (Node18) (remote types only)
-- Directly_Designated_Type (Node20)
-- Needs_No_Actuals (Flag22)
-- (plus type attributes)
-- E_Access_Type
-- E_Access_Subtype
-- Storage_Size_Variable (Node15) (base type only)
-- Master_Id (Node17)
-- Directly_Designated_Type (Node20)
-- Associated_Storage_Pool (Node22) (base type only)
-- Associated_Final_Chain (Node23)
-- Has_Pragma_Controlled (Flag27) (base type only)
-- Has_Storage_Size_Clause (Flag23) (base type only)
-- Is_Access_Constant (Flag69)
-- No_Pool_Assigned (Flag131) (base type only)
-- (plus type attributes)
-- E_Access_Attribute_Type
-- Directly_Designated_Type (Node20)
-- (plus type attributes)
-- E_Allocator_Type
-- Directly_Designated_Type (Node20)
-- (plus type attributes)
-- E_Anonymous_Access_Type
-- Storage_Size_Variable (Node15) ??? is this needed ???
-- Directly_Designated_Type (Node20)
-- (plus type attributes)
-- E_Array_Type
-- E_Array_Subtype
-- First_Index (Node17)
-- Related_Array_Object (Node19)
-- Component_Type (Node20) (base type only)
-- Original_Array_Type (Node21)
-- Component_Size (Uint22) (base type only)
-- Packed_Array_Type (Node23)
-- Component_Alignment (special) (base type only)
-- Has_Component_Size_Clause (Flag68) (base type only)
-- Has_Controlled_Component (Flag43) (base type only)
-- Has_Pragma_Pack (Flag121) (base type only)
-- Is_Aliased (Flag15)
-- Is_Constrained (Flag12)
-- Next_Index (synth)
-- Number_Dimensions (synth)
-- (plus type attributes)
-- E_Block
-- Block_Node (Node11)
-- First_Entity (Node17)
-- Last_Entity (Node20)
-- Delay_Cleanups (Flag114)
-- Discard_Names (Flag88)
-- Finalization_Chain_Entity (Node19)
-- Scope_Depth_Value (Uint22)<