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