Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / stdio / local.h
blobbc4bab2510d6ce9d212253c5cb75b0bf6395006b
1 /* $NetBSD: local.h,v 1.22 2009/12/01 00:03:53 roy Exp $ */
3 /*-
4 * Copyright (c) 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Chris Torek.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
34 * @(#)local.h 8.3 (Berkeley) 7/3/94
37 #include "wcio.h"
38 #include "fileext.h"
41 * Information local to this implementation of stdio,
42 * in particular, macros and private variables.
45 extern int __sflush __P((FILE *));
46 extern FILE *__sfp __P((void));
47 extern int __srefill __P((FILE *));
48 extern int __sread __P((void *, char *, int));
49 extern int __swrite __P((void *, char const *, int));
50 extern fpos_t __sseek __P((void *, fpos_t, int));
51 extern int __sclose __P((void *));
52 extern void __sinit __P((void));
53 extern void _cleanup __P((void));
54 extern void (*__cleanup) __P((void));
55 extern void __smakebuf __P((FILE *));
56 extern int __swhatbuf __P((FILE *, size_t *, int *));
57 extern int _fwalk __P((int (*)(FILE *)));
58 extern char *_mktemp __P((char *));
59 extern int __swsetup __P((FILE *));
60 extern int __sflags __P((const char *, int *));
61 extern int __svfscanf __P((FILE * __restrict, const char * __restrict,
62 _BSD_VA_LIST_))
63 __attribute__((__format__(__scanf__, 2, 0)));
64 extern int __svfscanf_unlocked __P((FILE * __restrict, const char * __restrict,
65 _BSD_VA_LIST_))
66 __attribute__((__format__(__scanf__, 2, 0)));
67 extern int __vfprintf_unlocked __P((FILE * __restrict, const char * __restrict,
68 _BSD_VA_LIST_));
71 extern int __sdidinit;
73 extern int __gettemp __P((char *, int *, int));
75 extern wint_t __fgetwc_unlock __P((FILE *));
76 extern wint_t __fputwc_unlock __P((wchar_t, FILE *));
78 extern ssize_t __getdelim(char **__restrict, size_t *__restrict, int,
79 FILE *__restrict);
80 extern char *__fgetstr __P((FILE * __restrict, size_t * __restrict, int));
81 extern int __vfwprintf_unlocked __P((FILE *, const wchar_t *,
82 _BSD_VA_LIST_));
83 extern int __vfwscanf_unlocked __P((FILE * __restrict,
84 const wchar_t * __restrict, _BSD_VA_LIST_));
87 * Return true iff the given FILE cannot be written now.
89 #define cantwrite(fp) \
90 ((((fp)->_flags & __SWR) == 0 || (fp)->_bf._base == NULL) && \
91 __swsetup(fp))
94 * Test whether the given stdio file has an active ungetc buffer;
95 * release such a buffer, without restoring ordinary unread data.
97 #define HASUB(fp) (_UB(fp)._base != NULL)
98 #define FREEUB(fp) { \
99 if (_UB(fp)._base != (fp)->_ubuf) \
100 free((char *)_UB(fp)._base); \
101 _UB(fp)._base = NULL; \
105 * test for an fgetln() buffer.
107 #define HASLB(fp) ((fp)->_lb._base != NULL)
108 #define FREELB(fp) { \
109 free((char *)(fp)->_lb._base); \
110 (fp)->_lb._base = NULL; \
113 extern void __flockfile_internal __P((FILE *, int));
114 extern void __funlockfile_internal __P((FILE *, int));