gio/gdatainputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_DATA_INPUT_STREAM_H__
  22 #define __G_DATA_INPUT_STREAM_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/gbufferedinputstream.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_DATA_INPUT_STREAM         (g_data_input_stream_get_type ())
  33 #define G_DATA_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DATA_INPUT_STREAM, GDataInputStream))
  34 #define G_DATA_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DATA_INPUT_STREAM, GDataInputStreamClass))
  35 #define G_IS_DATA_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DATA_INPUT_STREAM))
  36 #define G_IS_DATA_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DATA_INPUT_STREAM))
  37 #define G_DATA_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DATA_INPUT_STREAM, GDataInputStreamClass))
  38
  39 /**
  40  * GDataInputStream:
  41  *
  42  * An implementation of #GBufferedInputStream that allows for high-level
  43  * data manipulation of arbitrary data (including binary operations).
  44  **/
  45 typedef struct _GDataInputStreamClass    GDataInputStreamClass;
  46 typedef struct _GDataInputStreamPrivate  GDataInputStreamPrivate;
  47
  48 struct _GDataInputStream
  49 {
  50   GBufferedInputStream parent_instance;
  51
  52   /*< private >*/
  53   GDataInputStreamPrivate *priv;
  54 };
  55
  56 struct _GDataInputStreamClass
  57 {
  58   GBufferedInputStreamClass parent_class;
  59
  60   /*< private >*/
  61   /* Padding for future expansion */
  62   void (*_g_reserved1) (void);
  63   void (*_g_reserved2) (void);
  64   void (*_g_reserved3) (void);
  65   void (*_g_reserved4) (void);
  66   void (*_g_reserved5) (void);
  67 };
  68
  69 GLIB_AVAILABLE_IN_ALL
  70 GType                  g_data_input_stream_get_type             (void) G_GNUC_CONST;
  71 GLIB_AVAILABLE_IN_ALL
  72 GDataInputStream *     g_data_input_stream_new                  (GInputStream            *base_stream);
  73
  74 GLIB_AVAILABLE_IN_ALL
  75 void                   g_data_input_stream_set_byte_order       (GDataInputStream        *stream,
  76                                                                  GDataStreamByteOrder     order);
  77 GLIB_AVAILABLE_IN_ALL
  78 GDataStreamByteOrder   g_data_input_stream_get_byte_order       (GDataInputStream        *stream);
  79 GLIB_AVAILABLE_IN_ALL
  80 void                   g_data_input_stream_set_newline_type     (GDataInputStream        *stream,
  81                                                                  GDataStreamNewlineType   type);
  82 GLIB_AVAILABLE_IN_ALL
  83 GDataStreamNewlineType g_data_input_stream_get_newline_type     (GDataInputStream        *stream);
  84 GLIB_AVAILABLE_IN_ALL
  85 guchar                 g_data_input_stream_read_byte            (GDataInputStream        *stream,
  86                                                                  GCancellable            *cancellable,
  87                                                                  GError                 **error);
  88 GLIB_AVAILABLE_IN_ALL
  89 gint16                 g_data_input_stream_read_int16           (GDataInputStream        *stream,
  90                                                                  GCancellable            *cancellable,
  91                                                                  GError                 **error);
  92 GLIB_AVAILABLE_IN_ALL
  93 guint16                g_data_input_stream_read_uint16          (GDataInputStream        *stream,
  94                                                                  GCancellable            *cancellable,
  95                                                                  GError                 **error);
  96 GLIB_AVAILABLE_IN_ALL
  97 gint32                 g_data_input_stream_read_int32           (GDataInputStream        *stream,
  98                                                                  GCancellable            *cancellable,
  99                                                                  GError                 **error);
 100 GLIB_AVAILABLE_IN_ALL
 101 guint32                g_data_input_stream_read_uint32          (GDataInputStream        *stream,
 102                                                                  GCancellable            *cancellable,
 103                                                                  GError                 **error);
 104 GLIB_AVAILABLE_IN_ALL
 105 gint64                 g_data_input_stream_read_int64           (GDataInputStream        *stream,
 106                                                                  GCancellable            *cancellable,
 107                                                                  GError                 **error);
 108 GLIB_AVAILABLE_IN_ALL
 109 guint64                g_data_input_stream_read_uint64          (GDataInputStream        *stream,
 110                                                                  GCancellable            *cancellable,
 111                                                                  GError                 **error);
 112 GLIB_AVAILABLE_IN_ALL
 113 char *                 g_data_input_stream_read_line            (GDataInputStream        *stream,
 114                                                                  gsize                   *length,
 115                                                                  GCancellable            *cancellable,
 116                                                                  GError                 **error);
 117 GLIB_AVAILABLE_IN_2_30
 118 char *                 g_data_input_stream_read_line_utf8       (GDataInputStream        *stream,
 119                                                                  gsize                   *length,
 120                                                                  GCancellable            *cancellable,
 121                                                                  GError                 **error);
 122 GLIB_AVAILABLE_IN_ALL
 123 void                   g_data_input_stream_read_line_async      (GDataInputStream        *stream,
 124                                                                  gint                     io_priority,
 125                                                                  GCancellable            *cancellable,
 126                                                                  GAsyncReadyCallback      callback,
 127                                                                  gpointer                 user_data);
 128 GLIB_AVAILABLE_IN_ALL
 129 char *                 g_data_input_stream_read_line_finish     (GDataInputStream        *stream,
 130                                                                  GAsyncResult            *result,
 131                                                                  gsize                   *length,
 132                                                                  GError                 **error);
 133 GLIB_AVAILABLE_IN_2_30
 134 char *                 g_data_input_stream_read_line_finish_utf8(GDataInputStream        *stream,
 135                                                                  GAsyncResult            *result,
 136                                                                  gsize                   *length,
 137                                                                  GError                 **error);
 138 GLIB_DEPRECATED_IN_2_56_FOR (g_data_input_stream_read_upto)
 139 char *                 g_data_input_stream_read_until           (GDataInputStream        *stream,
 140                                                                  const gchar             *stop_chars,
 141                                                                  gsize                   *length,
 142                                                                  GCancellable            *cancellable,
 143                                                                  GError                 **error);
 144 GLIB_DEPRECATED_IN_2_56_FOR (g_data_input_stream_read_upto_async)
 145 void                   g_data_input_stream_read_until_async     (GDataInputStream        *stream,
 146                                                                  const gchar             *stop_chars,
 147                                                                  gint                     io_priority,
 148                                                                  GCancellable            *cancellable,
 149                                                                  GAsyncReadyCallback      callback,
 150                                                                  gpointer                 user_data);
 151 GLIB_DEPRECATED_IN_2_56_FOR (g_data_input_stream_read_upto_finish)
 152 char *                 g_data_input_stream_read_until_finish    (GDataInputStream        *stream,
 153                                                                  GAsyncResult            *result,
 154                                                                  gsize                   *length,
 155                                                                  GError                 **error);
 156
 157 GLIB_AVAILABLE_IN_ALL
 158 char *                 g_data_input_stream_read_upto            (GDataInputStream        *stream,
 159                                                                  const gchar             *stop_chars,
 160                                                                  gssize                   stop_chars_len,
 161                                                                  gsize                   *length,
 162                                                                  GCancellable            *cancellable,
 163                                                                  GError                 **error);
 164 GLIB_AVAILABLE_IN_ALL
 165 void                   g_data_input_stream_read_upto_async      (GDataInputStream        *stream,
 166                                                                  const gchar             *stop_chars,
 167                                                                  gssize                   stop_chars_len,
 168                                                                  gint                     io_priority,
 169                                                                  GCancellable            *cancellable,
 170                                                                  GAsyncReadyCallback      callback,
 171                                                                  gpointer                 user_data);
 172 GLIB_AVAILABLE_IN_ALL
 173 char *                 g_data_input_stream_read_upto_finish     (GDataInputStream        *stream,
 174                                                                  GAsyncResult            *result,
 175                                                                  gsize                   *length,
 176                                                                  GError                 **error);
 177
 178 G_END_DECLS
 179
 180 #endif /* __G_DATA_INPUT_STREAM_H__ */