Sync libc/stdio with FreeBSD:
[dragonfly.git] / lib / libc / stdio / local.h
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  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *      @(#)local.h     8.3 (Berkeley) 7/3/94
33  * $FreeBSD: src/lib/libc/stdio/local.h,v 1.33 2008/05/05 16:03:52 jhb Exp $
34  * $DragonFly: src/lib/libc/stdio/local.h,v 1.11 2007/11/25 01:28:22 swildner Exp $
35  */
36
37 #include <sys/types.h>  /* for off_t */
38 #include <pthread.h>
39 #include <string.h>
40 #include <wchar.h>
41
42 #include "wcio.h"
43
44 /*
45  * Information local to this implementation of stdio,
46  * in particular, macros and private variables.
47  */
48
49 extern int      _sread(FILE *, char *, int);
50 extern int      _swrite(FILE *, const char *, int);
51 extern fpos_t   _sseek(FILE *, fpos_t, int);
52 extern int      _ftello(FILE *, fpos_t *);
53 extern int      _fseeko(FILE *, off_t, int, int);
54 extern int      __fflush(FILE *fp);
55 extern void     __fcloseall(void);
56 extern wint_t   __fgetwc_unlock(FILE *);
57 extern wint_t   __fputwc_unlock(wchar_t, FILE *);
58 extern int      __sflush(FILE *);
59 extern FILE     *__sfp(void);
60 extern int      __slbexpand(FILE *, size_t);
61 extern int      __srefill(FILE *);
62 extern int      __sread(void *, char *, int);
63 extern int      __swrite(void *, const char *, int);
64 extern fpos_t   __sseek(void *, fpos_t, int);
65 extern int      __sclose(void *);
66 extern void     __sinit(void);
67 extern void     _cleanup(void);
68 extern void     __smakebuf(FILE *);
69 extern int      __swhatbuf(FILE *, size_t *, int *);
70 extern int      _fwalk(int (*)(FILE *));
71 extern int      __svfscanf(FILE *, const char *, __va_list);
72 extern int      __swsetup(FILE *);
73 extern int      __sflags(const char *, int *);
74 extern int      __ungetc(int, FILE *);
75 extern int      __vfprintf(FILE *, const char *, __va_list);
76 extern int      __vfscanf(FILE *, const char *, __va_list);
77 extern int      __vfwprintf(FILE *, const wchar_t *, __va_list);
78 extern int      __vfwscanf(FILE * __restrict, const wchar_t * __restrict,
79                            __va_list);
80 extern size_t   __fread(void * __restrict buf, size_t size, size_t count,
81                         FILE * __restrict fp);
82 extern int      __sdidinit;
83
84
85 /*
86  * Prepare the given FILE for writing, and return 0 iff it
87  * can be written now.  Otherwise, return EOF and set errno.
88  */
89 #define prepwrite(fp) \
90         ((((fp)->pub._flags & __SWR) == 0 || \
91             ((fp)->_bf._base == NULL && ((fp)->pub._flags & __SSTR) == 0)) && \
92          __swsetup(fp))
93
94 /*
95  * Test whether the given stdio file has an active ungetc buffer;
96  * release such a buffer, without restoring ordinary unread data.
97  */
98 #define HASUB(fp) ((fp)->_ub._base != NULL)
99 #define FREEUB(fp) { \
100         if ((fp)->_ub._base != (fp)->_ubuf) \
101                 free((char *)(fp)->_ub._base); \
102         (fp)->_ub._base = NULL; \
103 }
104
105 /*
106  * test for an fgetln() buffer.
107  */
108 #define HASLB(fp) ((fp)->_lb._base != NULL)
109 #define FREELB(fp) { \
110         free((char *)(fp)->_lb._base); \
111         (fp)->_lb._base = NULL; \
112 }
113
114 /*
115  * Set the orientation for a stream. If o > 0, the stream has wide-
116  * orientation. If o < 0, the stream has byte-orientation.
117  */
118 #define ORIENT(fp, o)   _SET_ORIENTATION(fp, o)