Adjust to recent gnulib change for @GUARD_PREFIX@.
[bpt/emacs.git] / lib / stdio.in.h
CommitLineData
d5cad867
PE
1/* A GNU-like <stdio.h>.
2
3 Copyright (C) 2004, 2007-2011 Free Software Foundation, Inc.
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3, or (at your option)
8 any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18
19#if __GNUC__ >= 3
20@PRAGMA_SYSTEM_HEADER@
21#endif
22@PRAGMA_COLUMNS@
23
24#if defined __need_FILE || defined __need___FILE || defined _GL_ALREADY_INCLUDING_STDIO_H
25/* Special invocation convention:
26 - Inside glibc header files.
27 - On OSF/1 5.1 we have a sequence of nested includes
28 <stdio.h> -> <getopt.h> -> <ctype.h> -> <sys/localedef.h> ->
29 <sys/lc_core.h> -> <nl_types.h> -> <mesg.h> -> <stdio.h>.
30 In this situation, the functions are not yet declared, therefore we cannot
31 provide the C++ aliases. */
32
33#@INCLUDE_NEXT@ @NEXT_STDIO_H@
34
35#else
36/* Normal invocation convention. */
37
6a3e57bb 38#ifndef _@GUARD_PREFIX@_STDIO_H
d5cad867
PE
39
40#define _GL_ALREADY_INCLUDING_STDIO_H
41
42/* The include_next requires a split double-inclusion guard. */
43#@INCLUDE_NEXT@ @NEXT_STDIO_H@
44
45#undef _GL_ALREADY_INCLUDING_STDIO_H
46
6a3e57bb
PE
47#ifndef _@GUARD_PREFIX@_STDIO_H
48#define _@GUARD_PREFIX@_STDIO_H
d5cad867
PE
49
50/* Get va_list. Needed on many systems, including glibc 2.8. */
51#include <stdarg.h>
52
53#include <stddef.h>
54
55/* Get off_t and ssize_t. Needed on many systems, including glibc 2.8
56 and eglibc 2.11.2. */
57#include <sys/types.h>
58
59/* The __attribute__ feature is available in gcc versions 2.5 and later.
60 The __-protected variants of the attributes 'format' and 'printf' are
61 accepted by gcc versions 2.6.4 (effectively 2.7) and later.
62 We enable _GL_ATTRIBUTE_FORMAT only if these are supported too, because
63 gnulib and libintl do '#define printf __printf__' when they override
64 the 'printf' function. */
65#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
66# define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
67#else
68# define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
69#endif
63139bfa
PE
70
71/* _GL_ATTRIBUTE_FORMAT_PRINTF
72 indicates to GCC that the function takes a format string and arguments,
73 where the format string directives are the ones standardized by ISO C99
74 and POSIX. */
75#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
76# define _GL_ATTRIBUTE_FORMAT_PRINTF(formatstring_parameter, first_argument) \
77 _GL_ATTRIBUTE_FORMAT ((__gnu_printf__, formatstring_parameter, first_argument))
78#else
79# define _GL_ATTRIBUTE_FORMAT_PRINTF(formatstring_parameter, first_argument) \
80 _GL_ATTRIBUTE_FORMAT ((__printf__, formatstring_parameter, first_argument))
81#endif
82
83/* _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM is like _GL_ATTRIBUTE_FORMAT_PRINTF,
84 except that it indicates to GCC that the supported format string directives
85 are the ones of the system printf(), rather than the ones standardized by
86 ISO C99 and POSIX. */
87#define _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM(formatstring_parameter, first_argument) \
d5cad867
PE
88 _GL_ATTRIBUTE_FORMAT ((__printf__, formatstring_parameter, first_argument))
89
cc2e7b46
PE
90/* _GL_ATTRIBUTE_FORMAT_SCANF
91 indicates to GCC that the function takes a format string and arguments,
92 where the format string directives are the ones standardized by ISO C99
93 and POSIX. */
94#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
95# define _GL_ATTRIBUTE_FORMAT_SCANF(formatstring_parameter, first_argument) \
96 _GL_ATTRIBUTE_FORMAT ((__gnu_scanf__, formatstring_parameter, first_argument))
97#else
98# define _GL_ATTRIBUTE_FORMAT_SCANF(formatstring_parameter, first_argument) \
99 _GL_ATTRIBUTE_FORMAT ((__scanf__, formatstring_parameter, first_argument))
100#endif
101
102/* _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM is like _GL_ATTRIBUTE_FORMAT_SCANF,
103 except that it indicates to GCC that the supported format string directives
104 are the ones of the system scanf(), rather than the ones standardized by
105 ISO C99 and POSIX. */
106#define _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM(formatstring_parameter, first_argument) \
107 _GL_ATTRIBUTE_FORMAT ((__scanf__, formatstring_parameter, first_argument))
108
d5cad867
PE
109/* Solaris 10 declares renameat in <unistd.h>, not in <stdio.h>. */
110/* But in any case avoid namespace pollution on glibc systems. */
111#if (@GNULIB_RENAMEAT@ || defined GNULIB_POSIXCHECK) && defined __sun \
112 && ! defined __GLIBC__
113# include <unistd.h>
114#endif
115
116
117/* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
118
119/* The definition of _GL_ARG_NONNULL is copied here. */
120
121/* The definition of _GL_WARN_ON_USE is copied here. */
122
123/* Macros for stringification. */
124#define _GL_STDIO_STRINGIZE(token) #token
125#define _GL_STDIO_MACROEXPAND_AND_STRINGIZE(token) _GL_STDIO_STRINGIZE(token)
126
127
128#if @GNULIB_DPRINTF@
129# if @REPLACE_DPRINTF@
130# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
131# define dprintf rpl_dprintf
132# endif
133_GL_FUNCDECL_RPL (dprintf, int, (int fd, const char *format, ...)
134 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
135 _GL_ARG_NONNULL ((2)));
136_GL_CXXALIAS_RPL (dprintf, int, (int fd, const char *format, ...));
137# else
138# if !@HAVE_DPRINTF@
139_GL_FUNCDECL_SYS (dprintf, int, (int fd, const char *format, ...)
140 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
141 _GL_ARG_NONNULL ((2)));
142# endif
143_GL_CXXALIAS_SYS (dprintf, int, (int fd, const char *format, ...));
144# endif
145_GL_CXXALIASWARN (dprintf);
146#elif defined GNULIB_POSIXCHECK
147# undef dprintf
148# if HAVE_RAW_DECL_DPRINTF
149_GL_WARN_ON_USE (dprintf, "dprintf is unportable - "
150 "use gnulib module dprintf for portability");
151# endif
152#endif
153
154#if @GNULIB_FCLOSE@
155/* Close STREAM and its underlying file descriptor. */
156# if @REPLACE_FCLOSE@
157# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
158# define fclose rpl_fclose
159# endif
160_GL_FUNCDECL_RPL (fclose, int, (FILE *stream) _GL_ARG_NONNULL ((1)));
161_GL_CXXALIAS_RPL (fclose, int, (FILE *stream));
162# else
163_GL_CXXALIAS_SYS (fclose, int, (FILE *stream));
164# endif
165_GL_CXXALIASWARN (fclose);
166#elif defined GNULIB_POSIXCHECK
167# undef fclose
168/* Assume fclose is always declared. */
169_GL_WARN_ON_USE (fclose, "fclose is not always POSIX compliant - "
170 "use gnulib module fclose for portable POSIX compliance");
171#endif
172
173#if @GNULIB_FFLUSH@
174/* Flush all pending data on STREAM according to POSIX rules. Both
175 output and seekable input streams are supported.
176 Note! LOSS OF DATA can occur if fflush is applied on an input stream
177 that is _not_seekable_ or on an update stream that is _not_seekable_
178 and in which the most recent operation was input. Seekability can
179 be tested with lseek(fileno(fp),0,SEEK_CUR). */
180# if @REPLACE_FFLUSH@
181# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
182# define fflush rpl_fflush
183# endif
184_GL_FUNCDECL_RPL (fflush, int, (FILE *gl_stream));
185_GL_CXXALIAS_RPL (fflush, int, (FILE *gl_stream));
186# else
187_GL_CXXALIAS_SYS (fflush, int, (FILE *gl_stream));
188# endif
189_GL_CXXALIASWARN (fflush);
190#elif defined GNULIB_POSIXCHECK
191# undef fflush
192/* Assume fflush is always declared. */
193_GL_WARN_ON_USE (fflush, "fflush is not always POSIX compliant - "
194 "use gnulib module fflush for portable POSIX compliance");
195#endif
196
cc2e7b46
PE
197#if @GNULIB_FGETC@
198# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
199# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
200# undef fgetc
201# define fgetc rpl_fgetc
202# endif
203_GL_FUNCDECL_RPL (fgetc, int, (FILE *stream) _GL_ARG_NONNULL ((1)));
204_GL_CXXALIAS_RPL (fgetc, int, (FILE *stream));
205# else
206_GL_CXXALIAS_SYS (fgetc, int, (FILE *stream));
207# endif
208_GL_CXXALIASWARN (fgetc);
209#endif
210
211#if @GNULIB_FGETS@
212# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
213# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
214# undef fgets
215# define fgets rpl_fgets
216# endif
217_GL_FUNCDECL_RPL (fgets, char *, (char *s, int n, FILE *stream)
218 _GL_ARG_NONNULL ((1, 3)));
219_GL_CXXALIAS_RPL (fgets, char *, (char *s, int n, FILE *stream));
220# else
221_GL_CXXALIAS_SYS (fgets, char *, (char *s, int n, FILE *stream));
222# endif
223_GL_CXXALIASWARN (fgets);
224#endif
d5cad867
PE
225
226#if @GNULIB_FOPEN@
227# if @REPLACE_FOPEN@
228# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
229# undef fopen
230# define fopen rpl_fopen
231# endif
232_GL_FUNCDECL_RPL (fopen, FILE *, (const char *filename, const char *mode)
233 _GL_ARG_NONNULL ((1, 2)));
234_GL_CXXALIAS_RPL (fopen, FILE *, (const char *filename, const char *mode));
235# else
236_GL_CXXALIAS_SYS (fopen, FILE *, (const char *filename, const char *mode));
237# endif
238_GL_CXXALIASWARN (fopen);
239#elif defined GNULIB_POSIXCHECK
240# undef fopen
241/* Assume fopen is always declared. */
242_GL_WARN_ON_USE (fopen, "fopen on Win32 platforms is not POSIX compatible - "
243 "use gnulib module fopen for portability");
244#endif
245
246#if @GNULIB_FPRINTF_POSIX@ || @GNULIB_FPRINTF@
247# if (@GNULIB_FPRINTF_POSIX@ && @REPLACE_FPRINTF@) \
cc2e7b46 248 || (@GNULIB_FPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
d5cad867
PE
249# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
250# define fprintf rpl_fprintf
251# endif
252# define GNULIB_overrides_fprintf 1
63139bfa 253# if @GNULIB_FPRINTF_POSIX@ || @GNULIB_VFPRINTF_POSIX@
d5cad867
PE
254_GL_FUNCDECL_RPL (fprintf, int, (FILE *fp, const char *format, ...)
255 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
256 _GL_ARG_NONNULL ((1, 2)));
63139bfa
PE
257# else
258_GL_FUNCDECL_RPL (fprintf, int, (FILE *fp, const char *format, ...)
259 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (2, 3)
260 _GL_ARG_NONNULL ((1, 2)));
261# endif
d5cad867
PE
262_GL_CXXALIAS_RPL (fprintf, int, (FILE *fp, const char *format, ...));
263# else
264_GL_CXXALIAS_SYS (fprintf, int, (FILE *fp, const char *format, ...));
265# endif
266_GL_CXXALIASWARN (fprintf);
267#endif
268#if !@GNULIB_FPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
269# if !GNULIB_overrides_fprintf
270# undef fprintf
271# endif
272/* Assume fprintf is always declared. */
273_GL_WARN_ON_USE (fprintf, "fprintf is not always POSIX compliant - "
274 "use gnulib module fprintf-posix for portable "
275 "POSIX compliance");
276#endif
277
278#if @GNULIB_FPURGE@
279/* Discard all pending buffered I/O data on STREAM.
280 STREAM must not be wide-character oriented.
281 When discarding pending output, the file position is set back to where it
282 was before the write calls. When discarding pending input, the file
283 position is advanced to match the end of the previously read input.
284 Return 0 if successful. Upon error, return -1 and set errno. */
285# if @REPLACE_FPURGE@
286# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
287# define fpurge rpl_fpurge
288# endif
289_GL_FUNCDECL_RPL (fpurge, int, (FILE *gl_stream) _GL_ARG_NONNULL ((1)));
290_GL_CXXALIAS_RPL (fpurge, int, (FILE *gl_stream));
291# else
292# if !@HAVE_DECL_FPURGE@
293_GL_FUNCDECL_SYS (fpurge, int, (FILE *gl_stream) _GL_ARG_NONNULL ((1)));
294# endif
295_GL_CXXALIAS_SYS (fpurge, int, (FILE *gl_stream));
296# endif
297_GL_CXXALIASWARN (fpurge);
298#elif defined GNULIB_POSIXCHECK
299# undef fpurge
300# if HAVE_RAW_DECL_FPURGE
301_GL_WARN_ON_USE (fpurge, "fpurge is not always present - "
302 "use gnulib module fpurge for portability");
303# endif
304#endif
305
306#if @GNULIB_FPUTC@
cc2e7b46 307# if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
d5cad867
PE
308# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
309# undef fputc
310# define fputc rpl_fputc
311# endif
312_GL_FUNCDECL_RPL (fputc, int, (int c, FILE *stream) _GL_ARG_NONNULL ((2)));
313_GL_CXXALIAS_RPL (fputc, int, (int c, FILE *stream));
314# else
315_GL_CXXALIAS_SYS (fputc, int, (int c, FILE *stream));
316# endif
317_GL_CXXALIASWARN (fputc);
318#endif
319
320#if @GNULIB_FPUTS@
cc2e7b46 321# if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
d5cad867
PE
322# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
323# undef fputs
324# define fputs rpl_fputs
325# endif
326_GL_FUNCDECL_RPL (fputs, int, (const char *string, FILE *stream)
327 _GL_ARG_NONNULL ((1, 2)));
328_GL_CXXALIAS_RPL (fputs, int, (const char *string, FILE *stream));
329# else
330_GL_CXXALIAS_SYS (fputs, int, (const char *string, FILE *stream));
331# endif
332_GL_CXXALIASWARN (fputs);
333#endif
334
cc2e7b46
PE
335#if @GNULIB_FREAD@
336# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
337# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
338# undef fread
339# define fread rpl_fread
340# endif
341_GL_FUNCDECL_RPL (fread, size_t, (void *ptr, size_t s, size_t n, FILE *stream)
342 _GL_ARG_NONNULL ((4)));
343_GL_CXXALIAS_RPL (fread, size_t, (void *ptr, size_t s, size_t n, FILE *stream));
344# else
345_GL_CXXALIAS_SYS (fread, size_t, (void *ptr, size_t s, size_t n, FILE *stream));
346# endif
347_GL_CXXALIASWARN (fread);
348#endif
349
d5cad867
PE
350#if @GNULIB_FREOPEN@
351# if @REPLACE_FREOPEN@
352# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
353# undef freopen
354# define freopen rpl_freopen
355# endif
356_GL_FUNCDECL_RPL (freopen, FILE *,
357 (const char *filename, const char *mode, FILE *stream)
358 _GL_ARG_NONNULL ((2, 3)));
359_GL_CXXALIAS_RPL (freopen, FILE *,
360 (const char *filename, const char *mode, FILE *stream));
361# else
362_GL_CXXALIAS_SYS (freopen, FILE *,
363 (const char *filename, const char *mode, FILE *stream));
364# endif
365_GL_CXXALIASWARN (freopen);
366#elif defined GNULIB_POSIXCHECK
367# undef freopen
368/* Assume freopen is always declared. */
369_GL_WARN_ON_USE (freopen,
370 "freopen on Win32 platforms is not POSIX compatible - "
371 "use gnulib module freopen for portability");
372#endif
373
cc2e7b46
PE
374#if @GNULIB_FSCANF@
375# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
376# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
377# undef fscanf
378# define fscanf rpl_fscanf
379# endif
380_GL_FUNCDECL_RPL (fscanf, int, (FILE *stream, const char *format, ...)
381 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (2, 3)
382 _GL_ARG_NONNULL ((1, 2)));
383_GL_CXXALIAS_RPL (fscanf, int, (FILE *stream, const char *format, ...));
384# else
385_GL_CXXALIAS_SYS (fscanf, int, (FILE *stream, const char *format, ...));
386# endif
387_GL_CXXALIASWARN (fscanf);
388#endif
389
d5cad867
PE
390
391/* Set up the following warnings, based on which modules are in use.
392 GNU Coding Standards discourage the use of fseek, since it imposes
393 an arbitrary limitation on some 32-bit hosts. Remember that the
394 fseek module depends on the fseeko module, so we only have three
395 cases to consider:
396
397 1. The developer is not using either module. Issue a warning under
398 GNULIB_POSIXCHECK for both functions, to remind them that both
399 functions have bugs on some systems. _GL_NO_LARGE_FILES has no
400 impact on this warning.
401
402 2. The developer is using both modules. They may be unaware of the
403 arbitrary limitations of fseek, so issue a warning under
404 GNULIB_POSIXCHECK. On the other hand, they may be using both
405 modules intentionally, so the developer can define
406 _GL_NO_LARGE_FILES in the compilation units where the use of fseek
407 is safe, to silence the warning.
408
409 3. The developer is using the fseeko module, but not fseek. Gnulib
410 guarantees that fseek will still work around platform bugs in that
411 case, but we presume that the developer is aware of the pitfalls of
412 fseek and was trying to avoid it, so issue a warning even when
413 GNULIB_POSIXCHECK is undefined. Again, _GL_NO_LARGE_FILES can be
414 defined to silence the warning in particular compilation units.
415 In C++ compilations with GNULIB_NAMESPACE, in order to avoid that
416 fseek gets defined as a macro, it is recommended that the developer
417 uses the fseek module, even if he is not calling the fseek function.
418
419 Most gnulib clients that perform stream operations should fall into
420 category 3. */
421
422#if @GNULIB_FSEEK@
423# if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
424# define _GL_FSEEK_WARN /* Category 2, above. */
425# undef fseek
426# endif
427# if @REPLACE_FSEEK@
428# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
429# undef fseek
430# define fseek rpl_fseek
431# endif
432_GL_FUNCDECL_RPL (fseek, int, (FILE *fp, long offset, int whence)
433 _GL_ARG_NONNULL ((1)));
434_GL_CXXALIAS_RPL (fseek, int, (FILE *fp, long offset, int whence));
435# else
436_GL_CXXALIAS_SYS (fseek, int, (FILE *fp, long offset, int whence));
437# endif
438_GL_CXXALIASWARN (fseek);
439#endif
440
441#if @GNULIB_FSEEKO@
442# if !@GNULIB_FSEEK@ && !defined _GL_NO_LARGE_FILES
443# define _GL_FSEEK_WARN /* Category 3, above. */
444# undef fseek
445# endif
446# if @REPLACE_FSEEKO@
447/* Provide an fseeko function that is aware of a preceding fflush(), and which
448 detects pipes. */
449# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
450# undef fseeko
451# define fseeko rpl_fseeko
452# endif
453_GL_FUNCDECL_RPL (fseeko, int, (FILE *fp, off_t offset, int whence)
454 _GL_ARG_NONNULL ((1)));
455_GL_CXXALIAS_RPL (fseeko, int, (FILE *fp, off_t offset, int whence));
456# else
457# if ! @HAVE_DECL_FSEEKO@
458_GL_FUNCDECL_SYS (fseeko, int, (FILE *fp, off_t offset, int whence)
459 _GL_ARG_NONNULL ((1)));
460# endif
461_GL_CXXALIAS_SYS (fseeko, int, (FILE *fp, off_t offset, int whence));
462# endif
463_GL_CXXALIASWARN (fseeko);
464# if (@REPLACE_FSEEKO@ || !@HAVE_FSEEKO@) && !@GNULIB_FSEEK@
465 /* Provide an fseek function that is consistent with fseeko. */
466 /* In order to avoid that fseek gets defined as a macro here, the
467 developer can request the 'fseek' module. */
468# if !GNULIB_defined_fseek_function
469# undef fseek
470# define fseek rpl_fseek
471static inline int _GL_ARG_NONNULL ((1))
472rpl_fseek (FILE *fp, long offset, int whence)
473{
474# if @REPLACE_FSEEKO@
475 return rpl_fseeko (fp, offset, whence);
476# else
477 return fseeko (fp, offset, whence);
478# endif
479}
480# define GNULIB_defined_fseek_function 1
481# endif
482# endif
483#elif defined GNULIB_POSIXCHECK
484# define _GL_FSEEK_WARN /* Category 1, above. */
485# undef fseek
486# undef fseeko
487# if HAVE_RAW_DECL_FSEEKO
488_GL_WARN_ON_USE (fseeko, "fseeko is unportable - "
489 "use gnulib module fseeko for portability");
490# endif
491#endif
492
493#ifdef _GL_FSEEK_WARN
494# undef _GL_FSEEK_WARN
495/* Here, either fseek is undefined (but C89 guarantees that it is
496 declared), or it is defined as rpl_fseek (declared above). */
497_GL_WARN_ON_USE (fseek, "fseek cannot handle files larger than 4 GB "
498 "on 32-bit platforms - "
499 "use fseeko function for handling of large files");
500#endif
501
502
503/* ftell, ftello. See the comments on fseek/fseeko. */
504
505#if @GNULIB_FTELL@
506# if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
507# define _GL_FTELL_WARN /* Category 2, above. */
508# undef ftell
509# endif
510# if @REPLACE_FTELL@
511# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
512# undef ftell
513# define ftell rpl_ftell
514# endif
515_GL_FUNCDECL_RPL (ftell, long, (FILE *fp) _GL_ARG_NONNULL ((1)));
516_GL_CXXALIAS_RPL (ftell, long, (FILE *fp));
517# else
518_GL_CXXALIAS_SYS (ftell, long, (FILE *fp));
519# endif
520_GL_CXXALIASWARN (ftell);
521#endif
522
523#if @GNULIB_FTELLO@
524# if !@GNULIB_FTELL@ && !defined _GL_NO_LARGE_FILES
525# define _GL_FTELL_WARN /* Category 3, above. */
526# undef ftell
527# endif
528# if @REPLACE_FTELLO@
529# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
530# undef ftello
531# define ftello rpl_ftello
532# endif
533_GL_FUNCDECL_RPL (ftello, off_t, (FILE *fp) _GL_ARG_NONNULL ((1)));
534_GL_CXXALIAS_RPL (ftello, off_t, (FILE *fp));
535# else
536# if ! @HAVE_DECL_FTELLO@
537_GL_FUNCDECL_SYS (ftello, off_t, (FILE *fp) _GL_ARG_NONNULL ((1)));
538# endif
539_GL_CXXALIAS_SYS (ftello, off_t, (FILE *fp));
540# endif
541_GL_CXXALIASWARN (ftello);
542# if (@REPLACE_FTELLO@ || !@HAVE_FTELLO@) && !@GNULIB_FTELL@
543 /* Provide an ftell function that is consistent with ftello. */
544 /* In order to avoid that ftell gets defined as a macro here, the
545 developer can request the 'ftell' module. */
546# if !GNULIB_defined_ftell_function
547# undef ftell
548# define ftell rpl_ftell
549static inline long _GL_ARG_NONNULL ((1))
550rpl_ftell (FILE *f)
551{
552# if @REPLACE_FTELLO@
553 return rpl_ftello (f);
554# else
555 return ftello (f);
556# endif
557}
558# define GNULIB_defined_ftell_function 1
559# endif
560# endif
561#elif defined GNULIB_POSIXCHECK
562# define _GL_FTELL_WARN /* Category 1, above. */
563# undef ftell
564# undef ftello
565# if HAVE_RAW_DECL_FTELLO
566_GL_WARN_ON_USE (ftello, "ftello is unportable - "
567 "use gnulib module ftello for portability");
568# endif
569#endif
570
571#ifdef _GL_FTELL_WARN
572# undef _GL_FTELL_WARN
573/* Here, either ftell is undefined (but C89 guarantees that it is
574 declared), or it is defined as rpl_ftell (declared above). */
575_GL_WARN_ON_USE (ftell, "ftell cannot handle files larger than 4 GB "
576 "on 32-bit platforms - "
577 "use ftello function for handling of large files");
578#endif
579
580
581#if @GNULIB_FWRITE@
cc2e7b46 582# if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
d5cad867
PE
583# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
584# undef fwrite
585# define fwrite rpl_fwrite
586# endif
587_GL_FUNCDECL_RPL (fwrite, size_t,
588 (const void *ptr, size_t s, size_t n, FILE *stream)
589 _GL_ARG_NONNULL ((1, 4)));
590_GL_CXXALIAS_RPL (fwrite, size_t,
591 (const void *ptr, size_t s, size_t n, FILE *stream));
592# else
593_GL_CXXALIAS_SYS (fwrite, size_t,
594 (const void *ptr, size_t s, size_t n, FILE *stream));
595
596/* Work around glibc bug 11959
597 <http://sources.redhat.com/bugzilla/show_bug.cgi?id=11959>,
598 which sometimes causes an unwanted diagnostic for fwrite calls.
599 This affects only function declaration attributes, so it's not
600 needed for C++. */
601# if !defined __cplusplus && 0 < __USE_FORTIFY_LEVEL
602static inline size_t _GL_ARG_NONNULL ((1, 4))
603rpl_fwrite (const void *ptr, size_t s, size_t n, FILE *stream)
604{
605 size_t r = fwrite (ptr, s, n, stream);
606 (void) r;
607 return r;
608}
609# undef fwrite
610# define fwrite rpl_fwrite
611# endif
612# endif
613_GL_CXXALIASWARN (fwrite);
614#endif
615
cc2e7b46
PE
616#if @GNULIB_GETC@
617# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
618# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
619# undef getc
620# define getc rpl_fgetc
621# endif
622_GL_FUNCDECL_RPL (fgetc, int, (FILE *stream) _GL_ARG_NONNULL ((1)));
623_GL_CXXALIAS_RPL_1 (getc, rpl_fgetc, int, (FILE *stream));
624# else
625_GL_CXXALIAS_SYS (getc, int, (FILE *stream));
626# endif
627_GL_CXXALIASWARN (getc);
628#endif
629
630#if @GNULIB_GETCHAR@
631# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
632# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
633# undef getchar
634# define getchar rpl_getchar
635# endif
636_GL_FUNCDECL_RPL (getchar, int, (void));
637_GL_CXXALIAS_RPL (getchar, int, (void));
638# else
639_GL_CXXALIAS_SYS (getchar, int, (void));
640# endif
641_GL_CXXALIASWARN (getchar);
642#endif
643
d5cad867
PE
644#if @GNULIB_GETDELIM@
645/* Read input, up to (and including) the next occurrence of DELIMITER, from
646 STREAM, store it in *LINEPTR (and NUL-terminate it).
647 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
648 bytes of space. It is realloc'd as necessary.
649 Return the number of bytes read and stored at *LINEPTR (not including the
650 NUL terminator), or -1 on error or EOF. */
651# if @REPLACE_GETDELIM@
652# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
653# undef getdelim
654# define getdelim rpl_getdelim
655# endif
656_GL_FUNCDECL_RPL (getdelim, ssize_t,
657 (char **lineptr, size_t *linesize, int delimiter,
658 FILE *stream)
659 _GL_ARG_NONNULL ((1, 2, 4)));
660_GL_CXXALIAS_RPL (getdelim, ssize_t,
661 (char **lineptr, size_t *linesize, int delimiter,
662 FILE *stream));
663# else
664# if !@HAVE_DECL_GETDELIM@
665_GL_FUNCDECL_SYS (getdelim, ssize_t,
666 (char **lineptr, size_t *linesize, int delimiter,
667 FILE *stream)
668 _GL_ARG_NONNULL ((1, 2, 4)));
669# endif
670_GL_CXXALIAS_SYS (getdelim, ssize_t,
671 (char **lineptr, size_t *linesize, int delimiter,
672 FILE *stream));
673# endif
674_GL_CXXALIASWARN (getdelim);
675#elif defined GNULIB_POSIXCHECK
676# undef getdelim
677# if HAVE_RAW_DECL_GETDELIM
678_GL_WARN_ON_USE (getdelim, "getdelim is unportable - "
679 "use gnulib module getdelim for portability");
680# endif
681#endif
682
683#if @GNULIB_GETLINE@
684/* Read a line, up to (and including) the next newline, from STREAM, store it
685 in *LINEPTR (and NUL-terminate it).
686 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
687 bytes of space. It is realloc'd as necessary.
688 Return the number of bytes read and stored at *LINEPTR (not including the
689 NUL terminator), or -1 on error or EOF. */
690# if @REPLACE_GETLINE@
691# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
692# undef getline
693# define getline rpl_getline
694# endif
695_GL_FUNCDECL_RPL (getline, ssize_t,
696 (char **lineptr, size_t *linesize, FILE *stream)
697 _GL_ARG_NONNULL ((1, 2, 3)));
698_GL_CXXALIAS_RPL (getline, ssize_t,
699 (char **lineptr, size_t *linesize, FILE *stream));
700# else
701# if !@HAVE_DECL_GETLINE@
702_GL_FUNCDECL_SYS (getline, ssize_t,
703 (char **lineptr, size_t *linesize, FILE *stream)
704 _GL_ARG_NONNULL ((1, 2, 3)));
705# endif
706_GL_CXXALIAS_SYS (getline, ssize_t,
707 (char **lineptr, size_t *linesize, FILE *stream));
708# endif
709# if @HAVE_DECL_GETLINE@
710_GL_CXXALIASWARN (getline);
711# endif
712#elif defined GNULIB_POSIXCHECK
713# undef getline
714# if HAVE_RAW_DECL_GETLINE
715_GL_WARN_ON_USE (getline, "getline is unportable - "
716 "use gnulib module getline for portability");
717# endif
718#endif
719
cc2e7b46
PE
720#if @GNULIB_GETS@
721# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
722# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
723# undef gets
724# define gets rpl_gets
725# endif
726_GL_FUNCDECL_RPL (gets, char *, (char *s) _GL_ARG_NONNULL ((1)));
727_GL_CXXALIAS_RPL (gets, char *, (char *s));
728# else
729_GL_CXXALIAS_SYS (gets, char *, (char *s));
730# undef gets
731# endif
732_GL_CXXALIASWARN (gets);
733/* It is very rare that the developer ever has full control of stdin,
734 so any use of gets warrants an unconditional warning. Assume it is
735 always declared, since it is required by C89. */
736_GL_WARN_ON_USE (gets, "gets is a security hole - use fgets instead");
737#endif
738
739
d5cad867
PE
740#if @GNULIB_OBSTACK_PRINTF@ || @GNULIB_OBSTACK_PRINTF_POSIX@
741struct obstack;
742/* Grow an obstack with formatted output. Return the number of
743 bytes added to OBS. No trailing nul byte is added, and the
744 object should be closed with obstack_finish before use. Upon
745 memory allocation error, call obstack_alloc_failed_handler. Upon
746 other error, return -1. */
747# if @REPLACE_OBSTACK_PRINTF@
748# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
749# define obstack_printf rpl_obstack_printf
750# endif
751_GL_FUNCDECL_RPL (obstack_printf, int,
752 (struct obstack *obs, const char *format, ...)
753 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
754 _GL_ARG_NONNULL ((1, 2)));
755_GL_CXXALIAS_RPL (obstack_printf, int,
756 (struct obstack *obs, const char *format, ...));
757# else
758# if !@HAVE_DECL_OBSTACK_PRINTF@
759_GL_FUNCDECL_SYS (obstack_printf, int,
760 (struct obstack *obs, const char *format, ...)
761 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
762 _GL_ARG_NONNULL ((1, 2)));
763# endif
764_GL_CXXALIAS_SYS (obstack_printf, int,
765 (struct obstack *obs, const char *format, ...));
766# endif
767_GL_CXXALIASWARN (obstack_printf);
768# if @REPLACE_OBSTACK_PRINTF@
769# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
770# define obstack_vprintf rpl_obstack_vprintf
771# endif
772_GL_FUNCDECL_RPL (obstack_vprintf, int,
773 (struct obstack *obs, const char *format, va_list args)
774 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
775 _GL_ARG_NONNULL ((1, 2)));
776_GL_CXXALIAS_RPL (obstack_vprintf, int,
777 (struct obstack *obs, const char *format, va_list args));
778# else
779# if !@HAVE_DECL_OBSTACK_PRINTF@
780_GL_FUNCDECL_SYS (obstack_vprintf, int,
781 (struct obstack *obs, const char *format, va_list args)
782 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
783 _GL_ARG_NONNULL ((1, 2)));
784# endif
785_GL_CXXALIAS_SYS (obstack_vprintf, int,
786 (struct obstack *obs, const char *format, va_list args));
787# endif
788_GL_CXXALIASWARN (obstack_vprintf);
789#endif
790
791#if @GNULIB_PERROR@
792/* Print a message to standard error, describing the value of ERRNO,
793 (if STRING is not NULL and not empty) prefixed with STRING and ": ",
794 and terminated with a newline. */
795# if @REPLACE_PERROR@
796# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
797# define perror rpl_perror
798# endif
799_GL_FUNCDECL_RPL (perror, void, (const char *string));
800_GL_CXXALIAS_RPL (perror, void, (const char *string));
801# else
802_GL_CXXALIAS_SYS (perror, void, (const char *string));
803# endif
804_GL_CXXALIASWARN (perror);
805#elif defined GNULIB_POSIXCHECK
806# undef perror
807/* Assume perror is always declared. */
808_GL_WARN_ON_USE (perror, "perror is not always POSIX compliant - "
809 "use gnulib module perror for portability");
810#endif
811
812#if @GNULIB_POPEN@
813# if @REPLACE_POPEN@
814# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
815# undef popen
816# define popen rpl_popen
817# endif
818_GL_FUNCDECL_RPL (popen, FILE *, (const char *cmd, const char *mode)
819 _GL_ARG_NONNULL ((1, 2)));
820_GL_CXXALIAS_RPL (popen, FILE *, (const char *cmd, const char *mode));
821# else
822_GL_CXXALIAS_SYS (popen, FILE *, (const char *cmd, const char *mode));
823# endif
824_GL_CXXALIASWARN (popen);
825#elif defined GNULIB_POSIXCHECK
826# undef popen
827# if HAVE_RAW_DECL_POPEN
828_GL_WARN_ON_USE (popen, "popen is buggy on some platforms - "
829 "use gnulib module popen or pipe for more portability");
830# endif
831#endif
832
833#if @GNULIB_PRINTF_POSIX@ || @GNULIB_PRINTF@
834# if (@GNULIB_PRINTF_POSIX@ && @REPLACE_PRINTF@) \
cc2e7b46 835 || (@GNULIB_PRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
d5cad867
PE
836# if defined __GNUC__
837# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
838/* Don't break __attribute__((format(printf,M,N))). */
839# define printf __printf__
840# endif
63139bfa 841# if @GNULIB_PRINTF_POSIX@ || @GNULIB_VFPRINTF_POSIX@
d5cad867
PE
842_GL_FUNCDECL_RPL_1 (__printf__, int,
843 (const char *format, ...)
844 __asm__ (@ASM_SYMBOL_PREFIX@
845 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_printf))
846 _GL_ATTRIBUTE_FORMAT_PRINTF (1, 2)
847 _GL_ARG_NONNULL ((1)));
63139bfa
PE
848# else
849_GL_FUNCDECL_RPL_1 (__printf__, int,
850 (const char *format, ...)
851 __asm__ (@ASM_SYMBOL_PREFIX@
852 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_printf))
853 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (1, 2)
854 _GL_ARG_NONNULL ((1)));
855# endif
d5cad867
PE
856_GL_CXXALIAS_RPL_1 (printf, __printf__, int, (const char *format, ...));
857# else
858# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
859# define printf rpl_printf
860# endif
861_GL_FUNCDECL_RPL (printf, int,
862 (const char *format, ...)
863 _GL_ATTRIBUTE_FORMAT_PRINTF (1, 2)
864 _GL_ARG_NONNULL ((1)));
865_GL_CXXALIAS_RPL (printf, int, (const char *format, ...));
866# endif
867# define GNULIB_overrides_printf 1
868# else
869_GL_CXXALIAS_SYS (printf, int, (const char *format, ...));
870# endif
871_GL_CXXALIASWARN (printf);
872#endif
873#if !@GNULIB_PRINTF_POSIX@ && defined GNULIB_POSIXCHECK
874# if !GNULIB_overrides_printf
875# undef printf
876# endif
877/* Assume printf is always declared. */
878_GL_WARN_ON_USE (printf, "printf is not always POSIX compliant - "
879 "use gnulib module printf-posix for portable "
880 "POSIX compliance");
881#endif
882
883#if @GNULIB_PUTC@
cc2e7b46 884# if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
d5cad867
PE
885# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
886# undef putc
887# define putc rpl_fputc
888# endif
889_GL_FUNCDECL_RPL (fputc, int, (int c, FILE *stream) _GL_ARG_NONNULL ((2)));
890_GL_CXXALIAS_RPL_1 (putc, rpl_fputc, int, (int c, FILE *stream));
891# else
892_GL_CXXALIAS_SYS (putc, int, (int c, FILE *stream));
893# endif
894_GL_CXXALIASWARN (putc);
895#endif
896
897#if @GNULIB_PUTCHAR@
cc2e7b46 898# if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
d5cad867
PE
899# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
900# undef putchar
901# define putchar rpl_putchar
902# endif
903_GL_FUNCDECL_RPL (putchar, int, (int c));
904_GL_CXXALIAS_RPL (putchar, int, (int c));
905# else
906_GL_CXXALIAS_SYS (putchar, int, (int c));
907# endif
908_GL_CXXALIASWARN (putchar);
909#endif
910
911#if @GNULIB_PUTS@
cc2e7b46 912# if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
d5cad867
PE
913# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
914# undef puts
915# define puts rpl_puts
916# endif
917_GL_FUNCDECL_RPL (puts, int, (const char *string) _GL_ARG_NONNULL ((1)));
918_GL_CXXALIAS_RPL (puts, int, (const char *string));
919# else
920_GL_CXXALIAS_SYS (puts, int, (const char *string));
921# endif
922_GL_CXXALIASWARN (puts);
923#endif
924
925#if @GNULIB_REMOVE@
926# if @REPLACE_REMOVE@
927# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
928# undef remove
929# define remove rpl_remove
930# endif
931_GL_FUNCDECL_RPL (remove, int, (const char *name) _GL_ARG_NONNULL ((1)));
932_GL_CXXALIAS_RPL (remove, int, (const char *name));
933# else
934_GL_CXXALIAS_SYS (remove, int, (const char *name));
935# endif
936_GL_CXXALIASWARN (remove);
937#elif defined GNULIB_POSIXCHECK
938# undef remove
939/* Assume remove is always declared. */
940_GL_WARN_ON_USE (remove, "remove cannot handle directories on some platforms - "
941 "use gnulib module remove for more portability");
942#endif
943
944#if @GNULIB_RENAME@
945# if @REPLACE_RENAME@
946# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
947# undef rename
948# define rename rpl_rename
949# endif
950_GL_FUNCDECL_RPL (rename, int,
951 (const char *old_filename, const char *new_filename)
952 _GL_ARG_NONNULL ((1, 2)));
953_GL_CXXALIAS_RPL (rename, int,
954 (const char *old_filename, const char *new_filename));
955# else
956_GL_CXXALIAS_SYS (rename, int,
957 (const char *old_filename, const char *new_filename));
958# endif
959_GL_CXXALIASWARN (rename);
960#elif defined GNULIB_POSIXCHECK
961# undef rename
962/* Assume rename is always declared. */
963_GL_WARN_ON_USE (rename, "rename is buggy on some platforms - "
964 "use gnulib module rename for more portability");
965#endif
966
967#if @GNULIB_RENAMEAT@
968# if @REPLACE_RENAMEAT@
969# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
970# undef renameat
971# define renameat rpl_renameat
972# endif
973_GL_FUNCDECL_RPL (renameat, int,
974 (int fd1, char const *file1, int fd2, char const *file2)
975 _GL_ARG_NONNULL ((2, 4)));
976_GL_CXXALIAS_RPL (renameat, int,
977 (int fd1, char const *file1, int fd2, char const *file2));
978# else
979# if !@HAVE_RENAMEAT@
980_GL_FUNCDECL_SYS (renameat, int,
981 (int fd1, char const *file1, int fd2, char const *file2)
982 _GL_ARG_NONNULL ((2, 4)));
983# endif
984_GL_CXXALIAS_SYS (renameat, int,
985 (int fd1, char const *file1, int fd2, char const *file2));
986# endif
987_GL_CXXALIASWARN (renameat);
988#elif defined GNULIB_POSIXCHECK
989# undef renameat
990# if HAVE_RAW_DECL_RENAMEAT
991_GL_WARN_ON_USE (renameat, "renameat is not portable - "
992 "use gnulib module renameat for portability");
993# endif
994#endif
995
cc2e7b46
PE
996#if @GNULIB_SCANF@
997# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
998# if defined __GNUC__
999# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1000# undef scanf
1001/* Don't break __attribute__((format(scanf,M,N))). */
1002# define scanf __scanf__
1003# endif
1004_GL_FUNCDECL_RPL_1 (__scanf__, int,
1005 (const char *format, ...)
1006 __asm__ (@ASM_SYMBOL_PREFIX@
1007 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_scanf))
1008 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (1, 2)
1009 _GL_ARG_NONNULL ((1)));
1010_GL_CXXALIAS_RPL_1 (scanf, __scanf__, int, (const char *format, ...));
1011# else
1012# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1013# undef scanf
1014# define scanf rpl_scanf
1015# endif
1016_GL_FUNCDECL_RPL (scanf, int, (const char *format, ...)
1017 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (1, 2)
1018 _GL_ARG_NONNULL ((1)));
1019_GL_CXXALIAS_RPL (scanf, int, (const char *format, ...));
1020# endif
1021# else
1022_GL_CXXALIAS_SYS (scanf, int, (const char *format, ...));
1023# endif
1024_GL_CXXALIASWARN (scanf);
1025#endif
1026
d5cad867
PE
1027#if @GNULIB_SNPRINTF@
1028# if @REPLACE_SNPRINTF@
1029# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1030# define snprintf rpl_snprintf
1031# endif
1032_GL_FUNCDECL_RPL (snprintf, int,
1033 (char *str, size_t size, const char *format, ...)
1034 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 4)
1035 _GL_ARG_NONNULL ((3)));
1036_GL_CXXALIAS_RPL (snprintf, int,
1037 (char *str, size_t size, const char *format, ...));
1038# else
1039# if !@HAVE_DECL_SNPRINTF@
1040_GL_FUNCDECL_SYS (snprintf, int,
1041 (char *str, size_t size, const char *format, ...)
1042 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 4)
1043 _GL_ARG_NONNULL ((3)));
1044# endif
1045_GL_CXXALIAS_SYS (snprintf, int,
1046 (char *str, size_t size, const char *format, ...));
1047# endif
1048_GL_CXXALIASWARN (snprintf);
1049#elif defined GNULIB_POSIXCHECK
1050# undef snprintf
1051# if HAVE_RAW_DECL_SNPRINTF
1052_GL_WARN_ON_USE (snprintf, "snprintf is unportable - "
1053 "use gnulib module snprintf for portability");
1054# endif
1055#endif
1056
1057/* Some people would argue that sprintf should be handled like gets
1058 (for example, OpenBSD issues a link warning for both functions),
1059 since both can cause security holes due to buffer overruns.
1060 However, we believe that sprintf can be used safely, and is more
1061 efficient than snprintf in those safe cases; and as proof of our
1062 belief, we use sprintf in several gnulib modules. So this header
1063 intentionally avoids adding a warning to sprintf except when
1064 GNULIB_POSIXCHECK is defined. */
1065
1066#if @GNULIB_SPRINTF_POSIX@
1067# if @REPLACE_SPRINTF@
1068# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1069# define sprintf rpl_sprintf
1070# endif
1071_GL_FUNCDECL_RPL (sprintf, int, (char *str, const char *format, ...)
1072 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
1073 _GL_ARG_NONNULL ((1, 2)));
1074_GL_CXXALIAS_RPL (sprintf, int, (char *str, const char *format, ...));
1075# else
1076_GL_CXXALIAS_SYS (sprintf, int, (char *str, const char *format, ...));
1077# endif
1078_GL_CXXALIASWARN (sprintf);
1079#elif defined GNULIB_POSIXCHECK
1080# undef sprintf
1081/* Assume sprintf is always declared. */
1082_GL_WARN_ON_USE (sprintf, "sprintf is not always POSIX compliant - "
1083 "use gnulib module sprintf-posix for portable "
1084 "POSIX compliance");
1085#endif
1086
1087#if @GNULIB_TMPFILE@
1088# if @REPLACE_TMPFILE@
1089# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1090# define tmpfile rpl_tmpfile
1091# endif
1092_GL_FUNCDECL_RPL (tmpfile, FILE *, (void));
1093_GL_CXXALIAS_RPL (tmpfile, FILE *, (void));
1094# else
1095_GL_CXXALIAS_SYS (tmpfile, FILE *, (void));
1096# endif
1097_GL_CXXALIASWARN (tmpfile);
1098#elif defined GNULIB_POSIXCHECK
1099# undef tmpfile
1100# if HAVE_RAW_DECL_TMPFILE
1101_GL_WARN_ON_USE (tmpfile, "tmpfile is not usable on mingw - "
1102 "use gnulib module tmpfile for portability");
1103# endif
1104#endif
1105
1106#if @GNULIB_VASPRINTF@
1107/* Write formatted output to a string dynamically allocated with malloc().
1108 If the memory allocation succeeds, store the address of the string in
1109 *RESULT and return the number of resulting bytes, excluding the trailing
1110 NUL. Upon memory allocation error, or some other error, return -1. */
1111# if @REPLACE_VASPRINTF@
1112# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1113# define asprintf rpl_asprintf
1114# endif
1115_GL_FUNCDECL_RPL (asprintf, int,
1116 (char **result, const char *format, ...)
1117 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
1118 _GL_ARG_NONNULL ((1, 2)));
1119_GL_CXXALIAS_RPL (asprintf, int,
1120 (char **result, const char *format, ...));
1121# else
1122# if !@HAVE_VASPRINTF@
1123_GL_FUNCDECL_SYS (asprintf, int,
1124 (char **result, const char *format, ...)
1125 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
1126 _GL_ARG_NONNULL ((1, 2)));
1127# endif
1128_GL_CXXALIAS_SYS (asprintf, int,
1129 (char **result, const char *format, ...));
1130# endif
1131_GL_CXXALIASWARN (asprintf);
1132# if @REPLACE_VASPRINTF@
1133# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1134# define vasprintf rpl_vasprintf
1135# endif
1136_GL_FUNCDECL_RPL (vasprintf, int,
1137 (char **result, const char *format, va_list args)
1138 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
1139 _GL_ARG_NONNULL ((1, 2)));
1140_GL_CXXALIAS_RPL (vasprintf, int,
1141 (char **result, const char *format, va_list args));
1142# else
1143# if !@HAVE_VASPRINTF@
1144_GL_FUNCDECL_SYS (vasprintf, int,
1145 (char **result, const char *format, va_list args)
1146 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
1147 _GL_ARG_NONNULL ((1, 2)));
1148# endif
1149_GL_CXXALIAS_SYS (vasprintf, int,
1150 (char **result, const char *format, va_list args));
1151# endif
1152_GL_CXXALIASWARN (vasprintf);
1153#endif
1154
1155#if @GNULIB_VDPRINTF@
1156# if @REPLACE_VDPRINTF@
1157# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1158# define vdprintf rpl_vdprintf
1159# endif
1160_GL_FUNCDECL_RPL (vdprintf, int, (int fd, const char *format, va_list args)
1161 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
1162 _GL_ARG_NONNULL ((2)));
1163_GL_CXXALIAS_RPL (vdprintf, int, (int fd, const char *format, va_list args));
1164# else
1165# if !@HAVE_VDPRINTF@
1166_GL_FUNCDECL_SYS (vdprintf, int, (int fd, const char *format, va_list args)
1167 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
1168 _GL_ARG_NONNULL ((2)));
1169# endif
1170/* Need to cast, because on Solaris, the third parameter will likely be
1171 __va_list args. */
1172_GL_CXXALIAS_SYS_CAST (vdprintf, int,
1173 (int fd, const char *format, va_list args));
1174# endif
1175_GL_CXXALIASWARN (vdprintf);
1176#elif defined GNULIB_POSIXCHECK
1177# undef vdprintf
1178# if HAVE_RAW_DECL_VDPRINTF
1179_GL_WARN_ON_USE (vdprintf, "vdprintf is unportable - "
1180 "use gnulib module vdprintf for portability");
1181# endif
1182#endif
1183
1184#if @GNULIB_VFPRINTF_POSIX@ || @GNULIB_VFPRINTF@
1185# if (@GNULIB_VFPRINTF_POSIX@ && @REPLACE_VFPRINTF@) \
cc2e7b46 1186 || (@GNULIB_VFPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
d5cad867
PE
1187# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1188# define vfprintf rpl_vfprintf
1189# endif
1190# define GNULIB_overrides_vfprintf 1
63139bfa 1191# if @GNULIB_VFPRINTF_POSIX@
d5cad867
PE
1192_GL_FUNCDECL_RPL (vfprintf, int, (FILE *fp, const char *format, va_list args)
1193 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
1194 _GL_ARG_NONNULL ((1, 2)));
63139bfa
PE
1195# else
1196_GL_FUNCDECL_RPL (vfprintf, int, (FILE *fp, const char *format, va_list args)
1197 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (2, 0)
1198 _GL_ARG_NONNULL ((1, 2)));
1199# endif
d5cad867
PE
1200_GL_CXXALIAS_RPL (vfprintf, int, (FILE *fp, const char *format, va_list args));
1201# else
1202/* Need to cast, because on Solaris, the third parameter is
1203 __va_list args
1204 and GCC's fixincludes did not change this to __gnuc_va_list. */
1205_GL_CXXALIAS_SYS_CAST (vfprintf, int,
1206 (FILE *fp, const char *format, va_list args));
1207# endif
1208_GL_CXXALIASWARN (vfprintf);
1209#endif
1210#if !@GNULIB_VFPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1211# if !GNULIB_overrides_vfprintf
1212# undef vfprintf
1213# endif
1214/* Assume vfprintf is always declared. */
1215_GL_WARN_ON_USE (vfprintf, "vfprintf is not always POSIX compliant - "
1216 "use gnulib module vfprintf-posix for portable "
1217 "POSIX compliance");
1218#endif
1219
cc2e7b46
PE
1220#if @GNULIB_VFSCANF@
1221# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
1222# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1223# undef vfscanf
1224# define vfscanf rpl_vfscanf
1225# endif
1226_GL_FUNCDECL_RPL (vfscanf, int,
1227 (FILE *stream, const char *format, va_list args)
1228 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (2, 0)
1229 _GL_ARG_NONNULL ((1, 2)));
1230_GL_CXXALIAS_RPL (vfscanf, int,
1231 (FILE *stream, const char *format, va_list args));
1232# else
1233_GL_CXXALIAS_SYS (vfscanf, int,
1234 (FILE *stream, const char *format, va_list args));
1235# endif
1236_GL_CXXALIASWARN (vfscanf);
1237#endif
1238
d5cad867
PE
1239#if @GNULIB_VPRINTF_POSIX@ || @GNULIB_VPRINTF@
1240# if (@GNULIB_VPRINTF_POSIX@ && @REPLACE_VPRINTF@) \
cc2e7b46 1241 || (@GNULIB_VPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
d5cad867
PE
1242# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1243# define vprintf rpl_vprintf
1244# endif
1245# define GNULIB_overrides_vprintf 1
63139bfa 1246# if @GNULIB_VPRINTF_POSIX@ || @GNULIB_VFPRINTF_POSIX@
d5cad867
PE
1247_GL_FUNCDECL_RPL (vprintf, int, (const char *format, va_list args)
1248 _GL_ATTRIBUTE_FORMAT_PRINTF (1, 0)
1249 _GL_ARG_NONNULL ((1)));
63139bfa
PE
1250# else
1251_GL_FUNCDECL_RPL (vprintf, int, (const char *format, va_list args)
1252 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (1, 0)
1253 _GL_ARG_NONNULL ((1)));
1254# endif
d5cad867
PE
1255_GL_CXXALIAS_RPL (vprintf, int, (const char *format, va_list args));
1256# else
1257/* Need to cast, because on Solaris, the second parameter is
1258 __va_list args
1259 and GCC's fixincludes did not change this to __gnuc_va_list. */
1260_GL_CXXALIAS_SYS_CAST (vprintf, int, (const char *format, va_list args));
1261# endif
1262_GL_CXXALIASWARN (vprintf);
1263#endif
1264#if !@GNULIB_VPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1265# if !GNULIB_overrides_vprintf
1266# undef vprintf
1267# endif
1268/* Assume vprintf is always declared. */
1269_GL_WARN_ON_USE (vprintf, "vprintf is not always POSIX compliant - "
1270 "use gnulib module vprintf-posix for portable "
1271 "POSIX compliance");
1272#endif
1273
cc2e7b46
PE
1274#if @GNULIB_VSCANF@
1275# if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
1276# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1277# undef vscanf
1278# define vscanf rpl_vscanf
1279# endif
1280_GL_FUNCDECL_RPL (vscanf, int, (const char *format, va_list args)
1281 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (1, 0)
1282 _GL_ARG_NONNULL ((1)));
1283_GL_CXXALIAS_RPL (vscanf, int, (const char *format, va_list args));
1284# else
1285_GL_CXXALIAS_SYS (vscanf, int, (const char *format, va_list args));
1286# endif
1287_GL_CXXALIASWARN (vscanf);
1288#endif
1289
d5cad867
PE
1290#if @GNULIB_VSNPRINTF@
1291# if @REPLACE_VSNPRINTF@
1292# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1293# define vsnprintf rpl_vsnprintf
1294# endif
1295_GL_FUNCDECL_RPL (vsnprintf, int,
1296 (char *str, size_t size, const char *format, va_list args)
1297 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 0)
1298 _GL_ARG_NONNULL ((3)));
1299_GL_CXXALIAS_RPL (vsnprintf, int,
1300 (char *str, size_t size, const char *format, va_list args));
1301# else
1302# if !@HAVE_DECL_VSNPRINTF@
1303_GL_FUNCDECL_SYS (vsnprintf, int,
1304 (char *str, size_t size, const char *format, va_list args)
1305 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 0)
1306 _GL_ARG_NONNULL ((3)));
1307# endif
1308_GL_CXXALIAS_SYS (vsnprintf, int,
1309 (char *str, size_t size, const char *format, va_list args));
1310# endif
1311_GL_CXXALIASWARN (vsnprintf);
1312#elif defined GNULIB_POSIXCHECK
1313# undef vsnprintf
1314# if HAVE_RAW_DECL_VSNPRINTF
1315_GL_WARN_ON_USE (vsnprintf, "vsnprintf is unportable - "
1316 "use gnulib module vsnprintf for portability");
1317# endif
1318#endif
1319
1320#if @GNULIB_VSPRINTF_POSIX@
1321# if @REPLACE_VSPRINTF@
1322# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1323# define vsprintf rpl_vsprintf
1324# endif
1325_GL_FUNCDECL_RPL (vsprintf, int,
1326 (char *str, const char *format, va_list args)
1327 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
1328 _GL_ARG_NONNULL ((1, 2)));
1329_GL_CXXALIAS_RPL (vsprintf, int,
1330 (char *str, const char *format, va_list args));
1331# else
1332/* Need to cast, because on Solaris, the third parameter is
1333 __va_list args
1334 and GCC's fixincludes did not change this to __gnuc_va_list. */
1335_GL_CXXALIAS_SYS_CAST (vsprintf, int,
1336 (char *str, const char *format, va_list args));
1337# endif
1338_GL_CXXALIASWARN (vsprintf);
1339#elif defined GNULIB_POSIXCHECK
1340# undef vsprintf
1341/* Assume vsprintf is always declared. */
1342_GL_WARN_ON_USE (vsprintf, "vsprintf is not always POSIX compliant - "
1343 "use gnulib module vsprintf-posix for portable "
1344 "POSIX compliance");
1345#endif
1346
1347
6a3e57bb
PE
1348#endif /* _@GUARD_PREFIX@_STDIO_H */
1349#endif /* _@GUARD_PREFIX@_STDIO_H */
d5cad867 1350#endif