gcc/ada/a-tigeau.ads

   1 -----------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUNTIME COMPONENTS                          --
   4 --                                                                          --
   5 --              A D A . T E X T _ I O . G E N E R I C _ A U X               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                            $Revision$
  10 --                                                                          --
  11 --          Copyright (C) 1992-2001 Free Software Foundation, Inc.          --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- As a special exception,  if other files  instantiate  generics from this --
  25 -- unit, or you link  this unit with other files  to produce an executable, --
  26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27 -- covered  by the  GNU  General  Public  License.  This exception does not --
  28 -- however invalidate  any other reasons why  the executable file  might be --
  29 -- covered by the  GNU Public License.                                      --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  This package contains a set of auxiliary routines used by the Text_IO
  37 --  generic children, including for reading and writing numeric strings.
  38
  39 private package Ada.Text_IO.Generic_Aux is
  40
  41    --  Note: for all the Load routines, File indicates the file to be read,
  42    --  Buf is the string into which data is stored, Ptr is the index of the
  43    --  last character stored so far, and is updated if additional characters
  44    --  are stored. Data_Error is raised if the input overflows Buf. The only
  45    --  Load routines that do a file status check are Load_Skip and Load_Width
  46    --  so one of these two routines must be called first.
  47
  48    procedure Check_End_Of_Field
  49      (File  : File_Type;
  50       Buf   : String;
  51       Stop  : Integer;
  52       Ptr   : Integer;
  53       Width : Field);
  54    --  This routine is used after doing a get operations on a numeric value.
  55    --  Buf is the string being scanned, and Stop is the last character of
  56    --  the field being scanned. Ptr is as set by the call to the scan routine
  57    --  that scanned out the numeric value, i.e. it points one past the last
  58    --  character scanned, and Width is the width parameter from the Get call.
  59    --
  60    --  There are two cases, if Width is non-zero, then a check is made that
  61    --  the remainder of the field is all blanks. If Width is zero, then it
  62    --  means that the scan routine scanned out only part of the field. We
  63    --  have already scanned out the field that the ACVC tests seem to expect
  64    --  us to read (even if it does not follow the syntax of the type being
  65    --  scanned, e.g. allowing negative exponents in integers, and underscores
  66    --  at the end of the string), so we just raise Data_Error.
  67
  68    procedure Check_On_One_Line (File : File_Type; Length : Integer);
  69    --  Check to see if item of length Integer characters can fit on
  70    --  current line. Call New_Line if not, first checking that the
  71    --  line length can accommodate Length characters, raise Layout_Error
  72    --  if item is too large for a single line.
  73
  74    function Getc (File : File_Type) return Integer;
  75    --  Gets next character from file, which has already been checked for
  76    --  being in read status, and returns the character read if no error
  77    --  occurs. The result is EOF if the end of file was read. Note that
  78    --  the Col value is not bumped, so it is the caller's responsibility
  79    --  to bump it if necessary.
  80
  81    function Is_Blank (C : Character) return Boolean;
  82    --  Determines if C is a blank (space or tab)
  83
  84    procedure Load_Width
  85      (File  : File_Type;
  86       Width : in Field;
  87       Buf   : out String;
  88       Ptr   : in out Integer);
  89    --  Loads exactly Width characters, unless a line mark is encountered first
  90
  91    procedure Load_Skip (File  : File_Type);
  92    --  Skips leading blanks and line and page marks, if the end of file is
  93    --  read without finding a non-blank character, then End_Error is raised.
  94    --  Note: a blank is defined as a space or horizontal tab (RM A.10.6(5)).
  95
  96    procedure Load
  97      (File   : File_Type;
  98       Buf    : out String;
  99       Ptr    : in out Integer;
 100       Char   : Character;
 101       Loaded : out Boolean);
 102    --  If next character is Char, loads it, otherwise no characters are loaded
 103    --  Loaded is set to indicate whether or not the character was found.
 104
 105    procedure Load
 106      (File   : File_Type;
 107       Buf    : out String;
 108       Ptr    : in out Integer;
 109       Char   : Character);
 110    --  Same as above, but no indication if character is loaded
 111
 112    procedure Load
 113      (File   : File_Type;
 114       Buf    : out String;
 115       Ptr    : in out Integer;
 116       Char1  : Character;
 117       Char2  : Character;
 118       Loaded : out Boolean);
 119    --  If next character is Char1 or Char2, loads it, otherwise no characters
 120    --  are loaded. Loaded is set to indicate whether or not one of the two
 121    --  characters was found.
 122
 123    procedure Load
 124      (File   : File_Type;
 125       Buf    : out String;
 126       Ptr    : in out Integer;
 127       Char1  : Character;
 128       Char2  : Character);
 129    --  Same as above, but no indication if character is loaded
 130
 131    procedure Load_Digits
 132      (File   : File_Type;
 133       Buf    : out String;
 134       Ptr    : in out Integer;
 135       Loaded : out Boolean);
 136    --  Loads a sequence of zero or more decimal digits. Loaded is set if
 137    --  at least one digit is loaded.
 138
 139    procedure Load_Digits
 140      (File   : File_Type;
 141       Buf    : out String;
 142       Ptr    : in out Integer);
 143    --  Same as above, but no indication if character is loaded
 144
 145    procedure Load_Extended_Digits
 146      (File   : File_Type;
 147       Buf    : out String;
 148       Ptr    : in out Integer;
 149       Loaded : out Boolean);
 150    --  Like Load_Digits, but also allows extended digits a-f and A-F
 151
 152    procedure Load_Extended_Digits
 153      (File   : File_Type;
 154       Buf    : out String;
 155       Ptr    : in out Integer);
 156    --  Same as above, but no indication if character is loaded
 157
 158    function Nextc (File : File_Type) return Integer;
 159    --  Like Getc, but includes a call to Ungetc, so that the file
 160    --  pointer is not moved by the call.
 161
 162    procedure Put_Item (File : File_Type; Str : String);
 163    --  This routine is like Text_IO.Put, except that it checks for overflow
 164    --  of bounded lines, as described in (RM A.10.6(8)). It is used for
 165    --  all output of numeric values and of enumeration values.
 166
 167    procedure Store_Char
 168      (File : File_Type;
 169       ch   : Integer;
 170       Buf  : out String;
 171       Ptr  : in out Integer);
 172    --  Store a single character in buffer, checking for overflow and
 173    --  adjusting the column number in the file to reflect the fact
 174    --  that a character has been acquired from the input stream.
 175
 176    procedure String_Skip (Str : String; Ptr : out Integer);
 177    --  Used in the Get from string procedures to skip leading blanks in the
 178    --  string. Ptr is set to the index of the first non-blank. If the string
 179    --  is all blanks, then the excption End_Error is raised, Note that blank
 180    --  is defined as a space or horizontal tab (RM A.10.6(5)).
 181
 182    procedure Ungetc (ch : Integer; File : File_Type);
 183    --  Pushes back character into stream, using ungetc. The caller has
 184    --  checked that the file is in read status. Device_Error is raised
 185    --  if the character cannot be pushed back. An attempt to push back
 186    --  an end of file (EOF) is ignored.
 187
 188 private
 189    pragma Inline (Is_Blank);
 190
 191 end Ada.Text_IO.Generic_Aux;