3a100ab7779d3b0228c8ab06e19a9690ca5cb6b3
[dragonfly.git] / lib / libc / stdio / priv_stdio.h
1 /*-
2  * Copyright (c) 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * Copyright (c) 2005 Joerg Sonnenberger <joerg@bec.de>.  All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * Chris Torek.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $DragonFly: src/lib/libc/stdio/priv_stdio.h,v 1.1 2005/07/23 20:23:06 joerg Exp $
34  */
35
36 #ifndef _LIBC_PRIV_STDIO_H_
37 #define _LIBC_PRIV_STDIO_H_
38
39 /* stdio buffers */
40 struct __sbuf {
41         unsigned char *_base;
42         int     _size;
43 };
44
45 struct __sFILEX;
46
47 /*
48  * _ub, _up, and _ur are used when ungetc() pushes back more characters
49  * than fit in the current _bf, or when ungetc() pushes back a character
50  * that does not match the previous one in _bf.  When this happens,
51  * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
52  * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
53  */
54
55 struct __FILE {
56         struct __FILE_public    pub;
57         struct  __sbuf _bf;     /* the buffer (at least 1 byte, if !NULL) */
58
59         /* operations */
60         void    *_cookie;       /* cookie passed to io functions */
61         int     (*_close) (void *);
62         int     (*_read)  (void *, char *, int);
63         fpos_t  (*_seek)  (void *, fpos_t, int);
64         int     (*_write) (void *, const char *, int);
65
66         /* separate buffer for long sequences of ungetc() */
67         struct  __sbuf _ub;     /* ungetc buffer */
68         struct  __sFILEX *_extra;
69         int     _ur;            /* saved _r when _r is counting ungetc data */
70
71         /* tricks to meet minimum requirements even when malloc() fails */
72         unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
73         unsigned char _nbuf[1]; /* guarantee a getc() buffer */
74
75         /* separate buffer for fgetln() when line crosses buffer boundary */
76         struct  __sbuf _lb;     /* buffer for fgetln() */
77
78         /* Unix stdio files get aligned to block boundaries on fseek() */
79         int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
80         fpos_t  _offset;        /* current lseek offset (see WARNING) */
81 };
82
83 /*
84  * I/O descriptors for __sfvwrite().
85  */
86 struct __siov {
87         void    *iov_base;
88         size_t  iov_len;
89 };
90 struct __suio {
91         struct  __siov *uio_iov;
92         int     uio_iovcnt;
93         int     uio_resid;
94 };
95
96 /*
97  * The first few FILEs are statically allocated; others are dynamically
98  * allocated and linked in via this glue structure.
99  */
100 struct glue {
101         struct  glue *next;
102         int     niobs;
103         FILE    *iobs;
104 };
105
106 extern struct glue __sglue;
107
108 __BEGIN_DECLS
109 int     __sfvwrite(FILE *, struct __suio *);
110 int     __fflush(FILE *);
111 int     __ungetc(int, FILE *);
112 __END_DECLS
113
114 #endif /* _LIBC_PRIV_STDIO_H_ */