gcc/ada/g-io.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                              G N A T . I O                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                     Copyright (C) 1995-2005, AdaCore                     --
  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 --  A simple preelaborable subset of Text_IO capabilities
  35
  36 --  A simple text I/O package that can be used for simple I/O functions in
  37 --  user programs as required. This package is also preelaborated, unlike
  38 --  Text_IO, and can thus be with'ed by preelaborated library units.
  39
  40 --  Note that Data_Error is not raised by these subprograms for bad data.
  41 --  If such checks are needed then the regular Text_IO package must be used.
  42
  43 package GNAT.IO is
  44    pragma Preelaborate;
  45
  46    type File_Type is limited private;
  47    --  Specifies file to be used (the only possibilities are Standard_Output
  48    --  and Standard_Error). There is no Create or Open facility that would
  49    --  allow more general use of file names.
  50
  51    function Standard_Output return File_Type;
  52    function Standard_Error  return File_Type;
  53    --  These functions are the only way to get File_Type values
  54
  55    procedure Get (X : out Integer);
  56    procedure Get (C : out Character);
  57    procedure Get_Line (Item : out String; Last : out Natural);
  58    --  These routines always read from Standard_Input
  59
  60    procedure Put (File : File_Type; X : Integer);
  61    procedure Put (X : Integer);
  62    --  Output integer to specified file, or to current output file, same
  63    --  output as if Ada.Text_IO.Integer_IO had been instantiated for Integer.
  64
  65    procedure Put (File : File_Type; C : Character);
  66    procedure Put (C : Character);
  67    --  Output character to specified file, or to current output file
  68
  69    procedure Put (File : File_Type; S : String);
  70    procedure Put (S : String);
  71    --  Output string to specified file, or to current output file
  72
  73    procedure Put_Line (File : File_Type; S : String);
  74    procedure Put_Line (S : String);
  75    --  Output string followed by new line to specified file, or to
  76    --  current output file.
  77
  78    procedure New_Line (File : File_Type; Spacing : Positive := 1);
  79    procedure New_Line (Spacing : Positive := 1);
  80    --  Output new line character to specified file, or to current output file
  81
  82    procedure Set_Output (File : File_Type);
  83    --  Set current output file, default is Standard_Output if no call to
  84    --  Set_Output is made.
  85
  86 private
  87    type File_Type is (Stdout, Stderr);
  88    --  Stdout = Standard_Output, Stderr = Standard_Error
  89
  90    pragma Inline (Standard_Error);
  91    pragma Inline (Standard_Output);
  92
  93 end GNAT.IO;