1 /*****************************************************************************
2 * unicode.c: Unicode <-> locale functions
3 *****************************************************************************
4 * Copyright (C) 2005-2006 the VideoLAN team
5 * Copyright © 2005-2006 Rémi Denis-Courmont
8 * Authors: Rémi Denis-Courmont <rem # videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
29 #include <vlc_charset.h>
37 #include <sys/types.h>
44 #ifdef HAVE_SYS_STAT_H
45 # include <sys/stat.h>
57 # define lstat( a, b ) stat(a, b)
61 /* Define this if the OS always use UTF-8 internally */
62 # define ASSUME_UTF8 1
65 #if defined (ASSUME_UTF8)
67 #elif defined (WIN32) || defined (UNDER_CE)
69 #elif defined (HAVE_ICONV)
72 # error No UTF8 charset conversion implemented on this platform!
75 #if defined (USE_ICONV)
76 static char charset[sizeof ("CSISO11SWEDISHFORNAMES//translit")] = "";
78 static void find_charset_once (void)
81 if (vlc_current_charset (&psz_charset)
82 || (psz_charset == NULL)
83 || ((size_t)snprintf (charset, sizeof (charset), "%s//translit",
84 psz_charset) >= sizeof (charset)))
85 strcpy (charset, "UTF-8");
90 static int find_charset (void)
92 static pthread_once_t once = PTHREAD_ONCE_INIT;
93 pthread_once (&once, find_charset_once);
94 return !strcmp (charset, "UTF-8");
99 static char *locale_fast (const char *string, vlc_bool_t from)
101 #if defined (USE_ICONV)
103 return (char *)string;
105 vlc_iconv_t hd = vlc_iconv_open (from ? "UTF-8" : charset,
106 from ? charset : "UTF-8");
107 if (hd == (vlc_iconv_t)(-1))
108 return strdup (string); /* Uho! */
110 const char *iptr = string;
111 size_t inb = strlen (string);
112 size_t outb = inb * 6 + 1;
113 char output[outb], *optr = output;
118 while (vlc_iconv (hd, &iptr, &inb, &optr, &outb) == (size_t)(-1))
124 vlc_iconv (hd, NULL, NULL, NULL, NULL);
127 vlc_iconv_close (hd);
130 assert (*iptr == '\0');
131 assert (*optr == '\0');
132 assert (strlen (output) == (size_t)(optr - output));
133 return strdup (output);
134 #elif defined (USE_MB2MB)
141 len = 1 + MultiByteToWideChar (from ? CP_ACP : CP_UTF8,
142 0, string, -1, NULL, 0);
145 MultiByteToWideChar (from ? CP_UTF8 : CP_ACP, 0, string, -1, wide, len);
146 len = 1 + WideCharToMultiByte (p->toCP, 0, wide, -1, NULL, 0, NULL, NULL);
151 WideCharToMultiByte (p->toCP, 0, wide, -1, out, len, NULL, NULL);
154 return (char *)string;
159 static inline char *locale_dup (const char *string, vlc_bool_t from)
161 #if defined (USE_ICONV)
163 return strdup (string);
164 return locale_fast (string, from);
165 #elif defined (USE_MB2MB)
166 return locale_fast (string, from);
168 return strdup (string);
173 void LocaleFree (const char *str)
175 #if defined (USE_ICONV)
178 #elif defined (USE_MB2MB)
185 * FromLocale: converts a locale string to UTF-8
187 * @param locale nul-terminated string to be converted
189 * @return a nul-terminated UTF-8 string, or NULL in case of error.
190 * To avoid memory leak, you have to pass the result to LocaleFree()
191 * when it is no longer needed.
193 char *FromLocale (const char *locale)
195 return locale_fast (locale, VLC_TRUE);
198 char *FromLocaleDup (const char *locale)
200 return locale_dup (locale, VLC_TRUE);
205 * ToLocale: converts a UTF-8 string to local system encoding.
207 * @param utf8 nul-terminated string to be converted
209 * @return a nul-terminated string, or NULL in case of error.
210 * To avoid memory leak, you have to pass the result to LocaleFree()
211 * when it is no longer needed.
213 char *ToLocale (const char *utf8)
215 return locale_fast (utf8, VLC_FALSE);
219 static char *ToLocaleDup (const char *utf8)
221 return locale_dup (utf8, VLC_FALSE);
226 * utf8_open: open() wrapper for UTF-8 filenames
228 int utf8_open (const char *filename, int flags, mode_t mode)
230 #if defined (WIN32) || defined (UNDER_CE)
231 if (GetVersion() < 0x80000000)
233 /* for Windows NT and above */
234 wchar_t wpath[MAX_PATH + 1];
236 if (!MultiByteToWideChar (CP_UTF8, 0, filename, -1, wpath, MAX_PATH))
241 wpath[MAX_PATH] = L'\0';
244 * open() cannot open files with non-“ANSI” characters on Windows.
245 * We use _wopen() instead. Same thing for mkdir() and stat().
247 return _wopen (wpath, flags, mode);
250 const char *local_name = ToLocale (filename);
252 if (local_name == NULL)
258 int fd = open (local_name, flags, mode);
259 LocaleFree (local_name);
264 * utf8_fopen: fopen() wrapper for UTF-8 filenames
266 FILE *utf8_fopen (const char *filename, const char *mode)
268 int rwflags = 0, oflags = 0;
269 vlc_bool_t append = VLC_FALSE;
271 for (const char *ptr = mode; *ptr; ptr++)
287 oflags |= O_CREAT | O_TRUNC;
302 int fd = utf8_open (filename, rwflags | oflags, 0666);
306 if (append && (lseek (fd, 0, SEEK_END) == -1))
312 FILE *stream = fdopen (fd, mode);
320 * utf8_mkdir: Calls mkdir() after conversion of file name to OS locale
322 * @param dirname a UTF-8 string with the name of the directory that you
324 * @return A 0 return value indicates success. A -1 return value indicates an
325 * error, and an error code is stored in errno
327 int utf8_mkdir( const char *dirname )
329 #if defined (UNDER_CE) || defined (WIN32)
330 wchar_t wname[MAX_PATH + 1];
331 char mod[MAX_PATH + 1];
334 /* Convert '/' into '\' */
335 for( i = 0; *dirname; i++ )
338 return -1; /* overflow */
340 if( *dirname == '/' )
349 if( MultiByteToWideChar( CP_UTF8, 0, mod, -1, wname, MAX_PATH ) == 0 )
354 wname[MAX_PATH] = L'\0';
356 if( CreateDirectoryW( wname, NULL ) == 0 )
358 if( GetLastError( ) == ERROR_ALREADY_EXISTS )
366 char *locname = ToLocale( dirname );
369 if( locname == NULL )
374 res = mkdir( locname, 0755 );
376 LocaleFree( locname );
382 * utf8_opendir: wrapper that converts dirname to the locale in use by the OS
384 * @param dirname UTF-8 representation of the directory name
386 * @return a pointer to the DIR struct. Release with closedir().
388 DIR *utf8_opendir( const char *dirname )
391 wchar_t wname[MAX_PATH + 1];
393 if (MultiByteToWideChar (CP_UTF8, 0, dirname, -1, wname, MAX_PATH))
395 wname[MAX_PATH] = L'\0';
396 return (DIR *)vlc_wopendir (wname);
399 const char *local_name = ToLocale( dirname );
401 if( local_name != NULL )
403 DIR *dir = opendir( local_name );
404 LocaleFree( local_name );
414 * utf8_readdir: a readdir wrapper that returns the name of the next entry
415 * in the directory as a UTF-8 string.
417 * @param dir The directory that is being read
419 * @return a UTF-8 string of the directory entry. Use LocaleFree() to free this memory
421 char *utf8_readdir( DIR *dir )
424 struct _wdirent *ent = vlc_wreaddir (dir);
428 return FromWide (ent->d_name);
432 ent = readdir( (DIR *)dir );
436 return vlc_fix_readdir( ent->d_name );
440 static int dummy_select( const char *str )
446 int utf8_loaddir( DIR *dir, char ***namelist,
447 int (*select)( const char * ),
448 int (*compar)( const char **, const char ** ) )
451 select = dummy_select;
463 while( ( entry = utf8_readdir( dir ) ) != NULL )
467 if( !select( entry ) )
473 newtab = realloc( tab, sizeof( char * ) * (num + 1) );
484 qsort( tab, num, sizeof( tab[0] ),
485 (int (*)( const void *, const void *))compar );
493 for( i = 0; i < num; i++ )
502 int utf8_scandir( const char *dirname, char ***namelist,
503 int (*select)( const char * ),
504 int (*compar)( const char **, const char ** ) )
506 DIR *dir = utf8_opendir (dirname);
511 val = utf8_loaddir (dir, namelist, select, compar);
517 static int utf8_statEx( const char *filename, struct stat *buf,
520 #if defined (WIN32) || defined (UNDER_CE)
521 /* retrieve Windows OS version */
522 if( GetVersion() < 0x80000000 )
524 /* for Windows NT and above */
525 wchar_t wpath[MAX_PATH + 1];
527 if( !MultiByteToWideChar( CP_UTF8, 0, filename, -1, wpath, MAX_PATH ) )
532 wpath[MAX_PATH] = L'\0';
534 return _wstati64( wpath, buf );
537 #ifdef HAVE_SYS_STAT_H
538 const char *local_name = ToLocale( filename );
540 if( local_name != NULL )
542 int res = deref ? stat( local_name, buf )
543 : lstat( local_name, buf );
544 LocaleFree( local_name );
553 int utf8_stat( const char *filename, struct stat *buf)
555 return utf8_statEx( filename, buf, VLC_TRUE );
558 int utf8_lstat( const char *filename, struct stat *buf)
560 return utf8_statEx( filename, buf, VLC_FALSE );
564 * utf8_*printf: *printf with conversion from UTF-8 to local encoding
566 static int utf8_vasprintf( char **str, const char *fmt, va_list ap )
569 int res = vasprintf( &utf8, fmt, ap );
573 *str = ToLocaleDup( utf8 );
578 int utf8_vfprintf( FILE *stream, const char *fmt, va_list ap )
581 int res = utf8_vasprintf( &str, fmt, ap );
585 fputs( str, stream );
590 int utf8_fprintf( FILE *stream, const char *fmt, ... )
596 res = utf8_vfprintf( stream, fmt, ap );
602 static char *CheckUTF8( char *str, char rep )
604 uint8_t *ptr = (uint8_t *)str;
605 assert (str != NULL);
615 for (int i = 0; i < 7; i++)
616 if ((c >> (7 - i)) == ((0xff >> (7 - i)) ^ 1))
624 case 0: // 7-bit ASCII character -> OK
628 case -1: // 1111111x -> error
629 case 1: // continuation byte -> error
633 assert (charlen >= 2);
635 uint32_t cp = c & ~((0xff >> (7 - charlen)) << (7 - charlen));
636 for (int i = 1; i < charlen; i++)
638 assert (cp < (1 << 26));
641 if ((c == '\0') // unexpected end of string
642 || ((c >> 6) != 2)) // not a continuation byte
645 cp = (cp << 6) | (ptr[i] & 0x3f);
648 if (cp < 128) // overlong (special case for ASCII)
650 if (cp < (1u << (5 * charlen - 3))) // overlong
667 * EnsureUTF8: replaces invalid/overlong UTF-8 sequences with question marks
668 * Note that it is not possible to convert from Latin-1 to UTF-8 on the fly,
669 * so we don't try that, even though it would be less disruptive.
671 * @return str if it was valid UTF-8, NULL if not.
673 char *EnsureUTF8( char *str )
675 return CheckUTF8( str, '?' );
680 * IsUTF8: checks whether a string is a valid UTF-8 byte sequence.
682 * @param str nul-terminated string to be checked
684 * @return str if it was valid UTF-8, NULL if not.
686 const char *IsUTF8( const char *str )
688 return CheckUTF8( (char *)str, 0 );