[apple/libc.git] / stdio / FreeBSD / local.h

/*-
 * Copyright (c) 1990, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Chris Torek.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)local.h	8.3 (Berkeley) 7/3/94
 * $FreeBSD: src/lib/libc/stdio/local.h,v 1.33 2008/05/05 16:03:52 jhb Exp $
 */

#include <sys/types.h>	/* for off_t */
#include <pthread.h>
#include <string.h>
#include <wchar.h>

/*
 * Information local to this implementation of stdio,
 * in particular, macros and private variables.
 */

extern int	_sread(FILE *, char *, int);
extern int	_swrite(FILE *, char const *, int);
extern fpos_t	_sseek(FILE *, fpos_t, int);
extern int	_ftello(FILE *, fpos_t *);
extern int	_fseeko(FILE *, off_t, int, int);
extern int	__fflush(FILE *fp);
extern void	__fcloseall(void);
extern wint_t	__fgetwc(FILE *);
extern wint_t	__fputwc(wchar_t, FILE *);
extern int	__sflush(FILE *);
extern FILE	*__sfp(void);
extern int	__slbexpand(FILE *, size_t);
extern int	__srefill(FILE *);
extern int	__sread(void *, char *, int);
extern int	__swrite(void *, char const *, int);
extern fpos_t	__sseek(void *, fpos_t, int);
extern int	__sclose(void *);
extern void	__sinit(void);
extern void	_cleanup(void);
extern void	__smakebuf(FILE *);
extern int	__swhatbuf(FILE *, size_t *, int *);
extern int	_fwalk(int (*)(FILE *));
extern int	__svfscanf(FILE *, const char *, __va_list);
extern int	__swsetup(FILE *);
extern int	__sflags(const char *, int *);
extern int	__ungetc(int, FILE *);
extern wint_t	__ungetwc(wint_t, FILE *);
extern int	__vfprintf(FILE *, const char *, __va_list);
extern int	__vfscanf(FILE *, const char *, __va_list);
extern int	__vfwprintf(FILE *, const wchar_t *, __va_list);
extern int	__vfwscanf(FILE * __restrict, const wchar_t * __restrict,
		    __va_list);
extern size_t	__fread(void * __restrict buf, size_t size, size_t count,
		FILE * __restrict fp);
extern int	__sdidinit;


/*
 * Prepare the given FILE for writing, and return 0 iff it
 * can be written now.  Otherwise, return EOF and set errno.
 */
#define	prepwrite(fp) \
 	((((fp)->_flags & __SWR) == 0 || \
 	    ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
	 __swsetup(fp))

/*
 * Test whether the given stdio file has an active ungetc buffer;
 * release such a buffer, without restoring ordinary unread data.
 */
#define	HASUB(fp) ((fp)->_ub._base != NULL)
#define	FREEUB(fp) { \
	if ((fp)->_ub._base != (fp)->_ubuf) \
		free((char *)(fp)->_ub._base); \
	(fp)->_ub._base = NULL; \
}

/*
 * test for an fgetln() buffer.
 */
#define	HASLB(fp) ((fp)->_lb._base != NULL)
#define	FREELB(fp) { \
	free((char *)(fp)->_lb._base); \
	(fp)->_lb._base = NULL; \
}

/*
 * Set the orientation for a stream. If o > 0, the stream has wide-
 * orientation. If o < 0, the stream has byte-orientation.
 */
#define	ORIENT(fp, o)	do {				\
	if ((fp)->_orientation == 0)			\
		(fp)->_orientation = (o);		\
} while (0)
Commit	Line	Data
9385eb3d A	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.
9385eb3d A	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
1f2f436a	33	* $FreeBSD: src/lib/libc/stdio/local.h,v 1.33 2008/05/05 16:03:52 jhb Exp $
9385eb3d A	34	*/
	35
	36	#include <sys/types.h> /* for off_t */
	37	#include <pthread.h>
	38	#include <string.h>
	39	#include <wchar.h>
	40
	41	/*
	42	* Information local to this implementation of stdio,
	43	* in particular, macros and private variables.
	44	*/
	45
	46	extern int _sread(FILE , char , int);
	47	extern int _swrite(FILE , char const , int);
	48	extern fpos_t _sseek(FILE *, fpos_t, int);
	49	extern int _ftello(FILE , fpos_t );
	50	extern int _fseeko(FILE *, off_t, int, int);
	51	extern int __fflush(FILE *fp);
1f2f436a	52	extern void __fcloseall(void);
9385eb3d A	53	extern wint_t __fgetwc(FILE *);
	54	extern wint_t __fputwc(wchar_t, FILE *);
	55	extern int __sflush(FILE *);
	56	extern FILE *__sfp(void);
3d9156a7	57	extern int __slbexpand(FILE *, size_t);
9385eb3d A	58	extern int __srefill(FILE *);
	59	extern int __sread(void , char , int);
	60	extern int __swrite(void , char const , int);
	61	extern fpos_t __sseek(void *, fpos_t, int);
	62	extern int __sclose(void *);
	63	extern void __sinit(void);
	64	extern void _cleanup(void);
9385eb3d A	65	extern void __smakebuf(FILE *);
	66	extern int __swhatbuf(FILE , size_t , int *);
	67	extern int _fwalk(int ()(FILE ));
	68	extern int __svfscanf(FILE , const char , __va_list);
	69	extern int __swsetup(FILE *);
	70	extern int __sflags(const char , int );
	71	extern int __ungetc(int, FILE *);
	72	extern wint_t __ungetwc(wint_t, FILE *);
	73	extern int __vfprintf(FILE , const char , __va_list);
	74	extern int __vfscanf(FILE , const char , __va_list);
	75	extern int __vfwprintf(FILE , const wchar_t , __va_list);
	76	extern int __vfwscanf(FILE * __restrict, const wchar_t * __restrict,
	77	__va_list);
1f2f436a A	78	extern size_t __fread(void * __restrict buf, size_t size, size_t count,
1f2f436a A	79	FILE * __restrict fp);
9385eb3d A	80	extern int __sdidinit;
	81
	82
9385eb3d	83	/*
3d9156a7 A	84	* Prepare the given FILE for writing, and return 0 iff it
3d9156a7 A	85	* can be written now. Otherwise, return EOF and set errno.
9385eb3d	86	*/
3d9156a7	87	#define prepwrite(fp) \
9385eb3d A	88	((((fp)->_flags & __SWR) == 0 \|\| \
	89	((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
	90	__swsetup(fp))
	91
	92	/*
	93	* Test whether the given stdio file has an active ungetc buffer;
	94	* release such a buffer, without restoring ordinary unread data.
	95	*/
	96	#define HASUB(fp) ((fp)->_ub._base != NULL)
	97	#define FREEUB(fp) { \
	98	if ((fp)->_ub._base != (fp)->_ubuf) \
	99	free((char *)(fp)->_ub._base); \
	100	(fp)->_ub._base = NULL; \
	101	}
	102
	103	/*
	104	* test for an fgetln() buffer.
	105	*/
	106	#define HASLB(fp) ((fp)->_lb._base != NULL)
	107	#define FREELB(fp) { \
	108	free((char *)(fp)->_lb._base); \
	109	(fp)->_lb._base = NULL; \
	110	}
	111
9385eb3d A	112	/*
	113	* Set the orientation for a stream. If o > 0, the stream has wide-
	114	* orientation. If o < 0, the stream has byte-orientation.
	115	*/
	116	#define ORIENT(fp, o) do { \
1f2f436a A	117	if ((fp)->_orientation == 0) \
1f2f436a A	118	(fp)->_orientation = (o); \
9385eb3d	119	} while (0)