include/yaz/yaz-iconv.h

   1 /*
   2  * Copyright (C) 1995-2006, Index Data ApS
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The name of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Id: yaz-iconv.h,v 1.10 2006-08-04 14:35:39 adam Exp $
  27  */
  28 /**
  29  * \file yaz-iconv.h
  30  * \brief Header for YAZ iconv interface
  31  */
  32
  33 #ifndef YAZ_ICONV_H
  34 #define YAZ_ICONV_H
  35
  36 #include <stddef.h>
  37 #include <yaz/yconfig.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 /** \brief yaz_iconv handle (similar to iconv_t) */
  42 typedef struct yaz_iconv_struct *yaz_iconv_t;
  43
  44 /** \brief error code: unknown */
  45 #define YAZ_ICONV_UNKNOWN 1
  46 /** \brief error code: Not sufficient room for output buffer */
  47 #define YAZ_ICONV_E2BIG 2
  48 /** \brief error code: Invalid sequence */
  49 #define YAZ_ICONV_EILSEQ 3
  50 /** \brief error code: An incomplete multibyte sequence is in input buffer */
  51 #define YAZ_ICONV_EINVAL 4
  52
  53 /** \brief just like iconv_open(3) */
  54 YAZ_EXPORT yaz_iconv_t yaz_iconv_open (const char *tocode,
  55                                        const char *fromcode);
  56 /** \brief just like iconv(3) */
  57 YAZ_EXPORT size_t yaz_iconv (yaz_iconv_t cd, char **inbuf, size_t *inbytesleft,
  58                              char **outbuf, size_t *outbytesleft);
  59 /** \brief returns last error - like errno for iconv(3) */
  60 YAZ_EXPORT int yaz_iconv_error (yaz_iconv_t cd);
  61
  62 /** \brief just like iconv_close(3) */
  63 YAZ_EXPORT int yaz_iconv_close (yaz_iconv_t cd);
  64
  65 /** \brief tests whether conversion is handled by YAZ' iconv or system iconv */
  66 YAZ_EXPORT int yaz_iconv_isbuiltin(yaz_iconv_t cd);
  67
  68 YAZ_EXPORT int yaz_matchstr(const char *s1, const char *s2);
  69
  70 YAZ_EXPORT int yaz_strcmp_del(const char *a, const char *b, const char *b_del);
  71
  72 YAZ_EXPORT unsigned long yaz_read_UTF8_char(unsigned char *inp,
  73                                             size_t inbytesleft,
  74                                             size_t *no_read,
  75                                             int *error);
  76
  77 YAZ_END_CDECL
  78
  79 #endif
  80 /*
  81  * Local variables:
  82  * c-basic-offset: 4
  83  * indent-tabs-mode: nil
  84  * End:
  85  * vim: shiftwidth=4 tabstop=8 expandtab
  86  */
  87