]>
git.saurik.com Git - apple/libc.git/blob - include/stdio.h
2 * Copyright (c) 2000, 2005, 2007, 2009, 2010 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
24 * Copyright (c) 1990, 1993
25 * The Regents of the University of California. All rights reserved.
27 * This code is derived from software contributed to Berkeley by
30 * Redistribution and use in source and binary forms, with or without
31 * modification, are permitted provided that the following conditions
33 * 1. Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * 2. Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in the
37 * documentation and/or other materials provided with the distribution.
38 * 3. All advertising materials mentioning features or use of this software
39 * must display the following acknowledgement:
40 * This product includes software developed by the University of
41 * California, Berkeley and its contributors.
42 * 4. Neither the name of the University nor the names of its contributors
43 * may be used to endorse or promote products derived from this software
44 * without specific prior written permission.
46 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * @(#)stdio.h 8.5 (Berkeley) 4/29/95
64 #include <sys/cdefs.h>
65 #include <Availability.h>
71 /* DO NOT REMOVE THIS COMMENT: fixincludes needs to see:
72 * __gnuc_va_list and include <stdarg.h> */
73 typedef __darwin_va_list
va_list;
78 typedef __darwin_size_t
size_t;
82 #define NULL __DARWIN_NULL
85 typedef __darwin_off_t
fpos_t;
87 #define _FSTDIO /* Define for new stdio with functions. */
90 * NB: to fit things in six character monocase externals, the stdio
91 * code uses the prefix `__s' for stdio objects, typically followed
92 * by a three-character attempt at a mnemonic.
101 /* hold a buncha junk that would grow the ABI */
105 * stdio state variables.
107 * The following always hold:
109 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
110 * _lbfsize is -_bf._size, else _lbfsize is 0
111 * if _flags&__SRD, _w is 0
112 * if _flags&__SWR, _r is 0
114 * This ensures that the getc and putc macros (or inline functions) never
115 * try to write or read from a file that is in `read' or `write' mode.
116 * (Moreover, they can, and do, automatically switch from read mode to
117 * write mode, and back, on "r+" and "w+" files.)
119 * _lbfsize is used only to make the inline line-buffered output stream
120 * code as compact as possible.
122 * _ub, _up, and _ur are used when ungetc() pushes back more characters
123 * than fit in the current _bf, or when ungetc() pushes back a character
124 * that does not match the previous one in _bf. When this happens,
125 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
126 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
128 * NB: see WARNING above before changing the layout of this structure!
130 typedef struct __sFILE
{
131 unsigned char *_p
; /* current position in (some) buffer */
132 int _r
; /* read space left for getc() */
133 int _w
; /* write space left for putc() */
134 short _flags
; /* flags, below; this FILE is free if 0 */
135 short _file
; /* fileno, if Unix descriptor, else -1 */
136 struct __sbuf _bf
; /* the buffer (at least 1 byte, if !NULL) */
137 int _lbfsize
; /* 0 or -_bf._size, for inline putc */
140 void *_cookie
; /* cookie passed to io functions */
141 int (*_close
)(void *);
142 int (*_read
) (void *, char *, int);
143 fpos_t (*_seek
) (void *, fpos_t, int);
144 int (*_write
)(void *, const char *, int);
146 /* separate buffer for long sequences of ungetc() */
147 struct __sbuf _ub
; /* ungetc buffer */
148 struct __sFILEX
*_extra
; /* additions to FILE to not break ABI */
149 int _ur
; /* saved _r when _r is counting ungetc data */
151 /* tricks to meet minimum requirements even when malloc() fails */
152 unsigned char _ubuf
[3]; /* guarantee an ungetc() buffer */
153 unsigned char _nbuf
[1]; /* guarantee a getc() buffer */
155 /* separate buffer for fgetln() when line crosses buffer boundary */
156 struct __sbuf _lb
; /* buffer for fgetln() */
158 /* Unix stdio files get aligned to block boundaries on fseek() */
159 int _blksize
; /* stat.st_blksize (may be != _bf._size) */
160 fpos_t _offset
; /* current lseek offset (see WARNING) */
164 extern FILE *__stdinp
;
165 extern FILE *__stdoutp
;
166 extern FILE *__stderrp
;
169 #define __SLBF 0x0001 /* line buffered */
170 #define __SNBF 0x0002 /* unbuffered */
171 #define __SRD 0x0004 /* OK to read */
172 #define __SWR 0x0008 /* OK to write */
173 /* RD and WR are never simultaneously asserted */
174 #define __SRW 0x0010 /* open for reading & writing */
175 #define __SEOF 0x0020 /* found EOF */
176 #define __SERR 0x0040 /* found error */
177 #define __SMBF 0x0080 /* _buf is from malloc */
178 #define __SAPP 0x0100 /* fdopen()ed in append mode */
179 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
180 #define __SOPT 0x0400 /* do fseek() optimisation */
181 #define __SNPT 0x0800 /* do not do fseek() optimisation */
182 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
183 #define __SMOD 0x2000 /* true => fgetln modified _p text */
184 #define __SALC 0x4000 /* allocate string space dynamically */
185 #define __SIGN 0x8000 /* ignore this file in _fwalk */
188 * The following three definitions are for ANSI C, which took them
189 * from System V, which brilliantly took internal interface macros and
190 * made them official arguments to setvbuf(), without renaming them.
191 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
193 * Although numbered as their counterparts above, the implementation
194 * does not rely on this.
196 #define _IOFBF 0 /* setvbuf should set fully buffered */
197 #define _IOLBF 1 /* setvbuf should set line buffered */
198 #define _IONBF 2 /* setvbuf should set unbuffered */
200 #define BUFSIZ 1024 /* size of buffer used by setbuf */
203 /* must be == _POSIX_STREAM_MAX <limits.h> */
204 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
205 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
207 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
209 #define P_tmpdir "/var/tmp/"
211 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
212 #define TMP_MAX 308915776
215 #define SEEK_SET 0 /* set file offset to offset */
218 #define SEEK_CUR 1 /* set file offset to current plus offset */
221 #define SEEK_END 2 /* set file offset to EOF plus offset */
224 #define stdin __stdinp
225 #define stdout __stdoutp
226 #define stderr __stderrp
228 #ifdef _DARWIN_UNLIMITED_STREAMS
229 #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_3_2
230 #error "_DARWIN_UNLIMITED_STREAMS specified, but -miphoneos-version-min version does not support it."
231 #elif defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_6
232 #error "_DARWIN_UNLIMITED_STREAMS specified, but -mmacosx-version-min version does not support it."
239 void clearerr(FILE *);
245 int fgetpos(FILE * __restrict
, fpos_t *);
246 char *fgets(char * __restrict
, int, FILE *);
247 #if defined(_DARWIN_UNLIMITED_STREAMS) || defined(_DARWIN_C_SOURCE)
248 FILE *fopen(const char * __restrict
, const char * __restrict
) __DARWIN_ALIAS_STARTING(__MAC_10_6
, __IPHONE_3_2
, __DARWIN_EXTSN(fopen
));
249 #else /* !_DARWIN_UNLIMITED_STREAMS && !_DARWIN_C_SOURCE */
251 #ifndef LIBC_ALIAS_FOPEN
253 FILE *fopen(const char * __restrict
, const char * __restrict
) __DARWIN_ALIAS_STARTING(__MAC_10_6
, __IPHONE_2_0
, __DARWIN_ALIAS(fopen
));
255 #else /* LIBC_ALIAS_FOPEN */
256 FILE *fopen(const char * __restrict
, const char * __restrict
) LIBC_ALIAS(fopen
);
257 #endif /* !LIBC_ALIAS_FOPEN */
259 #endif /* (DARWIN_UNLIMITED_STREAMS || _DARWIN_C_SOURCE) */
260 int fprintf(FILE * __restrict
, const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(fprintf
) __printflike(2, 3);
261 int fputc(int, FILE *);
263 #ifndef LIBC_ALIAS_FPUTS
265 int fputs(const char * __restrict
, FILE * __restrict
) __DARWIN_ALIAS(fputs
);
267 #else /* LIBC_ALIAS_FPUTS */
268 int fputs(const char * __restrict
, FILE * __restrict
) LIBC_ALIAS(fputs
);
269 #endif /* !LIBC_ALIAS_FPUTS */
271 size_t fread(void * __restrict
, size_t, size_t, FILE * __restrict
);
273 #ifndef LIBC_ALIAS_FREOPEN
275 FILE *freopen(const char * __restrict
, const char * __restrict
,
276 FILE * __restrict
) __DARWIN_ALIAS(freopen
);
278 #else /* LIBC_ALIAS_FREOPEN */
279 FILE *freopen(const char * __restrict
, const char * __restrict
,
280 FILE * __restrict
) LIBC_ALIAS(freopen
);
281 #endif /* !LIBC_ALIAS_FREOPEN */
283 int fscanf(FILE * __restrict
, const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(fscanf
) __scanflike(2, 3);
284 int fseek(FILE *, long, int);
285 int fsetpos(FILE *, const fpos_t *);
288 #ifndef LIBC_ALIAS_FWRITE
290 size_t fwrite(const void * __restrict
, size_t, size_t, FILE * __restrict
) __DARWIN_ALIAS(fwrite
);
292 #else /* LIBC_ALIAS_FWRITE */
293 size_t fwrite(const void * __restrict
, size_t, size_t, FILE * __restrict
) LIBC_ALIAS(fwrite
);
294 #endif /* !LIBC_ALIAS_FWRITE */
299 void perror(const char *);
300 int printf(const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(printf
) __printflike(1, 2);
301 int putc(int, FILE *);
303 int puts(const char *);
304 int remove(const char *);
305 int rename (const char *, const char *);
307 int scanf(const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(scanf
) __scanflike(1, 2);
308 void setbuf(FILE * __restrict
, char * __restrict
);
309 int setvbuf(FILE * __restrict
, char * __restrict
, int, size_t);
310 int sprintf(char * __restrict
, const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(sprintf
) __printflike(2, 3);
311 int sscanf(const char * __restrict
, const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(sscanf
) __scanflike(2, 3);
313 char *tmpnam(char *);
314 int ungetc(int, FILE *);
315 int vfprintf(FILE * __restrict
, const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vfprintf
) __printflike(2, 0);
316 int vprintf(const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vprintf
) __printflike(1, 0);
317 int vsprintf(char * __restrict
, const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vsprintf
) __printflike(2, 0);
322 /* Additional functionality provided by:
326 #if __DARWIN_C_LEVEL >= 198808L
327 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
330 #ifndef __CTERMID_DEFINED
331 /* Multiply defined in stdio.h and unistd.h by SUS */
332 #define __CTERMID_DEFINED 1
333 char *ctermid(char *);
336 #if defined(_DARWIN_UNLIMITED_STREAMS) || defined(_DARWIN_C_SOURCE)
337 FILE *fdopen(int, const char *) __DARWIN_ALIAS_STARTING(__MAC_10_6
, __IPHONE_3_2
, __DARWIN_EXTSN(fdopen
));
338 #else /* !_DARWIN_UNLIMITED_STREAMS && !_DARWIN_C_SOURCE */
340 #ifndef LIBC_ALIAS_FDOPEN
342 FILE *fdopen(int, const char *) __DARWIN_ALIAS_STARTING(__MAC_10_6
, __IPHONE_2_0
, __DARWIN_ALIAS(fdopen
));
344 #else /* LIBC_ALIAS_FDOPEN */
345 FILE *fdopen(int, const char *) LIBC_ALIAS(fdopen
);
346 #endif /* !LIBC_ALIAS_FDOPEN */
348 #endif /* (DARWIN_UNLIMITED_STREAMS || _DARWIN_C_SOURCE) */
351 #endif /* __DARWIN_C_LEVEL >= 198808L */
354 /* Additional functionality provided by:
355 * POSIX.2-1992 C Language Binding Option
358 #if __DARWIN_C_LEVEL >= 199209L
361 #if defined(_DARWIN_UNLIMITED_STREAMS) || defined(_DARWIN_C_SOURCE)
362 FILE *popen(const char *, const char *) __DARWIN_ALIAS_STARTING(__MAC_10_6
, __IPHONE_3_2
, __DARWIN_EXTSN(popen
));
363 #else /* !_DARWIN_UNLIMITED_STREAMS && !_DARWIN_C_SOURCE */
365 #ifndef LIBC_ALIAS_POPEN
367 FILE *popen(const char *, const char *) __DARWIN_ALIAS_STARTING(__MAC_10_6
, __IPHONE_2_0
, __DARWIN_ALIAS(popen
));
369 #else /* LIBC_ALIAS_POPEN */
370 FILE *popen(const char *, const char *) LIBC_ALIAS(popen
);
371 #endif /* !LIBC_ALIAS_POPEN */
373 #endif /* (DARWIN_UNLIMITED_STREAMS || _DARWIN_C_SOURCE) */
375 #endif /* __DARWIN_C_LEVEL >= 199209L */
380 /* Additional functionality provided by:
383 * and the omnibus ISO/IEC 9945-1: 1996
386 #if __DARWIN_C_LEVEL >= 199506L
388 /* Functions internal to the implementation. */
391 int __svfscanf(FILE *, const char *, va_list) __DARWIN_LDBL_COMPAT(__svfscanf
) __scanflike(2, 0);
392 int __swbuf(int, FILE *);
396 * The __sfoo macros are here so that we can
397 * define function versions in the C library.
399 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
400 #if defined(__GNUC__) && defined(__STDC__)
401 static __inline
int __sputc(int _c
, FILE *_p
) {
402 if (--_p
->_w
>= 0 || (_p
->_w
>= _p
->_lbfsize
&& (char)_c
!= '\n'))
403 return (*_p
->_p
++ = _c
);
405 return (__swbuf(_c
, _p
));
409 * This has been tuned to generate reasonable code on the vax using pcc.
411 #define __sputc(c, p) \
413 (p)->_w >= (p)->_lbfsize ? \
414 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
417 __swbuf((int)(c), p) : \
418 (*(p)->_p = (c), (int)*(p)->_p++))
421 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
422 #define __sferror(p) (((p)->_flags & __SERR) != 0)
423 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
424 #define __sfileno(p) ((p)->_file)
427 void flockfile(FILE *);
428 int ftrylockfile(FILE *);
429 void funlockfile(FILE *);
430 int getc_unlocked(FILE *);
431 int getchar_unlocked(void);
432 int putc_unlocked(int, FILE *);
433 int putchar_unlocked(int);
435 /* Removed in Issue 6 */
436 #if !defined(_POSIX_C_SOURCE) || _POSIX_C_SOURCE < 200112L
438 int putw(int, FILE *);
442 #ifndef LIBC_ALIAS_TEMPNAM
444 char *tempnam(const char *, const char *) __DARWIN_ALIAS(tempnam
);
446 #else /* LIBC_ALIAS_TEMPNAM */
447 char *tempnam(const char *, const char *) LIBC_ALIAS(tempnam
);
448 #endif /* !LIBC_ALIAS_TEMPNAM */
453 #define getc_unlocked(fp) __sgetc(fp)
454 #define putc_unlocked(x, fp) __sputc(x, fp)
457 #define getchar_unlocked() getc_unlocked(stdin)
458 #define putchar_unlocked(x) putc_unlocked(x, stdout)
459 #endif /* __DARWIN_C_LEVEL >= 199506L */
463 /* Additional functionality provided by:
468 #if __DARWIN_C_LEVEL >= 200112L
471 typedef __darwin_off_t off_t
;
475 int fseeko(FILE *, off_t
, int);
476 off_t
ftello(FILE *);
478 #endif /* __DARWIN_C_LEVEL >= 200112L */
480 #if __DARWIN_C_LEVEL >= 200112L || defined(_C99_SOURCE) || defined(__cplusplus)
482 int snprintf(char * __restrict
, size_t, const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(snprintf
) __printflike(3, 4);
483 int vfscanf(FILE * __restrict
, const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vfscanf
) __scanflike(2, 0);
484 int vscanf(const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vscanf
) __scanflike(1, 0);
485 int vsnprintf(char * __restrict
, size_t, const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vsnprintf
) __printflike(3, 0);
486 int vsscanf(const char * __restrict
, const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vsscanf
) __scanflike(2, 0);
488 #endif /* __DARWIN_C_LEVEL >= 200112L || defined(_C99_SOURCE) || defined(__cplusplus) */
492 /* Additional functionality provided by:
496 #if __DARWIN_C_LEVEL >= 200809L
499 typedef __darwin_ssize_t ssize_t
;
503 int dprintf(int, const char * __restrict
, ...) __DARWIN_LDBL_COMPAT(dprintf
) __printflike(2, 3) __OSX_AVAILABLE_STARTING(__MAC_10_7
, __IPHONE_4_3
);
504 int vdprintf(int, const char * __restrict
, va_list) __DARWIN_LDBL_COMPAT(vdprintf
) __printflike(2, 0) __OSX_AVAILABLE_STARTING(__MAC_10_7
, __IPHONE_4_3
);
505 ssize_t
getdelim(char ** __restrict
, size_t * __restrict
, int, FILE * __restrict
) __OSX_AVAILABLE_STARTING(__MAC_10_7
, __IPHONE_4_3
);
506 ssize_t
getline(char ** __restrict
, size_t * __restrict
, FILE * __restrict
) __OSX_AVAILABLE_STARTING(__MAC_10_7
, __IPHONE_4_3
);
508 #endif /* __DARWIN_C_LEVEL >= 200809L */
512 /* Darwin extensions */
514 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
516 extern __const
int sys_nerr
; /* perror(3) external variables */
517 extern __const
char *__const sys_errlist
[];
519 int asprintf(char **, const char *, ...) __DARWIN_LDBL_COMPAT(asprintf
) __printflike(2, 3);
520 char *ctermid_r(char *);
521 char *fgetln(FILE *, size_t *);
522 __const
char *fmtcheck(const char *, const char *);
524 void setbuffer(FILE *, char *, int);
525 int setlinebuf(FILE *);
526 int vasprintf(char **, const char *, va_list) __DARWIN_LDBL_COMPAT(vasprintf
) __printflike(2, 0);
527 FILE *zopen(const char *, const char *, int);
531 * Stdio function-access interface.
533 FILE *funopen(const void *,
534 int (*)(void *, char *, int),
535 int (*)(void *, const char *, int),
536 fpos_t (*)(void *, fpos_t, int),
539 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
540 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
542 #define feof_unlocked(p) __sfeof(p)
543 #define ferror_unlocked(p) __sferror(p)
544 #define clearerr_unlocked(p) __sclearerr(p)
545 #define fileno_unlocked(p) __sfileno(p)
547 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
550 #ifdef _USE_EXTENDED_LOCALES_
551 #include <xlocale/_stdio.h>
552 #endif /* _USE_EXTENDED_LOCALES_ */
554 #if defined (__GNUC__) && _FORTIFY_SOURCE > 0 && !defined (__cplusplus)
555 /* Security checking functions. */
556 #include <secure/_stdio.h>
559 #endif /* _STDIO_H_ */