1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- A D A . W I D E _ T E X T _ I O . G E N E R I C _ A U X --
11 -- Copyright (C) 1992-1997 Free Software Foundation, Inc. --
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. --
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. --
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). --
34 ------------------------------------------------------------------------------
36 -- This package contains a set of auxiliary routines used by Wide_Text_IO
37 -- generic children, including for reading and writing numeric strings.
39 -- Note: although this is the Wide version of the package, the interface
40 -- here is still in terms of Character and String rather than Wide_Character
41 -- and Wide_String, since all numeric strings are composed entirely of
42 -- characters in the range of type Standard.Character, and the basic
43 -- conversion routines work with Character rather than Wide_Character.
45 package Ada.Wide_Text_IO.Generic_Aux is
47 -- Note: for all the Load routines, File indicates the file to be read,
48 -- Buf is the string into which data is stored, Ptr is the index of the
49 -- last character stored so far, and is updated if additional characters
50 -- are stored. Data_Error is raised if the input overflows Buf. The only
51 -- Load routines that do a file status check are Load_Skip and Load_Width
52 -- so one of these two routines must be called first.
54 procedure Check_End_Of_Field
60 -- This routine is used after doing a get operations on a numeric value.
61 -- Buf is the string being scanned, and Stop is the last character of
62 -- the field being scanned. Ptr is as set by the call to the scan routine
63 -- that scanned out the numeric value, i.e. it points one past the last
64 -- character scanned, and Width is the width parameter from the Get call.
66 -- There are two cases, if Width is non-zero, then a check is made that
67 -- the remainder of the field is all blanks. If Width is zero, then it
68 -- means that the scan routine scanned out only part of the field. We
69 -- have already scanned out the field that the ACVC tests seem to expect
70 -- us to read (even if it does not follow the syntax of the type being
71 -- scanned, e.g. allowing negative exponents in integers, and underscores
72 -- at the end of the string), so we just raise Data_Error.
74 procedure Check_On_One_Line (File : File_Type; Length : Integer);
75 -- Check to see if item of length Integer characters can fit on
76 -- current line. Call New_Line if not, first checking that the
77 -- line length can accommodate Length characters, raise Layout_Error
78 -- if item is too large for a single line.
80 function Is_Blank (C : Character) return Boolean;
81 -- Determines if C is a blank (space or tab)
87 Ptr : in out Integer);
88 -- Loads exactly Width characters, unless a line mark is encountered first
90 procedure Load_Skip (File : File_Type);
91 -- Skips leading blanks and line and page marks, if the end of file is
92 -- read without finding a non-blank character, then End_Error is raised.
93 -- Note: a blank is defined as a space or horizontal tab (RM A.10.6(5)).
100 Loaded : out Boolean);
101 -- If next character is Char, loads it, otherwise no characters are loaded
102 -- Loaded is set to indicate whether or not the character was found.
107 Ptr : in out Integer;
109 -- Same as above, but no indication if character is loaded
114 Ptr : in out Integer;
117 Loaded : out Boolean);
118 -- If next character is Char1 or Char2, loads it, otherwise no characters
119 -- are loaded. Loaded is set to indicate whether or not one of the two
120 -- characters was found.
125 Ptr : in out Integer;
128 -- Same as above, but no indication if character is loaded
130 procedure Load_Digits
133 Ptr : in out Integer;
134 Loaded : out Boolean);
135 -- Loads a sequence of zero or more decimal digits. Loaded is set if
136 -- at least one digit is loaded.
138 procedure Load_Digits
141 Ptr : in out Integer);
142 -- Same as above, but no indication if character is loaded
144 procedure Load_Extended_Digits
147 Ptr : in out Integer;
148 Loaded : out Boolean);
149 -- Like Load_Digits, but also allows extended digits a-f and A-F
151 procedure Load_Extended_Digits
154 Ptr : in out Integer);
155 -- Same as above, but no indication if character is loaded
157 procedure Put_Item (File : File_Type; Str : String);
158 -- This routine is like Wide_Text_IO.Put, except that it checks for
159 -- overflow of bounded lines, as described in (RM A.10.6(8)). It is used
160 -- for all output of numeric values and of enumeration values. Note that
161 -- the buffer is of type String. Put_Item deals with converting this to
162 -- Wide_Characters as required.
168 Ptr : in out Integer);
169 -- Store a single character in buffer, checking for overflow and
170 -- adjusting the column number in the file to reflect the fact
171 -- that a character has been acquired from the input stream.
172 -- The pos value of the character to store is in ch on entry.
174 procedure String_Skip (Str : String; Ptr : out Integer);
175 -- Used in the Get from string procedures to skip leading blanks in the
176 -- string. Ptr is set to the index of the first non-blank. If the string
177 -- is all blanks, then the excption End_Error is raised, Note that blank
178 -- is defined as a space or horizontal tab (RM A.10.6(5)).
180 procedure Ungetc (ch : Integer; File : File_Type);
181 -- Pushes back character into stream, using ungetc. The caller has
182 -- checked that the file is in read status. Device_Error is raised
183 -- if the character cannot be pushed back. An attempt to push back
184 -- an end of file (EOF) is ignored.
187 pragma Inline (Is_Blank);
189 end Ada.Wide_Text_IO.Generic_Aux;