xref: /dragonfly/lib/libc/stdio/local.h (revision 0db87cb7)
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  * Copyright (c) 2011 The FreeBSD Foundation
9  * All rights reserved.
10  * Portions of this software were developed by David Chisnall
11  * under sponsorship from the FreeBSD Foundation.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)local.h	8.3 (Berkeley) 7/3/94
38  * $FreeBSD: head/lib/libc/stdio/local.h 234799 2012-04-29 16:28:39Z das $
39  */
40 
41 #include <sys/types.h>	/* for off_t */
42 #include <pthread.h>
43 #include <string.h>
44 #include <wchar.h>
45 #include <locale.h>
46 #include <xlocale_private.h>
47 
48 #include "priv_stdio.h"
49 #include "wcio.h"
50 
51 /*
52  * Information local to this implementation of stdio,
53  * in particular, macros and private variables.
54  */
55 
56 extern int	_sread(FILE *, char *, int);
57 extern int	_swrite(FILE *, char const *, int);
58 extern fpos_t	_sseek(FILE *, fpos_t, int);
59 extern int	_ftello(FILE *, fpos_t *);
60 extern int	_fseeko(FILE *, off_t, int, int);
61 extern int	__fflush(FILE *fp);
62 extern void	__fcloseall(void);
63 extern wint_t	__fgetwc_mbs(FILE *, mbstate_t *, int *, locale_t);
64 extern wint_t	__fputwc(wchar_t, FILE *, locale_t);
65 extern int	__sflush(FILE *);
66 extern FILE	*__sfp(void);
67 extern int	__slbexpand(FILE *, size_t);
68 extern int	__srefill(FILE *);
69 extern int	__sread(void *, char *, int);
70 extern int	__swrite(void *, char const *, int);
71 extern fpos_t	__sseek(void *, fpos_t, int);
72 extern int	__sclose(void *);
73 extern void	__sinit(void);
74 extern void	_cleanup(void);
75 extern void	__smakebuf(FILE *);
76 extern int	__swhatbuf(FILE *, size_t *, int *);
77 extern int	_fwalk(int (*)(FILE *));
78 extern int	__svfscanf(FILE *, locale_t, const char *, __va_list);
79 extern int	__swsetup(FILE *);
80 extern int	__sflags(const char *, int *);
81 extern int	__ungetc(int, FILE *);
82 extern wint_t	__ungetwc(wint_t, FILE *, locale_t);
83 extern int	__vfprintf(FILE *, locale_t, const char *, __va_list);
84 extern int	__vfscanf(FILE *, const char *, __va_list);
85 extern int	__vfwprintf(FILE *, locale_t, const wchar_t *, __va_list);
86 extern int	__vfwscanf(FILE * __restrict, locale_t, const wchar_t * __restrict,
87 		    __va_list);
88 extern size_t	__fread(void * __restrict buf, size_t size, size_t count,
89 		FILE * __restrict fp);
90 extern int	__sdidinit;
91 
92 static inline wint_t
93 __fgetwc(FILE *fp, locale_t locale)
94 {
95 	int nread;
96 	struct wchar_io_data *wcio;
97 	mbstate_t *st;
98 
99 	_SET_ORIENTATION(fp,1);
100 	wcio = WCIO_GET(fp);
101 
102 	if (wcio == NULL) {
103 		return WEOF;
104 	}
105 	wcio->wcio_ungetwc_inbuf = 0;
106 	st = &wcio->wcio_mbstate_out;
107 
108 	return (__fgetwc_mbs(fp, st, &nread, locale));
109 }
110 
111 /*
112  * Prepare the given FILE for writing, and return 0 iff it
113  * can be written now.  Otherwise, return EOF and set errno.
114  */
115 #define	prepwrite(fp) \
116 	((((fp)->pub._flags & __SWR) == 0 || \
117 	    ((fp)->_bf._base == NULL && ((fp)->pub._flags & __SSTR) == 0)) && \
118 	 __swsetup(fp))
119 
120 /*
121  * Test whether the given stdio file has an active ungetc buffer;
122  * release such a buffer, without restoring ordinary unread data.
123  */
124 #define	HASUB(fp) ((fp)->_ub._base != NULL)
125 #define	FREEUB(fp) { \
126 	if ((fp)->_ub._base != (fp)->_ubuf) \
127 		free((char *)(fp)->_ub._base); \
128 	(fp)->_ub._base = NULL; \
129 }
130 
131 /*
132  * test for an fgetln() buffer.
133  */
134 #define	HASLB(fp) ((fp)->_lb._base != NULL)
135 #define	FREELB(fp) { \
136 	free((char *)(fp)->_lb._base); \
137 	(fp)->_lb._base = NULL; \
138 }
139 
140 /*
141  * Structure initializations for 'fake' FILE objects.
142  */
143 #define	FAKE_FILE {				\
144 	.pub._lbfsize = 0,			\
145 	.pub._fileno = -1,			\
146 	._fl_mutex = PTHREAD_MUTEX_INITIALIZER,	\
147 }
148 
149 /*
150  * Set the orientation for a stream. If o > 0, the stream has wide-
151  * orientation. If o < 0, the stream has byte-orientation.
152  */
153 #define	ORIENT(fp, o)	_SET_ORIENTATION(fp, o)
154