glib/giochannel.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_IOCHANNEL_H__
  28 #define __G_IOCHANNEL_H__
  29
  30 #include <glib/gmain.h>
  31 #include <glib/gtypes.h>
  32 #include <glib/gstring.h>
  33
  34 G_BEGIN_DECLS
  35
  36 /* GIOChannel
  37  */
  38
  39 typedef struct _GIOChannel      GIOChannel;
  40 typedef struct _GIOFuncs        GIOFuncs;
  41
  42 typedef enum
  43 {
  44   G_IO_ERROR_NONE,
  45   G_IO_ERROR_AGAIN,
  46   G_IO_ERROR_INVAL,
  47   G_IO_ERROR_UNKNOWN
  48 } GIOError;
  49
  50 #define G_IO_CHANNEL_ERROR g_channel_error_quark()
  51
  52 typedef enum
  53 {
  54   /* Derived from errno */
  55   G_IO_CHANNEL_ERROR_ACCES,
  56   G_IO_CHANNEL_ERROR_BADF,
  57   G_IO_CHANNEL_ERROR_DEADLK,
  58   G_IO_CHANNEL_ERROR_FAULT,
  59   G_IO_CHANNEL_ERROR_INVAL,
  60   G_IO_CHANNEL_ERROR_IO,
  61   G_IO_CHANNEL_ERROR_ISDIR,
  62   G_IO_CHANNEL_ERROR_MFILE,
  63   G_IO_CHANNEL_ERROR_NOLCK,
  64   G_IO_CHANNEL_ERROR_NOSPC,
  65   G_IO_CHANNEL_ERROR_PERM,
  66   G_IO_CHANNEL_ERROR_PIPE,
  67   G_IO_CHANNEL_ERROR_SPIPE,
  68   /* Other */
  69   G_IO_CHANNEL_ERROR_ENCODE_RW,
  70   G_IO_CHANNEL_ERROR_FAILED
  71 } GIOChannelError;
  72
  73 typedef enum
  74 {
  75   G_IO_STATUS_ERROR,
  76   G_IO_STATUS_NORMAL,
  77   G_IO_STATUS_EOF,
  78   G_IO_STATUS_PARTIAL_CHARS, /* like EOF, but with unconverted data left */
  79   G_IO_STATUS_AGAIN
  80 } GIOStatus;
  81
  82 typedef enum
  83 {
  84   G_SEEK_CUR,
  85   G_SEEK_SET,
  86   G_SEEK_END
  87 } GSeekType;
  88
  89 typedef enum
  90 {
  91   G_IO_IN       GLIB_SYSDEF_POLLIN,
  92   G_IO_OUT      GLIB_SYSDEF_POLLOUT,
  93   G_IO_PRI      GLIB_SYSDEF_POLLPRI,
  94   G_IO_ERR      GLIB_SYSDEF_POLLERR,
  95   G_IO_HUP      GLIB_SYSDEF_POLLHUP,
  96   G_IO_NVAL     GLIB_SYSDEF_POLLNVAL
  97 } GIOCondition;
  98
  99 #define G_IO_CHANNEL_UNIX_LINE_TERM "\n"
 100 #define G_IO_CHANNEL_DOS_LINE_TERM "\r\n"
 101 #define G_IO_CHANNEL_MACINTOSH_LINE_TERM "\r"
 102 #define G_IO_CHANNEL_ENCODE_RAW "GIOChannelEncodeRaw"
 103
 104 typedef enum
 105 {
 106   G_IO_FLAG_APPEND = 1 << 0,
 107   G_IO_FLAG_NONBLOCK = 1 << 1,
 108   G_IO_FLAG_IS_READABLE = 1 << 2,       /* Read only flag */
 109   G_IO_FLAG_IS_WRITEABLE = 1 << 3,      /* Read only flag */
 110   G_IO_FLAG_IS_SEEKABLE = 1 << 4,       /* Read only flag */
 111   G_IO_FLAG_MASK = (1 << 5) - 1,
 112   G_IO_FLAG_GET_MASK = G_IO_FLAG_MASK,
 113   G_IO_FLAG_SET_MASK = G_IO_FLAG_APPEND | G_IO_FLAG_NONBLOCK,
 114 } GIOFlags;
 115
 116 typedef enum
 117 {
 118   G_IO_FILE_MODE_READ,
 119   G_IO_FILE_MODE_WRITE,
 120   G_IO_FILE_MODE_APPEND,
 121   G_IO_FILE_MODE_READ_WRITE,
 122   G_IO_FILE_MODE_READ_WRITE_TRUNCATE,
 123   G_IO_FILE_MODE_READ_WRITE_APPEND,
 124 } GIOFileMode;
 125
 126 struct _GIOChannel
 127 {
 128   guint channel_flags;
 129   guint ref_count;
 130   GIOFuncs *funcs;
 131
 132   gchar *encoding;
 133   GIConv read_cd;
 134   GIConv write_cd;
 135   gchar *line_term;
 136
 137   gsize buf_size;
 138   GString *read_buf;
 139   GString *encoded_read_buf;
 140   GString *write_buf;
 141
 142   /* Group the flags together to save memory */
 143
 144   gboolean use_buffer : 1;
 145   gboolean do_encode : 1;
 146   gboolean ready_to_read : 1;
 147   gboolean ready_to_write : 1;
 148   gboolean close_on_unref : 1;
 149   gboolean seekable_cached : 1;
 150   gboolean is_seekable : 1;
 151 };
 152
 153 typedef gboolean (*GIOFunc) (GIOChannel   *source,
 154                              GIOCondition  condition,
 155                              gpointer      data);
 156 struct _GIOFuncs
 157 {
 158   GIOStatus (*io_read)           (GIOChannel   *channel,
 159                                   gchar        *buf,
 160                                   gsize         count,
 161                                   gsize        *bytes_read,
 162                                   GError      **err);
 163   GIOStatus (*io_write)          (GIOChannel   *channel,
 164                                   const gchar  *buf,
 165                                   gsize         count,
 166                                   gsize        *bytes_written,
 167                                   GError      **err);
 168   GIOStatus (*io_seek)           (GIOChannel   *channel,
 169                                   glong         offset,
 170                                   GSeekType     type,
 171                                   GError      **err);
 172   GIOStatus  (*io_close)         (GIOChannel   *channel,
 173                                   GError      **err);
 174   GSource*   (*io_create_watch)  (GIOChannel   *channel,
 175                                   GIOCondition  condition);
 176   void       (*io_free)          (GIOChannel   *channel);
 177   GIOStatus  (*io_set_flags)     (GIOChannel   *channel,
 178                                   GIOFlags      flags,
 179                                   GError      **err);
 180   GIOFlags   (*io_get_flags)     (GIOChannel   *channel);
 181 };
 182
 183 void        g_io_channel_init   (GIOChannel    *channel);
 184 void        g_io_channel_ref    (GIOChannel    *channel);
 185 void        g_io_channel_unref  (GIOChannel    *channel);
 186
 187 #ifndef G_DISABLE_DEPRECATED
 188 GIOError    g_io_channel_read   (GIOChannel    *channel,
 189                                  gchar         *buf,
 190                                  gsize          count,
 191                                  gsize         *bytes_read);
 192 GIOError  g_io_channel_write    (GIOChannel    *channel,
 193                                  const gchar   *buf,
 194                                  gsize          count,
 195                                  gsize         *bytes_written);
 196 GIOError  g_io_channel_seek     (GIOChannel    *channel,
 197                                  glong          offset,
 198                                  GSeekType      type);
 199 void      g_io_channel_close    (GIOChannel    *channel);
 200 #endif /* G_DISABLE_DEPRECATED */
 201
 202 GIOStatus g_io_channel_shutdown (GIOChannel      *channel,
 203                                  gboolean         flush,
 204                                  GError         **err);
 205 guint     g_io_add_watch_full   (GIOChannel      *channel,
 206                                  gint             priority,
 207                                  GIOCondition     condition,
 208                                  GIOFunc          func,
 209                                  gpointer         user_data,
 210                                  GDestroyNotify   notify);
 211 GSource * g_io_create_watch     (GIOChannel      *channel,
 212                                  GIOCondition     condition);
 213 guint     g_io_add_watch        (GIOChannel      *channel,
 214                                  GIOCondition     condition,
 215                                  GIOFunc          func,
 216                                  gpointer         user_data);
 217
 218 /* character encoding conversion involved functions.
 219  */
 220
 221 void                  g_io_channel_set_buffer_size      (GIOChannel   *channel,
 222                                                          gsize         size);
 223 gsize                 g_io_channel_get_buffer_size      (GIOChannel   *channel);
 224 GIOCondition          g_io_channel_get_buffer_condition (GIOChannel   *channel);
 225 GIOStatus             g_io_channel_set_flags            (GIOChannel   *channel,
 226                                                          GIOFlags      flags,
 227                                                          GError      **error);
 228 GIOFlags              g_io_channel_get_flags            (GIOChannel   *channel);
 229 void                  g_io_channel_set_line_term        (GIOChannel   *channel,
 230                                                          const gchar  *line_term);
 231 G_CONST_RETURN gchar* g_io_channel_get_line_term        (GIOChannel   *channel);
 232 GIOStatus             g_io_channel_set_encoding         (GIOChannel   *channel,
 233                                                          const gchar  *encoding,
 234                                                          GError      **error);
 235 G_CONST_RETURN gchar* g_io_channel_get_encoding         (GIOChannel   *channel);
 236
 237
 238 GIOStatus   g_io_channel_flush            (GIOChannel   *channel,
 239                                            GError      **error);
 240 GIOStatus   g_io_channel_read_line        (GIOChannel   *channel,
 241                                            gchar       **str_return,
 242                                            gsize        *length,
 243                                            gsize        *terminator_pos,
 244                                            GError      **error);
 245 GIOStatus   g_io_channel_read_line_string (GIOChannel   *channel,
 246                                            GString      *buffer,
 247                                            gsize        *terminator_pos,
 248                                            GError      **error);
 249 GIOStatus   g_io_channel_read_to_end      (GIOChannel   *channel,
 250                                            gchar       **str_return,
 251                                            gsize        *length,
 252                                            GError      **error);
 253 GIOStatus   g_io_channel_read_chars       (GIOChannel   *channel,
 254                                            gchar        *buf,
 255                                            gsize         count,
 256                                            gsize        *bytes_read,
 257                                            GError      **error);
 258 GIOStatus   g_io_channel_write_chars      (GIOChannel   *channel,
 259                                            const gchar  *buf,
 260                                            gssize        count,
 261                                            gsize        *bytes_written,
 262                                            GError      **error);
 263 GIOStatus   g_io_channel_seek_position    (GIOChannel   *channel,
 264                                            glong         offset,
 265                                            GSeekType     type,
 266                                            GError      **error);
 267 GIOChannel* g_io_channel_new_file         (const gchar  *filename,
 268                                            GIOFileMode   mode,
 269                                            GError      **error);
 270
 271 /* Error handling */
 272
 273 GQuark          g_channel_error_quark      (void);
 274 GIOChannelError g_channel_error_from_errno (gint en);
 275
 276 /* On Unix, IO channels created with this function for any file
 277  * descriptor or socket.
 278  *
 279  * On Win32, this can be used either for files opened with the MSVCRT
 280  * (the Microsoft run-time C library) _open() or _pipe, including file
 281  * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr),
 282  * or for Winsock SOCKETs. If the parameter is a legal file
 283  * descriptor, it is assumed to be such, otherwise it should be a
 284  * SOCKET. This relies on SOCKETs and file descriptors not
 285  * overlapping. If you want to be certain, call either
 286  * g_io_channel_win32_new_fd() or g_io_channel_win32_new_socket()
 287  * instead as appropriate.
 288  *
 289  * The term file descriptor as used in the context of Win32 refers to
 290  * the emulated Unix-like file descriptors MSVCRT provides. The native
 291  * corresponding concept is file HANDLE. There isn't as of yet a way to
 292  * get GIOChannels for Win32 file HANDLEs.
 293  */
 294 GIOChannel* g_io_channel_unix_new    (int         fd);
 295 gint        g_io_channel_unix_get_fd (GIOChannel *channel);
 296
 297 #ifdef G_OS_WIN32
 298
 299 #define G_WIN32_MSG_HANDLE 19981206
 300
 301 /* Use this to get a GPollFD from a GIOChannel, so that you can call
 302  * g_io_channel_win32_poll(). After calling this you should only use
 303  * g_io_channel_read() to read from the GIOChannel, i.e. never read()
 304  * from the underlying file descriptor. For SOCKETs, it is possible to call
 305  * recv().
 306  */
 307 void        g_io_channel_win32_make_pollfd (GIOChannel   *channel,
 308                                             GIOCondition  condition,
 309                                             GPollFD      *fd);
 310
 311 /* This can be used to wait a until at least one of the channels is readable.
 312  * On Unix you would do a select() on the file descriptors of the channels.
 313  */
 314 gint        g_io_channel_win32_poll   (GPollFD    *fds,
 315                                        gint        n_fds,
 316                                        gint        timeout);
 317
 318 /* This is used to add polling for Windows messages. GDK (GTk+) programs
 319  * should *not* use this.
 320  */
 321 void        g_main_poll_win32_msg_add (gint        priority,
 322                                        GPollFD    *fd,
 323                                        guint       hwnd);
 324
 325 /* Create an IO channel for Windows messages for window handle hwnd. */
 326 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
 327
 328 /* Create an IO channel for C runtime (emulated Unix-like) file
 329  * descriptors. After calling g_io_add_watch() on a IO channel
 330  * returned by this function, you shouldn't call read() on the file
 331  * descriptor. This is because adding polling for a file descriptor is
 332  * implemented on Win32 by starting a thread that sits blocked in a
 333  * read() from the file descriptor most of the time. All reads from
 334  * the file descriptor should be done by this internal GLib
 335  * thread. Your code should call only g_io_channel_read().
 336  */
 337 GIOChannel* g_io_channel_win32_new_fd (gint         fd);
 338
 339 /* Get the C runtime file descriptor of a channel. */
 340 gint        g_io_channel_win32_get_fd (GIOChannel *channel);
 341
 342 /* Create an IO channel for a winsock socket. The parameter should be
 343  * a SOCKET. Contrary to IO channels for file descriptors (on *Win32),
 344  * you can use normal recv() or recvfrom() on sockets even if GLib
 345  * is polling them.
 346  */
 347 GIOChannel *g_io_channel_win32_new_socket (gint socket);
 348
 349 #endif
 350
 351 G_END_DECLS
 352
 353 #endif /* __G_IOCHANNEL_H__ */