regex: Remove obsolete patch
[platform/upstream/glib.git] / glib / gconvert.h
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/.
25  */
26
27 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
29 #endif
30
31 #ifndef __G_CONVERT_H__
32 #define __G_CONVERT_H__
33
34 #include <glib/gerror.h>
35
36 G_BEGIN_DECLS
37
38 /**
39  * GConvertError:
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.
47  *
48  * Error codes returned by character set conversion routines.
49  */
50 typedef enum
51 {
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
58 } GConvertError;
59
60 /**
61  * G_CONVERT_ERROR:
62  *
63  * Error domain for character set conversions. Errors in this domain will
64  * be from the #GConvertError enumeration. See #GError for information on
65  * error domains.
66  */
67 #define G_CONVERT_ERROR g_convert_error_quark()
68 GQuark g_convert_error_quark (void);
69
70 /**
71  * GIconv:
72  *
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.
76  */
77 typedef struct _GIConv *GIConv;
78
79 GIConv g_iconv_open   (const gchar  *to_codeset,
80                        const gchar  *from_codeset);
81 gsize  g_iconv        (GIConv        converter,
82                        gchar       **inbuf,
83                        gsize        *inbytes_left,
84                        gchar       **outbuf,
85                        gsize        *outbytes_left);
86 gint   g_iconv_close  (GIConv        converter);
87
88
89 gchar* g_convert               (const gchar  *str,
90                                 gssize        len,            
91                                 const gchar  *to_codeset,
92                                 const gchar  *from_codeset,
93                                 gsize        *bytes_read,     
94                                 gsize        *bytes_written,  
95                                 GError      **error) G_GNUC_MALLOC;
96 gchar* g_convert_with_iconv    (const gchar  *str,
97                                 gssize        len,
98                                 GIConv        converter,
99                                 gsize        *bytes_read,     
100                                 gsize        *bytes_written,  
101                                 GError      **error) G_GNUC_MALLOC;
102 gchar* g_convert_with_fallback (const gchar  *str,
103                                 gssize        len,            
104                                 const gchar  *to_codeset,
105                                 const gchar  *from_codeset,
106                                 const gchar  *fallback,
107                                 gsize        *bytes_read,     
108                                 gsize        *bytes_written,  
109                                 GError      **error) G_GNUC_MALLOC;
110
111
112 /* Convert between libc's idea of strings and UTF-8.
113  */
114 gchar* g_locale_to_utf8   (const gchar  *opsysstring,
115                            gssize        len,            
116                            gsize        *bytes_read,     
117                            gsize        *bytes_written,  
118                            GError      **error) G_GNUC_MALLOC;
119 gchar* g_locale_from_utf8 (const gchar  *utf8string,
120                            gssize        len,            
121                            gsize        *bytes_read,     
122                            gsize        *bytes_written,  
123                            GError      **error) G_GNUC_MALLOC;
124
125 /* Convert between the operating system (or C runtime)
126  * representation of file names and UTF-8.
127  */
128 #ifndef __GTK_DOC_IGNORE__
129 #ifdef G_OS_WIN32
130 #define g_filename_to_utf8 g_filename_to_utf8_utf8
131 #define g_filename_from_utf8 g_filename_from_utf8_utf8
132 #define g_filename_from_uri g_filename_from_uri_utf8
133 #define g_filename_to_uri g_filename_to_uri_utf8 
134 #endif
135 #endif
136
137 gchar* g_filename_to_utf8   (const gchar  *opsysstring,
138                              gssize        len,            
139                              gsize        *bytes_read,     
140                              gsize        *bytes_written,  
141                              GError      **error) G_GNUC_MALLOC;
142 gchar* g_filename_from_utf8 (const gchar  *utf8string,
143                              gssize        len,            
144                              gsize        *bytes_read,     
145                              gsize        *bytes_written,  
146                              GError      **error) G_GNUC_MALLOC;
147
148 gchar *g_filename_from_uri (const gchar *uri,
149                             gchar      **hostname,
150                             GError     **error) G_GNUC_MALLOC;
151   
152 gchar *g_filename_to_uri   (const gchar *filename,
153                             const gchar *hostname,
154                             GError     **error) G_GNUC_MALLOC;
155 gchar *g_filename_display_name (const gchar *filename) G_GNUC_MALLOC;
156 gboolean g_get_filename_charsets (const gchar ***charsets);
157
158 gchar *g_filename_display_basename (const gchar *filename) G_GNUC_MALLOC;
159
160 gchar **g_uri_list_extract_uris (const gchar *uri_list) G_GNUC_MALLOC;
161
162 G_END_DECLS
163
164 #endif /* __G_CONVERT_H__ */