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