gcc/ada/a-witeio.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                     A D A . W I D E _ T E X T _ I O                      --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2005 Free Software Foundation, Inc.          --
  10 --                                                                          --
  11 -- This specification is derived from the Ada Reference Manual for use with --
  12 -- GNAT. The copyright notice above, and the license provisions that follow --
  13 -- apply solely to the  contents of the part following the private keyword. --
  14 --                                                                          --
  15 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  16 -- terms of the  GNU General Public License as published  by the Free Soft- --
  17 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  18 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  19 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  20 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  21 -- for  more details.  You should have  received  a copy of the GNU General --
  22 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  23 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  24 -- MA 02111-1307, USA.                                                      --
  25 --                                                                          --
  26 -- As a special exception,  if other files  instantiate  generics from this --
  27 -- unit, or you link  this unit with other files  to produce an executable, --
  28 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  29 -- covered  by the  GNU  General  Public  License.  This exception does not --
  30 -- however invalidate  any other reasons why  the executable file  might be --
  31 -- covered by the  GNU Public License.                                      --
  32 --                                                                          --
  33 -- GNAT was originally developed  by the GNAT team at  New York University. --
  34 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  35 --                                                                          --
  36 ------------------------------------------------------------------------------
  37
  38 --  Note: the generic subpackages of Wide_Text_IO (Integer_IO, Float_IO,
  39 --  Fixed_IO, Modular_IO, Decimal_IO and Enumeration_IO) appear as private
  40 --  children in GNAT. These children are with'ed automatically if they are
  41 --  referenced, so this rearrangement is invisible to user programs, but has
  42 --  the advantage that only the needed parts of Wide_Text_IO are processed
  43 --  and loaded.
  44
  45 with Ada.IO_Exceptions;
  46 with Ada.Streams;
  47 with System;
  48 with System.File_Control_Block;
  49 with System.WCh_Con;
  50
  51 package Ada.Wide_Text_IO is
  52
  53    package WCh_Con renames System.WCh_Con;
  54
  55    type File_Type is limited private;
  56    type File_Mode is (In_File, Out_File, Append_File);
  57
  58    --  The following representation clause allows the use of unchecked
  59    --  conversion for rapid translation between the File_Mode type
  60    --  used in this package and System.File_IO.
  61
  62    for File_Mode use
  63      (In_File     => 0,  -- System.FIle_IO.File_Mode'Pos (In_File)
  64       Out_File    => 2,  -- System.File_IO.File_Mode'Pos (Out_File)
  65       Append_File => 3); -- System.File_IO.File_Mode'Pos (Append_File)
  66
  67    type Count is range 0 .. Natural'Last;
  68    --  The value of Count'Last must be large enough so that the assumption
  69    --  enough so that the assumption that the Line, Column and Page
  70    --  counts can never exceed this value is a valid assumption.
  71
  72    subtype Positive_Count is Count range 1 .. Count'Last;
  73
  74    Unbounded : constant Count := 0;
  75    --  Line and page length
  76
  77    subtype Field is Integer range 0 .. 255;
  78    --  Note: if for any reason, there is a need to increase this value,
  79    --  then it will be necessary to change the corresponding value in
  80    --  System.Img_Real in file s-imgrea.adb.
  81
  82    subtype Number_Base is Integer range 2 .. 16;
  83
  84    type Type_Set is (Lower_Case, Upper_Case);
  85
  86    ---------------------
  87    -- File Management --
  88    ---------------------
  89
  90    procedure Create
  91      (File : in out File_Type;
  92       Mode : File_Mode := Out_File;
  93       Name : String := "";
  94       Form : String := "");
  95
  96    procedure Open
  97      (File : in out File_Type;
  98       Mode : File_Mode;
  99       Name : String;
 100       Form : String := "");
 101
 102    procedure Close  (File : in out File_Type);
 103    procedure Delete (File : in out File_Type);
 104    procedure Reset  (File : in out File_Type; Mode : File_Mode);
 105    procedure Reset  (File : in out File_Type);
 106
 107    function Mode (File : File_Type) return File_Mode;
 108    function Name (File : File_Type) return String;
 109    function Form (File : File_Type) return String;
 110
 111    function Is_Open (File : File_Type) return Boolean;
 112
 113    ------------------------------------------------------
 114    -- Control of default input, output and error files --
 115    ------------------------------------------------------
 116
 117    procedure Set_Input  (File : File_Type);
 118    procedure Set_Output (File : File_Type);
 119    procedure Set_Error  (File : File_Type);
 120
 121    function Standard_Input  return File_Type;
 122    function Standard_Output return File_Type;
 123    function Standard_Error  return File_Type;
 124
 125    function Current_Input  return File_Type;
 126    function Current_Output return File_Type;
 127    function Current_Error  return File_Type;
 128
 129    type File_Access is access constant File_Type;
 130
 131    function Standard_Input  return File_Access;
 132    function Standard_Output return File_Access;
 133    function Standard_Error  return File_Access;
 134
 135    function Current_Input  return File_Access;
 136    function Current_Output return File_Access;
 137    function Current_Error  return File_Access;
 138
 139    --------------------
 140    -- Buffer control --
 141    --------------------
 142
 143    --  Note: The paramter file is in out in the RM, but as pointed out
 144    --  in <<95-5166.a Tucker Taft 95-6-23>> this is clearly an oversight.
 145
 146    procedure Flush (File : File_Type);
 147    procedure Flush;
 148
 149    --------------------------------------------
 150    -- Specification of line and page lengths --
 151    --------------------------------------------
 152
 153    procedure Set_Line_Length (File : File_Type; To : Count);
 154    procedure Set_Line_Length (To : Count);
 155
 156    procedure Set_Page_Length (File : File_Type; To : Count);
 157    procedure Set_Page_Length (To : Count);
 158
 159    function Line_Length (File : File_Type) return Count;
 160    function Line_Length return Count;
 161
 162    function Page_Length (File : File_Type) return Count;
 163    function Page_Length return Count;
 164
 165    ------------------------------------
 166    -- Column, Line, and Page Control --
 167    ------------------------------------
 168
 169    procedure New_Line (File : File_Type; Spacing : Positive_Count := 1);
 170    procedure New_Line (Spacing : Positive_Count := 1);
 171
 172    procedure Skip_Line (File : File_Type; Spacing : Positive_Count := 1);
 173    procedure Skip_Line (Spacing : Positive_Count := 1);
 174
 175    function End_Of_Line (File : File_Type) return Boolean;
 176    function End_Of_Line return Boolean;
 177
 178    procedure New_Page (File : File_Type);
 179    procedure New_Page;
 180
 181    procedure Skip_Page (File : File_Type);
 182    procedure Skip_Page;
 183
 184    function End_Of_Page (File : File_Type) return Boolean;
 185    function End_Of_Page return Boolean;
 186
 187    function End_Of_File (File : File_Type) return Boolean;
 188    function End_Of_File return Boolean;
 189
 190    procedure Set_Col (File : File_Type;  To : Positive_Count);
 191    procedure Set_Col (To : Positive_Count);
 192
 193    procedure Set_Line (File : File_Type; To : Positive_Count);
 194    procedure Set_Line (To : Positive_Count);
 195
 196    function Col (File : File_Type) return Positive_Count;
 197    function Col return Positive_Count;
 198
 199    function Line (File : File_Type) return Positive_Count;
 200    function Line return Positive_Count;
 201
 202    function Page (File : File_Type) return Positive_Count;
 203    function Page return Positive_Count;
 204
 205    ----------------------------
 206    -- Character Input-Output --
 207    ----------------------------
 208
 209    procedure Get (File : File_Type; Item : out Wide_Character);
 210    procedure Get (Item : out Wide_Character);
 211    procedure Put (File : File_Type; Item : Wide_Character);
 212    procedure Put (Item : Wide_Character);
 213
 214    procedure Look_Ahead
 215      (File        : File_Type;
 216       Item        : out Wide_Character;
 217       End_Of_Line : out Boolean);
 218
 219    procedure Look_Ahead
 220      (Item        : out Wide_Character;
 221       End_Of_Line : out Boolean);
 222
 223    procedure Get_Immediate
 224      (File : File_Type;
 225       Item : out Wide_Character);
 226
 227    procedure Get_Immediate
 228      (Item : out Wide_Character);
 229
 230    procedure Get_Immediate
 231      (File      : File_Type;
 232       Item      : out Wide_Character;
 233       Available : out Boolean);
 234
 235    procedure Get_Immediate
 236      (Item      : out Wide_Character;
 237       Available : out Boolean);
 238
 239    -------------------------
 240    -- String Input-Output --
 241    -------------------------
 242
 243    procedure Get (File : File_Type; Item : out Wide_String);
 244    procedure Get (Item : out Wide_String);
 245    procedure Put (File : File_Type; Item : Wide_String);
 246    procedure Put (Item : Wide_String);
 247
 248    procedure Get_Line
 249      (File : File_Type;
 250       Item : out Wide_String;
 251       Last : out Natural);
 252
 253    procedure Get_Line
 254      (Item : out Wide_String;
 255       Last : out Natural);
 256
 257    function Get_Line (File : File_Type) return Wide_String;
 258    pragma Ada_05 (Get_Line);
 259
 260    function Get_Line return Wide_String;
 261    pragma Ada_05 (Get_Line);
 262
 263    procedure Put_Line
 264      (File : File_Type;
 265       Item : Wide_String);
 266
 267    procedure Put_Line
 268      (Item : Wide_String);
 269
 270    ---------------------------------------
 271    -- Generic packages for Input-Output --
 272    ---------------------------------------
 273
 274    --  The generic packages:
 275
 276    --    Ada.Wide_Text_IO.Integer_IO
 277    --    Ada.Wide_Text_IO.Modular_IO
 278    --    Ada.Wide_Text_IO.Float_IO
 279    --    Ada.Wide_Text_IO.Fixed_IO
 280    --    Ada.Wide_Text_IO.Decimal_IO
 281    --    Ada.Wide_Text_IO.Enumeration_IO
 282
 283    --  are implemented as separate child packages in GNAT, so the
 284    --  spec and body of these packages are to be found in separate
 285    --  child units. This implementation detail is hidden from the
 286    --  Ada programmer by special circuitry in the compiler that
 287    --  treats these child packages as though they were nested in
 288    --  Text_IO. The advantage of this special processing is that
 289    --  the subsidiary routines needed if these generics are used
 290    --  are not loaded when they are not used.
 291
 292    ----------------
 293    -- Exceptions --
 294    ----------------
 295
 296    Status_Error : exception renames IO_Exceptions.Status_Error;
 297    Mode_Error   : exception renames IO_Exceptions.Mode_Error;
 298    Name_Error   : exception renames IO_Exceptions.Name_Error;
 299    Use_Error    : exception renames IO_Exceptions.Use_Error;
 300    Device_Error : exception renames IO_Exceptions.Device_Error;
 301    End_Error    : exception renames IO_Exceptions.End_Error;
 302    Data_Error   : exception renames IO_Exceptions.Data_Error;
 303    Layout_Error : exception renames IO_Exceptions.Layout_Error;
 304
 305 private
 306    -----------------------------------
 307    -- Handling of Format Characters --
 308    -----------------------------------
 309
 310    --  Line marks are represented by the single character ASCII.LF (16#0A#).
 311    --  In DOS and similar systems, underlying file translation takes care
 312    --  of translating this to and from the standard CR/LF sequences used in
 313    --  these operating systems to mark the end of a line. On output there is
 314    --  always a line mark at the end of the last line, but on input, this
 315    --  line mark can be omitted, and is implied by the end of file.
 316
 317    --  Page marks are represented by the single character ASCII.FF (16#0C#),
 318    --  The page mark at the end of the file may be omitted, and is normally
 319    --  omitted on output unless an explicit New_Page call is made before
 320    --  closing the file. No page mark is added when a file is appended to,
 321    --  so, in accordance with the permission in (RM A.10.2(4)), there may
 322    --  or may not be a page mark separating preexising text in the file
 323    --  from the new text to be written.
 324
 325    --  A file mark is marked by the physical end of file. In DOS translation
 326    --  mode on input, an EOF character (SUB = 16#1A#) gets translated to the
 327    --  physical end of file, so in effect this character is recognized as
 328    --  marking the end of file in DOS and similar systems.
 329
 330    LM : constant := Character'Pos (ASCII.LF);
 331    --  Used as line mark
 332
 333    PM : constant := Character'Pos (ASCII.FF);
 334    --  Used as page mark, except at end of file where it is implied
 335
 336    -------------------------------------
 337    -- Wide_Text_IO File Control Block --
 338    -------------------------------------
 339
 340    Default_WCEM : WCh_Con.WC_Encoding_Method := WCh_Con.WCEM_UTF8;
 341    --  This gets modified during initialization (see body) using
 342    --  the default value established in the call to Set_Globals.
 343
 344    package FCB renames System.File_Control_Block;
 345
 346    type Wide_Text_AFCB is new FCB.AFCB with record
 347       Page        : Count := 1;
 348       Line        : Count := 1;
 349       Col         : Count := 1;
 350       Line_Length : Count := 0;
 351       Page_Length : Count := 0;
 352
 353       Before_LM : Boolean := False;
 354       --  This flag is used to deal with the anomolies introduced by the
 355       --  peculiar definition of End_Of_File and End_Of_Page in Ada. These
 356       --  functions require looking ahead more than one character. Since
 357       --  there is no convenient way of backing up more than one character,
 358       --  what we do is to leave ourselves positioned past the LM, but set
 359       --  this flag, so that we know that from an Ada point of view we are
 360       --  in front of the LM, not after it. A bit of a kludge, but it works!
 361
 362       Before_LM_PM : Boolean := False;
 363       --  This flag similarly handles the case of being physically positioned
 364       --  after a LM-PM sequence when logically we are before the LM-PM. This
 365       --  flag can only be set if Before_LM is also set.
 366
 367       WC_Method : WCh_Con.WC_Encoding_Method := Default_WCEM;
 368       --  Encoding method to be used for this file
 369
 370       Before_Wide_Character : Boolean := False;
 371       --  This flag is set to indicate that a wide character in the input has
 372       --  been read by Wide_Text_IO.Look_Ahead. If it is set to True, then it
 373       --  means that the stream is logically positioned before the character
 374       --  but is physically positioned after it. The character involved must
 375       --  not be in the range 16#00#-16#7F#, i.e. if the flag is set, then
 376       --  we know the next character has a code greater than 16#7F#, and the
 377       --  value of this character is saved in Saved_Wide_Character.
 378
 379       Saved_Wide_Character : Wide_Character;
 380       --  This field is valid only if Before_Wide_Character is set. It
 381       --  contains a wide character read by Look_Ahead. If Look_Ahead
 382       --  reads a character in the range 16#0000# to 16#007F#, then it
 383       --  can use ungetc to put it back, but ungetc cannot be called
 384       --  more than once, so for characters above this range, we don't
 385       --  try to back up the file. Instead we save the character in this
 386       --  field and set the flag Before_Wide_Character to indicate that
 387       --  we are logically positioned before this character even though
 388       --  the stream is physically positioned after it.
 389
 390    end record;
 391
 392    type File_Type is access all Wide_Text_AFCB;
 393
 394    function AFCB_Allocate (Control_Block : Wide_Text_AFCB) return FCB.AFCB_Ptr;
 395
 396    procedure AFCB_Close (File : access Wide_Text_AFCB);
 397    procedure AFCB_Free  (File : access Wide_Text_AFCB);
 398
 399    procedure Read
 400      (File : in out Wide_Text_AFCB;
 401       Item : out Ada.Streams.Stream_Element_Array;
 402       Last : out Ada.Streams.Stream_Element_Offset);
 403    --  Read operation used when Wide_Text_IO file is treated as a Stream
 404
 405    procedure Write
 406      (File : in out Wide_Text_AFCB;
 407       Item : Ada.Streams.Stream_Element_Array);
 408    --  Write operation used when Wide_Text_IO file is treated as a Stream
 409
 410    ------------------------
 411    -- The Standard Files --
 412    ------------------------
 413
 414    Null_Str : aliased constant String := "";
 415    --  Used as name and form of standard files
 416
 417    Standard_Err_AFCB : aliased Wide_Text_AFCB;
 418    Standard_In_AFCB  : aliased Wide_Text_AFCB;
 419    Standard_Out_AFCB : aliased Wide_Text_AFCB;
 420
 421    Standard_Err : aliased File_Type := Standard_Err_AFCB'Access;
 422    Standard_In  : aliased File_Type := Standard_In_AFCB'Access;
 423    Standard_Out : aliased File_Type := Standard_Out_AFCB'Access;
 424    --  Standard files
 425
 426    Current_In   : aliased File_Type := Standard_In;
 427    Current_Out  : aliased File_Type := Standard_Out;
 428    Current_Err  : aliased File_Type := Standard_Err;
 429    --  Current files
 430
 431    -----------------------
 432    -- Local Subprograms --
 433    -----------------------
 434
 435    --  These subprograms are in the private part of the spec so that they can
 436    --  be shared by the routines in the body of Ada.Text_IO.Wide_Text_IO.
 437
 438    --  Note: we use Integer in these declarations instead of the more accurate
 439    --  Interfaces.C_Streams.int, because we do not want to drag in the spec of
 440    --  this interfaces package with the spec of Ada.Text_IO, and we know that
 441    --  in fact these types are identical
 442
 443    function Getc (File : File_Type) return Integer;
 444    --  Gets next character from file, which has already been checked for
 445    --  being in read status, and returns the character read if no error
 446    --  occurs. The result is EOF if the end of file was read.
 447
 448    procedure Get_Character
 449      (File : File_Type;
 450       Item : out Character);
 451    --  This is essentially a copy of the normal Get routine from Text_IO. It
 452    --  obtains a single character from the input file File, and places it in
 453    --  Item. This character may be the leading character of a Wide_Character
 454    --  sequence, but that is up to the caller to deal with.
 455
 456    function Get_Wide_Char
 457      (C    : Character;
 458       File : File_Type) return Wide_Character;
 459    --  This function is shared by Get and Get_Immediate to extract a wide
 460    --  character value from the given File. The first byte has already been
 461    --  read and is passed in C. The wide character value is returned as the
 462    --  result, and the file pointer is bumped past the character.
 463
 464    function Nextc (File : File_Type) return Integer;
 465    --  Returns next character from file without skipping past it (i.e. it
 466    --  is a combination of Getc followed by an Ungetc).
 467
 468    procedure Putc (ch : Integer; File : File_Type);
 469    --  Outputs the given character to the file, which has already been
 470    --  checked for being in output status. Device_Error is raised if the
 471    --  character cannot be written.
 472
 473    procedure Terminate_Line (File : File_Type);
 474    --  If the file is in Write_File or Append_File mode, and the current
 475    --  line is not terminated, then a line terminator is written using
 476    --  New_Line. Note that there is no Terminate_Page routine, because
 477    --  the page mark at the end of the file is implied if necessary.
 478
 479    procedure Ungetc (ch : Integer; File : File_Type);
 480    --  Pushes back character into stream, using ungetc. The caller has
 481    --  checked that the file is in read status. Device_Error is raised
 482    --  if the character cannot be pushed back. An attempt to push back
 483    --  and end of file character (EOF) is ignored.
 484
 485 end Ada.Wide_Text_IO;