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