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