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: stable/11/lib/libc/stdio/local.h 320942 2017-07-13 09:27:11Z kib $
39 */
40
41#ifndef _STDIO_LOCAL_H
42#define	_STDIO_LOCAL_H
43
44#include <sys/types.h>	/* for off_t */
45#include <pthread.h>
46#include <string.h>
47#include <wchar.h>
48#include <locale.h>
49
50/*
51 * Information local to this implementation of stdio,
52 * in particular, macros and private variables.
53 */
54
55extern int	_sread(FILE *, char *, int);
56extern int	_swrite(FILE *, char const *, int);
57extern fpos_t	_sseek(FILE *, fpos_t, int);
58extern int	_ftello(FILE *, fpos_t *);
59extern int	_fseeko(FILE *, off_t, int, int);
60extern int	__fflush(FILE *fp);
61extern void	__fcloseall(void);
62extern wint_t	__fgetwc_mbs(FILE *, mbstate_t *, int *, locale_t);
63extern wint_t	__fputwc(wchar_t, FILE *, locale_t);
64extern int	__sflush(FILE *);
65extern FILE	*__sfp(void);
66extern int	__slbexpand(FILE *, size_t);
67extern int	__srefill(FILE *);
68extern int	__sread(void *, char *, int);
69extern int	__swrite(void *, char const *, int);
70extern fpos_t	__sseek(void *, fpos_t, int);
71extern int	__sclose(void *);
72extern void	__sinit(void);
73extern void	_cleanup(void);
74extern void	__smakebuf(FILE *);
75extern int	__swhatbuf(FILE *, size_t *, int *);
76extern int	_fwalk(int (*)(FILE *));
77extern int	__svfscanf(FILE *, locale_t, const char *, __va_list);
78extern int	__swsetup(FILE *);
79extern int	__sflags(const char *, int *);
80extern int	__ungetc(int, FILE *);
81extern wint_t	__ungetwc(wint_t, FILE *, locale_t);
82extern int	__vfprintf(FILE *, locale_t, const char *, __va_list);
83extern int	__vfscanf(FILE *, const char *, __va_list);
84extern int	__vfwprintf(FILE *, locale_t, const wchar_t *, __va_list);
85extern int	__vfwscanf(FILE * __restrict, locale_t, const wchar_t * __restrict,
86		    __va_list);
87extern size_t	__fread(void * __restrict buf, size_t size, size_t count,
88		FILE * __restrict fp);
89extern int	__sdidinit;
90
91static inline wint_t
92__fgetwc(FILE *fp, locale_t locale)
93{
94	int nread;
95
96	return (__fgetwc_mbs(fp, &fp->_mbstate, &nread, locale));
97}
98
99/*
100 * Prepare the given FILE for writing, and return 0 iff it
101 * can be written now.  Otherwise, return EOF and set errno.
102 */
103#define	prepwrite(fp) \
104 	((((fp)->_flags & __SWR) == 0 || \
105 	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
106	 __swsetup(fp))
107
108/*
109 * Test whether the given stdio file has an active ungetc buffer;
110 * release such a buffer, without restoring ordinary unread data.
111 */
112#define	HASUB(fp) ((fp)->_ub._base != NULL)
113#define	FREEUB(fp) { \
114	if ((fp)->_ub._base != (fp)->_ubuf) \
115		free((char *)(fp)->_ub._base); \
116	(fp)->_ub._base = NULL; \
117}
118
119/*
120 * test for an fgetln() buffer.
121 */
122#define	HASLB(fp) ((fp)->_lb._base != NULL)
123#define	FREELB(fp) { \
124	free((char *)(fp)->_lb._base); \
125	(fp)->_lb._base = NULL; \
126}
127
128/*
129 * Structure initializations for 'fake' FILE objects.
130 */
131#define	FAKE_FILE {				\
132	._file = -1,				\
133	._fl_mutex = PTHREAD_MUTEX_INITIALIZER, \
134}
135
136/*
137 * Set the orientation for a stream. If o > 0, the stream has wide-
138 * orientation. If o < 0, the stream has byte-orientation.
139 */
140#define	ORIENT(fp, o)	do {				\
141	if ((fp)->_orientation == 0)			\
142		(fp)->_orientation = (o);		\
143} while (0)
144
145void __stdio_cancel_cleanup(void *);
146#define	FLOCKFILE_CANCELSAFE(fp)					\
147	{								\
148		struct _pthread_cleanup_info __cleanup_info__;		\
149		if (__isthreaded) {					\
150			_FLOCKFILE(fp);					\
151			___pthread_cleanup_push_imp(			\
152			    __stdio_cancel_cleanup, (fp), 		\
153			    &__cleanup_info__);				\
154		} else {						\
155			___pthread_cleanup_push_imp(			\
156			    __stdio_cancel_cleanup, NULL, 		\
157			    &__cleanup_info__);				\
158		}							\
159		{
160#define	FUNLOCKFILE_CANCELSAFE()					\
161			(void)0;					\
162		}							\
163		___pthread_cleanup_pop_imp(1);				\
164	}
165
166#endif /* _STDIO_LOCAL_H */
167