xref: /onnv-gate/usr/src/lib/libc/inc/mse.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_MSE_H
28*0Sstevel@tonic-gate #define	_MSE_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <stdio.h>
33*0Sstevel@tonic-gate #include <wchar.h>
34*0Sstevel@tonic-gate #include <string.h>
35*0Sstevel@tonic-gate #include "stdiom.h"
36*0Sstevel@tonic-gate 
37*0Sstevel@tonic-gate typedef enum {
38*0Sstevel@tonic-gate 	_NO_MODE,					/* not bound */
39*0Sstevel@tonic-gate 	_BYTE_MODE,					/* Byte orientation */
40*0Sstevel@tonic-gate 	_WC_MODE					/* Wide orientation */
41*0Sstevel@tonic-gate } _IOP_orientation_t;
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate /*
44*0Sstevel@tonic-gate  * DESCRIPTION:
45*0Sstevel@tonic-gate  * This function gets the pointer to the mbstate_t structure associated
46*0Sstevel@tonic-gate  * with the specified iop.
47*0Sstevel@tonic-gate  *
48*0Sstevel@tonic-gate  * RETURNS:
49*0Sstevel@tonic-gate  * If the associated mbstate_t found, the pointer to the mbstate_t is
50*0Sstevel@tonic-gate  * returned.  Otherwise, (mbstate_t *)NULL is returned.
51*0Sstevel@tonic-gate  */
52*0Sstevel@tonic-gate #ifdef _LP64
53*0Sstevel@tonic-gate #define	_getmbstate(iop)	(&(iop)->_state)
54*0Sstevel@tonic-gate #else
55*0Sstevel@tonic-gate extern mbstate_t	*_getmbstate(FILE *);
56*0Sstevel@tonic-gate #endif
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate /*
59*0Sstevel@tonic-gate  * DESCRIPTION:
60*0Sstevel@tonic-gate  * This function/macro gets the orientation bound to the specified iop.
61*0Sstevel@tonic-gate  *
62*0Sstevel@tonic-gate  * RETURNS:
63*0Sstevel@tonic-gate  * _WC_MODE	if iop has been bound to Wide orientation
64*0Sstevel@tonic-gate  * _BYTE_MODE	if iop has been bound to Byte orientation
65*0Sstevel@tonic-gate  * _NO_MODE	if iop has been bound to neither Wide nor Byte
66*0Sstevel@tonic-gate  */
67*0Sstevel@tonic-gate extern _IOP_orientation_t	_getorientation(FILE *);
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate /*
70*0Sstevel@tonic-gate  * DESCRIPTION:
71*0Sstevel@tonic-gate  * This function/macro sets the orientation to the specified iop.
72*0Sstevel@tonic-gate  *
73*0Sstevel@tonic-gate  * INPUT:
74*0Sstevel@tonic-gate  * flag may take one of the following:
75*0Sstevel@tonic-gate  *	_WC_MODE	Wide orientation
76*0Sstevel@tonic-gate  *	_BYTE_MODE	Byte orientation
77*0Sstevel@tonic-gate  *	_NO_MODE	Unoriented
78*0Sstevel@tonic-gate  */
79*0Sstevel@tonic-gate extern void	_setorientation(FILE *, _IOP_orientation_t);
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate /*
82*0Sstevel@tonic-gate  * From page 32 of XSH5
83*0Sstevel@tonic-gate  * Once a wide-character I/O function has been applied
84*0Sstevel@tonic-gate  * to a stream without orientation, the stream becomes
85*0Sstevel@tonic-gate  * wide-orientated.  Similarly, once a byte I/O function
86*0Sstevel@tonic-gate  * has been applied to a stream without orientation,
87*0Sstevel@tonic-gate  * the stream becomes byte-orientated.  Only a call to
88*0Sstevel@tonic-gate  * the freopen() function or the fwide() function can
89*0Sstevel@tonic-gate  * otherwise alter the orientation of a stream.
90*0Sstevel@tonic-gate  */
91*0Sstevel@tonic-gate 
92*0Sstevel@tonic-gate /*
93*0Sstevel@tonic-gate  * libc_i18n provides the following functions:
94*0Sstevel@tonic-gate  */
95*0Sstevel@tonic-gate extern int	_set_orientation_wide(FILE *, void **, void (*(*))(void), int);
96*0Sstevel@tonic-gate extern void	*__mbst_get_lc_and_fp(const mbstate_t *,
97*0Sstevel@tonic-gate     void (*(*))(void), int);
98*0Sstevel@tonic-gate /*
99*0Sstevel@tonic-gate  * Above two functions take either FP_WCTOMB or FP_FGETWC for the integer
100*0Sstevel@tonic-gate  * argument.
101*0Sstevel@tonic-gate  */
102*0Sstevel@tonic-gate #define	FP_WCTOMB	0
103*0Sstevel@tonic-gate #define	FP_FGETWC	1
104*0Sstevel@tonic-gate 
105*0Sstevel@tonic-gate #define	_SET_ORIENTATION_BYTE(iop) \
106*0Sstevel@tonic-gate { \
107*0Sstevel@tonic-gate 	if (GET_NO_MODE(iop)) \
108*0Sstevel@tonic-gate 		_setorientation(iop, _BYTE_MODE); \
109*0Sstevel@tonic-gate }
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate /* The following is specified in the argument of _get_internal_mbstate() */
112*0Sstevel@tonic-gate #define	_MBRLEN		0
113*0Sstevel@tonic-gate #define	_MBRTOWC	1
114*0Sstevel@tonic-gate #define	_WCRTOMB	2
115*0Sstevel@tonic-gate #define	_MBSRTOWCS	3
116*0Sstevel@tonic-gate #define	_WCSRTOMBS	4
117*0Sstevel@tonic-gate #define	_MAX_MB_FUNC	_WCSRTOMBS
118*0Sstevel@tonic-gate 
119*0Sstevel@tonic-gate extern void	_clear_internal_mbstate(void);
120*0Sstevel@tonic-gate extern mbstate_t	*_get_internal_mbstate(int);
121*0Sstevel@tonic-gate 
122*0Sstevel@tonic-gate #define	MBSTATE_INITIAL(ps)	MBSTATE_RESTART(ps)
123*0Sstevel@tonic-gate #define	MBSTATE_RESTART(ps) \
124*0Sstevel@tonic-gate 	(void) memset((void *)ps, 0, sizeof (mbstate_t))
125*0Sstevel@tonic-gate 
126*0Sstevel@tonic-gate #endif	/* _MSE_H */
127