]> git.sesse.net Git - vlc/blob - src/misc/unicode.c
More useless code - at least at do try to understand what I commit
[vlc] / src / misc / unicode.c
1 /*****************************************************************************
2  * unicode.c: Unicode <-> locale functions
3  *****************************************************************************
4  * Copyright (C) 2005-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Rémi Denis-Courmont <rem # videolan.org>
8  *
9  * UTF16toUTF8() adapted from Perl 5 (also GPL'd)
10  * Copyright (C) 1998-2002, Larry Wall
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <vlc/vlc.h>
31 #include "charset.h"
32
33 #include <assert.h>
34
35 #include <stdio.h>
36 #include <stdarg.h>
37 #include <stdlib.h>
38 #include <errno.h>
39 #include <sys/types.h>
40 #ifdef HAVE_DIRENT_H
41 #  include <dirent.h>
42 #endif
43 #ifdef UNDER_CE
44 #  include <tchar.h>
45 #endif
46 #ifdef HAVE_SYS_STAT_H
47 # include <sys/stat.h>
48 #endif
49
50 #ifndef HAVE_LSTAT
51 # define lstat( a, b ) stat(a, b)
52 #endif
53
54 #ifdef __APPLE__
55 /* Define this if the OS always use UTF-8 internally */
56 # define ASSUME_UTF8 1
57 #endif
58
59 #ifndef ASSUME_UTF8
60 # if defined (HAVE_ICONV)
61 /* libiconv is more powerful than Win32 API (it has translit) */
62 #  define USE_ICONV 1
63 # elif defined (WIN32) || defined (UNDER_CE)
64 #  define USE_MB2MB 1
65 # else
66 #  error No UTF8 charset conversion implemented on this platform!
67 # endif
68 #endif
69
70 #ifdef USE_ICONV
71 static struct {
72     vlc_iconv_t hd;
73     vlc_mutex_t lock;
74 } from_locale, to_locale;
75 #endif
76
77 void LocaleInit( vlc_object_t *p_this )
78 {
79 #ifdef USE_ICONV
80     char *psz_charset;
81
82     if( vlc_current_charset( &psz_charset ) )
83         /* UTF-8 */
84         from_locale.hd = to_locale.hd = (vlc_iconv_t)(-1);
85     else
86     {
87         /* not UTF-8 */
88         char psz_buf[strlen( psz_charset ) + sizeof( "//translit" )];
89         const char *psz_conv;
90
91         /*
92          * Still allow non-ASCII characters when the locale is not set.
93          * Western Europeans are being favored for historical reasons.
94          */
95         if( strcmp( psz_charset, "ASCII" ) )
96         {
97             sprintf( psz_buf, "%s//translit", psz_charset );
98             psz_conv = psz_buf;
99         }
100         else
101             psz_conv = "ISO-8859-1//translit";
102
103         vlc_mutex_init( p_this, &from_locale.lock );
104         vlc_mutex_init( p_this, &to_locale.lock );
105         from_locale.hd = vlc_iconv_open( "UTF-8", psz_conv );
106         to_locale.hd = vlc_iconv_open( psz_conv, "UTF-8" );
107     }
108
109     free( psz_charset );
110
111     assert( (from_locale.hd == (vlc_iconv_t)(-1))
112             == (to_locale.hd == (vlc_iconv_t)(-1)) );
113 #else
114     (void)p_this;
115 #endif
116 }
117
118 void LocaleDeinit( void )
119 {
120 #ifdef USE_ICONV
121     if( to_locale.hd != (vlc_iconv_t)(-1) )
122     {
123         vlc_iconv_close( to_locale.hd );
124         vlc_mutex_destroy( &to_locale.lock );
125     }
126
127     if( from_locale.hd != (vlc_iconv_t)(-1) )
128     {
129         vlc_iconv_close( from_locale.hd );
130         vlc_mutex_destroy( &from_locale.lock );
131     }
132 #endif
133 }
134
135 #ifdef USE_MB2MB
136 static char *MB2MB( const char *string, UINT fromCP, UINT toCP )
137 {
138     char *out;
139     wchar_t *wide;
140     int len;
141
142     len = MultiByteToWideChar( fromCP, 0, string, -1, NULL, 0 );
143     assert( len > 0 );
144     wide = (wchar_t *)malloc (len * sizeof (wchar_t));
145     if( wide == NULL )
146         return NULL;
147
148     MultiByteToWideChar( fromCP, 0, string, -1, wide, len );
149     len = WideCharToMultiByte( toCP, 0, wide, -1, NULL, 0, NULL, NULL );
150     assert( len > 0 );
151     out = malloc( len );
152
153     WideCharToMultiByte( toCP, 0, wide, -1, out, len, NULL, NULL );
154     free( wide );
155     return out;
156 }
157 #endif
158
159 /**
160  * FromLocale: converts a locale string to UTF-8
161  *
162  * @param locale nul-terminated string to be converted
163  *
164  * @return a nul-terminated UTF-8 string, or NULL in case of error.
165  * To avoid memory leak, you have to pass the result to LocaleFree()
166  * when it is no longer needed.
167  */
168 char *FromLocale( const char *locale )
169 {
170     if( locale == NULL )
171         return NULL;
172
173 #ifndef USE_MB2MB
174 # ifdef USE_ICONV
175     if( from_locale.hd != (vlc_iconv_t)(-1) )
176     {
177         const char *iptr = locale;
178         size_t inb = strlen( locale );
179         size_t outb = inb * 6 + 1;
180         char output[outb], *optr = output;
181
182         vlc_mutex_lock( &from_locale.lock );
183         vlc_iconv( from_locale.hd, NULL, NULL, NULL, NULL );
184
185         while( vlc_iconv( from_locale.hd, &iptr, &inb, &optr, &outb )
186                == (size_t)-1 )
187         {
188             *optr++ = '?';
189             outb--;
190             iptr++;
191             inb--;
192             vlc_iconv( from_locale.hd, NULL, NULL, NULL, NULL );
193         }
194         vlc_mutex_unlock( &from_locale.lock );
195         *optr = '\0';
196
197         assert (inb == 0);
198         assert (*iptr == '\0');
199         assert (*optr == '\0');
200         assert (strlen( output ) == (size_t)(optr - output));
201         return strdup( output );
202     }
203 # endif /* USE_ICONV */
204     return (char *)locale;
205 #else /* MB2MB */
206     return MB2MB( locale, CP_ACP, CP_UTF8 );
207 #endif
208 }
209
210 char *FromLocaleDup( const char *locale )
211 {
212 #if defined (ASSUME_UTF8)
213     return strdup( locale );
214 #else
215 # ifdef USE_ICONV
216     if (from_locale.hd == (vlc_iconv_t)(-1))
217         return strdup( locale );
218 # endif
219     return FromLocale( locale );
220 #endif
221 }
222
223
224 /**
225  * ToLocale: converts a UTF-8 string to local system encoding.
226  *
227  * @param utf8 nul-terminated string to be converted
228  *
229  * @return a nul-terminated string, or NULL in case of error.
230  * To avoid memory leak, you have to pass the result to LocaleFree()
231  * when it is no longer needed.
232  */
233 char *ToLocale( const char *utf8 )
234 {
235     if( utf8 == NULL )
236         return NULL;
237
238 #ifndef USE_MB2MB
239 # ifdef USE_ICONV
240     if( to_locale.hd != (vlc_iconv_t)(-1) )
241     {
242         const char *iptr = utf8;
243         size_t inb = strlen( utf8 );
244         /* FIXME: I'm not sure about the value for the multiplication
245         * (for western people, multiplication is not needed) */
246         size_t outb = inb * 2 + 1;
247
248         char output[outb], *optr = output;
249
250         vlc_mutex_lock( &to_locale.lock );
251         vlc_iconv( to_locale.hd, NULL, NULL, NULL, NULL );
252
253         while( vlc_iconv( to_locale.hd, &iptr, &inb, &optr, &outb )
254                == (size_t)-1 )
255         {
256             *optr++ = '?'; /* should not happen, and yes, it sucks */
257             outb--;
258             iptr++;
259             inb--;
260             vlc_iconv( to_locale.hd, NULL, NULL, NULL, NULL );
261         }
262         vlc_mutex_unlock( &to_locale.lock );
263         *optr = '\0';
264
265         assert (inb == 0);
266         assert (*iptr == '\0');
267         assert (*optr == '\0');
268         assert (strlen( output ) == (size_t)(optr - output));
269         return strdup( output );
270     }
271 # endif /* USE_ICONV */
272     return (char *)utf8;
273 #else /* MB2MB */
274     return MB2MB( utf8, CP_UTF8, CP_ACP );
275 #endif
276 }
277
278 char *ToLocaleDup( const char *utf8 )
279 {
280 #if defined (ASSUME_UTF8)
281     return strdup( utf8 );
282 #else
283 # ifdef USE_ICONV
284     if (to_locale.hd == (vlc_iconv_t)(-1))
285         return strdup( utf8 );
286 # endif
287     return ToLocale( utf8 );
288 #endif
289 }
290
291 void LocaleFree( const char *str )
292 {
293 #ifdef USE_ICONV
294     if( to_locale.hd == (vlc_iconv_t)(-1) )
295         return;
296 #endif
297
298 #ifndef ASSUME_UTF8
299     if( str != NULL )
300         free( (char *)str );
301 #endif
302 }
303
304 /**
305  * utf8_fopen: Calls fopen() after conversion of file name to OS locale
306  */
307 FILE *utf8_fopen( const char *filename, const char *mode )
308 {
309 #if !(defined (WIN32) || defined (UNDER_CE))
310     const char *local_name = ToLocale( filename );
311
312     if( local_name != NULL )
313     {
314         FILE *stream = fopen( local_name, mode );
315         LocaleFree( local_name );
316         return stream;
317     }
318     else
319         errno = ENOENT;
320     return NULL;
321 #else
322     wchar_t wpath[MAX_PATH + 1];
323     size_t len = strlen( mode ) + 1;
324     wchar_t wmode[len];
325
326     if( !MultiByteToWideChar( CP_UTF8, 0, filename, -1, wpath, MAX_PATH )
327      || !MultiByteToWideChar( CP_ACP, 0, mode, len, wmode, len ) )
328     {
329         errno = ENOENT;
330         return NULL;
331     }
332     wpath[MAX_PATH] = L'\0';
333
334     /*
335      * fopen() cannot open files with non-“ANSI” characters on Windows.
336      * We use _wfopen() instead. Same thing for mkdir() and stat().
337      */
338     return _wfopen( wpath, wmode );
339 #endif
340 }
341
342 /**
343  * utf8_mkdir: Calls mkdir() after conversion of file name to OS locale
344  */
345 int utf8_mkdir( const char *dirname )
346 {
347 #if defined (UNDER_CE) || defined (WIN32)
348     wchar_t wname[MAX_PATH + 1];
349     char mod[MAX_PATH + 1];
350     int i;
351
352     /* Convert '/' into '\' */
353     for( i = 0; *dirname; i++ )
354     {
355         if( i == MAX_PATH )
356             return -1; /* overflow */
357
358         if( *dirname == '/' )
359             mod[i] = '\\';
360         else
361             mod[i] = *dirname;
362         dirname++;
363
364     }
365     mod[i] = 0;
366
367     if( MultiByteToWideChar( CP_UTF8, 0, mod, -1, wname, MAX_PATH ) == 0 )
368     {
369         errno = ENOENT;
370         return -1;
371     }
372     wname[MAX_PATH] = L'\0';
373
374     if( CreateDirectoryW( wname, NULL ) == 0 )
375     {
376         if( GetLastError( ) == ERROR_ALREADY_EXISTS )
377             errno = EEXIST;
378         errno = ENOENT;
379         return -1;
380     }
381     return 0;
382 #else
383     char *locname = ToLocale( dirname );
384     int res;
385
386     if( locname == NULL )
387     {
388         errno = ENOENT;
389         return -1;
390     }
391     res = mkdir( locname, 0755 );
392
393     LocaleFree( locname );
394     return res;
395 #endif
396 }
397
398
399 void *utf8_opendir( const char *dirname )
400 {
401     const char *local_name = ToLocale( dirname );
402
403     if( local_name != NULL )
404     {
405         DIR *dir = vlc_opendir_wrapper( local_name );
406         LocaleFree( local_name );
407         return dir;
408     }
409     else
410         errno = ENOENT;
411     return NULL;
412 }
413
414 const char *utf8_readdir( void *dir )
415 {
416     struct dirent *ent;
417
418     ent = vlc_readdir_wrapper( (DIR *)dir );
419     if( ent == NULL )
420         return NULL;
421
422     return FromLocale( ent->d_name );
423 }
424
425 static int dummy_select( const char *str )
426 {
427     (void)str;
428     return 1;
429 }
430
431 int utf8_scandir( const char *dirname, char ***namelist,
432                   int (*select)( const char * ),
433                   int (*compar)( const char **, const char ** ) )
434 {
435     DIR *dir = utf8_opendir( dirname );
436
437     if( select == NULL )
438         select = dummy_select;
439
440     if( dir == NULL )
441         return -1;
442     else
443     {
444         char **tab = NULL;
445         const char *entry;
446         unsigned num = 0;
447
448         while( ( entry = utf8_readdir( dir ) ) != NULL )
449         {
450             char **newtab;
451             char *utf_entry = strdup( entry );
452             LocaleFree( entry );
453             if( utf_entry == NULL )
454                 goto error;
455
456             if( !select( utf_entry ) )
457                 continue;
458
459             newtab = realloc( tab, sizeof( char * ) * (num + 1) );
460             if( newtab == NULL )
461                 goto error;
462             tab = newtab;
463             tab[num++] = utf_entry;
464         }
465         vlc_closedir_wrapper( dir );
466
467         if( compar != NULL )
468             qsort( tab, num, sizeof( tab[0] ),
469                    (int (*)( const void *, const void *))compar );
470
471         *namelist = tab;
472         return num;
473
474     error:{
475         unsigned i;
476
477         for( i = 0; i < num; i++ )
478             free( tab[i] );
479         if( tab != NULL )
480             free( tab );
481         return -1;}
482     }
483 }
484
485
486 static int utf8_statEx( const char *filename, void *buf,
487                         vlc_bool_t deref )
488 {
489 #if !(defined (WIN32) || defined (UNDER_CE))
490 # ifdef HAVE_SYS_STAT_H
491     const char *local_name = ToLocale( filename );
492
493     if( local_name != NULL )
494     {
495         int res = deref ? stat( local_name, (struct stat *)buf )
496                        : lstat( local_name, (struct stat *)buf );
497         LocaleFree( local_name );
498         return res;
499     }
500     errno = ENOENT;
501 # endif
502     return -1;
503 #else
504     wchar_t wpath[MAX_PATH + 1];
505
506     if( !MultiByteToWideChar( CP_UTF8, 0, filename, -1, wpath, MAX_PATH ) )
507     {
508         errno = ENOENT;
509         return -1;
510     }
511     wpath[MAX_PATH] = L'\0';
512
513     return _wstati64( wpath, (struct _stati64 *)buf );
514 #endif
515 }
516
517
518 int utf8_stat( const char *filename, void *buf)
519 {
520     return utf8_statEx( filename, buf, VLC_TRUE );
521 }
522
523 int utf8_lstat( const char *filename, void *buf)
524 {
525     return utf8_statEx( filename, buf, VLC_FALSE );
526 }
527
528 /**
529  * utf8_*printf: *printf with conversion from UTF-8 to local encoding
530  */
531 static int utf8_vasprintf( char **str, const char *fmt, va_list ap )
532 {
533     char *utf8;
534     int res = vasprintf( &utf8, fmt, ap );
535     if( res == -1 )
536         return -1;
537
538     *str = ToLocaleDup( utf8 );
539     free( utf8 );
540     return res;
541 }
542
543 static int utf8_vfprintf( FILE *stream, const char *fmt, va_list ap )
544 {
545     char *str;
546     int res = utf8_vasprintf( &str, fmt, ap );
547     if( res == -1 )
548         return -1;
549
550     fputs( str, stream );
551     free( str );
552     return res;
553 }
554
555 int utf8_fprintf( FILE *stream, const char *fmt, ... )
556 {
557     va_list ap;
558     int res;
559
560     va_start( ap, fmt );
561     res = utf8_vfprintf( stream, fmt, ap );
562     va_end( ap );
563     return res;
564 }
565
566
567 static char *CheckUTF8( char *str, char rep )
568 #define isutf8cont( c ) (((c) >= 0x80) && ((c) <= 0xBF)) 
569 {
570     unsigned char *ptr, c;
571
572     ptr = (unsigned char *)str;
573     while( (c = *ptr) != '\0' )
574     {
575         /* US-ASCII, 1 byte */
576         if( c <= 0x7F )
577             ptr++; /* OK */
578         else
579         /* 2 bytes */
580         if( ( c >= 0xC2 ) && ( c <= 0xDF ) )
581         {
582             c = ptr[1];
583             if( isutf8cont( c ) )
584                 ptr += 2; /* OK */
585             else
586                 goto error;
587         }
588         else
589         /* 3 bytes */
590         if( c == 0xE0 )
591         {
592             c = ptr[1];
593             if( ( c >= 0xA0 ) && ( c <= 0xBF ) )
594             {
595                 c = ptr[2];
596                 if( isutf8cont( c ) )
597                     ptr += 3; /* OK */
598                 else
599                     goto error;
600             }
601             else
602                 goto error;
603         }
604         else
605         if( ( ( c >= 0xE1 ) && ( c <= 0xEC ) ) || ( c == 0xEC )
606          || ( c == 0xEE ) || ( c == 0xEF ) )
607         {
608             c = ptr[1];
609             if( isutf8cont( c ) )
610             {
611                 c = ptr[2];
612                 if( isutf8cont( c ) )
613                     ptr += 3; /* OK */
614                 else
615                     goto error;
616             }
617             else
618                 goto error;
619         }
620         else
621         if( c == 0xED )
622         {
623             c = ptr[1];
624             if( ( c >= 0x80 ) && ( c <= 0x9F ) )
625             {
626                 c = ptr[2];
627                 if( isutf8cont( c ) )
628                     ptr += 3; /* OK */
629                 else
630                     goto error;
631             }
632             else
633                 goto error;
634         }
635         else
636         /* 4 bytes */
637         if( c == 0xF0 )
638         {
639             c = ptr[1];
640             if( ( c >= 0x90 ) && ( c <= 0xBF ) )
641             {
642                 c = ptr[2];
643                 if( isutf8cont( c ) )
644                 {
645                     c = ptr[3];
646                     if( isutf8cont( c ) )
647                         ptr += 4; /* OK */
648                     else
649                         goto error;
650                 }
651                 else
652                     goto error;
653             }
654             else
655                 goto error;
656         }
657         else
658         if( ( c >= 0xF1 ) && ( c <= 0xF3 ) )
659         {
660             c = ptr[1];
661             if( isutf8cont( c ) )
662             {
663                 c = ptr[2];
664                 if( isutf8cont( c ) )
665                 {
666                     c = ptr[3];
667                     if( isutf8cont( c ) )
668                         ptr += 4; /* OK */
669                     goto error;
670                 }
671                 else
672                     goto error;
673             }
674             else
675                 goto error;
676         }
677         else
678         if( c == 0xF4 )
679         {
680             c = ptr[1];
681             if( ( c >= 0x80 ) && ( c <= 0x8F ) )
682             {
683                 c = ptr[2];
684                 if( isutf8cont( c ) )
685                 {
686                     c = ptr[3];
687                     if( isutf8cont( c ) )
688                         ptr += 4; /* OK */
689                     else
690                         goto error;
691                 }
692                 else
693                     goto error;
694             }
695             else
696                 goto error;
697         }
698         else
699             goto error;
700
701         continue;
702
703 error:
704         if( rep == 0 )
705             return NULL;
706         *ptr++ = '?';
707         str = NULL;
708     }
709
710     return str;
711 }
712
713 /**
714  * EnsureUTF8: replaces invalid/overlong UTF-8 sequences with question marks
715  * Note that it is not possible to convert from Latin-1 to UTF-8 on the fly,
716  * so we don't try that, even though it would be less disruptive.
717  *
718  * @return str if it was valid UTF-8, NULL if not.
719  */
720 char *EnsureUTF8( char *str )
721 {
722     return CheckUTF8( str, '?' );
723 }
724
725
726 /**
727  * IsUTF8: checks whether a string is a valid UTF-8 byte sequence.
728  *
729  * @param str nul-terminated string to be checked
730  *
731  * @return str if it was valid UTF-8, NULL if not.
732  */
733 const char *IsUTF8( const char *str )
734 {
735     return CheckUTF8( (char *)str, 0 );
736 }
737
738
739 /**
740  * UTF32toUTF8(): converts an array from UTF-32 (host byte order)
741  * to UTF-8.
742  *
743  * @param src the UTF-32 table to be converted
744  * @param len the number of code points to be converted from src
745  * (ie. the number of uint32_t in the table pointed to by src)
746  * @param newlen an optional pointer. If not NULL, *newlen will
747  * contain the total number of bytes written.
748  *
749  * @return the result of the conversion (must be free'd())
750  * or NULL on error (in that case, *newlen is undefined).
751  */
752 static char *
753 UTF32toUTF8( const uint32_t *src, size_t len, size_t *newlen )
754 {
755     char *res, *out;
756
757     /* allocate memory */
758     out = res = (char *)malloc( 6 * len );
759     if( res == NULL )
760         return NULL;
761
762     while( len > 0 )
763     {
764         uint32_t uv = *src++;
765         len--;
766
767         if( uv < 0x80 )
768         {
769             *out++ = uv;
770             continue;
771         }
772         else
773         if( uv < 0x800 )
774         {
775             *out++ = (( uv >>  6)         | 0xc0);
776             *out++ = (( uv        & 0x3f) | 0x80);
777             continue;
778         }
779         else
780         if( uv < 0x10000 )
781         {
782             *out++ = (( uv >> 12)         | 0xe0);
783             *out++ = (((uv >>  6) & 0x3f) | 0x80);
784             *out++ = (( uv        & 0x3f) | 0x80);
785             continue;
786         }
787         else
788         if( uv < 0x110000 )
789         {
790             *out++ = (( uv >> 18)         | 0xf0);
791             *out++ = (((uv >> 12) & 0x3f) | 0x80);
792             *out++ = (((uv >>  6) & 0x3f) | 0x80);
793             *out++ = (( uv        & 0x3f) | 0x80);
794             continue;
795         }
796         else
797         {
798             free( res );
799             return NULL;
800         }
801     }
802     len = out - res;
803     res = realloc( res, len );
804     if( newlen != NULL )
805         *newlen = len;
806     return res;
807 }
808
809 /**
810  * FromUTF32(): converts an UTF-32 string to UTF-8.
811  *
812  * @param src UTF-32 bytes sequence, aligned on a 32-bits boundary.
813  *
814  * @return the result of the conversion (must be free()'d),
815  * or NULL in case of error.
816  */
817 char *FromUTF32( const uint32_t *src )
818 {
819     const uint32_t *in;
820     size_t len;
821
822     /* determine the size of the string */
823     for( len = 1, in = src; *in; len++ )
824         in++;
825
826     return UTF32toUTF8( src, len, NULL );
827 }
828
829 /**
830  * UTF16toUTF8: converts UTF-16 (host byte order) to UTF-8
831  *
832  * @param src UTF-16 bytes sequence, aligned on a 16-bits boundary
833  * @param len number of uint16_t to convert
834  */
835 static char *
836 UTF16toUTF8( const uint16_t *in, size_t len, size_t *newlen )
837 {
838     char *res, *out;
839
840     /* allocate memory */
841     out = res = (char *)malloc( 3 * len );
842     if( res == NULL )
843         return NULL;
844
845     while( len > 0 )
846     {
847         uint32_t uv = *in;
848
849         in++;
850         len--;
851
852         if( uv < 0x80 )
853         {
854             *out++ = uv;
855             continue;
856         }
857         if( uv < 0x800 )
858         {
859             *out++ = (( uv >>  6)         | 0xc0);
860             *out++ = (( uv        & 0x3f) | 0x80);
861             continue;
862         }
863         if( (uv >= 0xd800) && (uv < 0xdbff) )
864         {   /* surrogates */
865             uint16_t low = GetWBE( in );
866             in++;
867             len--;
868
869             if( (low < 0xdc00) || (low >= 0xdfff) )
870             {
871                 *out++ = '?'; /* Malformed surrogate */
872                 continue;
873             }
874             else
875                 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
876         }
877         if( uv < 0x10000 )
878         {
879             *out++ = (( uv >> 12)         | 0xe0);
880             *out++ = (((uv >>  6) & 0x3f) | 0x80);
881             *out++ = (( uv        & 0x3f) | 0x80);
882             continue;
883         }
884         else
885         {
886             *out++ = (( uv >> 18)         | 0xf0);
887             *out++ = (((uv >> 12) & 0x3f) | 0x80);
888             *out++ = (((uv >>  6) & 0x3f) | 0x80);
889             *out++ = (( uv        & 0x3f) | 0x80);
890             continue;
891         }
892     }
893     len = out - res;
894     res = realloc( res, len );
895     if( newlen != NULL )
896         *newlen = len;
897     return res;
898 }
899
900
901 /**
902  * FromUTF16(): converts an UTF-16 string to UTF-8.
903  *
904  * @param src UTF-16 bytes sequence, aligned on a 16-bits boundary.
905  *
906  * @return the result of the conversion (must be free()'d),
907  * or NULL in case of error.
908  */
909 char *FromUTF16( const uint16_t *src )
910 {
911     const uint16_t *in;
912     size_t len;
913
914     /* determine the size of the string */
915     for( len = 1, in = src; *in; len++ )
916         in += 2;
917
918     return UTF16toUTF8( src, len, NULL );
919 }