lib/stdio.in.h

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