xref: /freebsd/lib/libc/stdio/local.h (revision 315ee00f)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Chris Torek.
9  *
10  * Copyright (c) 2011 The FreeBSD Foundation
11  *
12  * Portions of this software were developed by David Chisnall
13  * under sponsorship from the FreeBSD Foundation.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  * 3. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)local.h	8.3 (Berkeley) 7/3/94
40  */
41 
42 #ifndef _STDIO_LOCAL_H
43 #define	_STDIO_LOCAL_H
44 
45 #include <sys/types.h>	/* for off_t */
46 #include <pthread.h>
47 #include <string.h>
48 #include <wchar.h>
49 #include <locale.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 
97 	return (__fgetwc_mbs(fp, &fp->_mbstate, &nread, locale));
98 }
99 
100 /*
101  * Prepare the given FILE for writing, and return 0 iff it
102  * can be written now.  Otherwise, return EOF and set errno.
103  */
104 #define	prepwrite(fp) \
105  	((((fp)->_flags & __SWR) == 0 || \
106  	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
107 	 __swsetup(fp))
108 
109 /*
110  * Test whether the given stdio file has an active ungetc buffer;
111  * release such a buffer, without restoring ordinary unread data.
112  */
113 #define	HASUB(fp) ((fp)->_ub._base != NULL)
114 #define	FREEUB(fp) { \
115 	if ((fp)->_ub._base != (fp)->_ubuf) \
116 		free((char *)(fp)->_ub._base); \
117 	(fp)->_ub._base = NULL; \
118 }
119 
120 /*
121  * test for an fgetln() buffer.
122  */
123 #define	HASLB(fp) ((fp)->_lb._base != NULL)
124 #define	FREELB(fp) { \
125 	free((char *)(fp)->_lb._base); \
126 	(fp)->_lb._base = NULL; \
127 }
128 
129 /*
130  * Structure initializations for 'fake' FILE objects.
131  */
132 #define	FAKE_FILE {				\
133 	._file = -1,				\
134 	._fl_mutex = PTHREAD_MUTEX_INITIALIZER, \
135 }
136 
137 /*
138  * Set the orientation for a stream. If o > 0, the stream has wide-
139  * orientation. If o < 0, the stream has byte-orientation.
140  */
141 #define	ORIENT(fp, o)	do {				\
142 	if ((fp)->_orientation == 0)			\
143 		(fp)->_orientation = (o);		\
144 } while (0)
145 
146 void __stdio_cancel_cleanup(void *);
147 #define	FLOCKFILE_CANCELSAFE(fp)					\
148 	{								\
149 		struct _pthread_cleanup_info __cleanup_info__;		\
150 		if (__isthreaded) {					\
151 			_FLOCKFILE(fp);					\
152 			___pthread_cleanup_push_imp(			\
153 			    __stdio_cancel_cleanup, (fp), 		\
154 			    &__cleanup_info__);				\
155 		} else {						\
156 			___pthread_cleanup_push_imp(			\
157 			    __stdio_cancel_cleanup, NULL, 		\
158 			    &__cleanup_info__);				\
159 		}							\
160 		{
161 #define	FUNLOCKFILE_CANCELSAFE()					\
162 			(void)0;					\
163 		}							\
164 		___pthread_cleanup_pop_imp(1);				\
165 	}
166 
167 #endif /* _STDIO_LOCAL_H */
168