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 * 4. 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$
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
47/*
48 * Information local to this implementation of stdio,
49 * in particular, macros and private variables.
50 */
51
52extern int	_sread(FILE *, char *, int);
53extern int	_swrite(FILE *, char const *, int);
54extern fpos_t	_sseek(FILE *, fpos_t, int);
55extern int	_ftello(FILE *, fpos_t *);
56extern int	_fseeko(FILE *, off_t, int, int);
57extern int	__fflush(FILE *fp);
58extern void	__fcloseall(void);
59extern wint_t	__fgetwc_mbs(FILE *, mbstate_t *, int *, locale_t);
60extern wint_t	__fputwc(wchar_t, FILE *, locale_t);
61extern int	__sflush(FILE *);
62extern FILE	*__sfp(void);
63extern int	__slbexpand(FILE *, size_t);
64extern int	__srefill(FILE *);
65extern int	__sread(void *, char *, int);
66extern int	__swrite(void *, char const *, int);
67extern fpos_t	__sseek(void *, fpos_t, int);
68extern int	__sclose(void *);
69extern void	__sinit(void);
70extern void	_cleanup(void);
71extern void	__smakebuf(FILE *);
72extern int	__swhatbuf(FILE *, size_t *, int *);
73extern int	_fwalk(int (*)(FILE *));
74extern int	__svfscanf(FILE *, locale_t, const char *, __va_list);
75extern int	__swsetup(FILE *);
76extern int	__sflags(const char *, int *);
77extern int	__ungetc(int, FILE *);
78extern wint_t	__ungetwc(wint_t, FILE *, locale_t);
79extern int	__vfprintf(FILE *, locale_t, const char *, __va_list);
80extern int	__vfscanf(FILE *, const char *, __va_list);
81extern int	__vfwprintf(FILE *, locale_t, const wchar_t *, __va_list);
82extern int	__vfwscanf(FILE * __restrict, locale_t, const wchar_t * __restrict,
83		    __va_list);
84extern size_t	__fread(void * __restrict buf, size_t size, size_t count,
85		FILE * __restrict fp);
86extern int	__sdidinit;
87
88static inline wint_t
89__fgetwc(FILE *fp, locale_t locale)
90{
91	int nread;
92
93	return (__fgetwc_mbs(fp, &fp->_mbstate, &nread, locale));
94}
95
96/*
97 * Prepare the given FILE for writing, and return 0 iff it
98 * can be written now.  Otherwise, return EOF and set errno.
99 */
100#define	prepwrite(fp) \
101 	((((fp)->_flags & __SWR) == 0 || \
102 	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
103	 __swsetup(fp))
104
105/*
106 * Test whether the given stdio file has an active ungetc buffer;
107 * release such a buffer, without restoring ordinary unread data.
108 */
109#define	HASUB(fp) ((fp)->_ub._base != NULL)
110#define	FREEUB(fp) { \
111	if ((fp)->_ub._base != (fp)->_ubuf) \
112		free((char *)(fp)->_ub._base); \
113	(fp)->_ub._base = NULL; \
114}
115
116/*
117 * test for an fgetln() buffer.
118 */
119#define	HASLB(fp) ((fp)->_lb._base != NULL)
120#define	FREELB(fp) { \
121	free((char *)(fp)->_lb._base); \
122	(fp)->_lb._base = NULL; \
123}
124
125/*
126 * Structure initializations for 'fake' FILE objects.
127 */
128#define	FAKE_FILE {				\
129	._file = -1,				\
130	._fl_mutex = PTHREAD_MUTEX_INITIALIZER, \
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)->_orientation == 0)			\
139		(fp)->_orientation = (o);		\
140} while (0)
141