Updated name of error from G_CONVERT_ERROR_NOT_LOCAL_FILE to
[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 #ifndef __G_CONVERT_H__
28 #define __G_CONVERT_H__
29
30 #include <stddef.h>      /* For size_t */
31 #include <glib/gerror.h>
32
33 G_BEGIN_DECLS
34
35 typedef enum 
36 {
37   G_CONVERT_ERROR_NO_CONVERSION,
38   G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
39   G_CONVERT_ERROR_FAILED,
40   G_CONVERT_ERROR_PARTIAL_INPUT,
41   G_CONVERT_ERROR_NOT_ABSOLUTE_FILE_URI,
42   G_CONVERT_ERROR_INVALID_URI,
43   G_CONVERT_ERROR_NOT_ABSOLUTE_PATH
44 } GConvertError;
45
46 #define G_CONVERT_ERROR g_convert_error_quark()
47 GQuark g_convert_error_quark (void);
48
49 /* Thin wrappers around iconv
50  */
51 typedef struct _GIConv *GIConv;
52
53 GIConv g_iconv_open   (const gchar  *to_codeset,
54                        const gchar  *from_codeset);
55 size_t g_iconv        (GIConv        converter,
56                        gchar       **inbuf,
57                        gsize        *inbytes_left,
58                        gchar       **outbuf,
59                        gsize        *outbytes_left);
60 gint   g_iconv_close  (GIConv        converter);
61
62
63 gchar* g_convert               (const gchar  *str,
64                                 gssize        len,            
65                                 const gchar  *to_codeset,
66                                 const gchar  *from_codeset,
67                                 gsize        *bytes_read,     
68                                 gsize        *bytes_written,  
69                                 GError      **error);
70 gchar* g_convert_with_iconv    (const gchar  *str,
71                                 gssize        len,
72                                 GIConv        converter,
73                                 gsize        *bytes_read,     
74                                 gsize        *bytes_written,  
75                                 GError      **error);
76 gchar* g_convert_with_fallback (const gchar  *str,
77                                 gssize        len,            
78                                 const gchar  *to_codeset,
79                                 const gchar  *from_codeset,
80                                 gchar        *fallback,
81                                 gsize        *bytes_read,     
82                                 gsize        *bytes_written,  
83                                 GError      **error);
84
85
86 /* Convert between libc's idea of strings and UTF-8.
87  */
88 gchar* g_locale_to_utf8   (const gchar  *opsysstring,
89                            gssize        len,            
90                            gsize        *bytes_read,     
91                            gsize        *bytes_written,  
92                            GError      **error);
93 gchar* g_locale_from_utf8 (const gchar  *utf8string,
94                            gssize        len,            
95                            gsize        *bytes_read,     
96                            gsize        *bytes_written,  
97                            GError      **error);
98
99 /* Convert between the operating system (or C runtime)
100  * representation of file names and UTF-8.
101  */
102 gchar* g_filename_to_utf8   (const gchar  *opsysstring,
103                              gssize        len,            
104                              gsize        *bytes_read,     
105                              gsize        *bytes_written,  
106                              GError      **error);
107 gchar* g_filename_from_utf8 (const gchar  *utf8string,
108                              gssize        len,            
109                              gsize        *bytes_read,     
110                              gsize        *bytes_written,  
111                              GError      **error);
112
113 gchar *g_filename_from_uri (const char *uri,
114                             char      **hostname,
115                             GError    **error);
116   
117 gchar *g_filename_to_uri   (const char *filename,
118                             char       *hostname,
119                             GError    **error);
120
121
122 G_END_DECLS
123
124 #endif /* __G_CONVERT_H__ */