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.
24 #include "glibconfig.h"
35 #include "win_iconv.c"
38 #ifdef G_PLATFORM_WIN32
48 #include "gstrfuncs.h"
49 #include "gtestutils.h"
52 #include "gfileutils.h"
54 #ifdef NEED_ICONV_CACHE
61 #if defined(USE_LIBICONV_GNU) && !defined (_LIBICONV_H)
62 #error GNU libiconv in use but included iconv.h not from libiconv
64 #if !defined(USE_LIBICONV_GNU) && defined (_LIBICONV_H)
65 #error GNU libiconv not in use but included iconv.h is from libiconv
71 * @title: Character Set Conversion
72 * @short_description: convert strings between different character sets
74 * The g_convert() family of function wraps the functionality of iconv(). In
75 * addition to pure character set conversions, GLib has functions to deal
76 * with the extra complications of encodings for file names.
78 * <refsect2 id="file-name-encodings">
79 * <title>File Name Encodings</title>
81 * Historically, Unix has not had a defined encoding for file
82 * names: a file name is valid as long as it does not have path
83 * separators in it ("/"). However, displaying file names may
84 * require conversion: from the character set in which they were
85 * created, to the character set in which the application
86 * operates. Consider the Spanish file name
87 * "<filename>Presentación.sxi</filename>". If the
88 * application which created it uses ISO-8859-1 for its encoding,
90 * <programlisting id="filename-iso8859-1">
91 * Character: P r e s e n t a c i ó n . s x i
92 * Hex code: 50 72 65 73 65 6e 74 61 63 69 f3 6e 2e 73 78 69
95 * However, if the application use UTF-8, the actual file name on
96 * disk would look like this:
98 * <programlisting id="filename-utf-8">
99 * Character: P r e s e n t a c i ó n . s x i
100 * Hex code: 50 72 65 73 65 6e 74 61 63 69 c3 b3 6e 2e 73 78 69
103 * Glib uses UTF-8 for its strings, and GUI toolkits like GTK+
104 * that use Glib do the same thing. If you get a file name from
105 * the file system, for example, from readdir(3) or from g_dir_read_name(),
106 * and you wish to display the file name to the user, you
107 * <emphasis>will</emphasis> need to convert it into UTF-8. The
108 * opposite case is when the user types the name of a file he
109 * wishes to save: the toolkit will give you that string in
110 * UTF-8 encoding, and you will need to convert it to the
111 * character set used for file names before you can create the
112 * file with open(2) or fopen(3).
115 * By default, Glib assumes that file names on disk are in UTF-8
116 * encoding. This is a valid assumption for file systems which
117 * were created relatively recently: most applications use UTF-8
118 * encoding for their strings, and that is also what they use for
119 * the file names they create. However, older file systems may
120 * still contain file names created in "older" encodings, such as
121 * ISO-8859-1. In this case, for compatibility reasons, you may
122 * want to instruct Glib to use that particular encoding for file
123 * names rather than UTF-8. You can do this by specifying the
124 * encoding for file names in the <link
125 * linkend="G_FILENAME_ENCODING"><envar>G_FILENAME_ENCODING</envar></link>
126 * environment variable. For example, if your installation uses
127 * ISO-8859-1 for file names, you can put this in your
128 * <filename>~/.profile</filename>:
131 * export G_FILENAME_ENCODING=ISO-8859-1
134 * Glib provides the functions g_filename_to_utf8() and
135 * g_filename_from_utf8() to perform the necessary conversions. These
136 * functions convert file names from the encoding specified in
137 * <envar>G_FILENAME_ENCODING</envar> to UTF-8 and vice-versa.
138 * <xref linkend="file-name-encodings-diagram"/> illustrates how
139 * these functions are used to convert between UTF-8 and the
140 * encoding for file names in the file system.
142 * <figure id="file-name-encodings-diagram">
143 * <title>Conversion between File Name Encodings</title>
144 * <graphic fileref="file-name-encodings.png" format="PNG"/>
146 * <refsect3 id="file-name-encodings-checklist">
147 * <title>Checklist for Application Writers</title>
149 * This section is a practical summary of the detailed
150 * description above. You can use this as a checklist of
151 * things to do to make sure your applications process file
152 * name encodings correctly.
156 * If you get a file name from the file system from a function
157 * such as readdir(3) or gtk_file_chooser_get_filename(),
158 * you do not need to do any conversion to pass that
159 * file name to functions like open(2), rename(2), or
160 * fopen(3) — those are "raw" file names which the file
161 * system understands.
164 * If you need to display a file name, convert it to UTF-8 first by
165 * using g_filename_to_utf8(). If conversion fails, display a string like
166 * "<literal>Unknown file name</literal>". <emphasis>Do not</emphasis>
167 * convert this string back into the encoding used for file names if you
168 * wish to pass it to the file system; use the original file name instead.
169 * For example, the document window of a word processor could display
170 * "Unknown file name" in its title bar but still let the user save the
171 * file, as it would keep the raw file name internally. This can happen
172 * if the user has not set the <envar>G_FILENAME_ENCODING</envar>
173 * environment variable even though he has files whose names are not
177 * If your user interface lets the user type a file name for saving or
178 * renaming, convert it to the encoding used for file names in the file
179 * system by using g_filename_from_utf8(). Pass the converted file name
180 * to functions like fopen(3). If conversion fails, ask the user to enter
181 * a different file name. This can happen if the user types Japanese
182 * characters when <envar>G_FILENAME_ENCODING</envar> is set to
183 * <literal>ISO-8859-1</literal>, for example.
190 /* We try to terminate strings in unknown charsets with this many zero bytes
191 * to ensure that multibyte strings really are nul-terminated when we return
192 * them from g_convert() and friends.
194 #define NUL_TERMINATOR_LENGTH 4
197 g_convert_error_quark (void)
199 return g_quark_from_static_string ("g_convert_error");
203 try_conversion (const char *to_codeset
,
204 const char *from_codeset
,
207 *cd
= iconv_open (to_codeset
, from_codeset
);
209 if (*cd
== (iconv_t
)-1 && errno
== EINVAL
)
216 try_to_aliases (const char **to_aliases
,
217 const char *from_codeset
,
222 const char **p
= to_aliases
;
225 if (try_conversion (*p
, from_codeset
, cd
))
235 G_GNUC_INTERNAL
extern const char **
236 _g_charset_get_aliases (const char *canonical_name
);
240 * @to_codeset: destination codeset
241 * @from_codeset: source codeset
243 * Same as the standard UNIX routine iconv_open(), but
244 * may be implemented via libiconv on UNIX flavors that lack
245 * a native implementation.
247 * GLib provides g_convert() and g_locale_to_utf8() which are likely
248 * more convenient than the raw iconv wrappers.
250 * Return value: a "conversion descriptor", or (GIConv)-1 if
251 * opening the converter failed.
254 g_iconv_open (const gchar
*to_codeset
,
255 const gchar
*from_codeset
)
259 if (!try_conversion (to_codeset
, from_codeset
, &cd
))
261 const char **to_aliases
= _g_charset_get_aliases (to_codeset
);
262 const char **from_aliases
= _g_charset_get_aliases (from_codeset
);
266 const char **p
= from_aliases
;
269 if (try_conversion (to_codeset
, *p
, &cd
))
272 if (try_to_aliases (to_aliases
, *p
, &cd
))
279 if (try_to_aliases (to_aliases
, from_codeset
, &cd
))
284 return (cd
== (iconv_t
)-1) ? (GIConv
)-1 : (GIConv
)cd
;
289 * @converter: conversion descriptor from g_iconv_open()
290 * @inbuf: bytes to convert
291 * @inbytes_left: inout parameter, bytes remaining to convert in @inbuf
292 * @outbuf: converted output bytes
293 * @outbytes_left: inout parameter, bytes available to fill in @outbuf
295 * Same as the standard UNIX routine iconv(), but
296 * may be implemented via libiconv on UNIX flavors that lack
297 * a native implementation.
299 * GLib provides g_convert() and g_locale_to_utf8() which are likely
300 * more convenient than the raw iconv wrappers.
302 * Return value: count of non-reversible conversions, or -1 on error
305 g_iconv (GIConv converter
,
309 gsize
*outbytes_left
)
311 iconv_t cd
= (iconv_t
)converter
;
313 return iconv (cd
, inbuf
, inbytes_left
, outbuf
, outbytes_left
);
318 * @converter: a conversion descriptor from g_iconv_open()
320 * Same as the standard UNIX routine iconv_close(), but
321 * may be implemented via libiconv on UNIX flavors that lack
322 * a native implementation. Should be called to clean up
323 * the conversion descriptor from g_iconv_open() when
324 * you are done converting things.
326 * GLib provides g_convert() and g_locale_to_utf8() which are likely
327 * more convenient than the raw iconv wrappers.
329 * Return value: -1 on error, 0 on success
332 g_iconv_close (GIConv converter
)
334 iconv_t cd
= (iconv_t
)converter
;
336 return iconv_close (cd
);
340 #ifdef NEED_ICONV_CACHE
342 #define ICONV_CACHE_SIZE (16)
344 struct _iconv_cache_bucket
{
351 static GList
*iconv_cache_list
;
352 static GHashTable
*iconv_cache
;
353 static GHashTable
*iconv_open_hash
;
354 static guint iconv_cache_size
= 0;
355 G_LOCK_DEFINE_STATIC (iconv_cache_lock
);
357 /* caller *must* hold the iconv_cache_lock */
359 iconv_cache_init (void)
361 static gboolean initialized
= FALSE
;
366 iconv_cache_list
= NULL
;
367 iconv_cache
= g_hash_table_new (g_str_hash
, g_str_equal
);
368 iconv_open_hash
= g_hash_table_new (g_direct_hash
, g_direct_equal
);
375 * iconv_cache_bucket_new:
377 * @cd: iconv descriptor
379 * Creates a new cache bucket, inserts it into the cache and
380 * increments the cache size.
382 * This assumes ownership of @key.
384 * Returns a pointer to the newly allocated cache bucket.
386 static struct _iconv_cache_bucket
*
387 iconv_cache_bucket_new (gchar
*key
, GIConv cd
)
389 struct _iconv_cache_bucket
*bucket
;
391 bucket
= g_new (struct _iconv_cache_bucket
, 1);
393 bucket
->refcount
= 1;
397 g_hash_table_insert (iconv_cache
, bucket
->key
, bucket
);
399 /* FIXME: if we sorted the list so items with few refcounts were
400 first, then we could expire them faster in iconv_cache_expire_unused () */
401 iconv_cache_list
= g_list_prepend (iconv_cache_list
, bucket
);
410 * iconv_cache_bucket_expire:
411 * @node: cache bucket's node
412 * @bucket: cache bucket
414 * Expires a single cache bucket @bucket. This should only ever be
415 * called on a bucket that currently has no used iconv descriptors
418 * @node is not a required argument. If @node is not supplied, we
419 * search for it ourselves.
422 iconv_cache_bucket_expire (GList
*node
, struct _iconv_cache_bucket
*bucket
)
424 g_hash_table_remove (iconv_cache
, bucket
->key
);
427 node
= g_list_find (iconv_cache_list
, bucket
);
429 g_assert (node
!= NULL
);
433 node
->prev
->next
= node
->next
;
435 node
->next
->prev
= node
->prev
;
439 iconv_cache_list
= node
->next
;
441 node
->next
->prev
= NULL
;
444 g_list_free_1 (node
);
446 g_free (bucket
->key
);
447 g_iconv_close (bucket
->cd
);
455 * iconv_cache_expire_unused:
457 * Expires as many unused cache buckets as it needs to in order to get
458 * the total number of buckets < ICONV_CACHE_SIZE.
461 iconv_cache_expire_unused (void)
463 struct _iconv_cache_bucket
*bucket
;
466 node
= iconv_cache_list
;
467 while (node
&& iconv_cache_size
>= ICONV_CACHE_SIZE
)
472 if (bucket
->refcount
== 0)
473 iconv_cache_bucket_expire (node
, bucket
);
480 open_converter (const gchar
*to_codeset
,
481 const gchar
*from_codeset
,
484 struct _iconv_cache_bucket
*bucket
;
485 gchar
*key
, *dyn_key
, auto_key
[80];
487 gsize len_from_codeset
, len_to_codeset
;
490 len_from_codeset
= strlen (from_codeset
);
491 len_to_codeset
= strlen (to_codeset
);
492 if (len_from_codeset
+ len_to_codeset
+ 2 < sizeof (auto_key
))
498 key
= dyn_key
= g_malloc (len_from_codeset
+ len_to_codeset
+ 2);
499 memcpy (key
, from_codeset
, len_from_codeset
);
500 key
[len_from_codeset
] = ':';
501 strcpy (key
+ len_from_codeset
+ 1, to_codeset
);
503 G_LOCK (iconv_cache_lock
);
505 /* make sure the cache has been initialized */
508 bucket
= g_hash_table_lookup (iconv_cache
, key
);
515 cd
= g_iconv_open (to_codeset
, from_codeset
);
516 if (cd
== (GIConv
) -1)
521 /* Apparently iconv on Solaris <= 7 segfaults if you pass in
522 * NULL for anything but inbuf; work around that. (NULL outbuf
523 * or NULL *outbuf is allowed by Unix98.)
525 gsize inbytes_left
= 0;
526 gchar
*outbuf
= NULL
;
527 gsize outbytes_left
= 0;
532 /* reset the descriptor */
533 g_iconv (cd
, NULL
, &inbytes_left
, &outbuf
, &outbytes_left
);
540 cd
= g_iconv_open (to_codeset
, from_codeset
);
541 if (cd
== (GIConv
) -1)
547 iconv_cache_expire_unused ();
549 bucket
= iconv_cache_bucket_new (dyn_key
? dyn_key
: g_strdup (key
), cd
);
552 g_hash_table_insert (iconv_open_hash
, cd
, bucket
->key
);
554 G_UNLOCK (iconv_cache_lock
);
560 G_UNLOCK (iconv_cache_lock
);
562 /* Something went wrong. */
566 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_NO_CONVERSION
,
567 _("Conversion from character set '%s' to '%s' is not supported"),
568 from_codeset
, to_codeset
);
570 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
571 _("Could not open converter from '%s' to '%s'"),
572 from_codeset
, to_codeset
);
579 close_converter (GIConv converter
)
581 struct _iconv_cache_bucket
*bucket
;
587 if (cd
== (GIConv
) -1)
590 G_LOCK (iconv_cache_lock
);
592 key
= g_hash_table_lookup (iconv_open_hash
, cd
);
595 g_hash_table_remove (iconv_open_hash
, cd
);
597 bucket
= g_hash_table_lookup (iconv_cache
, key
);
602 if (cd
== bucket
->cd
)
603 bucket
->used
= FALSE
;
607 if (!bucket
->refcount
&& iconv_cache_size
> ICONV_CACHE_SIZE
)
609 /* expire this cache bucket */
610 iconv_cache_bucket_expire (NULL
, bucket
);
615 G_UNLOCK (iconv_cache_lock
);
617 g_warning ("This iconv context wasn't opened using open_converter");
619 return g_iconv_close (converter
);
622 G_UNLOCK (iconv_cache_lock
);
627 #else /* !NEED_ICONV_CACHE */
630 open_converter (const gchar
*to_codeset
,
631 const gchar
*from_codeset
,
636 cd
= g_iconv_open (to_codeset
, from_codeset
);
638 if (cd
== (GIConv
) -1)
640 /* Something went wrong. */
644 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_NO_CONVERSION
,
645 _("Conversion from character set '%s' to '%s' is not supported"),
646 from_codeset
, to_codeset
);
648 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
649 _("Could not open converter from '%s' to '%s'"),
650 from_codeset
, to_codeset
);
658 close_converter (GIConv cd
)
660 if (cd
== (GIConv
) -1)
663 return g_iconv_close (cd
);
666 #endif /* NEED_ICONV_CACHE */
669 * g_convert_with_iconv:
670 * @str: the string to convert
671 * @len: the length of the string, or -1 if the string is
672 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
673 * @converter: conversion descriptor from g_iconv_open()
674 * @bytes_read: location to store the number of bytes in the
675 * input string that were successfully converted, or %NULL.
676 * Even if the conversion was successful, this may be
677 * less than @len if there were partial characters
678 * at the end of the input. If the error
679 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
680 * stored will the byte offset after the last valid
682 * @bytes_written: the number of bytes stored in the output buffer (not
683 * including the terminating nul).
684 * @error: location to store the error occurring, or %NULL to ignore
685 * errors. Any of the errors in #GConvertError may occur.
687 * Converts a string from one character set to another.
689 * Note that you should use g_iconv() for streaming
690 * conversions<footnote id="streaming-state">
692 * Despite the fact that @byes_read can return information about partial
693 * characters, the <literal>g_convert_...</literal> functions
694 * are not generally suitable for streaming. If the underlying converter
695 * being used maintains internal state, then this won't be preserved
696 * across successive calls to g_convert(), g_convert_with_iconv() or
697 * g_convert_with_fallback(). (An example of this is the GNU C converter
698 * for CP1255 which does not emit a base character until it knows that
699 * the next character is not a mark that could combine with the base
704 * Return value: If the conversion was successful, a newly allocated
705 * nul-terminated string, which must be freed with
706 * g_free(). Otherwise %NULL and @error will be set.
709 g_convert_with_iconv (const gchar
*str
,
713 gsize
*bytes_written
,
719 gsize inbytes_remaining
;
720 gsize outbytes_remaining
;
723 gboolean have_error
= FALSE
;
724 gboolean done
= FALSE
;
725 gboolean reset
= FALSE
;
727 g_return_val_if_fail (converter
!= (GIConv
) -1, NULL
);
733 inbytes_remaining
= len
;
734 outbuf_size
= len
+ NUL_TERMINATOR_LENGTH
;
736 outbytes_remaining
= outbuf_size
- NUL_TERMINATOR_LENGTH
;
737 outp
= dest
= g_malloc (outbuf_size
);
739 while (!done
&& !have_error
)
742 err
= g_iconv (converter
, NULL
, &inbytes_remaining
, &outp
, &outbytes_remaining
);
744 err
= g_iconv (converter
, (char **)&p
, &inbytes_remaining
, &outp
, &outbytes_remaining
);
746 if (err
== (gsize
) -1)
751 /* Incomplete text, do not report an error */
756 gsize used
= outp
- dest
;
759 dest
= g_realloc (dest
, outbuf_size
);
762 outbytes_remaining
= outbuf_size
- used
- NUL_TERMINATOR_LENGTH
;
766 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_ILLEGAL_SEQUENCE
,
767 _("Invalid byte sequence in conversion input"));
774 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
775 _("Error during conversion: %s"),
786 /* call g_iconv with NULL inbuf to cleanup shift state */
788 inbytes_remaining
= 0;
795 memset (outp
, 0, NUL_TERMINATOR_LENGTH
);
798 *bytes_read
= p
- str
;
801 if ((p
- str
) != len
)
805 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_PARTIAL_INPUT
,
806 _("Partial character sequence at end of input"));
813 *bytes_written
= outp
- dest
; /* Doesn't include '\0' */
826 * @str: the string to convert
827 * @len: the length of the string, or -1 if the string is
828 * nul-terminated<footnote id="nul-unsafe">
830 Note that some encodings may allow nul bytes to
831 occur inside strings. In that case, using -1 for
832 the @len parameter is unsafe.
835 * @to_codeset: name of character set into which to convert @str
836 * @from_codeset: character set of @str.
837 * @bytes_read: (out): location to store the number of bytes in the
838 * input string that were successfully converted, or %NULL.
839 * Even if the conversion was successful, this may be
840 * less than @len if there were partial characters
841 * at the end of the input. If the error
842 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
843 * stored will the byte offset after the last valid
845 * @bytes_written: (out): the number of bytes stored in the output buffer (not
846 * including the terminating nul).
847 * @error: location to store the error occurring, or %NULL to ignore
848 * errors. Any of the errors in #GConvertError may occur.
850 * Converts a string from one character set to another.
852 * Note that you should use g_iconv() for streaming
853 * conversions<footnoteref linkend="streaming-state"/>.
855 * Return value: If the conversion was successful, a newly allocated
856 * nul-terminated string, which must be freed with
857 * g_free(). Otherwise %NULL and @error will be set.
860 g_convert (const gchar
*str
,
862 const gchar
*to_codeset
,
863 const gchar
*from_codeset
,
865 gsize
*bytes_written
,
871 g_return_val_if_fail (str
!= NULL
, NULL
);
872 g_return_val_if_fail (to_codeset
!= NULL
, NULL
);
873 g_return_val_if_fail (from_codeset
!= NULL
, NULL
);
875 cd
= open_converter (to_codeset
, from_codeset
, error
);
877 if (cd
== (GIConv
) -1)
888 res
= g_convert_with_iconv (str
, len
, cd
,
889 bytes_read
, bytes_written
,
892 close_converter (cd
);
898 * g_convert_with_fallback:
899 * @str: the string to convert
900 * @len: the length of the string, or -1 if the string is
901 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
902 * @to_codeset: name of character set into which to convert @str
903 * @from_codeset: character set of @str.
904 * @fallback: UTF-8 string to use in place of character not
905 * present in the target encoding. (The string must be
906 * representable in the target encoding).
907 If %NULL, characters not in the target encoding will
908 be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
909 * @bytes_read: location to store the number of bytes in the
910 * input string that were successfully converted, or %NULL.
911 * Even if the conversion was successful, this may be
912 * less than @len if there were partial characters
913 * at the end of the input.
914 * @bytes_written: the number of bytes stored in the output buffer (not
915 * including the terminating nul).
916 * @error: location to store the error occurring, or %NULL to ignore
917 * errors. Any of the errors in #GConvertError may occur.
919 * Converts a string from one character set to another, possibly
920 * including fallback sequences for characters not representable
921 * in the output. Note that it is not guaranteed that the specification
922 * for the fallback sequences in @fallback will be honored. Some
923 * systems may do an approximate conversion from @from_codeset
924 * to @to_codeset in their iconv() functions,
925 * in which case GLib will simply return that approximate conversion.
927 * Note that you should use g_iconv() for streaming
928 * conversions<footnoteref linkend="streaming-state"/>.
930 * Return value: If the conversion was successful, a newly allocated
931 * nul-terminated string, which must be freed with
932 * g_free(). Otherwise %NULL and @error will be set.
935 g_convert_with_fallback (const gchar
*str
,
937 const gchar
*to_codeset
,
938 const gchar
*from_codeset
,
939 const gchar
*fallback
,
941 gsize
*bytes_written
,
947 const gchar
*insert_str
= NULL
;
949 gsize inbytes_remaining
;
950 const gchar
*save_p
= NULL
;
951 gsize save_inbytes
= 0;
952 gsize outbytes_remaining
;
956 gboolean have_error
= FALSE
;
957 gboolean done
= FALSE
;
959 GError
*local_error
= NULL
;
961 g_return_val_if_fail (str
!= NULL
, NULL
);
962 g_return_val_if_fail (to_codeset
!= NULL
, NULL
);
963 g_return_val_if_fail (from_codeset
!= NULL
, NULL
);
968 /* Try an exact conversion; we only proceed if this fails
969 * due to an illegal sequence in the input string.
971 dest
= g_convert (str
, len
, to_codeset
, from_codeset
,
972 bytes_read
, bytes_written
, &local_error
);
976 if (!g_error_matches (local_error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_ILLEGAL_SEQUENCE
))
978 g_propagate_error (error
, local_error
);
982 g_error_free (local_error
);
986 /* No go; to proceed, we need a converter from "UTF-8" to
987 * to_codeset, and the string as UTF-8.
989 cd
= open_converter (to_codeset
, "UTF-8", error
);
990 if (cd
== (GIConv
) -1)
1001 utf8
= g_convert (str
, len
, "UTF-8", from_codeset
,
1002 bytes_read
, &inbytes_remaining
, error
);
1005 close_converter (cd
);
1011 /* Now the heart of the code. We loop through the UTF-8 string, and
1012 * whenever we hit an offending character, we form fallback, convert
1013 * the fallback to the target codeset, and then go back to
1014 * converting the original string after finishing with the fallback.
1016 * The variables save_p and save_inbytes store the input state
1017 * for the original string while we are converting the fallback
1021 outbuf_size
= len
+ NUL_TERMINATOR_LENGTH
;
1022 outbytes_remaining
= outbuf_size
- NUL_TERMINATOR_LENGTH
;
1023 outp
= dest
= g_malloc (outbuf_size
);
1025 while (!done
&& !have_error
)
1027 gsize inbytes_tmp
= inbytes_remaining
;
1028 err
= g_iconv (cd
, (char **)&p
, &inbytes_tmp
, &outp
, &outbytes_remaining
);
1029 inbytes_remaining
= inbytes_tmp
;
1031 if (err
== (gsize
) -1)
1036 g_assert_not_reached();
1040 gsize used
= outp
- dest
;
1043 dest
= g_realloc (dest
, outbuf_size
);
1046 outbytes_remaining
= outbuf_size
- used
- NUL_TERMINATOR_LENGTH
;
1053 /* Error converting fallback string - fatal
1055 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_ILLEGAL_SEQUENCE
,
1056 _("Cannot convert fallback '%s' to codeset '%s'"),
1057 insert_str
, to_codeset
);
1065 gunichar ch
= g_utf8_get_char (p
);
1066 insert_str
= g_strdup_printf (ch
< 0x10000 ? "\\u%04x" : "\\U%08x",
1070 insert_str
= fallback
;
1072 save_p
= g_utf8_next_char (p
);
1073 save_inbytes
= inbytes_remaining
- (save_p
- p
);
1075 inbytes_remaining
= strlen (p
);
1078 /* fall thru if p is NULL */
1083 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
1084 _("Error during conversion: %s"),
1085 g_strerror (errsv
));
1097 g_free ((gchar
*)insert_str
);
1099 inbytes_remaining
= save_inbytes
;
1104 /* call g_iconv with NULL inbuf to cleanup shift state */
1106 inbytes_remaining
= 0;
1115 memset (outp
, 0, NUL_TERMINATOR_LENGTH
);
1117 close_converter (cd
);
1120 *bytes_written
= outp
- dest
; /* Doesn't include '\0' */
1126 if (save_p
&& !fallback
)
1127 g_free ((gchar
*)insert_str
);
1142 strdup_len (const gchar
*string
,
1144 gsize
*bytes_written
,
1151 if (!g_utf8_validate (string
, len
, NULL
))
1158 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_ILLEGAL_SEQUENCE
,
1159 _("Invalid byte sequence in conversion input"));
1164 real_len
= strlen (string
);
1169 while (real_len
< len
&& string
[real_len
])
1174 *bytes_read
= real_len
;
1176 *bytes_written
= real_len
;
1178 return g_strndup (string
, real_len
);
1183 * @opsysstring: a string in the encoding of the current locale. On Windows
1184 * this means the system codepage.
1185 * @len: the length of the string, or -1 if the string is
1186 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
1187 * @bytes_read: location to store the number of bytes in the
1188 * input string that were successfully converted, or %NULL.
1189 * Even if the conversion was successful, this may be
1190 * less than @len if there were partial characters
1191 * at the end of the input. If the error
1192 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1193 * stored will the byte offset after the last valid
1195 * @bytes_written: the number of bytes stored in the output buffer (not
1196 * including the terminating nul).
1197 * @error: location to store the error occurring, or %NULL to ignore
1198 * errors. Any of the errors in #GConvertError may occur.
1200 * Converts a string which is in the encoding used for strings by
1201 * the C runtime (usually the same as that used by the operating
1202 * system) in the <link linkend="setlocale">current locale</link> into a
1205 * Return value: The converted string, or %NULL on an error.
1208 g_locale_to_utf8 (const gchar
*opsysstring
,
1211 gsize
*bytes_written
,
1214 const char *charset
;
1216 if (g_get_charset (&charset
))
1217 return strdup_len (opsysstring
, len
, bytes_read
, bytes_written
, error
);
1219 return g_convert (opsysstring
, len
,
1220 "UTF-8", charset
, bytes_read
, bytes_written
, error
);
1224 * g_locale_from_utf8:
1225 * @utf8string: a UTF-8 encoded string
1226 * @len: the length of the string, or -1 if the string is
1227 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
1228 * @bytes_read: location to store the number of bytes in the
1229 * input string that were successfully converted, or %NULL.
1230 * Even if the conversion was successful, this may be
1231 * less than @len if there were partial characters
1232 * at the end of the input. If the error
1233 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1234 * stored will the byte offset after the last valid
1236 * @bytes_written: the number of bytes stored in the output buffer (not
1237 * including the terminating nul).
1238 * @error: location to store the error occurring, or %NULL to ignore
1239 * errors. Any of the errors in #GConvertError may occur.
1241 * Converts a string from UTF-8 to the encoding used for strings by
1242 * the C runtime (usually the same as that used by the operating
1243 * system) in the <link linkend="setlocale">current locale</link>. On
1244 * Windows this means the system codepage.
1246 * Return value: The converted string, or %NULL on an error.
1249 g_locale_from_utf8 (const gchar
*utf8string
,
1252 gsize
*bytes_written
,
1255 const gchar
*charset
;
1257 if (g_get_charset (&charset
))
1258 return strdup_len (utf8string
, len
, bytes_read
, bytes_written
, error
);
1260 return g_convert (utf8string
, len
,
1261 charset
, "UTF-8", bytes_read
, bytes_written
, error
);
1264 #ifndef G_PLATFORM_WIN32
1266 typedef struct _GFilenameCharsetCache GFilenameCharsetCache
;
1268 struct _GFilenameCharsetCache
{
1271 gchar
**filename_charsets
;
1275 filename_charset_cache_free (gpointer data
)
1277 GFilenameCharsetCache
*cache
= data
;
1278 g_free (cache
->charset
);
1279 g_strfreev (cache
->filename_charsets
);
1284 * g_get_filename_charsets:
1285 * @charsets: return location for the %NULL-terminated list of encoding names
1287 * Determines the preferred character sets used for filenames.
1288 * The first character set from the @charsets is the filename encoding, the
1289 * subsequent character sets are used when trying to generate a displayable
1290 * representation of a filename, see g_filename_display_name().
1292 * On Unix, the character sets are determined by consulting the
1293 * environment variables <envar>G_FILENAME_ENCODING</envar> and
1294 * <envar>G_BROKEN_FILENAMES</envar>. On Windows, the character set
1295 * used in the GLib API is always UTF-8 and said environment variables
1298 * <envar>G_FILENAME_ENCODING</envar> may be set to a comma-separated list
1299 * of character set names. The special token "@locale" is taken to
1300 * mean the character set for the <link linkend="setlocale">current
1301 * locale</link>. If <envar>G_FILENAME_ENCODING</envar> is not set, but
1302 * <envar>G_BROKEN_FILENAMES</envar> is, the character set of the current
1303 * locale is taken as the filename encoding. If neither environment variable
1304 * is set, UTF-8 is taken as the filename encoding, but the character
1305 * set of the current locale is also put in the list of encodings.
1307 * The returned @charsets belong to GLib and must not be freed.
1309 * Note that on Unix, regardless of the locale character set or
1310 * <envar>G_FILENAME_ENCODING</envar> value, the actual file names present
1311 * on a system might be in any random encoding or just gibberish.
1313 * Return value: %TRUE if the filename encoding is UTF-8.
1318 g_get_filename_charsets (const gchar
***filename_charsets
)
1320 static GPrivate cache_private
= G_PRIVATE_INIT (filename_charset_cache_free
);
1321 GFilenameCharsetCache
*cache
= g_private_get (&cache_private
);
1322 const gchar
*charset
;
1326 cache
= g_new0 (GFilenameCharsetCache
, 1);
1327 g_private_set (&cache_private
, cache
);
1330 g_get_charset (&charset
);
1332 if (!(cache
->charset
&& strcmp (cache
->charset
, charset
) == 0))
1334 const gchar
*new_charset
;
1338 g_free (cache
->charset
);
1339 g_strfreev (cache
->filename_charsets
);
1340 cache
->charset
= g_strdup (charset
);
1342 p
= getenv ("G_FILENAME_ENCODING");
1343 if (p
!= NULL
&& p
[0] != '\0')
1345 cache
->filename_charsets
= g_strsplit (p
, ",", 0);
1346 cache
->is_utf8
= (strcmp (cache
->filename_charsets
[0], "UTF-8") == 0);
1348 for (i
= 0; cache
->filename_charsets
[i
]; i
++)
1350 if (strcmp ("@locale", cache
->filename_charsets
[i
]) == 0)
1352 g_get_charset (&new_charset
);
1353 g_free (cache
->filename_charsets
[i
]);
1354 cache
->filename_charsets
[i
] = g_strdup (new_charset
);
1358 else if (getenv ("G_BROKEN_FILENAMES") != NULL
)
1360 cache
->filename_charsets
= g_new0 (gchar
*, 2);
1361 cache
->is_utf8
= g_get_charset (&new_charset
);
1362 cache
->filename_charsets
[0] = g_strdup (new_charset
);
1366 cache
->filename_charsets
= g_new0 (gchar
*, 3);
1367 cache
->is_utf8
= TRUE
;
1368 cache
->filename_charsets
[0] = g_strdup ("UTF-8");
1369 if (!g_get_charset (&new_charset
))
1370 cache
->filename_charsets
[1] = g_strdup (new_charset
);
1374 if (filename_charsets
)
1375 *filename_charsets
= (const gchar
**)cache
->filename_charsets
;
1377 return cache
->is_utf8
;
1380 #else /* G_PLATFORM_WIN32 */
1383 g_get_filename_charsets (const gchar
***filename_charsets
)
1385 static const gchar
*charsets
[] = {
1391 /* On Windows GLib pretends that the filename charset is UTF-8 */
1392 if (filename_charsets
)
1393 *filename_charsets
= charsets
;
1399 /* Cygwin works like before */
1400 result
= g_get_charset (&(charsets
[0]));
1402 if (filename_charsets
)
1403 *filename_charsets
= charsets
;
1409 #endif /* G_PLATFORM_WIN32 */
1412 get_filename_charset (const gchar
**filename_charset
)
1414 const gchar
**charsets
;
1417 is_utf8
= g_get_filename_charsets (&charsets
);
1419 if (filename_charset
)
1420 *filename_charset
= charsets
[0];
1426 * g_filename_to_utf8:
1427 * @opsysstring: a string in the encoding for filenames
1428 * @len: the length of the string, or -1 if the string is
1429 * nul-terminated<footnoteref linkend="nul-unsafe"/>.
1430 * @bytes_read: location to store the number of bytes in the
1431 * input string that were successfully converted, or %NULL.
1432 * Even if the conversion was successful, this may be
1433 * less than @len if there were partial characters
1434 * at the end of the input. If the error
1435 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1436 * stored will the byte offset after the last valid
1438 * @bytes_written: the number of bytes stored in the output buffer (not
1439 * including the terminating nul).
1440 * @error: location to store the error occurring, or %NULL to ignore
1441 * errors. Any of the errors in #GConvertError may occur.
1443 * Converts a string which is in the encoding used by GLib for
1444 * filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8
1445 * for filenames; on other platforms, this function indirectly depends on
1446 * the <link linkend="setlocale">current locale</link>.
1448 * Return value: The converted string, or %NULL on an error.
1451 g_filename_to_utf8 (const gchar
*opsysstring
,
1454 gsize
*bytes_written
,
1457 const gchar
*charset
;
1459 g_return_val_if_fail (opsysstring
!= NULL
, NULL
);
1461 if (get_filename_charset (&charset
))
1462 return strdup_len (opsysstring
, len
, bytes_read
, bytes_written
, error
);
1464 return g_convert (opsysstring
, len
,
1465 "UTF-8", charset
, bytes_read
, bytes_written
, error
);
1468 #if defined (G_OS_WIN32) && !defined (_WIN64)
1470 #undef g_filename_to_utf8
1472 /* Binary compatibility version. Not for newly compiled code. Also not needed for
1473 * 64-bit versions as there should be no old deployed binaries that would use
1478 g_filename_to_utf8 (const gchar
*opsysstring
,
1481 gsize
*bytes_written
,
1484 const gchar
*charset
;
1486 g_return_val_if_fail (opsysstring
!= NULL
, NULL
);
1488 if (g_get_charset (&charset
))
1489 return strdup_len (opsysstring
, len
, bytes_read
, bytes_written
, error
);
1491 return g_convert (opsysstring
, len
,
1492 "UTF-8", charset
, bytes_read
, bytes_written
, error
);
1498 * g_filename_from_utf8:
1499 * @utf8string: a UTF-8 encoded string.
1500 * @len: the length of the string, or -1 if the string is
1502 * @bytes_read: location to store the number of bytes in the
1503 * input string that were successfully converted, or %NULL.
1504 * Even if the conversion was successful, this may be
1505 * less than @len if there were partial characters
1506 * at the end of the input. If the error
1507 * #G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
1508 * stored will the byte offset after the last valid
1510 * @bytes_written: the number of bytes stored in the output buffer (not
1511 * including the terminating nul).
1512 * @error: location to store the error occurring, or %NULL to ignore
1513 * errors. Any of the errors in #GConvertError may occur.
1515 * Converts a string from UTF-8 to the encoding GLib uses for
1516 * filenames. Note that on Windows GLib uses UTF-8 for filenames;
1517 * on other platforms, this function indirectly depends on the
1518 * <link linkend="setlocale">current locale</link>.
1520 * Return value: The converted string, or %NULL on an error.
1523 g_filename_from_utf8 (const gchar
*utf8string
,
1526 gsize
*bytes_written
,
1529 const gchar
*charset
;
1531 if (get_filename_charset (&charset
))
1532 return strdup_len (utf8string
, len
, bytes_read
, bytes_written
, error
);
1534 return g_convert (utf8string
, len
,
1535 charset
, "UTF-8", bytes_read
, bytes_written
, error
);
1538 #if defined (G_OS_WIN32) && !defined (_WIN64)
1540 #undef g_filename_from_utf8
1542 /* Binary compatibility version. Not for newly compiled code. */
1545 g_filename_from_utf8 (const gchar
*utf8string
,
1548 gsize
*bytes_written
,
1551 const gchar
*charset
;
1553 if (g_get_charset (&charset
))
1554 return strdup_len (utf8string
, len
, bytes_read
, bytes_written
, error
);
1556 return g_convert (utf8string
, len
,
1557 charset
, "UTF-8", bytes_read
, bytes_written
, error
);
1562 /* Test of haystack has the needle prefix, comparing case
1563 * insensitive. haystack may be UTF-8, but needle must
1564 * contain only ascii. */
1566 has_case_prefix (const gchar
*haystack
, const gchar
*needle
)
1570 /* Eat one character at a time. */
1575 g_ascii_tolower (*n
) == g_ascii_tolower (*h
))
1585 UNSAFE_ALL
= 0x1, /* Escape all unsafe characters */
1586 UNSAFE_ALLOW_PLUS
= 0x2, /* Allows '+' */
1587 UNSAFE_PATH
= 0x8, /* Allows '/', '&', '=', ':', '@', '+', '$' and ',' */
1588 UNSAFE_HOST
= 0x10, /* Allows '/' and ':' and '@' */
1589 UNSAFE_SLASHES
= 0x20 /* Allows all characters except for '/' and '%' */
1590 } UnsafeCharacterSet
;
1592 static const guchar acceptable
[96] = {
1593 /* A table of the ASCII chars from space (32) to DEL (127) */
1594 /* ! " # $ % & ' ( ) * + , - . / */
1595 0x00,0x3F,0x20,0x20,0x28,0x00,0x2C,0x3F,0x3F,0x3F,0x3F,0x2A,0x28,0x3F,0x3F,0x1C,
1596 /* 0 1 2 3 4 5 6 7 8 9 : ; < = > ? */
1597 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x38,0x20,0x20,0x2C,0x20,0x20,
1598 /* @ A B C D E F G H I J K L M N O */
1599 0x38,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,
1600 /* P Q R S T U V W X Y Z [ \ ] ^ _ */
1601 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x20,0x20,0x20,0x20,0x3F,
1602 /* ` a b c d e f g h i j k l m n o */
1603 0x20,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,
1604 /* p q r s t u v w x y z { | } ~ DEL */
1605 0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x3F,0x20,0x20,0x20,0x3F,0x20
1608 static const gchar hex
[16] = "0123456789ABCDEF";
1610 /* Note: This escape function works on file: URIs, but if you want to
1611 * escape something else, please read RFC-2396 */
1613 g_escape_uri_string (const gchar
*string
,
1614 UnsafeCharacterSet mask
)
1616 #define ACCEPTABLE(a) ((a)>=32 && (a)<128 && (acceptable[(a)-32] & use_mask))
1623 UnsafeCharacterSet use_mask
;
1625 g_return_val_if_fail (mask
== UNSAFE_ALL
1626 || mask
== UNSAFE_ALLOW_PLUS
1627 || mask
== UNSAFE_PATH
1628 || mask
== UNSAFE_HOST
1629 || mask
== UNSAFE_SLASHES
, NULL
);
1633 for (p
= string
; *p
!= '\0'; p
++)
1636 if (!ACCEPTABLE (c
))
1640 result
= g_malloc (p
- string
+ unacceptable
* 2 + 1);
1643 for (q
= result
, p
= string
; *p
!= '\0'; p
++)
1647 if (!ACCEPTABLE (c
))
1649 *q
++ = '%'; /* means hex coming */
1664 g_escape_file_uri (const gchar
*hostname
,
1665 const gchar
*pathname
)
1667 char *escaped_hostname
= NULL
;
1672 char *p
, *backslash
;
1674 /* Turn backslashes into forward slashes. That's what Netscape
1675 * does, and they are actually more or less equivalent in Windows.
1678 pathname
= g_strdup (pathname
);
1679 p
= (char *) pathname
;
1681 while ((backslash
= strchr (p
, '\\')) != NULL
)
1688 if (hostname
&& *hostname
!= '\0')
1690 escaped_hostname
= g_escape_uri_string (hostname
, UNSAFE_HOST
);
1693 escaped_path
= g_escape_uri_string (pathname
, UNSAFE_PATH
);
1695 res
= g_strconcat ("file://",
1696 (escaped_hostname
) ? escaped_hostname
: "",
1697 (*escaped_path
!= '/') ? "/" : "",
1702 g_free ((char *) pathname
);
1705 g_free (escaped_hostname
);
1706 g_free (escaped_path
);
1712 unescape_character (const char *scanner
)
1717 first_digit
= g_ascii_xdigit_value (scanner
[0]);
1718 if (first_digit
< 0)
1721 second_digit
= g_ascii_xdigit_value (scanner
[1]);
1722 if (second_digit
< 0)
1725 return (first_digit
<< 4) | second_digit
;
1729 g_unescape_uri_string (const char *escaped
,
1731 const char *illegal_escaped_characters
,
1732 gboolean ascii_must_not_be_escaped
)
1734 const gchar
*in
, *in_end
;
1735 gchar
*out
, *result
;
1738 if (escaped
== NULL
)
1742 len
= strlen (escaped
);
1744 result
= g_malloc (len
+ 1);
1747 for (in
= escaped
, in_end
= escaped
+ len
; in
< in_end
; in
++)
1753 /* catch partial escape sequences past the end of the substring */
1754 if (in
+ 3 > in_end
)
1757 c
= unescape_character (in
+ 1);
1759 /* catch bad escape sequences and NUL characters */
1763 /* catch escaped ASCII */
1764 if (ascii_must_not_be_escaped
&& c
<= 0x7F)
1767 /* catch other illegal escaped characters */
1768 if (strchr (illegal_escaped_characters
, c
) != NULL
)
1777 g_assert (out
- result
<= len
);
1790 is_asciialphanum (gunichar c
)
1792 return c
<= 0x7F && g_ascii_isalnum (c
);
1796 is_asciialpha (gunichar c
)
1798 return c
<= 0x7F && g_ascii_isalpha (c
);
1801 /* allows an empty string */
1803 hostname_validate (const char *hostname
)
1806 gunichar c
, first_char
, last_char
;
1813 /* read in a label */
1814 c
= g_utf8_get_char (p
);
1815 p
= g_utf8_next_char (p
);
1816 if (!is_asciialphanum (c
))
1822 c
= g_utf8_get_char (p
);
1823 p
= g_utf8_next_char (p
);
1825 while (is_asciialphanum (c
) || c
== '-');
1826 if (last_char
== '-')
1829 /* if that was the last label, check that it was a toplabel */
1830 if (c
== '\0' || (c
== '.' && *p
== '\0'))
1831 return is_asciialpha (first_char
);
1838 * g_filename_from_uri:
1839 * @uri: a uri describing a filename (escaped, encoded in ASCII).
1840 * @hostname: Location to store hostname for the URI, or %NULL.
1841 * If there is no hostname in the URI, %NULL will be
1842 * stored in this location.
1843 * @error: location to store the error occurring, or %NULL to ignore
1844 * errors. Any of the errors in #GConvertError may occur.
1846 * Converts an escaped ASCII-encoded URI to a local filename in the
1847 * encoding used for filenames.
1849 * Return value: a newly-allocated string holding the resulting
1850 * filename, or %NULL on an error.
1853 g_filename_from_uri (const gchar
*uri
,
1857 const char *path_part
;
1858 const char *host_part
;
1859 char *unescaped_hostname
;
1870 if (!has_case_prefix (uri
, "file:/"))
1872 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_BAD_URI
,
1873 _("The URI '%s' is not an absolute URI using the \"file\" scheme"),
1878 path_part
= uri
+ strlen ("file:");
1880 if (strchr (path_part
, '#') != NULL
)
1882 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_BAD_URI
,
1883 _("The local file URI '%s' may not include a '#'"),
1888 if (has_case_prefix (path_part
, "///"))
1890 else if (has_case_prefix (path_part
, "//"))
1893 host_part
= path_part
;
1895 path_part
= strchr (path_part
, '/');
1897 if (path_part
== NULL
)
1899 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_BAD_URI
,
1900 _("The URI '%s' is invalid"),
1905 unescaped_hostname
= g_unescape_uri_string (host_part
, path_part
- host_part
, "", TRUE
);
1907 if (unescaped_hostname
== NULL
||
1908 !hostname_validate (unescaped_hostname
))
1910 g_free (unescaped_hostname
);
1911 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_BAD_URI
,
1912 _("The hostname of the URI '%s' is invalid"),
1918 *hostname
= unescaped_hostname
;
1920 g_free (unescaped_hostname
);
1923 filename
= g_unescape_uri_string (path_part
, -1, "/", FALSE
);
1925 if (filename
== NULL
)
1927 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_BAD_URI
,
1928 _("The URI '%s' contains invalidly escaped characters"),
1935 /* Drop localhost */
1936 if (hostname
&& *hostname
!= NULL
&&
1937 g_ascii_strcasecmp (*hostname
, "localhost") == 0)
1943 /* Turn slashes into backslashes, because that's the canonical spelling */
1945 while ((slash
= strchr (p
, '/')) != NULL
)
1951 /* Windows URIs with a drive letter can be like "file://host/c:/foo"
1952 * or "file://host/c|/foo" (some Netscape versions). In those cases, start
1953 * the filename from the drive letter.
1955 if (g_ascii_isalpha (filename
[1]))
1957 if (filename
[2] == ':')
1959 else if (filename
[2] == '|')
1967 result
= g_strdup (filename
+ offs
);
1973 #if defined (G_OS_WIN32) && !defined (_WIN64)
1975 #undef g_filename_from_uri
1978 g_filename_from_uri (const gchar
*uri
,
1982 gchar
*utf8_filename
;
1983 gchar
*retval
= NULL
;
1985 utf8_filename
= g_filename_from_uri_utf8 (uri
, hostname
, error
);
1988 retval
= g_locale_from_utf8 (utf8_filename
, -1, NULL
, NULL
, error
);
1989 g_free (utf8_filename
);
1997 * g_filename_to_uri:
1998 * @filename: an absolute filename specified in the GLib file name encoding,
1999 * which is the on-disk file name bytes on Unix, and UTF-8 on
2001 * @hostname: (allow-none): A UTF-8 encoded hostname, or %NULL for none.
2002 * @error: location to store the error occurring, or %NULL to ignore
2003 * errors. Any of the errors in #GConvertError may occur.
2005 * Converts an absolute filename to an escaped ASCII-encoded URI, with the path
2006 * component following Section 3.3. of RFC 2396.
2008 * Return value: a newly-allocated string holding the resulting
2009 * URI, or %NULL on an error.
2012 g_filename_to_uri (const gchar
*filename
,
2013 const gchar
*hostname
,
2018 g_return_val_if_fail (filename
!= NULL
, NULL
);
2020 if (!g_path_is_absolute (filename
))
2022 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_NOT_ABSOLUTE_PATH
,
2023 _("The pathname '%s' is not an absolute path"),
2029 !(g_utf8_validate (hostname
, -1, NULL
)
2030 && hostname_validate (hostname
)))
2032 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_ILLEGAL_SEQUENCE
,
2033 _("Invalid hostname"));
2038 /* Don't use localhost unnecessarily */
2039 if (hostname
&& g_ascii_strcasecmp (hostname
, "localhost") == 0)
2043 escaped_uri
= g_escape_file_uri (hostname
, filename
);
2048 #if defined (G_OS_WIN32) && !defined (_WIN64)
2050 #undef g_filename_to_uri
2053 g_filename_to_uri (const gchar
*filename
,
2054 const gchar
*hostname
,
2057 gchar
*utf8_filename
;
2058 gchar
*retval
= NULL
;
2060 utf8_filename
= g_locale_to_utf8 (filename
, -1, NULL
, NULL
, error
);
2064 retval
= g_filename_to_uri_utf8 (utf8_filename
, hostname
, error
);
2065 g_free (utf8_filename
);
2074 * g_uri_list_extract_uris:
2075 * @uri_list: an URI list
2077 * Splits an URI list conforming to the text/uri-list
2078 * mime type defined in RFC 2483 into individual URIs,
2079 * discarding any comments. The URIs are not validated.
2081 * Returns: a newly allocated %NULL-terminated list of
2082 * strings holding the individual URIs. The array should
2083 * be freed with g_strfreev().
2088 g_uri_list_extract_uris (const gchar
*uri_list
)
2099 /* We don't actually try to validate the URI according to RFC
2100 * 2396, or even check for allowed characters - we just ignore
2101 * comments and trim whitespace off the ends. We also
2102 * allow LF delimination as well as the specified CRLF.
2104 * We do allow comments like specified in RFC 2483.
2110 while (g_ascii_isspace (*p
))
2114 while (*q
&& (*q
!= '\n') && (*q
!= '\r'))
2120 while (q
> p
&& g_ascii_isspace (*q
))
2125 uris
= g_slist_prepend (uris
, g_strndup (p
, q
- p
+ 1));
2130 p
= strchr (p
, '\n');
2135 result
= g_new (gchar
*, n_uris
+ 1);
2137 result
[n_uris
--] = NULL
;
2138 for (u
= uris
; u
; u
= u
->next
)
2139 result
[n_uris
--] = u
->data
;
2141 g_slist_free (uris
);
2147 * g_filename_display_basename:
2148 * @filename: an absolute pathname in the GLib file name encoding
2150 * Returns the display basename for the particular filename, guaranteed
2151 * to be valid UTF-8. The display name might not be identical to the filename,
2152 * for instance there might be problems converting it to UTF-8, and some files
2153 * can be translated in the display.
2155 * If GLib cannot make sense of the encoding of @filename, as a last resort it
2156 * replaces unknown characters with U+FFFD, the Unicode replacement character.
2157 * You can search the result for the UTF-8 encoding of this character (which is
2158 * "\357\277\275" in octal notation) to find out if @filename was in an invalid
2161 * You must pass the whole absolute pathname to this functions so that
2162 * translation of well known locations can be done.
2164 * This function is preferred over g_filename_display_name() if you know the
2165 * whole path, as it allows translation.
2167 * Return value: a newly allocated string containing
2168 * a rendition of the basename of the filename in valid UTF-8
2173 g_filename_display_basename (const gchar
*filename
)
2178 g_return_val_if_fail (filename
!= NULL
, NULL
);
2180 basename
= g_path_get_basename (filename
);
2181 display_name
= g_filename_display_name (basename
);
2183 return display_name
;
2187 * g_filename_display_name:
2188 * @filename: a pathname hopefully in the GLib file name encoding
2190 * Converts a filename into a valid UTF-8 string. The conversion is
2191 * not necessarily reversible, so you should keep the original around
2192 * and use the return value of this function only for display purposes.
2193 * Unlike g_filename_to_utf8(), the result is guaranteed to be non-%NULL
2194 * even if the filename actually isn't in the GLib file name encoding.
2196 * If GLib cannot make sense of the encoding of @filename, as a last resort it
2197 * replaces unknown characters with U+FFFD, the Unicode replacement character.
2198 * You can search the result for the UTF-8 encoding of this character (which is
2199 * "\357\277\275" in octal notation) to find out if @filename was in an invalid
2202 * If you know the whole pathname of the file you should use
2203 * g_filename_display_basename(), since that allows location-based
2204 * translation of filenames.
2206 * Return value: a newly allocated string containing
2207 * a rendition of the filename in valid UTF-8
2212 g_filename_display_name (const gchar
*filename
)
2215 const gchar
**charsets
;
2216 gchar
*display_name
= NULL
;
2219 is_utf8
= g_get_filename_charsets (&charsets
);
2223 if (g_utf8_validate (filename
, -1, NULL
))
2224 display_name
= g_strdup (filename
);
2229 /* Try to convert from the filename charsets to UTF-8.
2230 * Skip the first charset if it is UTF-8.
2232 for (i
= is_utf8
? 1 : 0; charsets
[i
]; i
++)
2234 display_name
= g_convert (filename
, -1, "UTF-8", charsets
[i
],
2242 /* if all conversions failed, we replace invalid UTF-8
2243 * by a question mark
2246 display_name
= _g_utf8_make_valid (filename
);
2248 return display_name
;