/include/stdio.h

https://bitbucket.org/freebsd/freebsd-head/ · C Header · 521 lines · 327 code · 57 blank · 137 comment · 17 complexity · 7e7ff4b62c51805d9a32624a7dd204f4 MD5 · raw file

  1. /*-
  2. * Copyright (c) 1990, 1993
  3. * The Regents of the University of California. All rights reserved.
  4. *
  5. * This code is derived from software contributed to Berkeley by
  6. * Chris Torek.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in the
  15. * documentation and/or other materials provided with the distribution.
  16. * 3. Neither the name of the University nor the names of its contributors
  17. * may be used to endorse or promote products derived from this software
  18. * without specific prior written permission.
  19. *
  20. * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23. * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30. * SUCH DAMAGE.
  31. *
  32. * @(#)stdio.h 8.5 (Berkeley) 4/29/95
  33. * $FreeBSD$
  34. */
  35. #ifndef _STDIO_H_
  36. #define _STDIO_H_
  37. #include <sys/cdefs.h>
  38. #include <sys/_null.h>
  39. #include <sys/_types.h>
  40. typedef __off_t fpos_t;
  41. #ifndef _SIZE_T_DECLARED
  42. typedef __size_t size_t;
  43. #define _SIZE_T_DECLARED
  44. #endif
  45. #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
  46. #ifndef _OFF_T_DECLARED
  47. #define _OFF_T_DECLARED
  48. typedef __off_t off_t;
  49. #endif
  50. #ifndef _SSIZE_T_DECLARED
  51. #define _SSIZE_T_DECLARED
  52. typedef __ssize_t ssize_t;
  53. #endif
  54. #endif
  55. #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
  56. #ifndef _VA_LIST_DECLARED
  57. typedef __va_list va_list;
  58. #define _VA_LIST_DECLARED
  59. #endif
  60. #endif
  61. #define _FSTDIO /* Define for new stdio with functions. */
  62. /*
  63. * NB: to fit things in six character monocase externals, the stdio
  64. * code uses the prefix `__s' for stdio objects, typically followed
  65. * by a three-character attempt at a mnemonic.
  66. */
  67. /* stdio buffers */
  68. struct __sbuf {
  69. unsigned char *_base;
  70. int _size;
  71. };
  72. /*
  73. * stdio state variables.
  74. *
  75. * The following always hold:
  76. *
  77. * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  78. * _lbfsize is -_bf._size, else _lbfsize is 0
  79. * if _flags&__SRD, _w is 0
  80. * if _flags&__SWR, _r is 0
  81. *
  82. * This ensures that the getc and putc macros (or inline functions) never
  83. * try to write or read from a file that is in `read' or `write' mode.
  84. * (Moreover, they can, and do, automatically switch from read mode to
  85. * write mode, and back, on "r+" and "w+" files.)
  86. *
  87. * _lbfsize is used only to make the inline line-buffered output stream
  88. * code as compact as possible.
  89. *
  90. * _ub, _up, and _ur are used when ungetc() pushes back more characters
  91. * than fit in the current _bf, or when ungetc() pushes back a character
  92. * that does not match the previous one in _bf. When this happens,
  93. * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
  94. * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
  95. *
  96. * Certain members of __sFILE are accessed directly via macros or
  97. * inline functions. To preserve ABI compat, these members must not
  98. * be disturbed. These members are marked below with (*).
  99. */
  100. struct __sFILE {
  101. unsigned char *_p; /* (*) current position in (some) buffer */
  102. int _r; /* (*) read space left for getc() */
  103. int _w; /* (*) write space left for putc() */
  104. short _flags; /* (*) flags, below; this FILE is free if 0 */
  105. short _file; /* (*) fileno, if Unix descriptor, else -1 */
  106. struct __sbuf _bf; /* (*) the buffer (at least 1 byte, if !NULL) */
  107. int _lbfsize; /* (*) 0 or -_bf._size, for inline putc */
  108. /* operations */
  109. void *_cookie; /* (*) cookie passed to io functions */
  110. int (*_close)(void *);
  111. int (*_read)(void *, char *, int);
  112. fpos_t (*_seek)(void *, fpos_t, int);
  113. int (*_write)(void *, const char *, int);
  114. /* separate buffer for long sequences of ungetc() */
  115. struct __sbuf _ub; /* ungetc buffer */
  116. unsigned char *_up; /* saved _p when _p is doing ungetc data */
  117. int _ur; /* saved _r when _r is counting ungetc data */
  118. /* tricks to meet minimum requirements even when malloc() fails */
  119. unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
  120. unsigned char _nbuf[1]; /* guarantee a getc() buffer */
  121. /* separate buffer for fgetln() when line crosses buffer boundary */
  122. struct __sbuf _lb; /* buffer for fgetln() */
  123. /* Unix stdio files get aligned to block boundaries on fseek() */
  124. int _blksize; /* stat.st_blksize (may be != _bf._size) */
  125. fpos_t _offset; /* current lseek offset */
  126. struct pthread_mutex *_fl_mutex; /* used for MT-safety */
  127. struct pthread *_fl_owner; /* current owner */
  128. int _fl_count; /* recursive lock count */
  129. int _orientation; /* orientation for fwide() */
  130. __mbstate_t _mbstate; /* multibyte conversion state */
  131. };
  132. #ifndef _STDFILE_DECLARED
  133. #define _STDFILE_DECLARED
  134. typedef struct __sFILE FILE;
  135. #endif
  136. #ifndef _STDSTREAM_DECLARED
  137. __BEGIN_DECLS
  138. extern FILE *__stdinp;
  139. extern FILE *__stdoutp;
  140. extern FILE *__stderrp;
  141. __END_DECLS
  142. #define _STDSTREAM_DECLARED
  143. #endif
  144. #define __SLBF 0x0001 /* line buffered */
  145. #define __SNBF 0x0002 /* unbuffered */
  146. #define __SRD 0x0004 /* OK to read */
  147. #define __SWR 0x0008 /* OK to write */
  148. /* RD and WR are never simultaneously asserted */
  149. #define __SRW 0x0010 /* open for reading & writing */
  150. #define __SEOF 0x0020 /* found EOF */
  151. #define __SERR 0x0040 /* found error */
  152. #define __SMBF 0x0080 /* _buf is from malloc */
  153. #define __SAPP 0x0100 /* fdopen()ed in append mode */
  154. #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
  155. #define __SOPT 0x0400 /* do fseek() optimization */
  156. #define __SNPT 0x0800 /* do not do fseek() optimization */
  157. #define __SOFF 0x1000 /* set iff _offset is in fact correct */
  158. #define __SMOD 0x2000 /* true => fgetln modified _p text */
  159. #define __SALC 0x4000 /* allocate string space dynamically */
  160. #define __SIGN 0x8000 /* ignore this file in _fwalk */
  161. /*
  162. * The following three definitions are for ANSI C, which took them
  163. * from System V, which brilliantly took internal interface macros and
  164. * made them official arguments to setvbuf(), without renaming them.
  165. * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
  166. *
  167. * Although numbered as their counterparts above, the implementation
  168. * does not rely on this.
  169. */
  170. #define _IOFBF 0 /* setvbuf should set fully buffered */
  171. #define _IOLBF 1 /* setvbuf should set line buffered */
  172. #define _IONBF 2 /* setvbuf should set unbuffered */
  173. #define BUFSIZ 1024 /* size of buffer used by setbuf */
  174. #define EOF (-1)
  175. /*
  176. * FOPEN_MAX is a minimum maximum, and is the number of streams that
  177. * stdio can provide without attempting to allocate further resources
  178. * (which could fail). Do not use this for anything.
  179. */
  180. /* must be == _POSIX_STREAM_MAX <limits.h> */
  181. #ifndef FOPEN_MAX
  182. #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
  183. #endif
  184. #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
  185. /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
  186. #if __XSI_VISIBLE
  187. #define P_tmpdir "/tmp/"
  188. #endif
  189. #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
  190. #define TMP_MAX 308915776
  191. #ifndef SEEK_SET
  192. #define SEEK_SET 0 /* set file offset to offset */
  193. #endif
  194. #ifndef SEEK_CUR
  195. #define SEEK_CUR 1 /* set file offset to current plus offset */
  196. #endif
  197. #ifndef SEEK_END
  198. #define SEEK_END 2 /* set file offset to EOF plus offset */
  199. #endif
  200. #define stdin __stdinp
  201. #define stdout __stdoutp
  202. #define stderr __stderrp
  203. __BEGIN_DECLS
  204. #ifdef _XLOCALE_H_
  205. #include <xlocale/_stdio.h>
  206. #endif
  207. /*
  208. * Functions defined in ANSI C standard.
  209. */
  210. void clearerr(FILE *);
  211. int fclose(FILE *);
  212. int feof(FILE *);
  213. int ferror(FILE *);
  214. int fflush(FILE *);
  215. int fgetc(FILE *);
  216. int fgetpos(FILE * __restrict, fpos_t * __restrict);
  217. char *fgets(char * __restrict, int, FILE * __restrict);
  218. FILE *fopen(const char * __restrict, const char * __restrict);
  219. int fprintf(FILE * __restrict, const char * __restrict, ...);
  220. int fputc(int, FILE *);
  221. int fputs(const char * __restrict, FILE * __restrict);
  222. size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
  223. FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
  224. int fscanf(FILE * __restrict, const char * __restrict, ...);
  225. int fseek(FILE *, long, int);
  226. int fsetpos(FILE *, const fpos_t *);
  227. long ftell(FILE *);
  228. size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
  229. int getc(FILE *);
  230. int getchar(void);
  231. char *gets(char *);
  232. void perror(const char *);
  233. int printf(const char * __restrict, ...);
  234. int putc(int, FILE *);
  235. int putchar(int);
  236. int puts(const char *);
  237. int remove(const char *);
  238. int rename(const char *, const char *);
  239. void rewind(FILE *);
  240. int scanf(const char * __restrict, ...);
  241. void setbuf(FILE * __restrict, char * __restrict);
  242. int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
  243. int sprintf(char * __restrict, const char * __restrict, ...);
  244. int sscanf(const char * __restrict, const char * __restrict, ...);
  245. FILE *tmpfile(void);
  246. char *tmpnam(char *);
  247. int ungetc(int, FILE *);
  248. int vfprintf(FILE * __restrict, const char * __restrict,
  249. __va_list);
  250. int vprintf(const char * __restrict, __va_list);
  251. int vsprintf(char * __restrict, const char * __restrict,
  252. __va_list);
  253. #if __ISO_C_VISIBLE >= 1999
  254. int snprintf(char * __restrict, size_t, const char * __restrict,
  255. ...) __printflike(3, 4);
  256. int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
  257. __scanflike(2, 0);
  258. int vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
  259. int vsnprintf(char * __restrict, size_t, const char * __restrict,
  260. __va_list) __printflike(3, 0);
  261. int vsscanf(const char * __restrict, const char * __restrict, __va_list)
  262. __scanflike(2, 0);
  263. #endif
  264. /*
  265. * Functions defined in all versions of POSIX 1003.1.
  266. */
  267. #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
  268. #define L_cuserid 17 /* size for cuserid(3); MAXLOGNAME, legacy */
  269. #endif
  270. #if __POSIX_VISIBLE
  271. #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
  272. char *ctermid(char *);
  273. FILE *fdopen(int, const char *);
  274. int fileno(FILE *);
  275. #endif /* __POSIX_VISIBLE */
  276. #if __POSIX_VISIBLE >= 199209
  277. int pclose(FILE *);
  278. FILE *popen(const char *, const char *);
  279. #endif
  280. #if __POSIX_VISIBLE >= 199506
  281. int ftrylockfile(FILE *);
  282. void flockfile(FILE *);
  283. void funlockfile(FILE *);
  284. /*
  285. * These are normally used through macros as defined below, but POSIX
  286. * requires functions as well.
  287. */
  288. int getc_unlocked(FILE *);
  289. int getchar_unlocked(void);
  290. int putc_unlocked(int, FILE *);
  291. int putchar_unlocked(int);
  292. #endif
  293. #if __BSD_VISIBLE
  294. void clearerr_unlocked(FILE *);
  295. int feof_unlocked(FILE *);
  296. int ferror_unlocked(FILE *);
  297. int fileno_unlocked(FILE *);
  298. #endif
  299. #if __POSIX_VISIBLE >= 200112
  300. int fseeko(FILE *, __off_t, int);
  301. __off_t ftello(FILE *);
  302. #endif
  303. #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
  304. int getw(FILE *);
  305. int putw(int, FILE *);
  306. #endif /* BSD or X/Open before issue 6 */
  307. #if __XSI_VISIBLE
  308. char *tempnam(const char *, const char *);
  309. #endif
  310. #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
  311. ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
  312. FILE * __restrict);
  313. int renameat(int, const char *, int, const char *);
  314. int vdprintf(int, const char * __restrict, __va_list);
  315. /*
  316. * Every programmer and his dog wrote functions called getline() and dprintf()
  317. * before POSIX.1-2008 came along and decided to usurp the names, so we
  318. * don't prototype them by default unless one of the following is true:
  319. * a) the app has requested them specifically by defining _WITH_GETLINE or
  320. * _WITH_DPRINTF, respectively
  321. * b) the app has requested a POSIX.1-2008 environment via _POSIX_C_SOURCE
  322. * c) the app defines a GNUism such as _BSD_SOURCE or _GNU_SOURCE
  323. */
  324. #ifndef _WITH_GETLINE
  325. #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
  326. #define _WITH_GETLINE
  327. #elif defined(_POSIX_C_SOURCE)
  328. #if _POSIX_C_SOURCE >= 200809
  329. #define _WITH_GETLINE
  330. #endif
  331. #endif
  332. #endif
  333. #ifdef _WITH_GETLINE
  334. ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
  335. #endif
  336. #ifndef _WITH_DPRINTF
  337. #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
  338. #define _WITH_DPRINTF
  339. #elif defined(_POSIX_C_SOURCE)
  340. #if _POSIX_C_SOURCE >= 200809
  341. #define _WITH_DPRINTF
  342. #endif
  343. #endif
  344. #endif
  345. #ifdef _WITH_DPRINTF
  346. int (dprintf)(int, const char * __restrict, ...);
  347. #endif
  348. #endif /* __BSD_VISIBLE || __POSIX_VISIBLE >= 200809 */
  349. /*
  350. * Routines that are purely local.
  351. */
  352. #if __BSD_VISIBLE
  353. int asprintf(char **, const char *, ...) __printflike(2, 3);
  354. char *ctermid_r(char *);
  355. void fcloseall(void);
  356. char *fgetln(FILE *, size_t *);
  357. const char *fmtcheck(const char *, const char *) __format_arg(2);
  358. int fpurge(FILE *);
  359. void setbuffer(FILE *, char *, int);
  360. int setlinebuf(FILE *);
  361. int vasprintf(char **, const char *, __va_list)
  362. __printflike(2, 0);
  363. /*
  364. * The system error table contains messages for the first sys_nerr
  365. * positive errno values. Use strerror() or strerror_r() from <string.h>
  366. * instead.
  367. */
  368. extern const int sys_nerr;
  369. extern const char * const sys_errlist[];
  370. /*
  371. * Stdio function-access interface.
  372. */
  373. FILE *funopen(const void *,
  374. int (*)(void *, char *, int),
  375. int (*)(void *, const char *, int),
  376. fpos_t (*)(void *, fpos_t, int),
  377. int (*)(void *));
  378. #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
  379. #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
  380. /*
  381. * Portability hacks. See <sys/types.h>.
  382. */
  383. #ifndef _FTRUNCATE_DECLARED
  384. #define _FTRUNCATE_DECLARED
  385. int ftruncate(int, __off_t);
  386. #endif
  387. #ifndef _LSEEK_DECLARED
  388. #define _LSEEK_DECLARED
  389. __off_t lseek(int, __off_t, int);
  390. #endif
  391. #ifndef _MMAP_DECLARED
  392. #define _MMAP_DECLARED
  393. void *mmap(void *, size_t, int, int, int, __off_t);
  394. #endif
  395. #ifndef _TRUNCATE_DECLARED
  396. #define _TRUNCATE_DECLARED
  397. int truncate(const char *, __off_t);
  398. #endif
  399. #endif /* __BSD_VISIBLE */
  400. /*
  401. * Functions internal to the implementation.
  402. */
  403. int __srget(FILE *);
  404. int __swbuf(int, FILE *);
  405. /*
  406. * The __sfoo macros are here so that we can
  407. * define function versions in the C library.
  408. */
  409. #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
  410. #if defined(__GNUC__) && defined(__STDC__)
  411. static __inline int __sputc(int _c, FILE *_p) {
  412. if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
  413. return (*_p->_p++ = _c);
  414. else
  415. return (__swbuf(_c, _p));
  416. }
  417. #else
  418. /*
  419. * This has been tuned to generate reasonable code on the vax using pcc.
  420. */
  421. #define __sputc(c, p) \
  422. (--(p)->_w < 0 ? \
  423. (p)->_w >= (p)->_lbfsize ? \
  424. (*(p)->_p = (c)), *(p)->_p != '\n' ? \
  425. (int)*(p)->_p++ : \
  426. __swbuf('\n', p) : \
  427. __swbuf((int)(c), p) : \
  428. (*(p)->_p = (c), (int)*(p)->_p++))
  429. #endif
  430. extern int __isthreaded;
  431. #ifndef __cplusplus
  432. #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
  433. #define __sferror(p) (((p)->_flags & __SERR) != 0)
  434. #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
  435. #define __sfileno(p) ((p)->_file)
  436. #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
  437. #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
  438. #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
  439. #if __POSIX_VISIBLE
  440. #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
  441. #endif
  442. #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
  443. #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
  444. #define getchar() getc(stdin)
  445. #define putchar(x) putc(x, stdout)
  446. #if __BSD_VISIBLE
  447. /*
  448. * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
  449. * B.8.2.7 for the rationale behind the *_unlocked() macros.
  450. */
  451. #define feof_unlocked(p) __sfeof(p)
  452. #define ferror_unlocked(p) __sferror(p)
  453. #define clearerr_unlocked(p) __sclearerr(p)
  454. #define fileno_unlocked(p) __sfileno(p)
  455. #endif
  456. #if __POSIX_VISIBLE >= 199506
  457. #define getc_unlocked(fp) __sgetc(fp)
  458. #define putc_unlocked(x, fp) __sputc(x, fp)
  459. #define getchar_unlocked() getc_unlocked(stdin)
  460. #define putchar_unlocked(x) putc_unlocked(x, stdout)
  461. #endif
  462. #endif /* __cplusplus */
  463. __END_DECLS
  464. #endif /* !_STDIO_H_ */