1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209 | -- SPDX-License-Identifier: MIT
--
-- Contributed by ITEC - NXP Semiconductors
-- June 2008
--
-- Copyright (c) 2008 - 2018 Gautier de Montmollin (maintainer)
-- SWITZERLAND
--
-- Permission is hereby granted, free of charge, to any person obtaining a copy
-- of this software and associated documentation files (the "Software"), to deal
-- in the Software without restriction, including without limitation the rights
-- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-- copies of the Software, and to permit persons to whom the Software is
-- furnished to do so, subject to the following conditions:
--
-- The above copyright notice and this permission notice shall be included in
-- all copies or substantial portions of the Software.
--
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-- THE SOFTWARE.
-- The DCF.Streams package defines an abstract stream
-- type, Root_Zipstream_Type, with name, time and an index for random access.
--
-- In addition, this package provides two ready-to-use derivations:
--
-- - Array_Zipstream, for using in-memory streaming
-- - File_Zipstream, for accessing files
private with Ada.Finalization;
with Ada.Streams.Stream_IO;
with Ada.Strings.Unbounded;
use Ada.Streams;
use Ada.Strings.Unbounded;
package DCF.Streams is
pragma Preelaborate;
type Time is private;
-- We define an own Time (Ada.Calendar's body can be very time-consuming!)
-- See child package Calendar for own Split, Time_Of and Convert from/to
-- Ada.Calendar.Time.
Default_Time : constant Time; -- Some default time
------------------------------------------------------
-- Root_Zipstream_Type: root abstract stream type --
------------------------------------------------------
type Root_Zipstream_Type is abstract new Ada.Streams.Root_Stream_Type with private;
type Zipstream_Class_Access is access all Root_Zipstream_Type'Class;
subtype Zs_Size_Type is Integer_64 range 0 .. Integer_64'Last;
subtype Zs_Index_Type is Zs_Size_Type range 1 .. Zs_Size_Type'Last;
-- Set the index on the stream
procedure Set_Index (S : in out Root_Zipstream_Type; To : Zs_Index_Type) is abstract;
-- Returns the index of the stream
function Index (S : in Root_Zipstream_Type) return Zs_Index_Type is abstract;
-- Returns the Size of the stream
function Size (S : in Root_Zipstream_Type) return Zs_Size_Type is abstract;
procedure Set_Name (S : in out Root_Zipstream_Type; Name : String; UTF_8 : Boolean := False);
-- This procedure returns the name of the stream
function Get_Name (S : in Root_Zipstream_Type) return String;
function UTF_8_Encoding (S : in Root_Zipstream_Type) return Boolean;
-- This procedure sets the Modification_Time of the stream
procedure Set_Time (S : in out Root_Zipstream_Type; Modification_Time : Time);
-- This procedure returns the ModificationTime of the stream
function Get_Time (S : in Root_Zipstream_Type) return Time;
-- Returns true if the index is at the end of the stream, else false
function End_Of_Stream (S : in Root_Zipstream_Type) return Boolean is abstract;
----------------------------------------------
-- File_Zipstream: stream based on a file --
----------------------------------------------
type File_Zipstream is new Root_Zipstream_Type with private;
type File_Mode is new Ada.Streams.Stream_IO.File_Mode;
function Open (File_Name : String) return File_Zipstream;
-- Open a file for reading
function Create (File_Name : String) return File_Zipstream;
-- Create a file on the disk
--------------------------------------------------------------
-- Array_Zipstream: stream based on a Stream_Element_Array --
--------------------------------------------------------------
type Array_Zipstream
(Elements : not null access Stream_Element_Array) is new Root_Zipstream_Type with private;
-----------------------------------------------------------------------------
subtype Dos_Time is Unsigned_32;
function Convert (Date : in Dos_Time) return Time;
function Convert (Date : in Time) return Dos_Time;
private
-- Time. Currently, DOS format (pkzip appnote.txt: part V., J.), as stored
-- in Zip archives. Subject to change, this is why this type is private.
type Time is new Unsigned_32;
Default_Time : constant Time := 16789 * 65536;
type Root_Zipstream_Type is abstract new Ada.Streams.Root_Stream_Type with record
Name : Unbounded_String;
Modification_Time : Time := Default_Time;
UTF_8 : Boolean := False;
end record;
-----------------------------------------------------------------------------
type Open_File is limited new Ada.Finalization.Limited_Controlled with record
File : Ada.Streams.Stream_IO.File_Type;
Finalized : Boolean := False;
end record;
overriding
procedure Finalize (Object : in out Open_File);
-----------------------------------------------------------------------------
type File_Zipstream is new Root_Zipstream_Type with record
File : Open_File;
end record;
-- Read data from the stream
overriding
procedure Read
(Stream : in out File_Zipstream;
Item : out Stream_Element_Array;
Last : out Stream_Element_Offset);
-- Write data to the stream, starting from the current index.
-- Data will be overwritten from index if already available.
overriding
procedure Write (Stream : in out File_Zipstream; Item : Stream_Element_Array);
-- Set the index on the stream
overriding
procedure Set_Index (S : in out File_Zipstream; To : Zs_Index_Type);
-- Returns the index of the stream
overriding
function Index (S : in File_Zipstream) return Zs_Index_Type;
-- Returns the Size of the stream
overriding
function Size (S : in File_Zipstream) return Zs_Size_Type;
-- Returns true if the index is at the end of the stream
overriding
function End_Of_Stream (S : in File_Zipstream) return Boolean;
-----------------------------------------------------------------------------
type Array_Zipstream
(Elements : not null access Stream_Element_Array) is new Root_Zipstream_Type with
record
Index : Stream_Element_Offset := Elements'First;
EOF : Boolean := False;
end record;
overriding
procedure Read
(Stream : in out Array_Zipstream;
Item : out Stream_Element_Array;
Last : out Stream_Element_Offset);
overriding
procedure Write
(Stream : in out Array_Zipstream;
Item : Stream_Element_Array);
overriding
procedure Set_Index (Stream : in out Array_Zipstream; To : Zs_Index_Type);
overriding
function Index (Stream : in Array_Zipstream) return Zs_Index_Type is
(Zs_Index_Type (Stream.Index));
overriding
function Size (Stream : in Array_Zipstream) return Zs_Size_Type is
(Zs_Size_Type (Stream.Elements'Length));
overriding
function End_Of_Stream (Stream : in Array_Zipstream) return Boolean is
(Stream.Size < Index (Stream));
end DCF.Streams;
|