1 /* A GNU-like <stdio.h>.
3 Copyright (C) 2004, 2007-2011 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
57 #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 _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))
68 # define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
70 #define _GL_ATTRIBUTE_FORMAT_PRINTF(formatstring_parameter, first_argument) \
71 _GL_ATTRIBUTE_FORMAT ((__printf__, formatstring_parameter, first_argument))
73 /* Solaris 10 declares renameat in <unistd.h>, not in <stdio.h>. */
74 /* But in any case avoid namespace pollution on glibc systems. */
75 #if (@GNULIB_RENAMEAT@ || defined GNULIB_POSIXCHECK) && defined __sun \
76 && ! defined __GLIBC__
81 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
83 /* The definition of _GL_ARG_NONNULL is copied here. */
85 /* The definition of _GL_WARN_ON_USE is copied here. */
87 /* Macros for stringification. */
88 #define _GL_STDIO_STRINGIZE(token) #token
89 #define _GL_STDIO_MACROEXPAND_AND_STRINGIZE(token) _GL_STDIO_STRINGIZE(token)
93 # if @REPLACE_DPRINTF@
94 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
95 # define dprintf rpl_dprintf
97 _GL_FUNCDECL_RPL (dprintf, int, (int fd, const char *format, ...)
98 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
99 _GL_ARG_NONNULL ((2)));
100 _GL_CXXALIAS_RPL (dprintf, int, (int fd, const char *format, ...));
103 _GL_FUNCDECL_SYS (dprintf, int, (int fd, const char *format, ...)
104 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
105 _GL_ARG_NONNULL ((2)));
107 _GL_CXXALIAS_SYS (dprintf, int, (int fd, const char *format, ...));
109 _GL_CXXALIASWARN (dprintf);
110 #elif defined GNULIB_POSIXCHECK
112 # if HAVE_RAW_DECL_DPRINTF
113 _GL_WARN_ON_USE (dprintf, "dprintf is unportable - "
114 "use gnulib module dprintf for portability");
119 /* Close STREAM and its underlying file descriptor. */
120 # if @REPLACE_FCLOSE@
121 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
122 # define fclose rpl_fclose
124 _GL_FUNCDECL_RPL (fclose, int, (FILE *stream) _GL_ARG_NONNULL ((1)));
125 _GL_CXXALIAS_RPL (fclose, int, (FILE *stream));
127 _GL_CXXALIAS_SYS (fclose, int, (FILE *stream));
129 _GL_CXXALIASWARN (fclose);
130 #elif defined GNULIB_POSIXCHECK
132 /* Assume fclose is always declared. */
133 _GL_WARN_ON_USE (fclose, "fclose is not always POSIX compliant - "
134 "use gnulib module fclose for portable POSIX compliance");
138 /* Flush all pending data on STREAM according to POSIX rules. Both
139 output and seekable input streams are supported.
140 Note! LOSS OF DATA can occur if fflush is applied on an input stream
141 that is _not_seekable_ or on an update stream that is _not_seekable_
142 and in which the most recent operation was input. Seekability can
143 be tested with lseek(fileno(fp),0,SEEK_CUR). */
144 # if @REPLACE_FFLUSH@
145 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
146 # define fflush rpl_fflush
148 _GL_FUNCDECL_RPL (fflush, int, (FILE *gl_stream));
149 _GL_CXXALIAS_RPL (fflush, int, (FILE *gl_stream));
151 _GL_CXXALIAS_SYS (fflush, int, (FILE *gl_stream));
153 _GL_CXXALIASWARN (fflush);
154 #elif defined GNULIB_POSIXCHECK
156 /* Assume fflush is always declared. */
157 _GL_WARN_ON_USE (fflush, "fflush is not always POSIX compliant - "
158 "use gnulib module fflush for portable POSIX compliance");
161 /* It is very rare that the developer ever has full control of stdin,
162 so any use of gets warrants an unconditional warning. Assume it is
163 always declared, since it is required by C89. */
165 _GL_WARN_ON_USE (gets, "gets is a security hole - use fgets instead");
169 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
171 # define fopen rpl_fopen
173 _GL_FUNCDECL_RPL (fopen, FILE *, (const char *filename, const char *mode)
174 _GL_ARG_NONNULL ((1, 2)));
175 _GL_CXXALIAS_RPL (fopen, FILE *, (const char *filename, const char *mode));
177 _GL_CXXALIAS_SYS (fopen, FILE *, (const char *filename, const char *mode));
179 _GL_CXXALIASWARN (fopen);
180 #elif defined GNULIB_POSIXCHECK
182 /* Assume fopen is always declared. */
183 _GL_WARN_ON_USE (fopen, "fopen on Win32 platforms is not POSIX compatible - "
184 "use gnulib module fopen for portability");
187 #if @GNULIB_FPRINTF_POSIX@ || @GNULIB_FPRINTF@
188 # if (@GNULIB_FPRINTF_POSIX@ && @REPLACE_FPRINTF@) \
189 || (@GNULIB_FPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
190 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
191 # define fprintf rpl_fprintf
193 # define GNULIB_overrides_fprintf 1
194 _GL_FUNCDECL_RPL (fprintf, int, (FILE *fp, const char *format, ...)
195 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
196 _GL_ARG_NONNULL ((1, 2)));
197 _GL_CXXALIAS_RPL (fprintf, int, (FILE *fp, const char *format, ...));
199 _GL_CXXALIAS_SYS (fprintf, int, (FILE *fp, const char *format, ...));
201 _GL_CXXALIASWARN (fprintf);
203 #if !@GNULIB_FPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
204 # if !GNULIB_overrides_fprintf
207 /* Assume fprintf is always declared. */
208 _GL_WARN_ON_USE (fprintf, "fprintf is not always POSIX compliant - "
209 "use gnulib module fprintf-posix for portable "
214 /* Discard all pending buffered I/O data on STREAM.
215 STREAM must not be wide-character oriented.
216 When discarding pending output, the file position is set back to where it
217 was before the write calls. When discarding pending input, the file
218 position is advanced to match the end of the previously read input.
219 Return 0 if successful. Upon error, return -1 and set errno. */
220 # if @REPLACE_FPURGE@
221 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
222 # define fpurge rpl_fpurge
224 _GL_FUNCDECL_RPL (fpurge, int, (FILE *gl_stream) _GL_ARG_NONNULL ((1)));
225 _GL_CXXALIAS_RPL (fpurge, int, (FILE *gl_stream));
227 # if !@HAVE_DECL_FPURGE@
228 _GL_FUNCDECL_SYS (fpurge, int, (FILE *gl_stream) _GL_ARG_NONNULL ((1)));
230 _GL_CXXALIAS_SYS (fpurge, int, (FILE *gl_stream));
232 _GL_CXXALIASWARN (fpurge);
233 #elif defined GNULIB_POSIXCHECK
235 # if HAVE_RAW_DECL_FPURGE
236 _GL_WARN_ON_USE (fpurge, "fpurge is not always present - "
237 "use gnulib module fpurge for portability");
242 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
243 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
245 # define fputc rpl_fputc
247 _GL_FUNCDECL_RPL (fputc, int, (int c, FILE *stream) _GL_ARG_NONNULL ((2)));
248 _GL_CXXALIAS_RPL (fputc, int, (int c, FILE *stream));
250 _GL_CXXALIAS_SYS (fputc, int, (int c, FILE *stream));
252 _GL_CXXALIASWARN (fputc);
256 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
257 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
259 # define fputs rpl_fputs
261 _GL_FUNCDECL_RPL (fputs, int, (const char *string, FILE *stream)
262 _GL_ARG_NONNULL ((1, 2)));
263 _GL_CXXALIAS_RPL (fputs, int, (const char *string, FILE *stream));
265 _GL_CXXALIAS_SYS (fputs, int, (const char *string, FILE *stream));
267 _GL_CXXALIASWARN (fputs);
271 # if @REPLACE_FREOPEN@
272 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
274 # define freopen rpl_freopen
276 _GL_FUNCDECL_RPL (freopen, FILE *,
277 (const char *filename, const char *mode, FILE *stream)
278 _GL_ARG_NONNULL ((2, 3)));
279 _GL_CXXALIAS_RPL (freopen, FILE *,
280 (const char *filename, const char *mode, FILE *stream));
282 _GL_CXXALIAS_SYS (freopen, FILE *,
283 (const char *filename, const char *mode, FILE *stream));
285 _GL_CXXALIASWARN (freopen);
286 #elif defined GNULIB_POSIXCHECK
288 /* Assume freopen is always declared. */
289 _GL_WARN_ON_USE (freopen,
290 "freopen on Win32 platforms is not POSIX compatible - "
291 "use gnulib module freopen for portability");
295 /* Set up the following warnings, based on which modules are in use.
296 GNU Coding Standards discourage the use of fseek, since it imposes
297 an arbitrary limitation on some 32-bit hosts. Remember that the
298 fseek module depends on the fseeko module, so we only have three
301 1. The developer is not using either module. Issue a warning under
302 GNULIB_POSIXCHECK for both functions, to remind them that both
303 functions have bugs on some systems. _GL_NO_LARGE_FILES has no
304 impact on this warning.
306 2. The developer is using both modules. They may be unaware of the
307 arbitrary limitations of fseek, so issue a warning under
308 GNULIB_POSIXCHECK. On the other hand, they may be using both
309 modules intentionally, so the developer can define
310 _GL_NO_LARGE_FILES in the compilation units where the use of fseek
311 is safe, to silence the warning.
313 3. The developer is using the fseeko module, but not fseek. Gnulib
314 guarantees that fseek will still work around platform bugs in that
315 case, but we presume that the developer is aware of the pitfalls of
316 fseek and was trying to avoid it, so issue a warning even when
317 GNULIB_POSIXCHECK is undefined. Again, _GL_NO_LARGE_FILES can be
318 defined to silence the warning in particular compilation units.
319 In C++ compilations with GNULIB_NAMESPACE, in order to avoid that
320 fseek gets defined as a macro, it is recommended that the developer
321 uses the fseek module, even if he is not calling the fseek function.
323 Most gnulib clients that perform stream operations should fall into
327 # if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
328 # define _GL_FSEEK_WARN /* Category 2, above. */
332 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
334 # define fseek rpl_fseek
336 _GL_FUNCDECL_RPL (fseek, int, (FILE *fp, long offset, int whence)
337 _GL_ARG_NONNULL ((1)));
338 _GL_CXXALIAS_RPL (fseek, int, (FILE *fp, long offset, int whence));
340 _GL_CXXALIAS_SYS (fseek, int, (FILE *fp, long offset, int whence));
342 _GL_CXXALIASWARN (fseek);
346 # if !@GNULIB_FSEEK@ && !defined _GL_NO_LARGE_FILES
347 # define _GL_FSEEK_WARN /* Category 3, above. */
350 # if @REPLACE_FSEEKO@
351 /* Provide an fseeko function that is aware of a preceding fflush(), and which
353 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
355 # define fseeko rpl_fseeko
357 _GL_FUNCDECL_RPL (fseeko, int, (FILE *fp, off_t offset, int whence)
358 _GL_ARG_NONNULL ((1)));
359 _GL_CXXALIAS_RPL (fseeko, int, (FILE *fp, off_t offset, int whence));
361 # if ! @HAVE_DECL_FSEEKO@
362 _GL_FUNCDECL_SYS (fseeko, int, (FILE *fp, off_t offset, int whence)
363 _GL_ARG_NONNULL ((1)));
365 _GL_CXXALIAS_SYS (fseeko, int, (FILE *fp, off_t offset, int whence));
367 _GL_CXXALIASWARN (fseeko);
368 # if (@REPLACE_FSEEKO@ || !@HAVE_FSEEKO@) && !@GNULIB_FSEEK@
369 /* Provide an fseek function that is consistent with fseeko. */
370 /* In order to avoid that fseek gets defined as a macro here, the
371 developer can request the 'fseek' module. */
372 # if !GNULIB_defined_fseek_function
374 # define fseek rpl_fseek
375 static inline int _GL_ARG_NONNULL ((1))
376 rpl_fseek (FILE *fp, long offset, int whence)
378 # if @REPLACE_FSEEKO@
379 return rpl_fseeko (fp, offset, whence);
381 return fseeko (fp, offset, whence);
384 # define GNULIB_defined_fseek_function 1
387 #elif defined GNULIB_POSIXCHECK
388 # define _GL_FSEEK_WARN /* Category 1, above. */
391 # if HAVE_RAW_DECL_FSEEKO
392 _GL_WARN_ON_USE (fseeko, "fseeko is unportable - "
393 "use gnulib module fseeko for portability");
397 #ifdef _GL_FSEEK_WARN
398 # undef _GL_FSEEK_WARN
399 /* Here, either fseek is undefined (but C89 guarantees that it is
400 declared), or it is defined as rpl_fseek (declared above). */
401 _GL_WARN_ON_USE (fseek, "fseek cannot handle files larger than 4 GB "
402 "on 32-bit platforms - "
403 "use fseeko function for handling of large files");
407 /* ftell, ftello. See the comments on fseek/fseeko. */
410 # if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
411 # define _GL_FTELL_WARN /* Category 2, above. */
415 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
417 # define ftell rpl_ftell
419 _GL_FUNCDECL_RPL (ftell, long, (FILE *fp) _GL_ARG_NONNULL ((1)));
420 _GL_CXXALIAS_RPL (ftell, long, (FILE *fp));
422 _GL_CXXALIAS_SYS (ftell, long, (FILE *fp));
424 _GL_CXXALIASWARN (ftell);
428 # if !@GNULIB_FTELL@ && !defined _GL_NO_LARGE_FILES
429 # define _GL_FTELL_WARN /* Category 3, above. */
432 # if @REPLACE_FTELLO@
433 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
435 # define ftello rpl_ftello
437 _GL_FUNCDECL_RPL (ftello, off_t, (FILE *fp) _GL_ARG_NONNULL ((1)));
438 _GL_CXXALIAS_RPL (ftello, off_t, (FILE *fp));
440 # if ! @HAVE_DECL_FTELLO@
441 _GL_FUNCDECL_SYS (ftello, off_t, (FILE *fp) _GL_ARG_NONNULL ((1)));
443 _GL_CXXALIAS_SYS (ftello, off_t, (FILE *fp));
445 _GL_CXXALIASWARN (ftello);
446 # if (@REPLACE_FTELLO@ || !@HAVE_FTELLO@) && !@GNULIB_FTELL@
447 /* Provide an ftell function that is consistent with ftello. */
448 /* In order to avoid that ftell gets defined as a macro here, the
449 developer can request the 'ftell' module. */
450 # if !GNULIB_defined_ftell_function
452 # define ftell rpl_ftell
453 static inline long _GL_ARG_NONNULL ((1))
456 # if @REPLACE_FTELLO@
457 return rpl_ftello (f);
462 # define GNULIB_defined_ftell_function 1
465 #elif defined GNULIB_POSIXCHECK
466 # define _GL_FTELL_WARN /* Category 1, above. */
469 # if HAVE_RAW_DECL_FTELLO
470 _GL_WARN_ON_USE (ftello, "ftello is unportable - "
471 "use gnulib module ftello for portability");
475 #ifdef _GL_FTELL_WARN
476 # undef _GL_FTELL_WARN
477 /* Here, either ftell is undefined (but C89 guarantees that it is
478 declared), or it is defined as rpl_ftell (declared above). */
479 _GL_WARN_ON_USE (ftell, "ftell cannot handle files larger than 4 GB "
480 "on 32-bit platforms - "
481 "use ftello function for handling of large files");
486 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
487 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
489 # define fwrite rpl_fwrite
491 _GL_FUNCDECL_RPL (fwrite, size_t,
492 (const void *ptr, size_t s, size_t n, FILE *stream)
493 _GL_ARG_NONNULL ((1, 4)));
494 _GL_CXXALIAS_RPL (fwrite, size_t,
495 (const void *ptr, size_t s, size_t n, FILE *stream));
497 _GL_CXXALIAS_SYS (fwrite, size_t,
498 (const void *ptr, size_t s, size_t n, FILE *stream));
500 _GL_CXXALIASWARN (fwrite);
503 #if @GNULIB_GETDELIM@
504 /* Read input, up to (and including) the next occurrence of DELIMITER, from
505 STREAM, store it in *LINEPTR (and NUL-terminate it).
506 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
507 bytes of space. It is realloc'd as necessary.
508 Return the number of bytes read and stored at *LINEPTR (not including the
509 NUL terminator), or -1 on error or EOF. */
510 # if @REPLACE_GETDELIM@
511 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
513 # define getdelim rpl_getdelim
515 _GL_FUNCDECL_RPL (getdelim, ssize_t,
516 (char **lineptr, size_t *linesize, int delimiter,
518 _GL_ARG_NONNULL ((1, 2, 4)));
519 _GL_CXXALIAS_RPL (getdelim, ssize_t,
520 (char **lineptr, size_t *linesize, int delimiter,
523 # if !@HAVE_DECL_GETDELIM@
524 _GL_FUNCDECL_SYS (getdelim, ssize_t,
525 (char **lineptr, size_t *linesize, int delimiter,
527 _GL_ARG_NONNULL ((1, 2, 4)));
529 _GL_CXXALIAS_SYS (getdelim, ssize_t,
530 (char **lineptr, size_t *linesize, int delimiter,
533 _GL_CXXALIASWARN (getdelim);
534 #elif defined GNULIB_POSIXCHECK
536 # if HAVE_RAW_DECL_GETDELIM
537 _GL_WARN_ON_USE (getdelim, "getdelim is unportable - "
538 "use gnulib module getdelim for portability");
543 /* Read a line, up to (and including) the next newline, from STREAM, store it
544 in *LINEPTR (and NUL-terminate it).
545 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
546 bytes of space. It is realloc'd as necessary.
547 Return the number of bytes read and stored at *LINEPTR (not including the
548 NUL terminator), or -1 on error or EOF. */
549 # if @REPLACE_GETLINE@
550 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
552 # define getline rpl_getline
554 _GL_FUNCDECL_RPL (getline, ssize_t,
555 (char **lineptr, size_t *linesize, FILE *stream)
556 _GL_ARG_NONNULL ((1, 2, 3)));
557 _GL_CXXALIAS_RPL (getline, ssize_t,
558 (char **lineptr, size_t *linesize, FILE *stream));
560 # if !@HAVE_DECL_GETLINE@
561 _GL_FUNCDECL_SYS (getline, ssize_t,
562 (char **lineptr, size_t *linesize, FILE *stream)
563 _GL_ARG_NONNULL ((1, 2, 3)));
565 _GL_CXXALIAS_SYS (getline, ssize_t,
566 (char **lineptr, size_t *linesize, FILE *stream));
568 # if @HAVE_DECL_GETLINE@
569 _GL_CXXALIASWARN (getline);
571 #elif defined GNULIB_POSIXCHECK
573 # if HAVE_RAW_DECL_GETLINE
574 _GL_WARN_ON_USE (getline, "getline is unportable - "
575 "use gnulib module getline for portability");
579 #if @GNULIB_OBSTACK_PRINTF@ || @GNULIB_OBSTACK_PRINTF_POSIX@
581 /* Grow an obstack with formatted output. Return the number of
582 bytes added to OBS. No trailing nul byte is added, and the
583 object should be closed with obstack_finish before use. Upon
584 memory allocation error, call obstack_alloc_failed_handler. Upon
585 other error, return -1. */
586 # if @REPLACE_OBSTACK_PRINTF@
587 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
588 # define obstack_printf rpl_obstack_printf
590 _GL_FUNCDECL_RPL (obstack_printf, int,
591 (struct obstack *obs, const char *format, ...)
592 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
593 _GL_ARG_NONNULL ((1, 2)));
594 _GL_CXXALIAS_RPL (obstack_printf, int,
595 (struct obstack *obs, const char *format, ...));
597 # if !@HAVE_DECL_OBSTACK_PRINTF@
598 _GL_FUNCDECL_SYS (obstack_printf, int,
599 (struct obstack *obs, const char *format, ...)
600 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
601 _GL_ARG_NONNULL ((1, 2)));
603 _GL_CXXALIAS_SYS (obstack_printf, int,
604 (struct obstack *obs, const char *format, ...));
606 _GL_CXXALIASWARN (obstack_printf);
607 # if @REPLACE_OBSTACK_PRINTF@
608 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
609 # define obstack_vprintf rpl_obstack_vprintf
611 _GL_FUNCDECL_RPL (obstack_vprintf, int,
612 (struct obstack *obs, const char *format, va_list args)
613 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
614 _GL_ARG_NONNULL ((1, 2)));
615 _GL_CXXALIAS_RPL (obstack_vprintf, int,
616 (struct obstack *obs, const char *format, va_list args));
618 # if !@HAVE_DECL_OBSTACK_PRINTF@
619 _GL_FUNCDECL_SYS (obstack_vprintf, int,
620 (struct obstack *obs, const char *format, va_list args)
621 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
622 _GL_ARG_NONNULL ((1, 2)));
624 _GL_CXXALIAS_SYS (obstack_vprintf, int,
625 (struct obstack *obs, const char *format, va_list args));
627 _GL_CXXALIASWARN (obstack_vprintf);
631 /* Print a message to standard error, describing the value of ERRNO,
632 (if STRING is not NULL and not empty) prefixed with STRING and ": ",
633 and terminated with a newline. */
634 # if @REPLACE_PERROR@
635 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
636 # define perror rpl_perror
638 _GL_FUNCDECL_RPL (perror, void, (const char *string));
639 _GL_CXXALIAS_RPL (perror, void, (const char *string));
641 _GL_CXXALIAS_SYS (perror, void, (const char *string));
643 _GL_CXXALIASWARN (perror);
644 #elif defined GNULIB_POSIXCHECK
646 /* Assume perror is always declared. */
647 _GL_WARN_ON_USE (perror, "perror is not always POSIX compliant - "
648 "use gnulib module perror for portability");
653 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
655 # define popen rpl_popen
657 _GL_FUNCDECL_RPL (popen, FILE *, (const char *cmd, const char *mode)
658 _GL_ARG_NONNULL ((1, 2)));
659 _GL_CXXALIAS_RPL (popen, FILE *, (const char *cmd, const char *mode));
661 _GL_CXXALIAS_SYS (popen, FILE *, (const char *cmd, const char *mode));
663 _GL_CXXALIASWARN (popen);
664 #elif defined GNULIB_POSIXCHECK
666 # if HAVE_RAW_DECL_POPEN
667 _GL_WARN_ON_USE (popen, "popen is buggy on some platforms - "
668 "use gnulib module popen or pipe for more portability");
672 #if @GNULIB_PRINTF_POSIX@ || @GNULIB_PRINTF@
673 # if (@GNULIB_PRINTF_POSIX@ && @REPLACE_PRINTF@) \
674 || (@GNULIB_PRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
675 # if defined __GNUC__
676 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
677 /* Don't break __attribute__((format(printf,M,N))). */
678 # define printf __printf__
680 _GL_FUNCDECL_RPL_1 (__printf__, int,
681 (const char *format, ...)
682 __asm__ (@ASM_SYMBOL_PREFIX@
683 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_printf))
684 _GL_ATTRIBUTE_FORMAT_PRINTF (1, 2)
685 _GL_ARG_NONNULL ((1)));
686 _GL_CXXALIAS_RPL_1 (printf, __printf__, int, (const char *format, ...));
688 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
689 # define printf rpl_printf
691 _GL_FUNCDECL_RPL (printf, int,
692 (const char *format, ...)
693 _GL_ATTRIBUTE_FORMAT_PRINTF (1, 2)
694 _GL_ARG_NONNULL ((1)));
695 _GL_CXXALIAS_RPL (printf, int, (const char *format, ...));
697 # define GNULIB_overrides_printf 1
699 _GL_CXXALIAS_SYS (printf, int, (const char *format, ...));
701 _GL_CXXALIASWARN (printf);
703 #if !@GNULIB_PRINTF_POSIX@ && defined GNULIB_POSIXCHECK
704 # if !GNULIB_overrides_printf
707 /* Assume printf is always declared. */
708 _GL_WARN_ON_USE (printf, "printf is not always POSIX compliant - "
709 "use gnulib module printf-posix for portable "
714 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
715 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
717 # define putc rpl_fputc
719 _GL_FUNCDECL_RPL (fputc, int, (int c, FILE *stream) _GL_ARG_NONNULL ((2)));
720 _GL_CXXALIAS_RPL_1 (putc, rpl_fputc, int, (int c, FILE *stream));
722 _GL_CXXALIAS_SYS (putc, int, (int c, FILE *stream));
724 _GL_CXXALIASWARN (putc);
728 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
729 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
731 # define putchar rpl_putchar
733 _GL_FUNCDECL_RPL (putchar, int, (int c));
734 _GL_CXXALIAS_RPL (putchar, int, (int c));
736 _GL_CXXALIAS_SYS (putchar, int, (int c));
738 _GL_CXXALIASWARN (putchar);
742 # if @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
743 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
745 # define puts rpl_puts
747 _GL_FUNCDECL_RPL (puts, int, (const char *string) _GL_ARG_NONNULL ((1)));
748 _GL_CXXALIAS_RPL (puts, int, (const char *string));
750 _GL_CXXALIAS_SYS (puts, int, (const char *string));
752 _GL_CXXALIASWARN (puts);
756 # if @REPLACE_REMOVE@
757 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
759 # define remove rpl_remove
761 _GL_FUNCDECL_RPL (remove, int, (const char *name) _GL_ARG_NONNULL ((1)));
762 _GL_CXXALIAS_RPL (remove, int, (const char *name));
764 _GL_CXXALIAS_SYS (remove, int, (const char *name));
766 _GL_CXXALIASWARN (remove);
767 #elif defined GNULIB_POSIXCHECK
769 /* Assume remove is always declared. */
770 _GL_WARN_ON_USE (remove, "remove cannot handle directories on some platforms - "
771 "use gnulib module remove for more portability");
775 # if @REPLACE_RENAME@
776 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
778 # define rename rpl_rename
780 _GL_FUNCDECL_RPL (rename, int,
781 (const char *old_filename, const char *new_filename)
782 _GL_ARG_NONNULL ((1, 2)));
783 _GL_CXXALIAS_RPL (rename, int,
784 (const char *old_filename, const char *new_filename));
786 _GL_CXXALIAS_SYS (rename, int,
787 (const char *old_filename, const char *new_filename));
789 _GL_CXXALIASWARN (rename);
790 #elif defined GNULIB_POSIXCHECK
792 /* Assume rename is always declared. */
793 _GL_WARN_ON_USE (rename, "rename is buggy on some platforms - "
794 "use gnulib module rename for more portability");
797 #if @GNULIB_RENAMEAT@
798 # if @REPLACE_RENAMEAT@
799 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
801 # define renameat rpl_renameat
803 _GL_FUNCDECL_RPL (renameat, int,
804 (int fd1, char const *file1, int fd2, char const *file2)
805 _GL_ARG_NONNULL ((2, 4)));
806 _GL_CXXALIAS_RPL (renameat, int,
807 (int fd1, char const *file1, int fd2, char const *file2));
809 # if !@HAVE_RENAMEAT@
810 _GL_FUNCDECL_SYS (renameat, int,
811 (int fd1, char const *file1, int fd2, char const *file2)
812 _GL_ARG_NONNULL ((2, 4)));
814 _GL_CXXALIAS_SYS (renameat, int,
815 (int fd1, char const *file1, int fd2, char const *file2));
817 _GL_CXXALIASWARN (renameat);
818 #elif defined GNULIB_POSIXCHECK
820 # if HAVE_RAW_DECL_RENAMEAT
821 _GL_WARN_ON_USE (renameat, "renameat is not portable - "
822 "use gnulib module renameat for portability");
826 #if @GNULIB_SNPRINTF@
827 # if @REPLACE_SNPRINTF@
828 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
829 # define snprintf rpl_snprintf
831 _GL_FUNCDECL_RPL (snprintf, int,
832 (char *str, size_t size, const char *format, ...)
833 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 4)
834 _GL_ARG_NONNULL ((3)));
835 _GL_CXXALIAS_RPL (snprintf, int,
836 (char *str, size_t size, const char *format, ...));
838 # if !@HAVE_DECL_SNPRINTF@
839 _GL_FUNCDECL_SYS (snprintf, int,
840 (char *str, size_t size, const char *format, ...)
841 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 4)
842 _GL_ARG_NONNULL ((3)));
844 _GL_CXXALIAS_SYS (snprintf, int,
845 (char *str, size_t size, const char *format, ...));
847 _GL_CXXALIASWARN (snprintf);
848 #elif defined GNULIB_POSIXCHECK
850 # if HAVE_RAW_DECL_SNPRINTF
851 _GL_WARN_ON_USE (snprintf, "snprintf is unportable - "
852 "use gnulib module snprintf for portability");
856 /* Some people would argue that sprintf should be handled like gets
857 (for example, OpenBSD issues a link warning for both functions),
858 since both can cause security holes due to buffer overruns.
859 However, we believe that sprintf can be used safely, and is more
860 efficient than snprintf in those safe cases; and as proof of our
861 belief, we use sprintf in several gnulib modules. So this header
862 intentionally avoids adding a warning to sprintf except when
863 GNULIB_POSIXCHECK is defined. */
865 #if @GNULIB_SPRINTF_POSIX@
866 # if @REPLACE_SPRINTF@
867 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
868 # define sprintf rpl_sprintf
870 _GL_FUNCDECL_RPL (sprintf, int, (char *str, const char *format, ...)
871 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
872 _GL_ARG_NONNULL ((1, 2)));
873 _GL_CXXALIAS_RPL (sprintf, int, (char *str, const char *format, ...));
875 _GL_CXXALIAS_SYS (sprintf, int, (char *str, const char *format, ...));
877 _GL_CXXALIASWARN (sprintf);
878 #elif defined GNULIB_POSIXCHECK
880 /* Assume sprintf is always declared. */
881 _GL_WARN_ON_USE (sprintf, "sprintf is not always POSIX compliant - "
882 "use gnulib module sprintf-posix for portable "
887 # if @REPLACE_TMPFILE@
888 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
889 # define tmpfile rpl_tmpfile
891 _GL_FUNCDECL_RPL (tmpfile, FILE *, (void));
892 _GL_CXXALIAS_RPL (tmpfile, FILE *, (void));
894 _GL_CXXALIAS_SYS (tmpfile, FILE *, (void));
896 _GL_CXXALIASWARN (tmpfile);
897 #elif defined GNULIB_POSIXCHECK
899 # if HAVE_RAW_DECL_TMPFILE
900 _GL_WARN_ON_USE (tmpfile, "tmpfile is not usable on mingw - "
901 "use gnulib module tmpfile for portability");
905 #if @GNULIB_VASPRINTF@
906 /* Write formatted output to a string dynamically allocated with malloc().
907 If the memory allocation succeeds, store the address of the string in
908 *RESULT and return the number of resulting bytes, excluding the trailing
909 NUL. Upon memory allocation error, or some other error, return -1. */
910 # if @REPLACE_VASPRINTF@
911 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
912 # define asprintf rpl_asprintf
914 _GL_FUNCDECL_RPL (asprintf, int,
915 (char **result, const char *format, ...)
916 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
917 _GL_ARG_NONNULL ((1, 2)));
918 _GL_CXXALIAS_RPL (asprintf, int,
919 (char **result, const char *format, ...));
921 # if !@HAVE_VASPRINTF@
922 _GL_FUNCDECL_SYS (asprintf, int,
923 (char **result, const char *format, ...)
924 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 3)
925 _GL_ARG_NONNULL ((1, 2)));
927 _GL_CXXALIAS_SYS (asprintf, int,
928 (char **result, const char *format, ...));
930 _GL_CXXALIASWARN (asprintf);
931 # if @REPLACE_VASPRINTF@
932 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
933 # define vasprintf rpl_vasprintf
935 _GL_FUNCDECL_RPL (vasprintf, int,
936 (char **result, const char *format, va_list args)
937 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
938 _GL_ARG_NONNULL ((1, 2)));
939 _GL_CXXALIAS_RPL (vasprintf, int,
940 (char **result, const char *format, va_list args));
942 # if !@HAVE_VASPRINTF@
943 _GL_FUNCDECL_SYS (vasprintf, int,
944 (char **result, const char *format, va_list args)
945 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
946 _GL_ARG_NONNULL ((1, 2)));
948 _GL_CXXALIAS_SYS (vasprintf, int,
949 (char **result, const char *format, va_list args));
951 _GL_CXXALIASWARN (vasprintf);
954 #if @GNULIB_VDPRINTF@
955 # if @REPLACE_VDPRINTF@
956 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
957 # define vdprintf rpl_vdprintf
959 _GL_FUNCDECL_RPL (vdprintf, int, (int fd, const char *format, va_list args)
960 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
961 _GL_ARG_NONNULL ((2)));
962 _GL_CXXALIAS_RPL (vdprintf, int, (int fd, const char *format, va_list args));
964 # if !@HAVE_VDPRINTF@
965 _GL_FUNCDECL_SYS (vdprintf, int, (int fd, const char *format, va_list args)
966 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
967 _GL_ARG_NONNULL ((2)));
969 /* Need to cast, because on Solaris, the third parameter will likely be
971 _GL_CXXALIAS_SYS_CAST (vdprintf, int,
972 (int fd, const char *format, va_list args));
974 _GL_CXXALIASWARN (vdprintf);
975 #elif defined GNULIB_POSIXCHECK
977 # if HAVE_RAW_DECL_VDPRINTF
978 _GL_WARN_ON_USE (vdprintf, "vdprintf is unportable - "
979 "use gnulib module vdprintf for portability");
983 #if @GNULIB_VFPRINTF_POSIX@ || @GNULIB_VFPRINTF@
984 # if (@GNULIB_VFPRINTF_POSIX@ && @REPLACE_VFPRINTF@) \
985 || (@GNULIB_VFPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
986 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
987 # define vfprintf rpl_vfprintf
989 # define GNULIB_overrides_vfprintf 1
990 _GL_FUNCDECL_RPL (vfprintf, int, (FILE *fp, const char *format, va_list args)
991 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
992 _GL_ARG_NONNULL ((1, 2)));
993 _GL_CXXALIAS_RPL (vfprintf, int, (FILE *fp, const char *format, va_list args));
995 /* Need to cast, because on Solaris, the third parameter is
997 and GCC's fixincludes did not change this to __gnuc_va_list. */
998 _GL_CXXALIAS_SYS_CAST (vfprintf, int,
999 (FILE *fp, const char *format, va_list args));
1001 _GL_CXXALIASWARN (vfprintf);
1003 #if !@GNULIB_VFPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1004 # if !GNULIB_overrides_vfprintf
1007 /* Assume vfprintf is always declared. */
1008 _GL_WARN_ON_USE (vfprintf, "vfprintf is not always POSIX compliant - "
1009 "use gnulib module vfprintf-posix for portable "
1010 "POSIX compliance");
1013 #if @GNULIB_VPRINTF_POSIX@ || @GNULIB_VPRINTF@
1014 # if (@GNULIB_VPRINTF_POSIX@ && @REPLACE_VPRINTF@) \
1015 || (@GNULIB_VPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@)
1016 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1017 # define vprintf rpl_vprintf
1019 # define GNULIB_overrides_vprintf 1
1020 _GL_FUNCDECL_RPL (vprintf, int, (const char *format, va_list args)
1021 _GL_ATTRIBUTE_FORMAT_PRINTF (1, 0)
1022 _GL_ARG_NONNULL ((1)));
1023 _GL_CXXALIAS_RPL (vprintf, int, (const char *format, va_list args));
1025 /* Need to cast, because on Solaris, the second parameter is
1027 and GCC's fixincludes did not change this to __gnuc_va_list. */
1028 _GL_CXXALIAS_SYS_CAST (vprintf, int, (const char *format, va_list args));
1030 _GL_CXXALIASWARN (vprintf);
1032 #if !@GNULIB_VPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1033 # if !GNULIB_overrides_vprintf
1036 /* Assume vprintf is always declared. */
1037 _GL_WARN_ON_USE (vprintf, "vprintf is not always POSIX compliant - "
1038 "use gnulib module vprintf-posix for portable "
1039 "POSIX compliance");
1042 #if @GNULIB_VSNPRINTF@
1043 # if @REPLACE_VSNPRINTF@
1044 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1045 # define vsnprintf rpl_vsnprintf
1047 _GL_FUNCDECL_RPL (vsnprintf, int,
1048 (char *str, size_t size, const char *format, va_list args)
1049 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 0)
1050 _GL_ARG_NONNULL ((3)));
1051 _GL_CXXALIAS_RPL (vsnprintf, int,
1052 (char *str, size_t size, const char *format, va_list args));
1054 # if !@HAVE_DECL_VSNPRINTF@
1055 _GL_FUNCDECL_SYS (vsnprintf, int,
1056 (char *str, size_t size, const char *format, va_list args)
1057 _GL_ATTRIBUTE_FORMAT_PRINTF (3, 0)
1058 _GL_ARG_NONNULL ((3)));
1060 _GL_CXXALIAS_SYS (vsnprintf, int,
1061 (char *str, size_t size, const char *format, va_list args));
1063 _GL_CXXALIASWARN (vsnprintf);
1064 #elif defined GNULIB_POSIXCHECK
1066 # if HAVE_RAW_DECL_VSNPRINTF
1067 _GL_WARN_ON_USE (vsnprintf, "vsnprintf is unportable - "
1068 "use gnulib module vsnprintf for portability");
1072 #if @GNULIB_VSPRINTF_POSIX@
1073 # if @REPLACE_VSPRINTF@
1074 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1075 # define vsprintf rpl_vsprintf
1077 _GL_FUNCDECL_RPL (vsprintf, int,
1078 (char *str, const char *format, va_list args)
1079 _GL_ATTRIBUTE_FORMAT_PRINTF (2, 0)
1080 _GL_ARG_NONNULL ((1, 2)));
1081 _GL_CXXALIAS_RPL (vsprintf, int,
1082 (char *str, const char *format, va_list args));
1084 /* Need to cast, because on Solaris, the third parameter is
1086 and GCC's fixincludes did not change this to __gnuc_va_list. */
1087 _GL_CXXALIAS_SYS_CAST (vsprintf, int,
1088 (char *str, const char *format, va_list args));
1090 _GL_CXXALIASWARN (vsprintf);
1091 #elif defined GNULIB_POSIXCHECK
1093 /* Assume vsprintf is always declared. */
1094 _GL_WARN_ON_USE (vsprintf, "vsprintf is not always POSIX compliant - "
1095 "use gnulib module vsprintf-posix for portable "
1096 "POSIX compliance");
1100 #endif /* _GL_STDIO_H */
1101 #endif /* _GL_STDIO_H */