freebsd-dev/lib/libc/iconv/citrus_stdenc.h
Kyle Evans 2300a22c97 libc: iconv: add mb_cur_min for encoder traits
A future commit will actually implement //IGNORE so that applications
using base iconv can, e.g., sanitize UTF-8 strings.  To do this, the
iconv_std module needs to be able to determine the minimum width for any
given encoding so that it can skip that many bytes in the input buffer.
This is mainly an issue for UTF-16 and UTF-32.

This commit bumps shlib versions to 5 for libiconv modules to reflect
the ABI change.  It also fixes OptionalObsoleteFiles to remove the
libiconv modules if WITHOUT_ICONV is in use.

re: _ENCODING_MB_CUR_MIN, note that this file (citrus_stdenc_template.h)
is included at the bottom of an encoding *implementation*, so the
implementation is free to #define it prior.  UTF1632 is a good example,
as it redefines the minimum to be a property on the encodinginfo, and
the minimum is set to 2 or 4 bytes for UTF-16 and UTF-32 respectively.

Sponsored by:	Klara, Inc.
Differential Revision:	https://reviews.freebsd.org/D34344
2022-08-11 11:42:17 -05:00

141 lines
4.2 KiB
C

/* $FreeBSD$ */
/* $NetBSD: citrus_stdenc.h,v 1.4 2005/10/29 18:02:04 tshiozak Exp $ */
/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* 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,
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 size_t
_citrus_stdenc_get_mb_cur_min(struct _citrus_stdenc *ce)
{
return (ce->ce_traits->et_mb_cur_min);
}
static __inline size_t
_citrus_stdenc_get_mb_cur_max(struct _citrus_stdenc *ce)
{
return (ce->ce_traits->et_mb_cur_max);
}
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