]>
git.saurik.com Git - apple/libc.git/blob - include/stdio.h
45357515103fcc17c0c1db5d1081230ef66f1659
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
67 extern FILE * __stdinp
;
68 extern FILE * __stdoutp
;
69 extern FILE * __stderrp
;
72 #define __SLBF 0x0001 /* line buffered */
73 #define __SNBF 0x0002 /* unbuffered */
74 #define __SRD 0x0004 /* OK to read */
75 #define __SWR 0x0008 /* OK to write */
76 /* RD and WR are never simultaneously asserted */
77 #define __SRW 0x0010 /* open for reading & writing */
78 #define __SEOF 0x0020 /* found EOF */
79 #define __SERR 0x0040 /* found error */
80 #define __SMBF 0x0080 /* _buf is from malloc */
81 #define __SAPP 0x0100 /* fdopen()ed in append mode */
82 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
83 #define __SOPT 0x0400 /* do fseek() optimisation */
84 #define __SNPT 0x0800 /* do not do fseek() optimisation */
85 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
86 #define __SMOD 0x2000 /* true => fgetln modified _p text */
87 #define __SALC 0x4000 /* allocate string space dynamically */
88 #define __SIGN 0x8000 /* ignore this file in _fwalk */
91 * The following three definitions are for ANSI C, which took them
92 * from System V, which brilliantly took internal interface macros and
93 * made them official arguments to setvbuf(), without renaming them.
94 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
96 * Although numbered as their counterparts above, the implementation
97 * does not rely on this.
99 #define _IOFBF 0 /* setvbuf should set fully buffered */
100 #define _IOLBF 1 /* setvbuf should set line buffered */
101 #define _IONBF 2 /* setvbuf should set unbuffered */
103 #define BUFSIZ 1024 /* size of buffer used by setbuf */
106 /* must be == _POSIX_STREAM_MAX <limits.h> */
107 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
108 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
110 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
112 #define P_tmpdir "/var/tmp/"
114 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
115 #define TMP_MAX 308915776
118 #define SEEK_SET 0 /* set file offset to offset */
121 #define SEEK_CUR 1 /* set file offset to current plus offset */
124 #define SEEK_END 2 /* set file offset to EOF plus offset */
127 #define stdin __stdinp
128 #define stdout __stdoutp
129 #define stderr __stderrp
131 #ifdef _DARWIN_UNLIMITED_STREAMS
132 #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_3_2
133 #error "_DARWIN_UNLIMITED_STREAMS specified, but -miphoneos-version-min version does not support it."
134 #elif defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_6
135 #error "_DARWIN_UNLIMITED_STREAMS specified, but -mmacosx-version-min version does not support it."
142 void clearerr ( FILE *);
148 int fgetpos ( FILE * __restrict
, fpos_t *);
149 char * fgets ( char * __restrict
, int , FILE *);
150 #if defined(_DARWIN_UNLIMITED_STREAMS) || defined(_DARWIN_C_SOURCE)
151 FILE * fopen ( const char * __restrict __filename
, const char * __restrict __mode
) __DARWIN_ALIAS_STARTING ( __MAC_10_6
, __IPHONE_3_2
, __DARWIN_EXTSN ( fopen
));
152 #else /* !_DARWIN_UNLIMITED_STREAMS && !_DARWIN_C_SOURCE */
154 #ifndef LIBC_ALIAS_FOPEN
156 FILE * fopen ( const char * __restrict __filename
, const char * __restrict __mode
) __DARWIN_ALIAS_STARTING ( __MAC_10_6
, __IPHONE_2_0
, __DARWIN_ALIAS ( fopen
));
158 #else /* LIBC_ALIAS_FOPEN */
159 FILE * fopen ( const char * __restrict __filename
, const char * __restrict __mode
) LIBC_ALIAS ( fopen
);
160 #endif /* !LIBC_ALIAS_FOPEN */
162 #endif /* (DARWIN_UNLIMITED_STREAMS || _DARWIN_C_SOURCE) */
163 int fprintf ( FILE * __restrict
, const char * __restrict
, ...) __printflike ( 2 , 3 );
164 int fputc ( int , FILE *);
166 #ifndef LIBC_ALIAS_FPUTS
168 int fputs ( const char * __restrict
, FILE * __restrict
) __DARWIN_ALIAS ( fputs
);
170 #else /* LIBC_ALIAS_FPUTS */
171 int fputs ( const char * __restrict
, FILE * __restrict
) LIBC_ALIAS ( fputs
);
172 #endif /* !LIBC_ALIAS_FPUTS */
174 size_t fread ( void * __restrict __ptr
, size_t __size
, size_t __nitems
, FILE * __restrict __stream
);
176 #ifndef LIBC_ALIAS_FREOPEN
178 FILE * freopen ( const char * __restrict
, const char * __restrict
,
179 FILE * __restrict
) __DARWIN_ALIAS ( freopen
);
181 #else /* LIBC_ALIAS_FREOPEN */
182 FILE * freopen ( const char * __restrict
, const char * __restrict
,
183 FILE * __restrict
) LIBC_ALIAS ( freopen
);
184 #endif /* !LIBC_ALIAS_FREOPEN */
186 int fscanf ( FILE * __restrict
, const char * __restrict
, ...) __scanflike ( 2 , 3 );
187 int fseek ( FILE *, long , int );
188 int fsetpos ( FILE *, const fpos_t *);
191 #ifndef LIBC_ALIAS_FWRITE
193 size_t fwrite ( const void * __restrict __ptr
, size_t __size
, size_t __nitems
, FILE * __restrict __stream
) __DARWIN_ALIAS ( fwrite
);
195 #else /* LIBC_ALIAS_FWRITE */
196 size_t fwrite ( const void * __restrict __ptr
, size_t __size
, size_t __nitems
, FILE * __restrict __stream
) LIBC_ALIAS ( fwrite
);
197 #endif /* !LIBC_ALIAS_FWRITE */
202 void perror ( const char *);
203 int printf ( const char * __restrict
, ...) __printflike ( 1 , 2 );
204 int putc ( int , FILE *);
206 int puts ( const char *);
207 int remove ( const char *);
208 int rename ( const char * __old
, const char * __new
);
210 int scanf ( const char * __restrict
, ...) __scanflike ( 1 , 2 );
211 void setbuf ( FILE * __restrict
, char * __restrict
);
212 int setvbuf ( FILE * __restrict
, char * __restrict
, int , size_t );
213 int sprintf ( char * __restrict
, const char * __restrict
, ...) __printflike ( 2 , 3 ) __swift_unavailable ( "Use snprintf instead." );
214 int sscanf ( const char * __restrict
, const char * __restrict
, ...) __scanflike ( 2 , 3 );
217 __swift_unavailable ( "Use mkstemp(3) instead." )
218 #if !defined(_POSIX_C_SOURCE)
219 __deprecated_msg ( "This function is provided for compatibility reasons only. Due to security concerns inherent in the design of tmpnam(3), it is highly recommended that you use mkstemp(3) instead." )
221 char * tmpnam ( char *);
222 int ungetc ( int , FILE *);
223 int vfprintf ( FILE * __restrict
, const char * __restrict
, va_list ) __printflike ( 2 , 0 );
224 int vprintf ( const char * __restrict
, va_list ) __printflike ( 1 , 0 );
225 int vsprintf ( char * __restrict
, const char * __restrict
, va_list ) __printflike ( 2 , 0 ) __swift_unavailable ( "Use vsnprintf instead." );
230 /* Additional functionality provided by:
234 #if __DARWIN_C_LEVEL >= 198808L
235 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
238 #ifndef __CTERMID_DEFINED
239 /* Multiply defined in stdio.h and unistd.h by SUS */
240 #define __CTERMID_DEFINED 1
241 char * ctermid ( char *);
244 #if defined(_DARWIN_UNLIMITED_STREAMS) || defined(_DARWIN_C_SOURCE)
245 FILE * fdopen ( int , const char *) __DARWIN_ALIAS_STARTING ( __MAC_10_6
, __IPHONE_3_2
, __DARWIN_EXTSN ( fdopen
));
246 #else /* !_DARWIN_UNLIMITED_STREAMS && !_DARWIN_C_SOURCE */
248 #ifndef LIBC_ALIAS_FDOPEN
250 FILE * fdopen ( int , const char *) __DARWIN_ALIAS_STARTING ( __MAC_10_6
, __IPHONE_2_0
, __DARWIN_ALIAS ( fdopen
));
252 #else /* LIBC_ALIAS_FDOPEN */
253 FILE * fdopen ( int , const char *) LIBC_ALIAS ( fdopen
);
254 #endif /* !LIBC_ALIAS_FDOPEN */
256 #endif /* (DARWIN_UNLIMITED_STREAMS || _DARWIN_C_SOURCE) */
259 #endif /* __DARWIN_C_LEVEL >= 198808L */
262 /* Additional functionality provided by:
263 * POSIX.2-1992 C Language Binding Option
265 #if TARGET_OS_EMBEDDED
266 #define __swift_unavailable_on(osx_msg, ios_msg) __swift_unavailable(ios_msg)
268 #define __swift_unavailable_on(osx_msg, ios_msg) __swift_unavailable(osx_msg)
271 #if __DARWIN_C_LEVEL >= 199209L
273 int pclose ( FILE *) __swift_unavailable_on ( "Use posix_spawn APIs or NSTask instead." , "Process spawning is unavailable." );
274 #if defined(_DARWIN_UNLIMITED_STREAMS) || defined(_DARWIN_C_SOURCE)
275 FILE * popen ( const char *, const char *) __DARWIN_ALIAS_STARTING ( __MAC_10_6
, __IPHONE_3_2
, __DARWIN_EXTSN ( popen
)) __swift_unavailable_on ( "Use posix_spawn APIs or NSTask instead." , "Process spawning is unavailable." );
276 #else /* !_DARWIN_UNLIMITED_STREAMS && !_DARWIN_C_SOURCE */
278 #ifndef LIBC_ALIAS_POPEN
280 FILE * popen ( const char *, const char *) __DARWIN_ALIAS_STARTING ( __MAC_10_6
, __IPHONE_2_0
, __DARWIN_ALIAS ( popen
)) __swift_unavailable_on ( "Use posix_spawn APIs or NSTask instead." , "Process spawning is unavailable." );
282 #else /* LIBC_ALIAS_POPEN */
283 FILE * popen ( const char *, const char *) LIBC_ALIAS ( popen
);
284 #endif /* !LIBC_ALIAS_POPEN */
286 #endif /* (DARWIN_UNLIMITED_STREAMS || _DARWIN_C_SOURCE) */
288 #endif /* __DARWIN_C_LEVEL >= 199209L */
290 #undef __swift_unavailable_on
292 /* Additional functionality provided by:
295 * and the omnibus ISO/IEC 9945-1: 1996
298 #if __DARWIN_C_LEVEL >= 199506L
300 /* Functions internal to the implementation. */
303 int __svfscanf ( FILE *, const char *, va_list ) __scanflike ( 2 , 0 );
304 int __swbuf ( int , FILE *);
308 * The __sfoo macros are here so that we can
309 * define function versions in the C library.
311 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
312 #if defined(__GNUC__) && defined(__STDC__)
313 __header_always_inline
int __sputc ( int _c
, FILE * _p
) {
314 if (-- _p
-> _w
>= 0 || ( _p
-> _w
>= _p
-> _lbfsize
&& ( char ) _c
!= ' \n ' ))
315 return (* _p
-> _p
++ = _c
);
317 return ( __swbuf ( _c
, _p
));
321 * This has been tuned to generate reasonable code on the vax using pcc.
323 #define __sputc(c, p) \
325 (p)->_w >= (p)->_lbfsize ? \
326 (*(p)->_p = (c)), *(p)->_p != ' \n ' ? \
329 __swbuf((int)(c), p) : \
330 (*(p)->_p = (c), (int)*(p)->_p++))
333 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
334 #define __sferror(p) (((p)->_flags & __SERR) != 0)
335 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
336 #define __sfileno(p) ((p)->_file)
339 void flockfile ( FILE *);
340 int ftrylockfile ( FILE *);
341 void funlockfile ( FILE *);
342 int getc_unlocked ( FILE *);
343 int getchar_unlocked ( void );
344 int putc_unlocked ( int , FILE *);
345 int putchar_unlocked ( int );
347 /* Removed in Issue 6 */
348 #if !defined(_POSIX_C_SOURCE) || _POSIX_C_SOURCE < 200112L
350 int putw ( int , FILE *);
353 __swift_unavailable ( "Use mkstemp(3) instead." )
354 #if !defined(_POSIX_C_SOURCE)
355 __deprecated_msg ( "This function is provided for compatibility reasons only. Due to security concerns inherent in the design of tempnam(3), it is highly recommended that you use mkstemp(3) instead." )
358 #ifndef LIBC_ALIAS_TEMPNAM
360 char * tempnam ( const char * __dir
, const char * __prefix
) __DARWIN_ALIAS ( tempnam
);
362 #else /* LIBC_ALIAS_TEMPNAM */
363 char * tempnam ( const char * __dir
, const char * __prefix
) LIBC_ALIAS ( tempnam
);
364 #endif /* !LIBC_ALIAS_TEMPNAM */
369 #define getc_unlocked(fp) __sgetc(fp)
370 #define putc_unlocked(x, fp) __sputc(x, fp)
373 #define getchar_unlocked() getc_unlocked(stdin)
374 #define putchar_unlocked(x) putc_unlocked(x, stdout)
375 #endif /* __DARWIN_C_LEVEL >= 199506L */
379 /* Additional functionality provided by:
384 #if __DARWIN_C_LEVEL >= 200112L
385 #include <sys/_types/_off_t.h>
388 int fseeko ( FILE * __stream
, off_t __offset
, int __whence
);
389 off_t
ftello ( FILE * __stream
);
391 #endif /* __DARWIN_C_LEVEL >= 200112L */
393 #if __DARWIN_C_LEVEL >= 200112L || defined(_C99_SOURCE) || defined(__cplusplus)
395 int snprintf ( char * __restrict __str
, size_t __size
, const char * __restrict __format
, ...) __printflike ( 3 , 4 );
396 int vfscanf ( FILE * __restrict __stream
, const char * __restrict __format
, va_list ) __scanflike ( 2 , 0 );
397 int vscanf ( const char * __restrict __format
, va_list ) __scanflike ( 1 , 0 );
398 int vsnprintf ( char * __restrict __str
, size_t __size
, const char * __restrict __format
, va_list ) __printflike ( 3 , 0 );
399 int vsscanf ( const char * __restrict __str
, const char * __restrict __format
, va_list ) __scanflike ( 2 , 0 );
401 #endif /* __DARWIN_C_LEVEL >= 200112L || defined(_C99_SOURCE) || defined(__cplusplus) */
405 /* Additional functionality provided by:
409 #if __DARWIN_C_LEVEL >= 200809L
410 #include <sys/_types/_ssize_t.h>
413 int dprintf ( int , const char * __restrict
, ...) __printflike ( 2 , 3 ) __OSX_AVAILABLE_STARTING ( __MAC_10_7
, __IPHONE_4_3
);
414 int vdprintf ( int , const char * __restrict
, va_list ) __printflike ( 2 , 0 ) __OSX_AVAILABLE_STARTING ( __MAC_10_7
, __IPHONE_4_3
);
415 ssize_t
getdelim ( char ** __restrict __linep
, size_t * __restrict __linecapp
, int __delimiter
, FILE * __restrict __stream
) __OSX_AVAILABLE_STARTING ( __MAC_10_7
, __IPHONE_4_3
);
416 ssize_t
getline ( char ** __restrict __linep
, size_t * __restrict __linecapp
, FILE * __restrict __stream
) __OSX_AVAILABLE_STARTING ( __MAC_10_7
, __IPHONE_4_3
);
417 FILE * fmemopen ( void * __restrict __buf
, size_t __size
, const char * __restrict __mode
) __API_AVAILABLE ( macos ( 10.13 ), ios ( 11.0 ), tvos ( 11.0 ), watchos ( 4.0 ));
418 FILE * open_memstream ( char ** __bufp
, size_t * __sizep
) __API_AVAILABLE ( macos ( 10.13 ), ios ( 11.0 ), tvos ( 11.0 ), watchos ( 4.0 ));
420 #endif /* __DARWIN_C_LEVEL >= 200809L */
424 /* Darwin extensions */
426 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
428 extern __const
int sys_nerr
; /* perror(3) external variables */
429 extern __const
char * __const sys_errlist
[];
431 int asprintf ( char ** __restrict
, const char * __restrict
, ...) __printflike ( 2 , 3 );
432 char * ctermid_r ( char *);
433 char * fgetln ( FILE *, size_t *);
434 __const
char * fmtcheck ( const char *, const char *);
436 void setbuffer ( FILE *, char *, int );
437 int setlinebuf ( FILE *);
438 int vasprintf ( char ** __restrict
, const char * __restrict
, va_list ) __printflike ( 2 , 0 );
439 FILE * zopen ( const char *, const char *, int );
443 * Stdio function-access interface.
445 FILE * funopen ( const void *,
446 int (* _Nullable
)( void *, char *, int ),
447 int (* _Nullable
)( void *, const char *, int ),
448 fpos_t (* _Nullable
)( void *, fpos_t , int ),
449 int (* _Nullable
)( void *));
451 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
452 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
454 #define feof_unlocked(p) __sfeof(p)
455 #define ferror_unlocked(p) __sferror(p)
456 #define clearerr_unlocked(p) __sclearerr(p)
457 #define fileno_unlocked(p) __sfileno(p)
459 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
462 #ifdef _USE_EXTENDED_LOCALES_
463 #include <xlocale/_stdio.h>
464 #endif /* _USE_EXTENDED_LOCALES_ */
466 #if defined (__GNUC__) && _FORTIFY_SOURCE > 0 && !defined (__cplusplus)
467 /* Security checking functions. */
468 #include <secure/_stdio.h>
471 #endif /* _STDIO_H_ */