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-textio.ads < prev    next >
Text File  |  1996-09-28  |  15KB  |  395 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT RUNTIME COMPONENTS                          --
  4. --                                                                          --
  5. --                          A D A . T E X T _ I O                           --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.38 $                             --
  10. --                                                                          --
  11. -- This specification is adapted from the Ada Reference Manual for use with --
  12. -- GNAT.  In accordance with the copyright of that document, you can freely --
  13. -- copy and modify this specification,  provided that if you redistribute a --
  14. -- modified version,  any changes that you have made are clearly indicated. --
  15. --                                                                          --
  16. ------------------------------------------------------------------------------
  17.  
  18. --  Note: the generic subpackages of Text_IO (Integer_IO, Float_IO, Fixed_IO,
  19. --  Modular_IO, Decimal_IO and Enumeration_IO) appear as private children in
  20. --  GNAT. These children are with'ed automatically if they are referenced, so
  21. --  this rearrangement is invisible to user programs, but has the advantage
  22. --  that only the needed parts of Text_IO are processed and loaded.
  23.  
  24. with Ada.IO_Exceptions;
  25. with Ada.Streams;
  26. with System;
  27. with System.File_Control_Block;
  28. with System.Parameters;
  29.  
  30. package Ada.Text_IO is
  31.  
  32.    type File_Type is limited private;
  33.    type File_Mode is (In_File, Out_File, Append_File);
  34.  
  35.    type Count is range 0 .. System.Parameters.Count_Max;
  36.  
  37.    subtype Positive_Count is Count range 1 .. Count'Last;
  38.  
  39.    Unbounded : constant Count := 0;
  40.    --  Line and page length
  41.  
  42.    subtype Field is Integer range 0 .. System.Parameters.Field_Max;
  43.  
  44.    subtype Number_Base is Integer range 2 .. 16;
  45.  
  46.    type Type_Set is (Lower_Case, Upper_Case);
  47.  
  48.    ---------------------
  49.    -- File Management --
  50.    ---------------------
  51.  
  52.    procedure Create
  53.      (File : in out File_Type;
  54.       Mode : in File_Mode := Out_File;
  55.       Name : in String := "";
  56.       Form : in String := "");
  57.  
  58.    procedure Open
  59.      (File : in out File_Type;
  60.       Mode : in File_Mode;
  61.       Name : in String;
  62.       Form : in String := "");
  63.  
  64.    procedure Close  (File : in out File_Type);
  65.    procedure Delete (File : in out File_Type);
  66.    procedure Reset  (File : in out File_Type; Mode : in File_Mode);
  67.    procedure Reset  (File : in out File_Type);
  68.  
  69.    function Mode (File : in File_Type) return File_Mode;
  70.    function Name (File : in File_Type) return String;
  71.    function Form (File : in File_Type) return String;
  72.  
  73.    function Is_Open (File : in File_Type) return Boolean;
  74.  
  75.    ------------------------------------------------------
  76.    -- Control of default input, output and error files --
  77.    ------------------------------------------------------
  78.  
  79.    procedure Set_Input  (File : in File_Type);
  80.    procedure Set_Output (File : in File_Type);
  81.    procedure Set_Error  (File : in File_Type);
  82.  
  83.    function Standard_Input  return File_Type;
  84.    function Standard_Output return File_Type;
  85.    function Standard_Error  return File_Type;
  86.  
  87.    function Current_Input  return File_Type;
  88.    function Current_Output return File_Type;
  89.    function Current_Error  return File_Type;
  90.  
  91.    type File_Access is access constant File_Type;
  92.  
  93.    function Standard_Input  return File_Access;
  94.    function Standard_Output return File_Access;
  95.    function Standard_Error  return File_Access;
  96.  
  97.    function Current_Input  return File_Access;
  98.    function Current_Output return File_Access;
  99.    function Current_Error  return File_Access;
  100.  
  101.    --------------------
  102.    -- Buffer control --
  103.    --------------------
  104.  
  105.    procedure Flush (File : in out File_Type);
  106.    procedure Flush;
  107.  
  108.    --------------------------------------------
  109.    -- Specification of line and page lengths --
  110.    --------------------------------------------
  111.  
  112.    procedure Set_Line_Length (File : in File_Type; To : in Count);
  113.    procedure Set_Line_Length (To : in Count);
  114.  
  115.    procedure Set_Page_Length (File : in File_Type; To : in Count);
  116.    procedure Set_Page_Length (To : in Count);
  117.  
  118.    function Line_Length (File : in File_Type) return Count;
  119.    function Line_Length return Count;
  120.  
  121.    function Page_Length (File : in File_Type) return Count;
  122.    function Page_Length return Count;
  123.  
  124.    ------------------------------------
  125.    -- Column, Line, and Page Control --
  126.    ------------------------------------
  127.  
  128.    procedure New_Line (File : in File_Type; Spacing : in Positive_Count := 1);
  129.    procedure New_Line (Spacing : in Positive_Count := 1);
  130.  
  131.    procedure Skip_Line (File : in File_Type; Spacing : in Positive_Count := 1);
  132.    procedure Skip_Line (Spacing : in Positive_Count := 1);
  133.  
  134.    function End_Of_Line (File : in File_Type) return Boolean;
  135.    function End_Of_Line return Boolean;
  136.  
  137.    procedure New_Page (File : in File_Type);
  138.    procedure New_Page;
  139.  
  140.    procedure Skip_Page (File : in File_Type);
  141.    procedure Skip_Page;
  142.  
  143.    function End_Of_Page (File : in File_Type) return Boolean;
  144.    function End_Of_Page return Boolean;
  145.  
  146.    function End_Of_File (File : in File_Type) return Boolean;
  147.    function End_Of_File return Boolean;
  148.  
  149.    procedure Set_Col (File : in File_Type;  To : in Positive_Count);
  150.    procedure Set_Col (To : in Positive_Count);
  151.  
  152.    procedure Set_Line (File : in File_Type; To : in Positive_Count);
  153.    procedure Set_Line (To : in Positive_Count);
  154.  
  155.    function Col (File : in File_Type) return Positive_Count;
  156.    function Col return Positive_Count;
  157.  
  158.    function Line (File : in File_Type) return Positive_Count;
  159.    function Line return Positive_Count;
  160.  
  161.    function Page (File : in File_Type) return Positive_Count;
  162.    function Page return Positive_Count;
  163.  
  164.    -----------------------------
  165.    -- Characters Input-Output --
  166.    -----------------------------
  167.  
  168.    procedure Get (File : in File_Type; Item : out Character);
  169.    procedure Get (Item : out Character);
  170.    procedure Put (File : in File_Type; Item : in Character);
  171.    procedure Put (Item : in Character);
  172.  
  173.    procedure Look_Ahead
  174.      (File        : in File_Type;
  175.       Item        : out Character;
  176.       End_Of_Line : out Boolean);
  177.  
  178.    procedure Look_Ahead
  179.      (Item        : out Character;
  180.       End_Of_Line : out Boolean);
  181.  
  182.    procedure Get_Immediate
  183.      (File : in File_Type;
  184.       Item : out Character);
  185.  
  186.    procedure Get_Immediate
  187.      (Item : out Character);
  188.  
  189.    procedure Get_Immediate
  190.      (File      : in File_Type;
  191.       Item      : out Character;
  192.       Available : out Boolean);
  193.  
  194.    procedure Get_Immediate
  195.      (Item      : out Character;
  196.       Available : out Boolean);
  197.  
  198.    --------------------------
  199.    -- Strings Input-Output --
  200.    --------------------------
  201.  
  202.    procedure Get (File : in File_Type; Item : out String);
  203.    procedure Get (Item : out String);
  204.    procedure Put (File : in File_Type; Item : in String);
  205.    procedure Put (Item : in String);
  206.  
  207.    procedure Get_Line
  208.      (File : in File_Type;
  209.       Item : out String;
  210.       Last : out Natural);
  211.  
  212.    procedure Get_Line
  213.      (Item : out String;
  214.       Last : out Natural);
  215.  
  216.    procedure Put_Line
  217.      (File : in File_Type;
  218.       Item : in String);
  219.  
  220.    procedure Put_Line
  221.      (Item : in String);
  222.  
  223.    --  Exceptions
  224.  
  225.    Status_Error : exception renames IO_Exceptions.Status_Error;
  226.    Mode_Error   : exception renames IO_Exceptions.Mode_Error;
  227.    Name_Error   : exception renames IO_Exceptions.Name_Error;
  228.    Use_Error    : exception renames IO_Exceptions.Use_Error;
  229.    Device_Error : exception renames IO_Exceptions.Device_Error;
  230.    End_Error    : exception renames IO_Exceptions.End_Error;
  231.    Data_Error   : exception renames IO_Exceptions.Data_Error;
  232.    Layout_Error : exception renames IO_Exceptions.Layout_Error;
  233.  
  234. private
  235.    -----------------------------------
  236.    -- Handling of Format Characters --
  237.    -----------------------------------
  238.  
  239.    --  Line marks are represented by the single character Ascii.LF (16#0A#).
  240.    --  In DOS and similar systems, underlying file translation takes care
  241.    --  of translating this to and from the standard CR/LF sequences used in
  242.    --  these operating systems to mark the end of a line. On output there is
  243.    --  always a line mark at the end of the last line, but on input, this
  244.    --  line mark can be omitted, and is implied by the end of file.
  245.  
  246.    --  Page marks are represented by the single character Ascii.FF (16#0C#),
  247.    --  The page mark at the end of the file may be omitted, and is normally
  248.    --  omitted on output unless an explicit New_Page call is made before
  249.    --  closing the file. No page mark is added when a file is appended to,
  250.    --  so, in accordance with the permission in (RM A.10.2(4)), there may
  251.    --  or may not be a page mark separating preexising text in the file
  252.    --  from the new text to be written.
  253.  
  254.    --  A file mark is marked by the physical end of file. In DOS translation
  255.    --  mode on input, an EOF character (SUB = 16#1A#) gets translated to the
  256.    --  physical end of file, so in effect this character is recognized as
  257.    --  marking the end of file in DOS and similar systems.
  258.  
  259.    LM : constant := Character'Pos (Ascii.LF);
  260.    --  Used as line mark
  261.  
  262.    PM : constant := Character'Pos (Ascii.FF);
  263.    --  Used as page mark, except at end of file where it is implied
  264.  
  265.    --------------------------------
  266.    -- Text_IO File Control Block --
  267.    --------------------------------
  268.  
  269.    package FCB renames System.File_Control_Block;
  270.  
  271.    type Text_AFCB is new FCB.AFCB with record
  272.       Page        : Count := 1;
  273.       Line        : Count := 1;
  274.       Col         : Count := 1;
  275.       Line_Length : Count := 0;
  276.       Page_Length : Count := 0;
  277.  
  278.       Before_LM : Boolean := False;
  279.       --  This flag is used to deal with the anomolies introduced by the
  280.       --  peculiar definition of End_Of_File and End_Of_Page in Ada. These
  281.       --  functions require looking ahead more than one character. Since
  282.       --  there is no convenient way of backing up more than one character,
  283.       --  what we do is to leave ourselves positioned past the LM, but set
  284.       --  this flag, so that we know that from an Ada point of view we are
  285.       --  in front of the LM, not after it. A bit of a kludge, but it works!
  286.  
  287.       Before_LM_PM : Boolean := False;
  288.       --  This flag similarly handles the case of being physically positioned
  289.       --  after a LM-PM sequence when logically we are before the LM-PM. This
  290.       --  flag can only be set if Before_LM is also set.
  291.  
  292.       Before_Wide_Character : Boolean := False;
  293.       --  This flag is always False for Text_IO files. It is used in the wide
  294.       --  character case to indicate that a wide character in the input has
  295.       --  been read by Wide_Text_IO.Look_Ahead. If it is set to True, then it
  296.       --  means that the stream is logically positioned before the character
  297.       --  but is physically positioned after it. The character involved must
  298.       --  not be in the range 16#00#-16#7F#, i.e. if the flag is set, then we
  299.       --  know the next character has a code greater than 16#7F#. The reason
  300.       --  we define this flag in the base Text_IO control block is that there
  301.       --  are routines shared between Text_IO and Wide_Text_IO, notably the
  302.       --  numeric input routines in Ada.Text_IO.Generic_Aux, which need to
  303.       --  test the flag (note that if it is set, the next character cannot
  304.       --  be a valid character in a numeric item).
  305.  
  306.    end record;
  307.  
  308.    type File_Type is access all Text_AFCB;
  309.  
  310.    function AFCB_Allocate (Control_Block : Text_AFCB) return FCB.AFCB_Ptr;
  311.  
  312.    procedure AFCB_Close (File : access Text_AFCB);
  313.    procedure AFCB_Free  (File : access Text_AFCB);
  314.  
  315.    procedure Read
  316.      (File : in out Text_AFCB;
  317.       Item : out Ada.Streams.Stream_Element_Array;
  318.       Last : out Ada.Streams.Stream_Element_Offset);
  319.    --  Read operation used when Text_IO file is treated directly as Stream
  320.  
  321.    procedure Write
  322.      (File : in out Text_AFCB;
  323.       Item : in Ada.Streams.Stream_Element_Array);
  324.    --  Write operation used when Text_IO file is treated directly as Stream
  325.  
  326.    --  The following representation clause allows the use of unchecked
  327.    --  conversion for rapid translation between the File_Mode type
  328.    --  used in this package and System.File_IO.
  329.  
  330.    for File_Mode use
  331.      (In_File     => 0,  -- System.FIle_IO.File_Mode'Pos (In_File)
  332.       Out_File    => 2,  -- System.File_IO.File_Mode'Pos (Out_File)
  333.       Append_File => 3); -- System.File_IO.File_Mode'Pos (Append_File)
  334.  
  335.    ------------------------
  336.    -- The Standard Files --
  337.    ------------------------
  338.  
  339.    Null_Str : aliased constant String := "";
  340.    --  Used as name and form of standard files
  341.  
  342.    Standard_Err_AFCB : aliased Text_AFCB;
  343.    Standard_In_AFCB  : aliased Text_AFCB;
  344.    Standard_Out_AFCB : aliased Text_AFCB;
  345.  
  346.    Standard_Err : aliased File_Type := Standard_Err_AFCB'Access;
  347.    Standard_In  : aliased File_Type := Standard_In_AFCB'Access;
  348.    Standard_Out : aliased File_Type := Standard_Out_AFCB'Access;
  349.    --  Standard files
  350.  
  351.    Current_In   : aliased File_Type := Standard_In;
  352.    Current_Out  : aliased File_Type := Standard_Out;
  353.    Current_Err  : aliased File_Type := Standard_Err;
  354.    --  Current files
  355.  
  356.    -----------------------
  357.    -- Local Subprograms --
  358.    -----------------------
  359.  
  360.    --  These subprograms are in the private part of the spec so that they can
  361.    --  be shared by the routines in the body of Ada.Text_IO.Wide_Text_IO.
  362.  
  363.    --  Note: we use Integer in these declarations instead of the more accurate
  364.    --  Interfaces.C_Streams.int, because we do not want to drag in the spec of
  365.    --  this interfaces package with the spec of Ada.Text_IO, and we know that
  366.    --  in fact these types are identical
  367.  
  368.    function Getc (File : File_Type) return Integer;
  369.    --  Gets next character from file, which has already been checked for
  370.    --  being in read status, and returns the character read if no error
  371.    --  occurs. The result is EOF if the end of file was read.
  372.  
  373.    function Nextc (File : File_Type) return Integer;
  374.    --  Returns next character from file without skipping past it (i.e. it
  375.    --  is a combination of Getc followed by an Ungetc).
  376.  
  377.    procedure Putc (ch : Integer; File : File_Type);
  378.    --  Outputs the given character to the file, which has already been
  379.    --  checked for being in output status. Device_Error is raised if the
  380.    --  character cannot be written.
  381.  
  382.    procedure Terminate_Line (File : File_Type);
  383.    --  If the file is in Write_File or Append_File mode, and the current
  384.    --  line is not terminated, then a line terminator is written using
  385.    --  New_Line. Note that there is no Terminate_Page routine, because
  386.    --  the page mark at the end of the file is implied if necessary.
  387.  
  388.    procedure Ungetc (ch : Integer; File : File_Type);
  389.    --  Pushes back character into stream, using ungetc. The caller has
  390.    --  checked that the file is in read status. Device_Error is raised
  391.    --  if the character cannot be pushed back. An attempt to push back
  392.    --  and end of file character (EOF) is ignored.
  393.  
  394. end Ada.Text_IO;
  395.