1
0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-25 11:37:56 +00:00
freebsd/lib/libc/iconv/citrus_mapper.h
Gabor Kovesdan ad30f8e79b 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

132 lines
4.2 KiB
C

/* $FreeBSD$ */
/* $NetBSD: citrus_mapper.h,v 1.3 2003/07/12 15:39:19 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_MAPPER_H_
#define _CITRUS_MAPPER_H_
struct _citrus_mapper_area;
struct _citrus_mapper;
struct _citrus_mapper_ops;
struct _citrus_mapper_traits;
__BEGIN_DECLS
int _citrus_mapper_create_area(
struct _citrus_mapper_area *__restrict *__restrict,
const char *__restrict);
int _citrus_mapper_open(struct _citrus_mapper_area *__restrict,
struct _citrus_mapper *__restrict *__restrict,
const char *__restrict);
int _citrus_mapper_open_direct(
struct _citrus_mapper_area *__restrict,
struct _citrus_mapper *__restrict *__restrict,
const char *__restrict, const char *__restrict);
void _citrus_mapper_close(struct _citrus_mapper *);
void _citrus_mapper_set_persistent(struct _citrus_mapper * __restrict);
__END_DECLS
#include "citrus_mapper_local.h"
/* return values of _citrus_mapper_convert */
#define _CITRUS_MAPPER_CONVERT_SUCCESS (0)
#define _CITRUS_MAPPER_CONVERT_NONIDENTICAL (1)
#define _CITRUS_MAPPER_CONVERT_SRC_MORE (2)
#define _CITRUS_MAPPER_CONVERT_DST_MORE (3)
#define _CITRUS_MAPPER_CONVERT_ILSEQ (4)
#define _CITRUS_MAPPER_CONVERT_FATAL (5)
/*
* _citrus_mapper_convert:
* convert an index.
* - if the converter supports M:1 converter, the function may return
* _CITRUS_MAPPER_CONVERT_SRC_MORE and the storage pointed by dst
* may be unchanged in this case, although the internal status of
* the mapper is affected.
* - if the converter supports 1:N converter, the function may return
* _CITRUS_MAPPER_CONVERT_DST_MORE. In this case, the contiguous
* call of this function ignores src and changes the storage pointed
* by dst.
* - if the converter supports M:N converter, the function may behave
* the combination of the above.
*
*/
static __inline int
_citrus_mapper_convert(struct _citrus_mapper * __restrict cm,
_citrus_index_t * __restrict dst, _citrus_index_t src,
void * __restrict ps)
{
return ((*cm->cm_ops->mo_convert)(cm, dst, src, ps));
}
/*
* _citrus_mapper_init_state:
* initialize the state.
*/
static __inline void
_citrus_mapper_init_state(struct _citrus_mapper * __restrict cm)
{
(*cm->cm_ops->mo_init_state)();
}
/*
* _citrus_mapper_get_state_size:
* get the size of state storage.
*/
static __inline size_t
_citrus_mapper_get_state_size(struct _citrus_mapper * __restrict cm)
{
return (cm->cm_traits->mt_state_size);
}
/*
* _citrus_mapper_get_src_max:
* get the maximum number of suspended sources.
*/
static __inline size_t
_citrus_mapper_get_src_max(struct _citrus_mapper * __restrict cm)
{
return (cm->cm_traits->mt_src_max);
}
/*
* _citrus_mapper_get_dst_max:
* get the maximum number of suspended destinations.
*/
static __inline size_t
_citrus_mapper_get_dst_max(struct _citrus_mapper * __restrict cm)
{
return (cm->cm_traits->mt_dst_max);
}
#endif