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