X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fyaz-iconv.h;h=4ce4e8334fff66b5455d0c419c55e3e6cb8a1bc3;hp=e6bf212da51b12bcfb2ad7b270f5168692c5e12f;hb=04a6feeefe28e7f2f9f4701560b3344545a681c6;hpb=f2428de7b5d72877c544d9812513fe465a1c75a6 diff --git a/include/yaz/yaz-iconv.h b/include/yaz/yaz-iconv.h index e6bf212..4ce4e83 100644 --- a/include/yaz/yaz-iconv.h +++ b/include/yaz/yaz-iconv.h @@ -1,58 +1,112 @@ -/* - * Copyright (c) 1995-2003, Index Data. - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2013 Index Data. + * All rights reserved. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: * - * 2. The name of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * 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. + * * Neither the name of Index Data nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. - * - * $Id: yaz-iconv.h,v 1.4 2003-05-06 11:51:23 adam Exp $ + * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS AND 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. + */ + +/** + * \file yaz-iconv.h + * \brief Header for YAZ iconv interface */ #ifndef YAZ_ICONV_H #define YAZ_ICONV_H +#include #include YAZ_BEGIN_CDECL +/** \brief yaz_iconv handle (similar to iconv_t) */ typedef struct yaz_iconv_struct *yaz_iconv_t; + +/** \brief error code: unknown */ #define YAZ_ICONV_UNKNOWN 1 +/** \brief error code: Not sufficient room for output buffer */ #define YAZ_ICONV_E2BIG 2 +/** \brief error code: Invalid sequence */ #define YAZ_ICONV_EILSEQ 3 +/** \brief error code: An incomplete multibyte sequence is in input buffer */ #define YAZ_ICONV_EINVAL 4 +/** \brief just like iconv_open(3) */ YAZ_EXPORT yaz_iconv_t yaz_iconv_open (const char *tocode, const char *fromcode); +/** \brief just like iconv(3) */ YAZ_EXPORT size_t yaz_iconv (yaz_iconv_t cd, char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft); +/** \brief returns last error - like errno for iconv(3) */ YAZ_EXPORT int yaz_iconv_error (yaz_iconv_t cd); +/** \brief just like iconv_close(3) */ YAZ_EXPORT int yaz_iconv_close (yaz_iconv_t cd); +/** \brief tests whether conversion is handled by YAZ' iconv or system iconv */ YAZ_EXPORT int yaz_iconv_isbuiltin(yaz_iconv_t cd); -YAZ_EXPORT int yaz_matchstr(const char *s1, const char *s2); +YAZ_EXPORT unsigned long yaz_read_UTF8_char(const unsigned char *inp, + size_t inbytesleft, + size_t *no_read, + int *error); + +/** \brief encodes UTF-8 sequence + \param x the UNICODE value + \param outbuf output buffer pointer, updated if conversion is successful + \param outbytesleft length of buffer, updated if conversino is successful + \param error pointer to error code if error occurs + \retval 0 if successful + \retval -1 for error +*/ +YAZ_EXPORT size_t yaz_write_UTF8_char(unsigned long x, + char **outbuf, size_t *outbytesleft, + int *error); + +/* ctype.h macros ASCII based. That do not depend on LANG, nor require + unsigned int as argument */ +#define yaz_isdigit(x) ((x) >= '0' && (x) <= '9') +#define yaz_isspace(x) strchr(" \f\r\n\t\v", x) +#define yaz_toupper(x) ((x) + ('A' - 'a')) +#define yaz_isupper(x) ((x) >= 'A' && (x) <= 'Z') +#define yaz_tolower(x) ((x) + ('a' - 'A')) +#define yaz_islower(x) ((x) >= 'a' && (x) <= 'z') -YAZ_EXPORT int yaz_strcmp_del(const char *a, const char *b, const char *b_del); +/** \brief check whether string apppers to be UTF-8 encoded + \param cstr string to check + \retval 1 OK (appears to be UTF-8) + \retval 0 definitely not UTF-8 +*/ +YAZ_EXPORT int yaz_utf8_check(const char *cstr); YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +