summaryrefslogtreecommitdiff
path: root/support/dktools/dk4fd.ctr
blob: 1ba43ae7bbfca9638c4a2238118439e5428ae441 (plain)
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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd



%%	header

/**	@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



%%	module


#include "dk4fd.h"

#if DK4_HAVE_ERRNO_H
#ifndef ERRNO_H_INCLUDED
#include <errno.h>
#define	ERRNO_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_UNISTD_H
#ifndef UNISTD_H_INCLUDED
#include <unistd.h>
#define	UNISTD_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_SHARE_H
#ifndef SHARE_H_INCLUDED
#include <share.h>
#define SHARE_H_INCLUDED 1
#endif
#endif


$!trace-include



int
dk4fd_c8_open(const char *path, int flags, dk4_er_t *erp)
{
  int		back	=	-1;
  if (NULL != path) {
#if DK4_ON_WINDOWS
#if _MSC_VER >= 1700
    int res;
    if (0 != (res = _sopen_s(&back,path,flags,_SH_DENYNO,(_S_IREAD|_S_IWRITE))))
    {
      if (-1 != back) {
        _close(back);
	back = -1;
      }
      dk4error_set_idetails(erp, DK4_E_OPEN_FAILED, res);
    }
#else
    errno = 0;
    back = _open(path, flags, (_S_IREAD | _S_IWRITE));
    if (-1 == back) {
      dk4error_set_idetails(erp, DK4_E_OPEN_FAILED, errno);
    }
#endif
#else
    errno = 0;
    back = open(path, flags, 0600);
    if (-1 == back) {
      dk4error_set_idetails(erp, DK4_E_OPEN_FAILED, errno);
    }
#endif
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
}



int
dk4fd_wc_open(const wchar_t *path, int flags, dk4_er_t *erp)
{
  int		back	=	-1;
  if (NULL != path) {
#if DK4_ON_WINDOWS
#if _MSC_VER >= 1700
    int res;
    if (0 != (res=_wsopen_s(&back,path,flags,_SH_DENYNO,(_S_IREAD|_S_IWRITE))))
    {
      if (-1 != back) {
        _close(back);
	back = -1;
      }
      dk4error_set_idetails(erp, DK4_E_OPEN_FAILED, res);
    }
#else
    errno = 0;
    back = _wopen(path, flags, (_S_IREAD | _S_IWRITE));
    if (-1 == back) {
      dk4error_set_idetails(erp, DK4_E_OPEN_FAILED, errno);
    }
#endif
#else
    dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED);
#endif
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
}



int
dk4fd_open(const dkChar *path, int flags, dk4_er_t *erp)
{
#if DK4_CHAR_SIZE > 1
  return (dk4fd_wc_open(path, flags, erp));
#else
  return (dk4fd_c8_open(path, flags, erp));
#endif
}



int
dk4fd_close(int fd, dk4_er_t *erp)
{
  int		back = 0;
#if DK4_ON_WINDOWS
  errno = 0;
  if (0 == _close(fd)) {
    back = 1;
  } else {
    dk4error_set_idetails(erp, DK4_E_CLOSE_FAILED, errno);
  }
#else
  errno = 0;
  if (0 == close(fd)) {
    back = 1;
  } else {
    dk4error_set_idetails(erp, DK4_E_CLOSE_FAILED, errno);
  }
#endif
  return back;
}



#if !DK4_ON_WINDOWS
#ifndef SSIZE_MAX
/**	Maximum value for ssize_t.
*/
#define	SSIZE_MAX ((SIZE_MAX) / 2U)
#endif
#endif



int
dk4fd_write(int fd, const void *buffer, size_t sz, dk4_er_t *erp)
{
#if DK4_ON_WINDOWS
  int		 back = 0;
  int		 res;
  if ((NULL != buffer) && (0 < sz)) {
    if ((dk4_um_t)INT_MAX >= (dk4_um_t)sz) {
      errno = 0;
      res = _write(fd, buffer, (unsigned)sz);
      if ((unsigned)res == (unsigned)sz) {
	back = 1;
      } else {
	if (0 <= res) {
	  dk4error_set_elsize_nelem(erp, DK4_E_WRITE_FAILED, 1, (size_t)res);
	} else {
	  dk4error_set_elsize_nelem(erp, DK4_E_WRITE_FAILED, 1, 0);
	}
      }
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
#else
  ssize_t	 res;
  int		 back = 0;
  if ((NULL != buffer) && (0 < sz)) {
    if ((dk4_um_t)SSIZE_MAX >= (dk4_um_t)sz) {
      errno = 0;
      res = write(fd, buffer, sz);
      if ((size_t)res == sz) {
        back = 1;
      } else {
        if (0 <= res) {
          dk4error_set_elsize_nelem(erp, DK4_E_WRITE_FAILED, 1, res);
	} else {
	  dk4error_set_elsize_nelem(erp, DK4_E_WRITE_FAILED, 1, 0);
	}
      }
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
#endif
}



int
dk4fd_read(int fd, void *buffer, size_t *psz, dk4_er_t *erp)
{
#if DK4_ON_WINDOWS
  int		 res	= 0;	/* Result from read operation */
  int		 back	= 0;
  if ((NULL != buffer) && (NULL != psz)) {
    if (0 < *psz) {
      if ((dk4_um_t)INT_MAX >= (dk4_um_t)(*psz)) {
	errno = 0;
	res = _read(fd, buffer, (unsigned)(*psz));
	if (0 < res) {
	  back = 1;
	  *psz = (size_t)res;
	} else {
	  if (0 > res) {
	    back = 0;
	    *psz = 0;
	    dk4error_set_idetails(erp, DK4_E_READ_FAILED, errno);
	  } else {
	    back = 1;
	    *psz = 0;
	  }
	}
      } else {
        dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
      }
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
#else
  int		 back = 0;
  ssize_t	 res;
  if ((NULL != buffer) && (NULL != psz)) {
    if (0 < *psz) {
      if ((dk4_um_t)SSIZE_MAX >= (dk4_um_t)(*psz)) {
        errno = 0;
        res = read(fd, buffer, *psz);
	if (0 < res) {
	  back = 1;
	  *psz = (size_t)res;
	} else {
	  if (0 > res) {
	    back = 0;
	    *psz = 0;
	    dk4error_set_idetails(erp, DK4_E_READ_FAILED, errno);
	  } else {
	    back = 1;
	    *psz = 0;
	  }
	}
      } else {
        dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
      }
    } else {
      dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
#endif
}