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