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(G_DISABLE_SINGLE_INCLUDES) && !defined (__G_LIB_H__) && !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 typedef enum
  39 {
  40   G_CONVERT_ERROR_NO_CONVERSION,
  41   G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
  42   G_CONVERT_ERROR_FAILED,
  43   G_CONVERT_ERROR_PARTIAL_INPUT,
  44   G_CONVERT_ERROR_BAD_URI,
  45   G_CONVERT_ERROR_NOT_ABSOLUTE_PATH
  46 } GConvertError;
  47
  48 #define G_CONVERT_ERROR g_convert_error_quark()
  49 GQuark g_convert_error_quark (void);
  50
  51 /* Thin wrappers around iconv
  52  */
  53 typedef struct _GIConv *GIConv;
  54
  55 GIConv g_iconv_open   (const gchar  *to_codeset,
  56                        const gchar  *from_codeset);
  57 gsize  g_iconv        (GIConv        converter,
  58                        gchar       **inbuf,
  59                        gsize        *inbytes_left,
  60                        gchar       **outbuf,
  61                        gsize        *outbytes_left);
  62 gint   g_iconv_close  (GIConv        converter);
  63
  64
  65 gchar* g_convert               (const gchar  *str,
  66                                 gssize        len,
  67                                 const gchar  *to_codeset,
  68                                 const gchar  *from_codeset,
  69                                 gsize        *bytes_read,
  70                                 gsize        *bytes_written,
  71                                 GError      **error) G_GNUC_MALLOC;
  72 gchar* g_convert_with_iconv    (const gchar  *str,
  73                                 gssize        len,
  74                                 GIConv        converter,
  75                                 gsize        *bytes_read,
  76                                 gsize        *bytes_written,
  77                                 GError      **error) G_GNUC_MALLOC;
  78 gchar* g_convert_with_fallback (const gchar  *str,
  79                                 gssize        len,
  80                                 const gchar  *to_codeset,
  81                                 const gchar  *from_codeset,
  82                                 gchar        *fallback,
  83                                 gsize        *bytes_read,
  84                                 gsize        *bytes_written,
  85                                 GError      **error) G_GNUC_MALLOC;
  86
  87
  88 /* Convert between libc's idea of strings and UTF-8.
  89  */
  90 gchar* g_locale_to_utf8   (const gchar  *opsysstring,
  91                            gssize        len,
  92                            gsize        *bytes_read,
  93                            gsize        *bytes_written,
  94                            GError      **error) G_GNUC_MALLOC;
  95 gchar* g_locale_from_utf8 (const gchar  *utf8string,
  96                            gssize        len,
  97                            gsize        *bytes_read,
  98                            gsize        *bytes_written,
  99                            GError      **error) G_GNUC_MALLOC;
 100
 101 /* Convert between the operating system (or C runtime)
 102  * representation of file names and UTF-8.
 103  */
 104 #ifdef G_OS_WIN32
 105 #define g_filename_to_utf8 g_filename_to_utf8_utf8
 106 #define g_filename_from_utf8 g_filename_from_utf8_utf8
 107 #define g_filename_from_uri g_filename_from_uri_utf8
 108 #define g_filename_to_uri g_filename_to_uri_utf8
 109 #endif
 110
 111 gchar* g_filename_to_utf8   (const gchar  *opsysstring,
 112                              gssize        len,
 113                              gsize        *bytes_read,
 114                              gsize        *bytes_written,
 115                              GError      **error) G_GNUC_MALLOC;
 116 gchar* g_filename_from_utf8 (const gchar  *utf8string,
 117                              gssize        len,
 118                              gsize        *bytes_read,
 119                              gsize        *bytes_written,
 120                              GError      **error) G_GNUC_MALLOC;
 121
 122 gchar *g_filename_from_uri (const gchar *uri,
 123                             gchar      **hostname,
 124                             GError     **error) G_GNUC_MALLOC;
 125
 126 gchar *g_filename_to_uri   (const gchar *filename,
 127                             const gchar *hostname,
 128                             GError     **error) G_GNUC_MALLOC;
 129 gchar *g_filename_display_name (const gchar *filename) G_GNUC_MALLOC;
 130 gboolean g_get_filename_charsets (G_CONST_RETURN gchar ***charsets);
 131
 132 gchar *g_filename_display_basename (const gchar *filename) G_GNUC_MALLOC;
 133
 134 gchar **g_uri_list_extract_uris (const gchar *uri_list) G_GNUC_MALLOC;
 135
 136 G_END_DECLS
 137
 138 #endif /* __G_CONVERT_H__ */