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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
-- File: FSD_File.cdl
-- Created: Fri Nov 29 13:03:05 1996
-- Author: Christophe LEYNADIER
-- <cle@parigox.paris1.matra-dtv.fr>
---Copyright: Matra Datavision 1996
class File from FSD
inherits BaseDriver from Storage
---Purpose:
-- A general driver which defines as a file, the
-- physical container for data to be stored or retrieved.
uses Position from Storage,
Error from Storage,
OpenMode from Storage,
AsciiString from TCollection,
SequenceOfAsciiString from TColStd,
SequenceOfExtendedString from TColStd,
ExtendedString from TCollection,
FStream from FSD
raises StreamTypeMismatchError from Storage,
StreamFormatError from Storage,
StreamWriteError from Storage,
StreamExtCharParityError from Storage
is
Create returns File from FSD;
---Purpose:
-- Constructs a driver defining as a file, the physical
-- container for data to be stored or retrieved.
-- Use the function Open to give the name of the driven file.
Open(me : in out; aName : AsciiString from TCollection; aMode : OpenMode from Storage) returns Error from Storage;
---Purpose:
-- Assigns as aName the name of the file to be
-- driven by this driver. aMode precises if the file is
-- opened in read or write mode.
-- The function returns Storage_VSOk if the file
-- is opened correctly, or any other value of the
-- Storage_Error enumeration which specifies the problem encountered.
IsEnd(me : in out) returns Boolean from Standard;
Tell( me : in out ) returns Position from Storage;
---Purpose: return position in the file. Return -1 upon error.
IsGoodFileType(myclass; aName : AsciiString from TCollection)
returns Error from Storage;
-- INFO SECTION
-- write
--
BeginWriteInfoSection(me : in out) returns Error from Storage;
WriteInfo(me : in out; nbObj : Integer from Standard;
dbVersion : AsciiString from TCollection;
date : AsciiString from TCollection;
schemaName : AsciiString from TCollection;
schemaVersion : AsciiString from TCollection;
appName : ExtendedString from TCollection;
appVersion : AsciiString from TCollection;
objectType : ExtendedString from TCollection;
userInfo : SequenceOfAsciiString from TColStd)
raises StreamWriteError;
EndWriteInfoSection(me : in out) returns Error from Storage;
-- read
--
BeginReadInfoSection(me : in out) returns Error from Storage;
ReadInfo(me : in out; nbObj : in out Integer from Standard;
dbVersion : in out AsciiString from TCollection;
date : in out AsciiString from TCollection;
schemaName : in out AsciiString from TCollection;
schemaVersion : in out AsciiString from TCollection;
appName : in out ExtendedString from TCollection;
appVersion : in out AsciiString from TCollection;
objectType : in out ExtendedString from TCollection;
userInfo : in out SequenceOfAsciiString from TColStd)
raises StreamTypeMismatchError,StreamExtCharParityError;
EndReadInfoSection(me : in out) returns Error from Storage;
-- COMMENTS SECTION
-- write
--
BeginWriteCommentSection(me : in out) returns Error from Storage;
WriteComment(me : in out; userComments : SequenceOfExtendedString from TColStd)
raises StreamWriteError;
EndWriteCommentSection(me : in out) returns Error from Storage;
-- read
--
BeginReadCommentSection(me : in out) returns Error from Storage;
ReadComment(me : in out; userComments : in out SequenceOfExtendedString from TColStd)
raises StreamTypeMismatchError,StreamExtCharParityError;
EndReadCommentSection(me : in out) returns Error from Storage;
-- TYPE SECTION
--
BeginWriteTypeSection(me : in out) returns Error from Storage;
SetTypeSectionSize(me : in out; aSize : Integer from Standard)
raises StreamWriteError;
WriteTypeInformations(me : in out; typeNum : Integer from Standard; typeName : AsciiString from TCollection)
raises StreamWriteError;
EndWriteTypeSection(me : in out) returns Error from Storage;
-- read
BeginReadTypeSection(me : in out) returns Error from Storage;
TypeSectionSize(me : in out) returns Integer from Standard
raises StreamTypeMismatchError;
ReadTypeInformations(me : in out; typeNum : in out Integer from Standard; typeName : in out AsciiString from TCollection)
raises StreamTypeMismatchError;
EndReadTypeSection(me : in out) returns Error from Storage;
-- ROOT SECTION
-- write
--
BeginWriteRootSection(me : in out) returns Error from Storage;
SetRootSectionSize(me : in out; aSize : Integer from Standard)
raises StreamWriteError;
WriteRoot(me : in out; rootName : AsciiString from TCollection; aRef : Integer from Standard; aType : AsciiString from TCollection)
raises StreamWriteError;
EndWriteRootSection(me : in out) returns Error from Storage;
-- read
--
BeginReadRootSection(me : in out) returns Error from Storage;
RootSectionSize(me : in out) returns Integer from Standard
raises StreamTypeMismatchError;
ReadRoot(me : in out; rootName : in out AsciiString from TCollection; aRef : in out Integer from Standard; aType : in out AsciiString from TCollection)
raises StreamTypeMismatchError;
EndReadRootSection(me : in out) returns Error from Storage;
-- REF SECTION
-- write
--
BeginWriteRefSection(me : in out) returns Error from Storage;
SetRefSectionSize(me : in out; aSize : Integer from Standard)
raises StreamWriteError;
WriteReferenceType(me : in out; reference : Integer from Standard; typeNum : Integer from Standard)
raises StreamWriteError;
EndWriteRefSection(me : in out) returns Error from Storage;
-- read
--
BeginReadRefSection(me : in out) returns Error from Storage;
RefSectionSize(me : in out) returns Integer from Standard
raises StreamTypeMismatchError;
ReadReferenceType(me : in out; reference : in out Integer from Standard; typeNum : in out Integer from Standard)
raises StreamTypeMismatchError;
EndReadRefSection(me : in out) returns Error from Storage;
-- DATA SECTION
-- write
--
BeginWriteDataSection(me : in out) returns Error from Storage;
WritePersistentObjectHeader(me : in out; aRef : Integer from Standard; aType : Integer from Standard)
raises StreamWriteError;
BeginWritePersistentObjectData(me : in out)
raises StreamWriteError;
BeginWriteObjectData(me : in out)
raises StreamWriteError;
EndWriteObjectData(me : in out)
raises StreamWriteError;
EndWritePersistentObjectData(me : in out)
raises StreamWriteError;
EndWriteDataSection(me : in out) returns Error from Storage;
-- read
--
BeginReadDataSection(me : in out) returns Error from Storage;
ReadPersistentObjectHeader(me : in out; aRef : in out Integer from Standard; aType : in out Integer from Standard)
raises StreamTypeMismatchError,StreamFormatError;
BeginReadPersistentObjectData(me : in out)
raises StreamFormatError;
BeginReadObjectData(me : in out)
raises StreamFormatError;
EndReadObjectData(me : in out)
raises StreamFormatError;
EndReadPersistentObjectData(me : in out)
raises StreamFormatError;
EndReadDataSection(me : in out) returns Error from Storage;
--
SkipObject(me : in out);
--
PutReference(me : in out; aValue : Integer from Standard) returns like me
raises StreamWriteError;
---C++: return &
PutCharacter(me : in out; aValue : Character from Standard) returns like me
raises StreamWriteError;
---C++: alias operator <<
---C++: return &
PutExtCharacter(me : in out; aValue : ExtCharacter from Standard) returns like me
raises StreamWriteError;
---C++: alias operator <<
---C++: return &
PutInteger(me : in out; aValue : Integer from Standard) returns like me
raises StreamWriteError;
---C++: alias operator <<
---C++: return &
PutBoolean(me : in out; aValue : Boolean from Standard) returns like me
raises StreamWriteError;
---C++: alias operator <<
---C++: return &
PutReal(me : in out; aValue : Real from Standard) returns like me
raises StreamWriteError;
---C++: alias operator <<
---C++: return &
PutShortReal(me : in out; aValue : ShortReal from Standard) returns like me
raises StreamWriteError;
---C++: alias operator <<
---C++: return &
GetReference(me : in out; aValue : in out Integer from Standard) returns like me
raises StreamTypeMismatchError;
---C++: return &
GetCharacter(me : in out; aValue : in out Character from Standard) returns like me
raises StreamTypeMismatchError;
---C++: alias operator >>
---C++: return &
GetExtCharacter(me : in out; aValue : in out ExtCharacter from Standard) returns like me
raises StreamTypeMismatchError;
---C++: alias operator >>
---C++: return &
GetInteger(me : in out; aValue : in out Integer from Standard) returns like me
raises StreamTypeMismatchError;
---C++: alias operator >>
---C++: return &
GetBoolean(me : in out; aValue : in out Boolean from Standard) returns like me
raises StreamTypeMismatchError;
---C++: alias operator >>
---C++: return &
GetReal(me : in out; aValue :in out Real from Standard) returns like me
raises StreamTypeMismatchError;
---C++: alias operator >>
---C++: return &
GetShortReal(me : in out; aValue : in out ShortReal from Standard) returns like me
raises StreamTypeMismatchError;
---C++: alias operator >>
---C++: return &
Close(me : in out) returns Error from Storage;
---Purpose:
-- Closes the file driven by this driver. This file was
-- opened by the last call to the function Open.
-- The function returns Storage_VSOk if the
-- closure is correctly done, or any other value of
-- the Storage_Error enumeration which specifies the problem encountered.
Destroy(me : in out);
---C++: alias ~
ReadLine(me : in out; buffer : in out AsciiString from TCollection) is protected;
---Purpose: read from the current position to the end of line.
ReadWord(me : in out; buffer : in out AsciiString from TCollection) is protected;
---Purpose: read from the current position to the next white space or end of line.
ReadExtendedLine(me : in out; buffer : in out ExtendedString from TCollection)
raises StreamExtCharParityError
is protected;
---Purpose: read extended chars (unicode) from the current position to the end of line.
WriteExtendedLine(me : in out; buffer : ExtendedString from TCollection) is protected;
---Purpose: write from the current position to the end of line.
ReadChar(me : in out; buffer : in out AsciiString from TCollection; rsize : Integer from Standard) is protected;
---Purpose: read <rsize> character from the current position.
ReadString(me : in out; buffer : in out AsciiString from TCollection) is protected;
---Purpose: read from the first none space character position to the end of line.
FlushEndOfLine(me : in out) is protected;
FindTag(me : in out; aTag : CString from Standard) returns Error from Storage is protected;
MagicNumber(myclass)
returns CString from Standard is private;
-- ---C++: return const
fields
myStream : FStream from FSD;
end;
|
