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