1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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 of the License, or (at your option) any later version.
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.
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/>.
18 * Author: Alexander Larsson <alexl@redhat.com>
21 #ifndef __G_DATA_INPUT_STREAM_H__
22 #define __G_DATA_INPUT_STREAM_H__
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
28 #include <gio/gbufferedinputstream.h>
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))
42 * An implementation of #GBufferedInputStream that allows for high-level
43 * data manipulation of arbitrary data (including binary operations).
45 typedef struct _GDataInputStreamClass GDataInputStreamClass;
46 typedef struct _GDataInputStreamPrivate GDataInputStreamPrivate;
48 struct _GDataInputStream
50 GBufferedInputStream parent_instance;
53 GDataInputStreamPrivate *priv;
56 struct _GDataInputStreamClass
58 GBufferedInputStreamClass parent_class;
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);
70 GType g_data_input_stream_get_type (void) G_GNUC_CONST;
72 GDataInputStream * g_data_input_stream_new (GInputStream *base_stream);
75 void g_data_input_stream_set_byte_order (GDataInputStream *stream,
76 GDataStreamByteOrder order);
78 GDataStreamByteOrder g_data_input_stream_get_byte_order (GDataInputStream *stream);
80 void g_data_input_stream_set_newline_type (GDataInputStream *stream,
81 GDataStreamNewlineType type);
83 GDataStreamNewlineType g_data_input_stream_get_newline_type (GDataInputStream *stream);
85 guchar g_data_input_stream_read_byte (GDataInputStream *stream,
86 GCancellable *cancellable,
89 gint16 g_data_input_stream_read_int16 (GDataInputStream *stream,
90 GCancellable *cancellable,
93 guint16 g_data_input_stream_read_uint16 (GDataInputStream *stream,
94 GCancellable *cancellable,
97 gint32 g_data_input_stream_read_int32 (GDataInputStream *stream,
98 GCancellable *cancellable,
100 GLIB_AVAILABLE_IN_ALL
101 guint32 g_data_input_stream_read_uint32 (GDataInputStream *stream,
102 GCancellable *cancellable,
104 GLIB_AVAILABLE_IN_ALL
105 gint64 g_data_input_stream_read_int64 (GDataInputStream *stream,
106 GCancellable *cancellable,
108 GLIB_AVAILABLE_IN_ALL
109 guint64 g_data_input_stream_read_uint64 (GDataInputStream *stream,
110 GCancellable *cancellable,
112 GLIB_AVAILABLE_IN_ALL
113 char * g_data_input_stream_read_line (GDataInputStream *stream,
115 GCancellable *cancellable,
117 GLIB_AVAILABLE_IN_2_30
118 char * g_data_input_stream_read_line_utf8 (GDataInputStream *stream,
120 GCancellable *cancellable,
122 GLIB_AVAILABLE_IN_ALL
123 void g_data_input_stream_read_line_async (GDataInputStream *stream,
125 GCancellable *cancellable,
126 GAsyncReadyCallback callback,
128 GLIB_AVAILABLE_IN_ALL
129 char * g_data_input_stream_read_line_finish (GDataInputStream *stream,
130 GAsyncResult *result,
133 GLIB_AVAILABLE_IN_2_30
134 char * g_data_input_stream_read_line_finish_utf8(GDataInputStream *stream,
135 GAsyncResult *result,
138 GLIB_AVAILABLE_IN_ALL
139 char * g_data_input_stream_read_until (GDataInputStream *stream,
140 const gchar *stop_chars,
142 GCancellable *cancellable,
144 GLIB_AVAILABLE_IN_ALL
145 void g_data_input_stream_read_until_async (GDataInputStream *stream,
146 const gchar *stop_chars,
148 GCancellable *cancellable,
149 GAsyncReadyCallback callback,
151 GLIB_AVAILABLE_IN_ALL
152 char * g_data_input_stream_read_until_finish (GDataInputStream *stream,
153 GAsyncResult *result,
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,
162 GCancellable *cancellable,
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,
169 GCancellable *cancellable,
170 GAsyncReadyCallback callback,
172 GLIB_AVAILABLE_IN_ALL
173 char * g_data_input_stream_read_upto_finish (GDataInputStream *stream,
174 GAsyncResult *result,
180 #endif /* __G_DATA_INPUT_STREAM_H__ */