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-ststio.ads < prev    next >
Text File  |  1996-09-28  |  6KB  |  167 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT RUNTIME COMPONENTS                          --
  4. --                                                                          --
  5. --                A D A . S T R E A M S . S T R E A M _ I O                 --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.11 $                             --
  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.  
  19. with Ada.IO_Exceptions;
  20. with System.File_Control_Block;
  21.  
  22. package Ada.Streams.Stream_IO is
  23.  
  24.    type Stream_Access is access all Root_Stream_Type'Class;
  25.  
  26.    type File_Type is limited private;
  27.  
  28.    type File_Mode is (In_File, Out_File, Append_File);
  29.  
  30.    type Count is new Stream_Element_Offset;
  31.  
  32.    subtype Positive_Count is Count range 1 .. Count'Last;
  33.    --  Index into file, in stream elements
  34.  
  35.    ---------------------
  36.    -- File Management --
  37.    ---------------------
  38.  
  39.    procedure Create
  40.      (File : in out File_Type;
  41.       Mode : in File_Mode := Out_File;
  42.       Name : in String := "";
  43.       Form : in String := "");
  44.  
  45.    procedure Open
  46.      (File : in out File_Type;
  47.       Mode : in File_Mode;
  48.       Name : in String;
  49.       Form : in String := "");
  50.  
  51.    procedure Close  (File : in out File_Type);
  52.    procedure Delete (File : in out File_Type);
  53.    procedure Reset  (File : in out File_Type; Mode : in File_Mode);
  54.    procedure Reset  (File : in out File_Type);
  55.  
  56.    function Mode (File : in File_Type) return File_Mode;
  57.    function Name (File : in File_Type) return String;
  58.    function Form (File : in File_Type) return String;
  59.  
  60.    function Is_Open     (File : in File_Type) return Boolean;
  61.    function End_Of_File (File : in File_Type) return Boolean;
  62.  
  63.    function Stream (File : in File_Type) return Stream_Access;
  64.  
  65.    -----------------------------
  66.    -- Input-Output Operations --
  67.    -----------------------------
  68.  
  69.    procedure Read
  70.      (File : in  File_Type;
  71.       Item : out Stream_Element_Array;
  72.       Last : out Stream_Element_Offset;
  73.       From : in  Positive_Count);
  74.  
  75.    procedure Read
  76.      (File : in  File_Type;
  77.       Item : out Stream_Element_Array;
  78.       Last : out Stream_Element_Offset);
  79.  
  80.    procedure Write
  81.      (File : in File_Type;
  82.       Item : in Stream_Element_Array;
  83.       To   : in Positive_Count);
  84.  
  85.    procedure Write
  86.      (File : in File_Type;
  87.       Item : in Stream_Element_Array);
  88.  
  89.    ----------------------------------------
  90.    -- Operations on Position within File --
  91.    ----------------------------------------
  92.  
  93.    procedure Set_Index (File : in File_Type; To : in Positive_Count);
  94.  
  95.    function Index (File : in File_Type) return Positive_Count;
  96.    function Size  (File : in File_Type) return Count;
  97.  
  98.    procedure Set_Mode (File : in out File_Type; Mode : in File_Mode);
  99.  
  100.    procedure Flush (File : in out File_Type);
  101.  
  102.    ----------------
  103.    -- Exceptions --
  104.    ----------------
  105.  
  106.    Status_Error : exception renames IO_Exceptions.Status_Error;
  107.    Mode_Error   : exception renames IO_Exceptions.Mode_Error;
  108.    Name_Error   : exception renames IO_Exceptions.Name_Error;
  109.    Use_Error    : exception renames IO_Exceptions.Use_Error;
  110.    Device_Error : exception renames IO_Exceptions.Device_Error;
  111.    End_Error    : exception renames IO_Exceptions.End_Error;
  112.    Data_Error   : exception renames IO_Exceptions.Data_Error;
  113.  
  114. private
  115.    package FCB renames System.File_Control_Block;
  116.  
  117.    -----------------------------
  118.    -- Stream_IO Control Block --
  119.    -----------------------------
  120.  
  121.    type Operation is (Op_Read, Op_Write, Op_Other);
  122.    --  Type used to record last operation (to optimize sequential operations)
  123.  
  124.    type Stream_AFCB is new FCB.AFCB with record
  125.       Index : Count := 1;
  126.       --  Current Index value
  127.  
  128.       Last_Op : Operation := Op_Other;
  129.       --  Last operation performed on file, used to avoid unnecessary
  130.       --  repositioning between successive read or write operations.
  131.  
  132.       Update_Mode : Boolean := False;
  133.       --  Set if the mode is changed from write to read or vice versa.
  134.       --  Indicates that the file has been reopened in update mode.
  135.  
  136.    end record;
  137.  
  138.    type File_Type is access all Stream_AFCB;
  139.  
  140.    function AFCB_Allocate (Control_Block : Stream_AFCB) return FCB.AFCB_Ptr;
  141.  
  142.    procedure AFCB_Close (File : access Stream_AFCB);
  143.    procedure AFCB_Free  (File : access Stream_AFCB);
  144.  
  145.    procedure Read
  146.      (File : in out Stream_AFCB;
  147.       Item : out Ada.Streams.Stream_Element_Array;
  148.       Last : out Ada.Streams.Stream_Element_Offset);
  149.    --  Read operation used when Stream_IO file is treated directly as Stream
  150.  
  151.    procedure Write
  152.      (File : in out Stream_AFCB;
  153.       Item : in Ada.Streams.Stream_Element_Array);
  154.    --  Write operation used when Stream_IO file is treated directly as Stream
  155.  
  156.    --  The following representation clause allows the use of unchecked
  157.    --  conversion for rapid translation between the File_Mode type
  158.    --  used in this package and System.File_IO.
  159.  
  160.    for File_Mode use
  161.      (In_File     => 0,  -- System.FIle_IO.File_Mode'Pos (In_File)
  162.       Out_File    => 2,  -- System.File_IO.File_Mode'Pos (Out_File)
  163.       Append_File => 3); -- System.File_IO.File_Mode'Pos (Append_File)
  164.  
  165.  
  166. end Ada.Streams.Stream_IO;
  167.