Up version to 1.3.2
[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 <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 } GConvertError;
42
43 #define G_CONVERT_ERROR g_convert_error_quark()
44 GQuark g_convert_error_quark();
45
46 /* Thin wrappers around iconv
47  */
48 typedef struct _GIConv *GIConv;
49
50 GIConv g_iconv_open   (const gchar  *to_codeset,
51                        const gchar  *from_codeset);
52 size_t g_iconv        (GIConv        converter,
53                        gchar       **inbuf,
54                        size_t       *inbytes_left,
55                        gchar       **outbuf,
56                        size_t       *outbytes_left);
57 gint   g_iconv_close  (GIConv        converter);
58
59
60 gchar* g_convert               (const gchar  *str,
61                                 gint          len,
62                                 const gchar  *to_codeset,
63                                 const gchar  *from_codeset,
64                                 gint         *bytes_read,
65                                 gint         *bytes_written,
66                                 GError      **error);
67 gchar* g_convert_with_fallback (const gchar  *str,
68                                 gint          len,
69                                 const gchar  *to_codeset,
70                                 const gchar  *from_codeset,
71                                 gchar        *fallback,
72                                 gint         *bytes_read,
73                                 gint         *bytes_written,
74                                 GError      **error);
75
76
77 /* Convert between libc's idea of strings and UTF-8.
78  */
79 gchar*   g_locale_to_utf8 (const gchar *opsysstring, GError **error);
80 gchar*   g_locale_from_utf8 (const gchar *utf8string, GError **error);
81
82 /* Convert between the operating system (or C runtime)
83  * representation of file names and UTF-8.
84  */
85 gchar*   g_filename_to_utf8 (const gchar *opsysstring, GError **error);
86 gchar*   g_filename_from_utf8 (const gchar *utf8string, GError **error);
87
88 G_END_DECLS
89
90 #endif /* __G_CONVERT_H__ */