xref: /illumos-gate/usr/src/lib/libc/inc/mse.h (revision 81ad62fc)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
57c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
67c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
77c478bd9Sstevel@tonic-gate  * with the License.
87c478bd9Sstevel@tonic-gate  *
97c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
107c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
117c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
127c478bd9Sstevel@tonic-gate  * and limitations under the License.
137c478bd9Sstevel@tonic-gate  *
147c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
157c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
167c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
177c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
187c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
197c478bd9Sstevel@tonic-gate  *
207c478bd9Sstevel@tonic-gate  * CDDL HEADER END
217c478bd9Sstevel@tonic-gate  */
227c478bd9Sstevel@tonic-gate /*
237c478bd9Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
247c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
257c478bd9Sstevel@tonic-gate  */
264297a3b0SGarrett D'Amore /*
274297a3b0SGarrett D'Amore  * Copyright 2010 Nexenta Systems, Inc.  All rights reserved.
284297a3b0SGarrett D'Amore  * Use is subject to license terms.
294297a3b0SGarrett D'Amore  */
317c478bd9Sstevel@tonic-gate #ifndef	_MSE_H
327c478bd9Sstevel@tonic-gate #define	_MSE_H
344297a3b0SGarrett D'Amore #include "lint.h"
35eda71b4aSGarrett D'Amore #include "file64.h"
367c478bd9Sstevel@tonic-gate #include <stdio.h>
377c478bd9Sstevel@tonic-gate #include <wchar.h>
387c478bd9Sstevel@tonic-gate #include <string.h>
397c478bd9Sstevel@tonic-gate #include "stdiom.h"
417c478bd9Sstevel@tonic-gate typedef enum {
427c478bd9Sstevel@tonic-gate 	_NO_MODE,					/* not bound */
437c478bd9Sstevel@tonic-gate 	_BYTE_MODE,					/* Byte orientation */
447c478bd9Sstevel@tonic-gate 	_WC_MODE					/* Wide orientation */
457c478bd9Sstevel@tonic-gate } _IOP_orientation_t;
477c478bd9Sstevel@tonic-gate /*
487c478bd9Sstevel@tonic-gate  * DESCRIPTION:
497c478bd9Sstevel@tonic-gate  * This function gets the pointer to the mbstate_t structure associated
507c478bd9Sstevel@tonic-gate  * with the specified iop.
517c478bd9Sstevel@tonic-gate  *
527c478bd9Sstevel@tonic-gate  * RETURNS:
537c478bd9Sstevel@tonic-gate  * If the associated mbstate_t found, the pointer to the mbstate_t is
547c478bd9Sstevel@tonic-gate  * returned.  Otherwise, (mbstate_t *)NULL is returned.
557c478bd9Sstevel@tonic-gate  */
567c478bd9Sstevel@tonic-gate #ifdef _LP64
577c478bd9Sstevel@tonic-gate #define	_getmbstate(iop)	(&(iop)->_state)
587c478bd9Sstevel@tonic-gate #else
597c478bd9Sstevel@tonic-gate extern mbstate_t	*_getmbstate(FILE *);
607c478bd9Sstevel@tonic-gate #endif
627c478bd9Sstevel@tonic-gate /*
637c478bd9Sstevel@tonic-gate  * DESCRIPTION:
647c478bd9Sstevel@tonic-gate  * This function/macro gets the orientation bound to the specified iop.
657c478bd9Sstevel@tonic-gate  *
667c478bd9Sstevel@tonic-gate  * RETURNS:
677c478bd9Sstevel@tonic-gate  * _WC_MODE	if iop has been bound to Wide orientation
687c478bd9Sstevel@tonic-gate  * _BYTE_MODE	if iop has been bound to Byte orientation
697c478bd9Sstevel@tonic-gate  * _NO_MODE	if iop has been bound to neither Wide nor Byte
707c478bd9Sstevel@tonic-gate  */
717c478bd9Sstevel@tonic-gate extern _IOP_orientation_t	_getorientation(FILE *);
737c478bd9Sstevel@tonic-gate /*
747c478bd9Sstevel@tonic-gate  * DESCRIPTION:
757c478bd9Sstevel@tonic-gate  * This function/macro sets the orientation to the specified iop.
767c478bd9Sstevel@tonic-gate  *
777c478bd9Sstevel@tonic-gate  * INPUT:
787c478bd9Sstevel@tonic-gate  * flag may take one of the following:
797c478bd9Sstevel@tonic-gate  *	_WC_MODE	Wide orientation
807c478bd9Sstevel@tonic-gate  *	_BYTE_MODE	Byte orientation
817c478bd9Sstevel@tonic-gate  *	_NO_MODE	Unoriented
827c478bd9Sstevel@tonic-gate  */
837c478bd9Sstevel@tonic-gate extern void	_setorientation(FILE *, _IOP_orientation_t);
857c478bd9Sstevel@tonic-gate /*
867c478bd9Sstevel@tonic-gate  * From page 32 of XSH5
877c478bd9Sstevel@tonic-gate  * Once a wide-character I/O function has been applied
887c478bd9Sstevel@tonic-gate  * to a stream without orientation, the stream becomes
89*81ad62fcSSergio Aguayo  * wide-oriented.  Similarly, once a byte I/O function
907c478bd9Sstevel@tonic-gate  * has been applied to a stream without orientation,
91*81ad62fcSSergio Aguayo  * the stream becomes byte-oriented.  Only a call to
927c478bd9Sstevel@tonic-gate  * the freopen() function or the fwide() function can
937c478bd9Sstevel@tonic-gate  * otherwise alter the orientation of a stream.
947c478bd9Sstevel@tonic-gate  */
967c478bd9Sstevel@tonic-gate #define	_SET_ORIENTATION_BYTE(iop) \
977c478bd9Sstevel@tonic-gate { \
987c478bd9Sstevel@tonic-gate 	if (GET_NO_MODE(iop)) \
997c478bd9Sstevel@tonic-gate 		_setorientation(iop, _BYTE_MODE); \
1007c478bd9Sstevel@tonic-gate }
1027c478bd9Sstevel@tonic-gate #endif	/* _MSE_H */