xref: /freebsd/lib/libc/stdio/local.h (revision ae83180158c4c937f170e31eff311b18c0286a93)
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  *	@(#)local.h	8.3 (Berkeley) 7/3/94
37  * $FreeBSD$
38  */
39 
40 #include <sys/types.h>	/* for off_t */
41 #include <pthread.h>
42 #include <string.h>
43 #include <wchar.h>
44 
45 /*
46  * Information local to this implementation of stdio,
47  * in particular, macros and private variables.
48  */
49 
50 extern int	_sread(FILE *, char *, int);
51 extern int	_swrite(FILE *, char const *, int);
52 extern fpos_t	_sseek(FILE *, fpos_t, int);
53 extern int	_ftello(FILE *, fpos_t *);
54 extern int	_fseeko(FILE *, off_t, int, int);
55 extern int	__fflush(FILE *fp);
56 extern int	__sflush(FILE *);
57 extern FILE	*__sfp(void);
58 extern int	__srefill(FILE *);
59 extern int	__sread(void *, char *, int);
60 extern int	__swrite(void *, char const *, int);
61 extern fpos_t	__sseek(void *, fpos_t, int);
62 extern int	__sclose(void *);
63 extern void	__sinit(void);
64 extern void	_cleanup(void);
65 extern void	(*__cleanup)(void);
66 extern void	__smakebuf(FILE *);
67 extern int	__swhatbuf(FILE *, size_t *, int *);
68 extern int	_fwalk(int (*)(FILE *));
69 extern int	__swsetup(FILE *);
70 extern int	__sflags(const char *, int *);
71 extern int	__ungetc(int, FILE *);
72 extern int	__vfprintf(FILE *, const char *, _BSD_VA_LIST_);
73 
74 extern int	__sdidinit;
75 
76 
77 /* hold a buncha junk that would grow the ABI */
78 struct __sFILEX {
79 	unsigned char	*_up;	/* saved _p when _p is doing ungetc data */
80 	pthread_mutex_t	fl_mutex;	/* used for MT-safety */
81 	pthread_t	fl_owner;	/* current owner */
82 	int		fl_count;	/* recursive lock count */
83 	int		orientation;	/* orientation for fwide() */
84 #ifdef notdef
85 	/*
86 	 * XXX These are not used yet -- they will be used to store the
87 	 * multibyte conversion state for writing and reading when
88 	 * stateful encodings are supported by the locale framework.
89 	 */
90 	mbstate_t	wstate;		/* write conversion state */
91 	mbstate_t	rstate;		/* read conversion state */
92 #endif
93 };
94 
95 /*
96  * Return true iff the given FILE cannot be written now.
97  */
98 #define	cantwrite(fp) \
99  	((((fp)->_flags & __SWR) == 0 || \
100  	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
101 	 __swsetup(fp))
102 
103 /*
104  * Test whether the given stdio file has an active ungetc buffer;
105  * release such a buffer, without restoring ordinary unread data.
106  */
107 #define	HASUB(fp) ((fp)->_ub._base != NULL)
108 #define	FREEUB(fp) { \
109 	if ((fp)->_ub._base != (fp)->_ubuf) \
110 		free((char *)(fp)->_ub._base); \
111 	(fp)->_ub._base = NULL; \
112 }
113 
114 /*
115  * test for an fgetln() buffer.
116  */
117 #define	HASLB(fp) ((fp)->_lb._base != NULL)
118 #define	FREELB(fp) { \
119 	free((char *)(fp)->_lb._base); \
120 	(fp)->_lb._base = NULL; \
121 }
122 
123 #define	INITEXTRA(fp) { \
124 	(fp)->_extra->_up = NULL; \
125 	(fp)->_extra->fl_mutex = PTHREAD_MUTEX_INITIALIZER; \
126 	(fp)->_extra->fl_owner = NULL; \
127 	(fp)->_extra->fl_count = 0; \
128 	(fp)->_extra->orientation = 0; \
129 	/* memset(&(fp)->_extra->wstate, 0, sizeof(mbstate_t)); */ \
130 	/* memset(&(fp)->_extra->rstate, 0, sizeof(mbstate_t)); */ \
131 }
132 
133 /*
134  * Set the orientation for a stream. If o > 0, the stream has wide-
135  * orientation. If o < 0, the stream has byte-orientation.
136  */
137 #define	ORIENT(fp, o)	do {				\
138 	if ((fp)->_extra->orientation == 0)		\
139 		(fp)->_extra->orientation = (o);	\
140 } while (0)
141 #ifdef FLOCKFILE
142 #define	ORIENTLOCK(fp, o)	do {			\
143 	FLOCKFILE(fp);					\
144 	ORIENT(fp, o);					\
145 	FUNLOCKFILE(fp);				\
146 } while (0)
147 #endif
148