]>
Commit | Line | Data |
---|---|---|
1eee94d3 GM |
1 | (* SFIO.def provides a String interface to the opening routines of FIO. |
2 | ||
a945c346 | 3 | Copyright (C) 2001-2024 Free Software Foundation, Inc. |
1eee94d3 GM |
4 | Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>. |
5 | ||
6 | This file is part of GNU Modula-2. | |
7 | ||
8 | GNU Modula-2 is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation; either version 3, or (at your option) | |
11 | any later version. | |
12 | ||
13 | GNU Modula-2 is distributed in the hope that it will be useful, but | |
14 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | General Public License for more details. | |
17 | ||
18 | Under Section 7 of GPL version 3, you are granted additional | |
19 | permissions described in the GCC Runtime Library Exception, version | |
20 | 3.1, as published by the Free Software Foundation. | |
21 | ||
22 | You should have received a copy of the GNU General Public License and | |
23 | a copy of the GCC Runtime Library Exception along with this program; | |
24 | see the files COPYING3 and COPYING.RUNTIME respectively. If not, see | |
25 | <http://www.gnu.org/licenses/>. *) | |
26 | ||
27 | DEFINITION MODULE SFIO ; | |
28 | ||
29 | FROM DynamicStrings IMPORT String ; | |
30 | FROM FIO IMPORT File ; | |
31 | ||
32 | EXPORT QUALIFIED OpenToRead, OpenToWrite, OpenForRandom, Exists, WriteS, ReadS ; | |
33 | ||
34 | ||
35 | (* | |
36 | Exists - returns TRUE if a file named, fname exists for reading. | |
37 | *) | |
38 | ||
39 | PROCEDURE Exists (fname: String) : BOOLEAN ; | |
40 | ||
41 | ||
42 | (* | |
43 | OpenToRead - attempts to open a file, fname, for reading and | |
44 | it returns this file. | |
45 | The success of this operation can be checked by | |
46 | calling IsNoError. | |
47 | *) | |
48 | ||
49 | PROCEDURE OpenToRead (fname: String) : File ; | |
50 | ||
51 | ||
52 | (* | |
53 | OpenToWrite - attempts to open a file, fname, for write and | |
54 | it returns this file. | |
55 | The success of this operation can be checked by | |
56 | calling IsNoError. | |
57 | *) | |
58 | ||
59 | PROCEDURE OpenToWrite (fname: String) : File ; | |
60 | ||
61 | ||
62 | (* | |
63 | OpenForRandom - attempts to open a file, fname, for random access | |
64 | read or write and it returns this file. | |
65 | The success of this operation can be checked by | |
66 | calling IsNoError. | |
67 | towrite, determines whether the file should be | |
68 | opened for writing or reading. | |
69 | if towrite is TRUE or whether the previous file should | |
70 | be left alone, allowing this descriptor to seek | |
71 | and modify an existing file. | |
72 | *) | |
73 | ||
74 | PROCEDURE OpenForRandom (fname: String; towrite, newfile: BOOLEAN) : File ; | |
75 | ||
76 | ||
77 | (* | |
78 | WriteS - writes a string, s, to, file. It returns the String, s. | |
79 | *) | |
80 | ||
81 | PROCEDURE WriteS (file: File; s: String) : String ; | |
82 | ||
83 | ||
84 | (* | |
85 | ReadS - reads a string, s, from, file. It returns the String, s. | |
86 | It stops reading the string at the end of line or end of file. | |
87 | It consumes the newline at the end of line but does not place | |
88 | this into the returned string. | |
89 | *) | |
90 | ||
91 | PROCEDURE ReadS (file: File) : String ; | |
92 | ||
93 | ||
94 | END SFIO. |