1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- A D A . D I R E C T _ I O --
9 -- Copyright (C) 1992-2008, Free Software Foundation, Inc. --
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. --
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. --
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. --
33 -- GNAT was originally developed by the GNAT team at New York University. --
34 -- Extensive contributions were provided by Ada Core Technologies Inc. --
36 ------------------------------------------------------------------------------
38 with Ada
.IO_Exceptions
;
39 with System
.Direct_IO
;
40 with Interfaces
.C_Streams
;
43 type Element_Type
is private;
45 package Ada
.Direct_IO
is
47 pragma Compile_Time_Warning
48 (Element_Type
'Has_Access_Values,
49 "Element_Type for Direct_IO instance has access values");
51 pragma Compile_Time_Warning
52 (Element_Type
'Has_Tagged_Values,
53 "Element_Type for Direct_IO instance has tagged values");
55 type File_Type
is limited private;
57 type File_Mode
is (In_File
, Inout_File
, Out_File
);
59 -- The following representation clause allows the use of unchecked
60 -- conversion for rapid translation between the File_Mode type
61 -- used in this package and System.File_IO.
64 (In_File
=> 0, -- System.File_IO.File_Mode'Pos (In_File)
65 Inout_File
=> 1, -- System.File_IO.File_Mode'Pos (Inout_File);
66 Out_File
=> 2); -- System.File_IO.File_Mode'Pos (Out_File)
68 type Count
is range 0 .. System
.Direct_IO
.Count
'Last;
70 subtype Positive_Count
is Count
range 1 .. Count
'Last;
77 (File
: in out File_Type
;
78 Mode
: File_Mode
:= Inout_File
;
83 (File
: in out File_Type
;
88 procedure Close
(File
: in out File_Type
);
89 procedure Delete
(File
: in out File_Type
);
90 procedure Reset
(File
: in out File_Type
; Mode
: File_Mode
);
91 procedure Reset
(File
: in out File_Type
);
93 function Mode
(File
: File_Type
) return File_Mode
;
94 function Name
(File
: File_Type
) return String;
95 function Form
(File
: File_Type
) return String;
97 function Is_Open
(File
: File_Type
) return Boolean;
99 ---------------------------------
100 -- Input and Output Operations --
101 ---------------------------------
105 Item
: out Element_Type
;
106 From
: Positive_Count
);
110 Item
: out Element_Type
);
115 To
: Positive_Count
);
119 Item
: Element_Type
);
121 procedure Set_Index
(File
: File_Type
; To
: Positive_Count
);
123 function Index
(File
: File_Type
) return Positive_Count
;
124 function Size
(File
: File_Type
) return Count
;
126 function End_Of_File
(File
: File_Type
) return Boolean;
132 Status_Error
: exception renames IO_Exceptions
.Status_Error
;
133 Mode_Error
: exception renames IO_Exceptions
.Mode_Error
;
134 Name_Error
: exception renames IO_Exceptions
.Name_Error
;
135 Use_Error
: exception renames IO_Exceptions
.Use_Error
;
136 Device_Error
: exception renames IO_Exceptions
.Device_Error
;
137 End_Error
: exception renames IO_Exceptions
.End_Error
;
138 Data_Error
: exception renames IO_Exceptions
.Data_Error
;
142 -- The following procedures have a File_Type formal of mode IN OUT because
143 -- they may close the original file. The Close operation may raise an
144 -- exception, but in that case we want any assignment to the formal to
145 -- be effective anyway, so it must be passed by reference (or the caller
146 -- will be left with a dangling pointer).
148 pragma Export_Procedure
151 Mechanism
=> Reference
);
152 pragma Export_Procedure
155 Mechanism
=> Reference
);
156 pragma Export_Procedure
159 Parameter_Types
=> (File_Type
),
160 Mechanism
=> Reference
);
161 pragma Export_Procedure
164 Parameter_Types
=> (File_Type
, File_Mode
),
165 Mechanism
=> (File
=> Reference
));
167 type File_Type
is new System
.Direct_IO
.File_Type
;
169 Bytes
: constant Interfaces
.C_Streams
.size_t
:=
170 Element_Type
'Max_Size_In_Storage_Elements;
171 -- Size of an element in storage units
173 pragma Inline
(Close
);
174 pragma Inline
(Create
);
175 pragma Inline
(Delete
);
176 pragma Inline
(End_Of_File
);
177 pragma Inline
(Form
);
178 pragma Inline
(Index
);
179 pragma Inline
(Is_Open
);
180 pragma Inline
(Mode
);
181 pragma Inline
(Name
);
182 pragma Inline
(Open
);
183 pragma Inline
(Read
);
184 pragma Inline
(Reset
);
185 pragma Inline
(Set_Index
);
186 pragma Inline
(Size
);
187 pragma Inline
(Write
);