gcc/ada/a-suteio.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --         A D A . S T R I N G S . U N B O U N D E D . T E X T _ I O        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1997-2005, 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,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  This child package of Ada.Strings.Unbounded provides some specialized
  35 --  Text_IO routines that work directly with unbounded strings, avoiding the
  36 --  inefficiencies of access via the standard interface, and also taking
  37 --  direct advantage of the variable length semantics of these strings.
  38
  39 with Ada.Text_IO;
  40
  41 package Ada.Strings.Unbounded.Text_IO is
  42
  43    function Get_Line                                return Unbounded_String;
  44    function Get_Line (File : Ada.Text_IO.File_Type) return Unbounded_String;
  45    --  Reads up to the end of the current line, returning the result
  46    --  as an unbounded string of appropriate length. If no File parameter
  47    --  is present, input is from Current_Input.
  48
  49    procedure Get_Line
  50      (File : Ada.Text_IO.File_Type;
  51       Item : out Unbounded_String);
  52    procedure Get_Line (Item : out Unbounded_String);
  53    --  Similar to the above, but in procedure form with an out parameter
  54
  55    procedure Put                                    (U : Unbounded_String);
  56    procedure Put      (File : Ada.Text_IO.File_Type; U : Unbounded_String);
  57    procedure Put_Line                               (U : Unbounded_String);
  58    procedure Put_Line (File : Ada.Text_IO.File_Type; U : Unbounded_String);
  59    --  These are equivalent to the standard Text_IO routines passed the
  60    --  value To_String (U), but operate more efficiently, because the extra
  61    --  copy of the argument is avoided.
  62
  63 end Ada.Strings.Unbounded.Text_IO;