1 /* GLIB - Library of useful routines for C programming
3 * gconvert.c: Convert between character sets using iconv
4 * Copyright Red Hat Inc., 2000
5 * Authors: Havoc Pennington <hp@redhat.com>, Owen Taylor <otaylor@redhat.com
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
33 #include "gprintfint.h"
34 #include "gthreadinit.h"
36 #ifdef G_PLATFORM_WIN32
44 #if defined(USE_LIBICONV_GNU) && !defined (_LIBICONV_H)
45 #error GNU libiconv in use but included iconv.h not from libiconv
47 #if !defined(USE_LIBICONV_GNU) && defined (_LIBICONV_H)
48 #error GNU libiconv not in use but included iconv.h is from libiconv
52 g_convert_error_quark (void)
56 quark = g_quark_from_static_string ("g_convert_error");
62 try_conversion (const char *to_codeset,
63 const char *from_codeset,
66 *cd = iconv_open (to_codeset, from_codeset);
68 if (*cd == (iconv_t)-1 && errno == EINVAL)
75 try_to_aliases (const char **to_aliases,
76 const char *from_codeset,
81 const char **p = to_aliases;
84 if (try_conversion (*p, from_codeset, cd))
94 extern const char **_g_charset_get_aliases (const char *canonical_name) G_GNUC_INTERNAL;
98 * @to_codeset: destination codeset
99 * @from_codeset: source codeset
101 * Same as the standard UNIX routine iconv_open(), but
102 * may be implemented via libiconv on UNIX flavors that lack
103 * a native implementation.
105 * GLib provides g_convert() and g_locale_to_utf8() which are likely
106 * more convenient than the raw iconv wrappers.
108 * Return value: a "conversion descriptor", or (GIConv)-1 if
109 * opening the converter failed.
112 g_iconv_open (const gchar *to_codeset,
113 const gchar *from_codeset)
117 if (!try_conversion (to_codeset, from_codeset, &cd))
119 const char **to_aliases = _g_charset_get_aliases (to_codeset);
120 const char **from_aliases = _g_charset_get_aliases (from_codeset);
124 const char **p = from_aliases;
127 if (try_conversion (to_codeset, *p, &cd))
130 if (try_to_aliases (to_aliases, *p, &cd))
137 if (try_to_aliases (to_aliases, from_codeset, &cd))
142 return (cd == (iconv_t)-1) ? (GIConv)-1 : (GIConv)cd;
147 * @converter: conversion descriptor from g_iconv_open()
148 * @inbuf: bytes to convert
149 * @inbytes_left: inout parameter, bytes remaining to convert in @inbuf
150 * @outbuf: converted output bytes
151 * @outbytes_left: inout parameter, bytes available to fill in @outbuf
153 * Same as the standard UNIX routine iconv(), but
154 * may be implemented via libiconv on UNIX flavors that lack
155 * a native implementation.
157 * GLib provides g_convert() and g_locale_to_utf8() which are likely
158 * more convenient than the raw iconv wrappers.
160 * Return value: count of non-reversible conversions, or -1 on error
163 g_iconv (GIConv converter,
167 gsize *outbytes_left)
169 iconv_t cd = (iconv_t)converter;
171 return iconv (cd, inbuf, inbytes_left, outbuf, outbytes_left);
176 * @converter: a conversion descriptor from g_iconv_open()
178 * Same as the standard UNIX routine iconv_close(), but
179 * may be implemented via libiconv on UNIX flavors that lack
180 * a native implementation. Should be called to clean up
181 * the conversion descriptor from g_iconv_open() when
182 * you are done converting things.
184 * GLib provides g_convert() and g_locale_to_utf8() which are likely
185 * more convenient than the raw iconv wrappers.
187 * Return value: -1 on error, 0 on success
190 g_iconv_close (GIConv converter)
192 iconv_t cd = (iconv_t)converter;
194 return iconv_close (cd);
198 #define ICONV_CACHE_SIZE (16)
200 struct _iconv_cache_bucket {
207 static GList *iconv_cache_list;
208 static GHashTable *iconv_cache;
209 static GHashTable *iconv_open_hash;
210 static guint iconv_cache_size = 0;
211 G_LOCK_DEFINE_STATIC (iconv_cache_lock);
213 /* caller *must* hold the iconv_cache_lock */
215 iconv_cache_init (void)
217 static gboolean initialized = FALSE;
222 iconv_cache_list = NULL;
223 iconv_cache = g_hash_table_new (g_str_hash, g_str_equal);
224 iconv_open_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
231 * iconv_cache_bucket_new:
233 * @cd: iconv descriptor
235 * Creates a new cache bucket, inserts it into the cache and
236 * increments the cache size.
238 * Returns a pointer to the newly allocated cache bucket.
240 static struct _iconv_cache_bucket *
241 iconv_cache_bucket_new (const gchar *key, GIConv cd)
243 struct _iconv_cache_bucket *bucket;
245 bucket = g_new (struct _iconv_cache_bucket, 1);
246 bucket->key = g_strdup (key);
247 bucket->refcount = 1;
251 g_hash_table_insert (iconv_cache, bucket->key, bucket);
253 /* FIXME: if we sorted the list so items with few refcounts were
254 first, then we could expire them faster in iconv_cache_expire_unused () */
255 iconv_cache_list = g_list_prepend (iconv_cache_list, bucket);
264 * iconv_cache_bucket_expire:
265 * @node: cache bucket's node
266 * @bucket: cache bucket
268 * Expires a single cache bucket @bucket. This should only ever be
269 * called on a bucket that currently has no used iconv descriptors
272 * @node is not a required argument. If @node is not supplied, we
273 * search for it ourselves.
276 iconv_cache_bucket_expire (GList *node, struct _iconv_cache_bucket *bucket)
278 g_hash_table_remove (iconv_cache, bucket->key);
281 node = g_list_find (iconv_cache_list, bucket);
283 g_assert (node != NULL);
287 node->prev->next = node->next;
289 node->next->prev = node->prev;
293 iconv_cache_list = node->next;
295 node->next->prev = NULL;
298 g_list_free_1 (node);
300 g_free (bucket->key);
301 g_iconv_close (bucket->cd);
309 * iconv_cache_expire_unused:
311 * Expires as many unused cache buckets as it needs to in order to get
312 * the total number of buckets < ICONV_CACHE_SIZE.
315 iconv_cache_expire_unused (void)
317 struct _iconv_cache_bucket *bucket;
320 node = iconv_cache_list;
321 while (node && iconv_cache_size >= ICONV_CACHE_SIZE)
326 if (bucket->refcount == 0)
327 iconv_cache_bucket_expire (node, bucket);
334 open_converter (const gchar *to_codeset,
335 const gchar *from_codeset,
338 struct _iconv_cache_bucket *bucket;
343 key = g_alloca (strlen (from_codeset) + strlen (to_codeset) + 2);
344 _g_sprintf (key, "%s:%s", from_codeset, to_codeset);
346 G_LOCK (iconv_cache_lock);
348 /* make sure the cache has been initialized */
351 bucket = g_hash_table_lookup (iconv_cache, key);
356 cd = g_iconv_open (to_codeset, from_codeset);
357 if (cd == (GIConv) -1)
362 /* Apparently iconv on Solaris <= 7 segfaults if you pass in
363 * NULL for anything but inbuf; work around that. (NULL outbuf
364 * or NULL *outbuf is allowed by Unix98.)
366 gsize inbytes_left = 0;
367 gchar *outbuf = NULL;
368 gsize outbytes_left = 0;
373 /* reset the descriptor */
374 g_iconv (cd, NULL, &inbytes_left, &outbuf, &outbytes_left);
381 cd = g_iconv_open (to_codeset, from_codeset);
382 if (cd == (GIConv) -1)
385 iconv_cache_expire_unused ();
387 bucket = iconv_cache_bucket_new (key, cd);
390 g_hash_table_insert (iconv_open_hash, cd, bucket->key);
392 G_UNLOCK (iconv_cache_lock);
398 G_UNLOCK (iconv_cache_lock);
400 /* Something went wrong. */
402 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_NO_CONVERSION,
403 _("Conversion from character set '%s' to '%s' is not supported"),
404 from_codeset, to_codeset);
406 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
407 _("Could not open converter from '%s' to '%s'"),
408 from_codeset, to_codeset);
414 close_converter (GIConv converter)
416 struct _iconv_cache_bucket *bucket;
422 if (cd == (GIConv) -1)
425 G_LOCK (iconv_cache_lock);
427 key = g_hash_table_lookup (iconv_open_hash, cd);
430 g_hash_table_remove (iconv_open_hash, cd);
432 bucket = g_hash_table_lookup (iconv_cache, key);
437 if (cd == bucket->cd)
438 bucket->used = FALSE;
442 if (!bucket->refcount && iconv_cache_size > ICONV_CACHE_SIZE)
444 /* expire this cache bucket */
445 iconv_cache_bucket_expire (NULL, bucket);
450 G_UNLOCK (iconv_cache_lock);
452 g_warning ("This iconv context wasn't opened using open_converter");
454 return g_iconv_close (converter);
457 G_UNLOCK (iconv_cache_lock);
465 * @str: the string to convert
466 * @len: the length of the string
467 * @to_codeset: name of character set into which to convert @str
468 * @from_codeset: character set of @str.
469 * @bytes_read: location to store the number of bytes in the
470 * input string that were successfully converted, or %NULL.
471 * Even if the conversion was successful, this may be
472 * less than @len if there were partial characters
473 * at the end of the input. If the error
474 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
475 * stored will the byte offset after the last valid
477 * @bytes_written: the number of bytes stored in the output buffer (not
478 * including the terminating nul).
479 * @error: location to store the error occuring, or %NULL to ignore
480 * errors. Any of the errors in #GConvertError may occur.
482 * Converts a string from one character set to another.
484 * Return value: If the conversion was successful, a newly allocated
485 * nul-terminated string, which must be freed with
486 * g_free(). Otherwise %NULL and @error will be set.
489 g_convert (const gchar *str,
491 const gchar *to_codeset,
492 const gchar *from_codeset,
494 gsize *bytes_written,
500 g_return_val_if_fail (str != NULL, NULL);
501 g_return_val_if_fail (to_codeset != NULL, NULL);
502 g_return_val_if_fail (from_codeset != NULL, NULL);
504 cd = open_converter (to_codeset, from_codeset, error);
506 if (cd == (GIConv) -1)
517 res = g_convert_with_iconv (str, len, cd,
518 bytes_read, bytes_written,
521 close_converter (cd);
527 * g_convert_with_iconv:
528 * @str: the string to convert
529 * @len: the length of the string
530 * @converter: conversion descriptor from g_iconv_open()
531 * @bytes_read: location to store the number of bytes in the
532 * input string that were successfully converted, or %NULL.
533 * Even if the conversion was successful, this may be
534 * less than @len if there were partial characters
535 * at the end of the input. If the error
536 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
537 * stored will the byte offset after the last valid
539 * @bytes_written: the number of bytes stored in the output buffer (not
540 * including the terminating nul).
541 * @error: location to store the error occuring, or %NULL to ignore
542 * errors. Any of the errors in #GConvertError may occur.
544 * Converts a string from one character set to another.
546 * Return value: If the conversion was successful, a newly allocated
547 * nul-terminated string, which must be freed with
548 * g_free(). Otherwise %NULL and @error will be set.
551 g_convert_with_iconv (const gchar *str,
555 gsize *bytes_written,
561 gsize inbytes_remaining;
562 gsize outbytes_remaining;
565 gboolean have_error = FALSE;
567 g_return_val_if_fail (str != NULL, NULL);
568 g_return_val_if_fail (converter != (GIConv) -1, NULL);
574 inbytes_remaining = len;
575 outbuf_size = len + 1; /* + 1 for nul in case len == 1 */
577 outbytes_remaining = outbuf_size - 1; /* -1 for nul */
578 outp = dest = g_malloc (outbuf_size);
582 err = g_iconv (converter, (char **)&p, &inbytes_remaining, &outp, &outbytes_remaining);
584 if (err == (size_t) -1)
589 /* Incomplete text, do not report an error */
593 size_t used = outp - dest;
596 dest = g_realloc (dest, outbuf_size);
599 outbytes_remaining = outbuf_size - used - 1; /* -1 for nul */
604 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
605 _("Invalid byte sequence in conversion input"));
609 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
610 _("Error during conversion: %s"),
620 *bytes_read = p - str;
623 if ((p - str) != len)
627 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
628 _("Partial character sequence at end of input"));
635 *bytes_written = outp - dest; /* Doesn't include '\0' */
647 * g_convert_with_fallback:
648 * @str: the string to convert
649 * @len: the length of the string
650 * @to_codeset: name of character set into which to convert @str
651 * @from_codeset: character set of @str.
652 * @fallback: UTF-8 string to use in place of character not
653 * present in the target encoding. (This must be
654 * in the target encoding), if %NULL, characters
655 * not in the target encoding will be represented
656 * as Unicode escapes \uxxxx or \Uxxxxyyyy.
657 * @bytes_read: location to store the number of bytes in the
658 * input string that were successfully converted, or %NULL.
659 * Even if the conversion was successful, this may be
660 * less than @len if there were partial characters
661 * at the end of the input.
662 * @bytes_written: the number of bytes stored in the output buffer (not
663 * including the terminating nul).
664 * @error: location to store the error occuring, or %NULL to ignore
665 * errors. Any of the errors in #GConvertError may occur.
667 * Converts a string from one character set to another, possibly
668 * including fallback sequences for characters not representable
669 * in the output. Note that it is not guaranteed that the specification
670 * for the fallback sequences in @fallback will be honored. Some
671 * systems may do a approximate conversion from @from_codeset
672 * to @to_codeset in their iconv() functions,
673 * in which case GLib will simply return that approximate conversion.
675 * Return value: If the conversion was successful, a newly allocated
676 * nul-terminated string, which must be freed with
677 * g_free(). Otherwise %NULL and @error will be set.
680 g_convert_with_fallback (const gchar *str,
682 const gchar *to_codeset,
683 const gchar *from_codeset,
686 gsize *bytes_written,
692 const gchar *insert_str = NULL;
694 gsize inbytes_remaining;
695 const gchar *save_p = NULL;
696 gsize save_inbytes = 0;
697 gsize outbytes_remaining;
701 gboolean have_error = FALSE;
702 gboolean done = FALSE;
704 GError *local_error = NULL;
706 g_return_val_if_fail (str != NULL, NULL);
707 g_return_val_if_fail (to_codeset != NULL, NULL);
708 g_return_val_if_fail (from_codeset != NULL, NULL);
713 /* Try an exact conversion; we only proceed if this fails
714 * due to an illegal sequence in the input string.
716 dest = g_convert (str, len, to_codeset, from_codeset,
717 bytes_read, bytes_written, &local_error);
721 if (!g_error_matches (local_error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE))
723 g_propagate_error (error, local_error);
727 g_error_free (local_error);
731 /* No go; to proceed, we need a converter from "UTF-8" to
732 * to_codeset, and the string as UTF-8.
734 cd = open_converter (to_codeset, "UTF-8", error);
735 if (cd == (GIConv) -1)
746 utf8 = g_convert (str, len, "UTF-8", from_codeset,
747 bytes_read, &inbytes_remaining, error);
750 close_converter (cd);
756 /* Now the heart of the code. We loop through the UTF-8 string, and
757 * whenever we hit an offending character, we form fallback, convert
758 * the fallback to the target codeset, and then go back to
759 * converting the original string after finishing with the fallback.
761 * The variables save_p and save_inbytes store the input state
762 * for the original string while we are converting the fallback
766 outbuf_size = len + 1; /* + 1 for nul in case len == 1 */
767 outbytes_remaining = outbuf_size - 1; /* -1 for nul */
768 outp = dest = g_malloc (outbuf_size);
770 while (!done && !have_error)
772 size_t inbytes_tmp = inbytes_remaining;
773 err = g_iconv (cd, (char **)&p, &inbytes_tmp, &outp, &outbytes_remaining);
774 inbytes_remaining = inbytes_tmp;
776 if (err == (size_t) -1)
781 g_assert_not_reached();
785 size_t used = outp - dest;
788 dest = g_realloc (dest, outbuf_size);
791 outbytes_remaining = outbuf_size - used - 1; /* -1 for nul */
798 /* Error converting fallback string - fatal
800 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
801 _("Cannot convert fallback '%s' to codeset '%s'"),
802 insert_str, to_codeset);
810 gunichar ch = g_utf8_get_char (p);
811 insert_str = g_strdup_printf (ch < 0x10000 ? "\\u%04x" : "\\U%08x",
815 insert_str = fallback;
817 save_p = g_utf8_next_char (p);
818 save_inbytes = inbytes_remaining - (save_p - p);
820 inbytes_remaining = strlen (p);
824 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
825 _("Error during conversion: %s"),
836 g_free ((gchar *)insert_str);
838 inbytes_remaining = save_inbytes;
850 close_converter (cd);
853 *bytes_written = outp - dest; /* Doesn't include '\0' */
859 if (save_p && !fallback)
860 g_free ((gchar *)insert_str);
875 strdup_len (const gchar *string,
877 gsize *bytes_written,
884 if (!g_utf8_validate (string, len, NULL))
891 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
892 _("Invalid byte sequence in conversion input"));
897 real_len = strlen (string);
902 while (real_len < len && string[real_len])
907 *bytes_read = real_len;
909 *bytes_written = real_len;
911 return g_strndup (string, real_len);
916 * @opsysstring: a string in the encoding of the current locale
917 * @len: the length of the string, or -1 if the string is
919 * @bytes_read: location to store the number of bytes in the
920 * input string that were successfully converted, or %NULL.
921 * Even if the conversion was successful, this may be
922 * less than @len if there were partial characters
923 * at the end of the input. If the error
924 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
925 * stored will the byte offset after the last valid
927 * @bytes_written: the number of bytes stored in the output buffer (not
928 * including the terminating nul).
929 * @error: location to store the error occuring, or %NULL to ignore
930 * errors. Any of the errors in #GConvertError may occur.
932 * Converts a string which is in the encoding used for strings by
933 * the C runtime (usually the same as that used by the operating
934 * system) in the current locale into a UTF-8 string.
936 * Return value: The converted string, or %NULL on an error.
939 g_locale_to_utf8 (const gchar *opsysstring,
942 gsize *bytes_written,
947 if (g_get_charset (&charset))
948 return strdup_len (opsysstring, len, bytes_read, bytes_written, error);
950 return g_convert (opsysstring, len,
951 "UTF-8", charset, bytes_read, bytes_written, error);
955 * g_locale_from_utf8:
956 * @utf8string: a UTF-8 encoded string
957 * @len: the length of the string, or -1 if the string is
959 * @bytes_read: location to store the number of bytes in the
960 * input string that were successfully converted, or %NULL.
961 * Even if the conversion was successful, this may be
962 * less than @len if there were partial characters
963 * at the end of the input. If the error
964 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
965 * stored will the byte offset after the last valid
967 * @bytes_written: the number of bytes stored in the output buffer (not
968 * including the terminating nul).
969 * @error: location to store the error occuring, or %NULL to ignore
970 * errors. Any of the errors in #GConvertError may occur.
972 * Converts a string from UTF-8 to the encoding used for strings by
973 * the C runtime (usually the same as that used by the operating
974 * system) in the current locale.
976 * Return value: The converted string, or %NULL on an error.
979 g_locale_from_utf8 (const gchar *utf8string,
982 gsize *bytes_written,
985 const gchar *charset;
987 if (g_get_charset (&charset))
988 return strdup_len (utf8string, len, bytes_read, bytes_written, error);
990 return g_convert (utf8string, len,
991 charset, "UTF-8", bytes_read, bytes_written, error);
994 #ifndef G_PLATFORM_WIN32
996 typedef struct _GFilenameCharsetCache GFilenameCharsetCache;
998 struct _GFilenameCharsetCache {
1001 gchar **filename_charsets;
1005 filename_charset_cache_free (gpointer data)
1007 GFilenameCharsetCache *cache = data;
1008 g_free (cache->charset);
1009 g_strfreev (cache->filename_charsets);
1014 * g_get_filename_charsets:
1015 * @charsets: return location for the %NULL-terminated list of encoding names
1017 * Determines the preferred character sets used for filenames.
1018 * The first character set from the @charsets is the filename encoding, the
1019 * subsequent character sets are used when trying to generate a displayable
1020 * representation of a filename, see g_filename_get_display_name().
1022 * The character sets are determined by consulting the environment variables
1023 * <envar>G_FILENAME_ENCODING</envar> and <envar>G_BROKEN_FILENAMES</envar>.
1025 * <envar>G_FILENAME_ENCODING</envar> may be set to a comma-separated list
1026 * of character set names. The special token "@locale" is taken to mean the
1027 * character set for the current locale. If <envar>G_FILENAME_ENCODING</envar>
1028 * is not set, but <envar>G_BROKEN_FILENAMES</envar> is, the character set of
1029 * the current locale is taken as the filename encoding. If neither environment
1030 * variable is set, UTF-8 is taken as the filename encoding, but the character
1031 * set of the current locale is also put in the list of encodings.
1033 * The returned @charsets belong to GLib and must not be freed.
1035 * Note that on Unix, regardless of the locale character set or
1036 * <envar>G_FILENAME_ENCODING</envar> value, the actual file names present on a
1037 * system might be in any random encoding or just gibberish.
1039 * Return value: %TRUE if the filename encoding is UTF-8.
1044 g_get_filename_charsets (G_CONST_RETURN gchar ***filename_charsets)
1046 static GStaticPrivate cache_private = G_STATIC_PRIVATE_INIT;
1047 GFilenameCharsetCache *cache = g_static_private_get (&cache_private);
1048 const gchar *charset;
1052 cache = g_new0 (GFilenameCharsetCache, 1);
1053 g_static_private_set (&cache_private, cache, filename_charset_cache_free);
1056 g_get_charset (&charset);
1058 if (!(cache->charset && strcmp (cache->charset, charset) == 0))
1060 const gchar *new_charset;
1064 g_free (cache->charset);
1065 g_strfreev (cache->filename_charsets);
1066 cache->charset = g_strdup (charset);
1068 p = getenv ("G_FILENAME_ENCODING");
1071 cache->filename_charsets = g_strsplit (p, ",", 0);
1072 cache->is_utf8 = (strcmp (cache->filename_charsets[0], "UTF-8") == 0);
1074 for (i = 0; cache->filename_charsets[i]; i++)
1076 if (strcmp ("@locale", cache->filename_charsets[i]) == 0)
1078 g_get_charset (&new_charset);
1079 g_free (cache->filename_charsets[i]);
1080 cache->filename_charsets[i] = g_strdup (new_charset);
1084 else if (getenv ("G_BROKEN_FILENAMES") != NULL)
1086 cache->filename_charsets = g_new0 (gchar *, 2);
1087 cache->is_utf8 = g_get_charset (&new_charset);
1088 cache->filename_charsets[0] = g_strdup (new_charset);
1092 cache->filename_charsets = g_new0 (gchar *, 3);
1093 cache->is_utf8 = TRUE;
1094 cache->filename_charsets[0] = g_strdup ("UTF-8");
1095 if (!g_get_charset (&new_charset))
1096 cache->filename_charsets[1] = g_strdup (new_charset);
1100 if (filename_charsets)
1101 *filename_charsets = (const gchar **)cache->filename_charsets;
1103 return cache->is_utf8;
1106 #else /* G_PLATFORM_WIN32 */
1109 g_get_filename_charsets (G_CONST_RETURN gchar ***filename_charsets)
1111 static gchar *charsets[] = {
1117 /* On Windows GLib pretends that the filename charset is UTF-8 */
1118 if (filename_charsets)
1119 *filename_charsets = charsets;
1125 /* Cygwin works like before */
1126 result = g_get_charset (&(charsets[0]));
1128 if (filename_charsets)
1129 *filename_charsets = charsets;
1135 #endif /* G_PLATFORM_WIN32 */
1138 get_filename_charset (const gchar **filename_charset)
1140 const gchar **charsets;
1143 is_utf8 = g_get_filename_charsets (&charsets);
1145 if (filename_charset)
1146 *filename_charset = charsets[0];
1151 /* This is called from g_thread_init(). It's used to
1152 * initialize some static data in a threadsafe way.
1155 _g_convert_thread_init (void)
1157 const gchar **dummy;
1158 (void) get_filename_charsets (&dummy);
1162 * g_filename_to_utf8:
1163 * @opsysstring: a string in the encoding for filenames
1164 * @len: the length of the string, or -1 if the string is
1166 * @bytes_read: location to store the number of bytes in the
1167 * input string that were successfully converted, or %NULL.
1168 * Even if the conversion was successful, this may be
1169 * less than @len if there were partial characters
1170 * at the end of the input. If the error
1171 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1172 * stored will the byte offset after the last valid
1174 * @bytes_written: the number of bytes stored in the output buffer (not
1175 * including the terminating nul).
1176 * @error: location to store the error occuring, or %NULL to ignore
1177 * errors. Any of the errors in #GConvertError may occur.
1179 * Converts a string which is in the encoding used for filenames
1180 * into a UTF-8 string.
1182 * Return value: The converted string, or %NULL on an error.
1185 g_filename_to_utf8 (const gchar *opsysstring,
1188 gsize *bytes_written,
1191 const gchar *charset;
1193 if (get_filename_charset (&charset))
1194 return strdup_len (opsysstring, len, bytes_read, bytes_written, error);
1196 return g_convert (opsysstring, len,
1197 "UTF-8", charset, bytes_read, bytes_written, error);
1202 #undef g_filename_to_utf8
1204 /* Binary compatibility version. Not for newly compiled code. */
1207 g_filename_to_utf8 (const gchar *opsysstring,
1210 gsize *bytes_written,
1213 const gchar *charset;
1215 if (g_get_charset (&charset))
1216 return strdup_len (opsysstring, len, bytes_read, bytes_written, error);
1218 return g_convert (opsysstring, len,
1219 "UTF-8", charset, bytes_read, bytes_written, error);
1225 * g_filename_from_utf8:
1226 * @utf8string: a UTF-8 encoded string.
1227 * @len: the length of the string, or -1 if the string is
1229 * @bytes_read: location to store the number of bytes in the
1230 * input string that were successfully converted, or %NULL.
1231 * Even if the conversion was successful, this may be
1232 * less than @len if there were partial characters
1233 * at the end of the input. If the error
1234 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1235 * stored will the byte offset after the last valid
1237 * @bytes_written: the number of bytes stored in the output buffer (not
1238 * including the terminating nul).
1239 * @error: location to store the error occuring, or %NULL to ignore
1240 * errors. Any of the errors in #GConvertError may occur.
1242 * Converts a string from UTF-8 to the encoding used for filenames.
1244 * Return value: The converted string, or %NULL on an error.
1247 g_filename_from_utf8 (const gchar *utf8string,
1250 gsize *bytes_written,
1253 const gchar *charset;
1255 if (get_filename_charset (&charset))
1256 return strdup_len (utf8string, len, bytes_read, bytes_written, error);
1258 return g_convert (utf8string, len,
1259 charset, "UTF-8", bytes_read, bytes_written, error);
1264 #undef g_filename_from_utf8
1266 /* Binary compatibility version. Not for newly compiled code. */
1269 g_filename_from_utf8 (const gchar *utf8string,
1272 gsize *bytes_written,
1275 const gchar *charset;
1277 if (g_get_charset (&charset))
1278 return strdup_len (utf8string, len, bytes_read, bytes_written, error);
1280 return g_convert (utf8string, len,
1281 charset, "UTF-8", bytes_read, bytes_written, error);
1286 /* Test of haystack has the needle prefix, comparing case
1287 * insensitive. haystack may be UTF-8, but needle must
1288 * contain only ascii. */
1290 has_case_prefix (const gchar *haystack, const gchar *needle)
1294 /* Eat one character at a time. */
1299 g_ascii_tolower (*n) == g_ascii_tolower (*h))
1309 UNSAFE_ALL = 0x1, /* Escape all unsafe characters */
1310 UNSAFE_ALLOW_PLUS = 0x2, /* Allows '+' */
1311 UNSAFE_PATH = 0x8, /* Allows '/', '&', '=', ':', '@', '+', '$' and ',' */
1312 UNSAFE_HOST = 0x10, /* Allows '/' and ':' and '@' */
1313 UNSAFE_SLASHES = 0x20 /* Allows all characters except for '/' and '%' */
1314 } UnsafeCharacterSet;
1316 static const guchar acceptable[96] = {
1317 /* A table of the ASCII chars from space (32) to DEL (127) */
1318 /* ! " # $ % & ' ( ) * + , - . / */
1319 0x00,0x3F,0x20,0x20,0x28,0x00,0x2C,0x3F,0x3F,0x3F,0x3F,0x2A,0x28,0x3F,0x3F,0x1C,
1320 /* 0 1 2 3 4 5 6 7 8 9 : ; < = > ? */
1321 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x38,0x20,0x20,0x2C,0x20,0x20,
1322 /* @ A B C D E F G H I J K L M N O */
1323 0x38,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,
1324 /* P Q R S T U V W X Y Z [ \ ] ^ _ */
1325 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x20,0x20,0x20,0x20,0x3F,
1326 /* ` a b c d e f g h i j k l m n o */
1327 0x20,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,
1328 /* p q r s t u v w x y z { | } ~ DEL */
1329 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x20,0x20,0x20,0x3F,0x20
1332 static const gchar hex[16] = "0123456789ABCDEF";
1334 /* Note: This escape function works on file: URIs, but if you want to
1335 * escape something else, please read RFC-2396 */
1337 g_escape_uri_string (const gchar *string,
1338 UnsafeCharacterSet mask)
1340 #define ACCEPTABLE(a) ((a)>=32 && (a)<128 && (acceptable[(a)-32] & use_mask))
1347 UnsafeCharacterSet use_mask;
1349 g_return_val_if_fail (mask == UNSAFE_ALL
1350 || mask == UNSAFE_ALLOW_PLUS
1351 || mask == UNSAFE_PATH
1352 || mask == UNSAFE_HOST
1353 || mask == UNSAFE_SLASHES, NULL);
1357 for (p = string; *p != '\0'; p++)
1360 if (!ACCEPTABLE (c))
1364 result = g_malloc (p - string + unacceptable * 2 + 1);
1367 for (q = result, p = string; *p != '\0'; p++)
1371 if (!ACCEPTABLE (c))
1373 *q++ = '%'; /* means hex coming */
1388 g_escape_file_uri (const gchar *hostname,
1389 const gchar *pathname)
1391 char *escaped_hostname = NULL;
1396 char *p, *backslash;
1398 /* Turn backslashes into forward slashes. That's what Netscape
1399 * does, and they are actually more or less equivalent in Windows.
1402 pathname = g_strdup (pathname);
1403 p = (char *) pathname;
1405 while ((backslash = strchr (p, '\\')) != NULL)
1412 if (hostname && *hostname != '\0')
1414 escaped_hostname = g_escape_uri_string (hostname, UNSAFE_HOST);
1417 escaped_path = g_escape_uri_string (pathname, UNSAFE_PATH);
1419 res = g_strconcat ("file://",
1420 (escaped_hostname) ? escaped_hostname : "",
1421 (*escaped_path != '/') ? "/" : "",
1426 g_free ((char *) pathname);
1429 g_free (escaped_hostname);
1430 g_free (escaped_path);
1436 unescape_character (const char *scanner)
1441 first_digit = g_ascii_xdigit_value (scanner[0]);
1442 if (first_digit < 0)
1445 second_digit = g_ascii_xdigit_value (scanner[1]);
1446 if (second_digit < 0)
1449 return (first_digit << 4) | second_digit;
1453 g_unescape_uri_string (const char *escaped,
1455 const char *illegal_escaped_characters,
1456 gboolean ascii_must_not_be_escaped)
1458 const gchar *in, *in_end;
1459 gchar *out, *result;
1462 if (escaped == NULL)
1466 len = strlen (escaped);
1468 result = g_malloc (len + 1);
1471 for (in = escaped, in_end = escaped + len; in < in_end; in++)
1477 /* catch partial escape sequences past the end of the substring */
1478 if (in + 3 > in_end)
1481 c = unescape_character (in + 1);
1483 /* catch bad escape sequences and NUL characters */
1487 /* catch escaped ASCII */
1488 if (ascii_must_not_be_escaped && c <= 0x7F)
1491 /* catch other illegal escaped characters */
1492 if (strchr (illegal_escaped_characters, c) != NULL)
1501 g_assert (out - result <= len);
1514 is_asciialphanum (gunichar c)
1516 return c <= 0x7F && g_ascii_isalnum (c);
1520 is_asciialpha (gunichar c)
1522 return c <= 0x7F && g_ascii_isalpha (c);
1525 /* allows an empty string */
1527 hostname_validate (const char *hostname)
1530 gunichar c, first_char, last_char;
1537 /* read in a label */
1538 c = g_utf8_get_char (p);
1539 p = g_utf8_next_char (p);
1540 if (!is_asciialphanum (c))
1546 c = g_utf8_get_char (p);
1547 p = g_utf8_next_char (p);
1549 while (is_asciialphanum (c) || c == '-');
1550 if (last_char == '-')
1553 /* if that was the last label, check that it was a toplabel */
1554 if (c == '\0' || (c == '.' && *p == '\0'))
1555 return is_asciialpha (first_char);
1562 * g_filename_from_uri:
1563 * @uri: a uri describing a filename (escaped, encoded in ASCII).
1564 * @hostname: Location to store hostname for the URI, or %NULL.
1565 * If there is no hostname in the URI, %NULL will be
1566 * stored in this location.
1567 * @error: location to store the error occuring, or %NULL to ignore
1568 * errors. Any of the errors in #GConvertError may occur.
1570 * Converts an escaped ASCII-encoded URI to a local filename in the
1571 * encoding used for filenames.
1573 * Return value: a newly-allocated string holding the resulting
1574 * filename, or %NULL on an error.
1577 g_filename_from_uri (const gchar *uri,
1581 const char *path_part;
1582 const char *host_part;
1583 char *unescaped_hostname;
1594 if (!has_case_prefix (uri, "file:/"))
1596 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1597 _("The URI '%s' is not an absolute URI using the \"file\" scheme"),
1602 path_part = uri + strlen ("file:");
1604 if (strchr (path_part, '#') != NULL)
1606 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1607 _("The local file URI '%s' may not include a '#'"),
1612 if (has_case_prefix (path_part, "///"))
1614 else if (has_case_prefix (path_part, "//"))
1617 host_part = path_part;
1619 path_part = strchr (path_part, '/');
1621 if (path_part == NULL)
1623 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1624 _("The URI '%s' is invalid"),
1629 unescaped_hostname = g_unescape_uri_string (host_part, path_part - host_part, "", TRUE);
1631 if (unescaped_hostname == NULL ||
1632 !hostname_validate (unescaped_hostname))
1634 g_free (unescaped_hostname);
1635 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1636 _("The hostname of the URI '%s' is invalid"),
1642 *hostname = unescaped_hostname;
1644 g_free (unescaped_hostname);
1647 filename = g_unescape_uri_string (path_part, -1, "/", FALSE);
1649 if (filename == NULL)
1651 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1652 _("The URI '%s' contains invalidly escaped characters"),
1659 /* Drop localhost */
1660 if (hostname && *hostname != NULL &&
1661 g_ascii_strcasecmp (*hostname, "localhost") == 0)
1667 /* Turn slashes into backslashes, because that's the canonical spelling */
1669 while ((slash = strchr (p, '/')) != NULL)
1675 /* Windows URIs with a drive letter can be like "file://host/c:/foo"
1676 * or "file://host/c|/foo" (some Netscape versions). In those cases, start
1677 * the filename from the drive letter.
1679 if (g_ascii_isalpha (filename[1]))
1681 if (filename[2] == ':')
1683 else if (filename[2] == '|')
1691 result = g_strdup (filename + offs);
1698 * g_filename_to_uri:
1699 * @filename: an absolute filename specified in the encoding
1700 * used for filenames by the operating system.
1701 * @hostname: A UTF-8 encoded hostname, or %NULL for none.
1702 * @error: location to store the error occuring, or %NULL to ignore
1703 * errors. Any of the errors in #GConvertError may occur.
1705 * Converts an absolute filename to an escaped ASCII-encoded URI.
1707 * Return value: a newly-allocated string holding the resulting
1708 * URI, or %NULL on an error.
1711 g_filename_to_uri (const gchar *filename,
1712 const gchar *hostname,
1717 g_return_val_if_fail (filename != NULL, NULL);
1719 if (!g_path_is_absolute (filename))
1721 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_NOT_ABSOLUTE_PATH,
1722 _("The pathname '%s' is not an absolute path"),
1728 !(g_utf8_validate (hostname, -1, NULL)
1729 && hostname_validate (hostname)))
1731 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1732 _("Invalid hostname"));
1737 /* Don't use localhost unnecessarily */
1738 if (hostname && g_ascii_strcasecmp (hostname, "localhost") == 0)
1742 escaped_uri = g_escape_file_uri (hostname, filename);
1748 * g_uri_list_extract_uris:
1749 * @uri_list: an URI list
1751 * Splits an URI list conforming to the text/uri-list
1752 * mime type defined in RFC 2483 into individual URIs,
1753 * discarding any comments. The URIs are not validated.
1755 * Returns: a newly allocated %NULL-terminated list of
1756 * strings holding the individual URIs. The array should
1757 * be freed with g_strfreev().
1762 g_uri_list_extract_uris (const gchar *uri_list)
1773 /* We don't actually try to validate the URI according to RFC
1774 * 2396, or even check for allowed characters - we just ignore
1775 * comments and trim whitespace off the ends. We also
1776 * allow LF delimination as well as the specified CRLF.
1778 * We do allow comments like specified in RFC 2483.
1784 while (g_ascii_isspace (*p))
1788 while (*q && (*q != '\n') && (*q != '\r'))
1794 while (q > p && g_ascii_isspace (*q))
1799 uris = g_slist_prepend (uris, g_strndup (p, q - p + 1));
1804 p = strchr (p, '\n');
1809 result = g_new (gchar *, n_uris + 1);
1811 result[n_uris--] = NULL;
1812 for (u = uris; u; u = u->next)
1813 result[n_uris--] = u->data;
1815 g_slist_free (uris);
1821 make_valid_utf8 (const gchar *name)
1824 const gchar *remainder, *invalid;
1825 gint remaining_bytes, valid_bytes;
1829 remaining_bytes = strlen (name);
1831 while (remaining_bytes != 0)
1833 if (g_utf8_validate (remainder, remaining_bytes, &invalid))
1835 valid_bytes = invalid - remainder;
1838 string = g_string_sized_new (remaining_bytes);
1840 g_string_append_len (string, remainder, valid_bytes);
1841 g_string_append_c (string, '?');
1843 remaining_bytes -= valid_bytes + 1;
1844 remainder = invalid + 1;
1848 return g_strdup (name);
1850 g_string_append (string, remainder);
1851 g_string_append (string, " (invalid encoding)");
1853 g_assert (g_utf8_validate (string->str, -1, NULL));
1855 return g_string_free (string, FALSE);
1859 * g_filename_display_name:
1860 * @filename: a pathname in the GLib filename encoding
1862 * Converts a filename into a valid UTF-8 string. The
1863 * conversion is not necessarily reversible, so you
1864 * should keep the original around and use the return
1865 * value of this function only for display purposes.
1867 * Return value: a newly allocated string containing
1868 * a rendition of the filename in valid UTF-8
1873 g_filename_display_name (const gchar *filename)
1876 const gchar **charsets;
1877 gchar *display_name = NULL;
1880 is_utf8 = g_get_filename_charsets (&charsets);
1884 if (g_utf8_validate (filename, -1, NULL))
1885 display_name = g_strdup (filename);
1890 /* Try to convert from the filename charsets to UTF-8.
1891 * Skip the first charset if it is UTF-8.
1893 for (i = is_utf8 ? 1 : 0; charsets[i]; i++)
1895 display_name = g_convert (filename, -1, "UTF-8", charsets[i],
1903 /* if all conversions failed, we replace invalid UTF-8
1904 * by a question mark
1907 display_name = make_valid_utf8 (filename);
1909 return display_name;