1 /* A GNU-like <stdio.h>.
3 Copyright (C) 2004, 2007-2020 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, see <https://www.gnu.org/licenses/>. */
19 @PRAGMA_SYSTEM_HEADER@
23 #if defined __need_FILE || defined __need___FILE || defined _GL_ALREADY_INCLUDING_STDIO_H
24 /* Special invocation convention:
25 - Inside glibc header files.
26 - On OSF/1 5.1 we have a sequence of nested includes
27 <stdio.h> -> <getopt.h> -> <ctype.h> -> <sys/localedef.h> ->
28 <sys/lc_core.h> -> <nl_types.h> -> <mesg.h> -> <stdio.h>.
29 In this situation, the functions are not yet declared, therefore we cannot
30 provide the C++ aliases. */
32 #@INCLUDE_NEXT@ @NEXT_STDIO_H@
35 /* Normal invocation convention. */
37 #ifndef _@GUARD_PREFIX@_STDIO_H
39 #define _GL_ALREADY_INCLUDING_STDIO_H
41 /* The include_next requires a split double-inclusion guard. */
42 #@INCLUDE_NEXT@ @NEXT_STDIO_H@
44 #undef _GL_ALREADY_INCLUDING_STDIO_H
46 #ifndef _@GUARD_PREFIX@_STDIO_H
47 #define _@GUARD_PREFIX@_STDIO_H
49 /* Get va_list. Needed on many systems, including glibc 2.8. */
54 /* Get off_t and ssize_t. Needed on many systems, including glibc 2.8
56 May also define off_t to a 64-bit type on native Windows. */
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 #ifndef _GL_ATTRIBUTE_FORMAT
66 # if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7) || defined __clang__
67 # define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
69 # define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
73 /* An __attribute__ __format__ specifier for a function that takes a format
74 string and arguments, where the format string directives are the ones
75 standardized by ISO C99 and POSIX.
76 _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD */
77 /* __gnu_printf__ is supported in GCC >= 4.4. */
78 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
79 # define _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD __gnu_printf__
81 # define _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD __printf__
84 /* An __attribute__ __format__ specifier for a function that takes a format
85 string and arguments, where the format string directives are the ones of the
86 system printf(), rather than the ones standardized by ISO C99 and POSIX.
87 _GL_ATTRIBUTE_SPEC_PRINTF_SYSTEM */
88 /* On mingw, Gnulib sets __USE_MINGW_ANSI_STDIO in order to get closer to
89 the standards. The macro GNULIB_PRINTF_ATTRIBUTE_FLAVOR_GNU indicates
90 whether this change is effective. On older mingw, it is not. */
91 #if GNULIB_PRINTF_ATTRIBUTE_FLAVOR_GNU
92 # define _GL_ATTRIBUTE_SPEC_PRINTF_SYSTEM _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD
94 # define _GL_ATTRIBUTE_SPEC_PRINTF_SYSTEM __printf__
97 /* _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD
98 indicates to GCC that the function takes a format string and arguments,
99 where the format string directives are the ones standardized by ISO C99
101 #define _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD(formatstring_parameter, first_argument) \
102 _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, formatstring_parameter, first_argument))
104 /* _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM is like _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD,
105 except that it indicates to GCC that the supported format string directives
106 are the ones of the system printf(), rather than the ones standardized by
107 ISO C99 and POSIX. */
108 #define _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM(formatstring_parameter, first_argument) \
109 _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_SYSTEM, formatstring_parameter, first_argument))
111 /* _GL_ATTRIBUTE_FORMAT_SCANF
112 indicates to GCC that the function takes a format string and arguments,
113 where the format string directives are the ones standardized by ISO C99
115 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
116 # define _GL_ATTRIBUTE_FORMAT_SCANF(formatstring_parameter, first_argument) \
117 _GL_ATTRIBUTE_FORMAT ((__gnu_scanf__, formatstring_parameter, first_argument))
119 # define _GL_ATTRIBUTE_FORMAT_SCANF(formatstring_parameter, first_argument) \
120 _GL_ATTRIBUTE_FORMAT ((__scanf__, formatstring_parameter, first_argument))
123 /* _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM is like _GL_ATTRIBUTE_FORMAT_SCANF,
124 except that it indicates to GCC that the supported format string directives
125 are the ones of the system scanf(), rather than the ones standardized by
126 ISO C99 and POSIX. */
127 #define _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM(formatstring_parameter, first_argument) \
128 _GL_ATTRIBUTE_FORMAT ((__scanf__, formatstring_parameter, first_argument))
130 /* Solaris 10 and NetBSD 7.0 declare renameat in <unistd.h>, not in <stdio.h>. */
131 /* But in any case avoid namespace pollution on glibc systems. */
132 #if (@GNULIB_RENAMEAT@ || defined GNULIB_POSIXCHECK) && (defined __sun || defined __NetBSD__) \
133 && ! defined __GLIBC__
137 /* Android 4.3 declares renameat in <sys/stat.h>, not in <stdio.h>. */
138 /* But in any case avoid namespace pollution on glibc systems. */
139 #if (@GNULIB_RENAMEAT@ || defined GNULIB_POSIXCHECK) && defined __ANDROID__ \
140 && ! defined __GLIBC__
141 # include <sys/stat.h>
144 /* MSVC declares 'perror' in <stdlib.h>, not in <stdio.h>. We must include
145 it before we #define perror rpl_perror. */
146 /* But in any case avoid namespace pollution on glibc systems. */
147 #if (@GNULIB_PERROR@ || defined GNULIB_POSIXCHECK) \
148 && (defined _WIN32 && ! defined __CYGWIN__) \
149 && ! defined __GLIBC__
153 /* MSVC declares 'remove' in <io.h>, not in <stdio.h>. We must include
154 it before we #define remove rpl_remove. */
155 /* MSVC declares 'rename' in <io.h>, not in <stdio.h>. We must include
156 it before we #define rename rpl_rename. */
157 /* But in any case avoid namespace pollution on glibc systems. */
158 #if (@GNULIB_REMOVE@ || @GNULIB_RENAME@ || defined GNULIB_POSIXCHECK) \
159 && (defined _WIN32 && ! defined __CYGWIN__) \
160 && ! defined __GLIBC__
165 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
167 /* The definition of _GL_ARG_NONNULL is copied here. */
169 /* The definition of _GL_WARN_ON_USE is copied here. */
171 /* Macros for stringification. */
172 #define _GL_STDIO_STRINGIZE(token) #token
173 #define _GL_STDIO_MACROEXPAND_AND_STRINGIZE(token) _GL_STDIO_STRINGIZE(token)
175 /* When also using extern inline, suppress the use of static inline in
176 standard headers of problematic Apple configurations, as Libc at
177 least through Libc-825.26 (2013-04-09) mishandles it; see, e.g.,
178 <https://lists.gnu.org/r/bug-gnulib/2012-12/msg00023.html>.
179 Perhaps Apple will fix this some day. */
180 #if (defined _GL_EXTERN_INLINE_IN_USE && defined __APPLE__ \
181 && defined __GNUC__ && defined __STDC__)
182 # undef putc_unlocked
186 # if @REPLACE_DPRINTF@
187 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
188 # define dprintf rpl_dprintf
190 _GL_FUNCDECL_RPL (dprintf
, int, (int fd
, const char *restrict format
, ...)
191 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
192 _GL_ARG_NONNULL ((2)));
193 _GL_CXXALIAS_RPL (dprintf
, int, (int fd
, const char *restrict format
, ...));
196 _GL_FUNCDECL_SYS (dprintf
, int, (int fd
, const char *restrict format
, ...)
197 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
198 _GL_ARG_NONNULL ((2)));
200 _GL_CXXALIAS_SYS (dprintf
, int, (int fd
, const char *restrict format
, ...));
202 _GL_CXXALIASWARN (dprintf
);
203 #elif defined GNULIB_POSIXCHECK
205 # if HAVE_RAW_DECL_DPRINTF
206 _GL_WARN_ON_USE (dprintf
, "dprintf is unportable - "
207 "use gnulib module dprintf for portability");
212 /* Close STREAM and its underlying file descriptor. */
213 # if @REPLACE_FCLOSE@
214 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
215 # define fclose rpl_fclose
217 _GL_FUNCDECL_RPL (fclose
, int, (FILE *stream
) _GL_ARG_NONNULL ((1)));
218 _GL_CXXALIAS_RPL (fclose
, int, (FILE *stream
));
220 _GL_CXXALIAS_SYS (fclose
, int, (FILE *stream
));
223 _GL_CXXALIASWARN (fclose
);
225 #elif defined GNULIB_POSIXCHECK
227 /* Assume fclose is always declared. */
228 _GL_WARN_ON_USE (fclose
, "fclose is not always POSIX compliant - "
229 "use gnulib module fclose for portable POSIX compliance");
232 #if defined _WIN32 && !defined __CYGWIN__
234 # define fcloseall _fcloseall
238 # if @REPLACE_FDOPEN@
239 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
241 # define fdopen rpl_fdopen
243 _GL_FUNCDECL_RPL (fdopen
, FILE *, (int fd
, const char *mode
)
244 _GL_ARG_NONNULL ((2)));
245 _GL_CXXALIAS_RPL (fdopen
, FILE *, (int fd
, const char *mode
));
246 # elif defined _WIN32 && !defined __CYGWIN__
247 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
249 # define fdopen _fdopen
251 _GL_CXXALIAS_MDA (fdopen
, FILE *, (int fd
, const char *mode
));
253 _GL_CXXALIAS_SYS (fdopen
, FILE *, (int fd
, const char *mode
));
255 _GL_CXXALIASWARN (fdopen
);
256 #elif defined GNULIB_POSIXCHECK
258 /* Assume fdopen is always declared. */
259 _GL_WARN_ON_USE (fdopen
, "fdopen on native Windows platforms is not POSIX compliant - "
260 "use gnulib module fdopen for portability");
261 #elif defined _WIN32 && !defined __CYGWIN__
263 # define fdopen _fdopen
267 /* Flush all pending data on STREAM according to POSIX rules. Both
268 output and seekable input streams are supported.
269 Note! LOSS OF DATA can occur if fflush is applied on an input stream
270 that is _not_seekable_ or on an update stream that is _not_seekable_
271 and in which the most recent operation was input. Seekability can
272 be tested with lseek(fileno(fp),0,SEEK_CUR). */
273 # if @REPLACE_FFLUSH@
274 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
275 # define fflush rpl_fflush
277 _GL_FUNCDECL_RPL (fflush
, int, (FILE *gl_stream
));
278 _GL_CXXALIAS_RPL (fflush
, int, (FILE *gl_stream
));
280 _GL_CXXALIAS_SYS (fflush
, int, (FILE *gl_stream
));
283 _GL_CXXALIASWARN (fflush
);
285 #elif defined GNULIB_POSIXCHECK
287 /* Assume fflush is always declared. */
288 _GL_WARN_ON_USE (fflush
, "fflush is not always POSIX compliant - "
289 "use gnulib module fflush for portable POSIX compliance");
293 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
294 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
296 # define fgetc rpl_fgetc
298 _GL_FUNCDECL_RPL (fgetc
, int, (FILE *stream
) _GL_ARG_NONNULL ((1)));
299 _GL_CXXALIAS_RPL (fgetc
, int, (FILE *stream
));
301 _GL_CXXALIAS_SYS (fgetc
, int, (FILE *stream
));
304 _GL_CXXALIASWARN (fgetc
);
309 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
310 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
312 # define fgets rpl_fgets
314 _GL_FUNCDECL_RPL (fgets
, char *,
315 (char *restrict s
, int n
, FILE *restrict stream
)
316 _GL_ARG_NONNULL ((1, 3)));
317 _GL_CXXALIAS_RPL (fgets
, char *,
318 (char *restrict s
, int n
, FILE *restrict stream
));
320 _GL_CXXALIAS_SYS (fgets
, char *,
321 (char *restrict s
, int n
, FILE *restrict stream
));
324 _GL_CXXALIASWARN (fgets
);
328 #if defined _WIN32 && !defined __CYGWIN__
330 # define fileno _fileno
335 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
337 # define fopen rpl_fopen
339 _GL_FUNCDECL_RPL (fopen
, FILE *,
340 (const char *restrict filename
, const char *restrict mode
)
341 _GL_ARG_NONNULL ((1, 2)));
342 _GL_CXXALIAS_RPL (fopen
, FILE *,
343 (const char *restrict filename
, const char *restrict mode
));
345 _GL_CXXALIAS_SYS (fopen
, FILE *,
346 (const char *restrict filename
, const char *restrict mode
));
349 _GL_CXXALIASWARN (fopen
);
351 #elif defined GNULIB_POSIXCHECK
353 /* Assume fopen is always declared. */
354 _GL_WARN_ON_USE (fopen
, "fopen on native Windows platforms is not POSIX compliant - "
355 "use gnulib module fopen for portability");
358 #if @GNULIB_FPRINTF_POSIX@ || @GNULIB_FPRINTF@
359 # if (@GNULIB_FPRINTF_POSIX@ && @REPLACE_FPRINTF@) \
360 || (@GNULIB_FPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
361 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
362 # define fprintf rpl_fprintf
364 # define GNULIB_overrides_fprintf 1
365 # if @GNULIB_FPRINTF_POSIX@ || @GNULIB_VFPRINTF_POSIX@
366 _GL_FUNCDECL_RPL (fprintf
, int,
367 (FILE *restrict fp
, const char *restrict format
, ...)
368 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
369 _GL_ARG_NONNULL ((1, 2)));
371 _GL_FUNCDECL_RPL (fprintf
, int,
372 (FILE *restrict fp
, const char *restrict format
, ...)
373 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (2, 3)
374 _GL_ARG_NONNULL ((1, 2)));
376 _GL_CXXALIAS_RPL (fprintf
, int,
377 (FILE *restrict fp
, const char *restrict format
, ...));
379 _GL_CXXALIAS_SYS (fprintf
, int,
380 (FILE *restrict fp
, const char *restrict format
, ...));
383 _GL_CXXALIASWARN (fprintf
);
386 #if !@GNULIB_FPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
387 # if !GNULIB_overrides_fprintf
390 /* Assume fprintf is always declared. */
391 _GL_WARN_ON_USE (fprintf
, "fprintf is not always POSIX compliant - "
392 "use gnulib module fprintf-posix for portable "
397 /* Discard all pending buffered I/O data on STREAM.
398 STREAM must not be wide-character oriented.
399 When discarding pending output, the file position is set back to where it
400 was before the write calls. When discarding pending input, the file
401 position is advanced to match the end of the previously read input.
402 Return 0 if successful. Upon error, return -1 and set errno. */
403 # if @REPLACE_FPURGE@
404 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
405 # define fpurge rpl_fpurge
407 _GL_FUNCDECL_RPL (fpurge
, int, (FILE *gl_stream
) _GL_ARG_NONNULL ((1)));
408 _GL_CXXALIAS_RPL (fpurge
, int, (FILE *gl_stream
));
410 # if !@HAVE_DECL_FPURGE@
411 _GL_FUNCDECL_SYS (fpurge
, int, (FILE *gl_stream
) _GL_ARG_NONNULL ((1)));
413 _GL_CXXALIAS_SYS (fpurge
, int, (FILE *gl_stream
));
415 _GL_CXXALIASWARN (fpurge
);
416 #elif defined GNULIB_POSIXCHECK
418 # if HAVE_RAW_DECL_FPURGE
419 _GL_WARN_ON_USE (fpurge
, "fpurge is not always present - "
420 "use gnulib module fpurge for portability");
425 # if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
426 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
428 # define fputc rpl_fputc
430 _GL_FUNCDECL_RPL (fputc
, int, (int c
, FILE *stream
) _GL_ARG_NONNULL ((2)));
431 _GL_CXXALIAS_RPL (fputc
, int, (int c
, FILE *stream
));
433 _GL_CXXALIAS_SYS (fputc
, int, (int c
, FILE *stream
));
436 _GL_CXXALIASWARN (fputc
);
441 # if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
442 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
444 # define fputs rpl_fputs
446 _GL_FUNCDECL_RPL (fputs
, int,
447 (const char *restrict string
, FILE *restrict stream
)
448 _GL_ARG_NONNULL ((1, 2)));
449 _GL_CXXALIAS_RPL (fputs
, int,
450 (const char *restrict string
, FILE *restrict stream
));
452 _GL_CXXALIAS_SYS (fputs
, int,
453 (const char *restrict string
, FILE *restrict stream
));
456 _GL_CXXALIASWARN (fputs
);
461 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
462 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
464 # define fread rpl_fread
466 _GL_FUNCDECL_RPL (fread
, size_t,
467 (void *restrict ptr
, size_t s
, size_t n
,
468 FILE *restrict stream
)
469 _GL_ARG_NONNULL ((4)));
470 _GL_CXXALIAS_RPL (fread
, size_t,
471 (void *restrict ptr
, size_t s
, size_t n
,
472 FILE *restrict stream
));
474 _GL_CXXALIAS_SYS (fread
, size_t,
475 (void *restrict ptr
, size_t s
, size_t n
,
476 FILE *restrict stream
));
479 _GL_CXXALIASWARN (fread
);
484 # if @REPLACE_FREOPEN@
485 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
487 # define freopen rpl_freopen
489 _GL_FUNCDECL_RPL (freopen
, FILE *,
490 (const char *restrict filename
, const char *restrict mode
,
491 FILE *restrict stream
)
492 _GL_ARG_NONNULL ((2, 3)));
493 _GL_CXXALIAS_RPL (freopen
, FILE *,
494 (const char *restrict filename
, const char *restrict mode
,
495 FILE *restrict stream
));
497 _GL_CXXALIAS_SYS (freopen
, FILE *,
498 (const char *restrict filename
, const char *restrict mode
,
499 FILE *restrict stream
));
502 _GL_CXXALIASWARN (freopen
);
504 #elif defined GNULIB_POSIXCHECK
506 /* Assume freopen is always declared. */
507 _GL_WARN_ON_USE (freopen
,
508 "freopen on native Windows platforms is not POSIX compliant - "
509 "use gnulib module freopen for portability");
513 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
514 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
516 # define fscanf rpl_fscanf
518 _GL_FUNCDECL_RPL (fscanf
, int,
519 (FILE *restrict stream
, const char *restrict format
, ...)
520 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (2, 3)
521 _GL_ARG_NONNULL ((1, 2)));
522 _GL_CXXALIAS_RPL (fscanf
, int,
523 (FILE *restrict stream
, const char *restrict format
, ...));
525 _GL_CXXALIAS_SYS (fscanf
, int,
526 (FILE *restrict stream
, const char *restrict format
, ...));
529 _GL_CXXALIASWARN (fscanf
);
534 /* Set up the following warnings, based on which modules are in use.
535 GNU Coding Standards discourage the use of fseek, since it imposes
536 an arbitrary limitation on some 32-bit hosts. Remember that the
537 fseek module depends on the fseeko module, so we only have three
540 1. The developer is not using either module. Issue a warning under
541 GNULIB_POSIXCHECK for both functions, to remind them that both
542 functions have bugs on some systems. _GL_NO_LARGE_FILES has no
543 impact on this warning.
545 2. The developer is using both modules. They may be unaware of the
546 arbitrary limitations of fseek, so issue a warning under
547 GNULIB_POSIXCHECK. On the other hand, they may be using both
548 modules intentionally, so the developer can define
549 _GL_NO_LARGE_FILES in the compilation units where the use of fseek
550 is safe, to silence the warning.
552 3. The developer is using the fseeko module, but not fseek. Gnulib
553 guarantees that fseek will still work around platform bugs in that
554 case, but we presume that the developer is aware of the pitfalls of
555 fseek and was trying to avoid it, so issue a warning even when
556 GNULIB_POSIXCHECK is undefined. Again, _GL_NO_LARGE_FILES can be
557 defined to silence the warning in particular compilation units.
558 In C++ compilations with GNULIB_NAMESPACE, in order to avoid that
559 fseek gets defined as a macro, it is recommended that the developer
560 uses the fseek module, even if he is not calling the fseek function.
562 Most gnulib clients that perform stream operations should fall into
566 # if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
567 # define _GL_FSEEK_WARN /* Category 2, above. */
571 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
573 # define fseek rpl_fseek
575 _GL_FUNCDECL_RPL (fseek
, int, (FILE *fp
, long offset
, int whence
)
576 _GL_ARG_NONNULL ((1)));
577 _GL_CXXALIAS_RPL (fseek
, int, (FILE *fp
, long offset
, int whence
));
579 _GL_CXXALIAS_SYS (fseek
, int, (FILE *fp
, long offset
, int whence
));
582 _GL_CXXALIASWARN (fseek
);
587 # if !@GNULIB_FSEEK@ && !defined _GL_NO_LARGE_FILES
588 # define _GL_FSEEK_WARN /* Category 3, above. */
591 # if @REPLACE_FSEEKO@
592 /* Provide an fseeko function that is aware of a preceding fflush(), and which
594 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
596 # define fseeko rpl_fseeko
598 _GL_FUNCDECL_RPL (fseeko
, int, (FILE *fp
, off_t offset
, int whence
)
599 _GL_ARG_NONNULL ((1)));
600 _GL_CXXALIAS_RPL (fseeko
, int, (FILE *fp
, off_t offset
, int whence
));
602 # if ! @HAVE_DECL_FSEEKO@
603 _GL_FUNCDECL_SYS (fseeko
, int, (FILE *fp
, off_t offset
, int whence
)
604 _GL_ARG_NONNULL ((1)));
606 _GL_CXXALIAS_SYS (fseeko
, int, (FILE *fp
, off_t offset
, int whence
));
608 _GL_CXXALIASWARN (fseeko
);
609 #elif defined GNULIB_POSIXCHECK
610 # define _GL_FSEEK_WARN /* Category 1, above. */
613 # if HAVE_RAW_DECL_FSEEKO
614 _GL_WARN_ON_USE (fseeko
, "fseeko is unportable - "
615 "use gnulib module fseeko for portability");
619 #ifdef _GL_FSEEK_WARN
620 # undef _GL_FSEEK_WARN
621 /* Here, either fseek is undefined (but C89 guarantees that it is
622 declared), or it is defined as rpl_fseek (declared above). */
623 _GL_WARN_ON_USE (fseek
, "fseek cannot handle files larger than 4 GB "
624 "on 32-bit platforms - "
625 "use fseeko function for handling of large files");
629 /* ftell, ftello. See the comments on fseek/fseeko. */
632 # if defined GNULIB_POSIXCHECK && !defined _GL_NO_LARGE_FILES
633 # define _GL_FTELL_WARN /* Category 2, above. */
637 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
639 # define ftell rpl_ftell
641 _GL_FUNCDECL_RPL (ftell
, long, (FILE *fp
) _GL_ARG_NONNULL ((1)));
642 _GL_CXXALIAS_RPL (ftell
, long, (FILE *fp
));
644 _GL_CXXALIAS_SYS (ftell
, long, (FILE *fp
));
647 _GL_CXXALIASWARN (ftell
);
652 # if !@GNULIB_FTELL@ && !defined _GL_NO_LARGE_FILES
653 # define _GL_FTELL_WARN /* Category 3, above. */
656 # if @REPLACE_FTELLO@
657 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
659 # define ftello rpl_ftello
661 _GL_FUNCDECL_RPL (ftello
, off_t
, (FILE *fp
) _GL_ARG_NONNULL ((1)));
662 _GL_CXXALIAS_RPL (ftello
, off_t
, (FILE *fp
));
664 # if ! @HAVE_DECL_FTELLO@
665 _GL_FUNCDECL_SYS (ftello
, off_t
, (FILE *fp
) _GL_ARG_NONNULL ((1)));
667 _GL_CXXALIAS_SYS (ftello
, off_t
, (FILE *fp
));
669 _GL_CXXALIASWARN (ftello
);
670 #elif defined GNULIB_POSIXCHECK
671 # define _GL_FTELL_WARN /* Category 1, above. */
674 # if HAVE_RAW_DECL_FTELLO
675 _GL_WARN_ON_USE (ftello
, "ftello is unportable - "
676 "use gnulib module ftello for portability");
680 #ifdef _GL_FTELL_WARN
681 # undef _GL_FTELL_WARN
682 /* Here, either ftell is undefined (but C89 guarantees that it is
683 declared), or it is defined as rpl_ftell (declared above). */
684 _GL_WARN_ON_USE (ftell
, "ftell cannot handle files larger than 4 GB "
685 "on 32-bit platforms - "
686 "use ftello function for handling of large files");
691 # if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
692 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
694 # define fwrite rpl_fwrite
696 _GL_FUNCDECL_RPL (fwrite
, size_t,
697 (const void *restrict ptr
, size_t s
, size_t n
,
698 FILE *restrict stream
)
699 _GL_ARG_NONNULL ((1, 4)));
700 _GL_CXXALIAS_RPL (fwrite
, size_t,
701 (const void *restrict ptr
, size_t s
, size_t n
,
702 FILE *restrict stream
));
704 _GL_CXXALIAS_SYS (fwrite
, size_t,
705 (const void *restrict ptr
, size_t s
, size_t n
,
706 FILE *restrict stream
));
708 /* Work around bug 11959 when fortifying glibc 2.4 through 2.15
709 <https://sourceware.org/bugzilla/show_bug.cgi?id=11959>,
710 which sometimes causes an unwanted diagnostic for fwrite calls.
711 This affects only function declaration attributes under certain
712 versions of gcc and clang, and is not needed for C++. */
713 # if (0 < __USE_FORTIFY_LEVEL \
714 && __GLIBC__ == 2 && 4 <= __GLIBC_MINOR__ && __GLIBC_MINOR__ <= 15 \
715 && 3 < __GNUC__ + (4 <= __GNUC_MINOR__) \
716 && !defined __cplusplus)
718 # undef fwrite_unlocked
719 extern size_t __REDIRECT (rpl_fwrite
,
720 (const void *__restrict
, size_t, size_t,
723 extern size_t __REDIRECT (rpl_fwrite_unlocked
,
724 (const void *__restrict
, size_t, size_t,
727 # define fwrite rpl_fwrite
728 # define fwrite_unlocked rpl_fwrite_unlocked
732 _GL_CXXALIASWARN (fwrite
);
737 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
738 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
740 # define getc rpl_fgetc
742 _GL_FUNCDECL_RPL (fgetc
, int, (FILE *stream
) _GL_ARG_NONNULL ((1)));
743 _GL_CXXALIAS_RPL_1 (getc
, rpl_fgetc
, int, (FILE *stream
));
745 _GL_CXXALIAS_SYS (getc
, int, (FILE *stream
));
748 _GL_CXXALIASWARN (getc
);
753 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
754 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
756 # define getchar rpl_getchar
758 _GL_FUNCDECL_RPL (getchar
, int, (void));
759 _GL_CXXALIAS_RPL (getchar
, int, (void));
761 _GL_CXXALIAS_SYS (getchar
, int, (void));
764 _GL_CXXALIASWARN (getchar
);
768 #if @GNULIB_GETDELIM@
769 /* Read input, up to (and including) the next occurrence of DELIMITER, from
770 STREAM, store it in *LINEPTR (and NUL-terminate it).
771 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
772 bytes of space. It is realloc'd as necessary.
773 Return the number of bytes read and stored at *LINEPTR (not including the
774 NUL terminator), or -1 on error or EOF. */
775 # if @REPLACE_GETDELIM@
776 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
778 # define getdelim rpl_getdelim
780 _GL_FUNCDECL_RPL (getdelim
, ssize_t
,
781 (char **restrict lineptr
, size_t *restrict linesize
,
783 FILE *restrict stream
)
784 _GL_ARG_NONNULL ((1, 2, 4)));
785 _GL_CXXALIAS_RPL (getdelim
, ssize_t
,
786 (char **restrict lineptr
, size_t *restrict linesize
,
788 FILE *restrict stream
));
790 # if !@HAVE_DECL_GETDELIM@
791 _GL_FUNCDECL_SYS (getdelim
, ssize_t
,
792 (char **restrict lineptr
, size_t *restrict linesize
,
794 FILE *restrict stream
)
795 _GL_ARG_NONNULL ((1, 2, 4)));
797 _GL_CXXALIAS_SYS (getdelim
, ssize_t
,
798 (char **restrict lineptr
, size_t *restrict linesize
,
800 FILE *restrict stream
));
802 _GL_CXXALIASWARN (getdelim
);
803 #elif defined GNULIB_POSIXCHECK
805 # if HAVE_RAW_DECL_GETDELIM
806 _GL_WARN_ON_USE (getdelim
, "getdelim is unportable - "
807 "use gnulib module getdelim for portability");
812 /* Read a line, up to (and including) the next newline, from STREAM, store it
813 in *LINEPTR (and NUL-terminate it).
814 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
815 bytes of space. It is realloc'd as necessary.
816 Return the number of bytes read and stored at *LINEPTR (not including the
817 NUL terminator), or -1 on error or EOF. */
818 # if @REPLACE_GETLINE@
819 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
821 # define getline rpl_getline
823 _GL_FUNCDECL_RPL (getline
, ssize_t
,
824 (char **restrict lineptr
, size_t *restrict linesize
,
825 FILE *restrict stream
)
826 _GL_ARG_NONNULL ((1, 2, 3)));
827 _GL_CXXALIAS_RPL (getline
, ssize_t
,
828 (char **restrict lineptr
, size_t *restrict linesize
,
829 FILE *restrict stream
));
831 # if !@HAVE_DECL_GETLINE@
832 _GL_FUNCDECL_SYS (getline
, ssize_t
,
833 (char **restrict lineptr
, size_t *restrict linesize
,
834 FILE *restrict stream
)
835 _GL_ARG_NONNULL ((1, 2, 3)));
837 _GL_CXXALIAS_SYS (getline
, ssize_t
,
838 (char **restrict lineptr
, size_t *restrict linesize
,
839 FILE *restrict stream
));
841 # if @HAVE_DECL_GETLINE@
842 _GL_CXXALIASWARN (getline
);
844 #elif defined GNULIB_POSIXCHECK
846 # if HAVE_RAW_DECL_GETLINE
847 _GL_WARN_ON_USE (getline
, "getline is unportable - "
848 "use gnulib module getline for portability");
852 /* It is very rare that the developer ever has full control of stdin,
853 so any use of gets warrants an unconditional warning; besides, C11
856 #if HAVE_RAW_DECL_GETS && !defined __cplusplus
857 _GL_WARN_ON_USE (gets
, "gets is a security hole - use fgets instead");
860 #if defined _WIN32 && !defined __CYGWIN__
865 #if @GNULIB_OBSTACK_PRINTF@ || @GNULIB_OBSTACK_PRINTF_POSIX@
867 /* Grow an obstack with formatted output. Return the number of
868 bytes added to OBS. No trailing nul byte is added, and the
869 object should be closed with obstack_finish before use. Upon
870 memory allocation error, call obstack_alloc_failed_handler. Upon
871 other error, return -1. */
872 # if @REPLACE_OBSTACK_PRINTF@
873 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
874 # define obstack_printf rpl_obstack_printf
876 _GL_FUNCDECL_RPL (obstack_printf
, int,
877 (struct obstack
*obs
, const char *format
, ...)
878 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
879 _GL_ARG_NONNULL ((1, 2)));
880 _GL_CXXALIAS_RPL (obstack_printf
, int,
881 (struct obstack
*obs
, const char *format
, ...));
883 # if !@HAVE_DECL_OBSTACK_PRINTF@
884 _GL_FUNCDECL_SYS (obstack_printf
, int,
885 (struct obstack
*obs
, const char *format
, ...)
886 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
887 _GL_ARG_NONNULL ((1, 2)));
889 _GL_CXXALIAS_SYS (obstack_printf
, int,
890 (struct obstack
*obs
, const char *format
, ...));
892 _GL_CXXALIASWARN (obstack_printf
);
893 # if @REPLACE_OBSTACK_PRINTF@
894 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
895 # define obstack_vprintf rpl_obstack_vprintf
897 _GL_FUNCDECL_RPL (obstack_vprintf
, int,
898 (struct obstack
*obs
, const char *format
, va_list args
)
899 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
900 _GL_ARG_NONNULL ((1, 2)));
901 _GL_CXXALIAS_RPL (obstack_vprintf
, int,
902 (struct obstack
*obs
, const char *format
, va_list args
));
904 # if !@HAVE_DECL_OBSTACK_PRINTF@
905 _GL_FUNCDECL_SYS (obstack_vprintf
, int,
906 (struct obstack
*obs
, const char *format
, va_list args
)
907 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
908 _GL_ARG_NONNULL ((1, 2)));
910 _GL_CXXALIAS_SYS (obstack_vprintf
, int,
911 (struct obstack
*obs
, const char *format
, va_list args
));
913 _GL_CXXALIASWARN (obstack_vprintf
);
918 _GL_FUNCDECL_SYS (pclose
, int, (FILE *stream
) _GL_ARG_NONNULL ((1)));
920 _GL_CXXALIAS_SYS (pclose
, int, (FILE *stream
));
921 _GL_CXXALIASWARN (pclose
);
922 #elif defined GNULIB_POSIXCHECK
924 # if HAVE_RAW_DECL_PCLOSE
925 _GL_WARN_ON_USE (pclose
, "pclose is unportable - "
926 "use gnulib module pclose for more portability");
931 /* Print a message to standard error, describing the value of ERRNO,
932 (if STRING is not NULL and not empty) prefixed with STRING and ": ",
933 and terminated with a newline. */
934 # if @REPLACE_PERROR@
935 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
936 # define perror rpl_perror
938 _GL_FUNCDECL_RPL (perror
, void, (const char *string
));
939 _GL_CXXALIAS_RPL (perror
, void, (const char *string
));
941 _GL_CXXALIAS_SYS (perror
, void, (const char *string
));
944 _GL_CXXALIASWARN (perror
);
946 #elif defined GNULIB_POSIXCHECK
948 /* Assume perror is always declared. */
949 _GL_WARN_ON_USE (perror
, "perror is not always POSIX compliant - "
950 "use gnulib module perror for portability");
955 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
957 # define popen rpl_popen
959 _GL_FUNCDECL_RPL (popen
, FILE *, (const char *cmd
, const char *mode
)
960 _GL_ARG_NONNULL ((1, 2)));
961 _GL_CXXALIAS_RPL (popen
, FILE *, (const char *cmd
, const char *mode
));
964 _GL_FUNCDECL_SYS (popen
, FILE *, (const char *cmd
, const char *mode
)
965 _GL_ARG_NONNULL ((1, 2)));
967 _GL_CXXALIAS_SYS (popen
, FILE *, (const char *cmd
, const char *mode
));
969 _GL_CXXALIASWARN (popen
);
970 #elif defined GNULIB_POSIXCHECK
972 # if HAVE_RAW_DECL_POPEN
973 _GL_WARN_ON_USE (popen
, "popen is buggy on some platforms - "
974 "use gnulib module popen or pipe for more portability");
978 #if @GNULIB_PRINTF_POSIX@ || @GNULIB_PRINTF@
979 # if (@GNULIB_PRINTF_POSIX@ && @REPLACE_PRINTF@) \
980 || (@GNULIB_PRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
981 # if defined __GNUC__ || defined __clang__
982 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
983 /* Don't break __attribute__((format(printf,M,N))). */
984 # define printf __printf__
986 # if @GNULIB_PRINTF_POSIX@ || @GNULIB_VFPRINTF_POSIX@
987 _GL_FUNCDECL_RPL_1 (__printf__
, int,
988 (const char *restrict format
, ...)
989 __asm__ (@ASM_SYMBOL_PREFIX@
990 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_printf
))
991 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (1, 2)
992 _GL_ARG_NONNULL ((1)));
994 _GL_FUNCDECL_RPL_1 (__printf__
, int,
995 (const char *restrict format
, ...)
996 __asm__ (@ASM_SYMBOL_PREFIX@
997 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_printf
))
998 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (1, 2)
999 _GL_ARG_NONNULL ((1)));
1001 _GL_CXXALIAS_RPL_1 (printf
, __printf__
, int, (const char *format
, ...));
1003 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1004 # define printf rpl_printf
1006 _GL_FUNCDECL_RPL (printf
, int,
1007 (const char *restrict format
, ...)
1008 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (1, 2)
1009 _GL_ARG_NONNULL ((1)));
1010 _GL_CXXALIAS_RPL (printf
, int, (const char *restrict format
, ...));
1012 # define GNULIB_overrides_printf 1
1014 _GL_CXXALIAS_SYS (printf
, int, (const char *restrict format
, ...));
1017 _GL_CXXALIASWARN (printf
);
1020 #if !@GNULIB_PRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1021 # if !GNULIB_overrides_printf
1024 /* Assume printf is always declared. */
1025 _GL_WARN_ON_USE (printf
, "printf is not always POSIX compliant - "
1026 "use gnulib module printf-posix for portable "
1027 "POSIX compliance");
1031 # if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
1032 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1034 # define putc rpl_fputc
1036 _GL_FUNCDECL_RPL (fputc
, int, (int c
, FILE *stream
) _GL_ARG_NONNULL ((2)));
1037 _GL_CXXALIAS_RPL_1 (putc
, rpl_fputc
, int, (int c
, FILE *stream
));
1039 _GL_CXXALIAS_SYS (putc
, int, (int c
, FILE *stream
));
1042 _GL_CXXALIASWARN (putc
);
1046 #if @GNULIB_PUTCHAR@
1047 # if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
1048 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1050 # define putchar rpl_putchar
1052 _GL_FUNCDECL_RPL (putchar
, int, (int c
));
1053 _GL_CXXALIAS_RPL (putchar
, int, (int c
));
1055 _GL_CXXALIAS_SYS (putchar
, int, (int c
));
1058 _GL_CXXALIASWARN (putchar
);
1063 # if @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)
1064 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1066 # define puts rpl_puts
1068 _GL_FUNCDECL_RPL (puts
, int, (const char *string
) _GL_ARG_NONNULL ((1)));
1069 _GL_CXXALIAS_RPL (puts
, int, (const char *string
));
1071 _GL_CXXALIAS_SYS (puts
, int, (const char *string
));
1074 _GL_CXXALIASWARN (puts
);
1078 #if defined _WIN32 && !defined __CYGWIN__
1084 # if @REPLACE_REMOVE@
1085 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1087 # define remove rpl_remove
1089 _GL_FUNCDECL_RPL (remove
, int, (const char *name
) _GL_ARG_NONNULL ((1)));
1090 _GL_CXXALIAS_RPL (remove
, int, (const char *name
));
1092 _GL_CXXALIAS_SYS (remove
, int, (const char *name
));
1095 _GL_CXXALIASWARN (remove
);
1097 #elif defined GNULIB_POSIXCHECK
1099 /* Assume remove is always declared. */
1100 _GL_WARN_ON_USE (remove
, "remove cannot handle directories on some platforms - "
1101 "use gnulib module remove for more portability");
1105 # if @REPLACE_RENAME@
1106 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1108 # define rename rpl_rename
1110 _GL_FUNCDECL_RPL (rename
, int,
1111 (const char *old_filename
, const char *new_filename
)
1112 _GL_ARG_NONNULL ((1, 2)));
1113 _GL_CXXALIAS_RPL (rename
, int,
1114 (const char *old_filename
, const char *new_filename
));
1116 _GL_CXXALIAS_SYS (rename
, int,
1117 (const char *old_filename
, const char *new_filename
));
1120 _GL_CXXALIASWARN (rename
);
1122 #elif defined GNULIB_POSIXCHECK
1124 /* Assume rename is always declared. */
1125 _GL_WARN_ON_USE (rename
, "rename is buggy on some platforms - "
1126 "use gnulib module rename for more portability");
1129 #if @GNULIB_RENAMEAT@
1130 # if @REPLACE_RENAMEAT@
1131 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1133 # define renameat rpl_renameat
1135 _GL_FUNCDECL_RPL (renameat
, int,
1136 (int fd1
, char const *file1
, int fd2
, char const *file2
)
1137 _GL_ARG_NONNULL ((2, 4)));
1138 _GL_CXXALIAS_RPL (renameat
, int,
1139 (int fd1
, char const *file1
, int fd2
, char const *file2
));
1141 # if !@HAVE_RENAMEAT@
1142 _GL_FUNCDECL_SYS (renameat
, int,
1143 (int fd1
, char const *file1
, int fd2
, char const *file2
)
1144 _GL_ARG_NONNULL ((2, 4)));
1146 _GL_CXXALIAS_SYS (renameat
, int,
1147 (int fd1
, char const *file1
, int fd2
, char const *file2
));
1149 _GL_CXXALIASWARN (renameat
);
1150 #elif defined GNULIB_POSIXCHECK
1152 # if HAVE_RAW_DECL_RENAMEAT
1153 _GL_WARN_ON_USE (renameat
, "renameat is not portable - "
1154 "use gnulib module renameat for portability");
1159 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
1160 # if defined __GNUC__ || defined __clang__
1161 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1163 /* Don't break __attribute__((format(scanf,M,N))). */
1164 # define scanf __scanf__
1166 _GL_FUNCDECL_RPL_1 (__scanf__
, int,
1167 (const char *restrict format
, ...)
1168 __asm__ (@ASM_SYMBOL_PREFIX@
1169 _GL_STDIO_MACROEXPAND_AND_STRINGIZE(rpl_scanf
))
1170 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (1, 2)
1171 _GL_ARG_NONNULL ((1)));
1172 _GL_CXXALIAS_RPL_1 (scanf
, __scanf__
, int, (const char *restrict format
, ...));
1174 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1176 # define scanf rpl_scanf
1178 _GL_FUNCDECL_RPL (scanf
, int, (const char *restrict format
, ...)
1179 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (1, 2)
1180 _GL_ARG_NONNULL ((1)));
1181 _GL_CXXALIAS_RPL (scanf
, int, (const char *restrict format
, ...));
1184 _GL_CXXALIAS_SYS (scanf
, int, (const char *restrict format
, ...));
1187 _GL_CXXALIASWARN (scanf
);
1191 #if @GNULIB_SNPRINTF@
1192 # if @REPLACE_SNPRINTF@
1193 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1194 # define snprintf rpl_snprintf
1196 _GL_FUNCDECL_RPL (snprintf
, int,
1197 (char *restrict str
, size_t size
,
1198 const char *restrict format
, ...)
1199 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (3, 4)
1200 _GL_ARG_NONNULL ((3)));
1201 _GL_CXXALIAS_RPL (snprintf
, int,
1202 (char *restrict str
, size_t size
,
1203 const char *restrict format
, ...));
1205 # if !@HAVE_DECL_SNPRINTF@
1206 _GL_FUNCDECL_SYS (snprintf
, int,
1207 (char *restrict str
, size_t size
,
1208 const char *restrict format
, ...)
1209 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (3, 4)
1210 _GL_ARG_NONNULL ((3)));
1212 _GL_CXXALIAS_SYS (snprintf
, int,
1213 (char *restrict str
, size_t size
,
1214 const char *restrict format
, ...));
1217 _GL_CXXALIASWARN (snprintf
);
1219 #elif defined GNULIB_POSIXCHECK
1221 # if HAVE_RAW_DECL_SNPRINTF
1222 _GL_WARN_ON_USE (snprintf
, "snprintf is unportable - "
1223 "use gnulib module snprintf for portability");
1227 /* Some people would argue that all sprintf uses should be warned about
1228 (for example, OpenBSD issues a link warning for it),
1229 since it can cause security holes due to buffer overruns.
1230 However, we believe that sprintf can be used safely, and is more
1231 efficient than snprintf in those safe cases; and as proof of our
1232 belief, we use sprintf in several gnulib modules. So this header
1233 intentionally avoids adding a warning to sprintf except when
1234 GNULIB_POSIXCHECK is defined. */
1236 #if @GNULIB_SPRINTF_POSIX@
1237 # if @REPLACE_SPRINTF@
1238 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1239 # define sprintf rpl_sprintf
1241 _GL_FUNCDECL_RPL (sprintf
, int,
1242 (char *restrict str
, const char *restrict format
, ...)
1243 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
1244 _GL_ARG_NONNULL ((1, 2)));
1245 _GL_CXXALIAS_RPL (sprintf
, int,
1246 (char *restrict str
, const char *restrict format
, ...));
1248 _GL_CXXALIAS_SYS (sprintf
, int,
1249 (char *restrict str
, const char *restrict format
, ...));
1252 _GL_CXXALIASWARN (sprintf
);
1254 #elif defined GNULIB_POSIXCHECK
1256 /* Assume sprintf is always declared. */
1257 _GL_WARN_ON_USE (sprintf
, "sprintf is not always POSIX compliant - "
1258 "use gnulib module sprintf-posix for portable "
1259 "POSIX compliance");
1262 #if defined _WIN32 && !defined __CYGWIN__
1264 # define tempnam _tempnam
1267 #if @GNULIB_TMPFILE@
1268 # if @REPLACE_TMPFILE@
1269 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1270 # define tmpfile rpl_tmpfile
1272 _GL_FUNCDECL_RPL (tmpfile
, FILE *, (void));
1273 _GL_CXXALIAS_RPL (tmpfile
, FILE *, (void));
1275 _GL_CXXALIAS_SYS (tmpfile
, FILE *, (void));
1278 _GL_CXXALIASWARN (tmpfile
);
1280 #elif defined GNULIB_POSIXCHECK
1282 # if HAVE_RAW_DECL_TMPFILE
1283 _GL_WARN_ON_USE (tmpfile
, "tmpfile is not usable on mingw - "
1284 "use gnulib module tmpfile for portability");
1288 #if @GNULIB_VASPRINTF@
1289 /* Write formatted output to a string dynamically allocated with malloc().
1290 If the memory allocation succeeds, store the address of the string in
1291 *RESULT and return the number of resulting bytes, excluding the trailing
1292 NUL. Upon memory allocation error, or some other error, return -1. */
1293 # if @REPLACE_VASPRINTF@
1294 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1295 # define asprintf rpl_asprintf
1297 _GL_FUNCDECL_RPL (asprintf
, int,
1298 (char **result
, const char *format
, ...)
1299 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
1300 _GL_ARG_NONNULL ((1, 2)));
1301 _GL_CXXALIAS_RPL (asprintf
, int,
1302 (char **result
, const char *format
, ...));
1304 # if !@HAVE_VASPRINTF@
1305 _GL_FUNCDECL_SYS (asprintf
, int,
1306 (char **result
, const char *format
, ...)
1307 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 3)
1308 _GL_ARG_NONNULL ((1, 2)));
1310 _GL_CXXALIAS_SYS (asprintf
, int,
1311 (char **result
, const char *format
, ...));
1313 _GL_CXXALIASWARN (asprintf
);
1314 # if @REPLACE_VASPRINTF@
1315 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1316 # define vasprintf rpl_vasprintf
1318 _GL_FUNCDECL_RPL (vasprintf
, int,
1319 (char **result
, const char *format
, va_list args
)
1320 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
1321 _GL_ARG_NONNULL ((1, 2)));
1322 _GL_CXXALIAS_RPL (vasprintf
, int,
1323 (char **result
, const char *format
, va_list args
));
1325 # if !@HAVE_VASPRINTF@
1326 _GL_FUNCDECL_SYS (vasprintf
, int,
1327 (char **result
, const char *format
, va_list args
)
1328 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
1329 _GL_ARG_NONNULL ((1, 2)));
1331 _GL_CXXALIAS_SYS (vasprintf
, int,
1332 (char **result
, const char *format
, va_list args
));
1334 _GL_CXXALIASWARN (vasprintf
);
1337 #if @GNULIB_VDPRINTF@
1338 # if @REPLACE_VDPRINTF@
1339 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1340 # define vdprintf rpl_vdprintf
1342 _GL_FUNCDECL_RPL (vdprintf
, int,
1343 (int fd
, const char *restrict format
, va_list args
)
1344 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
1345 _GL_ARG_NONNULL ((2)));
1346 _GL_CXXALIAS_RPL (vdprintf
, int,
1347 (int fd
, const char *restrict format
, va_list args
));
1349 # if !@HAVE_VDPRINTF@
1350 _GL_FUNCDECL_SYS (vdprintf
, int,
1351 (int fd
, const char *restrict format
, va_list args
)
1352 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
1353 _GL_ARG_NONNULL ((2)));
1355 /* Need to cast, because on Solaris, the third parameter will likely be
1357 _GL_CXXALIAS_SYS_CAST (vdprintf
, int,
1358 (int fd
, const char *restrict format
, va_list args
));
1361 _GL_CXXALIASWARN (vdprintf
);
1363 #elif defined GNULIB_POSIXCHECK
1365 # if HAVE_RAW_DECL_VDPRINTF
1366 _GL_WARN_ON_USE (vdprintf
, "vdprintf is unportable - "
1367 "use gnulib module vdprintf for portability");
1371 #if @GNULIB_VFPRINTF_POSIX@ || @GNULIB_VFPRINTF@
1372 # if (@GNULIB_VFPRINTF_POSIX@ && @REPLACE_VFPRINTF@) \
1373 || (@GNULIB_VFPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
1374 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1375 # define vfprintf rpl_vfprintf
1377 # define GNULIB_overrides_vfprintf 1
1378 # if @GNULIB_VFPRINTF_POSIX@
1379 _GL_FUNCDECL_RPL (vfprintf
, int,
1381 const char *restrict format
, va_list args
)
1382 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
1383 _GL_ARG_NONNULL ((1, 2)));
1385 _GL_FUNCDECL_RPL (vfprintf
, int,
1387 const char *restrict format
, va_list args
)
1388 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (2, 0)
1389 _GL_ARG_NONNULL ((1, 2)));
1391 _GL_CXXALIAS_RPL (vfprintf
, int,
1393 const char *restrict format
, va_list args
));
1395 /* Need to cast, because on Solaris, the third parameter is
1397 and GCC's fixincludes did not change this to __gnuc_va_list. */
1398 _GL_CXXALIAS_SYS_CAST (vfprintf
, int,
1400 const char *restrict format
, va_list args
));
1403 _GL_CXXALIASWARN (vfprintf
);
1406 #if !@GNULIB_VFPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1407 # if !GNULIB_overrides_vfprintf
1410 /* Assume vfprintf is always declared. */
1411 _GL_WARN_ON_USE (vfprintf
, "vfprintf is not always POSIX compliant - "
1412 "use gnulib module vfprintf-posix for portable "
1413 "POSIX compliance");
1416 #if @GNULIB_VFSCANF@
1417 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
1418 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1420 # define vfscanf rpl_vfscanf
1422 _GL_FUNCDECL_RPL (vfscanf
, int,
1423 (FILE *restrict stream
,
1424 const char *restrict format
, va_list args
)
1425 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (2, 0)
1426 _GL_ARG_NONNULL ((1, 2)));
1427 _GL_CXXALIAS_RPL (vfscanf
, int,
1428 (FILE *restrict stream
,
1429 const char *restrict format
, va_list args
));
1431 _GL_CXXALIAS_SYS (vfscanf
, int,
1432 (FILE *restrict stream
,
1433 const char *restrict format
, va_list args
));
1436 _GL_CXXALIASWARN (vfscanf
);
1440 #if @GNULIB_VPRINTF_POSIX@ || @GNULIB_VPRINTF@
1441 # if (@GNULIB_VPRINTF_POSIX@ && @REPLACE_VPRINTF@) \
1442 || (@GNULIB_VPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@))
1443 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1444 # define vprintf rpl_vprintf
1446 # define GNULIB_overrides_vprintf 1
1447 # if @GNULIB_VPRINTF_POSIX@ || @GNULIB_VFPRINTF_POSIX@
1448 _GL_FUNCDECL_RPL (vprintf
, int, (const char *restrict format
, va_list args
)
1449 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (1, 0)
1450 _GL_ARG_NONNULL ((1)));
1452 _GL_FUNCDECL_RPL (vprintf
, int, (const char *restrict format
, va_list args
)
1453 _GL_ATTRIBUTE_FORMAT_PRINTF_SYSTEM (1, 0)
1454 _GL_ARG_NONNULL ((1)));
1456 _GL_CXXALIAS_RPL (vprintf
, int, (const char *restrict format
, va_list args
));
1458 /* Need to cast, because on Solaris, the second parameter is
1460 and GCC's fixincludes did not change this to __gnuc_va_list. */
1461 _GL_CXXALIAS_SYS_CAST (vprintf
, int,
1462 (const char *restrict format
, va_list args
));
1465 _GL_CXXALIASWARN (vprintf
);
1468 #if !@GNULIB_VPRINTF_POSIX@ && defined GNULIB_POSIXCHECK
1469 # if !GNULIB_overrides_vprintf
1472 /* Assume vprintf is always declared. */
1473 _GL_WARN_ON_USE (vprintf
, "vprintf is not always POSIX compliant - "
1474 "use gnulib module vprintf-posix for portable "
1475 "POSIX compliance");
1479 # if @REPLACE_STDIO_READ_FUNCS@ && @GNULIB_STDIO_H_NONBLOCKING@
1480 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1482 # define vscanf rpl_vscanf
1484 _GL_FUNCDECL_RPL (vscanf
, int, (const char *restrict format
, va_list args
)
1485 _GL_ATTRIBUTE_FORMAT_SCANF_SYSTEM (1, 0)
1486 _GL_ARG_NONNULL ((1)));
1487 _GL_CXXALIAS_RPL (vscanf
, int, (const char *restrict format
, va_list args
));
1489 _GL_CXXALIAS_SYS (vscanf
, int, (const char *restrict format
, va_list args
));
1492 _GL_CXXALIASWARN (vscanf
);
1496 #if @GNULIB_VSNPRINTF@
1497 # if @REPLACE_VSNPRINTF@
1498 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1499 # define vsnprintf rpl_vsnprintf
1501 _GL_FUNCDECL_RPL (vsnprintf
, int,
1502 (char *restrict str
, size_t size
,
1503 const char *restrict format
, va_list args
)
1504 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (3, 0)
1505 _GL_ARG_NONNULL ((3)));
1506 _GL_CXXALIAS_RPL (vsnprintf
, int,
1507 (char *restrict str
, size_t size
,
1508 const char *restrict format
, va_list args
));
1510 # if !@HAVE_DECL_VSNPRINTF@
1511 _GL_FUNCDECL_SYS (vsnprintf
, int,
1512 (char *restrict str
, size_t size
,
1513 const char *restrict format
, va_list args
)
1514 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (3, 0)
1515 _GL_ARG_NONNULL ((3)));
1517 _GL_CXXALIAS_SYS (vsnprintf
, int,
1518 (char *restrict str
, size_t size
,
1519 const char *restrict format
, va_list args
));
1522 _GL_CXXALIASWARN (vsnprintf
);
1524 #elif defined GNULIB_POSIXCHECK
1526 # if HAVE_RAW_DECL_VSNPRINTF
1527 _GL_WARN_ON_USE (vsnprintf
, "vsnprintf is unportable - "
1528 "use gnulib module vsnprintf for portability");
1532 #if @GNULIB_VSPRINTF_POSIX@
1533 # if @REPLACE_VSPRINTF@
1534 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
1535 # define vsprintf rpl_vsprintf
1537 _GL_FUNCDECL_RPL (vsprintf
, int,
1538 (char *restrict str
,
1539 const char *restrict format
, va_list args
)
1540 _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0)
1541 _GL_ARG_NONNULL ((1, 2)));
1542 _GL_CXXALIAS_RPL (vsprintf
, int,
1543 (char *restrict str
,
1544 const char *restrict format
, va_list args
));
1546 /* Need to cast, because on Solaris, the third parameter is
1548 and GCC's fixincludes did not change this to __gnuc_va_list. */
1549 _GL_CXXALIAS_SYS_CAST (vsprintf
, int,
1550 (char *restrict str
,
1551 const char *restrict format
, va_list args
));
1554 _GL_CXXALIASWARN (vsprintf
);
1556 #elif defined GNULIB_POSIXCHECK
1558 /* Assume vsprintf is always declared. */
1559 _GL_WARN_ON_USE (vsprintf
, "vsprintf is not always POSIX compliant - "
1560 "use gnulib module vsprintf-posix for portable "
1561 "POSIX compliance");
1564 #endif /* _@GUARD_PREFIX@_STDIO_H */
1565 #endif /* _@GUARD_PREFIX@_STDIO_H */