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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393 | ------------------------------------------------------------------
-- Tokeneer ID Station Core Software
--
-- Copyright (2003) United States Government, as represented
-- by the Director, National Security Agency.All rights reserved.
--
-- This material was originally developed by Praxis High Integrity
-- Systems Ltd.under contract to the National Security Agency.
------------------------------------------------------------------
------------------------------------------------------------------
-- File
--
-- Description:
-- Provides file utilities.
--
------------------------------------------------------------------
with Ada.Streams.Stream_IO; -- only used in hidden private part
with CommonTypes;
package File
with SPARK_Mode
is
------------------------------------------------------------------
-- Types
--
------------------------------------------------------------------
type T is private;
MaxNameLength : constant := 255;
NullFile : constant T;
------------------------------------------------------------------
-- SetName
--
-- Description:
-- Sets the name of a file.
--
-- Traceunit : C.File.SetName
------------------------------------------------------------------
procedure SetName (TheName : in CommonTypes.StringF1;
TheFile : in out T)
with Global => null,
Depends => (TheFile =>+ TheName);
------------------------------------------------------------------
-- GetName
--
-- Description:
-- Gets the name of a file.
--
-- Traceunit : C.File.GetName
------------------------------------------------------------------
procedure GetName (TheFile : in T;
TheName : out String;
NameLength : out Natural)
with Global => null,
Depends => ((NameLength,
TheName) => TheFile,
null => TheName);
------------------------------------------------------------------
-- Construct
--
-- Description:
-- Creates the initial file entity.
--
-- Traceunit : C.File.Construct
------------------------------------------------------------------
function Construct (TheName : CommonTypes.StringF1) return T
with Global => null,
Pre => TheName'Last <= MaxNameLength;
------------------------------------------------------------------
-- OpenAppend
--
-- Description:
-- Opens the file for appending.
--
-- Traceunit : C.File.OpenAppend
------------------------------------------------------------------
procedure OpenAppend (TheFile : in out T;
Success : out Boolean)
with Global => null,
Depends => ((Success,
TheFile) => TheFile);
------------------------------------------------------------------
-- OpenWrite
--
-- Description:
-- Opens the file for writing.
--
-- Traceunit : C.File.OpenWrite
------------------------------------------------------------------
procedure OpenWrite (TheFile : in out T;
Success : out Boolean)
with Global => null,
Depends => ((Success,
TheFile) => TheFile);
------------------------------------------------------------------
-- OpenRead
--
-- Description:
-- Opens the file for reading.
--
-- Traceunit : C.File.OpenRead
------------------------------------------------------------------
procedure OpenRead (TheFile : in out T;
Success : out Boolean)
with Global => null,
Depends => ((Success,
TheFile) => TheFile);
------------------------------------------------------------------
-- Close
--
-- Description:
-- Closes the file.
--
-- Traceunit : C.File.Close
------------------------------------------------------------------
procedure Close (TheFile : in out T;
Success : out Boolean)
with Global => null,
Depends => ((Success,
TheFile) => TheFile);
------------------------------------------------------------------
-- Exists
--
-- Description:
-- Returns True if the file exists.
--
-- Traceunit : C.File.Exists
------------------------------------------------------------------
function Exists (TheFile : T) return Boolean
with Global => null;
------------------------------------------------------------------
-- PutString
--
-- Description:
-- Writes the string to file.
-- If Stop = 0 or Stop >= Text'Length then writes all of Text
-- If Stop < Text'Length writes first Stop characters from string.
--
-- Traceunit : C.File.PutString
------------------------------------------------------------------
procedure PutString (TheFile : in out T;
Text : in String;
Stop : in Natural)
with Global => null,
Depends => (TheFile =>+ (Stop,
Text));
------------------------------------------------------------------
-- GetString
--
-- Description:
-- Reads the string from file.
-- Stop gives the number of characters actually read.
--
-- Traceunit : C.File.GetString
------------------------------------------------------------------
procedure GetString (TheFile : in out T;
Text : out String;
Stop : out Natural)
with Global => null,
Depends => ((Stop,
Text,
TheFile) => TheFile,
null => Text);
------------------------------------------------------------------
-- GetChar
--
-- Description:
-- Reads a character from file.
--
-- Traceunit : C.File.GetChar
------------------------------------------------------------------
procedure GetChar (TheFile : in out T;
Item : out Character)
with Global => null,
Depends => ((Item,
TheFile) => TheFile);
------------------------------------------------------------------
-- PutInteger
--
-- Description:
-- Writes the integer to file.
--
-- Traceunit : C.File.PutInteger
------------------------------------------------------------------
procedure PutInteger (TheFile : in out T;
Item : in Integer;
Width : in Natural)
with Global => null,
Depends => (TheFile =>+ (Item,
Width));
------------------------------------------------------------------
-- GetInteger
--
-- Description:
-- Gets an Integer from file.
--
-- Traceunit : C.File.GetInteger
------------------------------------------------------------------
procedure GetInteger (TheFile : in out T;
Item : out Integer;
Width : in Natural;
Success : out Boolean)
with Global => null,
Depends => ((Item,
Success,
TheFile) => (TheFile,
Width));
------------------------------------------------------------------
-- NewLine
--
-- Description:
-- Writes spacing number of new lines (CR LF) to file.
--
-- Traceunit : C.File.NewLine
------------------------------------------------------------------
procedure NewLine (TheFile : in out T;
Spacing : in Natural)
with Global => null,
Depends => (TheFile =>+ Spacing);
------------------------------------------------------------------
-- SkipLine
--
-- Description:
-- Skips spacing lines in a file open for reading
-- any problems and it does nothing.
--
-- Traceunit : C.File.SkipLine
------------------------------------------------------------------
procedure SkipLine (TheFile : in out T;
Spacing : in Positive)
with Global => null,
Depends => (TheFile =>+ Spacing);
------------------------------------------------------------------
-- GetLine
--
-- Description:
-- Gets a string upto the next new line or max length of string
-- which ever is sooner.
-- Stop gives the number of characters read.
--
-- Traceunit : C.File.GetLine
------------------------------------------------------------------
procedure GetLine (TheFile : in out T;
Item : out String;
Stop : out Natural)
with Global => null,
Depends => ((Item,
Stop,
TheFile) => TheFile,
null => Item);
------------------------------------------------------------------
-- EndOfFile
--
-- Description:
-- Returns true when the next element in the file is EOF.
--
-- Traceunit : C.File.EndOfFile
------------------------------------------------------------------
function EndOfFile (TheFile : T) return Boolean
with Global => null;
------------------------------------------------------------------
-- EndOfLine
--
-- Description:
-- Returns true when the next element in the file is LF CR.
--
-- Traceunit : C.File.EndOfLine
------------------------------------------------------------------
function EndOfLine (TheFile : T) return Boolean
with Global => null;
------------------------------------------------------------------
-- Create
--
-- Description:
-- Creates the file.
--
-- Traceunit : C.File.Create
------------------------------------------------------------------
procedure Create (TheFile : in out T;
Success : out Boolean)
with Global => null,
Depends => ((Success,
TheFile) => TheFile);
------------------------------------------------------------------
-- Delete
--
-- Description:
-- Deletes the file.
--
-- Traceunit : C.File.Delete
------------------------------------------------------------------
procedure Delete (TheFile : in out T;
Success : out Boolean)
with Global => null,
Depends => ((Success,
TheFile) => TheFile);
------------------------------------------------------------------
-- Compare
--
-- Description:
-- Compares FileA with FileB.
--
-- Traceunit : C.File.Copy
------------------------------------------------------------------
procedure Compare (FileA : in out T;
FileB : in out T;
FilesTheSame : out Boolean)
with Global => null,
Depends => ((FileA,
FileB) =>+ null,
FilesTheSame => (FileA,
FileB));
------------------------------------------------------------------
-- Copy
--
-- Description:
-- Copies FileA to FileB, if FileB exists then the contents of
-- FileA are appended to FileB.
--
-- Traceunit : C.File.Copy
------------------------------------------------------------------
procedure Copy (FileA : in out T;
FileB : in out T;
Success : out Boolean)
with Global => null,
Depends => ((FileA,
FileB) =>+ FileA,
Success => (FileA,
FileB));
------------------------------------------------------------------
-- CreateDirectory
--
-- Description:
-- Creates the named directory if it does not exist.
--
-- Traceunit : C.File.CreateDirectory
------------------------------------------------------------------
procedure CreateDirectory (DirName : in String;
Success : out Boolean)
with Global => null,
Depends => (Success => DirName);
private
pragma SPARK_Mode (Off); -- access types
-- hidden due to use of access types, required in low level file
-- handling.
subtype NameLengthT is Natural range 0..MaxNameLength;
subtype NameI is Positive range 1..MaxNameLength;
subtype NameTextT is String(NameI);
type NameT is record
Text : NameTextT;
Length : NameLengthT;
end record;
type FilePtr is access Ada.Streams.Stream_IO.File_Type;
type T is record
Name : NameT;
Handle : FilePtr := null;
end record;
NullFile : constant T := T'(NameT'(NameTextT'(others => ' '), 0), null);
end File;
|