gio/gdatainputstream.h

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