1 /* $NetBSD: citrus_stdenc_local.h,v 1.4 2008/02/09 14:56:20 junyoung Exp $ */
2 /* $DragonFly: src/lib/libc/citrus/citrus_stdenc_local.h,v 1.3 2008/04/10 10:21:01 hasso Exp $ */
3 
4 /*-
5  * Copyright (c)2003 Citrus Project,
6  * All rights reserved.
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.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  */
30 
31 #ifndef _CITRUS_STDENC_LOCAL_H_
32 #define _CITRUS_STDENC_LOCAL_H_
33 
34 #include "citrus_module.h"
35 
36 struct _citrus_stdenc;
37 struct _citrus_stdenc_ops;
38 struct _citrus_stdenc_state_desc;
39 struct _citrus_stdenc_traits;
40 
41 #define _CITRUS_STDENC_GETOPS_FUNC_BASE(n)			\
42 int n(struct _citrus_stdenc_ops *, size_t, uint32_t)
43 #define _CITRUS_STDENC_GETOPS_FUNC(_e_)					\
44 _CITRUS_STDENC_GETOPS_FUNC_BASE(_citrus_##_e_##_stdenc_getops)
45 typedef _CITRUS_STDENC_GETOPS_FUNC_BASE((*_citrus_stdenc_getops_t));
46 
47 
48 #define _CITRUS_STDENC_DECLS(_e_)					\
49 static int	_citrus_##_e_##_stdenc_init				\
50 	(struct _citrus_stdenc * __restrict, const void * __restrict,	\
51 	 size_t, struct _citrus_stdenc_traits * __restrict);		\
52 static void	_citrus_##_e_##_stdenc_uninit(struct _citrus_stdenc *);	\
53 static int	_citrus_##_e_##_stdenc_init_state			\
54 	(struct _citrus_stdenc * __restrict, void * __restrict);	\
55 static int	_citrus_##_e_##_stdenc_mbtocs				\
56 	(struct _citrus_stdenc * __restrict,				\
57 	 _citrus_csid_t * __restrict, _citrus_index_t * __restrict,	\
58 	 const char ** __restrict, size_t,				\
59 	 void * __restrict, size_t * __restrict);			\
60 static int	_citrus_##_e_##_stdenc_cstomb				\
61 	(struct _citrus_stdenc * __restrict, char * __restrict,		\
62 	 size_t, _citrus_csid_t, _citrus_index_t,			\
63 	 void * __restrict, size_t * __restrict);			\
64 static int	_citrus_##_e_##_stdenc_mbtowc				\
65 	(struct _citrus_stdenc * __restrict,				\
66 	 _citrus_wc_t * __restrict,					\
67 	 const char ** __restrict, size_t,				\
68 	 void * __restrict, size_t * __restrict);			\
69 static int	_citrus_##_e_##_stdenc_wctomb				\
70 	(struct _citrus_stdenc * __restrict, char * __restrict, size_t,	\
71 	 _citrus_wc_t, void * __restrict, size_t * __restrict);		\
72 static int	_citrus_##_e_##_stdenc_put_state_reset			\
73 	(struct _citrus_stdenc * __restrict, char * __restrict, size_t,	\
74 	 void * __restrict, size_t * __restrict);			\
75 static int     _citrus_##_e_##_stdenc_get_state_desc			\
76 	(struct _citrus_stdenc * __restrict, void * __restrict, int,	\
77 	struct _citrus_stdenc_state_desc * __restrict);			\
78 CITRUS_MODULE(_e_, stdenc, _citrus_##_e_##_stdenc_getops)
79 
80 #define _CITRUS_STDENC_DEF_OPS(_e_)					\
81 struct _citrus_stdenc_ops _citrus_##_e_##_stdenc_ops = {		\
82 	/* eo_abi_version */	_CITRUS_STDENC_ABI_VERSION,		\
83 	/* eo_init */		&_citrus_##_e_##_stdenc_init,		\
84 	/* eo_uninit */		&_citrus_##_e_##_stdenc_uninit,		\
85 	/* eo_init_state */	&_citrus_##_e_##_stdenc_init_state,	\
86 	/* eo_mbtocs */		&_citrus_##_e_##_stdenc_mbtocs,		\
87 	/* eo_cstomb */		&_citrus_##_e_##_stdenc_cstomb,		\
88 	/* eo_mbtowc */		&_citrus_##_e_##_stdenc_mbtowc,		\
89 	/* eo_wctomb */		&_citrus_##_e_##_stdenc_wctomb,		\
90 	/* eo_put_state_reset */&_citrus_##_e_##_stdenc_put_state_reset,\
91 	/* eo_get_state_desc */	&_citrus_##_e_##_stdenc_get_state_desc	\
92 }
93 
94 typedef int	(*_citrus_stdenc_init_t)
95 	(struct _citrus_stdenc * __reatrict, const void * __restrict , size_t,
96 	 struct _citrus_stdenc_traits * __restrict);
97 typedef void	(*_citrus_stdenc_uninit_t)(struct _citrus_stdenc * __restrict);
98 typedef int	(*_citrus_stdenc_init_state_t)
99 	(struct _citrus_stdenc * __restrict, void * __restrict);
100 typedef int	(*_citrus_stdenc_mbtocs_t)
101 	(struct _citrus_stdenc * __restrict,
102 	 _citrus_csid_t * __restrict, _citrus_index_t * __restrict,
103 	 const char ** __restrict, size_t,
104 	 void * __restrict, size_t * __restrict);
105 typedef int	(*_citrus_stdenc_cstomb_t)
106 	(struct _citrus_stdenc *__restrict, char * __restrict, size_t,
107 	 _citrus_csid_t, _citrus_index_t, void * __restrict,
108 	 size_t * __restrict);
109 typedef int	(*_citrus_stdenc_mbtowc_t)
110 	(struct _citrus_stdenc * __restrict,
111 	 _citrus_wc_t * __restrict,
112 	 const char ** __restrict, size_t,
113 	 void * __restrict, size_t * __restrict);
114 typedef int	(*_citrus_stdenc_wctomb_t)
115 	(struct _citrus_stdenc *__restrict, char * __restrict, size_t,
116 	 _citrus_wc_t, void * __restrict, size_t * __restrict);
117 typedef int	(*_citrus_stdenc_put_state_reset_t)
118 	(struct _citrus_stdenc *__restrict, char * __restrict, size_t,
119 	 void * __restrict, size_t * __restrict);
120 typedef int	(*_citrus_stdenc_get_state_desc_t)
121 	(struct _citrus_stdenc * __restrict, void * __restrict, int,
122 	 struct _citrus_stdenc_state_desc * __restrict);
123 /*
124  * ABI version change log
125  *   0x00000001
126  *     initial version
127  */
128 #define _CITRUS_STDENC_ABI_VERSION	0x00000002
129 struct _citrus_stdenc_ops {
130 	uint32_t			eo_abi_version;
131 	/* version 0x00000001 */
132 	_citrus_stdenc_init_t		eo_init;
133 	_citrus_stdenc_uninit_t		eo_uninit;
134 	_citrus_stdenc_init_state_t	eo_init_state;
135 	_citrus_stdenc_mbtocs_t		eo_mbtocs;
136 	_citrus_stdenc_cstomb_t		eo_cstomb;
137 	_citrus_stdenc_mbtowc_t		eo_mbtowc;
138 	_citrus_stdenc_wctomb_t		eo_wctomb;
139 	_citrus_stdenc_put_state_reset_t eo_put_state_reset;
140 	/* version 0x00000002 */
141 	_citrus_stdenc_get_state_desc_t	eo_get_state_desc;
142 };
143 
144 struct _citrus_stdenc_traits {
145 	/* version 0x00000001 */
146 	size_t				et_state_size;
147 	size_t				et_mb_cur_max;
148 };
149 
150 struct _citrus_stdenc {
151 	/* public */
152 	/* version 0x00000001 */
153 	struct _citrus_stdenc_ops	*ce_ops;
154 	void				*ce_closure;
155 	/* private */
156 	_citrus_module_t		ce_module;
157 	struct _citrus_stdenc_traits	*ce_traits;
158 };
159 
160 #define _CITRUS_DEFAULT_STDENC_NAME		"NONE"
161 
162 #endif
163