gcc/ada/exp_ch3.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              E X P _ C H 3                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2023, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
  19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  Expand routines for chapter 3 constructs
  27
  28 with Types;   use Types;
  29 with Elists;  use Elists;
  30 with Exp_Tss; use Exp_Tss;
  31 with Uintp;   use Uintp;
  32
  33 package Exp_Ch3 is
  34
  35    procedure Expand_N_Object_Declaration         (N : Node_Id);
  36    procedure Expand_N_Subtype_Indication         (N : Node_Id);
  37    procedure Expand_N_Variant_Part               (N : Node_Id);
  38    procedure Expand_N_Full_Type_Declaration      (N : Node_Id);
  39
  40    procedure Expand_Previous_Access_Type (Def_Id : Entity_Id);
  41    --  For a full type declaration that contains tasks, or that is a task,
  42    --  check whether there exists an access type whose designated type is an
  43    --  incomplete declarations for the current composite type. If so, build the
  44    --  master for that access type, now that it is known to denote an object
  45    --  with tasks.
  46
  47    procedure Expand_Record_Extension (T : Entity_Id; Def : Node_Id);
  48    --  Add a field _parent in the extension part of the record
  49
  50    procedure Build_Access_Subprogram_Wrapper_Body
  51      (Decl     : Node_Id;
  52       New_Decl : Node_Id);
  53    --  Build the wrapper body, which holds the indirect call through an access-
  54    --  to-subprogram, and whose expansion incorporates the contracts of the
  55    --  access type declaration. Called from Build_Access_Subprogram_Wrapper.
  56    --  Building the wrapper is done during analysis to perform proper semantic
  57    --  checks on the relevant aspects. The wrapper body could be simplified to
  58    --  a null body when expansion is disabled ???
  59
  60    procedure Build_Or_Copy_Discr_Checking_Funcs (N : Node_Id);
  61    --  For each variant component, builds a function that checks whether
  62    --  the component name is consistent with the current discriminants
  63    --  and sets the component's Dcheck_Function attribute to refer to it.
  64    --  N is the full type declaration node; the discriminant checking
  65    --  functions are inserted after this node.
  66    --  In the case of a derived untagged type, copy the attributes that were
  67    --  set for the components of the parent type onto the components of the
  68    --  derived type; no new subprograms are constructed in this case.
  69
  70    function Build_Initialization_Call
  71      (Loc                 : Source_Ptr;
  72       Id_Ref              : Node_Id;
  73       Typ                 : Entity_Id;
  74       In_Init_Proc        : Boolean := False;
  75       Enclos_Type         : Entity_Id := Empty;
  76       Discr_Map           : Elist_Id := New_Elmt_List;
  77       With_Default_Init   : Boolean := False;
  78       Constructor_Ref     : Node_Id := Empty;
  79       Init_Control_Actual : Entity_Id := Empty) return List_Id;
  80    --  Builds a call to the initialization procedure for the base type of Typ,
  81    --  passing it the object denoted by Id_Ref, plus additional parameters as
  82    --  appropriate for the type (the _Master, for task types, for example).
  83    --  Loc is the source location for the constructed tree. In_Init_Proc has
  84    --  to be set to True when the call is itself in an init proc in order to
  85    --  enable the use of discriminals. Enclos_Type is the enclosing type when
  86    --  initializing a component in an outer init proc, and it is used for
  87    --  various expansion cases including the case where Typ is a task type
  88    --  which is an array component, the indexes of the enclosing type are
  89    --  used to build the string that identifies each task at runtime.
  90    --
  91    --  Discr_Map is used to replace discriminants by their discriminals in
  92    --  expressions used to constrain record components. In the presence of
  93    --  entry families bounded by discriminants, protected type discriminants
  94    --  can appear within expressions in array bounds (not as stand-alone
  95    --  identifiers) and a general replacement is necessary.
  96    --
  97    --  Ada 2005 (AI-287): With_Default_Init is used to indicate that the
  98    --  initialization call corresponds to a default initialized component
  99    --  of an aggregate.
 100    --
 101    --  Constructor_Ref is a call to a constructor subprogram. It is currently
 102    --  used only to support C++ constructors.
 103    --
 104    --  Init_Control_Actual is Empty except in the case where the init proc
 105    --  for a tagged type calls the init proc for its parent type in order
 106    --  to initialize its _Parent component. In that case, it is the
 107    --  actual parameter value corresponding to the Init_Control formal
 108    --  parameter to be used in the call of the parent type's init proc.
 109
 110    function Build_Variant_Record_Equality
 111      (Typ         : Entity_Id;
 112       Spec_Id     : Entity_Id;
 113       Body_Id     : Entity_Id;
 114       Param_Specs : List_Id) return Node_Id;
 115    --  Build the body of the equality function Body_Id for the untagged variant
 116    --  record Typ with the given parameters specification list. If Spec_Id is
 117    --  present, the body is built for a renaming of the equality function.
 118
 119    function Freeze_Type (N : Node_Id) return Boolean;
 120    --  This function executes the freezing actions associated with the given
 121    --  freeze type node N and returns True if the node is to be deleted. We
 122    --  delete the node if it is present just for front end purpose and we don't
 123    --  want Gigi to see the node. This function can't delete the node itself
 124    --  since it would confuse any remaining processing of the freeze node.
 125    --
 126    --  Note: for GNATprove we have a minimal variant of this routine in
 127    --  Exp_SPARK.SPARK_Freeze_Type. They need to be kept in sync.
 128
 129    function Get_Simple_Init_Val
 130      (Typ  : Entity_Id;
 131       N    : Node_Id;
 132       Size : Uint := No_Uint) return Node_Id;
 133    --  Build an expression that represents the required initial value of type
 134    --  Typ for which predicate Needs_Simple_Initialization is True. N is a node
 135    --  whose source location is used in the construction of the expression.
 136    --  Size is used as follows:
 137    --
 138    --    * If the size of the object to be initialized it is known, it should
 139    --      be passed to the routine.
 140    --
 141    --    * If the size is unknown or is zero, then the Esize of Typ is used as
 142    --      an estimate of the size.
 143    --
 144    --  The object size is needed to prepare a known invalid value for use by
 145    --  Normalize_Scalars. A call to this routine where Typ denotes a scalar
 146    --  type is valid only when Normalize_Scalars or Initialize_Scalars is
 147    --  active, or if N is the node for a 'Invalid_Value attribute node.
 148
 149    function Init_Proc_Level_Formal (Proc : Entity_Id) return Entity_Id;
 150    --  Fetch the extra formal from an initalization procedure "proc"
 151    --  corresponding to the level of the object being initialized. When none
 152    --  is present Empty is returned.
 153
 154    procedure Init_Secondary_Tags
 155      (Typ            : Entity_Id;
 156       Target         : Node_Id;
 157       Init_Tags_List : List_Id;
 158       Stmts_List     : List_Id;
 159       Fixed_Comps    : Boolean := True;
 160       Variable_Comps : Boolean := True);
 161    --  Ada 2005 (AI-251): Initialize the tags of the secondary dispatch tables
 162    --  of Typ. The generated code referencing tag fields of Target is appended
 163    --  to Init_Tags_List and the code required to complete the elaboration of
 164    --  the dispatch tables of Typ is appended to Stmts_List. If Fixed_Comps is
 165    --  True then the tag components located at fixed positions of Target are
 166    --  initialized; if Variable_Comps is True then tags components located at
 167    --  variable positions of Target are initialized.
 168
 169    procedure Make_Controlling_Function_Wrappers
 170      (Tag_Typ   : Entity_Id;
 171       Decl_List : out List_Id;
 172       Body_List : out List_Id);
 173    --  Ada 2005 (AI-391): Makes specs and bodies for the wrapper functions
 174    --  associated with inherited functions with controlling results which
 175    --  are not overridden. The body of each wrapper function consists solely
 176    --  of a return statement whose expression is an extension aggregate
 177    --  invoking the inherited subprogram's parent subprogram and extended
 178    --  with a null association list.
 179
 180    procedure Make_Predefined_Primitive_Eq_Spec
 181      (Tag_Typ     : Entity_Id;
 182       Predef_List : List_Id;
 183       Renamed_Eq  : out Entity_Id);
 184    --  Creates spec for the predefined equality on a tagged type Tag_Typ, if
 185    --  required. If created, it will be appended to Predef_List.
 186    --
 187    --  The Parameter Renamed_Eq either returns the value Empty, or else
 188    --  the defining unit name for the predefined equality function in the
 189    --  case where the type has a primitive operation that is a renaming
 190    --  of predefined equality (but only if there is also an overriding
 191    --  user-defined equality function). The returned Renamed_Eq will be
 192    --  passed to the corresponding parameter of Predefined_Primitive_Bodies.
 193
 194    function Make_Tag_Assignment (N : Node_Id) return Node_Id;
 195    --  An object declaration that has an initialization for a tagged object
 196    --  requires a separate reassignment of the tag of the given type, because
 197    --  the expression may include an unchecked conversion. This tag assignment
 198    --  is inserted after the declaration, but if the object has an address
 199    --  clause the assignment is handled as part of the freezing of the object,
 200    --  see Check_Address_Clause.
 201
 202    procedure Predefined_Primitive_Eq_Body
 203      (Tag_Typ     : Entity_Id;
 204       Predef_List : List_Id;
 205       Renamed_Eq  : Entity_Id);
 206    --  Creates body for the predefined equality (and ineqality, if required) on
 207    --  a tagged type Tag_Typ. If created they will be appended to Predef_List.
 208    --
 209    --  The spec for the equality function has been created by
 210    --  Make_Predefined_Primitive_Eq_Spec; see there for description of
 211    --  the Renamed_Eq parameter.
 212
 213    function Stream_Operation_OK
 214      (Typ       : Entity_Id;
 215       Operation : TSS_Name_Type) return Boolean;
 216    --  Check whether the named stream operation must be emitted for a given
 217    --  type. The rules for inheritance of stream attributes by type extensions
 218    --  are enforced by this function. Furthermore, various restrictions prevent
 219    --  the generation of these operations, as a useful optimization or for
 220    --  certification purposes and to save unnecessary generated code.
 221
 222 end Exp_Ch3;