r23784: use the GPLv3 boilerplate as recommended by the FSF and the license text
[tprouty/samba.git] / source / lib / charcnv.c
index eb427cc0fce23ac39a3b4dc88ca98a9efeb7b116..b48880a8ea9239c81627cfef0a45c94accb4ce5d 100644 (file)
@@ -8,7 +8,7 @@
    
    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 of the License, or
+   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,
    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., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 #include "includes.h"
 
+/* We can parameterize this if someone complains.... JRA. */
+
+char lp_failed_convert_char(void)
+{
+       return '_';
+}
+
 /**
  * @file
  *
@@ -40,7 +46,7 @@
 
 
 static smb_iconv_t conv_handles[NUM_CHARSETS][NUM_CHARSETS];
-
+static BOOL conv_silent; /* Should we do a debug if the conversion fails ? */
 
 /**
  * Return the name of a charset to give to iconv().
@@ -49,12 +55,37 @@ static const char *charset_name(charset_t ch)
 {
        const char *ret = NULL;
 
-       if (ch == CH_UCS2) ret = "UCS-2LE";
+       if (ch == CH_UTF16LE) ret = "UTF-16LE";
+       else if (ch == CH_UTF16BE) ret = "UTF-16BE";
        else if (ch == CH_UNIX) ret = lp_unix_charset();
        else if (ch == CH_DOS) ret = lp_dos_charset();
        else if (ch == CH_DISPLAY) ret = lp_display_charset();
        else if (ch == CH_UTF8) ret = "UTF8";
 
+#if defined(HAVE_NL_LANGINFO) && defined(CODESET)
+       if (ret && !strcmp(ret, "LOCALE")) {
+               const char *ln = NULL;
+
+#ifdef HAVE_SETLOCALE
+               setlocale(LC_ALL, "");
+#endif
+               ln = nl_langinfo(CODESET);
+               if (ln) {
+                       /* Check whether the charset name is supported
+                          by iconv */
+                       smb_iconv_t handle = smb_iconv_open(ln,"UCS-2LE");
+                       if (handle == (smb_iconv_t) -1) {
+                               DEBUG(5,("Locale charset '%s' unsupported, using ASCII instead\n", ln));
+                               ln = NULL;
+                       } else {
+                               DEBUG(5,("Substituting charset '%s' for LOCALE\n", ln));
+                               smb_iconv_close(handle);
+                       }
+               }
+               ret = ln;
+       }
+#endif
+
        if (!ret || !*ret) ret = "ASCII";
        return ret;
 }
@@ -70,6 +101,23 @@ void lazy_initialize_conv(void)
        }
 }
 
+/**
+ * Destroy global objects allocated by init_iconv()
+ **/
+void gfree_charcnv(void)
+{
+       int c1, c2;
+
+       for (c1=0;c1<NUM_CHARSETS;c1++) {
+               for (c2=0;c2<NUM_CHARSETS;c2++) {
+                       if ( conv_handles[c1][c2] ) {
+                               smb_iconv_close( conv_handles[c1][c2] );
+                               conv_handles[c1][c2] = 0;
+                       }
+               }
+       }
+}
+
 /**
  * Initialize iconv conversion descriptors.
  *
@@ -84,11 +132,11 @@ void init_iconv(void)
 
        /* so that charset_name() works we need to get the UNIX<->UCS2 going
           first */
-       if (!conv_handles[CH_UNIX][CH_UCS2])
-               conv_handles[CH_UNIX][CH_UCS2] = smb_iconv_open("UCS-2LE", "ASCII");
+       if (!conv_handles[CH_UNIX][CH_UTF16LE])
+               conv_handles[CH_UNIX][CH_UTF16LE] = smb_iconv_open(charset_name(CH_UTF16LE), "ASCII");
 
-       if (!conv_handles[CH_UCS2][CH_UNIX])
-               conv_handles[CH_UCS2][CH_UNIX] = smb_iconv_open("ASCII", "UCS-2LE");
+       if (!conv_handles[CH_UTF16LE][CH_UNIX])
+               conv_handles[CH_UTF16LE][CH_UNIX] = smb_iconv_open("ASCII", charset_name(CH_UTF16LE));
 
        for (c1=0;c1<NUM_CHARSETS;c1++) {
                for (c2=0;c2<NUM_CHARSETS;c2++) {
@@ -106,9 +154,21 @@ void init_iconv(void)
 
                        conv_handles[c1][c2] = smb_iconv_open(n2,n1);
                        if (conv_handles[c1][c2] == (smb_iconv_t)-1) {
-                               DEBUG(0,("Conversion from %s to %s not supported\n",
+                               DEBUG(0,("init_iconv: Conversion from %s to %s not supported\n",
                                         charset_name((charset_t)c1), charset_name((charset_t)c2)));
-                               conv_handles[c1][c2] = NULL;
+                               if (c1 != CH_UTF16LE && c1 != CH_UTF16BE) {
+                                       n1 = "ASCII";
+                               }
+                               if (c2 != CH_UTF16LE && c2 != CH_UTF16BE) {
+                                       n2 = "ASCII";
+                               }
+                               DEBUG(0,("init_iconv: Attempting to replace with conversion from %s to %s\n",
+                                       n1, n2 ));
+                               conv_handles[c1][c2] = smb_iconv_open(n2,n1);
+                               if (!conv_handles[c1][c2]) {
+                                       DEBUG(0,("init_iconv: Conversion from %s to %s failed", n1, n2));
+                                       smb_panic("init_iconv: conv_handle initialization failed");
+                               }
                        }
                }
        }
@@ -117,23 +177,31 @@ void init_iconv(void)
                /* XXX: Does this really get called every time the dos
                 * codepage changes? */
                /* XXX: Is the did_reload test too strict? */
+               conv_silent = True;
                init_doschar_table();
                init_valid_table();
+               conv_silent = False;
        }
 }
 
 /**
  * Convert string from one encoding to another, making error checking etc
+ * Slow path version - uses (slow) iconv.
  *
  * @param src pointer to source string (multibyte or singlebyte)
  * @param srclen length of the source string in bytes
  * @param dest pointer to destination string (multibyte or singlebyte)
  * @param destlen maximal length allowed for string
+ * @param allow_bad_conv determines if a "best effort" conversion is acceptable (never returns errors)
  * @returns the number of bytes occupied in the destination
+ *
+ * Ensure the srclen contains the terminating zero.
+ *
  **/
-size_t convert_string(charset_t from, charset_t to,
+
+static size_t convert_string_internal(charset_t from, charset_t to,
                      void const *src, size_t srclen, 
-                     void *dest, size_t destlen)
+                     void *dest, size_t destlen, BOOL allow_bad_conv)
 {
        size_t i_len, o_len;
        size_t retval;
@@ -141,95 +209,374 @@ size_t convert_string(charset_t from, charset_t to,
        char* outbuf = (char*)dest;
        smb_iconv_t descriptor;
 
-       if (srclen == (size_t)-1)
-               srclen = strlen(src)+1;
-
        lazy_initialize_conv();
 
        descriptor = conv_handles[from][to];
 
+       if (srclen == (size_t)-1) {
+               if (from == CH_UTF16LE || from == CH_UTF16BE) {
+                       srclen = (strlen_w((const smb_ucs2_t *)src)+1) * 2;
+               } else {
+                       srclen = strlen((const char *)src)+1;
+               }
+       }
+
+
        if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
-               /* conversion not supported, use as is */
-               size_t len = MIN(srclen,destlen);
-               memcpy(dest,src,len);
-               return len;
+               if (!conv_silent)
+                       DEBUG(0,("convert_string_internal: Conversion not supported.\n"));
+               return (size_t)-1;
        }
 
        i_len=srclen;
        o_len=destlen;
-       retval = smb_iconv(descriptor,  &inbuf, &i_len, &outbuf, &o_len);
+
+ again:
+
+       retval = smb_iconv(descriptor, &inbuf, &i_len, &outbuf, &o_len);
        if(retval==(size_t)-1) {
                const char *reason="unknown error";
                switch(errno) {
                        case EINVAL:
                                reason="Incomplete multibyte sequence";
+                               if (!conv_silent)
+                                       DEBUG(3,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
+                               if (allow_bad_conv)
+                                       goto use_as_is;
                                break;
                        case E2BIG:
                                reason="No more room"; 
-                               DEBUG(0, ("convert_string: Required %d, available %d\n",
-                                       srclen, destlen));
-                               /* we are not sure we need srclen bytes,
-                                 may be more, may be less.
-                                 We only know we need more than destlen
-                                 bytes ---simo */
-                              break;
+                               if (!conv_silent) {
+                                       if (from == CH_UNIX) {
+                                               DEBUG(3,("E2BIG: convert_string(%s,%s): srclen=%u destlen=%u - '%s'\n",
+                                                       charset_name(from), charset_name(to),
+                                                       (unsigned int)srclen, (unsigned int)destlen, (const char *)src));
+                                       } else {
+                                               DEBUG(3,("E2BIG: convert_string(%s,%s): srclen=%u destlen=%u\n",
+                                                       charset_name(from), charset_name(to),
+                                                       (unsigned int)srclen, (unsigned int)destlen));
+                                       }
+                               }
+                               break;
                        case EILSEQ:
-                              reason="Illegal multibyte sequence";
-                              break;
+                               reason="Illegal multibyte sequence";
+                               if (!conv_silent)
+                                       DEBUG(3,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
+                               if (allow_bad_conv)
+                                       goto use_as_is;
+                               break;
+                       default:
+                               if (!conv_silent)
+                                       DEBUG(0,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
+                               break;
                }
                /* smb_panic(reason); */
        }
        return destlen-o_len;
+
+ use_as_is:
+
+       /* 
+        * Conversion not supported. This is actually an error, but there are so
+        * many misconfigured iconv systems and smb.conf's out there we can't just
+        * fail. Do a very bad conversion instead.... JRA.
+        */
+
+       {
+               if (o_len == 0 || i_len == 0)
+                       return destlen - o_len;
+
+               if (((from == CH_UTF16LE)||(from == CH_UTF16BE)) &&
+                               ((to != CH_UTF16LE)||(to != CH_UTF16BE))) {
+                       /* Can't convert from utf16 any endian to multibyte.
+                          Replace with the default fail char.
+                       */
+                       if (i_len < 2)
+                               return destlen - o_len;
+                       if (i_len >= 2) {
+                               *outbuf = lp_failed_convert_char();
+
+                               outbuf++;
+                               o_len--;
+
+                               inbuf += 2;
+                               i_len -= 2;
+                       }
+
+                       if (o_len == 0 || i_len == 0)
+                               return destlen - o_len;
+
+                       /* Keep trying with the next char... */
+                       goto again;
+
+               } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
+                       /* Can't convert to UTF16LE - just widen by adding the
+                          default fail char then zero.
+                       */
+                       if (o_len < 2)
+                               return destlen - o_len;
+
+                       outbuf[0] = lp_failed_convert_char();
+                       outbuf[1] = '\0';
+
+                       inbuf++;
+                       i_len--;
+
+                       outbuf += 2;
+                       o_len -= 2;
+
+                       if (o_len == 0 || i_len == 0)
+                               return destlen - o_len;
+
+                       /* Keep trying with the next char... */
+                       goto again;
+
+               } else if (from != CH_UTF16LE && from != CH_UTF16BE &&
+                               to != CH_UTF16LE && to != CH_UTF16BE) {
+                       /* Failed multibyte to multibyte. Just copy the default fail char and
+                               try again. */
+                       outbuf[0] = lp_failed_convert_char();
+
+                       inbuf++;
+                       i_len--;
+
+                       outbuf++;
+                       o_len--;
+
+                       if (o_len == 0 || i_len == 0)
+                               return destlen - o_len;
+
+                       /* Keep trying with the next char... */
+                       goto again;
+
+               } else {
+                       /* Keep compiler happy.... */
+                       return destlen - o_len;
+               }
+       }
+}
+
+/**
+ * Convert string from one encoding to another, making error checking etc
+ * Fast path version - handles ASCII first.
+ *
+ * @param src pointer to source string (multibyte or singlebyte)
+ * @param srclen length of the source string in bytes, or -1 for nul terminated.
+ * @param dest pointer to destination string (multibyte or singlebyte)
+ * @param destlen maximal length allowed for string - *NEVER* -1.
+ * @param allow_bad_conv determines if a "best effort" conversion is acceptable (never returns errors)
+ * @returns the number of bytes occupied in the destination
+ *
+ * Ensure the srclen contains the terminating zero.
+ *
+ * This function has been hand-tuned to provide a fast path.
+ * Don't change unless you really know what you are doing. JRA.
+ **/
+
+size_t convert_string(charset_t from, charset_t to,
+                     void const *src, size_t srclen, 
+                     void *dest, size_t destlen, BOOL allow_bad_conv)
+{
+       /*
+        * NB. We deliberately don't do a strlen here if srclen == -1.
+        * This is very expensive over millions of calls and is taken
+        * care of in the slow path in convert_string_internal. JRA.
+        */
+
+#ifdef DEVELOPER
+       SMB_ASSERT(destlen != (size_t)-1);
+#endif
+
+       if (srclen == 0)
+               return 0;
+
+       if (from != CH_UTF16LE && from != CH_UTF16BE && to != CH_UTF16LE && to != CH_UTF16BE) {
+               const unsigned char *p = (const unsigned char *)src;
+               unsigned char *q = (unsigned char *)dest;
+               size_t slen = srclen;
+               size_t dlen = destlen;
+               unsigned char lastp = '\0';
+               size_t retval = 0;
+
+               /* If all characters are ascii, fast path here. */
+               while (slen && dlen) {
+                       if ((lastp = *p) <= 0x7f) {
+                               *q++ = *p++;
+                               if (slen != (size_t)-1) {
+                                       slen--;
+                               }
+                               dlen--;
+                               retval++;
+                               if (!lastp)
+                                       break;
+                       } else {
+#ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
+                               goto general_case;
+#else
+                               return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
+#endif
+                       }
+               }
+               if (!dlen) {
+                       /* Even if we fast path we should note if we ran out of room. */
+                       if (((slen != (size_t)-1) && slen) ||
+                                       ((slen == (size_t)-1) && lastp)) {
+                               errno = E2BIG;
+                       }
+               }
+               return retval;
+       } else if (from == CH_UTF16LE && to != CH_UTF16LE) {
+               const unsigned char *p = (const unsigned char *)src;
+               unsigned char *q = (unsigned char *)dest;
+               size_t retval = 0;
+               size_t slen = srclen;
+               size_t dlen = destlen;
+               unsigned char lastp = '\0';
+
+               /* If all characters are ascii, fast path here. */
+               while (((slen == (size_t)-1) || (slen >= 2)) && dlen) {
+                       if (((lastp = *p) <= 0x7f) && (p[1] == 0)) {
+                               *q++ = *p;
+                               if (slen != (size_t)-1) {
+                                       slen -= 2;
+                               }
+                               p += 2;
+                               dlen--;
+                               retval++;
+                               if (!lastp)
+                                       break;
+                       } else {
+#ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
+                               goto general_case;
+#else
+                               return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
+#endif
+                       }
+               }
+               if (!dlen) {
+                       /* Even if we fast path we should note if we ran out of room. */
+                       if (((slen != (size_t)-1) && slen) ||
+                                       ((slen == (size_t)-1) && lastp)) {
+                               errno = E2BIG;
+                       }
+               }
+               return retval;
+       } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
+               const unsigned char *p = (const unsigned char *)src;
+               unsigned char *q = (unsigned char *)dest;
+               size_t retval = 0;
+               size_t slen = srclen;
+               size_t dlen = destlen;
+               unsigned char lastp = '\0';
+
+               /* If all characters are ascii, fast path here. */
+               while (slen && (dlen >= 2)) {
+                       if ((lastp = *p) <= 0x7F) {
+                               *q++ = *p++;
+                               *q++ = '\0';
+                               if (slen != (size_t)-1) {
+                                       slen--;
+                               }
+                               dlen -= 2;
+                               retval += 2;
+                               if (!lastp)
+                                       break;
+                       } else {
+#ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
+                               goto general_case;
+#else
+                               return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
+#endif
+                       }
+               }
+               if (!dlen) {
+                       /* Even if we fast path we should note if we ran out of room. */
+                       if (((slen != (size_t)-1) && slen) ||
+                                       ((slen == (size_t)-1) && lastp)) {
+                               errno = E2BIG;
+                       }
+               }
+               return retval;
+       }
+
+#ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
+  general_case:
+#endif
+       return convert_string_internal(from, to, src, srclen, dest, destlen, allow_bad_conv);
 }
 
 /**
  * Convert between character sets, allocating a new buffer for the result.
  *
+ * @param ctx TALLOC_CTX to use to allocate with. If NULL use malloc.
  * @param srclen length of source buffer.
  * @param dest always set at least to NULL
  * @note -1 is not accepted for srclen.
  *
  * @returns Size in bytes of the converted string; or -1 in case of error.
+ *
+ * Ensure the srclen contains the terminating zero.
+ * 
+ * I hate the goto's in this function. It's embarressing.....
+ * There has to be a cleaner way to do this. JRA.
  **/
 
-size_t convert_string_allocate(charset_t from, charset_t to,
-                              void const *src, size_t srclen, void **dest)
+size_t convert_string_allocate(TALLOC_CTX *ctx, charset_t from, charset_t to,
+                              void const *src, size_t srclen, void *dst, BOOL allow_bad_conv)
 {
-       size_t i_len, o_len, destlen;
+       size_t i_len, o_len, destlen = MAX(srclen, 512);
        size_t retval;
        const char *inbuf = (const char *)src;
-       char *outbuf, *ob;
+       char *outbuf = NULL, *ob = NULL;
        smb_iconv_t descriptor;
+       void **dest = (void **)dst;
 
        *dest = NULL;
 
        if (src == NULL || srclen == (size_t)-1)
                return (size_t)-1;
+       if (srclen == 0)
+               return 0;
 
        lazy_initialize_conv();
 
        descriptor = conv_handles[from][to];
 
        if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
-               /* conversion not supported, return -1*/
-               DEBUG(3, ("convert_string_allocate: conversion not supported!\n"));
-               return -1;
+               if (!conv_silent)
+                       DEBUG(0,("convert_string_allocate: Conversion not supported.\n"));
+               return (size_t)-1;
+       }
+
+  convert:
+
+       if ((destlen*2) < destlen) {
+               /* wrapped ! abort. */
+               if (!conv_silent)
+                       DEBUG(0, ("convert_string_allocate: destlen wrapped !\n"));
+               if (!ctx)
+                       SAFE_FREE(outbuf);
+               return (size_t)-1;
+       } else {
+               destlen = destlen * 2;
+       }
+
+       if (ctx) {
+               ob = (char *)TALLOC_REALLOC(ctx, ob, destlen);
+       } else {
+               ob = (char *)SMB_REALLOC(ob, destlen);
        }
 
-       destlen = MAX(srclen, 512);
-       outbuf = NULL;
-convert:
-       destlen = destlen * 2;
-       ob = (char *)Realloc(outbuf, destlen);
        if (!ob) {
                DEBUG(0, ("convert_string_allocate: realloc failed!\n"));
-               SAFE_FREE(outbuf);
                return (size_t)-1;
-       } else {
-               outbuf = ob;
        }
+       outbuf = ob;
        i_len = srclen;
        o_len = destlen;
+
+ again:
+
        retval = smb_iconv(descriptor,
                           &inbuf, &i_len,
                           &outbuf, &o_len);
@@ -238,29 +585,127 @@ convert:
                switch(errno) {
                        case EINVAL:
                                reason="Incomplete multibyte sequence";
+                               if (!conv_silent)
+                                       DEBUG(3,("convert_string_allocate: Conversion error: %s(%s)\n",reason,inbuf));
+                               if (allow_bad_conv)
+                                       goto use_as_is;
                                break;
                        case E2BIG:
                                goto convert;           
                        case EILSEQ:
                                reason="Illegal multibyte sequence";
+                               if (!conv_silent)
+                                       DEBUG(3,("convert_string_allocate: Conversion error: %s(%s)\n",reason,inbuf));
+                               if (allow_bad_conv)
+                                       goto use_as_is;
                                break;
                }
-               DEBUG(0,("Conversion error: %s(%s)\n",reason,inbuf));
+               if (!conv_silent)
+                       DEBUG(0,("Conversion error: %s(%s)\n",reason,inbuf));
                /* smb_panic(reason); */
                return (size_t)-1;
        }
-       
+
+  out:
+
        destlen = destlen - o_len;
-       *dest = (char *)Realloc(ob,destlen);
-       if (destlen && !*dest) {
+       if (ctx) {
+               ob = (char *)TALLOC_REALLOC(ctx,ob,destlen);
+       } else {
+               ob = (char *)SMB_REALLOC(ob,destlen);
+       }
+
+       if (destlen && !ob) {
                DEBUG(0, ("convert_string_allocate: out of memory!\n"));
-               SAFE_FREE(ob);
                return (size_t)-1;
        }
 
+       *dest = ob;
        return destlen;
-}
 
+ use_as_is:
+
+       /* 
+        * Conversion not supported. This is actually an error, but there are so
+        * many misconfigured iconv systems and smb.conf's out there we can't just
+        * fail. Do a very bad conversion instead.... JRA.
+        */
+
+       {
+               if (o_len == 0 || i_len == 0)
+                       goto out;
+
+               if (((from == CH_UTF16LE)||(from == CH_UTF16BE)) &&
+                               ((to != CH_UTF16LE)||(to != CH_UTF16BE))) {
+                       /* Can't convert from utf16 any endian to multibyte.
+                          Replace with the default fail char.
+                       */
+
+                       if (i_len < 2)
+                               goto out;
+
+                       if (i_len >= 2) {
+                               *outbuf = lp_failed_convert_char();
+
+                               outbuf++;
+                               o_len--;
+
+                               inbuf += 2;
+                               i_len -= 2;
+                       }
+
+                       if (o_len == 0 || i_len == 0)
+                               goto out;
+
+                       /* Keep trying with the next char... */
+                       goto again;
+
+               } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
+                       /* Can't convert to UTF16LE - just widen by adding the
+                          default fail char then zero.
+                       */
+                       if (o_len < 2)
+                               goto out;
+
+                       outbuf[0] = lp_failed_convert_char();
+                       outbuf[1] = '\0';
+
+                       inbuf++;
+                       i_len--;
+
+                       outbuf += 2;
+                       o_len -= 2;
+
+                       if (o_len == 0 || i_len == 0)
+                               goto out;
+
+                       /* Keep trying with the next char... */
+                       goto again;
+
+               } else if (from != CH_UTF16LE && from != CH_UTF16BE &&
+                               to != CH_UTF16LE && to != CH_UTF16BE) {
+                       /* Failed multibyte to multibyte. Just copy the default fail char and
+                          try again. */
+                       outbuf[0] = lp_failed_convert_char();
+
+                       inbuf++;
+                       i_len--;
+
+                       outbuf++;
+                       o_len--;
+
+                       if (o_len == 0 || i_len == 0)
+                               goto out;
+
+                       /* Keep trying with the next char... */
+                       goto again;
+
+               } else {
+                       /* Keep compiler happy.... */
+                       goto out;
+               }
+       }
+}
 
 /**
  * Convert between character sets, allocating a new buffer using talloc for the result.
@@ -271,20 +716,17 @@ convert:
  *
  * @returns Size in bytes of the converted string; or -1 in case of error.
  **/
-static size_t convert_string_talloc(TALLOC_CTX *ctx, charset_t from, charset_t to,
-                               void const *src, size_t srclen, void **dest)
+size_t convert_string_talloc(TALLOC_CTX *ctx, charset_t from, charset_t to,
+                            void const *src, size_t srclen, void *dst,
+                            BOOL allow_bad_conv)
 {
-       void *alloced_string;
+       void **dest = (void **)dst;
        size_t dest_len;
 
-       /* FIXME: Ridiculous to allocate two buffers and then copy the string! */
-       
        *dest = NULL;
-       dest_len=convert_string_allocate(from, to, src, srclen, &alloced_string);
+       dest_len=convert_string_allocate(ctx, from, to, src, srclen, dest, allow_bad_conv);
        if (dest_len == (size_t)-1)
                return (size_t)-1;
-       *dest = talloc_memdup(ctx, alloced_string, dest_len);
-       SAFE_FREE(alloced_string);
        if (*dest == NULL)
                return (size_t)-1;
        return dest_len;
@@ -295,9 +737,8 @@ size_t unix_strupper(const char *src, size_t srclen, char *dest, size_t destlen)
        size_t size;
        smb_ucs2_t *buffer;
        
-       size = convert_string_allocate(CH_UNIX, CH_UCS2, src, srclen,
-                                      (void **) &buffer);
-       if (size == -1) {
+       size = push_ucs2_allocate(&buffer, src);
+       if (size == (size_t)-1) {
                smb_panic("failed to create UCS2 buffer");
        }
        if (!strupper_w(buffer) && (dest == src)) {
@@ -305,30 +746,103 @@ size_t unix_strupper(const char *src, size_t srclen, char *dest, size_t destlen)
                return srclen;
        }
        
-       size = convert_string(CH_UCS2, CH_UNIX, buffer, size, dest, destlen);
+       size = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, True);
        free(buffer);
        return size;
 }
 
+/**
+ strdup() a unix string to upper case.
+ Max size is pstring.
+**/
+
+char *strdup_upper(const char *s)
+{
+       pstring out_buffer;
+       const unsigned char *p = (const unsigned char *)s;
+       unsigned char *q = (unsigned char *)out_buffer;
+
+       /* this is quite a common operation, so we want it to be
+          fast. We optimise for the ascii case, knowing that all our
+          supported multi-byte character sets are ascii-compatible
+          (ie. they match for the first 128 chars) */
+
+       while (1) {
+               if (*p & 0x80)
+                       break;
+               *q++ = toupper_ascii(*p);
+               if (!*p)
+                       break;
+               p++;
+               if (p - ( const unsigned char *)s >= sizeof(pstring))
+                       break;
+       }
+
+       if (*p) {
+               /* MB case. */
+               size_t size;
+               wpstring buffer;
+               size = convert_string(CH_UNIX, CH_UTF16LE, s, -1, buffer, sizeof(buffer), True);
+               if (size == (size_t)-1) {
+                       return NULL;
+               }
+
+               strupper_w(buffer);
+       
+               size = convert_string(CH_UTF16LE, CH_UNIX, buffer, -1, out_buffer, sizeof(out_buffer), True);
+               if (size == (size_t)-1) {
+                       return NULL;
+               }
+       }
+
+       return SMB_STRDUP(out_buffer);
+}
+
 size_t unix_strlower(const char *src, size_t srclen, char *dest, size_t destlen)
 {
        size_t size;
-       smb_ucs2_t *buffer;
+       smb_ucs2_t *buffer = NULL;
        
-       size = convert_string_allocate(CH_UNIX, CH_UCS2, src, srclen,
-                                      (void **) &buffer);
-       if (size == -1) {
+       size = convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE, src, srclen,
+                                      (void **)(void *)&buffer, True);
+       if (size == (size_t)-1 || !buffer) {
                smb_panic("failed to create UCS2 buffer");
        }
        if (!strlower_w(buffer) && (dest == src)) {
-               free(buffer);
+               SAFE_FREE(buffer);
                return srclen;
        }
-       size = convert_string(CH_UCS2, CH_UNIX, buffer, size, dest, destlen);
-       free(buffer);
+       size = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, True);
+       SAFE_FREE(buffer);
        return size;
 }
 
+/**
+ strdup() a unix string to lower case.
+**/
+
+char *strdup_lower(const char *s)
+{
+       size_t size;
+       smb_ucs2_t *buffer = NULL;
+       char *out_buffer;
+       
+       size = push_ucs2_allocate(&buffer, s);
+       if (size == -1 || !buffer) {
+               return NULL;
+       }
+
+       strlower_w(buffer);
+       
+       size = pull_ucs2_allocate(&out_buffer, buffer);
+       SAFE_FREE(buffer);
+
+       if (size == (size_t)-1) {
+               return NULL;
+       }
+       
+       return out_buffer;
+}
 
 static size_t ucs2_align(const void *base_ptr, const void *p, int flags)
 {
@@ -363,14 +877,14 @@ size_t push_ascii(void *dest, const char *src, size_t dest_len, int flags)
 
        if (flags & STR_UPPER) {
                pstrcpy(tmpbuf, src);
-               strupper(tmpbuf);
+               strupper_m(tmpbuf);
                src = tmpbuf;
        }
 
-       if (flags & STR_TERMINATE)
+       if (flags & (STR_TERMINATE | STR_TERMINATE_ASCII))
                src_len++;
 
-       return convert_string(CH_UNIX, CH_DOS, src, src_len, dest, dest_len);
+       return convert_string(CH_UNIX, CH_DOS, src, src_len, dest, dest_len, True);
 }
 
 size_t push_ascii_fstring(void *dest, const char *src)
@@ -383,6 +897,45 @@ size_t push_ascii_pstring(void *dest, const char *src)
        return push_ascii(dest, src, sizeof(pstring), STR_TERMINATE);
 }
 
+/********************************************************************
+ Push an nstring - ensure null terminated. Written by
+ moriyama@miraclelinux.com (MORIYAMA Masayuki).
+********************************************************************/
+
+size_t push_ascii_nstring(void *dest, const char *src)
+{
+       size_t i, buffer_len, dest_len;
+       smb_ucs2_t *buffer;
+
+       conv_silent = True;
+       buffer_len = push_ucs2_allocate(&buffer, src);
+       if (buffer_len == (size_t)-1) {
+               smb_panic("failed to create UCS2 buffer");
+       }
+
+       /* We're using buffer_len below to count ucs2 characters, not bytes. */
+       buffer_len /= sizeof(smb_ucs2_t);
+
+       dest_len = 0;
+       for (i = 0; buffer[i] != 0 && (i < buffer_len); i++) {
+               unsigned char mb[10];
+               /* Convert one smb_ucs2_t character at a time. */
+               size_t mb_len = convert_string(CH_UTF16LE, CH_DOS, buffer+i, sizeof(smb_ucs2_t), mb, sizeof(mb), False);
+               if ((mb_len != (size_t)-1) && (dest_len + mb_len <= MAX_NETBIOSNAME_LEN - 1)) {
+                       memcpy((char *)dest + dest_len, mb, mb_len);
+                       dest_len += mb_len;
+               } else {
+                       errno = E2BIG;
+                       break;
+               }
+       }
+       ((char *)dest)[dest_len] = '\0';
+
+       SAFE_FREE(buffer);
+       conv_silent = False;
+       return dest_len;
+}
+
 /**
  * Copy a string from a dos codepage source to a unix char* destination.
  *
@@ -407,21 +960,29 @@ size_t pull_ascii(char *dest, const void *src, size_t dest_len, size_t src_len,
 
        if (flags & STR_TERMINATE) {
                if (src_len == (size_t)-1) {
-                       src_len = strlen(src) + 1;
+                       src_len = strlen((const char *)src) + 1;
                } else {
-                       size_t len = strnlen(src, src_len);
+                       size_t len = strnlen((const char *)src, src_len);
                        if (len < src_len)
                                len++;
                        src_len = len;
                }
        }
 
-       ret = convert_string(CH_DOS, CH_UNIX, src, src_len, dest, dest_len);
+       ret = convert_string(CH_DOS, CH_UNIX, src, src_len, dest, dest_len, True);
+       if (ret == (size_t)-1) {
+               ret = 0;
+               dest_len = 0;
+       }
 
-       if (dest_len)
-               dest[MIN(ret, dest_len-1)] = 0;
-       else 
+       if (dest_len && ret) {
+               /* Did we already process the terminating zero ? */
+               if (dest[MIN(ret-1, dest_len-1)] != 0) {
+                       dest[MIN(ret, dest_len-1)] = 0;
+               }
+       } else  {
                dest[0] = 0;
+       }
 
        return src_len;
 }
@@ -436,6 +997,13 @@ size_t pull_ascii_fstring(char *dest, const void *src)
        return pull_ascii(dest, src, sizeof(fstring), -1, STR_TERMINATE);
 }
 
+/* When pulling an nstring it can expand into a larger size (dos cp -> utf8). Cope with this. */
+
+size_t pull_ascii_nstring(char *dest, size_t dest_len, const void *src)
+{
+       return pull_ascii(dest, src, dest_len, sizeof(nstring)-1, STR_TERMINATE);
+}
+
 /**
  * Copy a string from a char* src to a unicode destination.
  *
@@ -452,36 +1020,55 @@ size_t pull_ascii_fstring(char *dest, const void *src)
  * @param dest_len is the maximum length allowed in the
  * destination. If dest_len is -1 then no maxiumum is used.
  **/
+
 size_t push_ucs2(const void *base_ptr, void *dest, const char *src, size_t dest_len, int flags)
 {
        size_t len=0;
-       size_t src_len = strlen(src);
-       pstring tmpbuf;
+       size_t src_len;
+       size_t ret;
 
        /* treat a pstring as "unlimited" length */
        if (dest_len == (size_t)-1)
                dest_len = sizeof(pstring);
 
-       if (flags & STR_UPPER) {
-               pstrcpy(tmpbuf, src);
-               strupper(tmpbuf);
-               src = tmpbuf;
-       }
-
        if (flags & STR_TERMINATE)
-               src_len++;
+               src_len = (size_t)-1;
+       else
+               src_len = strlen(src);
 
        if (ucs2_align(base_ptr, dest, flags)) {
                *(char *)dest = 0;
                dest = (void *)((char *)dest + 1);
-               if (dest_len) dest_len--;
+               if (dest_len)
+                       dest_len--;
                len++;
        }
 
        /* ucs2 is always a multiple of 2 bytes */
        dest_len &= ~1;
 
-       len += convert_string(CH_UNIX, CH_UCS2, src, src_len, dest, dest_len);
+       ret =  convert_string(CH_UNIX, CH_UTF16LE, src, src_len, dest, dest_len, True);
+       if (ret == (size_t)-1) {
+               return 0;
+       }
+
+       len += ret;
+
+       if (flags & STR_UPPER) {
+               smb_ucs2_t *dest_ucs2 = (smb_ucs2_t *)dest;
+               size_t i;
+
+               /* We check for i < (ret / 2) below as the dest string isn't null
+                  terminated if STR_TERMINATE isn't set. */
+
+               for (i = 0; i < (ret / 2) && i < (dest_len / 2) && dest_ucs2[i]; i++) {
+                       smb_ucs2_t v = toupper_w(dest_ucs2[i]);
+                       if (v != dest_ucs2[i]) {
+                               dest_ucs2[i] = v;
+                       }
+               }
+       }
+
        return len;
 }
 
@@ -500,7 +1087,7 @@ size_t push_ucs2_talloc(TALLOC_CTX *ctx, smb_ucs2_t **dest, const char *src)
        size_t src_len = strlen(src)+1;
 
        *dest = NULL;
-       return convert_string_talloc(ctx, CH_UNIX, CH_UCS2, src, src_len, (void **)dest);
+       return convert_string_talloc(ctx, CH_UNIX, CH_UTF16LE, src, src_len, (void **)dest, True);
 }
 
 
@@ -518,7 +1105,7 @@ size_t push_ucs2_allocate(smb_ucs2_t **dest, const char *src)
        size_t src_len = strlen(src)+1;
 
        *dest = NULL;
-       return convert_string_allocate(CH_UNIX, CH_UCS2, src, src_len, (void **)dest);  
+       return convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE, src, src_len, (void **)dest, True);
 }
 
 /**
@@ -542,14 +1129,14 @@ static size_t push_utf8(void *dest, const char *src, size_t dest_len, int flags)
 
        if (flags & STR_UPPER) {
                pstrcpy(tmpbuf, src);
-               strupper(tmpbuf);
+               strupper_m(tmpbuf);
                src = tmpbuf;
        }
 
        if (flags & STR_TERMINATE)
                src_len++;
 
-       return convert_string(CH_UNIX, CH_UTF8, src, src_len, dest, dest_len);
+       return convert_string(CH_UNIX, CH_UTF8, src, src_len, dest, dest_len, True);
 }
 
 size_t push_utf8_fstring(void *dest, const char *src)
@@ -570,7 +1157,7 @@ size_t push_utf8_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
        size_t src_len = strlen(src)+1;
 
        *dest = NULL;
-       return convert_string_talloc(ctx, CH_UNIX, CH_UTF8, src, src_len, (void**)dest);
+       return convert_string_talloc(ctx, CH_UNIX, CH_UTF8, src, src_len, (void**)dest, True);
 }
 
 /**
@@ -586,7 +1173,7 @@ size_t push_utf8_allocate(char **dest, const char *src)
        size_t src_len = strlen(src)+1;
 
        *dest = NULL;
-       return convert_string_allocate(CH_UNIX, CH_UTF8, src, src_len, (void **)dest);  
+       return convert_string_allocate(NULL, CH_UNIX, CH_UTF8, src, src_len, (void **)dest, True);      
 }
 
 /**
@@ -609,15 +1196,15 @@ size_t pull_ucs2(const void *base_ptr, char *dest, const void *src, size_t dest_
 
        if (ucs2_align(base_ptr, src, flags)) {
                src = (const void *)((const char *)src + 1);
-               if (src_len > 0)
+               if (src_len != (size_t)-1)
                        src_len--;
        }
 
        if (flags & STR_TERMINATE) {
-               if (src_len == (size_t)-1) {
-                       src_len = strlen_w(src)*2 + 2;
-               } else {
-                       size_t len = strnlen_w(src, src_len/2);
+               /* src_len -1 is the default for null terminated strings. */
+               if (src_len != (size_t)-1) {
+                       size_t len = strnlen_w((const smb_ucs2_t *)src,
+                                               src_len/2);
                        if (len < src_len/2)
                                len++;
                        src_len = len*2;
@@ -628,11 +1215,22 @@ size_t pull_ucs2(const void *base_ptr, char *dest, const void *src, size_t dest_
        if (src_len != (size_t)-1)
                src_len &= ~1;
        
-       ret = convert_string(CH_UCS2, CH_UNIX, src, src_len, dest, dest_len);
-       if (dest_len)
-               dest[MIN(ret, dest_len-1)] = 0;
-       else 
+       ret = convert_string(CH_UTF16LE, CH_UNIX, src, src_len, dest, dest_len, True);
+       if (ret == (size_t)-1) {
+               return 0;
+       }
+
+       if (src_len == (size_t)-1)
+               src_len = ret*2;
+               
+       if (dest_len && ret) {
+               /* Did we already process the terminating zero ? */
+               if (dest[MIN(ret-1, dest_len-1)] != 0) {
+                       dest[MIN(ret, dest_len-1)] = 0;
+               }
+       } else {
                dest[0] = 0;
+       }
 
        return src_len;
 }
@@ -659,7 +1257,7 @@ size_t pull_ucs2_talloc(TALLOC_CTX *ctx, char **dest, const smb_ucs2_t *src)
 {
        size_t src_len = (strlen_w(src)+1) * sizeof(smb_ucs2_t);
        *dest = NULL;
-       return convert_string_talloc(ctx, CH_UCS2, CH_UNIX, src, src_len, (void **)dest);
+       return convert_string_talloc(ctx, CH_UTF16LE, CH_UNIX, src, src_len, (void **)dest, True);
 }
 
 /**
@@ -674,7 +1272,7 @@ size_t pull_ucs2_allocate(char **dest, const smb_ucs2_t *src)
 {
        size_t src_len = (strlen_w(src)+1) * sizeof(smb_ucs2_t);
        *dest = NULL;
-       return convert_string_allocate(CH_UCS2, CH_UNIX, src, src_len, (void **)dest);  
+       return convert_string_allocate(NULL, CH_UTF16LE, CH_UNIX, src, src_len, (void **)dest, True);
 }
 
 /**
@@ -689,7 +1287,7 @@ size_t pull_utf8_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
 {
        size_t src_len = strlen(src)+1;
        *dest = NULL;
-       return convert_string_talloc(ctx, CH_UTF8, CH_UNIX, src, src_len, (void **)dest);       
+       return convert_string_talloc(ctx, CH_UTF8, CH_UNIX, src, src_len, (void **)dest, True);
 }
 
 /**
@@ -700,13 +1298,28 @@ size_t pull_utf8_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
  * @returns The number of bytes occupied by the string in the destination
  **/
 
-size_t pull_utf8_allocate(void **dest, const char *src)
+size_t pull_utf8_allocate(char **dest, const char *src)
 {
        size_t src_len = strlen(src)+1;
        *dest = NULL;
-       return convert_string_allocate(CH_UTF8, CH_UNIX, src, src_len, dest);   
+       return convert_string_allocate(NULL, CH_UTF8, CH_UNIX, src, src_len, (void **)dest, True);
 }
  
+/**
+ * Copy a string from a DOS src to a unix char * destination, allocating a buffer using talloc
+ *
+ * @param dest always set at least to NULL 
+ *
+ * @returns The number of bytes occupied by the string in the destination
+ **/
+
+size_t pull_ascii_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
+{
+       size_t src_len = strlen(src)+1;
+       *dest = NULL;
+       return convert_string_talloc(ctx, CH_DOS, CH_UNIX, src, src_len, (void **)dest, True);
+}
+
 /**
  Copy a string from a char* src to a unicode or ascii
  dos codepage destination choosing unicode or ascii based on the 
@@ -723,8 +1336,21 @@ size_t pull_utf8_allocate(void **dest, const char *src)
 
 size_t push_string_fn(const char *function, unsigned int line, const void *base_ptr, void *dest, const char *src, size_t dest_len, int flags)
 {
+#ifdef DEVELOPER
+       /* We really need to zero fill here, not clobber
+        * region, as we want to ensure that valgrind thinks
+        * all of the outgoing buffer has been written to
+        * so a send() or write() won't trap an error.
+        * JRA.
+        */
+#if 0
        if (dest_len != (size_t)-1)
                clobber_region(function, line, dest, dest_len);
+#else
+       if (dest_len != (size_t)-1)
+               memset(dest, '\0', dest_len);
+#endif
+#endif
 
        if (!(flags & STR_ASCII) && \
            ((flags & STR_UNICODE || \
@@ -749,14 +1375,24 @@ size_t push_string_fn(const char *function, unsigned int line, const void *base_
  The resulting string in "dest" is always null terminated.
 **/
 
-size_t pull_string_fn(const char *function, unsigned int line, const void *base_ptr, char *dest, const void *src, size_t dest_len, size_t src_len, int flags)
+size_t pull_string_fn(const char *function, unsigned int line,
+                     const void *base_ptr, uint16 smb_flags2, char *dest,
+                     const void *src, size_t dest_len, size_t src_len,
+                     int flags)
 {
+#ifdef DEVELOPER
        if (dest_len != (size_t)-1)
                clobber_region(function, line, dest, dest_len);
+#endif
+
+       if ((base_ptr == NULL) && ((flags & (STR_ASCII|STR_UNICODE)) == 0)) {
+               smb_panic("No base ptr to get flg2 and neither ASCII nor "
+                         "UNICODE defined");
+       }
 
        if (!(flags & STR_ASCII) && \
            ((flags & STR_UNICODE || \
-             (SVAL(base_ptr, smb_flg2) & FLAGS2_UNICODE_STRINGS)))) {
+             (smb_flags2 & FLAGS2_UNICODE_STRINGS)))) {
                return pull_ucs2(base_ptr, dest, src, dest_len, src_len, flags);
        }
        return pull_ascii(dest, src, dest_len, src_len, flags);
@@ -772,44 +1408,85 @@ size_t align_string(const void *base_ptr, const char *p, int flags)
        return 0;
 }
 
-/**
- Convert from unix to ucs2 charset and return the
- allocated and converted string or NULL if an error occurred.
- You must provide a zero terminated string.
- The returning string will be zero terminated.
-**/
+/*
+  Return the unicode codepoint for the next multi-byte CH_UNIX character
+  in the string. The unicode codepoint (codepoint_t) is an unsinged 32 bit value.
 
-smb_ucs2_t *acnv_uxu2(const char *src)
-{
-       size_t slen;
-       size_t dlen;
-       void *dest;
-       
-       slen = strlen(src) + 1;
-       dlen = convert_string_allocate(CH_UNIX, CH_UCS2, src, slen, &dest);
-       if (dlen == (size_t)-1)
-               return NULL;
-       else
-               return dest;
-}
+  Also return the number of bytes consumed (which tells the caller
+  how many bytes to skip to get to the next CH_UNIX character).
 
-/**
- Convert from dos to ucs2 charset and return the
- allocated and converted string or NULL if an error occurred.
- You must provide a zero terminated string.
- The returning string will be zero terminated.
-**/
+  Return INVALID_CODEPOINT if the next character cannot be converted.
+*/
 
-smb_ucs2_t *acnv_dosu2(const char *src)
+codepoint_t next_codepoint(const char *str, size_t *size)
 {
-       size_t slen;
-       size_t dlen;
-       void *dest;
-       
-       slen = strlen(src) + 1;
-       dlen = convert_string_allocate(CH_DOS, CH_UCS2, src, slen, &dest);
-       if (dlen == (size_t)-1)
-               return NULL;
-       else
-               return dest;
+       /* It cannot occupy more than 4 bytes in UTF16 format */
+       uint8_t buf[4];
+       smb_iconv_t descriptor;
+       size_t ilen_orig;
+       size_t ilen;
+       size_t olen;
+       char *outbuf;
+
+       if ((str[0] & 0x80) == 0) {
+               *size = 1;
+               return (codepoint_t)str[0];
+       }
+
+       /* We assume that no multi-byte character can take
+          more than 5 bytes. This is OK as we only
+          support codepoints up to 1M */
+
+       ilen_orig = strnlen(str, 5);
+       ilen = ilen_orig;
+
+        lazy_initialize_conv();
+
+        descriptor = conv_handles[CH_UNIX][CH_UTF16LE];
+       if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
+               *size = 1;
+               return INVALID_CODEPOINT;
+       }
+
+       /* This looks a little strange, but it is needed to cope
+          with codepoints above 64k which are encoded as per RFC2781. */
+       olen = 2;
+       outbuf = (char *)buf;
+       smb_iconv(descriptor, &str, &ilen, &outbuf, &olen);
+       if (olen == 2) {
+               /* We failed to convert to a 2 byte character.
+                  See if we can convert to a 4 UTF16-LE byte char encoding.
+               */
+               olen = 4;
+               outbuf = (char *)buf;
+               smb_iconv(descriptor,  &str, &ilen, &outbuf, &olen);
+               if (olen == 4) {
+                       /* We didn't convert any bytes */
+                       *size = 1;
+                       return INVALID_CODEPOINT;
+               }
+               olen = 4 - olen;
+       } else {
+               olen = 2 - olen;
+       }
+
+       *size = ilen_orig - ilen;
+
+       if (olen == 2) {
+               /* 2 byte, UTF16-LE encoded value. */
+               return (codepoint_t)SVAL(buf, 0);
+       }
+       if (olen == 4) {
+               /* Decode a 4 byte UTF16-LE character manually.
+                  See RFC2871 for the encoding machanism.
+               */
+               codepoint_t w1 = SVAL(buf,0) & ~0xD800;
+               codepoint_t w2 = SVAL(buf,2) & ~0xDC00;
+
+               return (codepoint_t)0x10000 +
+                               (w1 << 10) + w2;
+       }
+
+       /* no other length is valid */
+       return INVALID_CODEPOINT;
 }