Sync Citrus iconv support with NetBSD.
[dragonfly.git] / lib / libc / citrus / citrus_stdenc_local.h
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 #define _CITRUS_STDENC_GETOPS_FUNC_BASE(n)                      \
37 int n(struct _citrus_stdenc_ops *, size_t, uint32_t)
38 #define _CITRUS_STDENC_GETOPS_FUNC(_e_)                                 \
39 _CITRUS_STDENC_GETOPS_FUNC_BASE(_citrus_##_e_##_stdenc_getops)
40 typedef _CITRUS_STDENC_GETOPS_FUNC_BASE((*_citrus_stdenc_getops_t));
41
42
43 #define _CITRUS_STDENC_DECLS(_e_)                                       \
44 static int      _citrus_##_e_##_stdenc_init                             \
45         (struct _citrus_stdenc * __restrict, const void * __restrict,   \
46          size_t, struct _citrus_stdenc_traits * __restrict);            \
47 static void     _citrus_##_e_##_stdenc_uninit(struct _citrus_stdenc *); \
48 static int      _citrus_##_e_##_stdenc_init_state                       \
49         (struct _citrus_stdenc * __restrict, void * __restrict);        \
50 static int      _citrus_##_e_##_stdenc_mbtocs                           \
51         (struct _citrus_stdenc * __restrict,                            \
52          _citrus_csid_t * __restrict, _citrus_index_t * __restrict,     \
53          const char ** __restrict, size_t,                              \
54          void * __restrict, size_t * __restrict);                       \
55 static int      _citrus_##_e_##_stdenc_cstomb                           \
56         (struct _citrus_stdenc * __restrict, char * __restrict,         \
57          size_t, _citrus_csid_t, _citrus_index_t,                       \
58          void * __restrict, size_t * __restrict);                       \
59 static int      _citrus_##_e_##_stdenc_mbtowc                           \
60         (struct _citrus_stdenc * __restrict,                            \
61          _citrus_wc_t * __restrict,                                     \
62          const char ** __restrict, size_t,                              \
63          void * __restrict, size_t * __restrict);                       \
64 static int      _citrus_##_e_##_stdenc_wctomb                           \
65         (struct _citrus_stdenc * __restrict, char * __restrict, size_t, \
66          _citrus_wc_t, void * __restrict, size_t * __restrict);         \
67 static int      _citrus_##_e_##_stdenc_put_state_reset                  \
68         (struct _citrus_stdenc * __restrict, char * __restrict, size_t, \
69          void * __restrict, size_t * __restrict);                       \
70 static int     _citrus_##_e_##_stdenc_get_state_desc                    \
71         (struct _citrus_stdenc * __restrict, void * __restrict, int,    \
72         struct _citrus_stdenc_state_desc * __restrict);                 \
73 CITRUS_MODULE(_e_, stdenc, _citrus_##_e_##_stdenc_getops)
74
75 #define _CITRUS_STDENC_DEF_OPS(_e_)                                     \
76 struct _citrus_stdenc_ops _citrus_##_e_##_stdenc_ops = {                \
77         /* eo_abi_version */    _CITRUS_STDENC_ABI_VERSION,             \
78         /* eo_init */           &_citrus_##_e_##_stdenc_init,           \
79         /* eo_uninit */         &_citrus_##_e_##_stdenc_uninit,         \
80         /* eo_init_state */     &_citrus_##_e_##_stdenc_init_state,     \
81         /* eo_mbtocs */         &_citrus_##_e_##_stdenc_mbtocs,         \
82         /* eo_cstomb */         &_citrus_##_e_##_stdenc_cstomb,         \
83         /* eo_mbtowc */         &_citrus_##_e_##_stdenc_mbtowc,         \
84         /* eo_wctomb */         &_citrus_##_e_##_stdenc_wctomb,         \
85         /* eo_put_state_reset */&_citrus_##_e_##_stdenc_put_state_reset,\
86         /* eo_get_state_desc */ &_citrus_##_e_##_stdenc_get_state_desc  \
87 }
88
89 typedef int     (*_citrus_stdenc_init_t)
90         (struct _citrus_stdenc * __reatrict, const void * __restrict , size_t,
91          struct _citrus_stdenc_traits * __restrict);
92 typedef void    (*_citrus_stdenc_uninit_t)(struct _citrus_stdenc * __restrict);
93 typedef int     (*_citrus_stdenc_init_state_t)
94         (struct _citrus_stdenc * __restrict, void * __restrict);
95 typedef int     (*_citrus_stdenc_mbtocs_t)
96         (struct _citrus_stdenc * __restrict,
97          _citrus_csid_t * __restrict, _citrus_index_t * __restrict,
98          const char ** __restrict, size_t,
99          void * __restrict, size_t * __restrict);
100 typedef int     (*_citrus_stdenc_cstomb_t)
101         (struct _citrus_stdenc *__restrict, char * __restrict, size_t,
102          _citrus_csid_t, _citrus_index_t, void * __restrict,
103          size_t * __restrict);
104 typedef int     (*_citrus_stdenc_mbtowc_t)
105         (struct _citrus_stdenc * __restrict,
106          _citrus_wc_t * __restrict,
107          const char ** __restrict, size_t,
108          void * __restrict, size_t * __restrict);
109 typedef int     (*_citrus_stdenc_wctomb_t)
110         (struct _citrus_stdenc *__restrict, char * __restrict, size_t,
111          _citrus_wc_t, void * __restrict, size_t * __restrict);
112 typedef int     (*_citrus_stdenc_put_state_reset_t)
113         (struct _citrus_stdenc *__restrict, char * __restrict, size_t,
114          void * __restrict, size_t * __restrict);
115 typedef int     (*_citrus_stdenc_get_state_desc_t)
116         (struct _citrus_stdenc * __restrict, void * __restrict, int,
117          struct _citrus_stdenc_state_desc * __restrict);
118 /*
119  * ABI version change log
120  *   0x00000001
121  *     initial version
122  */
123 #define _CITRUS_STDENC_ABI_VERSION      0x00000002
124 struct _citrus_stdenc_ops {
125         uint32_t                        eo_abi_version;
126         /* version 0x00000001 */
127         _citrus_stdenc_init_t           eo_init;
128         _citrus_stdenc_uninit_t         eo_uninit;
129         _citrus_stdenc_init_state_t     eo_init_state;
130         _citrus_stdenc_mbtocs_t         eo_mbtocs;
131         _citrus_stdenc_cstomb_t         eo_cstomb;
132         _citrus_stdenc_mbtowc_t         eo_mbtowc;
133         _citrus_stdenc_wctomb_t         eo_wctomb;
134         _citrus_stdenc_put_state_reset_t eo_put_state_reset;
135         /* version 0x00000002 */
136         _citrus_stdenc_get_state_desc_t eo_get_state_desc;
137 };
138
139 struct _citrus_stdenc_traits {
140         /* version 0x00000001 */
141         size_t                          et_state_size;
142         size_t                          et_mb_cur_max;
143 };
144
145 struct _citrus_stdenc {
146         /* public */
147         /* version 0x00000001 */
148         struct _citrus_stdenc_ops       *ce_ops;
149         void                            *ce_closure;
150         /* private */
151         _citrus_module_t                ce_module;
152         struct _citrus_stdenc_traits    *ce_traits;
153 };
154
155 #define _CITRUS_DEFAULT_STDENC_NAME             "NONE"
156
157 #endif