[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/cdefs.h>
#include "xlocale_private.h"
#include "xprintf_private.h"
#include <sys/types.h>	/* for off_t */
#include <pthread.h>
#include <limits.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	_vasprintf(printf_comp_t __restrict, printf_domain_t __restrict,
		char ** __restrict, locale_t __restrict,
		const char * __restrict, __va_list);
extern int	_vdprintf(printf_comp_t __restrict, printf_domain_t __restrict,
		int, locale_t __restrict, const char * __restrict, va_list);
extern int	_vsnprintf(printf_comp_t __restrict, printf_domain_t __restrict,
		char * __restrict, size_t n, locale_t __restrict,
		const char * __restrict, __va_list);

extern int	__fflush(FILE *fp);
extern void	__fcloseall(void);
extern wint_t	__fgetwc(FILE *, locale_t);
extern wint_t	__fputwc(wchar_t, FILE *, locale_t);
extern int	__sflush(FILE *);
extern FILE	*__sfp(int);
extern void	__sfprelease(FILE *);	/* mark free and update count as needed */
extern int	__slbexpand(FILE *, size_t);
extern int	__srefill(FILE *);
extern int	__srefill0(FILE *);
extern int	__srefill1(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	(*__cleanup)(void);
extern void	__smakebuf(FILE *);
extern int	__swhatbuf(FILE *, size_t *, int *);
extern int	_fwalk(int (*)(FILE *));
extern int	__svfscanf_l(FILE *, locale_t, 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 *, locale_t);
extern int	__vfprintf(FILE *, locale_t, const char *, __va_list);
extern int	__vfscanf(FILE *, const char *, __va_list);
extern int	__vfwprintf(FILE *, locale_t, const wchar_t *, __va_list);
extern int	__vfwscanf(FILE * __restrict, locale_t, 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;


/* hold a buncha junk that would grow the ABI */
struct __sFILEX {
	unsigned char	*up;	/* saved _p when _p is doing ungetc data */
	pthread_mutex_t	fl_mutex;	/* used for MT-safety */
	pthread_t	fl_owner;	/* current owner */
	int		fl_count;	/* recursive lock count */
	int		orientation:2;	/* orientation for fwide() */
	int		counted:1;	/* stream counted against STREAM_MAX */
	mbstate_t	mbstate;	/* multibyte conversion state */
};

#define _up 		_extra->up
#define _fl_mutex	_extra->fl_mutex
#define _fl_owner	_extra->fl_owner
#define _fl_count	_extra->fl_count
#define _orientation	_extra->orientation
#define _mbstate	_extra->mbstate
#define _counted	_extra->counted

#define	INITEXTRA(fp) do { \
	(fp)->_extra->up = NULL; \
	(fp)->_extra->fl_mutex = (pthread_mutex_t)PTHREAD_MUTEX_INITIALIZER; \
	(fp)->_extra->fl_owner = NULL; \
	(fp)->_extra->fl_count = 0; \
	(fp)->_extra->orientation = 0; \
	memset(&(fp)->_extra->mbstate, 0, sizeof(mbstate_t)); \
	(fp)->_extra->counted = 0; \
} while(0);

/*
 * 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	*/
9385eb3d A	35
ad3c9f2a A	36	#include <sys/cdefs.h>
ad3c9f2a A	37	#include "xlocale_private.h"
6465356a	38	#include "xprintf_private.h"
9385eb3d A	39	#include <sys/types.h> /* for off_t */
9385eb3d A	40	#include <pthread.h>
ad3c9f2a	41	#include <limits.h>
9385eb3d A	42	#include <string.h>
	43	#include <wchar.h>
	44
	45	/*
	46	* Information local to this implementation of stdio,
	47	* in particular, macros and private variables.
	48	*/
	49
	50	extern int _sread(FILE , char , int);
	51	extern int _swrite(FILE , char const , int);
	52	extern fpos_t _sseek(FILE *, fpos_t, int);
	53	extern int _ftello(FILE , fpos_t );
	54	extern int _fseeko(FILE *, off_t, int, int);
6465356a A	55	extern int _vasprintf(printf_comp_t __restrict, printf_domain_t __restrict,
	56	char ** __restrict, locale_t __restrict,
	57	const char * __restrict, __va_list);
	58	extern int _vdprintf(printf_comp_t __restrict, printf_domain_t __restrict,
	59	int, locale_t __restrict, const char * __restrict, va_list);
	60	extern int _vsnprintf(printf_comp_t __restrict, printf_domain_t __restrict,
	61	char * __restrict, size_t n, locale_t __restrict,
	62	const char * __restrict, __va_list);
	63
9385eb3d	64	extern int __fflush(FILE *fp);
1f2f436a	65	extern void __fcloseall(void);
ad3c9f2a A	66	extern wint_t __fgetwc(FILE *, locale_t);
ad3c9f2a A	67	extern wint_t __fputwc(wchar_t, FILE *, locale_t);
9385eb3d	68	extern int __sflush(FILE *);
ad3c9f2a A	69	extern FILE *__sfp(int);
ad3c9f2a A	70	extern void __sfprelease(FILE ); / mark free and update count as needed */
3d9156a7	71	extern int __slbexpand(FILE *, size_t);
9385eb3d	72	extern int __srefill(FILE *);
ad3c9f2a A	73	extern int __srefill0(FILE *);
ad3c9f2a A	74	extern int __srefill1(FILE *);
9385eb3d A	75	extern int __sread(void , char , int);
	76	extern int __swrite(void , char const , int);
	77	extern fpos_t __sseek(void *, fpos_t, int);
	78	extern int __sclose(void *);
	79	extern void __sinit(void);
	80	extern void _cleanup(void);
ad3c9f2a	81	extern void (*__cleanup)(void);
9385eb3d A	82	extern void __smakebuf(FILE *);
	83	extern int __swhatbuf(FILE , size_t , int *);
	84	extern int _fwalk(int ()(FILE ));
ad3c9f2a	85	extern int __svfscanf_l(FILE , locale_t, const char , __va_list);
9385eb3d A	86	extern int __swsetup(FILE *);
	87	extern int __sflags(const char , int );
	88	extern int __ungetc(int, FILE *);
ad3c9f2a A	89	extern wint_t __ungetwc(wint_t, FILE *, locale_t);
ad3c9f2a A	90	extern int __vfprintf(FILE , locale_t, const char , __va_list);
9385eb3d	91	extern int __vfscanf(FILE , const char , __va_list);
ad3c9f2a A	92	extern int __vfwprintf(FILE , locale_t, const wchar_t , __va_list);
ad3c9f2a A	93	extern int __vfwscanf(FILE * __restrict, locale_t, const wchar_t * __restrict,
9385eb3d	94	__va_list);
1f2f436a A	95	extern size_t __fread(void * __restrict buf, size_t size, size_t count,
1f2f436a A	96	FILE * __restrict fp);
9385eb3d A	97	extern int __sdidinit;
	98
	99
ad3c9f2a A	100	/* hold a buncha junk that would grow the ABI */
	101	struct __sFILEX {
	102	unsigned char up; / saved _p when _p is doing ungetc data */
	103	pthread_mutex_t fl_mutex; /* used for MT-safety */
	104	pthread_t fl_owner; /* current owner */
	105	int fl_count; /* recursive lock count */
	106	int orientation:2; /* orientation for fwide() */
	107	int counted:1; /* stream counted against STREAM_MAX */
	108	mbstate_t mbstate; /* multibyte conversion state */
	109	};
	110
	111	#define _up _extra->up
	112	#define _fl_mutex _extra->fl_mutex
	113	#define _fl_owner _extra->fl_owner
	114	#define _fl_count _extra->fl_count
	115	#define _orientation _extra->orientation
	116	#define _mbstate _extra->mbstate
	117	#define _counted _extra->counted
	118
	119	#define INITEXTRA(fp) do { \
	120	(fp)->_extra->up = NULL; \
	121	(fp)->_extra->fl_mutex = (pthread_mutex_t)PTHREAD_MUTEX_INITIALIZER; \
	122	(fp)->_extra->fl_owner = NULL; \
	123	(fp)->_extra->fl_count = 0; \
	124	(fp)->_extra->orientation = 0; \
	125	memset(&(fp)->_extra->mbstate, 0, sizeof(mbstate_t)); \
	126	(fp)->_extra->counted = 0; \
	127	} while(0);
	128
9385eb3d	129	/*
3d9156a7 A	130	* Prepare the given FILE for writing, and return 0 iff it
3d9156a7 A	131	* can be written now. Otherwise, return EOF and set errno.
9385eb3d	132	*/
3d9156a7	133	#define prepwrite(fp) \
9385eb3d A	134	((((fp)->_flags & __SWR) == 0 \|\| \
	135	((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
	136	__swsetup(fp))
	137
	138	/*
	139	* Test whether the given stdio file has an active ungetc buffer;
	140	* release such a buffer, without restoring ordinary unread data.
	141	*/
	142	#define HASUB(fp) ((fp)->_ub._base != NULL)
	143	#define FREEUB(fp) { \
	144	if ((fp)->_ub._base != (fp)->_ubuf) \
	145	free((char *)(fp)->_ub._base); \
	146	(fp)->_ub._base = NULL; \
	147	}
	148
	149	/*
	150	* test for an fgetln() buffer.
	151	*/
	152	#define HASLB(fp) ((fp)->_lb._base != NULL)
	153	#define FREELB(fp) { \
	154	free((char *)(fp)->_lb._base); \
	155	(fp)->_lb._base = NULL; \
	156	}
	157
9385eb3d A	158	/*
	159	* Set the orientation for a stream. If o > 0, the stream has wide-
	160	* orientation. If o < 0, the stream has byte-orientation.
	161	*/
	162	#define ORIENT(fp, o) do { \
1f2f436a A	163	if ((fp)->_orientation == 0) \
1f2f436a A	164	(fp)->_orientation = (o); \
9385eb3d	165	} while (0)