1 /* A GNU-like <stdio.h>.
3 Copyright (C) 2004, 2007-2010 Free Software Foundation, Inc.
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 2, or (at your option)
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.
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. */
20 @PRAGMA_SYSTEM_HEADER@
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. */
33 #@INCLUDE_NEXT@ @NEXT_STDIO_H@
36 /* Normal invocation convention. */
40 #define _GL_ALREADY_INCLUDING_STDIO_H
42 /* The include_next requires a split double-inclusion guard. */
43 #@INCLUDE_NEXT@ @NEXT_STDIO_H@
45 #undef _GL_ALREADY_INCLUDING_STDIO_H
50 /* Get va_list. Needed on many systems, including glibc 2.8. */
55 /* Get off_t and ssize_t. Needed on many systems, including glibc 2.8. */
56 #include <sys/types.h>
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 __attribute__ 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 __attribute__(Spec) /* empty */
70 /* Solaris 10 declares renameat in <unistd.h>, not in <stdio.h>. */
71 /* But in any case avoid namespace pollution on glibc systems. */
72 #if (@GNULIB_RENAMEAT@ || defined GNULIB_POSIXCHECK) && defined __sun \
73 && ! defined __GLIBC__
78 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
80 /* The definition of _GL_ARG_NONNULL is copied here. */
82 /* The definition of _GL_WARN_ON_USE is copied here. */
84 /* Macros for stringification. */
85 #define _GL_STDIO_STRINGIZE(token) #token
86 #define _GL_STDIO_MACROEXPAND_AND_STRINGIZE(token) _GL_STDIO_STRINGIZE(token)
90 # if @REPLACE_DPRINTF@
91 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
92 # define dprintf rpl_dprintf
94 _GL_FUNCDECL_RPL (dprintf, int, (int fd, const char *format, ...)
95 __attribute__ ((__format__ (__printf__, 2, 3)))
96 _GL_ARG_NONNULL ((2)));
97 _GL_CXXALIAS_RPL (dprintf, int, (int fd, const char *format, ...));
100 _GL_FUNCDECL_SYS (dprintf, int, (int fd, const char *format, ...)
101 __attribute__ ((__format__ (__printf__, 2, 3)))
102 _GL_ARG_NONNULL ((2)));
104 _GL_CXXALIAS_SYS (dprintf, int, (int fd, const char *format, ...));
106 _GL_CXXALIASWARN (dprintf);
107 #elif defined GNULIB_POSIXCHECK
109 # if HAVE_RAW_DECL_DPRINTF
110 _GL_WARN_ON_USE (dprintf, "dprintf is unportable - "
111 "use gnulib module dprintf for portability");
116 /* Close STREAM and its underlying file descriptor. */
117 # if @REPLACE_FCLOSE@
118 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
119 # define fclose rpl_fclose
121 _GL_FUNCDECL_RPL (fclose, int, (FILE *stream) _GL_ARG_NONNULL ((1)));
122 _GL_CXXALIAS_RPL (fclose, int, (FILE *stream));
124 _GL_CXXALIAS_SYS (fclose, int, (FILE *stream));
126 _GL_CXXALIASWARN (fclose);
127 #elif defined GNULIB_POSIXCHECK
129 /* Assume fclose is always declared. */
130 _GL_WARN_ON_USE (fclose, "fclose is not always POSIX compliant - "
131 "use gnulib module fclose for portable POSIX compliance");
135 /* Flush all pending data on STREAM according to POSIX rules. Both
136 output and seekable input streams are supported.
137 Note! LOSS OF DATA can occur if fflush is applied on an input stream
138 that is _not_seekable_ or on an update stream that is _not_seekable_
139 and in which the most recent operation was input. Seekability can
140 be tested with lseek(fileno(fp),0,SEEK_CUR). */
141 # if @REPLACE_FFLUSH@
142 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
143 # define fflush rpl_fflush
145 _GL_FUNCDECL_RPL (fflush, int, (FILE *gl_stream));
146 _GL_CXXALIAS_RPL (fflush, int, (FILE *gl_stream));
148 _GL_CXXALIAS_SYS (fflush, int, (FILE *gl_stream));
150 _GL_CXXALIASWARN (fflush);
151 #elif defined GNULIB_POSIXCHECK
153 /* Assume fflush is always declared. */
154 _GL_WARN_ON_USE (fflush, "fflush is not always POSIX compliant - "
155 "use gnulib module fflush for portable POSIX compliance");
158 /* It is very rare that the developer ever has full control of stdin,
159 so any use of gets warrants an unconditional warning. Assume it is
160 always declared, since it is required by C89. */
162 _GL_WARN_ON_USE (gets, "gets is a security hole - use fgets instead");
166 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
168 # define fopen rpl_fopen
170 _GL_FUNCDECL_RPL (fopen, FILE *, (const char *filename, const char *mode)
171 _GL_ARG_NONNULL ((1, 2)));
172 _GL_CXXALIAS_RPL (fopen, FILE *, (const char *filename, const char *mode));
174 _GL_CXXALIAS_SYS (fopen, FILE *, (const char *filename, const char *mode));
176 _GL_CXXALIASWARN (fopen);
177 #elif defined GNULIB_POSIXCHECK
179 /* Assume fopen is always declared. */
180 _GL_WARN_ON_USE (fopen, "fopen on Win32 platforms is not POSIX compatible - "
181 "use gnulib module fopen for portability");
184 #if @GNULIB_FPRINTF_POSIX@ || @GNULIB_FPRINTF@
185 # if (@GNULIB_FPRINTF_POSIX@ && @REPLACE_FPRINTF@) \
186 || (@GNULIB_FPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
187 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
188 # define fprintf rpl_fprintf
190 # define GNULIB_overrides_fprintf 1
191 _GL_FUNCDECL_RPL (fprintf, int, (FILE *fp, const char *format, ...)
192 __attribute__ ((__format__ (__printf__, 2, 3)))
193 _GL_ARG_NONNULL ((1, 2)));
194 _GL_CXXALIAS_RPL (fprintf, int, (FILE *fp, const char *format, ...));
196 _GL_CXXALIAS_SYS (fprintf, int, (FILE *fp, const char *format, ...));
198 _GL_CXXALIASWARN (fprintf);
200 #if !@GNULIB_FPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
201 # if !GNULIB_overrides_fprintf
204 /* Assume fprintf is always declared. */
205 _GL_WARN_ON_USE (fprintf, "fprintf is not always POSIX compliant - "
206 "use gnulib module fprintf-posix for portable "
211 /* Discard all pending buffered I/O data on STREAM.
212 STREAM must not be wide-character oriented.
213 When discarding pending output, the file position is set back to where it
214 was before the write calls. When discarding pending input, the file
215 position is advanced to match the end of the previously read input.
216 Return 0 if successful. Upon error, return -1 and set errno. */
217 # if @REPLACE_FPURGE@
218 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
219 # define fpurge rpl_fpurge
221 _GL_FUNCDECL_RPL (fpurge, int, (FILE *gl_stream) _GL_ARG_NONNULL ((1)));
222 _GL_CXXALIAS_RPL (fpurge, int, (FILE *gl_stream));
224 # if !@HAVE_DECL_FPURGE@
225 _GL_FUNCDECL_SYS (fpurge, int, (FILE *gl_stream) _GL_ARG_NONNULL ((1)));
227 _GL_CXXALIAS_SYS (fpurge, int, (FILE *gl_stream));
229 _GL_CXXALIASWARN (fpurge);
230 #elif defined GNULIB_POSIXCHECK
232 # if HAVE_RAW_DECL_FPURGE
233 _GL_WARN_ON_USE (fpurge, "fpurge is not always present - "
234 "use gnulib module fpurge for portability");
239 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
240 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
242 # define fputc rpl_fputc
244 _GL_FUNCDECL_RPL (fputc, int, (int c, FILE *stream) _GL_ARG_NONNULL ((2)));
245 _GL_CXXALIAS_RPL (fputc, int, (int c, FILE *stream));
247 _GL_CXXALIAS_SYS (fputc, int, (int c, FILE *stream));
249 _GL_CXXALIASWARN (fputc);
253 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
254 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
256 # define fputs rpl_fputs
258 _GL_FUNCDECL_RPL (fputs, int, (const char *string, FILE *stream)
259 _GL_ARG_NONNULL ((1, 2)));
260 _GL_CXXALIAS_RPL (fputs, int, (const char *string, FILE *stream));
262 _GL_CXXALIAS_SYS (fputs, int, (const char *string, FILE *stream));
264 _GL_CXXALIASWARN (fputs);
268 # if @REPLACE_FREOPEN@
269 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
271 # define freopen rpl_freopen
273 _GL_FUNCDECL_RPL (freopen, FILE *,
274 (const char *filename, const char *mode, FILE *stream)
275 _GL_ARG_NONNULL ((2, 3)));
276 _GL_CXXALIAS_RPL (freopen, FILE *,
277 (const char *filename, const char *mode, FILE *stream));
279 _GL_CXXALIAS_SYS (freopen, FILE *,
280 (const char *filename, const char *mode, FILE *stream));
282 _GL_CXXALIASWARN (freopen);
283 #elif defined GNULIB_POSIXCHECK
285 /* Assume freopen is always declared. */
286 _GL_WARN_ON_USE (freopen,
287 "freopen on Win32 platforms is not POSIX compatible - "
288 "use gnulib module freopen for portability");
292 /* Set up the following warnings, based on which modules are in use.
293 GNU Coding Standards discourage the use of fseek, since it imposes
294 an arbitrary limitation on some 32-bit hosts. Remember that the
295 fseek module depends on the fseeko module, so we only have three
298 1. The developer is not using either module. Issue a warning under
299 GNULIB_POSIXCHECK for both functions, to remind them that both
300 functions have bugs on some systems. _GL_NO_LARGE_FILES has no
301 impact on this warning.
303 2. The developer is using both modules. They may be unaware of the
304 arbitrary limitations of fseek, so issue a warning under
305 GNULIB_POSIXCHECK. On the other hand, they may be using both
306 modules intentionally, so the developer can define
307 _GL_NO_LARGE_FILES in the compilation units where the use of fseek
308 is safe, to silence the warning.
310 3. The developer is using the fseeko module, but not fseek. Gnulib
311 guarantees that fseek will still work around platform bugs in that
312 case, but we presume that the developer is aware of the pitfalls of
313 fseek and was trying to avoid it, so issue a warning even when
314 GNULIB_POSIXCHECK is undefined. Again, _GL_NO_LARGE_FILES can be
315 defined to silence the warning in particular compilation units.
316 In C++ compilations with GNULIB_NAMESPACE, in order to avoid that
317 fseek gets defined as a macro, it is recommended that the developer
318 uses the fseek module, even if he is not calling the fseek function.
320 Most gnulib clients that perform stream operations should fall into
324 # if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
325 # define _GL_FSEEK_WARN /* Category 2, above. */
329 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
331 # define fseek rpl_fseek
333 _GL_FUNCDECL_RPL (fseek, int, (FILE *fp, long offset, int whence)
334 _GL_ARG_NONNULL ((1)));
335 _GL_CXXALIAS_RPL (fseek, int, (FILE *fp, long offset, int whence));
337 _GL_CXXALIAS_SYS (fseek, int, (FILE *fp, long offset, int whence));
339 _GL_CXXALIASWARN (fseek);
343 # if !@GNULIB_FSEEK@ && !defined _GL_NO_LARGE_FILES
344 # define _GL_FSEEK_WARN /* Category 3, above. */
347 # if @REPLACE_FSEEKO@
348 /* Provide an fseeko function that is aware of a preceding fflush(), and which
350 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
352 # define fseeko rpl_fseeko
354 _GL_FUNCDECL_RPL (fseeko, int, (FILE *fp, off_t offset, int whence)
355 _GL_ARG_NONNULL ((1)));
356 _GL_CXXALIAS_RPL (fseeko, int, (FILE *fp, off_t offset, int whence));
358 # if ! @HAVE_DECL_FSEEKO@
359 _GL_FUNCDECL_SYS (fseeko, int, (FILE *fp, off_t offset, int whence)
360 _GL_ARG_NONNULL ((1)));
362 _GL_CXXALIAS_SYS (fseeko, int, (FILE *fp, off_t offset, int whence));
364 _GL_CXXALIASWARN (fseeko);
365 # if (@REPLACE_FSEEKO@ || !@HAVE_FSEEKO@) && !@GNULIB_FSEEK@
366 /* Provide an fseek function that is consistent with fseeko. */
367 /* In order to avoid that fseek gets defined as a macro here, the
368 developer can request the 'fseek' module. */
370 # define fseek rpl_fseek
371 static inline int _GL_ARG_NONNULL ((1))
372 rpl_fseek (FILE *fp, long offset, int whence)
374 # if @REPLACE_FSEEKO@
375 return rpl_fseeko (fp, offset, whence);
377 return fseeko (fp, offset, whence);
381 #elif defined GNULIB_POSIXCHECK
382 # define _GL_FSEEK_WARN /* Category 1, above. */
385 # if HAVE_RAW_DECL_FSEEKO
386 _GL_WARN_ON_USE (fseeko, "fseeko is unportable - "
387 "use gnulib module fseeko for portability");
391 #ifdef _GL_FSEEK_WARN
392 # undef _GL_FSEEK_WARN
393 /* Here, either fseek is undefined (but C89 guarantees that it is
394 declared), or it is defined as rpl_fseek (declared above). */
395 _GL_WARN_ON_USE (fseek, "fseek cannot handle files larger than 4 GB "
396 "on 32-bit platforms - "
397 "use fseeko function for handling of large files");
401 /* ftell, ftello. See the comments on fseek/fseeko. */
404 # if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
405 # define _GL_FTELL_WARN /* Category 2, above. */
409 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
411 # define ftell rpl_ftell
413 _GL_FUNCDECL_RPL (ftell, long, (FILE *fp) _GL_ARG_NONNULL ((1)));
414 _GL_CXXALIAS_RPL (ftell, long, (FILE *fp));
416 _GL_CXXALIAS_SYS (ftell, long, (FILE *fp));
418 _GL_CXXALIASWARN (ftell);
422 # if !@GNULIB_FTELL@ && !defined _GL_NO_LARGE_FILES
423 # define _GL_FTELL_WARN /* Category 3, above. */
426 # if @REPLACE_FTELLO@
427 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
429 # define ftello rpl_ftello
431 _GL_FUNCDECL_RPL (ftello, off_t, (FILE *fp) _GL_ARG_NONNULL ((1)));
432 _GL_CXXALIAS_RPL (ftello, off_t, (FILE *fp));
434 # if ! @HAVE_DECL_FTELLO@
435 _GL_FUNCDECL_SYS (ftello, off_t, (FILE *fp) _GL_ARG_NONNULL ((1)));
437 _GL_CXXALIAS_SYS (ftello, off_t, (FILE *fp));
439 _GL_CXXALIASWARN (ftello);
440 # if (@REPLACE_FTELLO@ || !@HAVE_FTELLO@) && !@GNULIB_FTELL@
441 /* Provide an ftell function that is consistent with ftello. */
442 /* In order to avoid that ftell gets defined as a macro here, the
443 developer can request the 'ftell' module. */
445 # define ftell rpl_ftell
446 static inline long _GL_ARG_NONNULL ((1))
449 # if @REPLACE_FTELLO@
450 return rpl_ftello (f);
456 #elif defined GNULIB_POSIXCHECK
457 # define _GL_FTELL_WARN /* Category 1, above. */
460 # if HAVE_RAW_DECL_FTELLO
461 _GL_WARN_ON_USE (ftello, "ftello is unportable - "
462 "use gnulib module ftello for portability");
466 #ifdef _GL_FTELL_WARN
467 # undef _GL_FTELL_WARN
468 /* Here, either ftell is undefined (but C89 guarantees that it is
469 declared), or it is defined as rpl_ftell (declared above). */
470 _GL_WARN_ON_USE (ftell, "ftell cannot handle files larger than 4 GB "
471 "on 32-bit platforms - "
472 "use ftello function for handling of large files");
477 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
478 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
480 # define fwrite rpl_fwrite
482 _GL_FUNCDECL_RPL (fwrite, size_t,
483 (const void *ptr, size_t s, size_t n, FILE *stream)
484 _GL_ARG_NONNULL ((1, 4)));
485 _GL_CXXALIAS_RPL (fwrite, size_t,
486 (const void *ptr, size_t s, size_t n, FILE *stream));
488 _GL_CXXALIAS_SYS (fwrite, size_t,
489 (const void *ptr, size_t s, size_t n, FILE *stream));
491 _GL_CXXALIASWARN (fwrite);
494 #if @GNULIB_GETDELIM@
495 /* Read input, up to (and including) the next occurrence of DELIMITER, from
496 STREAM, store it in *LINEPTR (and NUL-terminate it).
497 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
498 bytes of space. It is realloc'd as necessary.
499 Return the number of bytes read and stored at *LINEPTR (not including the
500 NUL terminator), or -1 on error or EOF. */
501 # if @REPLACE_GETDELIM@
502 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
504 # define getdelim rpl_getdelim
506 _GL_FUNCDECL_RPL (getdelim, ssize_t,
507 (char **lineptr, size_t *linesize, int delimiter,
509 _GL_ARG_NONNULL ((1, 2, 4)));
510 _GL_CXXALIAS_RPL (getdelim, ssize_t,
511 (char **lineptr, size_t *linesize, int delimiter,
514 # if !@HAVE_DECL_GETDELIM@
515 _GL_FUNCDECL_SYS (getdelim, ssize_t,
516 (char **lineptr, size_t *linesize, int delimiter,
518 _GL_ARG_NONNULL ((1, 2, 4)));
520 _GL_CXXALIAS_SYS (getdelim, ssize_t,
521 (char **lineptr, size_t *linesize, int delimiter,
524 _GL_CXXALIASWARN (getdelim);
525 #elif defined GNULIB_POSIXCHECK
527 # if HAVE_RAW_DECL_GETDELIM
528 _GL_WARN_ON_USE (getdelim, "getdelim is unportable - "
529 "use gnulib module getdelim for portability");
534 /* Read a line, up to (and including) the next newline, from STREAM, store it
535 in *LINEPTR (and NUL-terminate it).
536 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
537 bytes of space. It is realloc'd as necessary.
538 Return the number of bytes read and stored at *LINEPTR (not including the
539 NUL terminator), or -1 on error or EOF. */
540 # if @REPLACE_GETLINE@
541 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
543 # define getline rpl_getline
545 _GL_FUNCDECL_RPL (getline, ssize_t,
546 (char **lineptr, size_t *linesize, FILE *stream)
547 _GL_ARG_NONNULL ((1, 2, 3)));
548 _GL_CXXALIAS_RPL (getline, ssize_t,
549 (char **lineptr, size_t *linesize, FILE *stream));
551 # if !@HAVE_DECL_GETLINE@
552 _GL_FUNCDECL_SYS (getline, ssize_t,
553 (char **lineptr, size_t *linesize, FILE *stream)
554 _GL_ARG_NONNULL ((1, 2, 3)));
556 _GL_CXXALIAS_SYS (getline, ssize_t,
557 (char **lineptr, size_t *linesize, FILE *stream));
559 # if @HAVE_DECL_GETLINE@
560 _GL_CXXALIASWARN (getline);
562 #elif defined GNULIB_POSIXCHECK
564 # if HAVE_RAW_DECL_GETLINE
565 _GL_WARN_ON_USE (getline, "getline is unportable - "
566 "use gnulib module getline for portability");
570 #if @GNULIB_OBSTACK_PRINTF@ || @GNULIB_OBSTACK_PRINTF_POSIX@
572 /* Grow an obstack with formatted output. Return the number of
573 bytes added to OBS. No trailing nul byte is added, and the
574 object should be closed with obstack_finish before use. Upon
575 memory allocation error, call obstack_alloc_failed_handler. Upon
576 other error, return -1. */
577 # if @REPLACE_OBSTACK_PRINTF@
578 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
579 # define obstack_printf rpl_obstack_printf
581 _GL_FUNCDECL_RPL (obstack_printf, int,
582 (struct obstack *obs, const char *format, ...)
583 __attribute__ ((__format__ (__printf__, 2, 3)))
584 _GL_ARG_NONNULL ((1, 2)));
585 _GL_CXXALIAS_RPL (obstack_printf, int,
586 (struct obstack *obs, const char *format, ...));
588 # if !@HAVE_DECL_OBSTACK_PRINTF@
589 _GL_FUNCDECL_SYS (obstack_printf, int,
590 (struct obstack *obs, const char *format, ...)
591 __attribute__ ((__format__ (__printf__, 2, 3)))
592 _GL_ARG_NONNULL ((1, 2)));
594 _GL_CXXALIAS_SYS (obstack_printf, int,
595 (struct obstack *obs, const char *format, ...));
597 _GL_CXXALIASWARN (obstack_printf);
598 # if @REPLACE_OBSTACK_PRINTF@
599 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
600 # define obstack_vprintf rpl_obstack_vprintf
602 _GL_FUNCDECL_RPL (obstack_vprintf, int,
603 (struct obstack *obs, const char *format, va_list args)
604 __attribute__ ((__format__ (__printf__, 2, 0)))
605 _GL_ARG_NONNULL ((1, 2)));
606 _GL_CXXALIAS_RPL (obstack_vprintf, int,
607 (struct obstack *obs, const char *format, va_list args));
609 # if !@HAVE_DECL_OBSTACK_PRINTF@
610 _GL_FUNCDECL_SYS (obstack_vprintf, int,
611 (struct obstack *obs, const char *format, va_list args)
612 __attribute__ ((__format__ (__printf__, 2, 0)))
613 _GL_ARG_NONNULL ((1, 2)));
615 _GL_CXXALIAS_SYS (obstack_vprintf, int,
616 (struct obstack *obs, const char *format, va_list args));
618 _GL_CXXALIASWARN (obstack_vprintf);
622 /* Print a message to standard error, describing the value of ERRNO,
623 (if STRING is not NULL and not empty) prefixed with STRING and ": ",
624 and terminated with a newline. */
625 # if @REPLACE_PERROR@
626 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
627 # define perror rpl_perror
629 _GL_FUNCDECL_RPL (perror, void, (const char *string));
630 _GL_CXXALIAS_RPL (perror, void, (const char *string));
632 _GL_CXXALIAS_SYS (perror, void, (const char *string));
634 _GL_CXXALIASWARN (perror);
635 #elif defined GNULIB_POSIXCHECK
637 /* Assume perror is always declared. */
638 _GL_WARN_ON_USE (perror, "perror is not always POSIX compliant - "
639 "use gnulib module perror for portability");
644 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
646 # define popen rpl_popen
648 _GL_FUNCDECL_RPL (popen, FILE *, (const char *cmd, const char *mode)
649 _GL_ARG_NONNULL ((1, 2)));
650 _GL_CXXALIAS_RPL (popen, FILE *, (const char *cmd, const char *mode));
652 _GL_CXXALIAS_SYS (popen, FILE *, (const char *cmd, const char *mode));
654 _GL_CXXALIASWARN (popen);
655 #elif defined GNULIB_POSIXCHECK
657 # if HAVE_RAW_DECL_POPEN
658 _GL_WARN_ON_USE (popen, "popen is buggy on some platforms - "
659 "use gnulib module popen or pipe for more portability");
663 #if @GNULIB_PRINTF_POSIX@ || @GNULIB_PRINTF@
664 # if (@GNULIB_PRINTF_POSIX@ && @REPLACE_PRINTF@) \
665 || (@GNULIB_PRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
666 # if defined __GNUC__
667 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
668 /* Don't break __attribute__((format(printf,M,N))). */
669 # define printf __printf__
671 _GL_FUNCDECL_RPL_1 (__printf__, int,
672 (const char *format, ...)
673 __asm__ (@ASM_SYMBOL_PREFIX@
674 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_printf))
675 __attribute__ ((__format__ (__printf__, 1, 2)))
676 _GL_ARG_NONNULL ((1)));
677 _GL_CXXALIAS_RPL_1 (printf, __printf__, int, (const char *format, ...));
679 _GL_FUNCDECL_RPL (printf, int,
680 (const char *format, ...)
681 __attribute__ ((__format__ (__printf__, 1, 2)))
682 _GL_ARG_NONNULL ((1)));
683 _GL_CXXALIAS_RPL (printf, int, (const char *format, ...));
685 # define GNULIB_overrides_printf 1
687 _GL_CXXALIAS_SYS (printf, int, (const char *format, ...));
689 _GL_CXXALIASWARN (printf);
691 #if !@GNULIB_PRINTF_POSIX@ && defined GNULIB_POSIXCHECK
692 # if !GNULIB_overrides_printf
695 /* Assume printf is always declared. */
696 _GL_WARN_ON_USE (printf, "printf is not always POSIX compliant - "
697 "use gnulib module printf-posix for portable "
702 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
703 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
705 # define putc rpl_fputc
707 _GL_FUNCDECL_RPL (fputc, int, (int c, FILE *stream) _GL_ARG_NONNULL ((2)));
708 _GL_CXXALIAS_RPL_1 (putc, rpl_fputc, int, (int c, FILE *stream));
710 _GL_CXXALIAS_SYS (putc, int, (int c, FILE *stream));
712 _GL_CXXALIASWARN (putc);
716 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
717 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
719 # define putchar rpl_putchar
721 _GL_FUNCDECL_RPL (putchar, int, (int c));
722 _GL_CXXALIAS_RPL (putchar, int, (int c));
724 _GL_CXXALIAS_SYS (putchar, int, (int c));
726 _GL_CXXALIASWARN (putchar);
730 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
731 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
733 # define puts rpl_puts
735 _GL_FUNCDECL_RPL (puts, int, (const char *string) _GL_ARG_NONNULL ((1)));
736 _GL_CXXALIAS_RPL (puts, int, (const char *string));
738 _GL_CXXALIAS_SYS (puts, int, (const char *string));
740 _GL_CXXALIASWARN (puts);
744 # if @REPLACE_REMOVE@
745 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
747 # define remove rpl_remove
749 _GL_FUNCDECL_RPL (remove, int, (const char *name) _GL_ARG_NONNULL ((1)));
750 _GL_CXXALIAS_RPL (remove, int, (const char *name));
752 _GL_CXXALIAS_SYS (remove, int, (const char *name));
754 _GL_CXXALIASWARN (remove);
755 #elif defined GNULIB_POSIXCHECK
757 /* Assume remove is always declared. */
758 _GL_WARN_ON_USE (remove, "remove cannot handle directories on some platforms - "
759 "use gnulib module remove for more portability");
763 # if @REPLACE_RENAME@
764 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
766 # define rename rpl_rename
768 _GL_FUNCDECL_RPL (rename, int,
769 (const char *old_filename, const char *new_filename)
770 _GL_ARG_NONNULL ((1, 2)));
771 _GL_CXXALIAS_RPL (rename, int,
772 (const char *old_filename, const char *new_filename));
774 _GL_CXXALIAS_SYS (rename, int,
775 (const char *old_filename, const char *new_filename));
777 _GL_CXXALIASWARN (rename);
778 #elif defined GNULIB_POSIXCHECK
780 /* Assume rename is always declared. */
781 _GL_WARN_ON_USE (rename, "rename is buggy on some platforms - "
782 "use gnulib module rename for more portability");
785 #if @GNULIB_RENAMEAT@
786 # if @REPLACE_RENAMEAT@
787 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
789 # define renameat rpl_renameat
791 _GL_FUNCDECL_RPL (renameat, int,
792 (int fd1, char const *file1, int fd2, char const *file2)
793 _GL_ARG_NONNULL ((2, 4)));
794 _GL_CXXALIAS_RPL (renameat, int,
795 (int fd1, char const *file1, int fd2, char const *file2));
797 # if !@HAVE_RENAMEAT@
798 _GL_FUNCDECL_SYS (renameat, int,
799 (int fd1, char const *file1, int fd2, char const *file2)
800 _GL_ARG_NONNULL ((2, 4)));
802 _GL_CXXALIAS_SYS (renameat, int,
803 (int fd1, char const *file1, int fd2, char const *file2));
805 _GL_CXXALIASWARN (renameat);
806 #elif defined GNULIB_POSIXCHECK
808 # if HAVE_RAW_DECL_RENAMEAT
809 _GL_WARN_ON_USE (renameat, "renameat is not portable - "
810 "use gnulib module renameat for portability");
814 #if @GNULIB_SNPRINTF@
815 # if @REPLACE_SNPRINTF@
816 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
817 # define snprintf rpl_snprintf
819 _GL_FUNCDECL_RPL (snprintf, int,
820 (char *str, size_t size, const char *format, ...)
821 __attribute__ ((__format__ (__printf__, 3, 4)))
822 _GL_ARG_NONNULL ((3)));
823 _GL_CXXALIAS_RPL (snprintf, int,
824 (char *str, size_t size, const char *format, ...));
826 # if !@HAVE_DECL_SNPRINTF@
827 _GL_FUNCDECL_SYS (snprintf, int,
828 (char *str, size_t size, const char *format, ...)
829 __attribute__ ((__format__ (__printf__, 3, 4)))
830 _GL_ARG_NONNULL ((3)));
832 _GL_CXXALIAS_SYS (snprintf, int,
833 (char *str, size_t size, const char *format, ...));
835 _GL_CXXALIASWARN (snprintf);
836 #elif defined GNULIB_POSIXCHECK
838 # if HAVE_RAW_DECL_SNPRINTF
839 _GL_WARN_ON_USE (snprintf, "snprintf is unportable - "
840 "use gnulib module snprintf for portability");
844 /* Some people would argue that sprintf should be handled like gets
845 (for example, OpenBSD issues a link warning for both functions),
846 since both can cause security holes due to buffer overruns.
847 However, we believe that sprintf can be used safely, and is more
848 efficient than snprintf in those safe cases; and as proof of our
849 belief, we use sprintf in several gnulib modules. So this header
850 intentionally avoids adding a warning to sprintf except when
851 GNULIB_POSIXCHECK is defined. */
853 #if @GNULIB_SPRINTF_POSIX@
854 # if @REPLACE_SPRINTF@
855 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
856 # define sprintf rpl_sprintf
858 _GL_FUNCDECL_RPL (sprintf, int, (char *str, const char *format, ...)
859 __attribute__ ((__format__ (__printf__, 2, 3)))
860 _GL_ARG_NONNULL ((1, 2)));
861 _GL_CXXALIAS_RPL (sprintf, int, (char *str, const char *format, ...));
863 _GL_CXXALIAS_SYS (sprintf, int, (char *str, const char *format, ...));
865 _GL_CXXALIASWARN (sprintf);
866 #elif defined GNULIB_POSIXCHECK
868 /* Assume sprintf is always declared. */
869 _GL_WARN_ON_USE (sprintf, "sprintf is not always POSIX compliant - "
870 "use gnulib module sprintf-posix for portable "
875 # if @REPLACE_TMPFILE@
876 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
877 # define tmpfile rpl_tmpfile
879 _GL_FUNCDECL_RPL (tmpfile, FILE *, (void));
880 _GL_CXXALIAS_RPL (tmpfile, FILE *, (void));
882 _GL_CXXALIAS_SYS (tmpfile, FILE *, (void));
884 _GL_CXXALIASWARN (tmpfile);
885 #elif defined GNULIB_POSIXCHECK
887 # if HAVE_RAW_DECL_TMPFILE
888 _GL_WARN_ON_USE (tmpfile, "tmpfile is not usable on mingw - "
889 "use gnulib module tmpfile for portability");
893 #if @GNULIB_VASPRINTF@
894 /* Write formatted output to a string dynamically allocated with malloc().
895 If the memory allocation succeeds, store the address of the string in
896 *RESULT and return the number of resulting bytes, excluding the trailing
897 NUL. Upon memory allocation error, or some other error, return -1. */
898 # if @REPLACE_VASPRINTF@
899 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
900 # define asprintf rpl_asprintf
902 _GL_FUNCDECL_RPL (asprintf, int,
903 (char **result, const char *format, ...)
904 __attribute__ ((__format__ (__printf__, 2, 3)))
905 _GL_ARG_NONNULL ((1, 2)));
906 _GL_CXXALIAS_RPL (asprintf, int,
907 (char **result, const char *format, ...));
909 # if !@HAVE_VASPRINTF@
910 _GL_FUNCDECL_SYS (asprintf, int,
911 (char **result, const char *format, ...)
912 __attribute__ ((__format__ (__printf__, 2, 3)))
913 _GL_ARG_NONNULL ((1, 2)));
915 _GL_CXXALIAS_SYS (asprintf, int,
916 (char **result, const char *format, ...));
918 _GL_CXXALIASWARN (asprintf);
919 # if @REPLACE_VASPRINTF@
920 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
921 # define vasprintf rpl_vasprintf
923 _GL_FUNCDECL_RPL (vasprintf, int,
924 (char **result, const char *format, va_list args)
925 __attribute__ ((__format__ (__printf__, 2, 0)))
926 _GL_ARG_NONNULL ((1, 2)));
927 _GL_CXXALIAS_RPL (vasprintf, int,
928 (char **result, const char *format, va_list args));
930 # if !@HAVE_VASPRINTF@
931 _GL_FUNCDECL_SYS (vasprintf, int,
932 (char **result, const char *format, va_list args)
933 __attribute__ ((__format__ (__printf__, 2, 0)))
934 _GL_ARG_NONNULL ((1, 2)));
936 _GL_CXXALIAS_SYS (vasprintf, int,
937 (char **result, const char *format, va_list args));
939 _GL_CXXALIASWARN (vasprintf);
942 #if @GNULIB_VDPRINTF@
943 # if @REPLACE_VDPRINTF@
944 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
945 # define vdprintf rpl_vdprintf
947 _GL_FUNCDECL_RPL (vdprintf, int, (int fd, const char *format, va_list args)
948 __attribute__ ((__format__ (__printf__, 2, 0)))
949 _GL_ARG_NONNULL ((2)));
950 _GL_CXXALIAS_RPL (vdprintf, int, (int fd, const char *format, va_list args));
952 # if !@HAVE_VDPRINTF@
953 _GL_FUNCDECL_SYS (vdprintf, int, (int fd, const char *format, va_list args)
954 __attribute__ ((__format__ (__printf__, 2, 0)))
955 _GL_ARG_NONNULL ((2)));
957 /* Need to cast, because on Solaris, the third parameter will likely be
959 _GL_CXXALIAS_SYS_CAST (vdprintf, int,
960 (int fd, const char *format, va_list args));
962 _GL_CXXALIASWARN (vdprintf);
963 #elif defined GNULIB_POSIXCHECK
965 # if HAVE_RAW_DECL_VDPRINTF
966 _GL_WARN_ON_USE (vdprintf, "vdprintf is unportable - "
967 "use gnulib module vdprintf for portability");
971 #if @GNULIB_VFPRINTF_POSIX@ || @GNULIB_VFPRINTF@
972 # if (@GNULIB_VFPRINTF_POSIX@ && @REPLACE_VFPRINTF@) \
973 || (@GNULIB_VFPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
974 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
975 # define vfprintf rpl_vfprintf
977 # define GNULIB_overrides_vfprintf 1
978 _GL_FUNCDECL_RPL (vfprintf, int, (FILE *fp, const char *format, va_list args)
979 __attribute__ ((__format__ (__printf__, 2, 0)))
980 _GL_ARG_NONNULL ((1, 2)));
981 _GL_CXXALIAS_RPL (vfprintf, int, (FILE *fp, const char *format, va_list args));
983 /* Need to cast, because on Solaris, the third parameter is
985 and GCC's fixincludes did not change this to __gnuc_va_list. */
986 _GL_CXXALIAS_SYS_CAST (vfprintf, int,
987 (FILE *fp, const char *format, va_list args));
989 _GL_CXXALIASWARN (vfprintf);
991 #if !@GNULIB_VFPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
992 # if !GNULIB_overrides_vfprintf
995 /* Assume vfprintf is always declared. */
996 _GL_WARN_ON_USE (vfprintf, "vfprintf is not always POSIX compliant - "
997 "use gnulib module vfprintf-posix for portable "
1001 #if @GNULIB_VPRINTF_POSIX@ || @GNULIB_VPRINTF@
1002 # if (@GNULIB_VPRINTF_POSIX@ && @REPLACE_VPRINTF@) \
1003 || (@GNULIB_VPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
1004 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1005 # define vprintf rpl_vprintf
1007 # define GNULIB_overrides_vprintf 1
1008 _GL_FUNCDECL_RPL (vprintf, int, (const char *format, va_list args)
1009 __attribute__ ((__format__ (__printf__, 1, 0)))
1010 _GL_ARG_NONNULL ((1)));
1011 _GL_CXXALIAS_RPL (vprintf, int, (const char *format, va_list args));
1013 /* Need to cast, because on Solaris, the second parameter is
1015 and GCC's fixincludes did not change this to __gnuc_va_list. */
1016 _GL_CXXALIAS_SYS_CAST (vprintf, int, (const char *format, va_list args));
1018 _GL_CXXALIASWARN (vprintf);
1020 #if !@GNULIB_VPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1021 # if !GNULIB_overrides_vprintf
1024 /* Assume vprintf is always declared. */
1025 _GL_WARN_ON_USE (vprintf, "vprintf is not always POSIX compliant - "
1026 "use gnulib module vprintf-posix for portable "
1027 "POSIX compliance");
1030 #if @GNULIB_VSNPRINTF@
1031 # if @REPLACE_VSNPRINTF@
1032 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1033 # define vsnprintf rpl_vsnprintf
1035 _GL_FUNCDECL_RPL (vsnprintf, int,
1036 (char *str, size_t size, const char *format, va_list args)
1037 __attribute__ ((__format__ (__printf__, 3, 0)))
1038 _GL_ARG_NONNULL ((3)));
1039 _GL_CXXALIAS_RPL (vsnprintf, int,
1040 (char *str, size_t size, const char *format, va_list args));
1042 # if !@HAVE_DECL_VSNPRINTF@
1043 _GL_FUNCDECL_SYS (vsnprintf, int,
1044 (char *str, size_t size, const char *format, va_list args)
1045 __attribute__ ((__format__ (__printf__, 3, 0)))
1046 _GL_ARG_NONNULL ((3)));
1048 _GL_CXXALIAS_SYS (vsnprintf, int,
1049 (char *str, size_t size, const char *format, va_list args));
1051 _GL_CXXALIASWARN (vsnprintf);
1052 #elif defined GNULIB_POSIXCHECK
1054 # if HAVE_RAW_DECL_VSNPRINTF
1055 _GL_WARN_ON_USE (vsnprintf, "vsnprintf is unportable - "
1056 "use gnulib module vsnprintf for portability");
1060 #if @GNULIB_VSPRINTF_POSIX@
1061 # if @REPLACE_VSPRINTF@
1062 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1063 # define vsprintf rpl_vsprintf
1065 _GL_FUNCDECL_RPL (vsprintf, int,
1066 (char *str, const char *format, va_list args)
1067 __attribute__ ((__format__ (__printf__, 2, 0)))
1068 _GL_ARG_NONNULL ((1, 2)));
1069 _GL_CXXALIAS_RPL (vsprintf, int,
1070 (char *str, const char *format, va_list args));
1072 /* Need to cast, because on Solaris, the third parameter is
1074 and GCC's fixincludes did not change this to __gnuc_va_list. */
1075 _GL_CXXALIAS_SYS_CAST (vsprintf, int,
1076 (char *str, const char *format, va_list args));
1078 _GL_CXXALIASWARN (vsprintf);
1079 #elif defined GNULIB_POSIXCHECK
1081 /* Assume vsprintf is always declared. */
1082 _GL_WARN_ON_USE (vsprintf, "vsprintf is not always POSIX compliant - "
1083 "use gnulib module vsprintf-posix for portable "
1084 "POSIX compliance");
1088 #endif /* _GL_STDIO_H */
1089 #endif /* _GL_STDIO_H */