]>
Commit | Line | Data |
---|---|---|
1eee94d3 GM |
1 | /* do not edit automatically generated by mc from SFIO. */ |
2 | /* SFIO.def provides a String interface to the opening routines of FIO. | |
3 | ||
83ffe9cd | 4 | Copyright (C) 2001-2023 Free Software Foundation, Inc. |
1eee94d3 GM |
5 | Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>. |
6 | ||
7 | This file is part of GNU Modula-2. | |
8 | ||
9 | GNU Modula-2 is free software; you can redistribute it and/or modify | |
10 | it under the terms of the GNU General Public License as published by | |
11 | the Free Software Foundation; either version 3, or (at your option) | |
12 | any later version. | |
13 | ||
14 | GNU Modula-2 is distributed in the hope that it will be useful, but | |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | General Public License for more details. | |
18 | ||
19 | Under Section 7 of GPL version 3, you are granted additional | |
20 | permissions described in the GCC Runtime Library Exception, version | |
21 | 3.1, as published by the Free Software Foundation. | |
22 | ||
23 | You should have received a copy of the GNU General Public License and | |
24 | a copy of the GCC Runtime Library Exception along with this program; | |
25 | see the files COPYING3 and COPYING.RUNTIME respectively. If not, see | |
26 | <http://www.gnu.org/licenses/>. */ | |
27 | ||
28 | ||
29 | #if !defined (_SFIO_H) | |
30 | # define _SFIO_H | |
31 | ||
32 | #include "config.h" | |
33 | #include "system.h" | |
34 | # ifdef __cplusplus | |
35 | extern "C" { | |
36 | # endif | |
37 | # if !defined (PROC_D) | |
38 | # define PROC_D | |
39 | typedef void (*PROC_t) (void); | |
40 | typedef struct { PROC_t proc; } PROC; | |
41 | # endif | |
42 | ||
43 | # include "GDynamicStrings.h" | |
44 | # include "GFIO.h" | |
45 | ||
46 | # if defined (_SFIO_C) | |
47 | # define EXTERN | |
48 | # else | |
49 | # define EXTERN extern | |
50 | # endif | |
51 | ||
52 | ||
53 | /* | |
54 | Exists - returns TRUE if a file named, fname exists for reading. | |
55 | */ | |
56 | ||
57 | EXTERN unsigned int SFIO_Exists (DynamicStrings_String fname); | |
58 | ||
59 | /* | |
60 | OpenToRead - attempts to open a file, fname, for reading and | |
61 | it returns this file. | |
62 | The success of this operation can be checked by | |
63 | calling IsNoError. | |
64 | */ | |
65 | ||
66 | EXTERN FIO_File SFIO_OpenToRead (DynamicStrings_String fname); | |
67 | ||
68 | /* | |
69 | OpenToWrite - attempts to open a file, fname, for write and | |
70 | it returns this file. | |
71 | The success of this operation can be checked by | |
72 | calling IsNoError. | |
73 | */ | |
74 | ||
75 | EXTERN FIO_File SFIO_OpenToWrite (DynamicStrings_String fname); | |
76 | ||
77 | /* | |
78 | OpenForRandom - attempts to open a file, fname, for random access | |
79 | read or write and it returns this file. | |
80 | The success of this operation can be checked by | |
81 | calling IsNoError. | |
82 | towrite, determines whether the file should be | |
83 | opened for writing or reading. | |
84 | if towrite is TRUE or whether the previous file should | |
85 | be left alone, allowing this descriptor to seek | |
86 | and modify an existing file. | |
87 | */ | |
88 | ||
89 | EXTERN FIO_File SFIO_OpenForRandom (DynamicStrings_String fname, unsigned int towrite, unsigned int newfile); | |
90 | ||
91 | /* | |
92 | WriteS - writes a string, s, to, file. It returns the String, s. | |
93 | */ | |
94 | ||
95 | EXTERN DynamicStrings_String SFIO_WriteS (FIO_File file, DynamicStrings_String s); | |
96 | ||
97 | /* | |
98 | ReadS - reads a string, s, from, file. It returns the String, s. | |
99 | It stops reading the string at the end of line or end of file. | |
100 | It consumes the newline at the end of line but does not place | |
101 | this into the returned string. | |
102 | */ | |
103 | ||
104 | EXTERN DynamicStrings_String SFIO_ReadS (FIO_File file); | |
105 | # ifdef __cplusplus | |
106 | } | |
107 | # endif | |
108 | ||
109 | # undef EXTERN | |
110 | #endif |