summaryrefslogtreecommitdiff
path: root/support/dktools/dk4fput.ctr
blob: 3e1328d0123e7ec4df158173e56f27bfe267d66e (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
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
SPDX-License-Identifier:	BSD-3-Clause



%%	header

/**	@file
	File functions for dkChar characters
	and strings.

	CRT on Windows: Required.
*/

#ifndef DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif

#ifndef STDIO_H_INCLUDED
#include <stdio.h>
#define	STDIO_H_INCLUDED 1
#endif

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

#ifdef __cplusplus
extern "C" {
#endif

/**	On Windows, initialize stdout to write dkChar and write a BOM.
*/
void
dk4fput_initialize_stdout(void);

/**	On Windows, initialize stdout to write dkChar.
*/
void
dk4fput_initialize_stdout_no_bom(void);

/**	On Windows, initialize stderr to write dkChar and write a BOM.
*/
void
dk4fput_initialize_stderr(void);

/**	On Windows, initialize stderr to write dkChar.
*/
void
dk4fput_initialize_stderr_no_bom(void);

/**	On Windows, initialize file to write dkChar and write a BOM.
	@param	fipo	File to set up.
*/
void
dk4fput_initialize_file(FILE *fipo);

/**	On Windows, initialize file to write dkChar.
	@param	fipo	File to set up.
*/
void
dk4fput_initialize_file_no_bom(FILE *fipo);

/**	On Windows, return to the default file encoding for stdout.
*/
void
dk4fput_cleanup_stdout(void);

/**	On Windows, return to the default file encoding for stderr.
*/
void
dk4fput_cleanup_stderr(void);

/**	Write one character to file.
	@param	c	Character to write.
	@param	fipo	File to write to.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  if writing wide characters is not supported on the system,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL,
	- DK4_E_WRITE_FAILED<br>
	  with errno value in iDetails1 if the write attempt failed.
*/
int
dk4fputc(dkChar c, FILE *fipo, dk4_er_t *erp);

/**	Write one string to file.
	@param	s	String to write.
	@param	fipo	File to write to.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  if writing wide character strings is not supported on the system,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fipo is NULL,
	- DK4_E_WRITE_FAILED<br>
	  with errno in iDetails1 if the write attempt failed.
*/
int
dk4fputs(const dkChar *s, FILE *fipo, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



%%	module

#include "dk4conf.h"
#include "dk4fput.h"

#if DK4_HAVE_IO_H
#ifndef IO_H_INCLUDED
#include <io.h>
#define IO_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_FCNTL_H
#ifndef FCNTL_H_INCLUDED
#include <fcntl.h>
#define	FCNTL_H_INCLUDED 1
#endif
#endif

#ifndef	DK4REC26_H_INCLUDED
#include "dk4rec26.h"
#endif

#include "dk4unused.h"

#if DK4_HAVE_ASSERT_H
#ifndef	ASSERT_H_INCLUDED
#include <assert.h>
#define	ASSERT_H_INCLUDED 1
#endif
#endif


$!trace-include



#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)

/**	Flag: Standard output initialized to write dkChar.
*/
static int dk4fput_stdout_initialized = 0;

/**	Standard output mode at startup (should be restored before exiting).
*/
static int dk4fput_stdout_oldmode = _O_TEXT;

/**	Flag: Standard error output initialized to write dkChar.
*/
static int dk4fput_stderr_initialized = 0;

/**	Standard error mode at startup (should be restored before exiting).
*/
static int dk4fput_stderr_oldmode = _O_TEXT;

#endif



void
dk4fput_initialize_stdout(void)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  if (0 == dk4fput_stdout_initialized) {
    dk4fput_stdout_oldmode = _setmode(_fileno(stdout), _O_U16TEXT);
    if (0 == _isatty(_fileno(stdout))) {
      fputwc((wchar_t)0xFEFF, stdout);
    }
    dk4fput_stdout_initialized = 1;
  }
#endif
}



void
dk4fput_initialize_stdout_no_bom(void)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  if (0 == dk4fput_stdout_initialized) {
    dk4fput_stdout_oldmode = _setmode(_fileno(stdout), _O_U16TEXT);
    dk4fput_stdout_initialized = 1;
  }
#endif
}


void
dk4fput_cleanup_stdout(void)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  if (0 != dk4fput_stdout_initialized) {
    fflush(stdout);
    (void)_setmode(_fileno(stdout), dk4fput_stdout_oldmode);
  }
#endif
}



void
dk4fput_initialize_stderr(void)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  if (0 == dk4fput_stderr_initialized) {
    dk4fput_stderr_oldmode = _setmode(_fileno(stderr), _O_U16TEXT);
    if (0 == _isatty(_fileno(stderr))) {
      fputwc((wchar_t)0xFEFF, stderr);
    }
    dk4fput_stderr_initialized = 1;
  }
#endif
}



void
dk4fput_initialize_stderr_no_bom(void)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  if (0 == dk4fput_stderr_initialized) {
    dk4fput_stderr_oldmode = _setmode(_fileno(stderr), _O_U16TEXT);
    dk4fput_stderr_initialized = 1;
  }
#endif
}



void
dk4fput_cleanup_stderr(void)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  if (0 != dk4fput_stderr_initialized) {
    fflush(stderr);
    (void)_setmode(_fileno(stdout), dk4fput_stderr_oldmode);
  }
#endif
}


void
dk4fput_initialize_file(
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  FILE *fipo
#else
  FILE * DK4_ARG_UNUSED(fipo)
#endif
)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
#if	DK4_USE_ASSERT
  assert(NULL != fipo);
#endif
  if (NULL != fipo) {
    (void)_setmode(_fileno(fipo), _O_U16TEXT);
    fputwc(0xFEFF, fipo);
  }
#else
  DK4_UNUSED_ARG(fipo)
#endif
}



void
dk4fput_initialize_file_no_bom(
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
  FILE *fipo
#else
  FILE * DK4_ARG_UNUSED(fipo)
#endif
)
{
#if _WIN32 && (DK4_CHAR_SIZE > 1) && DK4_HAVE__SETMODE && defined(_MSC_VER)
#if	DK4_USE_ASSERT
  assert(NULL != fipo);
#endif
  if (NULL != fipo) {
    (void)_setmode(_fileno(fipo), _O_U16TEXT);
  }
#else
  DK4_UNUSED_ARG(fipo)
#endif
}



int
dk4fputc(dkChar c, FILE *fipo, dk4_er_t *erp)
{
#if DK4_CHAR_SIZE > 1
#if DK4_CHAR_SIZE == DK4_SIZEOF_WCHAR_T
#if DK4_HAVE_FPUTWC
  int	back = 0;
  $? "+ dk4fputc (wide) %lx", dk4recode_dk_to_ul(c)
#if	DK4_USE_ASSERT
  assert(NULL != fipo);
#endif
  if (NULL != fipo) {
    errno = 0;
    if (WEOF != fputwc(c, fipo)) {
      back = 1;
    } else {
      dk4error_set_idetails(erp, DK4_E_WRITE_FAILED, errno);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  } $? "- dk4fputc (wide) %d", back
  return back;
#else
  dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED);
  return 0;
#endif
#else
  dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED);
  return 0;
#endif
#else
  int	back = 0;
#if	DK4_USE_ASSERT
  assert(NULL != fipo);
#endif
  if (NULL != fipo) {
    errno = 0;
    if (EOF != fputc(c, fipo)) {
      back = 1;
    } else {
      dk4error_set_idetails(erp, DK4_E_WRITE_FAILED, errno);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
#endif
}



int
dk4fputs(const dkChar *s, FILE *fipo, dk4_er_t *erp)
{
#if DK4_CHAR_SIZE > 1
#if DK4_CHAR_SIZE == DK4_SIZEOF_WCHAR_T
#if DK4_HAVE_FPUTWS
  int	back = 0;
#if	DK4_USE_ASSERT
  assert(NULL != fipo);
  assert(NULL != s);
#endif
  if ((NULL != s) && (NULL != fipo)) {
    errno = 0;
    if (WEOF != fputws(s, fipo)) {
      back = 1;
    } else {
      dk4error_set_idetails(erp, DK4_E_WRITE_FAILED, errno);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
#else
  dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED);
  return 0;
#endif
#else
  dk4error_set_simple_error_code(erp, DK4_E_NOT_SUPPORTED);
  return 0;
#endif
#else
  int	back = 0;
#if	DK4_USE_ASSERT
  assert(NULL != fipo);
  assert(NULL != s);
#endif
  if ((NULL != s) && (NULL != fipo)) {
    errno = 0;
    if (EOF != fputs(s, fipo)) {
      back = 1;
    } else {
      dk4error_set_idetails(erp, DK4_E_WRITE_FAILED, errno);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  return back;
#endif
}