home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gnat-2.06-src.tgz / tar.out / fsf / gnat / ada / a-tigeau.ads < prev    next >
Text File  |  1996-09-28  |  8KB  |  182 lines
  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: 1.9 $                              --
  10. --                                                                          --
  11. --        Copyright (c) 1992,1993,1994, 1995 NYU, All Rights Reserved       --
  12. --                                                                          --
  13. -- The GNAT library is free software; you can redistribute it and/or modify --
  14. -- it under terms of the GNU Library General Public License as published by --
  15. -- the Free Software  Foundation; either version 2, or (at your option) any --
  16. -- later version.  The GNAT library is distributed in the hope that it will --
  17. -- be useful, but WITHOUT ANY WARRANTY;  without even  the implied warranty --
  18. -- of MERCHANTABILITY  or  FITNESS FOR  A PARTICULAR PURPOSE.  See the  GNU --
  19. -- Library  General  Public  License for  more  details.  You  should  have --
  20. -- received  a copy of the GNU  Library  General Public License  along with --
  21. -- the GNAT library;  see the file  COPYING.LIB.  If not, write to the Free --
  22. -- Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.        --
  23. --                                                                          --
  24. ------------------------------------------------------------------------------
  25.  
  26. --  This package contains a set of auxiliary routines used by the Text_IO
  27. --  generic children, including for reading and writing numeric strings.
  28.  
  29. package Ada.Text_IO.Generic_Aux is
  30.  
  31.    --  Note: for all the Load routines, File indicates the file to be read,
  32.    --  Buf is the string into which data is stored, Ptr is the index of the
  33.    --  last character stored so far, and is updated if additional characters
  34.    --  are stored. Data_Error is raised if the input overflows Buf. The only
  35.    --  Load routines that do a file status check are Load_Skip and Load_Width
  36.    --  so one of these two routines must be called first.
  37.  
  38.    procedure Check_End_Of_Field
  39.      (File  : File_Type;
  40.       Buf   : String;
  41.       Stop  : Integer;
  42.       Ptr   : Integer;
  43.       Width : Field);
  44.    --  This routine is used after doing a get operations on a numeric value.
  45.    --  Buf is the string being scanned, and Stop is the last character of
  46.    --  the field being scanned. Ptr is as set by the call to the scan routine
  47.    --  that scanned out the numeric value, i.e. it points one past the last
  48.    --  character scanned, and Width is the width parameter from the Get call.
  49.    --
  50.    --  There are two cases, if Width is non-zero, then a check is made that
  51.    --  the remainder of the field is all blanks. If Width is non-zero, then
  52.    --  it means that the scan routine scanned out only part of the field. We
  53.    --  have already scanned out the field that the ACVC tests seem to expect
  54.    --  us to read (even if it does not follow the syntax of the type being
  55.    --  scanned, e.g. allowing negative exponents in integers, and underscores
  56.    --  at the end of the string), so we just raise Data_Error.
  57.  
  58.    procedure Check_On_One_Line (File : File_Type; Length : Integer);
  59.    --  Check to see if item of length Integer characters can fit on
  60.    --  current line. Call New_Line if not, first checking that the
  61.    --  line length can accomodate Length characters, raise Layout_Error
  62.    --  if item is too large for a single line.
  63.  
  64.    function Getc (File : File_Type) return Integer;
  65.    --  Gets next character from file, which has already been checked for
  66.    --  being in read status, and returns the character read if no error
  67.    --  occurs. The result is EOF if the end of file was read. Note that
  68.    --  the Col value is not bumped, so it is the caller's responsibility
  69.    --  to bump it if necessary.
  70.  
  71.    function Is_Blank (C : Character) return Boolean;
  72.    --  Determines if C is a blank (space or tab)
  73.  
  74.    procedure Load_Width
  75.      (File  : File_Type;
  76.       Width : in Field;
  77.       Buf   : out String;
  78.       Ptr   : in out Integer);
  79.    --  Loads exactly Width characters, unless a line mark is encountered first
  80.  
  81.    procedure Load_Skip (File  : File_Type);
  82.    --  Skips leading blanks and line and page marks, if the end of file is
  83.    --  read without finding a non-blank character, then End_Error is raised.
  84.    --  Note: a blank is defined as a space or horizontal tab (RM A.10.6(5)).
  85.  
  86.    procedure Load
  87.      (File   : File_Type;
  88.       Buf    : out String;
  89.       Ptr    : in out Integer;
  90.       Char   : Character;
  91.       Loaded : out Boolean);
  92.    --  If next character is Char, loads it, otherwise no characters are loaded
  93.    --  Loaded is set to indicate whether or not the character was found.
  94.  
  95.    procedure Load
  96.      (File   : File_Type;
  97.       Buf    : out String;
  98.       Ptr    : in out Integer;
  99.       Char   : Character);
  100.    --  Same as above, but no indication if character is loaded
  101.  
  102.    procedure Load
  103.      (File   : File_Type;
  104.       Buf    : out String;
  105.       Ptr    : in out Integer;
  106.       Char1  : Character;
  107.       Char2  : Character;
  108.       Loaded : out Boolean);
  109.    --  If next character is Char1 or Char2, loads it, otherwise no characters
  110.    --  are loaded. Loaded is set to indicate whether or not one of the two
  111.    --  characters was found.
  112.  
  113.    procedure Load
  114.      (File   : File_Type;
  115.       Buf    : out String;
  116.       Ptr    : in out Integer;
  117.       Char1  : Character;
  118.       Char2  : Character);
  119.    --  Same as above, but no indication if character is loaded
  120.  
  121.    procedure Load_Digits
  122.      (File   : File_Type;
  123.       Buf    : out String;
  124.       Ptr    : in out Integer;
  125.       Loaded : out Boolean);
  126.    --  Loads a sequence of zero or more decimal digits. Loaded is set if
  127.    --  at least one digit is loaded.
  128.  
  129.    procedure Load_Digits
  130.      (File   : File_Type;
  131.       Buf    : out String;
  132.       Ptr    : in out Integer);
  133.    --  Same as above, but no indication if character is loaded
  134.  
  135.    procedure Load_Extended_Digits
  136.      (File   : File_Type;
  137.       Buf    : out String;
  138.       Ptr    : in out Integer;
  139.       Loaded : out Boolean);
  140.    --  Like Load_Digits, but also allows extended digits a-f and A-F
  141.  
  142.    procedure Load_Extended_Digits
  143.      (File   : File_Type;
  144.       Buf    : out String;
  145.       Ptr    : in out Integer);
  146.    --  Same as above, but no indication if character is loaded
  147.  
  148.    function Nextc (File : File_Type) return Integer;
  149.    --  Like Getc, but includes a call to Ungetc, so that the file
  150.    --  pointer is not moved by the call.
  151.  
  152.    procedure Put_Item (File : File_Type; Str : String);
  153.    --  This routine is like Text_IO.Put, except that it checks for overflow
  154.    --  of bounded lines, as described in (RM A.10.6(8)). It is used for
  155.    --  all output of numeric values and of enumeration values.
  156.  
  157.    procedure Store_Char
  158.      (File : File_Type;
  159.       ch   : Integer;
  160.       Buf  : out String;
  161.       Ptr  : in out Integer);
  162.    --  Store a single character in buffer, checking for overflow and
  163.    --  adjusting the column number in the file to reflect the fact
  164.    --  that a character has been acquired from the input stream.
  165.  
  166.    procedure String_Skip (Str : String; Ptr : out Positive'Base);
  167.    --  Used in the Get from string procedures to skip leading blanks in the
  168.    --  string. Ptr is set to the index of the first non-blank. If the string
  169.    --  is all blanks, then the excption End_Error is raised, Note that blank
  170.    --  is defined as a space or horizontal tab (RM A.10.6(5)).
  171.  
  172.    procedure Ungetc (ch : Integer; File : File_Type);
  173.    --  Pushes back character into stream, using ungetc. The caller has
  174.    --  checked that the file is in read status. Device_Error is raised
  175.    --  if the character cannot be pushed back. An attempt to push back
  176.    --  an end of file (EOF) is ignored.
  177.  
  178. private
  179.    pragma Inline (Is_Blank);
  180.  
  181. end Ada.Text_IO.Generic_Aux;
  182.