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