2007-08-06 Simon Josefsson <simon@josefsson.org>

[gnulib.git] / lib / uniconv.h

diff --git a/lib/uniconv.h b/lib/uniconv.h
index 3a62dcc..589e070 100644 (file)
--- a/lib/uniconv.h
+++ b/lib/uniconv.h
@@ -76,6 +76,43 @@ extern int
                               size_t *offsets,
                               uint32_t **resultp, size_t *lengthp);
 
+/* Converts an entire Unicode string, possibly including NUL units, from a
+   Unicode encoding to a given encoding.
+   Converts a memory region to encoding TOCODE.  TOCODE is as for
+   iconv_open(3).
+   The input is in the memory region between SRC (inclusive) and SRC + SRCLEN
+   (exclusive).
+   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.
+   Return value: 0 if successful, otherwise -1 and errno set.
+   If successful: The resulting string is stored in *RESULTP and its length
+   in *LENGTHP.  *RESULTP is set to a freshly allocated memory block, or is
+   unchanged if no dynamic memory allocation was necessary.
+   Particular errno values: EINVAL, EILSEQ, ENOMEM.  */
+extern int
+       u8_conv_to_encoding (const char *tocode,
+                           enum iconv_ilseq_handler handler,
+                           const uint8_t *src, size_t srclen,
+                           size_t *offsets,
+                           char **resultp, size_t *lengthp);
+extern int
+       u16_conv_to_encoding (const char *tocode,
+                            enum iconv_ilseq_handler handler,
+                            const uint16_t *src, size_t srclen,
+                            size_t *offsets,
+                            char **resultp, size_t *lengthp);
+extern int
+       u32_conv_to_encoding (const char *tocode,
+                            enum iconv_ilseq_handler handler,
+                            const uint32_t *src, size_t srclen,
+                            size_t *offsets,
+                            char **resultp, size_t *lengthp);
+
 /* Converts a NUL terminated string from a given encoding.
    The result is malloc allocated, or NULL (with errno set) in case of error.
    Particular errno values: EILSEQ, ENOMEM.  */