include/stdio.h

   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. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)stdio.h     8.5 (Berkeley) 4/29/95
  37  * $FreeBSD: src/include/stdio.h,v 1.24.2.5 2002/11/09 08:07:20 imp Exp $
  38  * $DragonFly: src/include/stdio.h,v 1.12 2007/04/17 22:25:45 corecode Exp $
  39  */
  40
  41 #ifndef _STDIO_H_
  42 #define _STDIO_H_
  43
  44 #include <sys/cdefs.h>
  45 #ifndef _SYS_STDINT_H_
  46 #include <sys/stdint.h>
  47 #endif
  48 #ifndef _MACHINE_STDARG_H_
  49 #include <machine/stdarg.h>
  50 #endif
  51
  52 #ifndef _SIZE_T_DECLARED
  53 #define _SIZE_T_DECLARED
  54 typedef __size_t        size_t;
  55 #endif
  56
  57 #ifndef NULL
  58 #define NULL    0
  59 #endif
  60
  61 typedef __off_t fpos_t;
  62
  63 /*
  64  * stdio state variables.
  65  *
  66  * The following always hold:
  67  *
  68  *      if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  69  *              _lbfsize is -_bf._size, else _lbfsize is 0
  70  *      if _flags&__SRD, _w is 0
  71  *      if _flags&__SWR, _r is 0
  72  *
  73  * This ensures that the getc and putc macros (or inline functions) never
  74  * try to write or read from a file that is in `read' or `write' mode.
  75  * (Moreover, they can, and do, automatically switch from read mode to
  76  * write mode, and back, on "r+" and "w+" files.)
  77  *
  78  * _lbfsize is used only to make the inline line-buffered output stream
  79  * code as compact as possible.
  80  *
  81  * WARNING: Do not change the order of the fields in __FILE_public!
  82  */
  83 typedef struct __FILE FILE;
  84
  85 struct __FILE_public {
  86         unsigned char   *_p;    /* current position in (some) buffer */
  87         int             _flags;         /* flags, below; this FILE is free if 0 */
  88         int             _fileno;        /* fileno, if Unix descriptor, else -1 */
  89         __ssize_t       _r;             /* read space left for getc() */
  90         __ssize_t       _w;             /* write space left for putc() */
  91         __ssize_t       _lbfsize;       /* 0 or -_bf._size, for inline putc */
  92 };
  93
  94 __BEGIN_DECLS
  95 extern FILE *__stdinp, *__stdoutp, *__stderrp;
  96 __END_DECLS
  97
  98 #define __SLBF  0x0001          /* line buffered */
  99 #define __SNBF  0x0002          /* unbuffered */
 100 #define __SRD   0x0004          /* OK to read */
 101 #define __SWR   0x0008          /* OK to write */
 102         /* RD and WR are never simultaneously asserted */
 103 #define __SRW   0x0010          /* open for reading & writing */
 104 #define __SEOF  0x0020          /* found EOF */
 105 #define __SERR  0x0040          /* found error */
 106 #define __SMBF  0x0080          /* _buf is from malloc */
 107 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 108 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 109 #define __SOPT  0x0400          /* do fseek() optimization */
 110 #define __SNPT  0x0800          /* do not do fseek() optimization */
 111 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 112 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 113 #define __SALC  0x4000          /* allocate string space dynamically */
 114
 115 /*
 116  * The following three definitions are for ANSI C, which took them
 117  * from System V, which brilliantly took internal interface macros and
 118  * made them official arguments to setvbuf(), without renaming them.
 119  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 120  *
 121  * Although numbered as their counterparts above, the implementation
 122  * does not rely on this.
 123  */
 124 #define _IOFBF  0               /* setvbuf should set fully buffered */
 125 #define _IOLBF  1               /* setvbuf should set line buffered */
 126 #define _IONBF  2               /* setvbuf should set unbuffered */
 127
 128 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 129 #define EOF     (-1)
 130
 131 /*
 132  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 133  * stdio can provide without attempting to allocate further resources
 134  * (which could fail).  Do not use this for anything.
 135  */
 136                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 137 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 138 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 139
 140 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 141 #ifndef _ANSI_SOURCE
 142 #define P_tmpdir        "/tmp/"
 143 #endif
 144 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 145 #define TMP_MAX         308915776
 146
 147 #ifndef SEEK_SET
 148 #define SEEK_SET        0       /* set file offset to offset */
 149 #endif
 150 #ifndef SEEK_CUR
 151 #define SEEK_CUR        1       /* set file offset to current plus offset */
 152 #endif
 153 #ifndef SEEK_END
 154 #define SEEK_END        2       /* set file offset to EOF plus offset */
 155 #endif
 156
 157 #define stdin   (__stdinp)
 158 #define stdout  (__stdoutp)
 159 #define stderr  (__stderrp)
 160
 161 /*
 162  * Functions defined in ANSI C standard.
 163  */
 164 __BEGIN_DECLS
 165 void     clearerr(FILE *);
 166 int      fclose(FILE *);
 167 int      feof(FILE *);
 168 int      feof_unlocked(FILE *);
 169 int      ferror(FILE *);
 170 int      ferror_unlocked(FILE *);
 171 int      fflush(FILE *);
 172 int      fgetc(FILE *);
 173 int      fgetpos(FILE *, fpos_t *);
 174 char    *fgets(char *, int, FILE *);
 175 FILE    *fopen(const char *, const char *);
 176 int      fprintf(FILE *, const char *, ...);
 177 int      fputc(int, FILE *);
 178 int      fputs(const char *, FILE *);
 179 size_t   fread(void *, size_t, size_t, FILE *);
 180 FILE    *freopen(const char *, const char *, FILE *);
 181 int      fscanf(FILE *, const char *, ...);
 182 int      fseek(FILE *, long, int);
 183 int      fsetpos(FILE *, const fpos_t *);
 184 long     ftell(FILE *);
 185 size_t   fwrite(const void *, size_t, size_t, FILE *);
 186 int      getc(FILE *);
 187 int      getc_unlocked(FILE *);
 188 int      getchar(void);
 189 int      getchar_unlocked(void);
 190 char    *gets(char *);
 191 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 192 extern __const int sys_nerr;            /* perror(3) external variables */
 193 extern __const char *__const sys_errlist[];
 194 #endif
 195 void     perror(const char *);
 196 int      printf(const char *, ...);
 197 int      putc(int, FILE *);
 198 int      putc_unlocked(int, FILE *);
 199 int      putchar(int);
 200 int      putchar_unlocked(int);
 201 int      puts(const char *);
 202 int      remove(const char *);
 203 int      rename(const char *, const char *);
 204 void     rewind(FILE *);
 205 int      scanf(const char *, ...);
 206 void     setbuf(FILE *, char *);
 207 int      setvbuf(FILE *, char *, int, size_t);
 208 int      sprintf(char *, const char *, ...);
 209 int      sscanf(const char *, const char *, ...);
 210 FILE    *tmpfile(void);
 211 char    *tmpnam(char *);
 212 int      ungetc(int, FILE *);
 213 int      vfprintf(FILE *, const char *, __va_list);
 214 int      vprintf(const char *, __va_list);
 215 int      vsprintf(char *, const char *, __va_list);
 216 __END_DECLS
 217
 218 /*
 219  * Functions defined in POSIX 1003.1.
 220  */
 221 #ifndef _ANSI_SOURCE
 222 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
 223 #define L_cuserid       17
 224
 225 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 226
 227 __BEGIN_DECLS
 228 char    *ctermid(char *);
 229 FILE    *fdopen(int, const char *);
 230 int      fileno(FILE *);
 231 int      fileno_unlocked(FILE *);
 232 int      ftrylockfile(FILE *);
 233 void     flockfile(FILE *);
 234 void     funlockfile(FILE *);
 235 __END_DECLS
 236 #endif /* not ANSI */
 237
 238 /*
 239  * Portability hacks.  See <sys/types.h>.
 240  */
 241 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 242 __BEGIN_DECLS
 243 #ifndef _FTRUNCATE_DECLARED
 244 #define _FTRUNCATE_DECLARED
 245 int      ftruncate(int, __off_t);
 246 #endif
 247 #ifndef _LSEEK_DECLARED
 248 #define _LSEEK_DECLARED
 249 __off_t  lseek(int, __off_t, int);
 250 #endif
 251 #ifndef _MMAP_DECLARED
 252 #define _MMAP_DECLARED
 253 void    *mmap(void *, size_t, int, int, int, __off_t);
 254 #endif
 255 #ifndef _TRUNCATE_DECLARED
 256 #define _TRUNCATE_DECLARED
 257 int      truncate(const char *, __off_t);
 258 #endif
 259 __END_DECLS
 260 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
 261
 262 /*
 263  * Routines that are purely local.
 264  */
 265 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 266 __BEGIN_DECLS
 267 int      asprintf(char **, const char *, ...) __printflike(2, 3);
 268 char    *ctermid_r(char *);
 269 void    *fcookie(FILE *);
 270 char    *fgetln(FILE *, size_t *);
 271 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3
 272 #define __ATTR_FORMAT_ARG       __attribute__((__format_arg__(2)))
 273 #else
 274 #define __ATTR_FORMAT_ARG
 275 #endif
 276 const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG;
 277 __ssize_t __fpending(FILE *);
 278 int      fpurge(FILE *);
 279 int      fseeko(FILE *, __off_t, int);
 280 __off_t  ftello(FILE *);
 281 int      getw(FILE *);
 282 int      pclose(FILE *);
 283 FILE    *popen(const char *, const char *);
 284 int      putw(int, FILE *);
 285 void     setbuffer(FILE *, char *, int);
 286 int      setlinebuf(FILE *);
 287 char    *tempnam(const char *, const char *);
 288 int      snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
 289 int      vasprintf(char **, const char *, __va_list)
 290             __printflike(2, 0);
 291 int      vsnprintf (char *, size_t, const char *, __va_list)
 292             __printflike(3, 0);
 293 int      vscanf(const char *, __va_list) __scanflike(1, 0);
 294 int      vsscanf(const char *, const char *, __va_list)
 295             __scanflike(2, 0);
 296 __END_DECLS
 297
 298 /*
 299  * This is a #define because the function is used internally and
 300  * (unlike vfscanf) the name __vfscanf is guaranteed not to collide
 301  * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
 302  */
 303 #define  vfscanf        __vfscanf
 304
 305 /*
 306  * Stdio function-access interface.
 307  */
 308 __BEGIN_DECLS
 309 FILE    *funopen(const void *,
 310                  int (*)(void *, char *, int),
 311                  int (*)(void *, const char *, int),
 312                  fpos_t (*)(void *, fpos_t, int),
 313                  int (*)(void *));
 314 __END_DECLS
 315 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 316 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 317 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
 318
 319 /*
 320  * Functions internal to the implementation.
 321  */
 322 __BEGIN_DECLS
 323 int     __srget(FILE *);
 324 int     __vfscanf(FILE *, const char *, __va_list);
 325 int     __svfscanf(FILE *, const char *, __va_list);
 326 int     __swbuf(int, FILE *);
 327 __END_DECLS
 328
 329 /*
 330  * The __sfoo functions are here so that we can
 331  * define real function versions in the C library.
 332  */
 333 static __inline int
 334 __sgetc(FILE *_fp)
 335 {
 336         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 337
 338         if (--_p->_r < 0)
 339                 return (__srget(_fp));
 340         else
 341                 return (*_p->_p++);
 342 }
 343
 344 static __inline int
 345 __sputc(int _c, FILE *_fp)
 346 {
 347         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 348
 349         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && _c != '\n'))
 350                 return (*_p->_p++ = _c);
 351         else
 352                 return (__swbuf(_c, _fp));
 353 }
 354
 355 static __inline int
 356 __sfeof(FILE *_fp)
 357 {
 358         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 359
 360         return ((_p->_flags & __SEOF) != 0);
 361 }
 362
 363 static __inline int
 364 __sferror(FILE *_fp)
 365 {
 366         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 367
 368         return ((_p->_flags & __SERR) != 0);
 369 }
 370
 371 static __inline void
 372 __sclearerr(FILE *_fp)
 373 {
 374         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 375
 376         _p->_flags &= ~(__SERR|__SEOF);
 377 }
 378
 379 static __inline int
 380 __sfileno(FILE *_fp)
 381 {
 382         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 383
 384         return (_p->_fileno);
 385 }
 386
 387 /*
 388  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
 389  * B.8.2.7 for the rationale behind the *_unlocked() macros.
 390  */
 391 #define feof_unlocked(p)        __sfeof(p)
 392 #define ferror_unlocked(p)      __sferror(p)
 393 #define clearerr_unlocked(p)    __sclearerr(p)
 394
 395 #ifndef _ANSI_SOURCE
 396 #define fileno_unlocked(p)      __sfileno(p)
 397 #endif
 398
 399 #define getc_unlocked(fp)       __sgetc(fp)
 400 #define putc_unlocked(x, fp)    __sputc(x, fp)
 401
 402 #define getchar_unlocked()      getc_unlocked(stdin)
 403 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 404
 405 #endif /* !_STDIO_H_ */