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