argp-version-etc: new module.

[gnulib.git] / lib / striconveh.h

diff --git a/lib/striconveh.h b/lib/striconveh.h
index 3dc1539..f94b33a 100644 (file)
--- a/lib/striconveh.h
+++ b/lib/striconveh.h
@@ -1,11 +1,11 @@
 /* Character set conversion with error handling.
-   Copyright (C) 2001-2007 Free Software Foundation, Inc.
+   Copyright (C) 2001-2007, 2009 Free Software Foundation, Inc.
    Written by Bruno Haible and Simon Josefsson.
 
-   This program is free software; you can redistribute it and/or modify
+   This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2, or (at your option)
-   any later version.
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -13,8 +13,7 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software Foundation,
-   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #ifndef _STRICONVEH_H
 #define _STRICONVEH_H
@@ -24,29 +23,28 @@
 #include <iconv.h>
 #endif
 
+#include "iconveh.h"
+
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 
-/* Handling of unconvertible characters.  */
-enum iconv_ilseq_handler
-{
-  iconveh_error,               /* return and set errno = EILSEQ */
-  iconveh_question_mark,       /* use one '?' per unconvertible character */
-  iconveh_escape_sequence      /* use escape sequence \uxxxx or \Uxxxxxxxx */
-};
-
 #if HAVE_ICONV
 
 /* Convert an entire string from one encoding to another, using iconv.
    The original string is at [SRC,...,SRC+SRCLEN-1].
-   The conversion descriptor from FROMCODE to TOCODE is passed as CD.
+   CD is the conversion descriptor from FROMCODE to TOCODE, or (iconv_t)(-1) if
+   the system does not support a direct conversion from FROMCODE to TOCODE.
    CD1 is the conversion descriptor from FROM_CODESET to UTF-8 (or
    (iconv_t)(-1) if FROM_CODESET is UTF-8).
    CD2 is the conversion descriptor from UTF-8 to TO_CODESET (or (iconv_t)(-1)
    if TO_CODESET is UTF-8).
+   If OFFSETS is not NULL, it should point to an array of SRCLEN integers; this
+   array is filled with offsets into the result, i.e. the character starting
+   at SRC[i] corresponds to the character starting at (*RESULTP)[OFFSETS[i]],
+   and other offsets are set to (size_t)(-1).
    *RESULTP and *LENGTH should initially be a scratch buffer and its size,
    or *RESULTP can initially be NULL.
    May erase the contents of the memory at *RESULTP.
@@ -58,13 +56,15 @@ extern int
        mem_cd_iconveh (const char *src, size_t srclen,
                       iconv_t cd, iconv_t cd1, iconv_t cd2,
                       enum iconv_ilseq_handler handler,
+                      size_t *offsets,
                       char **resultp, size_t *lengthp);
 
 /* Convert an entire string from one encoding to another, using iconv.
    The original string is the NUL-terminated string starting at SRC.
-   The conversion descriptor is passed as CD.  Both the "from" and the "to"
-   encoding must use a single NUL byte at the end of the string (i.e. not
-   UCS-2, UCS-4, UTF-16, UTF-32).
+   CD is the conversion descriptor from FROMCODE to TOCODE, or (iconv_t)(-1) if
+   the system does not support a direct conversion from FROMCODE to TOCODE.
+   Both the "from" and the "to" encoding must use a single NUL byte at the end
+   of the string (i.e. not UCS-2, UCS-4, UTF-16, UTF-32).
    CD1 is the conversion descriptor from FROM_CODESET to UTF-8 (or
    (iconv_t)(-1) if FROM_CODESET is UTF-8).
    CD2 is the conversion descriptor from UTF-8 to TO_CODESET (or (iconv_t)(-1)
@@ -81,8 +81,10 @@ extern char *
 
 /* Convert an entire string from one encoding to another, using iconv.
    The original string is at [SRC,...,SRC+SRCLEN-1].
-   Both the "from" and the "to" encoding must use a single NUL byte at the
-   end of the string (i.e. not UCS-2, UCS-4, UTF-16, UTF-32).
+   If OFFSETS is not NULL, it should point to an array of SRCLEN integers; this
+   array is filled with offsets into the result, i.e. the character starting
+   at SRC[i] corresponds to the character starting at (*RESULTP)[OFFSETS[i]],
+   and other offsets are set to (size_t)(-1).
    *RESULTP and *LENGTH should initially be a scratch buffer and its size,
    or *RESULTP can initially be NULL.
    May erase the contents of the memory at *RESULTP.
@@ -94,6 +96,7 @@ extern int
        mem_iconveh (const char *src, size_t srclen,
                    const char *from_codeset, const char *to_codeset,
                    enum iconv_ilseq_handler handler,
+                   size_t *offsets,
                    char **resultp, size_t *lengthp);
 
 /* Convert an entire string from one encoding to another, using iconv.