summaryrefslogtreecommitdiff
path: root/PACE/pace/stdio.h
blob: 573d5c1d3506d291e0aefc03b8110279370c5dfd (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
/* $Id$

 * ============================================================================
 *
 * = LIBRARY
 *    pace
 *
 * = FILENAME
 *    pace/stdio.h
 *
 * = AUTHOR
 *    Luther Baker
 *
 * ============================================================================ */

#ifndef PACE_STDIO_H
#define PACE_STDIO_H

#include "pace/config/defines.h"

#if (PACE_HAS_POSIX)
# include "pace/posix/stdio.h"
#elif (PACE_VXWORKS)
# include "pace/vxworks/stdio.h"
#elif (PACE_WIN32)
# include "pace/win32/stdio.h"
#endif

#if defined (PACE_HAS_CPLUSPLUS)
extern "C" {
#endif /* PACE_HAS_CPLUSPLUS */

  /**
     PACE's implementation of the POSIX function clearerr.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE void pace_clearerr (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function fclose.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_fclose (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function ctermid.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 4.7.1.
     */
  PACE_INLINE char * pace_ctermid (char * s);

  /**
     PACE's implementation of the POSIX function fdopen.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.2.
     */
  PACE_INLINE PACE_FILE * pace_fdopen (int fildes, const char * type);

  /**
     PACE's implementation of the POSIX function ferror.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_ferror (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function feof.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_feof (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function fflush.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_fflush (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function fileno.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.1.
     */
  PACE_INLINE int pace_fileno (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function fgetc.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_fgetc (PACE_FILE * stream);

  /**
    C std 7.19.9.1
    */
  PACE_INLINE int pace_fgetpos(PACE_FILE * stream,
                               pace_fpos_t * pos);

  /**
     PACE's implementation of the POSIX function fgets.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE char * pace_fgets (char * s, int n, PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function flockfile.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.6.
     */
  PACE_INLINE void pace_flockfile (PACE_FILE * file);
  /* Requires PACE_HAS_REENTRANT. */

  /**
     PACE's implementation of the POSIX function fopen.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE PACE_FILE * pace_fopen (const char * filename, const char * mode);

  /**
     PACE's implementation of the POSIX function fprintf.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  int pace_fprintf (PACE_FILE *stream, const char *format, ...);

  /**
     PACE's implementation of the POSIX function fputc.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_fputc (int c, PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function fputs.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_fputs (const char * s, PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function fread.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE pace_size_t pace_fread (void * ptr,
                                      pace_size_t size,
                                      pace_size_t number_of_items,
                                      PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function freopen.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE FILE * pace_freopen (const char * filename,
                                   const char * mode,
                                   PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function fscanf.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  #define pace_fscanf (X) fscanf X
  /* int pace_scanf (const char *format, ... );
  *
  * PLEASE PAY SPECIAL ATTENTION HERE!
  * This is a macro and requires an additional set of parenthesis
  * surrounding the arguments.
  */

  /**
     PACE's implementation of the POSIX function fseek.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_fseek (PACE_FILE * stream, long offset, int whence);

  /**
    C std 7.19.9.3
    */
  PACE_INLINE int pace_fsetpos(PACE_FILE *stream, const pace_fpos_t *pos);

  /**
     PACE's implementation of the POSIX function ftell.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE long pace_ftell (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function ftrylockfile.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.6.
     */
  PACE_INLINE int pace_ftrylockfile (PACE_FILE * file);
  /* Requires PACE_HAS_REENTRANT. */

  /**
     PACE's implementation of the POSIX function funlockfile.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.6.
     */
  PACE_INLINE void pace_funlockfile (PACE_FILE * file);
  /* Requires PACE_HAS_REENTRANT. */

  /**
    C std 7.19.8.2
    */
  PACE_INLINE pace_size_t pace_fwrite(const void * ptr,
                       pace_size_t size, pace_size_t nmemb,
                       PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function getc.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_getc (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function getc_unlocked.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.7.
     */
  PACE_INLINE int pace_getc_unlocked (PACE_FILE * stream);
  /* Requires PACE_HAS_REENTRANT. */

  /**
     PACE's implementation of the POSIX function getchar.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_getchar ();

  /**
     PACE's implementation of the POSIX function getchar_unlocked.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.7.
     */
  PACE_INLINE int pace_getchar_unlocked ();
  /* Requires PACE_HAS_REENTRANT. */

  /**
     PACE's implementation of the POSIX function gets.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE char *pace_gets (char * s);

  /**
     PACE's implementation of the POSIX function perror.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE void pace_perror (const char * s);

  /**
     PACE's implementation of the POSIX function printf.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  int pace_printf (const char* format, ...);

  /**
     PACE's implementation of the POSIX function putc.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_putc (int c, PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function putc_unlocked.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.7.
     */
  PACE_INLINE int pace_putc_unlocked (int c, PACE_FILE * stream);
  /* Requires PACE_HAS_REENTRANT. */

  /**
     PACE's implementation of the POSIX function putchar.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_putchar (int c);

  /**
     PACE's implementation of the POSIX function putchar_unlocked.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.2.7.
     */
  PACE_INLINE int pace_putchar_unlocked (int c);
  /* Requires PACE_HAS_REENTRANT. */

  /**
     PACE's implementation of the POSIX function puts.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_puts (const char * s);

  /**
     PACE's implementation of the POSIX function remove.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_remove (const char * path);

  /**
     PACE's implementation of the POSIX function rename.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 5.5.3.
     */
  PACE_INLINE int pace_rename (const char * old_name,
                               const char * new_name);

  /**
     PACE's implementation of the POSIX function rewind.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE void pace_rewind (PACE_FILE * stream);

  /**
     PACE's implementation of the POSIX function sprintf.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  int pace_sprintf (char* s, const char* format, ...);

  /**
     PACE's implementation of the POSIX function scanf.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  #define pace_scanf (X) scanf X
  /* int pace_scanf (const char *format, ... );
  *
  * PLEASE PAY SPECIAL ATTENTION HERE!
  * This is a macro and requires an additional set of parenthesis
  * surrounding the arguments.
  */

  /**
     PACE's implementation of the POSIX function setbuf.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE void pace_setbuf (PACE_FILE * stream, char * buf);


  /**
    C std 7.19.5.6
    */
  PACE_INLINE int pace_setvbuf(PACE_FILE * stream,
                               char * buf,
                               int mode, pace_size_t size);
  /**
     PACE's implementation of the POSIX function sscanf.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  #define pace_sscanf (X) sscanf X
  /* int pace_sscanf (const char *s, const char *format, ... );
  *
  * PLEASE PAY SPECIAL ATTENTION HERE!
  * This is a macro and requires an additional set of parenthesis
  * surrounding the arguments.
  */

  /**
     PACE's implementation of the POSIX function tmpfile.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE FILE * pace_tmpfile ();

  /**
     PACE's implementation of the POSIX function tmpnam.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE char * pace_tmpnam (char * s);

  /**
     PACE's implementation of the POSIX function ungetc.
     See POSIX standard (Internation Standard ISO/IEC 9945-1:1996;
     IEEE Std 1003.1, 1996 Edition), Section 8.1.
     */
  PACE_INLINE int pace_ungetc (int c, FILE * stream);

  /**
    C std 7.19.6.8
    */
  PACE_INLINE int pace_vfprintf (PACE_FILE * stream,
                                 const char * format,
                                 va_list arg);

  /**
    C std 7.19.6.10
    */
  PACE_INLINE int pace_vprintf (const char * format,
                                va_list arg);

  /**
    C std 7.19.6.13
    */
  PACE_INLINE int pace_vsprintf (char * s,
                                 const char * format,
                                 va_list arg);
#if defined (PACE_HAS_CPLUSPLUS)
}
#endif /* PACE_HAS_CPLUSPLUS */

#if defined (PACE_HAS_INLINE)
#  if (PACE_HAS_POSIX)
#    include "pace/posix/stdio.inl"
#  elif (PACE_VXWORKS)
#    include "pace/vxworks/stdio.inl"
#  elif (PACE_WIN32)
#    include "pace/win32/stdio.inl"
#  endif
#endif /* PACE_HAS_INLINE */

#endif /* PACE_STDIO_H */