1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
27 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
31 #ifndef __G_CONVERT_H__
32 #define __G_CONVERT_H__
34 #include <glib/gerror.h>
40 * @G_CONVERT_ERROR_NO_CONVERSION: Conversion between the requested character
41 * sets is not supported.
42 * @G_CONVERT_ERROR_ILLEGAL_SEQUENCE: Invalid byte sequence in conversion input.
43 * @G_CONVERT_ERROR_FAILED: Conversion failed for some reason.
44 * @G_CONVERT_ERROR_PARTIAL_INPUT: Partial character sequence at end of input.
45 * @G_CONVERT_ERROR_BAD_URI: URI is invalid.
46 * @G_CONVERT_ERROR_NOT_ABSOLUTE_PATH: Pathname is not an absolute path.
48 * Error codes returned by character set conversion routines.
52 G_CONVERT_ERROR_NO_CONVERSION,
53 G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
54 G_CONVERT_ERROR_FAILED,
55 G_CONVERT_ERROR_PARTIAL_INPUT,
56 G_CONVERT_ERROR_BAD_URI,
57 G_CONVERT_ERROR_NOT_ABSOLUTE_PATH
63 * Error domain for character set conversions. Errors in this domain will
64 * be from the #GConvertError enumeration. See #GError for information on
67 #define G_CONVERT_ERROR g_convert_error_quark()
68 GQuark g_convert_error_quark (void);
73 * The <structname>GIConv</structname> struct wraps an
74 * iconv() conversion descriptor. It contains private data
75 * and should only be accessed using the following functions.
77 typedef struct _GIConv *GIConv;
79 GIConv g_iconv_open (const gchar *to_codeset,
80 const gchar *from_codeset);
81 gsize g_iconv (GIConv converter,
85 gsize *outbytes_left);
86 gint g_iconv_close (GIConv converter);
89 gchar* g_convert (const gchar *str,
91 const gchar *to_codeset,
92 const gchar *from_codeset,
95 GError **error) G_GNUC_MALLOC;
96 gchar* g_convert_with_iconv (const gchar *str,
100 gsize *bytes_written,
101 GError **error) G_GNUC_MALLOC;
102 gchar* g_convert_with_fallback (const gchar *str,
104 const gchar *to_codeset,
105 const gchar *from_codeset,
106 const gchar *fallback,
108 gsize *bytes_written,
109 GError **error) G_GNUC_MALLOC;
112 /* Convert between libc's idea of strings and UTF-8.
114 gchar* g_locale_to_utf8 (const gchar *opsysstring,
117 gsize *bytes_written,
118 GError **error) G_GNUC_MALLOC;
119 gchar* g_locale_from_utf8 (const gchar *utf8string,
122 gsize *bytes_written,
123 GError **error) G_GNUC_MALLOC;
125 /* Convert between the operating system (or C runtime)
126 * representation of file names and UTF-8.
128 gchar* g_filename_to_utf8 (const gchar *opsysstring,
131 gsize *bytes_written,
132 GError **error) G_GNUC_MALLOC;
133 gchar* g_filename_from_utf8 (const gchar *utf8string,
136 gsize *bytes_written,
137 GError **error) G_GNUC_MALLOC;
139 gchar *g_filename_from_uri (const gchar *uri,
141 GError **error) G_GNUC_MALLOC;
143 gchar *g_filename_to_uri (const gchar *filename,
144 const gchar *hostname,
145 GError **error) G_GNUC_MALLOC;
146 gchar *g_filename_display_name (const gchar *filename) G_GNUC_MALLOC;
147 gboolean g_get_filename_charsets (const gchar ***charsets);
149 gchar *g_filename_display_basename (const gchar *filename) G_GNUC_MALLOC;
151 gchar **g_uri_list_extract_uris (const gchar *uri_list) G_GNUC_MALLOC;
154 #define g_filename_to_utf8 g_filename_to_utf8_utf8
155 #define g_filename_from_utf8 g_filename_from_utf8_utf8
156 #define g_filename_from_uri g_filename_from_uri_utf8
157 #define g_filename_to_uri g_filename_to_uri_utf8
159 gchar* g_filename_to_utf8_utf8 (const gchar *opsysstring,
162 gsize *bytes_written,
163 GError **error) G_GNUC_MALLOC;
164 gchar* g_filename_from_utf8_utf8 (const gchar *utf8string,
167 gsize *bytes_written,
168 GError **error) G_GNUC_MALLOC;
169 gchar *g_filename_from_uri_utf8 (const gchar *uri,
171 GError **error) G_GNUC_MALLOC;
172 gchar *g_filename_to_uri_utf8 (const gchar *filename,
173 const gchar *hostname,
174 GError **error) G_GNUC_MALLOC;
179 #endif /* __G_CONVERT_H__ */