local.h revision 157959
1260525Sjmmv/*-
2260525Sjmmv * Copyright (c) 1990, 1993
3260525Sjmmv *	The Regents of the University of California.  All rights reserved.
4260525Sjmmv *
5260525Sjmmv * This code is derived from software contributed to Berkeley by
6260525Sjmmv * Chris Torek.
7260525Sjmmv *
8260525Sjmmv * Redistribution and use in source and binary forms, with or without
9260525Sjmmv * modification, are permitted provided that the following conditions
10260525Sjmmv * are met:
11260525Sjmmv * 1. Redistributions of source code must retain the above copyright
12260525Sjmmv *    notice, this list of conditions and the following disclaimer.
13260525Sjmmv * 2. Redistributions in binary form must reproduce the above copyright
14260525Sjmmv *    notice, this list of conditions and the following disclaimer in the
15260525Sjmmv *    documentation and/or other materials provided with the distribution.
16260525Sjmmv * 3. All advertising materials mentioning features or use of this software
17260525Sjmmv *    must display the following acknowledgement:
18260525Sjmmv *	This product includes software developed by the University of
19260525Sjmmv *	California, Berkeley and its contributors.
20260525Sjmmv * 4. Neither the name of the University nor the names of its contributors
21260525Sjmmv *    may be used to endorse or promote products derived from this software
22260525Sjmmv *    without specific prior written permission.
23260525Sjmmv *
24260525Sjmmv * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25262855Sjmmv * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26262855Sjmmv * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27262855Sjmmv * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28262855Sjmmv * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29262855Sjmmv * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30262855Sjmmv * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31262855Sjmmv * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32260525Sjmmv * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33262855Sjmmv * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34264483Sjmmv * SUCH DAMAGE.
35 *
36 *	@(#)local.h	8.3 (Berkeley) 7/3/94
37 * $FreeBSD: head/lib/libc/stdio/local.h 157959 2006-04-22 15:09:15Z deischen $
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 void	__fcloseall(void);
57extern wint_t	__fgetwc(FILE *);
58extern wint_t	__fputwc(wchar_t, FILE *);
59extern int	__sflush(FILE *);
60extern FILE	*__sfp(void);
61extern int	__slbexpand(FILE *, size_t);
62extern int	__srefill(FILE *);
63extern int	__sread(void *, char *, int);
64extern int	__swrite(void *, char const *, int);
65extern fpos_t	__sseek(void *, fpos_t, int);
66extern int	__sclose(void *);
67extern void	__sinit(void);
68extern void	_cleanup(void);
69extern void	__smakebuf(FILE *);
70extern int	__swhatbuf(FILE *, size_t *, int *);
71extern int	_fwalk(int (*)(FILE *));
72extern int	__svfscanf(FILE *, const char *, __va_list);
73extern int	__swsetup(FILE *);
74extern int	__sflags(const char *, int *);
75extern int	__ungetc(int, FILE *);
76extern wint_t	__ungetwc(wint_t, FILE *);
77extern int	__vfprintf(FILE *, const char *, __va_list);
78extern int	__vfscanf(FILE *, const char *, __va_list);
79extern int	__vfwprintf(FILE *, const wchar_t *, __va_list);
80extern int	__vfwscanf(FILE * __restrict, const wchar_t * __restrict,
81		    __va_list);
82extern size_t	__fread(void * __restrict buf, size_t size, size_t count,
83		FILE * __restrict fp);
84extern int	__sdidinit;
85
86
87/* hold a buncha junk that would grow the ABI */
88struct __sFILEX {
89	unsigned char	*_up;	/* saved _p when _p is doing ungetc data */
90	pthread_mutex_t	fl_mutex;	/* used for MT-safety */
91	pthread_t	fl_owner;	/* current owner */
92	int		fl_count;	/* recursive lock count */
93	int		orientation;	/* orientation for fwide() */
94	mbstate_t	mbstate;	/* multibyte conversion state */
95};
96
97/*
98 * Prepare the given FILE for writing, and return 0 iff it
99 * can be written now.  Otherwise, return EOF and set errno.
100 */
101#define	prepwrite(fp) \
102 	((((fp)->_flags & __SWR) == 0 || \
103 	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
104	 __swsetup(fp))
105
106/*
107 * Test whether the given stdio file has an active ungetc buffer;
108 * release such a buffer, without restoring ordinary unread data.
109 */
110#define	HASUB(fp) ((fp)->_ub._base != NULL)
111#define	FREEUB(fp) { \
112	if ((fp)->_ub._base != (fp)->_ubuf) \
113		free((char *)(fp)->_ub._base); \
114	(fp)->_ub._base = NULL; \
115}
116
117/*
118 * test for an fgetln() buffer.
119 */
120#define	HASLB(fp) ((fp)->_lb._base != NULL)
121#define	FREELB(fp) { \
122	free((char *)(fp)->_lb._base); \
123	(fp)->_lb._base = NULL; \
124}
125
126#define	INITEXTRA(fp) { \
127	(fp)->_extra->_up = NULL; \
128	(fp)->_extra->fl_mutex = PTHREAD_MUTEX_INITIALIZER; \
129	(fp)->_extra->fl_owner = NULL; \
130	(fp)->_extra->fl_count = 0; \
131	(fp)->_extra->orientation = 0; \
132	memset(&(fp)->_extra->mbstate, 0, sizeof(mbstate_t)); \
133}
134
135/*
136 * Set the orientation for a stream. If o > 0, the stream has wide-
137 * orientation. If o < 0, the stream has byte-orientation.
138 */
139#define	ORIENT(fp, o)	do {				\
140	if ((fp)->_extra->orientation == 0)		\
141		(fp)->_extra->orientation = (o);	\
142} while (0)
143