gcc/ada/exp_ch7.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              E X P _ C H 7                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2001 Free Software Foundation, Inc.          --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, USA.                                                      --
  21 --                                                                          --
  22 -- GNAT was originally developed  by the GNAT team at  New York University. --
  23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  24 --                                                                          --
  25 ------------------------------------------------------------------------------
  26
  27 with Types; use Types;
  28
  29 package Exp_Ch7 is
  30
  31    procedure Expand_N_Package_Body        (N : Node_Id);
  32    procedure Expand_N_Package_Declaration (N : Node_Id);
  33
  34    ------------------------------
  35    --  Finalization Management --
  36    ------------------------------
  37
  38    function In_Finalization_Root (E : Entity_Id) return Boolean;
  39    --  True if current scope is in package System.Finalization_Root. Used
  40    --  to avoid certain expansions that would involve circularity in the
  41    --  Rtsfind mechanism.
  42
  43    procedure Build_Final_List (N : Node_Id; Typ : Entity_Id);
  44    --  Build finalization list for anonymous access types, and for access
  45    --  types that are frozen before their designated types are known to
  46    --  be controlled.
  47
  48    procedure Build_Controlling_Procs (Typ : Entity_Id);
  49    --  Typ is a record, and array type having controlled components.
  50    --  Create the procedures Deep_Initialize, Deep_Adjust and Deep_Finalize
  51    --  that take care of finalization management at run-time.
  52
  53    procedure Build_Late_Proc (Typ : Entity_Id; Nam : Name_Id);
  54    --  Build one controlling procedure when a late body overrides one of
  55    --  the controlling operations.
  56
  57    function Controller_Component (Typ : Entity_Id) return Entity_Id;
  58    --  Returns the entity of the component whose name is 'Name_uController'
  59
  60    function Controlled_Type (T : Entity_Id) return Boolean;
  61    --  True if T potentially needs finalization actions
  62
  63    function Find_Final_List
  64      (E    : Entity_Id;
  65       Ref  : Node_Id := Empty)
  66       return Node_Id;
  67       --  E is an entity representing a controlled object, a controlled type
  68       --  or a scope. If Ref is not empty, it is a reference to a controlled
  69       --  record, the closest Final list is in the controller component of
  70       --  the record containing Ref otherwise this function returns a
  71       --  reference to the final list attached to the closest dynamic scope
  72       --  (that can be E itself) creating this final list if necessary.
  73
  74    function Has_New_Controlled_Component (E : Entity_Id) return Boolean;
  75    --  E is a type entity. Give the same resul as Has_Controlled_Component
  76    --  except for tagged extensions where the result is True only if the
  77    --  latest extension contains a controlled component.
  78
  79    function Make_Attach_Call
  80      (Obj_Ref      : Node_Id;
  81       Flist_Ref    : Node_Id;
  82       With_Attach  : Node_Id)
  83       return         Node_Id;
  84    --  Attach the referenced object to the referenced Final Chain
  85    --  'Flist_Ref' With_Attach is an expression of type Short_Short_Integer
  86    --  which can be either '0' to signify no attachment, '1' for
  87    --  attachement to a simply linked list or '2' for attachement to a
  88    --  doubly linked list.
  89
  90    function Make_Init_Call
  91      (Ref          : Node_Id;
  92       Typ          : Entity_Id;
  93       Flist_Ref    : Node_Id;
  94       With_Attach  : Node_Id)
  95       return         List_Id;
  96    --  Ref is an expression (with no-side effect and is not required to
  97    --  have been previously analyzed) that references the object to be
  98    --  initialized. Typ is the expected type of Ref, which is a controlled
  99    --  type (Is_Controlled) or a type with controlled components
 100    --  (Has_Controlled). 'Dynamic_Case' controls the way the object is
 101    --  attached which is different whether the object is dynamically
 102    --  allocated or not.
 103    --
 104    --  This function will generate the appropriate calls to make
 105    --  sure that the objects referenced by Ref are initialized. The
 106    --  generate code is quite different depending on the fact the type
 107    --  IS_Controlled or HAS_Controlled but this is not the problem of the
 108    --  caller, the details are in the body.
 109
 110    function Make_Adjust_Call
 111      (Ref          : Node_Id;
 112       Typ          : Entity_Id;
 113       Flist_Ref    : Node_Id;
 114       With_Attach  : Node_Id)
 115       return         List_Id;
 116    --  Ref is an expression (with no-side effect and is not required to
 117    --  have been previously analyzed) that references the object to be
 118    --  adjusted. Typ is the expected type of Ref, which is a controlled
 119    --  type (Is_Controlled) or a type with controlled components
 120    --  (Has_Controlled).
 121    --
 122    --  This function will generate the appropriate calls to make
 123    --  sure that the objects referenced by Ref are adjusted. The generated
 124    --  code is quite different depending on the fact the type IS_Controlled
 125    --  or HAS_Controlled but this is not the problem of the caller, the
 126    --  details are in the body. If the parameter With_Attach is set to
 127    --  True, the finalizable objects involved are attached to the proper
 128    --  finalization chain. The objects must be attached when the adjust
 129    --  takes place after an initialization expression but not when it takes
 130    --  place after a regular assignment.
 131    --
 132    --  The description of With_Attach is completely obsolete ???
 133
 134    function Make_Final_Call
 135      (Ref         : Node_Id;
 136       Typ         : Entity_Id;
 137       With_Detach : Node_Id)
 138       return        List_Id;
 139    --  Ref is an expression (with no-side effect and is not required to
 140    --  have been previously analyzed) that references the object
 141    --  to be Finalized. Typ is the expected type of Ref, which is a
 142    --  controlled type (Is_Controlled) or a type with controlled
 143    --  components (Has_Controlled).
 144    --
 145    --  This function will generate the appropriate calls to make
 146    --  sure that the objects referenced by Ref are finalized. The generated
 147    --  code is quite different depending on the fact the type IS_Controlled
 148    --  or HAS_Controlled but this is not the problem of the caller, the
 149    --  details are in the body. If the parameter With_Detach is set to
 150    --  True, the finalizable objects involved are detached from the proper
 151    --  finalization chain. The objects must be detached when finalizing an
 152    --  unchecked deallocated object but not when finalizing the target of
 153    --  an assignment, it is not necessary either on scope exit.
 154
 155    procedure Expand_Ctrl_Function_Call (N : Node_Id);
 156    --  Expand a call to a function returning a controlled value. That is to
 157    --  say attach the result of the call to the current finalization list,
 158    --  which is the one of the transient scope created for such constructs.
 159
 160    --------------------------------
 161    -- Transient Scope Management --
 162    --------------------------------
 163
 164    procedure Expand_Cleanup_Actions (N : Node_Id);
 165    --  Expand the necessary stuff into a scope to enable finalization of local
 166    --  objects and deallocation of transient data when exiting the scope. N is
 167    --  a "scope node" that is to say one of the following: N_Block_Statement,
 168    --  N_Subprogram_Body, N_Task_Body, N_Entry_Body.
 169
 170    procedure Establish_Transient_Scope (N : Node_Id; Sec_Stack : Boolean);
 171    --  Push a new transient scope on the scope stack. N is the node responsible
 172    --  for the need of a transient scope. If Sec_Stack is True then the
 173    --  secondary stack is brought in, otherwise it isn't.
 174
 175    function Node_To_Be_Wrapped return Node_Id;
 176    --  return the node to be wrapped if the current scope is transient.
 177
 178    procedure Store_Before_Actions_In_Scope (L : List_Id);
 179    --  Append the list L of actions to the end of the before-actions store
 180    --  in the top of the scope stack
 181
 182    procedure Store_After_Actions_In_Scope (L : List_Id);
 183    --  Append the list L of actions to the beginning of the after-actions
 184    --  store in the top of the scope stack
 185
 186    procedure Wrap_Transient_Declaration (N : Node_Id);
 187    --  N is an object declaration. Expand the finalization calls after the
 188    --  declaration and make the outer scope beeing the transient one.
 189
 190    procedure Wrap_Transient_Expression (N : Node_Id);
 191    --  N is a sub-expression. Expand a transient block around an expression
 192
 193    procedure Wrap_Transient_Statement (N : Node_Id);
 194    --  N is a statement. Expand a transient block around an instruction
 195
 196 end Exp_Ch7;