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
|
/*
WARNING: This file was generated by dkct.
Changes you make here will be lost if dkct is run again!
You should modify the original source and run dkct on it.
Original source: dk4fd.ctr
*/
/*
Copyright (C) 2015-2017, Dirk Krause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef DK4FD_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4FD_H_INCLUDED 1
#line 10 "dk4fd.ctr"
/** @file
File descriptors, open and close a file, read and write.
Portable use of file descriptor.
CRT on Windows: Required.
*/
#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif
#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif
#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif
#if DK4_HAVE_SYS_TYPES_H
#ifndef SYS_TYPES_H_INCLUDED
#include <sys/types.h>
#define SYS_TYPES_H_INCLUDED 1
#endif
#endif
#if DK4_HAVE_SYS_STAT_H
#ifndef SYS_STAT_H_INCLUDED
#include <sys/stat.h>
#define SYS_STAT_H_INCLUDED 1
#endif
#endif
#if DK4_HAVE_FCNTL_H
#ifndef FCNTL_H_INCLUDED
#include <fcntl.h>
#define FCNTL_H_INCLUDED 1
#endif
#endif
#if DK4_HAVE_IO_H
#ifndef IO_H_INCLUDED
#include <io.h>
#define IO_H_INCLUDED 1
#endif
#endif
#if DK4_HAVE_WCHAR_H
#ifndef WCHAR_H_INCLUDED
#include <wchar.h>
#define WCHAR_H_INCLUDED 1
#endif
#endif
#if DK4_ON_WINDOWS
/** File open flags.
*/
enum {
/** Read only access.
*/
DK4_O_RDONLY = _O_RDONLY,
/** Write only access.
*/
DK4_O_WRONLY = _O_WRONLY,
/** Read and write access.
*/
DK4_O_RDWR = _O_RDWR,
/** Create file if it does
not yet exist.
*/
DK4_O_CREAT = _O_CREAT,
/** Combined with DK4_O_CREAT,
create error if file already
exists.
*/
DK4_O_EXCL = _O_EXCL,
/** Truncate existing file.
*/
DK4_O_TRUNC = _O_TRUNC,
/** Append to existing file.
*/
DK4_O_APPEND = _O_APPEND,
/** Open file in binary mode.
*/
DK4_O_BINARY = _O_BINARY,
};
#else
/** File open flags.
*/
enum {
/** Read only access.
*/
DK4_O_RDONLY = O_RDONLY,
/** Write only access.
*/
DK4_O_WRONLY = O_WRONLY,
/** Read and write access.
*/
DK4_O_RDWR = O_RDWR,
/** Create file if it does
not yet exist.
*/
DK4_O_CREAT = O_CREAT,
/** Combined with DK4_O_CREAT,
create error if file already
exists.
*/
DK4_O_EXCL = O_EXCL,
/** Truncate existing file.
*/
DK4_O_TRUNC = O_TRUNC,
/** Append to existing file.
*/
DK4_O_APPEND = O_APPEND,
/** Open file in binary mode.
*/
DK4_O_BINARY = 0,
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
/** Open a file, return file descriptor.
@param path File name.
@param flags Flags how to open the file.
@param erp Error report, may be NULL.
@return Non-negative file descriptor on success, -1 on error.
Error codes:
- DK4_E_INVALID_ARGUMENTS<br>
if path is NULL,
- DK4_E_OPEN_FAILED<br>
with iDetails set to errno value if the open() function indicated
an error.
*/
int
dk4fd_c8_open(const char *path, int flags, dk4_er_t *erp);
/** Open a file, return file descriptor.
@param path File name.
@param flags Flags how to open the file.
@param erp Error report, may be NULL.
@return Non-negative file descriptor on success, -1 on error.
Error codes:
- DK4_E_NOT_SUPPORTED<br>
if there is no function available to open files by wchar_t file name,
- DK4_E_INVALID_ARGUMENTS<br>
if path is NULL,
- DK4_E_OPEN_FAILED<br>
with iDetails set to errno value if the open() function indicated
an error.
*/
int
dk4fd_wc_open(const wchar_t *path, int flags, dk4_er_t *erp);
/** Open a file, return file descriptor.
@param path File name.
@param flags Flags how to open the file.
@param erp Error report, may be NULL.
@return Non-negative file descriptor on success, -1 on error.
Error codes:
- DK4_E_NOT_SUPPORTED<br>
if there is no function available to open files by wchar_t file name,
- DK4_E_INVALID_ARGUMENTS<br>
if path is NULL,
- DK4_E_OPEN_FAILED<br>
with iDetails set to errno value if the open() function indicated
an error.
*/
int
dk4fd_open(const dkChar *path, int flags, dk4_er_t *erp);
/** Close file descriptor.
@param fd File descriptor to close.
@param erp Error report, may be NULL.
@return 1 on success, 0 on error.
Error codes:
- DK4_E_CLOSE_FAILED<br>
with iDetails set to errno if the close() function indicates an error.
*/
int
dk4fd_close(int fd, dk4_er_t *erp);
/** Write data to a file descriptor.
@param fd File descriptor.
@param buffer Buffer start address.
@param sz Size of buffer.
@param erp Error report, may be NULL.
@return 1 on success (all bytes written), 0 otherwise.
Error codes:
- DK4_E_INVALID_ARGUMENTS<br>
if buffer is NULL or sz is 0 or sz is too large,
- DK4_E_WRITE_FAILED<br>
with mem.nelem set to the number of bytes written if
the write attempt failed.
*/
int
dk4fd_write(int fd, const void *buffer, size_t sz, dk4_er_t *erp);
/** Read data from a file descriptor.
@param fd File descriptor.
@param buffer Buffer start address.
@param psz Pointer to size variable,
in: Size of buffer,
out: Number of bytes read.
@param erp Error report, may be NULL.
@return 1 on success (at least one byte read), 0 otherwise.
Error codes:
- DK4_E_INVALID_ARGUMENTS<br>
if buffer or psz is NULL or *psz is 0 or *psz is too large,
- DK4_E_READ_FAILED<br>
with iDetails set to errno if the read() function indicated an error.
*/
int
dk4fd_read(int fd, void *buffer, size_t *psz, dk4_er_t *erp);
#ifdef __cplusplus
}
#endif
#endif
|
