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.
32 #include "gprintfint.h"
33 #include "gthreadinit.h"
35 #ifdef G_PLATFORM_WIN32
43 #if defined(USE_LIBICONV_GNU) && !defined (_LIBICONV_H)
44 #error GNU libiconv in use but included iconv.h not from libiconv
46 #if !defined(USE_LIBICONV_GNU) && defined (_LIBICONV_H)
47 #error GNU libiconv not in use but included iconv.h is from libiconv
53 g_convert_error_quark (void)
57 quark = g_quark_from_static_string ("g_convert_error");
63 try_conversion (const char *to_codeset,
64 const char *from_codeset,
67 *cd = iconv_open (to_codeset, from_codeset);
69 if (*cd == (iconv_t)-1 && errno == EINVAL)
76 try_to_aliases (const char **to_aliases,
77 const char *from_codeset,
82 const char **p = to_aliases;
85 if (try_conversion (*p, from_codeset, cd))
95 extern const char **_g_charset_get_aliases (const char *canonical_name) G_GNUC_INTERNAL;
99 * @to_codeset: destination codeset
100 * @from_codeset: source codeset
102 * Same as the standard UNIX routine iconv_open(), but
103 * may be implemented via libiconv on UNIX flavors that lack
104 * a native implementation.
106 * GLib provides g_convert() and g_locale_to_utf8() which are likely
107 * more convenient than the raw iconv wrappers.
109 * Return value: a "conversion descriptor", or (GIConv)-1 if
110 * opening the converter failed.
113 g_iconv_open (const gchar *to_codeset,
114 const gchar *from_codeset)
118 if (!try_conversion (to_codeset, from_codeset, &cd))
120 const char **to_aliases = _g_charset_get_aliases (to_codeset);
121 const char **from_aliases = _g_charset_get_aliases (from_codeset);
125 const char **p = from_aliases;
128 if (try_conversion (to_codeset, *p, &cd))
131 if (try_to_aliases (to_aliases, *p, &cd))
138 if (try_to_aliases (to_aliases, from_codeset, &cd))
143 return (cd == (iconv_t)-1) ? (GIConv)-1 : (GIConv)cd;
148 * @converter: conversion descriptor from g_iconv_open()
149 * @inbuf: bytes to convert
150 * @inbytes_left: inout parameter, bytes remaining to convert in @inbuf
151 * @outbuf: converted output bytes
152 * @outbytes_left: inout parameter, bytes available to fill in @outbuf
154 * Same as the standard UNIX routine iconv(), but
155 * may be implemented via libiconv on UNIX flavors that lack
156 * a native implementation.
158 * GLib provides g_convert() and g_locale_to_utf8() which are likely
159 * more convenient than the raw iconv wrappers.
161 * Return value: count of non-reversible conversions, or -1 on error
164 g_iconv (GIConv converter,
168 gsize *outbytes_left)
170 iconv_t cd = (iconv_t)converter;
172 return iconv (cd, inbuf, inbytes_left, outbuf, outbytes_left);
177 * @converter: a conversion descriptor from g_iconv_open()
179 * Same as the standard UNIX routine iconv_close(), but
180 * may be implemented via libiconv on UNIX flavors that lack
181 * a native implementation. Should be called to clean up
182 * the conversion descriptor from g_iconv_open() when
183 * you are done converting things.
185 * GLib provides g_convert() and g_locale_to_utf8() which are likely
186 * more convenient than the raw iconv wrappers.
188 * Return value: -1 on error, 0 on success
191 g_iconv_close (GIConv converter)
193 iconv_t cd = (iconv_t)converter;
195 return iconv_close (cd);
199 #ifdef NEED_ICONV_CACHE
201 #define ICONV_CACHE_SIZE (16)
203 struct _iconv_cache_bucket {
210 static GList *iconv_cache_list;
211 static GHashTable *iconv_cache;
212 static GHashTable *iconv_open_hash;
213 static guint iconv_cache_size = 0;
214 G_LOCK_DEFINE_STATIC (iconv_cache_lock);
216 /* caller *must* hold the iconv_cache_lock */
218 iconv_cache_init (void)
220 static gboolean initialized = FALSE;
225 iconv_cache_list = NULL;
226 iconv_cache = g_hash_table_new (g_str_hash, g_str_equal);
227 iconv_open_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
234 * iconv_cache_bucket_new:
236 * @cd: iconv descriptor
238 * Creates a new cache bucket, inserts it into the cache and
239 * increments the cache size.
241 * Returns a pointer to the newly allocated cache bucket.
243 static struct _iconv_cache_bucket *
244 iconv_cache_bucket_new (const gchar *key, GIConv cd)
246 struct _iconv_cache_bucket *bucket;
248 bucket = g_new (struct _iconv_cache_bucket, 1);
249 bucket->key = g_strdup (key);
250 bucket->refcount = 1;
254 g_hash_table_insert (iconv_cache, bucket->key, bucket);
256 /* FIXME: if we sorted the list so items with few refcounts were
257 first, then we could expire them faster in iconv_cache_expire_unused () */
258 iconv_cache_list = g_list_prepend (iconv_cache_list, bucket);
267 * iconv_cache_bucket_expire:
268 * @node: cache bucket's node
269 * @bucket: cache bucket
271 * Expires a single cache bucket @bucket. This should only ever be
272 * called on a bucket that currently has no used iconv descriptors
275 * @node is not a required argument. If @node is not supplied, we
276 * search for it ourselves.
279 iconv_cache_bucket_expire (GList *node, struct _iconv_cache_bucket *bucket)
281 g_hash_table_remove (iconv_cache, bucket->key);
284 node = g_list_find (iconv_cache_list, bucket);
286 g_assert (node != NULL);
290 node->prev->next = node->next;
292 node->next->prev = node->prev;
296 iconv_cache_list = node->next;
298 node->next->prev = NULL;
301 g_list_free_1 (node);
303 g_free (bucket->key);
304 g_iconv_close (bucket->cd);
312 * iconv_cache_expire_unused:
314 * Expires as many unused cache buckets as it needs to in order to get
315 * the total number of buckets < ICONV_CACHE_SIZE.
318 iconv_cache_expire_unused (void)
320 struct _iconv_cache_bucket *bucket;
323 node = iconv_cache_list;
324 while (node && iconv_cache_size >= ICONV_CACHE_SIZE)
329 if (bucket->refcount == 0)
330 iconv_cache_bucket_expire (node, bucket);
337 open_converter (const gchar *to_codeset,
338 const gchar *from_codeset,
341 struct _iconv_cache_bucket *bucket;
346 key = g_alloca (strlen (from_codeset) + strlen (to_codeset) + 2);
347 _g_sprintf (key, "%s:%s", from_codeset, to_codeset);
349 G_LOCK (iconv_cache_lock);
351 /* make sure the cache has been initialized */
354 bucket = g_hash_table_lookup (iconv_cache, key);
359 cd = g_iconv_open (to_codeset, from_codeset);
360 if (cd == (GIConv) -1)
365 /* Apparently iconv on Solaris <= 7 segfaults if you pass in
366 * NULL for anything but inbuf; work around that. (NULL outbuf
367 * or NULL *outbuf is allowed by Unix98.)
369 gsize inbytes_left = 0;
370 gchar *outbuf = NULL;
371 gsize outbytes_left = 0;
376 /* reset the descriptor */
377 g_iconv (cd, NULL, &inbytes_left, &outbuf, &outbytes_left);
384 cd = g_iconv_open (to_codeset, from_codeset);
385 if (cd == (GIConv) -1)
388 iconv_cache_expire_unused ();
390 bucket = iconv_cache_bucket_new (key, cd);
393 g_hash_table_insert (iconv_open_hash, cd, bucket->key);
395 G_UNLOCK (iconv_cache_lock);
401 G_UNLOCK (iconv_cache_lock);
403 /* Something went wrong. */
407 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_NO_CONVERSION,
408 _("Conversion from character set '%s' to '%s' is not supported"),
409 from_codeset, to_codeset);
411 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
412 _("Could not open converter from '%s' to '%s'"),
413 from_codeset, to_codeset);
420 close_converter (GIConv converter)
422 struct _iconv_cache_bucket *bucket;
428 if (cd == (GIConv) -1)
431 G_LOCK (iconv_cache_lock);
433 key = g_hash_table_lookup (iconv_open_hash, cd);
436 g_hash_table_remove (iconv_open_hash, cd);
438 bucket = g_hash_table_lookup (iconv_cache, key);
443 if (cd == bucket->cd)
444 bucket->used = FALSE;
448 if (!bucket->refcount && iconv_cache_size > ICONV_CACHE_SIZE)
450 /* expire this cache bucket */
451 iconv_cache_bucket_expire (NULL, bucket);
456 G_UNLOCK (iconv_cache_lock);
458 g_warning ("This iconv context wasn't opened using open_converter");
460 return g_iconv_close (converter);
463 G_UNLOCK (iconv_cache_lock);
468 #else /* !NEED_ICONV_CACHE */
471 open_converter (const gchar *to_codeset,
472 const gchar *from_codeset,
477 cd = g_iconv_open (to_codeset, from_codeset);
479 if (cd == (GIConv) -1)
481 /* Something went wrong. */
485 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_NO_CONVERSION,
486 _("Conversion from character set '%s' to '%s' is not supported"),
487 from_codeset, to_codeset);
489 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
490 _("Could not open converter from '%s' to '%s'"),
491 from_codeset, to_codeset);
499 close_converter (GIConv cd)
501 if (cd == (GIConv) -1)
504 return g_iconv_close (cd);
507 #endif /* NEED_ICONV_CACHE */
510 * g_convert_with_iconv:
511 * @str: the string to convert
512 * @len: the length of the string, or -1 if the string is
513 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
514 * @converter: conversion descriptor from g_iconv_open()
515 * @bytes_read: location to store the number of bytes in the
516 * input string that were successfully converted, or %NULL.
517 * Even if the conversion was successful, this may be
518 * less than @len if there were partial characters
519 * at the end of the input. If the error
520 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
521 * stored will the byte offset after the last valid
523 * @bytes_written: the number of bytes stored in the output buffer (not
524 * including the terminating nul).
525 * @error: location to store the error occuring, or %NULL to ignore
526 * errors. Any of the errors in #GConvertError may occur.
528 * Converts a string from one character set to another.
530 * Note that you should use g_iconv() for streaming
531 * conversions<footnote id="streaming-state">
533 * Despite the fact that @byes_read can return information about partial
534 * characters, the <literal>g_convert_...</literal> functions
535 * are not generally suitable for streaming. If the underlying converter
536 * being used maintains internal state, then this won't be preserved
537 * across successive calls to g_convert(), g_convert_with_iconv() or
538 * g_convert_with_fallback(). (An example of this is the GNU C converter
539 * for CP1255 which does not emit a base character until it knows that
540 * the next character is not a mark that could combine with the base
545 * Return value: If the conversion was successful, a newly allocated
546 * nul-terminated string, which must be freed with
547 * g_free(). Otherwise %NULL and @error will be set.
550 g_convert_with_iconv (const gchar *str,
554 gsize *bytes_written,
560 const gchar *shift_p = NULL;
561 gsize inbytes_remaining;
562 gsize outbytes_remaining;
565 gboolean have_error = FALSE;
566 gboolean done = FALSE;
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);
580 while (!done && !have_error)
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 */
594 size_t used = outp - dest;
597 dest = g_realloc (dest, outbuf_size);
600 outbytes_remaining = outbuf_size - used - 1; /* -1 for nul */
605 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
606 _("Invalid byte sequence in conversion input"));
611 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
612 _("Error during conversion: %s"),
622 /* call g_iconv with NULL inbuf to cleanup shift state */
625 inbytes_remaining = 0;
638 *bytes_read = p - str;
641 if ((p - str) != len)
646 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
647 _("Partial character sequence at end of input"));
654 *bytes_written = outp - dest; /* Doesn't include '\0' */
667 * @str: the string to convert
668 * @len: the length of the string, or -1 if the string is
669 * nul-terminated<footnote id="nul-unsafe">
671 Note that some encodings may allow nul bytes to
672 occur inside strings. In that case, using -1 for
673 the @len parameter is unsafe.
676 * @to_codeset: name of character set into which to convert @str
677 * @from_codeset: character set of @str.
678 * @bytes_read: location to store the number of bytes in the
679 * input string that were successfully converted, or %NULL.
680 * Even if the conversion was successful, this may be
681 * less than @len if there were partial characters
682 * at the end of the input. If the error
683 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
684 * stored will the byte offset after the last valid
686 * @bytes_written: the number of bytes stored in the output buffer (not
687 * including the terminating nul).
688 * @error: location to store the error occuring, or %NULL to ignore
689 * errors. Any of the errors in #GConvertError may occur.
691 * Converts a string from one character set to another.
693 * Note that you should use g_iconv() for streaming
694 * conversions<footnoteref linkend="streaming-state"/>.
696 * Return value: If the conversion was successful, a newly allocated
697 * nul-terminated string, which must be freed with
698 * g_free(). Otherwise %NULL and @error will be set.
701 g_convert (const gchar *str,
703 const gchar *to_codeset,
704 const gchar *from_codeset,
706 gsize *bytes_written,
712 g_return_val_if_fail (str != NULL, NULL);
713 g_return_val_if_fail (to_codeset != NULL, NULL);
714 g_return_val_if_fail (from_codeset != NULL, NULL);
716 cd = open_converter (to_codeset, from_codeset, error);
718 if (cd == (GIConv) -1)
729 res = g_convert_with_iconv (str, len, cd,
730 bytes_read, bytes_written,
733 close_converter (cd);
739 * g_convert_with_fallback:
740 * @str: the string to convert
741 * @len: the length of the string, or -1 if the string is
742 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
743 * @to_codeset: name of character set into which to convert @str
744 * @from_codeset: character set of @str.
745 * @fallback: UTF-8 string to use in place of character not
746 * present in the target encoding. (The string must be
747 * representable in the target encoding).
748 If %NULL, characters not in the target encoding will
749 be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
750 * @bytes_read: location to store the number of bytes in the
751 * input string that were successfully converted, or %NULL.
752 * Even if the conversion was successful, this may be
753 * less than @len if there were partial characters
754 * at the end of the input.
755 * @bytes_written: the number of bytes stored in the output buffer (not
756 * including the terminating nul).
757 * @error: location to store the error occuring, or %NULL to ignore
758 * errors. Any of the errors in #GConvertError may occur.
760 * Converts a string from one character set to another, possibly
761 * including fallback sequences for characters not representable
762 * in the output. Note that it is not guaranteed that the specification
763 * for the fallback sequences in @fallback will be honored. Some
764 * systems may do a approximate conversion from @from_codeset
765 * to @to_codeset in their iconv() functions,
766 * in which case GLib will simply return that approximate conversion.
768 * Note that you should use g_iconv() for streaming
769 * conversions<footnoteref linkend="streaming-state"/>.
771 * Return value: If the conversion was successful, a newly allocated
772 * nul-terminated string, which must be freed with
773 * g_free(). Otherwise %NULL and @error will be set.
776 g_convert_with_fallback (const gchar *str,
778 const gchar *to_codeset,
779 const gchar *from_codeset,
782 gsize *bytes_written,
788 const gchar *insert_str = NULL;
790 gsize inbytes_remaining;
791 const gchar *save_p = NULL;
792 gsize save_inbytes = 0;
793 gsize outbytes_remaining;
797 gboolean have_error = FALSE;
798 gboolean done = FALSE;
800 GError *local_error = NULL;
802 g_return_val_if_fail (str != NULL, NULL);
803 g_return_val_if_fail (to_codeset != NULL, NULL);
804 g_return_val_if_fail (from_codeset != NULL, NULL);
809 /* Try an exact conversion; we only proceed if this fails
810 * due to an illegal sequence in the input string.
812 dest = g_convert (str, len, to_codeset, from_codeset,
813 bytes_read, bytes_written, &local_error);
817 if (!g_error_matches (local_error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE))
819 g_propagate_error (error, local_error);
823 g_error_free (local_error);
827 /* No go; to proceed, we need a converter from "UTF-8" to
828 * to_codeset, and the string as UTF-8.
830 cd = open_converter (to_codeset, "UTF-8", error);
831 if (cd == (GIConv) -1)
842 utf8 = g_convert (str, len, "UTF-8", from_codeset,
843 bytes_read, &inbytes_remaining, error);
846 close_converter (cd);
852 /* Now the heart of the code. We loop through the UTF-8 string, and
853 * whenever we hit an offending character, we form fallback, convert
854 * the fallback to the target codeset, and then go back to
855 * converting the original string after finishing with the fallback.
857 * The variables save_p and save_inbytes store the input state
858 * for the original string while we are converting the fallback
862 outbuf_size = len + 1; /* + 1 for nul in case len == 1 */
863 outbytes_remaining = outbuf_size - 1; /* -1 for nul */
864 outp = dest = g_malloc (outbuf_size);
866 while (!done && !have_error)
868 size_t inbytes_tmp = inbytes_remaining;
869 err = g_iconv (cd, (char **)&p, &inbytes_tmp, &outp, &outbytes_remaining);
870 inbytes_remaining = inbytes_tmp;
872 if (err == (size_t) -1)
877 g_assert_not_reached();
881 size_t used = outp - dest;
884 dest = g_realloc (dest, outbuf_size);
887 outbytes_remaining = outbuf_size - used - 1; /* -1 for nul */
894 /* Error converting fallback string - fatal
896 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
897 _("Cannot convert fallback '%s' to codeset '%s'"),
898 insert_str, to_codeset);
906 gunichar ch = g_utf8_get_char (p);
907 insert_str = g_strdup_printf (ch < 0x10000 ? "\\u%04x" : "\\U%08x",
911 insert_str = fallback;
913 save_p = g_utf8_next_char (p);
914 save_inbytes = inbytes_remaining - (save_p - p);
916 inbytes_remaining = strlen (p);
919 /* fall thru if p is NULL */
921 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
922 _("Error during conversion: %s"),
933 g_free ((gchar *)insert_str);
935 inbytes_remaining = save_inbytes;
940 /* call g_iconv with NULL inbuf to cleanup shift state */
942 inbytes_remaining = 0;
953 close_converter (cd);
956 *bytes_written = outp - dest; /* Doesn't include '\0' */
962 if (save_p && !fallback)
963 g_free ((gchar *)insert_str);
978 strdup_len (const gchar *string,
980 gsize *bytes_written,
987 if (!g_utf8_validate (string, len, NULL))
994 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
995 _("Invalid byte sequence in conversion input"));
1000 real_len = strlen (string);
1005 while (real_len < len && string[real_len])
1010 *bytes_read = real_len;
1012 *bytes_written = real_len;
1014 return g_strndup (string, real_len);
1019 * @opsysstring: a string in the encoding of the current locale. On Windows
1020 * this means the system codepage.
1021 * @len: the length of the string, or -1 if the string is
1022 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
1023 * @bytes_read: location to store the number of bytes in the
1024 * input string that were successfully converted, or %NULL.
1025 * Even if the conversion was successful, this may be
1026 * less than @len if there were partial characters
1027 * at the end of the input. If the error
1028 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1029 * stored will the byte offset after the last valid
1031 * @bytes_written: the number of bytes stored in the output buffer (not
1032 * including the terminating nul).
1033 * @error: location to store the error occuring, or %NULL to ignore
1034 * errors. Any of the errors in #GConvertError may occur.
1036 * Converts a string which is in the encoding used for strings by
1037 * the C runtime (usually the same as that used by the operating
1038 * system) in the current locale into a UTF-8 string.
1040 * Return value: The converted string, or %NULL on an error.
1043 g_locale_to_utf8 (const gchar *opsysstring,
1046 gsize *bytes_written,
1049 const char *charset;
1051 if (g_get_charset (&charset))
1052 return strdup_len (opsysstring, len, bytes_read, bytes_written, error);
1054 return g_convert (opsysstring, len,
1055 "UTF-8", charset, bytes_read, bytes_written, error);
1059 * g_locale_from_utf8:
1060 * @utf8string: a UTF-8 encoded string
1061 * @len: the length of the string, or -1 if the string is
1062 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
1063 * @bytes_read: location to store the number of bytes in the
1064 * input string that were successfully converted, or %NULL.
1065 * Even if the conversion was successful, this may be
1066 * less than @len if there were partial characters
1067 * at the end of the input. If the error
1068 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1069 * stored will the byte offset after the last valid
1071 * @bytes_written: the number of bytes stored in the output buffer (not
1072 * including the terminating nul).
1073 * @error: location to store the error occuring, or %NULL to ignore
1074 * errors. Any of the errors in #GConvertError may occur.
1076 * Converts a string from UTF-8 to the encoding used for strings by
1077 * the C runtime (usually the same as that used by the operating
1078 * system) in the current locale.
1080 * Return value: The converted string, or %NULL on an error.
1083 g_locale_from_utf8 (const gchar *utf8string,
1086 gsize *bytes_written,
1089 const gchar *charset;
1091 if (g_get_charset (&charset))
1092 return strdup_len (utf8string, len, bytes_read, bytes_written, error);
1094 return g_convert (utf8string, len,
1095 charset, "UTF-8", bytes_read, bytes_written, error);
1098 #ifndef G_PLATFORM_WIN32
1100 typedef struct _GFilenameCharsetCache GFilenameCharsetCache;
1102 struct _GFilenameCharsetCache {
1105 gchar **filename_charsets;
1109 filename_charset_cache_free (gpointer data)
1111 GFilenameCharsetCache *cache = data;
1112 g_free (cache->charset);
1113 g_strfreev (cache->filename_charsets);
1118 * g_get_filename_charsets:
1119 * @charsets: return location for the %NULL-terminated list of encoding names
1121 * Determines the preferred character sets used for filenames.
1122 * The first character set from the @charsets is the filename encoding, the
1123 * subsequent character sets are used when trying to generate a displayable
1124 * representation of a filename, see g_filename_display_name().
1126 * On Unix, the character sets are determined by consulting the
1127 * environment variables <envar>G_FILENAME_ENCODING</envar> and
1128 * <envar>G_BROKEN_FILENAMES</envar>. On Windows, the character set
1129 * used in the GLib API is always UTF-8 and said environment variables
1132 * <envar>G_FILENAME_ENCODING</envar> may be set to a comma-separated list
1133 * of character set names. The special token "@locale" is taken to mean the
1134 * character set for the current locale. If <envar>G_FILENAME_ENCODING</envar>
1135 * is not set, but <envar>G_BROKEN_FILENAMES</envar> is, the character set of
1136 * the current locale is taken as the filename encoding. If neither environment
1137 * variable is set, UTF-8 is taken as the filename encoding, but the character
1138 * set of the current locale is also put in the list of encodings.
1140 * The returned @charsets belong to GLib and must not be freed.
1142 * Note that on Unix, regardless of the locale character set or
1143 * <envar>G_FILENAME_ENCODING</envar> value, the actual file names present on a
1144 * system might be in any random encoding or just gibberish.
1146 * Return value: %TRUE if the filename encoding is UTF-8.
1151 g_get_filename_charsets (G_CONST_RETURN gchar ***filename_charsets)
1153 static GStaticPrivate cache_private = G_STATIC_PRIVATE_INIT;
1154 GFilenameCharsetCache *cache = g_static_private_get (&cache_private);
1155 const gchar *charset;
1159 cache = g_new0 (GFilenameCharsetCache, 1);
1160 g_static_private_set (&cache_private, cache, filename_charset_cache_free);
1163 g_get_charset (&charset);
1165 if (!(cache->charset && strcmp (cache->charset, charset) == 0))
1167 const gchar *new_charset;
1171 g_free (cache->charset);
1172 g_strfreev (cache->filename_charsets);
1173 cache->charset = g_strdup (charset);
1175 p = getenv ("G_FILENAME_ENCODING");
1176 if (p != NULL && p[0] != '\0')
1178 cache->filename_charsets = g_strsplit (p, ",", 0);
1179 cache->is_utf8 = (strcmp (cache->filename_charsets[0], "UTF-8") == 0);
1181 for (i = 0; cache->filename_charsets[i]; i++)
1183 if (strcmp ("@locale", cache->filename_charsets[i]) == 0)
1185 g_get_charset (&new_charset);
1186 g_free (cache->filename_charsets[i]);
1187 cache->filename_charsets[i] = g_strdup (new_charset);
1191 else if (getenv ("G_BROKEN_FILENAMES") != NULL)
1193 cache->filename_charsets = g_new0 (gchar *, 2);
1194 cache->is_utf8 = g_get_charset (&new_charset);
1195 cache->filename_charsets[0] = g_strdup (new_charset);
1199 cache->filename_charsets = g_new0 (gchar *, 3);
1200 cache->is_utf8 = TRUE;
1201 cache->filename_charsets[0] = g_strdup ("UTF-8");
1202 if (!g_get_charset (&new_charset))
1203 cache->filename_charsets[1] = g_strdup (new_charset);
1207 if (filename_charsets)
1208 *filename_charsets = (const gchar **)cache->filename_charsets;
1210 return cache->is_utf8;
1213 #else /* G_PLATFORM_WIN32 */
1216 g_get_filename_charsets (G_CONST_RETURN gchar ***filename_charsets)
1218 static const gchar *charsets[] = {
1224 /* On Windows GLib pretends that the filename charset is UTF-8 */
1225 if (filename_charsets)
1226 *filename_charsets = charsets;
1232 /* Cygwin works like before */
1233 result = g_get_charset (&(charsets[0]));
1235 if (filename_charsets)
1236 *filename_charsets = charsets;
1242 #endif /* G_PLATFORM_WIN32 */
1245 get_filename_charset (const gchar **filename_charset)
1247 const gchar **charsets;
1250 is_utf8 = g_get_filename_charsets (&charsets);
1252 if (filename_charset)
1253 *filename_charset = charsets[0];
1258 /* This is called from g_thread_init(). It's used to
1259 * initialize some static data in a threadsafe way.
1262 _g_convert_thread_init (void)
1264 const gchar **dummy;
1265 (void) g_get_filename_charsets (&dummy);
1269 * g_filename_to_utf8:
1270 * @opsysstring: a string in the encoding for filenames
1271 * @len: the length of the string, or -1 if the string is
1272 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
1273 * @bytes_read: location to store the number of bytes in the
1274 * input string that were successfully converted, or %NULL.
1275 * Even if the conversion was successful, this may be
1276 * less than @len if there were partial characters
1277 * at the end of the input. If the error
1278 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1279 * stored will the byte offset after the last valid
1281 * @bytes_written: the number of bytes stored in the output buffer (not
1282 * including the terminating nul).
1283 * @error: location to store the error occuring, or %NULL to ignore
1284 * errors. Any of the errors in #GConvertError may occur.
1286 * Converts a string which is in the encoding used by GLib for
1287 * filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8
1290 * Return value: The converted string, or %NULL on an error.
1293 g_filename_to_utf8 (const gchar *opsysstring,
1296 gsize *bytes_written,
1299 const gchar *charset;
1301 if (get_filename_charset (&charset))
1302 return strdup_len (opsysstring, len, bytes_read, bytes_written, error);
1304 return g_convert (opsysstring, len,
1305 "UTF-8", charset, bytes_read, bytes_written, error);
1310 #undef g_filename_to_utf8
1312 /* Binary compatibility version. Not for newly compiled code. */
1315 g_filename_to_utf8 (const gchar *opsysstring,
1318 gsize *bytes_written,
1321 const gchar *charset;
1323 if (g_get_charset (&charset))
1324 return strdup_len (opsysstring, len, bytes_read, bytes_written, error);
1326 return g_convert (opsysstring, len,
1327 "UTF-8", charset, bytes_read, bytes_written, error);
1333 * g_filename_from_utf8:
1334 * @utf8string: a UTF-8 encoded string.
1335 * @len: the length of the string, or -1 if the string is
1337 * @bytes_read: location to store the number of bytes in the
1338 * input string that were successfully converted, or %NULL.
1339 * Even if the conversion was successful, this may be
1340 * less than @len if there were partial characters
1341 * at the end of the input. If the error
1342 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1343 * stored will the byte offset after the last valid
1345 * @bytes_written: the number of bytes stored in the output buffer (not
1346 * including the terminating nul).
1347 * @error: location to store the error occuring, or %NULL to ignore
1348 * errors. Any of the errors in #GConvertError may occur.
1350 * Converts a string from UTF-8 to the encoding GLib uses for
1351 * filenames. Note that on Windows GLib uses UTF-8 for filenames.
1353 * Return value: The converted string, or %NULL on an error.
1356 g_filename_from_utf8 (const gchar *utf8string,
1359 gsize *bytes_written,
1362 const gchar *charset;
1364 if (get_filename_charset (&charset))
1365 return strdup_len (utf8string, len, bytes_read, bytes_written, error);
1367 return g_convert (utf8string, len,
1368 charset, "UTF-8", bytes_read, bytes_written, error);
1373 #undef g_filename_from_utf8
1375 /* Binary compatibility version. Not for newly compiled code. */
1378 g_filename_from_utf8 (const gchar *utf8string,
1381 gsize *bytes_written,
1384 const gchar *charset;
1386 if (g_get_charset (&charset))
1387 return strdup_len (utf8string, len, bytes_read, bytes_written, error);
1389 return g_convert (utf8string, len,
1390 charset, "UTF-8", bytes_read, bytes_written, error);
1395 /* Test of haystack has the needle prefix, comparing case
1396 * insensitive. haystack may be UTF-8, but needle must
1397 * contain only ascii. */
1399 has_case_prefix (const gchar *haystack, const gchar *needle)
1403 /* Eat one character at a time. */
1408 g_ascii_tolower (*n) == g_ascii_tolower (*h))
1418 UNSAFE_ALL = 0x1, /* Escape all unsafe characters */
1419 UNSAFE_ALLOW_PLUS = 0x2, /* Allows '+' */
1420 UNSAFE_PATH = 0x8, /* Allows '/', '&', '=', ':', '@', '+', '$' and ',' */
1421 UNSAFE_HOST = 0x10, /* Allows '/' and ':' and '@' */
1422 UNSAFE_SLASHES = 0x20 /* Allows all characters except for '/' and '%' */
1423 } UnsafeCharacterSet;
1425 static const guchar acceptable[96] = {
1426 /* A table of the ASCII chars from space (32) to DEL (127) */
1427 /* ! " # $ % & ' ( ) * + , - . / */
1428 0x00,0x3F,0x20,0x20,0x28,0x00,0x2C,0x3F,0x3F,0x3F,0x3F,0x2A,0x28,0x3F,0x3F,0x1C,
1429 /* 0 1 2 3 4 5 6 7 8 9 : ; < = > ? */
1430 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x38,0x20,0x20,0x2C,0x20,0x20,
1431 /* @ A B C D E F G H I J K L M N O */
1432 0x38,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,
1433 /* P Q R S T U V W X Y Z [ \ ] ^ _ */
1434 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x20,0x20,0x20,0x20,0x3F,
1435 /* ` a b c d e f g h i j k l m n o */
1436 0x20,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,
1437 /* p q r s t u v w x y z { | } ~ DEL */
1438 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x20,0x20,0x20,0x3F,0x20
1441 static const gchar hex[16] = "0123456789ABCDEF";
1443 /* Note: This escape function works on file: URIs, but if you want to
1444 * escape something else, please read RFC-2396 */
1446 g_escape_uri_string (const gchar *string,
1447 UnsafeCharacterSet mask)
1449 #define ACCEPTABLE(a) ((a)>=32 && (a)<128 && (acceptable[(a)-32] & use_mask))
1456 UnsafeCharacterSet use_mask;
1458 g_return_val_if_fail (mask == UNSAFE_ALL
1459 || mask == UNSAFE_ALLOW_PLUS
1460 || mask == UNSAFE_PATH
1461 || mask == UNSAFE_HOST
1462 || mask == UNSAFE_SLASHES, NULL);
1466 for (p = string; *p != '\0'; p++)
1469 if (!ACCEPTABLE (c))
1473 result = g_malloc (p - string + unacceptable * 2 + 1);
1476 for (q = result, p = string; *p != '\0'; p++)
1480 if (!ACCEPTABLE (c))
1482 *q++ = '%'; /* means hex coming */
1497 g_escape_file_uri (const gchar *hostname,
1498 const gchar *pathname)
1500 char *escaped_hostname = NULL;
1505 char *p, *backslash;
1507 /* Turn backslashes into forward slashes. That's what Netscape
1508 * does, and they are actually more or less equivalent in Windows.
1511 pathname = g_strdup (pathname);
1512 p = (char *) pathname;
1514 while ((backslash = strchr (p, '\\')) != NULL)
1521 if (hostname && *hostname != '\0')
1523 escaped_hostname = g_escape_uri_string (hostname, UNSAFE_HOST);
1526 escaped_path = g_escape_uri_string (pathname, UNSAFE_PATH);
1528 res = g_strconcat ("file://",
1529 (escaped_hostname) ? escaped_hostname : "",
1530 (*escaped_path != '/') ? "/" : "",
1535 g_free ((char *) pathname);
1538 g_free (escaped_hostname);
1539 g_free (escaped_path);
1545 unescape_character (const char *scanner)
1550 first_digit = g_ascii_xdigit_value (scanner[0]);
1551 if (first_digit < 0)
1554 second_digit = g_ascii_xdigit_value (scanner[1]);
1555 if (second_digit < 0)
1558 return (first_digit << 4) | second_digit;
1562 g_unescape_uri_string (const char *escaped,
1564 const char *illegal_escaped_characters,
1565 gboolean ascii_must_not_be_escaped)
1567 const gchar *in, *in_end;
1568 gchar *out, *result;
1571 if (escaped == NULL)
1575 len = strlen (escaped);
1577 result = g_malloc (len + 1);
1580 for (in = escaped, in_end = escaped + len; in < in_end; in++)
1586 /* catch partial escape sequences past the end of the substring */
1587 if (in + 3 > in_end)
1590 c = unescape_character (in + 1);
1592 /* catch bad escape sequences and NUL characters */
1596 /* catch escaped ASCII */
1597 if (ascii_must_not_be_escaped && c <= 0x7F)
1600 /* catch other illegal escaped characters */
1601 if (strchr (illegal_escaped_characters, c) != NULL)
1610 g_assert (out - result <= len);
1623 is_asciialphanum (gunichar c)
1625 return c <= 0x7F && g_ascii_isalnum (c);
1629 is_asciialpha (gunichar c)
1631 return c <= 0x7F && g_ascii_isalpha (c);
1634 /* allows an empty string */
1636 hostname_validate (const char *hostname)
1639 gunichar c, first_char, last_char;
1646 /* read in a label */
1647 c = g_utf8_get_char (p);
1648 p = g_utf8_next_char (p);
1649 if (!is_asciialphanum (c))
1655 c = g_utf8_get_char (p);
1656 p = g_utf8_next_char (p);
1658 while (is_asciialphanum (c) || c == '-');
1659 if (last_char == '-')
1662 /* if that was the last label, check that it was a toplabel */
1663 if (c == '\0' || (c == '.' && *p == '\0'))
1664 return is_asciialpha (first_char);
1671 * g_filename_from_uri:
1672 * @uri: a uri describing a filename (escaped, encoded in ASCII).
1673 * @hostname: Location to store hostname for the URI, or %NULL.
1674 * If there is no hostname in the URI, %NULL will be
1675 * stored in this location.
1676 * @error: location to store the error occuring, or %NULL to ignore
1677 * errors. Any of the errors in #GConvertError may occur.
1679 * Converts an escaped ASCII-encoded URI to a local filename in the
1680 * encoding used for filenames.
1682 * Return value: a newly-allocated string holding the resulting
1683 * filename, or %NULL on an error.
1686 g_filename_from_uri (const gchar *uri,
1690 const char *path_part;
1691 const char *host_part;
1692 char *unescaped_hostname;
1703 if (!has_case_prefix (uri, "file:/"))
1705 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1706 _("The URI '%s' is not an absolute URI using the \"file\" scheme"),
1711 path_part = uri + strlen ("file:");
1713 if (strchr (path_part, '#') != NULL)
1715 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1716 _("The local file URI '%s' may not include a '#'"),
1721 if (has_case_prefix (path_part, "///"))
1723 else if (has_case_prefix (path_part, "//"))
1726 host_part = path_part;
1728 path_part = strchr (path_part, '/');
1730 if (path_part == NULL)
1732 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1733 _("The URI '%s' is invalid"),
1738 unescaped_hostname = g_unescape_uri_string (host_part, path_part - host_part, "", TRUE);
1740 if (unescaped_hostname == NULL ||
1741 !hostname_validate (unescaped_hostname))
1743 g_free (unescaped_hostname);
1744 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1745 _("The hostname of the URI '%s' is invalid"),
1751 *hostname = unescaped_hostname;
1753 g_free (unescaped_hostname);
1756 filename = g_unescape_uri_string (path_part, -1, "/", FALSE);
1758 if (filename == NULL)
1760 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_BAD_URI,
1761 _("The URI '%s' contains invalidly escaped characters"),
1768 /* Drop localhost */
1769 if (hostname && *hostname != NULL &&
1770 g_ascii_strcasecmp (*hostname, "localhost") == 0)
1776 /* Turn slashes into backslashes, because that's the canonical spelling */
1778 while ((slash = strchr (p, '/')) != NULL)
1784 /* Windows URIs with a drive letter can be like "file://host/c:/foo"
1785 * or "file://host/c|/foo" (some Netscape versions). In those cases, start
1786 * the filename from the drive letter.
1788 if (g_ascii_isalpha (filename[1]))
1790 if (filename[2] == ':')
1792 else if (filename[2] == '|')
1800 result = g_strdup (filename + offs);
1808 #undef g_filename_from_uri
1811 g_filename_from_uri (const gchar *uri,
1815 gchar *utf8_filename;
1816 gchar *retval = NULL;
1818 utf8_filename = g_filename_from_uri_utf8 (uri, hostname, error);
1821 retval = g_locale_from_utf8 (utf8_filename, -1, NULL, NULL, error);
1822 g_free (utf8_filename);
1830 * g_filename_to_uri:
1831 * @filename: an absolute filename specified in the GLib file name encoding,
1832 * which is the on-disk file name bytes on Unix, and UTF-8 on
1834 * @hostname: A UTF-8 encoded hostname, or %NULL for none.
1835 * @error: location to store the error occuring, or %NULL to ignore
1836 * errors. Any of the errors in #GConvertError may occur.
1838 * Converts an absolute filename to an escaped ASCII-encoded URI.
1840 * Return value: a newly-allocated string holding the resulting
1841 * URI, or %NULL on an error.
1844 g_filename_to_uri (const gchar *filename,
1845 const gchar *hostname,
1850 g_return_val_if_fail (filename != NULL, NULL);
1852 if (!g_path_is_absolute (filename))
1854 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_NOT_ABSOLUTE_PATH,
1855 _("The pathname '%s' is not an absolute path"),
1861 !(g_utf8_validate (hostname, -1, NULL)
1862 && hostname_validate (hostname)))
1864 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1865 _("Invalid hostname"));
1870 /* Don't use localhost unnecessarily */
1871 if (hostname && g_ascii_strcasecmp (hostname, "localhost") == 0)
1875 escaped_uri = g_escape_file_uri (hostname, filename);
1882 #undef g_filename_to_uri
1885 g_filename_to_uri (const gchar *filename,
1886 const gchar *hostname,
1889 gchar *utf8_filename;
1890 gchar *retval = NULL;
1892 utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, error);
1896 retval = g_filename_to_uri_utf8 (utf8_filename, hostname, error);
1897 g_free (utf8_filename);
1906 * g_uri_list_extract_uris:
1907 * @uri_list: an URI list
1909 * Splits an URI list conforming to the text/uri-list
1910 * mime type defined in RFC 2483 into individual URIs,
1911 * discarding any comments. The URIs are not validated.
1913 * Returns: a newly allocated %NULL-terminated list of
1914 * strings holding the individual URIs. The array should
1915 * be freed with g_strfreev().
1920 g_uri_list_extract_uris (const gchar *uri_list)
1931 /* We don't actually try to validate the URI according to RFC
1932 * 2396, or even check for allowed characters - we just ignore
1933 * comments and trim whitespace off the ends. We also
1934 * allow LF delimination as well as the specified CRLF.
1936 * We do allow comments like specified in RFC 2483.
1942 while (g_ascii_isspace (*p))
1946 while (*q && (*q != '\n') && (*q != '\r'))
1952 while (q > p && g_ascii_isspace (*q))
1957 uris = g_slist_prepend (uris, g_strndup (p, q - p + 1));
1962 p = strchr (p, '\n');
1967 result = g_new (gchar *, n_uris + 1);
1969 result[n_uris--] = NULL;
1970 for (u = uris; u; u = u->next)
1971 result[n_uris--] = u->data;
1973 g_slist_free (uris);
1979 make_valid_utf8 (const gchar *name)
1982 const gchar *remainder, *invalid;
1983 gint remaining_bytes, valid_bytes;
1987 remaining_bytes = strlen (name);
1989 while (remaining_bytes != 0)
1991 if (g_utf8_validate (remainder, remaining_bytes, &invalid))
1993 valid_bytes = invalid - remainder;
1996 string = g_string_sized_new (remaining_bytes);
1998 g_string_append_len (string, remainder, valid_bytes);
1999 g_string_append_c (string, '?');
2001 remaining_bytes -= valid_bytes + 1;
2002 remainder = invalid + 1;
2006 return g_strdup (name);
2008 g_string_append (string, remainder);
2009 g_string_append (string, " (invalid encoding)");
2011 g_assert (g_utf8_validate (string->str, -1, NULL));
2013 return g_string_free (string, FALSE);
2017 * g_filename_display_basename:
2018 * @filename: an absolute pathname in the GLib file name encoding
2020 * Returns the display basename for the particular filename, guaranteed
2021 * to be valid UTF-8. The display name might not be identical to the filename,
2022 * for instance there might be problems converting it to UTF-8, and some files
2023 * can be translated in the display
2025 * You must pass the whole absolute pathname to this functions so that
2026 * translation of well known locations can be done.
2028 * This function is preferred over g_filename_display_name() if you know the
2029 * whole path, as it allows translation.
2031 * Return value: a newly allocated string containing
2032 * a rendition of the basename of the filename in valid UTF-8
2037 g_filename_display_basename (const gchar *filename)
2042 g_return_val_if_fail (filename != NULL, NULL);
2044 basename = g_path_get_basename (filename);
2045 display_name = g_filename_display_name (basename);
2047 return display_name;
2051 * g_filename_display_name:
2052 * @filename: a pathname hopefully in the GLib file name encoding
2054 * Converts a filename into a valid UTF-8 string. The
2055 * conversion is not necessarily reversible, so you
2056 * should keep the original around and use the return
2057 * value of this function only for display purposes.
2058 * Unlike g_filename_to_utf8(), the result is guaranteed
2059 * to be non-NULL even if the filename actually isn't in the GLib
2060 * file name encoding.
2062 * If you know the whole pathname of the file you should use
2063 * g_filename_display_basename(), since that allows location-based
2064 * translation of filenames.
2066 * Return value: a newly allocated string containing
2067 * a rendition of the filename in valid UTF-8
2072 g_filename_display_name (const gchar *filename)
2075 const gchar **charsets;
2076 gchar *display_name = NULL;
2079 is_utf8 = g_get_filename_charsets (&charsets);
2083 if (g_utf8_validate (filename, -1, NULL))
2084 display_name = g_strdup (filename);
2089 /* Try to convert from the filename charsets to UTF-8.
2090 * Skip the first charset if it is UTF-8.
2092 for (i = is_utf8 ? 1 : 0; charsets[i]; i++)
2094 display_name = g_convert (filename, -1, "UTF-8", charsets[i],
2102 /* if all conversions failed, we replace invalid UTF-8
2103 * by a question mark
2106 display_name = make_valid_utf8 (filename);
2108 return display_name;
2111 #define __G_CONVERT_C__
2112 #include "galiasdef.c"