1 /* A GNU-like <stdio.h>.
3 Copyright (C) 2004, 2007-2008 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 @PRAGMA_SYSTEM_HEADER@
23 #if defined __need_FILE || defined __need___FILE
24 /* Special invocation convention inside glibc header files. */
26 #@INCLUDE_NEXT@ @NEXT_STDIO_H@
29 /* Normal invocation convention. */
33 /* The include_next requires a split double-inclusion guard. */
34 #@INCLUDE_NEXT@ @NEXT_STDIO_H@
42 #if (@GNULIB_FSEEKO@ && @REPLACE_FSEEKO@) \
43 || (@GNULIB_FTELLO@ && @REPLACE_FTELLO@) \
44 || (@GNULIB_GETDELIM@ && !@HAVE_DECL_GETDELIM@) \
45 || (@GNULIB_GETLINE@ && (!@HAVE_DECL_GETLINE@ || @REPLACE_GETLINE@))
46 /* Get off_t and ssize_t. */
47 # include <sys/types.h>
51 /* This feature is available in gcc versions 2.5 and later. */
52 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
53 # define __attribute__(Spec) /* empty */
55 /* The __-protected variants of `format' and `printf' attributes
56 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
57 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
58 # define __format__ format
59 # define __printf__ printf
64 /* The definition of GL_LINK_WARNING is copied here. */
72 #if @GNULIB_FPRINTF_POSIX@
73 # if @REPLACE_FPRINTF@
74 # define fprintf rpl_fprintf
75 extern int fprintf (FILE *fp, const char *format, ...)
76 __attribute__ ((__format__ (__printf__, 2, 3)));
78 #elif @GNULIB_FPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
79 # define fprintf rpl_fprintf
80 extern int fprintf (FILE *fp, const char *format, ...)
81 __attribute__ ((__format__ (__printf__, 2, 3)));
82 #elif defined GNULIB_POSIXCHECK
85 (GL_LINK_WARNING ("fprintf is not always POSIX compliant - " \
86 "use gnulib module fprintf-posix for portable " \
87 "POSIX compliance"), \
91 #if @GNULIB_VFPRINTF_POSIX@
92 # if @REPLACE_VFPRINTF@
93 # define vfprintf rpl_vfprintf
94 extern int vfprintf (FILE *fp, const char *format, va_list args)
95 __attribute__ ((__format__ (__printf__, 2, 0)));
97 #elif @GNULIB_VFPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
98 # define vfprintf rpl_vfprintf
99 extern int vfprintf (FILE *fp, const char *format, va_list args)
100 __attribute__ ((__format__ (__printf__, 2, 0)));
101 #elif defined GNULIB_POSIXCHECK
103 # define vfprintf(s,f,a) \
104 (GL_LINK_WARNING ("vfprintf is not always POSIX compliant - " \
105 "use gnulib module vfprintf-posix for portable " \
106 "POSIX compliance"), \
110 #if @GNULIB_PRINTF_POSIX@
111 # if @REPLACE_PRINTF@
112 /* Don't break __attribute__((format(printf,M,N))). */
113 # define printf __printf__
114 extern int printf (const char *format, ...)
115 __attribute__ ((__format__ (__printf__, 1, 2)));
117 #elif @GNULIB_PRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
118 /* Don't break __attribute__((format(printf,M,N))). */
119 # define printf __printf__
120 extern int printf (const char *format, ...)
121 __attribute__ ((__format__ (__printf__, 1, 2)));
122 #elif defined GNULIB_POSIXCHECK
125 (GL_LINK_WARNING ("printf is not always POSIX compliant - " \
126 "use gnulib module printf-posix for portable " \
127 "POSIX compliance"), \
129 /* Don't break __attribute__((format(printf,M,N))). */
130 # define format(kind,m,n) format (__##kind##__, m, n)
131 # define __format__(kind,m,n) __format__ (__##kind##__, m, n)
132 # define ____printf____ __printf__
133 # define ____scanf____ __scanf__
134 # define ____strftime____ __strftime__
135 # define ____strfmon____ __strfmon__
138 #if @GNULIB_VPRINTF_POSIX@
139 # if @REPLACE_VPRINTF@
140 # define vprintf rpl_vprintf
141 extern int vprintf (const char *format, va_list args)
142 __attribute__ ((__format__ (__printf__, 1, 0)));
144 #elif @GNULIB_VPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
145 # define vprintf rpl_vprintf
146 extern int vprintf (const char *format, va_list args)
147 __attribute__ ((__format__ (__printf__, 1, 0)));
148 #elif defined GNULIB_POSIXCHECK
150 # define vprintf(f,a) \
151 (GL_LINK_WARNING ("vprintf is not always POSIX compliant - " \
152 "use gnulib module vprintf-posix for portable " \
153 "POSIX compliance"), \
157 #if @GNULIB_SNPRINTF@
158 # if @REPLACE_SNPRINTF@
159 # define snprintf rpl_snprintf
161 # if @REPLACE_SNPRINTF@ || !@HAVE_DECL_SNPRINTF@
162 extern int snprintf (char *str, size_t size, const char *format, ...)
163 __attribute__ ((__format__ (__printf__, 3, 4)));
165 #elif defined GNULIB_POSIXCHECK
168 (GL_LINK_WARNING ("snprintf is unportable - " \
169 "use gnulib module snprintf for portability"), \
173 #if @GNULIB_VSNPRINTF@
174 # if @REPLACE_VSNPRINTF@
175 # define vsnprintf rpl_vsnprintf
177 # if @REPLACE_VSNPRINTF@ || !@HAVE_DECL_VSNPRINTF@
178 extern int vsnprintf (char *str, size_t size, const char *format, va_list args)
179 __attribute__ ((__format__ (__printf__, 3, 0)));
181 #elif defined GNULIB_POSIXCHECK
183 # define vsnprintf(b,s,f,a) \
184 (GL_LINK_WARNING ("vsnprintf is unportable - " \
185 "use gnulib module vsnprintf for portability"), \
186 vsnprintf (b, s, f, a))
189 #if @GNULIB_SPRINTF_POSIX@
190 # if @REPLACE_SPRINTF@
191 # define sprintf rpl_sprintf
192 extern int sprintf (char *str, const char *format, ...)
193 __attribute__ ((__format__ (__printf__, 2, 3)));
195 #elif defined GNULIB_POSIXCHECK
198 (GL_LINK_WARNING ("sprintf is not always POSIX compliant - " \
199 "use gnulib module sprintf-posix for portable " \
200 "POSIX compliance"), \
204 #if @GNULIB_VSPRINTF_POSIX@
205 # if @REPLACE_VSPRINTF@
206 # define vsprintf rpl_vsprintf
207 extern int vsprintf (char *str, const char *format, va_list args)
208 __attribute__ ((__format__ (__printf__, 2, 0)));
210 #elif defined GNULIB_POSIXCHECK
212 # define vsprintf(b,f,a) \
213 (GL_LINK_WARNING ("vsprintf is not always POSIX compliant - " \
214 "use gnulib module vsprintf-posix for portable " \
215 "POSIX compliance"), \
219 #if @GNULIB_VDPRINTF@
220 # if @REPLACE_VDPRINTF@
221 # define vdprintf rpl_vdprintf
223 # if @REPLACE_VDPRINTF@ || !@HAVE_VDPRINTF@
224 extern int vdprintf (int fd, const char *format, va_list args)
225 __attribute__ ((__format__ (__printf__, 2, 0)));
227 #elif defined GNULIB_POSIXCHECK
229 # define vdprintf(d,f,a) \
230 (GL_LINK_WARNING ("vdprintf is unportable - " \
231 "use gnulib module vdprintf for portability"), \
235 #if @GNULIB_VASPRINTF@
236 # if @REPLACE_VASPRINTF@
237 # define asprintf rpl_asprintf
238 # define vasprintf rpl_vasprintf
240 # if @REPLACE_VASPRINTF@ || !@HAVE_VASPRINTF@
241 /* Write formatted output to a string dynamically allocated with malloc().
242 If the memory allocation succeeds, store the address of the string in
243 *RESULT and return the number of resulting bytes, excluding the trailing
244 NUL. Upon memory allocation error, or some other error, return -1. */
245 extern int asprintf (char **result, const char *format, ...)
246 __attribute__ ((__format__ (__printf__, 2, 3)));
247 extern int vasprintf (char **result, const char *format, va_list args)
248 __attribute__ ((__format__ (__printf__, 2, 0)));
252 #if @GNULIB_OBSTACK_PRINTF@
253 # if @REPLACE_OBSTACK_PRINTF@
254 # define obstack_printf rpl_osbtack_printf
255 # define obstack_vprintf rpl_obstack_vprintf
257 # if @REPLACE_OBSTACK_PRINTF@ || !@HAVE_DECL_OBSTACK_PRINTF@
259 /* Grow an obstack with formatted output. Return the number of
260 bytes added to OBS. No trailing nul byte is added, and the
261 object should be closed with obstack_finish before use. Upon
262 memory allocation error, call obstack_alloc_failed_handler. Upon
263 other error, return -1. */
264 extern int obstack_printf (struct obstack *obs, const char *format, ...)
265 __attribute__ ((__format__ (__printf__, 2, 3)));
266 extern int obstack_vprintf (struct obstack *obs, const char *format,
268 __attribute__ ((__format__ (__printf__, 2, 0)));
275 # define fopen rpl_fopen
276 extern FILE * fopen (const char *filename, const char *mode);
278 #elif defined GNULIB_POSIXCHECK
280 # define fopen(f,m) \
281 (GL_LINK_WARNING ("fopen on Win32 platforms is not POSIX compatible - " \
282 "use gnulib module fopen for portability"), \
287 # if @REPLACE_FREOPEN@
289 # define freopen rpl_freopen
290 extern FILE * freopen (const char *filename, const char *mode, FILE *stream);
292 #elif defined GNULIB_POSIXCHECK
294 # define freopen(f,m,s) \
295 (GL_LINK_WARNING ("freopen on Win32 platforms is not POSIX compatible - " \
296 "use gnulib module freopen for portability"), \
301 # if @REPLACE_FSEEKO@
302 /* Provide fseek, fseeko functions that are aware of a preceding
303 fflush(), and which detect pipes. */
304 # define fseeko rpl_fseeko
305 extern int fseeko (FILE *fp, off_t offset, int whence);
306 # define fseek(fp, offset, whence) fseeko (fp, (off_t)(offset), whence)
308 #elif defined GNULIB_POSIXCHECK
310 # define fseeko(f,o,w) \
311 (GL_LINK_WARNING ("fseeko is unportable - " \
312 "use gnulib module fseeko for portability"), \
316 #if @GNULIB_FSEEK@ && @REPLACE_FSEEK@
317 extern int rpl_fseek (FILE *fp, long offset, int whence);
319 # if defined GNULIB_POSIXCHECK
320 # define fseek(f,o,w) \
321 (GL_LINK_WARNING ("fseek cannot handle files larger than 4 GB " \
322 "on 32-bit platforms - " \
323 "use fseeko function for handling of large files"), \
326 # define fseek rpl_fseek
328 #elif defined GNULIB_POSIXCHECK
330 # define fseek(f,o,w) \
331 (GL_LINK_WARNING ("fseek cannot handle files larger than 4 GB " \
332 "on 32-bit platforms - " \
333 "use fseeko function for handling of large files"), \
339 # if @REPLACE_FTELLO@
340 # define ftello rpl_ftello
341 extern off_t ftello (FILE *fp);
342 # define ftell(fp) ftello (fp)
344 #elif defined GNULIB_POSIXCHECK
347 (GL_LINK_WARNING ("ftello is unportable - " \
348 "use gnulib module ftello for portability"), \
352 #if @GNULIB_FTELL@ && @REPLACE_FTELL@
353 extern long rpl_ftell (FILE *fp);
355 # if GNULIB_POSIXCHECK
357 (GL_LINK_WARNING ("ftell cannot handle files larger than 4 GB " \
358 "on 32-bit platforms - " \
359 "use ftello function for handling of large files"), \
362 # define ftell rpl_ftell
364 #elif defined GNULIB_POSIXCHECK
367 (GL_LINK_WARNING ("ftell cannot handle files larger than 4 GB " \
368 "on 32-bit platforms - " \
369 "use ftello function for handling of large files"), \
375 # if @REPLACE_FFLUSH@
376 # define fflush rpl_fflush
377 /* Flush all pending data on STREAM according to POSIX rules. Both
378 output and seekable input streams are supported.
379 Note! LOSS OF DATA can occur if fflush is applied on an input stream
380 that is _not_seekable_ or on an update stream that is _not_seekable_
381 and in which the most recent operation was input. Seekability can
382 be tested with lseek(fileno(fp),0,SEEK_CUR). */
383 extern int fflush (FILE *gl_stream);
385 #elif defined GNULIB_POSIXCHECK
388 (GL_LINK_WARNING ("fflush is not always POSIX compliant - " \
389 "use gnulib module fflush for portable " \
390 "POSIX compliance"), \
395 # if @REPLACE_FCLOSE@
396 # define fclose rpl_fclose
397 /* Close STREAM and its underlying file descriptor. */
398 extern int fclose (FILE *stream);
400 #elif defined GNULIB_POSIXCHECK
403 (GL_LINK_WARNING ("fclose is not always POSIX compliant - " \
404 "use gnulib module fclose for portable " \
405 "POSIX compliance"), \
409 #if @GNULIB_FPUTC@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
411 # define fputc rpl_fputc
412 extern int fputc (int c, FILE *stream);
415 #if @GNULIB_PUTC@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
417 # define putc rpl_fputc
418 extern int putc (int c, FILE *stream);
421 #if @GNULIB_PUTCHAR@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
423 # define putchar rpl_putchar
424 extern int putchar (int c);
427 #if @GNULIB_FPUTS@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
429 # define fputs rpl_fputs
430 extern int fputs (const char *string, FILE *stream);
433 #if @GNULIB_PUTS@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
435 # define puts rpl_puts
436 extern int puts (const char *string);
439 #if @GNULIB_FWRITE@ && @REPLACE_STDIO_WRITE_FUNCS@ && @GNULIB_STDIO_H_SIGPIPE@
441 # define fwrite rpl_fwrite
442 extern size_t fwrite (const void *ptr, size_t s, size_t n, FILE *stream);
445 #if @GNULIB_GETDELIM@
446 # if !@HAVE_DECL_GETDELIM@
447 /* Read input, up to (and including) the next occurrence of DELIMITER, from
448 STREAM, store it in *LINEPTR (and NUL-terminate it).
449 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
450 bytes of space. It is realloc'd as necessary.
451 Return the number of bytes read and stored at *LINEPTR (not including the
452 NUL terminator), or -1 on error or EOF. */
453 extern ssize_t getdelim (char **lineptr, size_t *linesize, int delimiter,
456 #elif defined GNULIB_POSIXCHECK
458 # define getdelim(l, s, d, f) \
459 (GL_LINK_WARNING ("getdelim is unportable - " \
460 "use gnulib module getdelim for portability"), \
461 getdelim (l, s, d, f))
465 # if @REPLACE_GETLINE@
467 # define getline rpl_getline
469 # if !@HAVE_DECL_GETLINE@ || @REPLACE_GETLINE@
470 /* Read a line, up to (and including) the next newline, from STREAM, store it
471 in *LINEPTR (and NUL-terminate it).
472 *LINEPTR is a pointer returned from malloc (or NULL), pointing to *LINESIZE
473 bytes of space. It is realloc'd as necessary.
474 Return the number of bytes read and stored at *LINEPTR (not including the
475 NUL terminator), or -1 on error or EOF. */
476 extern ssize_t getline (char **lineptr, size_t *linesize, FILE *stream);
478 #elif defined GNULIB_POSIXCHECK
480 # define getline(l, s, f) \
481 (GL_LINK_WARNING ("getline is unportable - " \
482 "use gnulib module getline for portability"), \
487 # if @REPLACE_PERROR@
488 # define perror rpl_perror
489 /* Print a message to standard error, describing the value of ERRNO,
490 (if STRING is not NULL and not empty) prefixed with STRING and ": ",
491 and terminated with a newline. */
492 extern void perror (const char *string);
494 #elif defined GNULIB_POSIXCHECK
497 (GL_LINK_WARNING ("perror is not always POSIX compliant - " \
498 "use gnulib module perror for portability"), \
506 #endif /* _GL_STDIO_H */
507 #endif /* _GL_STDIO_H */