]> git.sesse.net Git - vlc/blobdiff - src/text/unicode.c
Refactor EnsureUTF8 and IsUTF8
[vlc] / src / text / unicode.c
index 77b7684d4a6f58ae793a9cea1b4822fc331df172..bed5f1f96d7cbd91693690e78297357c1bea7a62 100644 (file)
@@ -2,7 +2,7 @@
  * unicode.c: Unicode <-> locale functions
  *****************************************************************************
  * Copyright (C) 2005-2006 the VideoLAN team
- * Copyright © 2005-2008 Rémi Denis-Courmont
+ * Copyright © 2005-2010 Rémi Denis-Courmont
  *
  * Authors: Rémi Denis-Courmont <rem # videolan.org>
  *
 #endif
 #include <errno.h>
 
-#if defined (__APPLE__) || defined (HAVE_MAEMO)
-/* Define this if the OS always use UTF-8 internally */
-# define ASSUME_UTF8 1
-#endif
-
 #if defined (ASSUME_UTF8)
 /* Cool */
+
 #elif defined (WIN32) || defined (UNDER_CE)
 # define USE_MB2MB 1
-#elif defined (HAVE_ICONV)
-# define USE_ICONV 1
-#else
-# error No UTF8 charset conversion implemented on this platform!
-#endif
+# include <io.h>
 
-#if defined (USE_ICONV)
-# include <langinfo.h>
-static char charset[sizeof ("CSISO11SWEDISHFORNAMES")] = "";
-
-static void find_charset_once (void)
+static char *locale_dup (const char *string, bool from)
 {
-    strlcpy (charset, nl_langinfo (CODESET), sizeof (charset));
-    if (!strcasecmp (charset, "ASCII")
-     || !strcasecmp (charset, "ANSI_X3.4-1968"))
-        strcpy (charset, "UTF-8"); /* superset... */
-}
+    char *out;
+    int len;
 
-static int find_charset (void)
-{
-    static pthread_once_t once = PTHREAD_ONCE_INIT;
-    pthread_once (&once, find_charset_once);
-    return !strcasecmp (charset, "UTF-8");
+    len = 1 + MultiByteToWideChar (from ? CP_ACP : CP_UTF8,
+                                   0, string, -1, NULL, 0);
+    wchar_t *wide = malloc (len * sizeof (wchar_t));
+    if (wide == NULL)
+        return NULL;
+
+    MultiByteToWideChar (from ? CP_ACP : CP_UTF8, 0, string, -1, wide, len);
+    len = 1 + WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1,
+                                   NULL, 0, NULL, NULL);
+    out = malloc (len);
+    if (out != NULL)
+        WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1, out, len,
+                             NULL, NULL);
+    free (wide);
+    return out;
 }
-#endif
 
+#elif defined (HAVE_ICONV)
+# define USE_ICONV 1
 
-static char *locale_fast (const char *string, bool from)
+static char *locale_dup (const char *string, bool from)
 {
-    if( string == NULL )
-        return NULL;
-
-#if defined (USE_ICONV)
-    if (find_charset ())
-        return (char *)string;
-
-    vlc_iconv_t hd = vlc_iconv_open (from ? "UTF-8" : charset,
-                                     from ? charset : "UTF-8");
+    vlc_iconv_t hd = vlc_iconv_open (from ? "UTF-8" : "",
+                                     from ? "" : "UTF-8");
     if (hd == (vlc_iconv_t)(-1))
         return NULL; /* Uho! */
 
@@ -113,47 +102,12 @@ static char *locale_fast (const char *string, bool from)
     assert (*optr == '\0');
     assert (strlen (output) == (size_t)(optr - output));
     return strdup (output);
-#elif defined (USE_MB2MB)
-    char *out;
-    int len;
-
-    len = 1 + MultiByteToWideChar (from ? CP_ACP : CP_UTF8,
-                                   0, string, -1, NULL, 0);
-    wchar_t *wide = malloc (len * sizeof (wchar_t));
-    if (wide == NULL)
-        return NULL;
-
-    MultiByteToWideChar (from ? CP_ACP : CP_UTF8, 0, string, -1, wide, len);
-    len = 1 + WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1,
-                                   NULL, 0, NULL, NULL);
-    out = malloc (len);
-    if (out != NULL)
-        WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1, out, len,
-                             NULL, NULL);
-    free (wide);
-    return out;
-#else
-    (void)from;
-    return (char *)string;
-#endif
 }
 
-
-static inline char *locale_dup (const char *string, bool from)
-{
-    assert( string );
-
-#if defined (USE_ICONV)
-    if (find_charset ())
-        return strdup (string);
-    return locale_fast (string, from);
-#elif defined (USE_MB2MB)
-    return locale_fast (string, from);
 #else
-    (void)from;
-    return strdup (string);
+# error No UTF8 charset conversion implemented on this platform!
 #endif
-}
+
 
 /**
  * Releases (if needed) a localized or uniformized string.
@@ -161,13 +115,10 @@ static inline char *locale_dup (const char *string, bool from)
  */
 void LocaleFree (const char *str)
 {
-#if defined (USE_ICONV)
-    if (!find_charset ())
-        free ((char *)str);
-#elif defined (USE_MB2MB)
-    free ((char *)str);
+#ifdef ASSUME_UTF8
+    (void) str;
 #else
-    (void)str;
+    free ((char *)str);
 #endif
 }
 
@@ -183,7 +134,11 @@ void LocaleFree (const char *str)
  */
 char *FromLocale (const char *locale)
 {
-    return locale_fast (locale, true);
+#ifdef ASSUME_UTF8
+    return (char *)locale;
+#else
+    return locale ? locale_dup (locale, true) : NULL;
+#endif
 }
 
 /**
@@ -197,7 +152,11 @@ char *FromLocale (const char *locale)
  */
 char *FromLocaleDup (const char *locale)
 {
+#ifdef ASSUME_UTF8
+    return strdup (locale);
+#else
     return locale_dup (locale, true);
+#endif
 }
 
 
@@ -212,7 +171,11 @@ char *FromLocaleDup (const char *locale)
  */
 char *ToLocale (const char *utf8)
 {
-    return locale_fast (utf8, false);
+#ifdef ASSUME_UTF8
+    return (char *)utf8;
+#else
+    return utf8 ? locale_dup (utf8, false) : NULL;
+#endif
 }
 
 
@@ -227,23 +190,11 @@ char *ToLocale (const char *utf8)
  */
 char *ToLocaleDup (const char *utf8)
 {
+#ifdef ASSUME_UTF8
+    return strdup (utf8);
+#else
     return locale_dup (utf8, false);
-}
-
-/**
- * Formats an UTF-8 string as vasprintf(), then print it to stdout, with
- * appropriate conversion to local encoding.
- */
-static int utf8_vasprintf( char **str, const char *fmt, va_list ap )
-{
-    char *utf8;
-    int res = vasprintf( &utf8, fmt, ap );
-    if( res == -1 )
-        return -1;
-
-    *str = ToLocaleDup( utf8 );
-    free( utf8 );
-    return res;
+#endif
 }
 
 /**
@@ -252,14 +203,58 @@ static int utf8_vasprintf( char **str, const char *fmt, va_list ap )
  */
 int utf8_vfprintf( FILE *stream, const char *fmt, va_list ap )
 {
+#ifdef ASSUME_UTF8
+    return vfprintf (stream, fmt, ap);
+#else
     char *str;
-    int res = utf8_vasprintf( &str, fmt, ap );
-    if( res == -1 )
+    int res;
+
+# if defined( WIN32 ) && !defined( UNDER_CE )
+    /* Writing to the console is a lot of fun on Microsoft Windows.
+     * If you use the standard I/O functions, you must use the OEM code page,
+     * which is different from the usual ANSI code page. Or maybe not, if the
+     * user called "chcp". Anyway, we prefer Unicode. */
+    int fd = _fileno (stream);
+    if (likely(fd != -1) && _isatty (fd))
+    {
+        res = vasprintf (&str, fmt, ap);
+        if (unlikely(res == -1))
+            return -1;
+
+        size_t wlen = 2 * (res + 1);
+        wchar_t *wide = malloc (wlen);
+        if (likely(wide != NULL))
+        {
+            wlen = MultiByteToWideChar (CP_UTF8, 0, str, res + 1, wide, wlen);
+            if (wlen > 0)
+            {
+                HANDLE h = (HANDLE)(intptr_t)_get_osfhandle (fd);
+                DWORD out;
+
+                WriteConsoleW (h, wide, wlen - 1, &out, NULL);
+            }
+            else
+                res = -1;
+            free (wide);
+        }
+        else
+            res = -1;
+        free (str);
+        return res;
+    }
+# endif
+
+    res = vasprintf (&str, fmt, ap);
+    if (unlikely(res == -1))
         return -1;
 
-    fputs( str, stream );
-    free( str );
+    char *ansi = ToLocaleDup (str);
+    free (str);
+
+    fputs (ansi, stream);
+    free (ansi);
     return res;
+#endif
 }
 
 /**
@@ -278,73 +273,74 @@ int utf8_fprintf( FILE *stream, const char *fmt, ... )
 }
 
 
-static char *CheckUTF8( char *str, char rep )
+/**
+ * Converts the first character from a UTF-8 sequence into a code point.
+ *
+ * @param str an UTF-8 bytes sequence
+ * @return 0 if str points to an empty string, i.e. the first character is NUL;
+ * number of bytes that the first character occupies (from 1 to 4) otherwise;
+ * -1 if the byte sequence was not a valid UTF-8 sequence.
+ */
+static size_t vlc_towc (const char *str, uint32_t *restrict pwc)
 {
     uint8_t *ptr = (uint8_t *)str;
     assert (str != NULL);
 
-    for (;;)
-    {
-        uint8_t c = ptr[0];
-
-        if (c == '\0')
-            break;
-
-        if (c > 0xF4)
-            goto error;
+    uint8_t c = ptr[0];
 
-        int charlen = clz8 (c ^ 0xFF);
-        switch (charlen)
-        {
-            case 0: // 7-bit ASCII character -> OK
-                ptr++;
-                continue;
+    if (unlikely(c == '\0'))
+    {
+        *pwc = 0;
+        return 0;
+    }
 
-            case 1: // continuation byte -> error
-                goto error;
-        }
+    if (unlikely(c > 0xF4))
+        return -1;
 
-        assert (charlen >= 2 && charlen <= 4);
+    int charlen = clz8 (c ^ 0xFF);
+    switch (charlen)
+    {
+        case 0: // 7-bit ASCII character -> OK
+            *pwc = c;
+            return 1;
 
-        uint32_t cp = c & ~((0xff >> (7 - charlen)) << (7 - charlen));
-        for (int i = 1; i < charlen; i++)
-        {
-            assert (cp < (1 << 26));
-            c = ptr[i];
+        case 1: // continuation byte -> error
+            return -1;
+    }
 
-            if ((c >> 6) != 2) // not a continuation byte
-                goto error;
+    assert (charlen >= 2 && charlen <= 4);
 
-            cp = (cp << 6) | (ptr[i] & 0x3f);
-        }
+    uint32_t cp = c & ~((0xff >> (7 - charlen)) << (7 - charlen));
+    for (int i = 1; i < charlen; i++)
+    {
+        assert (cp < (1 << 26));
+        c = ptr[i];
 
-        switch (charlen)
-        {
-            case 4:
-                if (cp > 0x10FFFF) // beyond Unicode
-                    goto error;
-            case 3:
-                if (cp >= 0xD800 && cp < 0xC000) // UTF-16 surrogate
-                    goto error;
-            case 2:
-                if (cp < 128) // ASCII overlong
-                    goto error;
-                if (cp < (1u << (5 * charlen - 3))) // overlong
-                    goto error;
-        }
-        ptr += charlen;
-        continue;
+        if (unlikely((c >> 6) != 2)) // not a continuation byte
+            return -1;
 
-    error:
-        if (rep == 0)
-            return NULL;
-        *ptr++ = rep;
-        str = NULL;
+        cp = (cp << 6) | (ptr[i] & 0x3f);
     }
 
-    return str;
+    switch (charlen)
+    {
+        case 4:
+            if (unlikely(cp > 0x10FFFF)) // beyond Unicode
+                return -1;
+        case 3:
+            if (unlikely(cp >= 0xD800 && cp < 0xC000)) // UTF-16 surrogate
+                return -1;
+        case 2:
+            if (unlikely(cp < 128)) // ASCII overlong
+                return -1;
+            if (unlikely(cp < (1u << (5 * charlen - 3)))) // overlong
+                return -1;
+    }
+    *pwc = cp;
+    return charlen;
 }
 
+
 /**
  * Replaces invalid/overlong UTF-8 sequences with question marks.
  * Note that it is not possible to convert from Latin-1 to UTF-8 on the fly,
@@ -354,7 +350,19 @@ static char *CheckUTF8( char *str, char rep )
  */
 char *EnsureUTF8( char *str )
 {
-    return CheckUTF8( str, '?' );
+    char *ret = str;
+    size_t n;
+    uint32_t cp;
+
+    while ((n = vlc_towc (str, &cp)) != 0)
+        if (likely(n != (size_t)-1))
+            str += n;
+        else
+        {
+            *str++ = '?';
+            ret = NULL;
+        }
+    return ret;
 }
 
 
@@ -367,7 +375,15 @@ char *EnsureUTF8( char *str )
  */
 const char *IsUTF8( const char *str )
 {
-    return CheckUTF8( (char *)str, 0 );
+    size_t n;
+    uint32_t cp;
+
+    while ((n = vlc_towc (str, &cp)) != 0)
+        if (likely(n != (size_t)-1))
+            str += n;
+        else
+            return NULL;
+    return str;
 }
 
 /**