git.sesse.net Git - vlc/blob - src/text/unicode.c

   1 /*****************************************************************************
   2  * unicode.c: Unicode <-> locale functions
   3  *****************************************************************************
   4  * Copyright (C) 2005-2006 the VideoLAN team
   5  * Copyright © 2005-2008 Rémi Denis-Courmont
   6  *
   7  * Authors: Rémi Denis-Courmont <rem # videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_charset.h>
  33
  34 #include <assert.h>
  35
  36 #include <stdio.h>
  37 #include <stdarg.h>
  38 #include <stdlib.h>
  39 #include <sys/types.h>
  40 #ifdef UNDER_CE
  41 #  include <tchar.h>
  42 #endif
  43 #include <errno.h>
  44
  45 #if defined (__APPLE__) || defined (HAVE_MAEMO)
  46 /* Define this if the OS always use UTF-8 internally */
  47 # define ASSUME_UTF8 1
  48 #endif
  49
  50 #if defined (ASSUME_UTF8)
  51 /* Cool */
  52
  53 #elif defined (WIN32) || defined (UNDER_CE)
  54 # define USE_MB2MB 1
  55
  56 static char *locale_dup (const char *string, bool from)
  57 {
  58     char *out;
  59     int len;
  60
  61     len = 1 + MultiByteToWideChar (from ? CP_ACP : CP_UTF8,
  62                                    0, string, -1, NULL, 0);
  63     wchar_t *wide = malloc (len * sizeof (wchar_t));
  64     if (wide == NULL)
  65         return NULL;
  66
  67     MultiByteToWideChar (from ? CP_ACP : CP_UTF8, 0, string, -1, wide, len);
  68     len = 1 + WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1,
  69                                    NULL, 0, NULL, NULL);
  70     out = malloc (len);
  71     if (out != NULL)
  72         WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1, out, len,
  73                              NULL, NULL);
  74     free (wide);
  75     return out;
  76 }
  77
  78 #elif defined (HAVE_ICONV)
  79 # define USE_ICONV 1
  80
  81 static char *locale_dup (const char *string, bool from)
  82 {
  83     vlc_iconv_t hd = vlc_iconv_open (from ? "UTF-8" : "",
  84                                      from ? "" : "UTF-8");
  85     if (hd == (vlc_iconv_t)(-1))
  86         return NULL; /* Uho! */
  87
  88     const char *iptr = string;
  89     size_t inb = strlen (string);
  90     size_t outb = inb * 6 + 1;
  91     char output[outb], *optr = output;
  92
  93     while (vlc_iconv (hd, &iptr, &inb, &optr, &outb) == (size_t)(-1))
  94     {
  95         *optr++ = '?';
  96         outb--;
  97         iptr++;
  98         inb--;
  99         vlc_iconv (hd, NULL, NULL, NULL, NULL); /* reset */
 100     }
 101     *optr = '\0';
 102     vlc_iconv_close (hd);
 103
 104     assert (inb == 0);
 105     assert (*iptr == '\0');
 106     assert (*optr == '\0');
 107     assert (strlen (output) == (size_t)(optr - output));
 108     return strdup (output);
 109 }
 110
 111 #else
 112 # error No UTF8 charset conversion implemented on this platform!
 113 #endif
 114
 115
 116 /**
 117  * Releases (if needed) a localized or uniformized string.
 118  * @param str non-NULL return value from FromLocale() or ToLocale().
 119  */
 120 void LocaleFree (const char *str)
 121 {
 122 #ifdef ASSUME_UTF8
 123     (void) str;
 124 #else
 125     free ((char *)str);
 126 #endif
 127 }
 128
 129
 130 /**
 131  * Converts a string from the system locale character encoding to UTF-8.
 132  *
 133  * @param locale nul-terminated string to convert
 134  *
 135  * @return a nul-terminated UTF-8 string, or NULL in case of error.
 136  * To avoid memory leak, you have to pass the result to LocaleFree()
 137  * when it is no longer needed.
 138  */
 139 char *FromLocale (const char *locale)
 140 {
 141 #ifdef ASSUME_UTF8
 142     return (char *)locale;
 143 #else
 144     return locale ? locale_dup (locale, true) : NULL;
 145 #endif
 146 }
 147
 148 /**
 149  * converts a string from the system locale character encoding to utf-8,
 150  * the result is always allocated on the heap.
 151  *
 152  * @param locale nul-terminated string to convert
 153  *
 154  * @return a nul-terminated utf-8 string, or null in case of error.
 155  * The result must be freed using free() - as with the strdup() function.
 156  */
 157 char *FromLocaleDup (const char *locale)
 158 {
 159 #ifdef ASSUME_UTF8
 160     return strdup (locale);
 161 #else
 162     return locale_dup (locale, true);
 163 #endif
 164 }
 165
 166
 167 /**
 168  * ToLocale: converts an UTF-8 string to local system encoding.
 169  *
 170  * @param utf8 nul-terminated string to be converted
 171  *
 172  * @return a nul-terminated string, or NULL in case of error.
 173  * To avoid memory leak, you have to pass the result to LocaleFree()
 174  * when it is no longer needed.
 175  */
 176 char *ToLocale (const char *utf8)
 177 {
 178 #ifdef ASSUME_UTF8
 179     return (char *)utf8;
 180 #else
 181     return utf8 ? locale_fast (utf8, false) : NULL
 182 #endif
 183 }
 184
 185
 186 /**
 187  * converts a string from UTF-8 to the system locale character encoding,
 188  * the result is always allocated on the heap.
 189  *
 190  * @param utf8 nul-terminated string to convert
 191  *
 192  * @return a nul-terminated string, or null in case of error.
 193  * The result must be freed using free() - as with the strdup() function.
 194  */
 195 char *ToLocaleDup (const char *utf8)
 196 {
 197 #ifdef ASSUME_UTF8
 198     return strdup (utf8);
 199 #else
 200     return locale_dup (utf8, false);
 201 #endif
 202 }
 203
 204 /**
 205  * Formats an UTF-8 string as vasprintf(), then print it to stdout, with
 206  * appropriate conversion to local encoding.
 207  */
 208 static int utf8_vasprintf( char **str, const char *fmt, va_list ap )
 209 {
 210     char *utf8;
 211     int res = vasprintf( &utf8, fmt, ap );
 212     if( res == -1 )
 213         return -1;
 214
 215     *str = ToLocaleDup( utf8 );
 216     free( utf8 );
 217     return res;
 218 }
 219
 220 /**
 221  * Formats an UTF-8 string as vfprintf(), then print it, with
 222  * appropriate conversion to local encoding.
 223  */
 224 int utf8_vfprintf( FILE *stream, const char *fmt, va_list ap )
 225 {
 226     char *str;
 227     int res = utf8_vasprintf( &str, fmt, ap );
 228     if( res == -1 )
 229         return -1;
 230
 231     fputs( str, stream );
 232     free( str );
 233     return res;
 234 }
 235
 236 /**
 237  * Formats an UTF-8 string as fprintf(), then print it, with
 238  * appropriate conversion to local encoding.
 239  */
 240 int utf8_fprintf( FILE *stream, const char *fmt, ... )
 241 {
 242     va_list ap;
 243     int res;
 244
 245     va_start( ap, fmt );
 246     res = utf8_vfprintf( stream, fmt, ap );
 247     va_end( ap );
 248     return res;
 249 }
 250
 251
 252 static char *CheckUTF8( char *str, char rep )
 253 {
 254     uint8_t *ptr = (uint8_t *)str;
 255     assert (str != NULL);
 256
 257     for (;;)
 258     {
 259         uint8_t c = ptr[0];
 260
 261         if (c == '\0')
 262             break;
 263
 264         if (c > 0xF4)
 265             goto error;
 266
 267         int charlen = clz8 (c ^ 0xFF);
 268         switch (charlen)
 269         {
 270             case 0: // 7-bit ASCII character -> OK
 271                 ptr++;
 272                 continue;
 273
 274             case 1: // continuation byte -> error
 275                 goto error;
 276         }
 277
 278         assert (charlen >= 2 && charlen <= 4);
 279
 280         uint32_t cp = c & ~((0xff >> (7 - charlen)) << (7 - charlen));
 281         for (int i = 1; i < charlen; i++)
 282         {
 283             assert (cp < (1 << 26));
 284             c = ptr[i];
 285
 286             if ((c >> 6) != 2) // not a continuation byte
 287                 goto error;
 288
 289             cp = (cp << 6) | (ptr[i] & 0x3f);
 290         }
 291
 292         switch (charlen)
 293         {
 294             case 4:
 295                 if (cp > 0x10FFFF) // beyond Unicode
 296                     goto error;
 297             case 3:
 298                 if (cp >= 0xD800 && cp < 0xC000) // UTF-16 surrogate
 299                     goto error;
 300             case 2:
 301                 if (cp < 128) // ASCII overlong
 302                     goto error;
 303                 if (cp < (1u << (5 * charlen - 3))) // overlong
 304                     goto error;
 305         }
 306         ptr += charlen;
 307         continue;
 308
 309     error:
 310         if (rep == 0)
 311             return NULL;
 312         *ptr++ = rep;
 313         str = NULL;
 314     }
 315
 316     return str;
 317 }
 318
 319 /**
 320  * Replaces invalid/overlong UTF-8 sequences with question marks.
 321  * Note that it is not possible to convert from Latin-1 to UTF-8 on the fly,
 322  * so we don't try that, even though it would be less disruptive.
 323  *
 324  * @return str if it was valid UTF-8, NULL if not.
 325  */
 326 char *EnsureUTF8( char *str )
 327 {
 328     return CheckUTF8( str, '?' );
 329 }
 330
 331
 332 /**
 333  * Checks whether a string is a valid UTF-8 byte sequence.
 334  *
 335  * @param str nul-terminated string to be checked
 336  *
 337  * @return str if it was valid UTF-8, NULL if not.
 338  */
 339 const char *IsUTF8( const char *str )
 340 {
 341     return CheckUTF8( (char *)str, 0 );
 342 }
 343
 344 /**
 345  * Converts a string from the given character encoding to utf-8.
 346  *
 347  * @return a nul-terminated utf-8 string, or null in case of error.
 348  * The result must be freed using free().
 349  */
 350 char *FromCharset(const char *charset, const void *data, size_t data_size)
 351 {
 352     vlc_iconv_t handle = vlc_iconv_open ("UTF-8", charset);
 353     if (handle == (vlc_iconv_t)(-1))
 354         return NULL;
 355
 356     char *out = NULL;
 357     for(unsigned mul = 4; mul < 8; mul++ )
 358     {
 359         size_t in_size = data_size;
 360         const char *in = data;
 361         size_t out_max = mul * data_size;
 362         char *tmp = out = malloc (1 + out_max);
 363         if (!out)
 364             break;
 365
 366         if (vlc_iconv (handle, &in, &in_size, &tmp, &out_max) != (size_t)(-1)) {
 367             *tmp = '\0';
 368             break;
 369         }
 370         free(out);
 371         out = NULL;
 372
 373         if (errno != E2BIG)
 374             break;
 375     }
 376     vlc_iconv_close(handle);
 377     return out;
 378 }
 379