freebsd-dev/lib/libc/iconv/citrus_stdenc.h

125 lines
3.9 KiB
C
Raw Normal View History

Add the BSD-licensed Citrus iconv to the base system with default off setting. It can be built by setting the WITH_ICONV knob. While this knob is unset, the library part, the binaries, the header file and the metadata files will not be built or installed so it makes no impact on the system if left turned off. This work is based on the iconv implementation in NetBSD but a great number of improvements and feature additions have been included: - Some utilities have been added. There is a conversion table generator, which can compare conversion tables to reference data generated by GNU libiconv. This helps ensuring conversion compatibility. - UTF-16 surrogate support and some endianness issues have been fixed. - The rather chaotic Makefiles to build metadata have been refactored and cleaned up, now it is easy to read and it is also easier to add support for new encodings. - A bunch of new encodings and encoding aliases have been added. - Support for 1->2, 1->3 and 1->4 mappings, which is needed for transliterating with flying accents as GNU does, like "u. - Lots of warnings have been fixed, the major part of the code is now WARNS=6 clean. - New section 1 and section 5 manual pages have been added. - Some GNU-specific calls have been implemented: iconvlist(), iconvctl(), iconv_canonicalize(), iconv_open_into() - Support for GNU's //IGNORE suffix has been added. - The "-" argument for stdin is now recognized in iconv(1) as per POSIX. - The Big5 conversion module has been fixed. - The iconv.h header files is supposed to be compatible with the GNU version, i.e. sources should build with base iconv.h and GNU libiconv. It also includes a macro magic to deal with the char ** and const char ** incompatibility. - GNU compatibility: "" or "char" means the current local encoding in use - Various cleanups and style(9) fixes. Approved by: delphij (mentor) Obtained from: The NetBSD Project Sponsored by: Google Summer of Code 2009
2011-02-25 00:04:39 +00:00
/* $FreeBSD$ */
/* $NetBSD: citrus_stdenc.h,v 1.4 2005/10/29 18:02:04 tshiozak Exp $ */
/*-
* Copyright (c)2003 Citrus Project,
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
#ifndef _CITRUS_STDENC_H_
#define _CITRUS_STDENC_H_
struct _citrus_stdenc;
struct _citrus_stdenc_ops;
struct _citrus_stdenc_traits;
#define _CITRUS_STDENC_SDID_GENERIC 0
struct _citrus_stdenc_state_desc
{
union {
struct {
int state;
#define _CITRUS_STDENC_SDGEN_UNKNOWN 0
#define _CITRUS_STDENC_SDGEN_INITIAL 1
#define _CITRUS_STDENC_SDGEN_STABLE 2
#define _CITRUS_STDENC_SDGEN_INCOMPLETE_CHAR 3
#define _CITRUS_STDENC_SDGEN_INCOMPLETE_SHIFT 4
} generic;
} u;
};
#include "citrus_stdenc_local.h"
__BEGIN_DECLS
int _citrus_stdenc_open(struct _citrus_stdenc * __restrict * __restrict,
char const * __restrict, const void * __restrict, size_t);
void _citrus_stdenc_close(struct _citrus_stdenc *);
__END_DECLS
static __inline int
_citrus_stdenc_init_state(struct _citrus_stdenc * __restrict ce,
void * __restrict ps)
{
return ((*ce->ce_ops->eo_init_state)(ce, ps));
}
static __inline int
_citrus_stdenc_mbtocs(struct _citrus_stdenc * __restrict ce,
_citrus_csid_t * __restrict csid, _citrus_index_t * __restrict idx,
char ** __restrict s, size_t n, void * __restrict ps,
Add the BSD-licensed Citrus iconv to the base system with default off setting. It can be built by setting the WITH_ICONV knob. While this knob is unset, the library part, the binaries, the header file and the metadata files will not be built or installed so it makes no impact on the system if left turned off. This work is based on the iconv implementation in NetBSD but a great number of improvements and feature additions have been included: - Some utilities have been added. There is a conversion table generator, which can compare conversion tables to reference data generated by GNU libiconv. This helps ensuring conversion compatibility. - UTF-16 surrogate support and some endianness issues have been fixed. - The rather chaotic Makefiles to build metadata have been refactored and cleaned up, now it is easy to read and it is also easier to add support for new encodings. - A bunch of new encodings and encoding aliases have been added. - Support for 1->2, 1->3 and 1->4 mappings, which is needed for transliterating with flying accents as GNU does, like "u. - Lots of warnings have been fixed, the major part of the code is now WARNS=6 clean. - New section 1 and section 5 manual pages have been added. - Some GNU-specific calls have been implemented: iconvlist(), iconvctl(), iconv_canonicalize(), iconv_open_into() - Support for GNU's //IGNORE suffix has been added. - The "-" argument for stdin is now recognized in iconv(1) as per POSIX. - The Big5 conversion module has been fixed. - The iconv.h header files is supposed to be compatible with the GNU version, i.e. sources should build with base iconv.h and GNU libiconv. It also includes a macro magic to deal with the char ** and const char ** incompatibility. - GNU compatibility: "" or "char" means the current local encoding in use - Various cleanups and style(9) fixes. Approved by: delphij (mentor) Obtained from: The NetBSD Project Sponsored by: Google Summer of Code 2009
2011-02-25 00:04:39 +00:00
size_t * __restrict nresult, struct iconv_hooks *hooks)
{
return ((*ce->ce_ops->eo_mbtocs)(ce, csid, idx, s, n, ps, nresult,
hooks));
}
static __inline int
_citrus_stdenc_cstomb(struct _citrus_stdenc * __restrict ce,
char * __restrict s, size_t n, _citrus_csid_t csid, _citrus_index_t idx,
void * __restrict ps, size_t * __restrict nresult,
struct iconv_hooks *hooks)
{
return ((*ce->ce_ops->eo_cstomb)(ce, s, n, csid, idx, ps, nresult,
hooks));
}
static __inline int
_citrus_stdenc_wctomb(struct _citrus_stdenc * __restrict ce,
char * __restrict s, size_t n, _citrus_wc_t wc, void * __restrict ps,
size_t * __restrict nresult, struct iconv_hooks *hooks)
{
return ((*ce->ce_ops->eo_wctomb)(ce, s, n, wc, ps, nresult, hooks));
}
static __inline int
_citrus_stdenc_put_state_reset(struct _citrus_stdenc * __restrict ce,
char * __restrict s, size_t n, void * __restrict ps,
size_t * __restrict nresult)
{
return ((*ce->ce_ops->eo_put_state_reset)(ce, s, n, ps, nresult));
}
static __inline size_t
_citrus_stdenc_get_state_size(struct _citrus_stdenc *ce)
{
return (ce->ce_traits->et_state_size);
}
static __inline int
_citrus_stdenc_get_state_desc(struct _citrus_stdenc * __restrict ce,
void * __restrict ps, int id,
struct _citrus_stdenc_state_desc * __restrict d)
{
return ((*ce->ce_ops->eo_get_state_desc)(ce, ps, id, d));
}
#endif