gcc/ada/sem_aux.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              S E M _ A U X                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2013, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
  19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
  20 --                                                                          --
  21 -- As a special exception,  if other files  instantiate  generics from this --
  22 -- unit, or you link  this unit with other files  to produce an executable, --
  23 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  24 -- covered  by the  GNU  General  Public  License.  This exception does not --
  25 -- however invalidate  any other reasons why  the executable file  might be --
  26 -- covered by the  GNU Public License.                                      --
  27 --                                                                          --
  28 -- GNAT was originally developed  by the GNAT team at  New York University. --
  29 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  30 --                                                                          --
  31 ------------------------------------------------------------------------------
  32
  33 --  Package containing utility procedures used throughout the compiler,
  34 --  and also by ASIS so dependencies are limited to ASIS included packages.
  35
  36 --  Historical note. Many of the routines here were originally in Einfo, but
  37 --  Einfo is supposed to be a relatively low level package dealing with the
  38 --  content of entities in the tree, so this package is used for routines that
  39 --  require more than minimal semantic knowledge.
  40
  41 with Alloc; use Alloc;
  42 with Namet; use Namet;
  43 with Table;
  44 with Types; use Types;
  45
  46 package Sem_Aux is
  47
  48    --------------------------------
  49    -- Obsolescent Warnings Table --
  50    --------------------------------
  51
  52    --  This table records entities for which a pragma Obsolescent with a
  53    --  message argument has been processed.
  54
  55    type OWT_Record is record
  56       Ent : Entity_Id;
  57       --  The entity to which the pragma applies
  58
  59       Msg : String_Id;
  60       --  The string containing the message
  61    end record;
  62
  63    package Obsolescent_Warnings is new Table.Table (
  64      Table_Component_Type => OWT_Record,
  65      Table_Index_Type     => Int,
  66      Table_Low_Bound      => 0,
  67      Table_Initial        => Alloc.Obsolescent_Warnings_Initial,
  68      Table_Increment      => Alloc.Obsolescent_Warnings_Increment,
  69      Table_Name           => "Obsolescent_Warnings");
  70
  71    procedure Initialize;
  72    --  Called at the start of compilation of each new main source file to
  73    --  initialize the allocation of the Obsolescent_Warnings table. Note that
  74    --  Initialize must not be called if Tree_Read is used.
  75
  76    procedure Tree_Read;
  77    --  Initializes Obsolescent_Warnings table from current tree file using the
  78    --  relevant Table.Tree_Read routine.
  79
  80    procedure Tree_Write;
  81    --  Writes out Obsolescent_Warnings table to current tree file using the
  82    --  relevant Table.Tree_Write routine.
  83
  84    -----------------
  85    -- Subprograms --
  86    -----------------
  87
  88    function Ancestor_Subtype (Typ : Entity_Id) return Entity_Id;
  89    --  The argument Id is a type or subtype entity. If the argument is a
  90    --  subtype then it returns the subtype or type from which the subtype was
  91    --  obtained, otherwise it returns Empty.
  92
  93    function Available_View (Typ : Entity_Id) return Entity_Id;
  94    --  Typ is typically a type that has the With_Type flag set. Returns the
  95    --  non-limited view of the type, if available, otherwise the type itself.
  96    --  For class-wide types, there is no direct link in the tree, so we have
  97    --  to retrieve the class-wide type of the non-limited view of the Etype.
  98    --  Returns the argument unchanged if it is not one of these cases.
  99
 100    function Constant_Value (Ent : Entity_Id) return Node_Id;
 101    --  Ent is a variable, constant, named integer, or named real entity. This
 102    --  call obtains the initialization expression for the entity. Will return
 103    --  Empty for a deferred constant whose full view is not available or
 104    --  in some other cases of internal entities, which cannot be treated as
 105    --  constants from the point of view of constant folding. Empty is also
 106    --  returned for variables with no initialization expression.
 107
 108    function Enclosing_Dynamic_Scope (Ent : Entity_Id) return Entity_Id;
 109    --  For any entity, Ent, returns the closest dynamic scope in which the
 110    --  entity is declared or Standard_Standard for library-level entities.
 111
 112    function First_Discriminant (Typ : Entity_Id) return Entity_Id;
 113    --  Typ is a type with discriminants. The discriminants are the first
 114    --  entities declared in the type, so normally this is equivalent to
 115    --  First_Entity. The exception arises for tagged types, where the tag
 116    --  itself is prepended to the front of the entity chain, so the
 117    --  First_Discriminant function steps past the tag if it is present.
 118
 119    function First_Stored_Discriminant (Typ : Entity_Id) return Entity_Id;
 120    --  Typ is a type with discriminants. Gives the first discriminant stored
 121    --  in an object of this type. In many cases, these are the same as the
 122    --  normal visible discriminants for the type, but in the case of renamed
 123    --  discriminants, this is not always the case.
 124    --
 125    --  For tagged types, and untagged types which are root types or derived
 126    --  types but which do not rename discriminants in their root type, the
 127    --  stored discriminants are the same as the actual discriminants of the
 128    --  type, and hence this function is the same as First_Discriminant.
 129    --
 130    --  For derived non-tagged types that rename discriminants in the root type
 131    --  this is the first of the discriminants that occur in the root type. To
 132    --  be precise, in this case stored discriminants are entities attached to
 133    --  the entity chain of the derived type which are a copy of the
 134    --  discriminants of the root type. Furthermore their Is_Completely_Hidden
 135    --  flag is set since although they are actually stored in the object, they
 136    --  are not in the set of discriminants that is visible in the type.
 137    --
 138    --  For derived untagged types, the set of stored discriminants are the real
 139    --  discriminants from Gigi's standpoint, i.e. those that will be stored in
 140    --  actual objects of the type.
 141
 142    function First_Subtype (Typ : Entity_Id) return Entity_Id;
 143    --  Applies to all types and subtypes. For types, yields the first subtype
 144    --  of the type. For subtypes, yields the first subtype of the base type of
 145    --  the subtype.
 146
 147    function First_Tag_Component (Typ : Entity_Id) return Entity_Id;
 148    --  Typ must be a tagged record type. This function returns the Entity for
 149    --  the first _Tag field in the record type.
 150
 151    function Get_Rep_Item
 152      (E             : Entity_Id;
 153       Nam           : Name_Id;
 154       Check_Parents : Boolean := True) return Node_Id;
 155    --  Searches the Rep_Item chain for a given entity E, for an instance of a
 156    --  rep item (pragma, attribute definition clause, or aspect specification)
 157    --  whose name matches the given name Nam. If Check_Parents is False then it
 158    --  only returns rep item that has been directly specified for E (and not
 159    --  inherited from its parents, if any). If one is found, it is returned,
 160    --  otherwise Empty is returned. A special case is that when Nam is
 161    --  Name_Priority, the call will also find Interrupt_Priority.
 162
 163    function Get_Rep_Item
 164      (E             : Entity_Id;
 165       Nam1          : Name_Id;
 166       Nam2          : Name_Id;
 167       Check_Parents : Boolean := True) return Node_Id;
 168    --  Searches the Rep_Item chain for a given entity E, for an instance of a
 169    --  rep item (pragma, attribute definition clause, or aspect specification)
 170    --  whose name matches one of the given names Nam1 or Nam2. If Check_Parents
 171    --  is False then it only returns rep item that has been directly specified
 172    --  for E (and not inherited from its parents, if any). If one is found, it
 173    --  is returned, otherwise Empty is returned. A special case is that when
 174    --  one of the given names is Name_Priority, the call will also find
 175    --  Interrupt_Priority.
 176
 177    function Get_Rep_Pragma
 178      (E             : Entity_Id;
 179       Nam           : Name_Id;
 180       Check_Parents : Boolean := True) return Node_Id;
 181    --  Searches the Rep_Item chain for a given entity E, for an instance of a
 182    --  representation pragma whose name matches the given name Nam. If
 183    --  Check_Parents is False then it only returns representation pragma that
 184    --  has been directly specified for E (and not inherited from its parents,
 185    --  if any). If one is found and if it is the first rep item in the list
 186    --  that matches Nam, it is returned, otherwise Empty is returned. A special
 187    --  case is that when Nam is Name_Priority, the call will also find
 188    --  Interrupt_Priority.
 189
 190    function Get_Rep_Pragma
 191      (E             : Entity_Id;
 192       Nam1          : Name_Id;
 193       Nam2          : Name_Id;
 194       Check_Parents : Boolean := True) return Node_Id;
 195    --  Searches the Rep_Item chain for a given entity E, for an instance of a
 196    --  representation pragma whose name matches one of the given names Nam1 or
 197    --  Nam2. If Check_Parents is False then it only returns representation
 198    --  pragma that has been directly specified for E (and not inherited from
 199    --  its parents, if any). If one is found and if it is the first rep item in
 200    --  the list that matches one of the given names, it is returned, otherwise
 201    --  Empty is returned. A special case is that when one of the given names is
 202    --  Name_Priority, the call will also find Interrupt_Priority.
 203
 204    function Has_Rep_Item
 205      (E             : Entity_Id;
 206       Nam           : Name_Id;
 207       Check_Parents : Boolean := True) return Boolean;
 208    --  Searches the Rep_Item chain for the given entity E, for an instance of a
 209    --  rep item (pragma, attribute definition clause, or aspect specification)
 210    --  with the given name Nam. If Check_Parents is False then it only checks
 211    --  for a rep item that has been directly specified for E (and not inherited
 212    --  from its parents, if any). If found then True is returned, otherwise
 213    --  False indicates that no matching entry was found.
 214
 215    function Has_Rep_Item
 216      (E             : Entity_Id;
 217       Nam1          : Name_Id;
 218       Nam2          : Name_Id;
 219       Check_Parents : Boolean := True) return Boolean;
 220    --  Searches the Rep_Item chain for the given entity E, for an instance of a
 221    --  rep item (pragma, attribute definition clause, or aspect specification)
 222    --  with the given names Nam1 or Nam2. If Check_Parents is False then it
 223    --  only checks for a rep item that has been directly specified for E (and
 224    --  not inherited from its parents, if any). If found then True is returned,
 225    --  otherwise False indicates that no matching entry was found.
 226
 227    function Has_Rep_Pragma
 228      (E             : Entity_Id;
 229       Nam           : Name_Id;
 230       Check_Parents : Boolean := True) return Boolean;
 231    --  Searches the Rep_Item chain for the given entity E, for an instance of a
 232    --  representation pragma with the given name Nam. If Check_Parents is False
 233    --  then it only checks for a representation pragma that has been directly
 234    --  specified for E (and not inherited from its parents, if any). If found
 235    --  and if it is the first rep item in the list that matches Nam then True
 236    --  is returned, otherwise False indicates that no matching entry was found.
 237
 238    function Has_Rep_Pragma
 239      (E             : Entity_Id;
 240       Nam1          : Name_Id;
 241       Nam2          : Name_Id;
 242       Check_Parents : Boolean := True) return Boolean;
 243    --  Searches the Rep_Item chain for the given entity E, for an instance of a
 244    --  representation pragma with the given names Nam1 or Nam2. If
 245    --  Check_Parents is False then it only checks for a rep item that has been
 246    --  directly specified for E (and not inherited from its parents, if any).
 247    --  If found and if it is the first rep item in the list that matches one of
 248    --  the given names then True is returned, otherwise False indicates that no
 249    --  matching entry was found.
 250
 251    function In_Generic_Body (Id : Entity_Id) return Boolean;
 252    --  Determine whether entity Id appears inside a generic body
 253
 254    function Initialization_Suppressed (Typ : Entity_Id) return Boolean;
 255    pragma Inline (Initialization_Suppressed);
 256    --  Returns True if initialization should be suppressed for the given type
 257    --  or subtype. This is true if Suppress_Initialization is set either for
 258    --  the subtype itself, or for the corresponding base type.
 259
 260    function Is_By_Copy_Type (Ent : Entity_Id) return Boolean;
 261    --  Ent is any entity. Returns True if Ent is a type entity where the type
 262    --  is required to be passed by copy, as defined in (RM 6.2(3)).
 263
 264    function Is_By_Reference_Type (Ent : Entity_Id) return Boolean;
 265    --  Ent is any entity. Returns True if Ent is a type entity where the type
 266    --  is required to be passed by reference, as defined in (RM 6.2(4-9)).
 267
 268    function Is_Derived_Type (Ent : Entity_Id) return Boolean;
 269    --  Determines if the given entity Ent is a derived type. Result is always
 270    --  false if argument is not a type.
 271
 272    function Is_Generic_Formal (E : Entity_Id) return Boolean;
 273    --  Determine whether E is a generic formal parameter. In particular this is
 274    --  used to set the visibility of generic formals of a generic package
 275    --  declared with a box or with partial parametrization.
 276
 277    function Is_Indefinite_Subtype (Ent : Entity_Id) return Boolean;
 278    --  Ent is any entity. Determines if given entity is an unconstrained array
 279    --  type or subtype, a discriminated record type or subtype with no initial
 280    --  discriminant values or a class wide type or subtype and returns True if
 281    --  so. False for other type entities, or any entities that are not types.
 282
 283    function Is_Immutably_Limited_Type (Ent : Entity_Id) return Boolean;
 284    --  Ent is any entity. True for a type that is "inherently" limited (i.e.
 285    --  cannot become nonlimited). From the Ada 2005 RM-7.5(8.1/2), "a type with
 286    --  a part that is of a task, protected, or explicitly limited record type".
 287    --  These are the types that are defined as return-by-reference types in Ada
 288    --  95 (see RM95-6.5(11-16)). In Ada 2005, these are the types that require
 289    --  build-in-place for function calls. Note that build-in-place is allowed
 290    --  for other types, too. This is also used for identifying pure procedures
 291    --  whose calls should not be eliminated (RM 10.2.1(18/2)).
 292
 293    function Is_Limited_Type (Ent : Entity_Id) return Boolean;
 294    --  Ent is any entity. Returns true if Ent is a limited type (limited
 295    --  private type, limited interface type, task type, protected type,
 296    --  composite containing a limited component, or a subtype of any of
 297    --  these types).
 298
 299    function Nearest_Ancestor (Typ : Entity_Id) return Entity_Id;
 300    --  Given a subtype Typ, this function finds out the nearest ancestor from
 301    --  which constraints and predicates are inherited. There is no simple link
 302    --  for doing this, consider:
 303    --
 304    --     subtype R is Integer range 1 .. 10;
 305    --     type T is new R;
 306    --
 307    --  In this case the nearest ancestor is R, but the Etype of T'Base will
 308    --  point to R'Base, so we have to go rummaging in the declarations to get
 309    --  this information. It is used for making sure we freeze this before we
 310    --  freeze Typ, and also for retrieving inherited predicate information.
 311    --  For the case of base types or first subtypes, there is no useful entity
 312    --  to return, so Empty is returned.
 313    --
 314    --  Note: this is similar to Ancestor_Subtype except that it also deals
 315    --  with the case of derived types.
 316
 317    function Nearest_Dynamic_Scope (Ent : Entity_Id) return Entity_Id;
 318    --  This is similar to Enclosing_Dynamic_Scope except that if Ent is itself
 319    --  a dynamic scope, then it is returned. Otherwise the result is the same
 320    --  as that returned by Enclosing_Dynamic_Scope.
 321
 322    function Next_Tag_Component (Tag : Entity_Id) return Entity_Id;
 323    --  Tag must be an entity representing a _Tag field of a tagged record.
 324    --  The result returned is the next _Tag field in this record, or Empty
 325    --  if this is the last such field.
 326
 327    function Number_Discriminants (Typ : Entity_Id) return Pos;
 328    --  Typ is a type with discriminants, yields number of discriminants in type
 329
 330    function Object_Type_Has_Constrained_Partial_View
 331      (Typ  : Entity_Id;
 332       Scop : Entity_Id) return Boolean;
 333    --  Return True if type of object has attribute Has_Constrained_Partial_View
 334    --  set to True; in addition, within a generic body, return True if subtype
 335    --  of the object is a descendant of an untagged generic formal private or
 336    --  derived type, and the subtype is not an unconstrained array subtype
 337    --  (RM 3.3(23.10/3)).
 338
 339    function Ultimate_Alias (Prim : Entity_Id) return Entity_Id;
 340    pragma Inline (Ultimate_Alias);
 341    --  Return the last entity in the chain of aliased entities of Prim. If Prim
 342    --  has no alias return Prim.
 343
 344    function Unit_Declaration_Node (Unit_Id : Entity_Id) return Node_Id;
 345    --  Unit_Id is the simple name of a program unit, this function returns the
 346    --  corresponding xxx_Declaration node for the entity. Also applies to the
 347    --  body entities for subprograms, tasks and protected units, in which case
 348    --  it returns the subprogram, task or protected body node for it. The unit
 349    --  may be a child unit with any number of ancestors.
 350
 351 end Sem_Aux;