]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/m2/gm2-libs/SFIO.def
Update copyright years.
[thirdparty/gcc.git] / gcc / m2 / gm2-libs / SFIO.def
CommitLineData
1eee94d3
GM
1(* SFIO.def provides a String interface to the opening routines of FIO.
2
a945c346 3Copyright (C) 2001-2024 Free Software Foundation, Inc.
1eee94d3
GM
4Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
5
6This file is part of GNU Modula-2.
7
8GNU Modula-2 is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation; either version 3, or (at your option)
11any later version.
12
13GNU Modula-2 is distributed in the hope that it will be useful, but
14WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16General Public License for more details.
17
18Under Section 7 of GPL version 3, you are granted additional
19permissions described in the GCC Runtime Library Exception, version
203.1, as published by the Free Software Foundation.
21
22You should have received a copy of the GNU General Public License and
23a copy of the GCC Runtime Library Exception along with this program;
24see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
25<http://www.gnu.org/licenses/>. *)
26
27DEFINITION MODULE SFIO ;
28
29FROM DynamicStrings IMPORT String ;
30FROM FIO IMPORT File ;
31
32EXPORT QUALIFIED OpenToRead, OpenToWrite, OpenForRandom, Exists, WriteS, ReadS ;
33
34
35(*
36 Exists - returns TRUE if a file named, fname exists for reading.
37*)
38
39PROCEDURE 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
49PROCEDURE 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
59PROCEDURE 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
74PROCEDURE 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
81PROCEDURE 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
91PROCEDURE ReadS (file: File) : String ;
92
93
94END SFIO.