X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fyaz-iconv.h;h=4768805b037971ae2d13ebf36218d91892fb96c8;hb=6dff34312a0f7c3272f7b52c5e13af1e04f72228;hp=599f8adf66b106c760cd93c55b9294166abea2d0;hpb=e87336d1ad9587d0a7fdc805e2b53c77d435d67c;p=yaz-moved-to-github.git

diff --git a/include/yaz/yaz-iconv.h b/include/yaz/yaz-iconv.h
index 599f8ad..4768805 100644
--- a/include/yaz/yaz-iconv.h
+++ b/include/yaz/yaz-iconv.h
@@ -1,30 +1,30 @@
-/*
- * Copyright (C) 1995-2006, Index Data ApS
- *
- * 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-2008 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.10 2006-08-04 14:35:39 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
@@ -65,15 +65,61 @@ 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);
 
+/** \brief match strings - independent of case and '-'
+    \param s1 first string
+    \param s2 second string (May include wildcard ? and .)
+    \retval 0 strings are similar
+    \retval !=0 strings are different
+*/
 YAZ_EXPORT int yaz_matchstr(const char *s1, const char *s2);
 
+/** \brief match a and b with some delimitor for b
+    \param a first second
+    \param b second string
+    \param b_del delimitor for b
+    \retval 0 strings are similar
+    \retval !=0 strings are different
+*/
 YAZ_EXPORT int yaz_strcmp_del(const char *a, const char *b, const char *b_del);
 
+
+/** \brief compares two buffers of different size
+    \param a first buffer
+    \param b second buffer
+    \param len_a length of first buffer
+    \retval len_b length of second buffer
+    \retval 0 buffers are equal
+    \retval >0 a > b
+    \retval <0 a < b
+*/
+int yaz_memcmp(const void *a, const void *b, size_t len_a, size_t len_b);
+
+
+/** \brief decodes UTF-8 sequence
+    \param inp input buffer with UTF-8 bytes
+    \param inbytesleft length of input buffer
+    \param no_read holds number of bytes read if conversion is successful
+    \param error pointer to error code if error occurs
+    \retval 0 if error
+    \retval >0 if conversion is successful
+*/
 YAZ_EXPORT unsigned long yaz_read_UTF8_char(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);
+
 YAZ_END_CDECL
 
 #endif