gdatainputstream.h 10.9 KB
Newer Older
1
/* GIO - GLib Input, Output and Streaming Library
2
 *
3 4 5 6 7
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * 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 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19 20
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

21 22 23
#ifndef __G_DATA_INPUT_STREAM_H__
#define __G_DATA_INPUT_STREAM_H__

24 25 26 27
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif

28 29 30 31 32 33 34 35 36 37 38
#include <gio/gbufferedinputstream.h>

G_BEGIN_DECLS

#define G_TYPE_DATA_INPUT_STREAM         (g_data_input_stream_get_type ())
#define G_DATA_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DATA_INPUT_STREAM, GDataInputStream))
#define G_DATA_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DATA_INPUT_STREAM, GDataInputStreamClass))
#define G_IS_DATA_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DATA_INPUT_STREAM))
#define G_IS_DATA_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DATA_INPUT_STREAM))
#define G_DATA_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DATA_INPUT_STREAM, GDataInputStreamClass))

39 40 41
/**
 * GDataInputStream:
 *
42
 * An implementation of #GBufferedInputStream that allows for high-level
43 44
 * data manipulation of arbitrary data (including binary operations).
 **/
45 46 47 48 49
typedef struct _GDataInputStreamClass    GDataInputStreamClass;
typedef struct _GDataInputStreamPrivate  GDataInputStreamPrivate;

struct _GDataInputStream
{
50
  GBufferedInputStream parent_instance;
51 52 53 54 55 56 57

  /*< private >*/
  GDataInputStreamPrivate *priv;
};

struct _GDataInputStreamClass
{
58 59
  GBufferedInputStreamClass parent_class;

60
  /*< private >*/
61 62 63 64 65 66 67 68
  /* Padding for future expansion */
  void (*_g_reserved1) (void);
  void (*_g_reserved2) (void);
  void (*_g_reserved3) (void);
  void (*_g_reserved4) (void);
  void (*_g_reserved5) (void);
};

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 87
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
88
GLIB_AVAILABLE_IN_ALL
89
gint16                 g_data_input_stream_read_int16           (GDataInputStream        *stream,
90 91
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
92
GLIB_AVAILABLE_IN_ALL
93
guint16                g_data_input_stream_read_uint16          (GDataInputStream        *stream,
94 95
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
96
GLIB_AVAILABLE_IN_ALL
97
gint32                 g_data_input_stream_read_int32           (GDataInputStream        *stream,
98 99
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
100
GLIB_AVAILABLE_IN_ALL
101
guint32                g_data_input_stream_read_uint32          (GDataInputStream        *stream,
102 103
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
104
GLIB_AVAILABLE_IN_ALL
105
gint64                 g_data_input_stream_read_int64           (GDataInputStream        *stream,
106 107
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
108
GLIB_AVAILABLE_IN_ALL
109
guint64                g_data_input_stream_read_uint64          (GDataInputStream        *stream,
110 111
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
112
GLIB_AVAILABLE_IN_ALL
113
char *                 g_data_input_stream_read_line            (GDataInputStream        *stream,
114 115 116
                                                                 gsize                   *length,
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
117
GLIB_AVAILABLE_IN_2_30
118 119 120 121
char *                 g_data_input_stream_read_line_utf8       (GDataInputStream        *stream,
								 gsize                   *length,
								 GCancellable            *cancellable,
								 GError                 **error);
122
GLIB_AVAILABLE_IN_ALL
123 124 125 126 127
void                   g_data_input_stream_read_line_async      (GDataInputStream        *stream,
                                                                 gint                     io_priority,
                                                                 GCancellable            *cancellable,
                                                                 GAsyncReadyCallback      callback,
                                                                 gpointer                 user_data);
128
GLIB_AVAILABLE_IN_ALL
129 130 131 132
char *                 g_data_input_stream_read_line_finish     (GDataInputStream        *stream,
                                                                 GAsyncResult            *result,
                                                                 gsize                   *length,
                                                                 GError                 **error);
133
GLIB_AVAILABLE_IN_2_30
134 135 136 137
char *                 g_data_input_stream_read_line_finish_utf8(GDataInputStream        *stream,
                                                                 GAsyncResult            *result,
                                                                 gsize                   *length,
                                                                 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 141 142 143
                                                                 const gchar             *stop_chars,
                                                                 gsize                   *length,
                                                                 GCancellable            *cancellable,
                                                                 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 148 149 150
                                                                 gint                     io_priority,
                                                                 GCancellable            *cancellable,
                                                                 GAsyncReadyCallback      callback,
                                                                 gpointer                 user_data);
151
GLIB_DEPRECATED_IN_2_56_FOR (g_data_input_stream_read_upto_finish)
152 153 154 155
char *                 g_data_input_stream_read_until_finish    (GDataInputStream        *stream,
                                                                 GAsyncResult            *result,
                                                                 gsize                   *length,
                                                                 GError                 **error);
156

157
GLIB_AVAILABLE_IN_ALL
158 159 160 161 162 163
char *                 g_data_input_stream_read_upto            (GDataInputStream        *stream,
                                                                 const gchar             *stop_chars,
                                                                 gssize                   stop_chars_len,
                                                                 gsize                   *length,
                                                                 GCancellable            *cancellable,
                                                                 GError                 **error);
164
GLIB_AVAILABLE_IN_ALL
165 166 167 168 169 170 171
void                   g_data_input_stream_read_upto_async      (GDataInputStream        *stream,
                                                                 const gchar             *stop_chars,
                                                                 gssize                   stop_chars_len,
                                                                 gint                     io_priority,
                                                                 GCancellable            *cancellable,
                                                                 GAsyncReadyCallback      callback,
                                                                 gpointer                 user_data);
172
GLIB_AVAILABLE_IN_ALL
173 174 175 176 177
char *                 g_data_input_stream_read_upto_finish     (GDataInputStream        *stream,
                                                                 GAsyncResult            *result,
                                                                 gsize                   *length,
                                                                 GError                 **error);

178 179 180
G_END_DECLS

#endif /* __G_DATA_INPUT_STREAM_H__ */