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, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #ifndef __G_DATA_INPUT_STREAM_H__
24 #define __G_DATA_INPUT_STREAM_H__
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
30 #include <gio/gbufferedinputstream.h>
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))
44 * An implementation of #GBufferedInputStream that allows for high-level
45 * data manipulation of arbitrary data (including binary operations).
47 typedef struct _GDataInputStreamClass GDataInputStreamClass
;
48 typedef struct _GDataInputStreamPrivate GDataInputStreamPrivate
;
50 struct _GDataInputStream
52 GBufferedInputStream parent_instance
;
55 GDataInputStreamPrivate
*priv
;
58 struct _GDataInputStreamClass
60 GBufferedInputStreamClass parent_class
;
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);
72 GType
g_data_input_stream_get_type (void) G_GNUC_CONST
;
74 GDataInputStream
* g_data_input_stream_new (GInputStream
*base_stream
);
77 void g_data_input_stream_set_byte_order (GDataInputStream
*stream
,
78 GDataStreamByteOrder order
);
80 GDataStreamByteOrder
g_data_input_stream_get_byte_order (GDataInputStream
*stream
);
82 void g_data_input_stream_set_newline_type (GDataInputStream
*stream
,
83 GDataStreamNewlineType type
);
85 GDataStreamNewlineType
g_data_input_stream_get_newline_type (GDataInputStream
*stream
);
87 guchar
g_data_input_stream_read_byte (GDataInputStream
*stream
,
88 GCancellable
*cancellable
,
91 gint16
g_data_input_stream_read_int16 (GDataInputStream
*stream
,
92 GCancellable
*cancellable
,
95 guint16
g_data_input_stream_read_uint16 (GDataInputStream
*stream
,
96 GCancellable
*cancellable
,
99 gint32
g_data_input_stream_read_int32 (GDataInputStream
*stream
,
100 GCancellable
*cancellable
,
102 GLIB_AVAILABLE_IN_ALL
103 guint32
g_data_input_stream_read_uint32 (GDataInputStream
*stream
,
104 GCancellable
*cancellable
,
106 GLIB_AVAILABLE_IN_ALL
107 gint64
g_data_input_stream_read_int64 (GDataInputStream
*stream
,
108 GCancellable
*cancellable
,
110 GLIB_AVAILABLE_IN_ALL
111 guint64
g_data_input_stream_read_uint64 (GDataInputStream
*stream
,
112 GCancellable
*cancellable
,
114 GLIB_AVAILABLE_IN_ALL
115 char * g_data_input_stream_read_line (GDataInputStream
*stream
,
117 GCancellable
*cancellable
,
119 GLIB_AVAILABLE_IN_2_30
120 char * g_data_input_stream_read_line_utf8 (GDataInputStream
*stream
,
122 GCancellable
*cancellable
,
124 GLIB_AVAILABLE_IN_ALL
125 void g_data_input_stream_read_line_async (GDataInputStream
*stream
,
127 GCancellable
*cancellable
,
128 GAsyncReadyCallback callback
,
130 GLIB_AVAILABLE_IN_ALL
131 char * g_data_input_stream_read_line_finish (GDataInputStream
*stream
,
132 GAsyncResult
*result
,
135 GLIB_AVAILABLE_IN_2_30
136 char * g_data_input_stream_read_line_finish_utf8(GDataInputStream
*stream
,
137 GAsyncResult
*result
,
140 GLIB_AVAILABLE_IN_ALL
141 char * g_data_input_stream_read_until (GDataInputStream
*stream
,
142 const gchar
*stop_chars
,
144 GCancellable
*cancellable
,
146 GLIB_AVAILABLE_IN_ALL
147 void g_data_input_stream_read_until_async (GDataInputStream
*stream
,
148 const gchar
*stop_chars
,
150 GCancellable
*cancellable
,
151 GAsyncReadyCallback callback
,
153 GLIB_AVAILABLE_IN_ALL
154 char * g_data_input_stream_read_until_finish (GDataInputStream
*stream
,
155 GAsyncResult
*result
,
159 GLIB_AVAILABLE_IN_ALL
160 char * g_data_input_stream_read_upto (GDataInputStream
*stream
,
161 const gchar
*stop_chars
,
162 gssize stop_chars_len
,
164 GCancellable
*cancellable
,
166 GLIB_AVAILABLE_IN_ALL
167 void g_data_input_stream_read_upto_async (GDataInputStream
*stream
,
168 const gchar
*stop_chars
,
169 gssize stop_chars_len
,
171 GCancellable
*cancellable
,
172 GAsyncReadyCallback callback
,
174 GLIB_AVAILABLE_IN_ALL
175 char * g_data_input_stream_read_upto_finish (GDataInputStream
*stream
,
176 GAsyncResult
*result
,
182 #endif /* __G_DATA_INPUT_STREAM_H__ */