gcc/ada/exp_strm.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             E X P _ S T R M                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-1999 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 --  Routines to build stream subprograms for composite types
  28
  29 with Types; use Types;
  30
  31 package Exp_Strm is
  32
  33    function Build_Elementary_Input_Call (N : Node_Id) return Node_Id;
  34    --  Build call to Read attribute function for elementary type. Also used
  35    --  for Input attributes for elementary types with an appropriate extra
  36    --  assignment statement. N is the attribute reference node.
  37
  38    function Build_Elementary_Write_Call (N : Node_Id) return Node_Id;
  39    --  Build call to Write attribute function for elementary type. Also used
  40    --  for Output attributes for elementary types (since the effect of the
  41    --  two attributes is identical for elementary types). N is the attribute
  42    --  reference node.
  43
  44    function Build_Stream_Attr_Profile
  45      (Loc  : Source_Ptr;
  46       Typ  : Entity_Id;
  47       Nam  : Name_Id)
  48       return List_Id;
  49    --  Builds the parameter profile for the stream attribute identified by
  50    --  the given name (which is the underscore version, e.g. Name_uWrite to
  51    --  identify the Write attribute). This is used for the tagged case to
  52    --  build the spec for the primitive operation.
  53
  54    --  The following routines build procedures and functions for stream
  55    --  attributes applied to composite types. For each of these routines,
  56    --  Loc is used to provide the location for the constructed subprogram
  57    --  declaration. Typ is the base type to which the subprogram applies
  58    --  (i.e. the base type of the stream attribute prefix). The returned
  59    --  results are the declaration and name (entity) of the subprogram.
  60
  61    procedure Build_Array_Input_Function
  62      (Loc  : Source_Ptr;
  63       Typ  : Entity_Id;
  64       Decl : out Node_Id;
  65       Fnam : out Entity_Id);
  66    --  Build function for Input attribute for array type
  67
  68    procedure Build_Array_Output_Procedure
  69      (Loc  : Source_Ptr;
  70       Typ  : Entity_Id;
  71       Decl : out Node_Id;
  72       Pnam : out Entity_Id);
  73    --  Build procedure for Output attribute for array type
  74
  75    procedure Build_Array_Read_Procedure
  76      (Nod  : Node_Id;
  77       Typ  : Entity_Id;
  78       Decl : out Node_Id;
  79       Pnam : out Entity_Id);
  80    --  Build procedure for Read attribute for array type. Nod provides the
  81    --  Sloc value for generated code.
  82
  83    procedure Build_Array_Write_Procedure
  84      (Nod  : Node_Id;
  85       Typ  : Entity_Id;
  86       Decl : out Node_Id;
  87       Pnam : out Entity_Id);
  88    --  Build procedure for Write attribute for array type. Nod provides the
  89    --  Sloc value for generated code.
  90
  91    procedure Build_Mutable_Record_Read_Procedure
  92      (Loc  : Source_Ptr;
  93       Typ  : Entity_Id;
  94       Decl : out Node_Id;
  95       Pnam : out Entity_Id);
  96    --  Build procedure to Read a record with default discriminants.
  97    --  Discriminants must be read explicitly (RM 13.13.2(9)) in the
  98    --  same manner as is done for 'Input.
  99
 100    procedure Build_Mutable_Record_Write_Procedure
 101      (Loc  : Source_Ptr;
 102       Typ  : Entity_Id;
 103       Decl : out Node_Id;
 104       Pnam : out Entity_Id);
 105    --  Build procedure to write a record with default discriminants.
 106    --  Discriminants must be written explicitly (RM 13.13.2(9)) in
 107    --  the same manner as is done for 'Output.
 108
 109    procedure Build_Record_Or_Elementary_Input_Function
 110      (Loc  : Source_Ptr;
 111       Typ  : Entity_Id;
 112       Decl : out Node_Id;
 113       Fnam : out Entity_Id);
 114    --  Build function for Input attribute for record type or for an
 115    --  elementary type (the latter is used only in the case where a
 116    --  user defined Read routine is defined, since in other cases,
 117    --  Input calls the appropriate runtime library routine directly.
 118
 119    procedure Build_Record_Or_Elementary_Output_Procedure
 120      (Loc  : Source_Ptr;
 121       Typ  : Entity_Id;
 122       Decl : out Node_Id;
 123       Pnam : out Entity_Id);
 124    --  Build procedure for Output attribute for record type or for an
 125    --  elementary type (the latter is used only in the case where a
 126    --  user defined Write routine is defined, since in other cases,
 127    --  Output calls the appropriate runtime library routine directly.
 128
 129    procedure Build_Record_Read_Procedure
 130      (Loc  : Source_Ptr;
 131       Typ  : Entity_Id;
 132       Decl : out Node_Id;
 133       Pnam : out Entity_Id);
 134    --  Build procedure for Read attribute for record type
 135
 136    procedure Build_Record_Write_Procedure
 137      (Loc  : Source_Ptr;
 138       Typ  : Entity_Id;
 139       Decl : out Node_Id;
 140       Pnam : out Entity_Id);
 141    --  Build procedure for Write attribute for record type
 142
 143 end Exp_Strm;