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 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  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 GLIB_AVAILABLE_IN_ALL
  69 GQuark g_convert_error_quark (void);
  70
  71 /**
  72  * GIconv:
  73  *
  74  * The <structname>GIConv</structname> struct wraps an
  75  * iconv() conversion descriptor. It contains private data
  76  * and should only be accessed using the following functions.
  77  */
  78 typedef struct _GIConv *GIConv;
  79
  80 GLIB_AVAILABLE_IN_ALL
  81 GIConv g_iconv_open   (const gchar  *to_codeset,
  82                        const gchar  *from_codeset);
  83 GLIB_AVAILABLE_IN_ALL
  84 gsize  g_iconv        (GIConv        converter,
  85                        gchar       **inbuf,
  86                        gsize        *inbytes_left,
  87                        gchar       **outbuf,
  88                        gsize        *outbytes_left);
  89 GLIB_AVAILABLE_IN_ALL
  90 gint   g_iconv_close  (GIConv        converter);
  91
  92
  93 GLIB_AVAILABLE_IN_ALL
  94 gchar* g_convert               (const gchar  *str,
  95                                 gssize        len,
  96                                 const gchar  *to_codeset,
  97                                 const gchar  *from_codeset,
  98                                 gsize        *bytes_read,
  99                                 gsize        *bytes_written,
 100                                 GError      **error) G_GNUC_MALLOC;
 101 GLIB_AVAILABLE_IN_ALL
 102 gchar* g_convert_with_iconv    (const gchar  *str,
 103                                 gssize        len,
 104                                 GIConv        converter,
 105                                 gsize        *bytes_read,
 106                                 gsize        *bytes_written,
 107                                 GError      **error) G_GNUC_MALLOC;
 108 GLIB_AVAILABLE_IN_ALL
 109 gchar* g_convert_with_fallback (const gchar  *str,
 110                                 gssize        len,
 111                                 const gchar  *to_codeset,
 112                                 const gchar  *from_codeset,
 113                                 const gchar  *fallback,
 114                                 gsize        *bytes_read,
 115                                 gsize        *bytes_written,
 116                                 GError      **error) G_GNUC_MALLOC;
 117
 118
 119 /* Convert between libc's idea of strings and UTF-8.
 120  */
 121 GLIB_AVAILABLE_IN_ALL
 122 gchar* g_locale_to_utf8   (const gchar  *opsysstring,
 123                            gssize        len,
 124                            gsize        *bytes_read,
 125                            gsize        *bytes_written,
 126                            GError      **error) G_GNUC_MALLOC;
 127 GLIB_AVAILABLE_IN_ALL
 128 gchar* g_locale_from_utf8 (const gchar  *utf8string,
 129                            gssize        len,
 130                            gsize        *bytes_read,
 131                            gsize        *bytes_written,
 132                            GError      **error) G_GNUC_MALLOC;
 133
 134 /* Convert between the operating system (or C runtime)
 135  * representation of file names and UTF-8.
 136  */
 137 GLIB_AVAILABLE_IN_ALL
 138 gchar* g_filename_to_utf8   (const gchar  *opsysstring,
 139                              gssize        len,
 140                              gsize        *bytes_read,
 141                              gsize        *bytes_written,
 142                              GError      **error) G_GNUC_MALLOC;
 143 GLIB_AVAILABLE_IN_ALL
 144 gchar* g_filename_from_utf8 (const gchar  *utf8string,
 145                              gssize        len,
 146                              gsize        *bytes_read,
 147                              gsize        *bytes_written,
 148                              GError      **error) G_GNUC_MALLOC;
 149
 150 GLIB_AVAILABLE_IN_ALL
 151 gchar *g_filename_from_uri (const gchar *uri,
 152                             gchar      **hostname,
 153                             GError     **error) G_GNUC_MALLOC;
 154
 155 GLIB_AVAILABLE_IN_ALL
 156 gchar *g_filename_to_uri   (const gchar *filename,
 157                             const gchar *hostname,
 158                             GError     **error) G_GNUC_MALLOC;
 159 GLIB_AVAILABLE_IN_ALL
 160 gchar *g_filename_display_name (const gchar *filename) G_GNUC_MALLOC;
 161 GLIB_AVAILABLE_IN_ALL
 162 gboolean g_get_filename_charsets (const gchar ***charsets);
 163
 164 GLIB_AVAILABLE_IN_ALL
 165 gchar *g_filename_display_basename (const gchar *filename) G_GNUC_MALLOC;
 166
 167 GLIB_AVAILABLE_IN_ALL
 168 gchar **g_uri_list_extract_uris (const gchar *uri_list) G_GNUC_MALLOC;
 169
 170 #ifdef G_OS_WIN32
 171 #define g_filename_to_utf8   g_filename_to_utf8_utf8
 172 #define g_filename_from_utf8 g_filename_from_utf8_utf8
 173 #define g_filename_from_uri  g_filename_from_uri_utf8
 174 #define g_filename_to_uri    g_filename_to_uri_utf8
 175
 176 GLIB_AVAILABLE_IN_ALL
 177 gchar* g_filename_to_utf8_utf8   (const gchar  *opsysstring,
 178                                   gssize        len,
 179                                   gsize        *bytes_read,
 180                                   gsize        *bytes_written,
 181                                   GError      **error) G_GNUC_MALLOC;
 182 GLIB_AVAILABLE_IN_ALL
 183 gchar* g_filename_from_utf8_utf8 (const gchar  *utf8string,
 184                                   gssize        len,
 185                                   gsize        *bytes_read,
 186                                   gsize        *bytes_written,
 187                                   GError      **error) G_GNUC_MALLOC;
 188 GLIB_AVAILABLE_IN_ALL
 189 gchar *g_filename_from_uri_utf8  (const gchar  *uri,
 190                                   gchar       **hostname,
 191                                   GError      **error) G_GNUC_MALLOC;
 192 GLIB_AVAILABLE_IN_ALL
 193 gchar *g_filename_to_uri_utf8    (const gchar  *filename,
 194                                   const gchar  *hostname,
 195                                   GError      **error) G_GNUC_MALLOC;
 196 #endif
 197
 198 G_END_DECLS
 199
 200 #endif /* __G_CONVERT_H__ */