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  * SPDX-License-Identifier: LGPL-2.1-or-later
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  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 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gconvert.h>
  35 #include <glib/gmain.h>
  36 #include <glib/gstring.h>
  37
  38 G_BEGIN_DECLS
  39
  40 /* GIOChannel
  41  */
  42
  43 typedef struct _GIOChannel      GIOChannel;
  44 typedef struct _GIOFuncs        GIOFuncs;
  45
  46 typedef enum
  47 {
  48   G_IO_ERROR_NONE,
  49   G_IO_ERROR_AGAIN,
  50   G_IO_ERROR_INVAL,
  51   G_IO_ERROR_UNKNOWN
  52 } GIOError;
  53
  54 #define G_IO_CHANNEL_ERROR g_io_channel_error_quark()
  55
  56 typedef enum
  57 {
  58   /* Derived from errno */
  59   G_IO_CHANNEL_ERROR_FBIG,
  60   G_IO_CHANNEL_ERROR_INVAL,
  61   G_IO_CHANNEL_ERROR_IO,
  62   G_IO_CHANNEL_ERROR_ISDIR,
  63   G_IO_CHANNEL_ERROR_NOSPC,
  64   G_IO_CHANNEL_ERROR_NXIO,
  65   G_IO_CHANNEL_ERROR_OVERFLOW,
  66   G_IO_CHANNEL_ERROR_PIPE,
  67   /* Other */
  68   G_IO_CHANNEL_ERROR_FAILED
  69 } GIOChannelError;
  70
  71 typedef enum
  72 {
  73   G_IO_STATUS_ERROR,
  74   G_IO_STATUS_NORMAL,
  75   G_IO_STATUS_EOF,
  76   G_IO_STATUS_AGAIN
  77 } GIOStatus;
  78
  79 typedef enum
  80 {
  81   G_SEEK_CUR,
  82   G_SEEK_SET,
  83   G_SEEK_END
  84 } GSeekType;
  85
  86 typedef enum
  87 {
  88   G_IO_FLAG_NONE GLIB_AVAILABLE_ENUMERATOR_IN_2_74 = 0,
  89   G_IO_FLAG_APPEND = 1 << 0,
  90   G_IO_FLAG_NONBLOCK = 1 << 1,
  91   G_IO_FLAG_IS_READABLE = 1 << 2,       /* Read only flag */
  92   G_IO_FLAG_IS_WRITABLE = 1 << 3,       /* Read only flag */
  93   G_IO_FLAG_IS_WRITEABLE = 1 << 3,      /* Misspelling in 2.29.10 and earlier */
  94   G_IO_FLAG_IS_SEEKABLE = 1 << 4,       /* Read only flag */
  95   G_IO_FLAG_MASK = (1 << 5) - 1,
  96   G_IO_FLAG_GET_MASK = G_IO_FLAG_MASK,
  97   G_IO_FLAG_SET_MASK = G_IO_FLAG_APPEND | G_IO_FLAG_NONBLOCK
  98 } GIOFlags;
  99
 100 struct _GIOChannel
 101 {
 102   /*< private >*/
 103   gint ref_count;
 104   GIOFuncs *funcs;
 105
 106   gchar *encoding;
 107   GIConv read_cd;
 108   GIConv write_cd;
 109   gchar *line_term;             /* String which indicates the end of a line of text */
 110   guint line_term_len;          /* So we can have null in the line term */
 111
 112   gsize buf_size;
 113   GString *read_buf;            /* Raw data from the channel */
 114   GString *encoded_read_buf;    /* Channel data converted to UTF-8 */
 115   GString *write_buf;           /* Data ready to be written to the file */
 116   gchar partial_write_buf[6];   /* UTF-8 partial characters, null terminated */
 117
 118   /* Group the flags together, immediately after partial_write_buf, to save memory */
 119
 120   guint use_buffer     : 1;     /* The encoding uses the buffers */
 121   guint do_encode      : 1;     /* The encoding uses the GIConv coverters */
 122   guint close_on_unref : 1;     /* Close the channel on final unref */
 123   guint is_readable    : 1;     /* Cached GIOFlag */
 124   guint is_writeable   : 1;     /* ditto */
 125   guint is_seekable    : 1;     /* ditto */
 126
 127   gpointer reserved1;
 128   gpointer reserved2;
 129 };
 130
 131 typedef gboolean (*GIOFunc) (GIOChannel   *source,
 132                              GIOCondition  condition,
 133                              gpointer      data);
 134 struct _GIOFuncs
 135 {
 136   GIOStatus (*io_read)           (GIOChannel   *channel,
 137                                   gchar        *buf,
 138                                   gsize         count,
 139                                   gsize        *bytes_read,
 140                                   GError      **err);
 141   GIOStatus (*io_write)          (GIOChannel   *channel,
 142                                   const gchar  *buf,
 143                                   gsize         count,
 144                                   gsize        *bytes_written,
 145                                   GError      **err);
 146   GIOStatus (*io_seek)           (GIOChannel   *channel,
 147                                   gint64        offset,
 148                                   GSeekType     type,
 149                                   GError      **err);
 150   GIOStatus  (*io_close)         (GIOChannel   *channel,
 151                                   GError      **err);
 152   GSource*   (*io_create_watch)  (GIOChannel   *channel,
 153                                   GIOCondition  condition);
 154   void       (*io_free)          (GIOChannel   *channel);
 155   GIOStatus  (*io_set_flags)     (GIOChannel   *channel,
 156                                   GIOFlags      flags,
 157                                   GError      **err);
 158   GIOFlags   (*io_get_flags)     (GIOChannel   *channel);
 159 };
 160
 161 GLIB_AVAILABLE_IN_ALL
 162 void        g_io_channel_init   (GIOChannel    *channel);
 163 GLIB_AVAILABLE_IN_ALL
 164 GIOChannel *g_io_channel_ref    (GIOChannel    *channel);
 165 GLIB_AVAILABLE_IN_ALL
 166 void        g_io_channel_unref  (GIOChannel    *channel);
 167
 168 GLIB_DEPRECATED_FOR(g_io_channel_read_chars)
 169 GIOError    g_io_channel_read   (GIOChannel    *channel,
 170                                  gchar         *buf,
 171                                  gsize          count,
 172                                  gsize         *bytes_read);
 173
 174 GLIB_DEPRECATED_FOR(g_io_channel_write_chars)
 175 GIOError  g_io_channel_write    (GIOChannel    *channel,
 176                                  const gchar   *buf,
 177                                  gsize          count,
 178                                  gsize         *bytes_written);
 179
 180 GLIB_DEPRECATED_FOR(g_io_channel_seek_position)
 181 GIOError  g_io_channel_seek     (GIOChannel    *channel,
 182                                  gint64         offset,
 183                                  GSeekType      type);
 184
 185 GLIB_DEPRECATED_FOR(g_io_channel_shutdown)
 186 void      g_io_channel_close    (GIOChannel    *channel);
 187
 188 GLIB_AVAILABLE_IN_ALL
 189 GIOStatus g_io_channel_shutdown (GIOChannel      *channel,
 190                                  gboolean         flush,
 191                                  GError         **err);
 192 GLIB_AVAILABLE_IN_ALL
 193 guint     g_io_add_watch_full   (GIOChannel      *channel,
 194                                  gint             priority,
 195                                  GIOCondition     condition,
 196                                  GIOFunc          func,
 197                                  gpointer         user_data,
 198                                  GDestroyNotify   notify);
 199 GLIB_AVAILABLE_IN_ALL
 200 GSource * g_io_create_watch     (GIOChannel      *channel,
 201                                  GIOCondition     condition);
 202 GLIB_AVAILABLE_IN_ALL
 203 guint     g_io_add_watch        (GIOChannel      *channel,
 204                                  GIOCondition     condition,
 205                                  GIOFunc          func,
 206                                  gpointer         user_data);
 207
 208 /* character encoding conversion involved functions.
 209  */
 210
 211 GLIB_AVAILABLE_IN_ALL
 212 void                  g_io_channel_set_buffer_size      (GIOChannel   *channel,
 213                                                          gsize         size);
 214 GLIB_AVAILABLE_IN_ALL
 215 gsize                 g_io_channel_get_buffer_size      (GIOChannel   *channel);
 216 GLIB_AVAILABLE_IN_ALL
 217 GIOCondition          g_io_channel_get_buffer_condition (GIOChannel   *channel);
 218 GLIB_AVAILABLE_IN_ALL
 219 GIOStatus             g_io_channel_set_flags            (GIOChannel   *channel,
 220                                                          GIOFlags      flags,
 221                                                          GError      **error);
 222 GLIB_AVAILABLE_IN_ALL
 223 GIOFlags              g_io_channel_get_flags            (GIOChannel   *channel);
 224 GLIB_AVAILABLE_IN_ALL
 225 void                  g_io_channel_set_line_term        (GIOChannel   *channel,
 226                                                          const gchar  *line_term,
 227                                                          gint          length);
 228 GLIB_AVAILABLE_IN_ALL
 229 const gchar *         g_io_channel_get_line_term        (GIOChannel   *channel,
 230                                                          gint         *length);
 231 GLIB_AVAILABLE_IN_ALL
 232 void                  g_io_channel_set_buffered         (GIOChannel   *channel,
 233                                                          gboolean      buffered);
 234 GLIB_AVAILABLE_IN_ALL
 235 gboolean              g_io_channel_get_buffered         (GIOChannel   *channel);
 236 GLIB_AVAILABLE_IN_ALL
 237 GIOStatus             g_io_channel_set_encoding         (GIOChannel   *channel,
 238                                                          const gchar  *encoding,
 239                                                          GError      **error);
 240 GLIB_AVAILABLE_IN_ALL
 241 const gchar *         g_io_channel_get_encoding         (GIOChannel   *channel);
 242 GLIB_AVAILABLE_IN_ALL
 243 void                  g_io_channel_set_close_on_unref   (GIOChannel   *channel,
 244                                                          gboolean      do_close);
 245 GLIB_AVAILABLE_IN_ALL
 246 gboolean              g_io_channel_get_close_on_unref   (GIOChannel   *channel);
 247
 248
 249 GLIB_AVAILABLE_IN_ALL
 250 GIOStatus   g_io_channel_flush            (GIOChannel   *channel,
 251                                            GError      **error);
 252 GLIB_AVAILABLE_IN_ALL
 253 GIOStatus   g_io_channel_read_line        (GIOChannel   *channel,
 254                                            gchar       **str_return,
 255                                            gsize        *length,
 256                                            gsize        *terminator_pos,
 257                                            GError      **error);
 258 GLIB_AVAILABLE_IN_ALL
 259 GIOStatus   g_io_channel_read_line_string (GIOChannel   *channel,
 260                                            GString      *buffer,
 261                                            gsize        *terminator_pos,
 262                                            GError      **error);
 263 GLIB_AVAILABLE_IN_ALL
 264 GIOStatus   g_io_channel_read_to_end      (GIOChannel   *channel,
 265                                            gchar       **str_return,
 266                                            gsize        *length,
 267                                            GError      **error);
 268 GLIB_AVAILABLE_IN_ALL
 269 GIOStatus   g_io_channel_read_chars       (GIOChannel   *channel,
 270                                            gchar        *buf,
 271                                            gsize         count,
 272                                            gsize        *bytes_read,
 273                                            GError      **error);
 274 GLIB_AVAILABLE_IN_ALL
 275 GIOStatus   g_io_channel_read_unichar     (GIOChannel   *channel,
 276                                            gunichar     *thechar,
 277                                            GError      **error);
 278 GLIB_AVAILABLE_IN_ALL
 279 GIOStatus   g_io_channel_write_chars      (GIOChannel   *channel,
 280                                            const gchar  *buf,
 281                                            gssize        count,
 282                                            gsize        *bytes_written,
 283                                            GError      **error);
 284 GLIB_AVAILABLE_IN_ALL
 285 GIOStatus   g_io_channel_write_unichar    (GIOChannel   *channel,
 286                                            gunichar      thechar,
 287                                            GError      **error);
 288 GLIB_AVAILABLE_IN_ALL
 289 GIOStatus   g_io_channel_seek_position    (GIOChannel   *channel,
 290                                            gint64        offset,
 291                                            GSeekType     type,
 292                                            GError      **error);
 293 GLIB_AVAILABLE_IN_ALL
 294 GIOChannel* g_io_channel_new_file         (const gchar  *filename,
 295                                            const gchar  *mode,
 296                                            GError      **error);
 297
 298 /* Error handling */
 299
 300 GLIB_AVAILABLE_IN_ALL
 301 GQuark          g_io_channel_error_quark      (void);
 302 GLIB_AVAILABLE_IN_ALL
 303 GIOChannelError g_io_channel_error_from_errno (gint en);
 304
 305 /* On Unix, IO channels created with this function for any file
 306  * descriptor or socket.
 307  *
 308  * On Win32, this can be used either for files opened with the MSVCRT
 309  * (the Microsoft run-time C library) _open() or _pipe, including file
 310  * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr),
 311  * or for Winsock SOCKETs. If the parameter is a legal file
 312  * descriptor, it is assumed to be such, otherwise it should be a
 313  * SOCKET. This relies on SOCKETs and file descriptors not
 314  * overlapping. If you want to be certain, call either
 315  * g_io_channel_win32_new_fd() or g_io_channel_win32_new_socket()
 316  * instead as appropriate.
 317  *
 318  * The term file descriptor as used in the context of Win32 refers to
 319  * the emulated Unix-like file descriptors MSVCRT provides. The native
 320  * corresponding concept is file HANDLE. There isn't as of yet a way to
 321  * get GIOChannels for Win32 file HANDLEs.
 322  */
 323 GLIB_AVAILABLE_IN_ALL
 324 GIOChannel* g_io_channel_unix_new    (int         fd);
 325 GLIB_AVAILABLE_IN_ALL
 326 gint        g_io_channel_unix_get_fd (GIOChannel *channel);
 327
 328
 329 /* Hook for GClosure / GSource integration. Don't touch */
 330 GLIB_VAR GSourceFuncs g_io_watch_funcs;
 331
 332 #ifdef G_OS_WIN32
 333
 334 /* You can use this "pseudo file descriptor" in a GPollFD to add
 335  * polling for Windows messages. GTK applications should not do that.
 336  */
 337
 338 #define G_WIN32_MSG_HANDLE 19981206
 339
 340 /* Use this to get a GPollFD from a GIOChannel, so that you can call
 341  * g_io_channel_win32_poll(). After calling this you should only use
 342  * g_io_channel_read() to read from the GIOChannel, i.e. never read()
 343  * from the underlying file descriptor. For SOCKETs, it is possible to call
 344  * recv().
 345  */
 346 GLIB_AVAILABLE_IN_ALL
 347 void        g_io_channel_win32_make_pollfd (GIOChannel   *channel,
 348                                             GIOCondition  condition,
 349                                             GPollFD      *fd);
 350
 351 /* This can be used to wait until at least one of the channels is readable.
 352  * On Unix you would do a select() on the file descriptors of the channels.
 353  */
 354 GLIB_AVAILABLE_IN_ALL
 355 gint        g_io_channel_win32_poll   (GPollFD    *fds,
 356                                        gint        n_fds,
 357                                        gint        timeout_);
 358
 359 /* Create an IO channel for Windows messages for window handle hwnd. */
 360 #if GLIB_SIZEOF_VOID_P == 8
 361 /* We use gsize here so that it is still an integer type and not a
 362  * pointer, like the guint in the traditional prototype. We can't use
 363  * intptr_t as that is not portable enough.
 364  */
 365 GLIB_AVAILABLE_IN_ALL
 366 GIOChannel *g_io_channel_win32_new_messages (gsize hwnd);
 367 #else
 368 GLIB_AVAILABLE_IN_ALL
 369 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
 370 #endif
 371
 372 /* Create an IO channel for C runtime (emulated Unix-like) file
 373  * descriptors. After calling g_io_add_watch() on a IO channel
 374  * returned by this function, you shouldn't call read() on the file
 375  * descriptor. This is because adding polling for a file descriptor is
 376  * implemented on Win32 by starting a thread that sits blocked in a
 377  * read() from the file descriptor most of the time. All reads from
 378  * the file descriptor should be done by this internal GLib
 379  * thread. Your code should call only g_io_channel_read_chars().
 380  */
 381 GLIB_AVAILABLE_IN_ALL
 382 GIOChannel* g_io_channel_win32_new_fd (gint         fd);
 383
 384 /* Get the C runtime file descriptor of a channel. */
 385 GLIB_AVAILABLE_IN_ALL
 386 gint        g_io_channel_win32_get_fd (GIOChannel *channel);
 387
 388 /* Create an IO channel for a winsock socket. The parameter should be
 389  * a SOCKET. Contrary to IO channels for file descriptors (on *Win32),
 390  * you can use normal recv() or recvfrom() on sockets even if GLib
 391  * is polling them.
 392  */
 393 GLIB_AVAILABLE_IN_ALL
 394 GIOChannel *g_io_channel_win32_new_socket (gint socket);
 395
 396 GLIB_DEPRECATED_FOR(g_io_channel_win32_new_socket)
 397 GIOChannel *g_io_channel_win32_new_stream_socket (gint socket);
 398
 399 GLIB_AVAILABLE_IN_ALL
 400 void        g_io_channel_win32_set_debug (GIOChannel *channel,
 401                                           gboolean    flag);
 402
 403 #endif
 404
 405 G_END_DECLS
 406
 407 #endif /* __G_IOCHANNEL_H__ */