OSDN Git Service

2007-08-14 Robert Dewar <dewar@adacore.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / a-sequio.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT RUN-TIME COMPONENTS                         --
4 --                                                                          --
5 --                    A D A . S E Q U E N T I A L _ I O                     --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2006, 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,  51  Franklin  Street,  Fifth  Floor, --
24 -- Boston, MA 02110-1301, 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 with Ada.IO_Exceptions;
39
40 with System.Sequential_IO;
41
42 generic
43    type Element_Type (<>) is private;
44
45 package Ada.Sequential_IO is
46
47    pragma Compile_Time_Warning
48      (Element_Type'Has_Access_Values,
49       "Element_Type for Sequential_IO instance has access values");
50
51    type File_Type is limited private;
52
53    type File_Mode is (In_File, Out_File, Append_File);
54
55    --  The following representation clause allows the use of unchecked
56    --  conversion for rapid translation between the File_Mode type
57    --  used in this package and System.File_IO.
58
59    for File_Mode use
60      (In_File     => 0,  -- System.FIle_IO.File_Mode'Pos (In_File)
61       Out_File    => 2,  -- System.File_IO.File_Mode'Pos (Out_File)
62       Append_File => 3); -- System.File_IO.File_Mode'Pos (Append_File)
63
64    ---------------------
65    -- File management --
66    ---------------------
67
68    procedure Create
69      (File : in out File_Type;
70       Mode : File_Mode := Out_File;
71       Name : String := "";
72       Form : String := "");
73
74    procedure Open
75      (File : in out File_Type;
76       Mode : File_Mode;
77       Name : String;
78       Form : String := "");
79
80    procedure Close  (File : in out File_Type);
81    procedure Delete (File : in out File_Type);
82    procedure Reset  (File : in out File_Type; Mode : File_Mode);
83    procedure Reset  (File : in out File_Type);
84
85    function Mode    (File : File_Type) return File_Mode;
86    function Name    (File : File_Type) return String;
87    function Form    (File : File_Type) return String;
88
89    function Is_Open (File : File_Type) return Boolean;
90
91    ---------------------------------
92    -- Input and output operations --
93    ---------------------------------
94
95    procedure Read  (File : File_Type; Item : out Element_Type);
96    procedure Write (File : File_Type; Item : Element_Type);
97
98    function End_Of_File (File : File_Type) return Boolean;
99
100    ----------------
101    -- Exceptions --
102    ----------------
103
104    Status_Error : exception renames IO_Exceptions.Status_Error;
105    Mode_Error   : exception renames IO_Exceptions.Mode_Error;
106    Name_Error   : exception renames IO_Exceptions.Name_Error;
107    Use_Error    : exception renames IO_Exceptions.Use_Error;
108    Device_Error : exception renames IO_Exceptions.Device_Error;
109    End_Error    : exception renames IO_Exceptions.End_Error;
110    Data_Error   : exception renames IO_Exceptions.Data_Error;
111
112 private
113    type File_Type is new System.Sequential_IO.File_Type;
114
115    --  All subprograms are inlined
116
117    pragma Inline (Close);
118    pragma Inline (Create);
119    pragma Inline (Delete);
120    pragma Inline (End_Of_File);
121    pragma Inline (Form);
122    pragma Inline (Is_Open);
123    pragma Inline (Mode);
124    pragma Inline (Name);
125    pragma Inline (Open);
126    pragma Inline (Read);
127    pragma Inline (Reset);
128    pragma Inline (Write);
129
130 end Ada.Sequential_IO;