1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 * Copyright (C) 2007 Jürg Billeter
5 * Copyright © 2009 Codethink Limited
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 of the License, or (at your option) any later version.
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.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
22 * Author: Alexander Larsson <alexl@redhat.com>
26 #include "gdatainputstream.h"
27 #include "gsimpleasyncresult.h"
28 #include "gcancellable.h"
29 #include "gioenumtypes.h"
36 * SECTION:gdatainputstream
37 * @short_description: Data Input Stream
39 * @see_also: #GInputStream
41 * Data input stream implements #GInputStream and includes functions for
42 * reading structured data directly from a binary input stream.
46 struct _GDataInputStreamPrivate {
47 GDataStreamByteOrder byte_order;
48 GDataStreamNewlineType newline_type;
57 static void g_data_input_stream_set_property (GObject *object,
61 static void g_data_input_stream_get_property (GObject *object,
66 G_DEFINE_TYPE (GDataInputStream,
68 G_TYPE_BUFFERED_INPUT_STREAM)
72 g_data_input_stream_class_init (GDataInputStreamClass *klass)
74 GObjectClass *object_class;
76 g_type_class_add_private (klass, sizeof (GDataInputStreamPrivate));
78 object_class = G_OBJECT_CLASS (klass);
79 object_class->get_property = g_data_input_stream_get_property;
80 object_class->set_property = g_data_input_stream_set_property;
83 * GDataStream:byte-order:
85 * The ::byte-order property determines the byte ordering that
86 * is used when reading multi-byte entities (such as integers)
89 g_object_class_install_property (object_class,
91 g_param_spec_enum ("byte-order",
94 G_TYPE_DATA_STREAM_BYTE_ORDER,
95 G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN,
96 G_PARAM_READWRITE|G_PARAM_STATIC_NAME|G_PARAM_STATIC_BLURB));
99 * GDataStream:newline-type:
101 * The :newline-type property determines what is considered
102 * as a line ending when reading complete lines from the stream.
104 g_object_class_install_property (object_class,
106 g_param_spec_enum ("newline-type",
108 P_("The accepted types of line ending"),
109 G_TYPE_DATA_STREAM_NEWLINE_TYPE,
110 G_DATA_STREAM_NEWLINE_TYPE_LF,
111 G_PARAM_READWRITE|G_PARAM_STATIC_NAME|G_PARAM_STATIC_BLURB));
115 g_data_input_stream_set_property (GObject *object,
120 GDataInputStream *dstream;
122 dstream = G_DATA_INPUT_STREAM (object);
126 case PROP_BYTE_ORDER:
127 g_data_input_stream_set_byte_order (dstream, g_value_get_enum (value));
130 case PROP_NEWLINE_TYPE:
131 g_data_input_stream_set_newline_type (dstream, g_value_get_enum (value));
135 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
142 g_data_input_stream_get_property (GObject *object,
147 GDataInputStreamPrivate *priv;
148 GDataInputStream *dstream;
150 dstream = G_DATA_INPUT_STREAM (object);
151 priv = dstream->priv;
155 case PROP_BYTE_ORDER:
156 g_value_set_enum (value, priv->byte_order);
159 case PROP_NEWLINE_TYPE:
160 g_value_set_enum (value, priv->newline_type);
164 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
170 g_data_input_stream_init (GDataInputStream *stream)
172 stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
173 G_TYPE_DATA_INPUT_STREAM,
174 GDataInputStreamPrivate);
176 stream->priv->byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
177 stream->priv->newline_type = G_DATA_STREAM_NEWLINE_TYPE_LF;
181 * g_data_input_stream_new:
182 * @base_stream: a #GInputStream.
184 * Creates a new data input stream for the @base_stream.
186 * Returns: a new #GDataInputStream.
189 g_data_input_stream_new (GInputStream *base_stream)
191 GDataInputStream *stream;
193 g_return_val_if_fail (G_IS_INPUT_STREAM (base_stream), NULL);
195 stream = g_object_new (G_TYPE_DATA_INPUT_STREAM,
196 "base-stream", base_stream,
203 * g_data_input_stream_set_byte_order:
204 * @stream: a given #GDataInputStream.
205 * @order: a #GDataStreamByteOrder to set.
207 * This function sets the byte order for the given @stream. All subsequent
208 * reads from the @stream will be read in the given @order.
212 g_data_input_stream_set_byte_order (GDataInputStream *stream,
213 GDataStreamByteOrder order)
215 GDataInputStreamPrivate *priv;
217 g_return_if_fail (G_IS_DATA_INPUT_STREAM (stream));
221 if (priv->byte_order != order)
223 priv->byte_order = order;
225 g_object_notify (G_OBJECT (stream), "byte-order");
230 * g_data_input_stream_get_byte_order:
231 * @stream: a given #GDataInputStream.
233 * Gets the byte order for the data input stream.
235 * Returns: the @stream's current #GDataStreamByteOrder.
238 g_data_input_stream_get_byte_order (GDataInputStream *stream)
240 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN);
242 return stream->priv->byte_order;
246 * g_data_input_stream_set_newline_type:
247 * @stream: a #GDataInputStream.
248 * @type: the type of new line return as #GDataStreamNewlineType.
250 * Sets the newline type for the @stream.
252 * Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read
253 * chunk ends in "CR" we must read an additional byte to know if this is "CR" or
254 * "CR LF", and this might block if there is no more data availible.
258 g_data_input_stream_set_newline_type (GDataInputStream *stream,
259 GDataStreamNewlineType type)
261 GDataInputStreamPrivate *priv;
263 g_return_if_fail (G_IS_DATA_INPUT_STREAM (stream));
267 if (priv->newline_type != type)
269 priv->newline_type = type;
271 g_object_notify (G_OBJECT (stream), "newline-type");
276 * g_data_input_stream_get_newline_type:
277 * @stream: a given #GDataInputStream.
279 * Gets the current newline type for the @stream.
281 * Returns: #GDataStreamNewlineType for the given @stream.
283 GDataStreamNewlineType
284 g_data_input_stream_get_newline_type (GDataInputStream *stream)
286 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), G_DATA_STREAM_NEWLINE_TYPE_ANY);
288 return stream->priv->newline_type;
292 read_data (GDataInputStream *stream,
295 GCancellable *cancellable,
301 while ((available = g_buffered_input_stream_get_available (G_BUFFERED_INPUT_STREAM (stream))) < size)
303 res = g_buffered_input_stream_fill (G_BUFFERED_INPUT_STREAM (stream),
310 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
311 _("Unexpected early end-of-stream"));
316 /* This should always succeed, since it's in the buffer */
317 res = g_input_stream_read (G_INPUT_STREAM (stream),
320 g_warn_if_fail (res == size);
326 * g_data_input_stream_read_byte:
327 * @stream: a given #GDataInputStream.
328 * @cancellable: optional #GCancellable object, %NULL to ignore.
329 * @error: #GError for error reporting.
331 * Reads an unsigned 8-bit/1-byte value from @stream.
333 * Returns: an unsigned 8-bit/1-byte value read from the @stream or %0
334 * if an error occurred.
337 g_data_input_stream_read_byte (GDataInputStream *stream,
338 GCancellable *cancellable,
343 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), '\0');
345 if (read_data (stream, &c, 1, cancellable, error))
353 * g_data_input_stream_read_int16:
354 * @stream: a given #GDataInputStream.
355 * @cancellable: optional #GCancellable object, %NULL to ignore.
356 * @error: #GError for error reporting.
358 * Reads a 16-bit/2-byte value from @stream.
360 * In order to get the correct byte order for this read operation,
361 * see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
363 * Returns: a signed 16-bit/2-byte value read from @stream or %0 if
367 g_data_input_stream_read_int16 (GDataInputStream *stream,
368 GCancellable *cancellable,
373 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), 0);
375 if (read_data (stream, &v, 2, cancellable, error))
377 switch (stream->priv->byte_order)
379 case G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN:
380 v = GINT16_FROM_BE (v);
382 case G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN:
383 v = GINT16_FROM_LE (v);
385 case G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN:
397 * g_data_input_stream_read_uint16:
398 * @stream: a given #GDataInputStream.
399 * @cancellable: optional #GCancellable object, %NULL to ignore.
400 * @error: #GError for error reporting.
402 * Reads an unsigned 16-bit/2-byte value from @stream.
404 * In order to get the correct byte order for this read operation,
405 * see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
407 * Returns: an unsigned 16-bit/2-byte value read from the @stream or %0 if
411 g_data_input_stream_read_uint16 (GDataInputStream *stream,
412 GCancellable *cancellable,
417 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), 0);
419 if (read_data (stream, &v, 2, cancellable, error))
421 switch (stream->priv->byte_order)
423 case G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN:
424 v = GUINT16_FROM_BE (v);
426 case G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN:
427 v = GUINT16_FROM_LE (v);
429 case G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN:
441 * g_data_input_stream_read_int32:
442 * @stream: a given #GDataInputStream.
443 * @cancellable: optional #GCancellable object, %NULL to ignore.
444 * @error: #GError for error reporting.
446 * Reads a signed 32-bit/4-byte value from @stream.
448 * In order to get the correct byte order for this read operation,
449 * see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
451 * If @cancellable is not %NULL, then the operation can be cancelled by
452 * triggering the cancellable object from another thread. If the operation
453 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
455 * Returns: a signed 32-bit/4-byte value read from the @stream or %0 if
459 g_data_input_stream_read_int32 (GDataInputStream *stream,
460 GCancellable *cancellable,
465 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), 0);
467 if (read_data (stream, &v, 4, cancellable, error))
469 switch (stream->priv->byte_order)
471 case G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN:
472 v = GINT32_FROM_BE (v);
474 case G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN:
475 v = GINT32_FROM_LE (v);
477 case G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN:
489 * g_data_input_stream_read_uint32:
490 * @stream: a given #GDataInputStream.
491 * @cancellable: optional #GCancellable object, %NULL to ignore.
492 * @error: #GError for error reporting.
494 * Reads an unsigned 32-bit/4-byte value from @stream.
496 * In order to get the correct byte order for this read operation,
497 * see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
499 * If @cancellable is not %NULL, then the operation can be cancelled by
500 * triggering the cancellable object from another thread. If the operation
501 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
503 * Returns: an unsigned 32-bit/4-byte value read from the @stream or %0 if
507 g_data_input_stream_read_uint32 (GDataInputStream *stream,
508 GCancellable *cancellable,
513 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), 0);
515 if (read_data (stream, &v, 4, cancellable, error))
517 switch (stream->priv->byte_order)
519 case G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN:
520 v = GUINT32_FROM_BE (v);
522 case G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN:
523 v = GUINT32_FROM_LE (v);
525 case G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN:
537 * g_data_input_stream_read_int64:
538 * @stream: a given #GDataInputStream.
539 * @cancellable: optional #GCancellable object, %NULL to ignore.
540 * @error: #GError for error reporting.
542 * Reads a 64-bit/8-byte value from @stream.
544 * In order to get the correct byte order for this read operation,
545 * see g_data_stream_get_byte_order() and g_data_stream_set_byte_order().
547 * If @cancellable is not %NULL, then the operation can be cancelled by
548 * triggering the cancellable object from another thread. If the operation
549 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
551 * Returns: a signed 64-bit/8-byte value read from @stream or %0 if
555 g_data_input_stream_read_int64 (GDataInputStream *stream,
556 GCancellable *cancellable,
561 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), 0);
563 if (read_data (stream, &v, 8, cancellable, error))
565 switch (stream->priv->byte_order)
567 case G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN:
568 v = GINT64_FROM_BE (v);
570 case G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN:
571 v = GINT64_FROM_LE (v);
573 case G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN:
585 * g_data_input_stream_read_uint64:
586 * @stream: a given #GDataInputStream.
587 * @cancellable: optional #GCancellable object, %NULL to ignore.
588 * @error: #GError for error reporting.
590 * Reads an unsigned 64-bit/8-byte value from @stream.
592 * In order to get the correct byte order for this read operation,
593 * see g_data_stream_get_byte_order().
595 * If @cancellable is not %NULL, then the operation can be cancelled by
596 * triggering the cancellable object from another thread. If the operation
597 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
599 * Returns: an unsigned 64-bit/8-byte read from @stream or %0 if
603 g_data_input_stream_read_uint64 (GDataInputStream *stream,
604 GCancellable *cancellable,
609 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), 0);
611 if (read_data (stream, &v, 8, cancellable, error))
613 switch (stream->priv->byte_order)
615 case G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN:
616 v = GUINT64_FROM_BE (v);
618 case G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN:
619 v = GUINT64_FROM_LE (v);
621 case G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN:
632 scan_for_newline (GDataInputStream *stream,
634 gboolean *last_saw_cr_out,
635 int *newline_len_out)
637 GBufferedInputStream *bstream;
638 GDataInputStreamPrivate *priv;
640 gsize start, end, peeked;
644 gsize available, checked;
645 gboolean last_saw_cr;
649 bstream = G_BUFFERED_INPUT_STREAM (stream);
651 checked = *checked_out;
652 last_saw_cr = *last_saw_cr_out;
657 buffer = (const char*)g_buffered_input_stream_peek_buffer (bstream, &available) + start;
659 peeked = end - start;
661 for (i = 0; checked < available && i < peeked; i++)
663 switch (priv->newline_type)
665 case G_DATA_STREAM_NEWLINE_TYPE_LF:
668 found_pos = start + i;
672 case G_DATA_STREAM_NEWLINE_TYPE_CR:
675 found_pos = start + i;
679 case G_DATA_STREAM_NEWLINE_TYPE_CR_LF:
680 if (last_saw_cr && buffer[i] == 10)
682 found_pos = start + i - 1;
687 case G_DATA_STREAM_NEWLINE_TYPE_ANY:
688 if (buffer[i] == 10) /* LF */
693 found_pos = start + i - 1;
699 found_pos = start + i;
703 else if (last_saw_cr)
705 /* Last was cr, this is not LF, end is CR */
706 found_pos = start + i - 1;
709 /* Don't check for CR here, instead look at last_saw_cr on next byte */
713 last_saw_cr = (buffer[i] == 13);
717 *newline_len_out = newline_len;
724 *checked_out = checked;
725 *last_saw_cr_out = last_saw_cr;
731 * g_data_input_stream_read_line:
732 * @stream: a given #GDataInputStream.
733 * @length: a #gsize to get the length of the data read in.
734 * @cancellable: optional #GCancellable object, %NULL to ignore.
735 * @error: #GError for error reporting.
737 * Reads a line from the data input stream.
739 * If @cancellable is not %NULL, then the operation can be cancelled by
740 * triggering the cancellable object from another thread. If the operation
741 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
743 * Returns: a string with the line that was read in (without the newlines).
744 * Set @length to a #gsize to get the length of the read line.
745 * On an error, it will return %NULL and @error will be set. If there's no
746 * content to read, it will still return %NULL, but @error won't be set.
749 g_data_input_stream_read_line (GDataInputStream *stream,
751 GCancellable *cancellable,
754 GBufferedInputStream *bstream;
756 gboolean last_saw_cr;
762 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), NULL);
764 bstream = G_BUFFERED_INPUT_STREAM (stream);
770 while ((found_pos = scan_for_newline (stream, &checked, &last_saw_cr, &newline_len)) == -1)
772 if (g_buffered_input_stream_get_available (bstream) ==
773 g_buffered_input_stream_get_buffer_size (bstream))
774 g_buffered_input_stream_set_buffer_size (bstream,
775 2 * g_buffered_input_stream_get_buffer_size (bstream));
777 res = g_buffered_input_stream_fill (bstream, -1, cancellable, error);
783 if (g_buffered_input_stream_get_available (bstream) == 0)
798 line = g_malloc (found_pos + newline_len + 1);
800 res = g_input_stream_read (G_INPUT_STREAM (stream),
802 found_pos + newline_len,
805 *length = (gsize)found_pos;
806 g_warn_if_fail (res == found_pos + newline_len);
813 scan_for_chars (GDataInputStream *stream,
815 const char *stop_chars)
817 GBufferedInputStream *bstream;
819 gsize start, end, peeked;
821 gsize available, checked;
822 const char *stop_char;
824 bstream = G_BUFFERED_INPUT_STREAM (stream);
826 checked = *checked_out;
829 buffer = (const char *)g_buffered_input_stream_peek_buffer (bstream, &available) + start;
831 peeked = end - start;
833 for (i = 0; checked < available && i < peeked; i++)
835 for (stop_char = stop_chars; *stop_char != '\0'; stop_char++)
837 if (buffer[i] == *stop_char)
844 *checked_out = checked;
849 * g_data_input_stream_read_until:
850 * @stream: a given #GDataInputStream.
851 * @stop_chars: characters to terminate the read.
852 * @length: a #gsize to get the length of the data read in.
853 * @cancellable: optional #GCancellable object, %NULL to ignore.
854 * @error: #GError for error reporting.
856 * Reads a string from the data input stream, up to the first
857 * occurrence of any of the stop characters.
859 * Returns: a string with the data that was read before encountering
860 * any of the stop characters. Set @length to a #gsize to get the length
861 * of the string. This function will return %NULL on an error.
864 g_data_input_stream_read_until (GDataInputStream *stream,
865 const gchar *stop_chars,
867 GCancellable *cancellable,
870 GBufferedInputStream *bstream;
877 g_return_val_if_fail (G_IS_DATA_INPUT_STREAM (stream), NULL);
879 bstream = G_BUFFERED_INPUT_STREAM (stream);
884 while ((found_pos = scan_for_chars (stream, &checked, stop_chars)) == -1)
886 if (g_buffered_input_stream_get_available (bstream) ==
887 g_buffered_input_stream_get_buffer_size (bstream))
888 g_buffered_input_stream_set_buffer_size (bstream,
889 2 * g_buffered_input_stream_get_buffer_size (bstream));
891 res = g_buffered_input_stream_fill (bstream, -1, cancellable, error);
897 if (g_buffered_input_stream_get_available (bstream) == 0)
912 data_until = g_malloc (found_pos + stop_char_len + 1);
914 res = g_input_stream_read (G_INPUT_STREAM (stream),
916 found_pos + stop_char_len,
919 *length = (gsize)found_pos;
920 g_warn_if_fail (res == found_pos + stop_char_len);
921 data_until[found_pos] = 0;
928 GDataInputStream *stream;
929 GSimpleAsyncResult *simple;
930 gboolean last_saw_cr;
933 GCancellable *cancellable;
938 } GDataInputStreamReadData;
941 g_data_input_stream_read_complete (GDataInputStreamReadData *data,
944 gboolean need_idle_dispatch)
946 if (read_length || skip_length)
950 data->length = read_length;
951 data->line = g_malloc (read_length + 1);
952 data->line[read_length] = '\0';
954 /* we already checked the buffer. this shouldn't fail. */
955 bytes = g_input_stream_read (G_INPUT_STREAM (data->stream),
956 data->line, read_length, NULL, NULL);
957 g_assert_cmpint (bytes, ==, read_length);
959 bytes = g_input_stream_skip (G_INPUT_STREAM (data->stream),
960 skip_length, NULL, NULL);
961 g_assert_cmpint (bytes, ==, skip_length);
964 if (need_idle_dispatch)
965 g_simple_async_result_complete_in_idle (data->simple);
967 g_simple_async_result_complete (data->simple);
969 g_object_unref (data->simple);
973 g_data_input_stream_read_line_ready (GObject *object,
974 GAsyncResult *result,
977 GDataInputStreamReadData *data = user_data;
982 /* this is a callback. finish the async call. */
984 GBufferedInputStream *buffer = G_BUFFERED_INPUT_STREAM (data->stream);
985 GError *error = NULL;
988 bytes = g_buffered_input_stream_fill_finish (buffer, result, &error);
995 g_simple_async_result_set_from_error (data->simple, error);
996 g_error_free (error);
1000 g_data_input_stream_read_complete (data, data->checked, 0, FALSE);
1004 /* only proceed if we got more bytes... */
1007 if (data->stop_chars)
1009 found_pos = scan_for_chars (data->stream,
1015 found_pos = scan_for_newline (data->stream, &data->checked,
1016 &data->last_saw_cr, &newline_len);
1018 if (found_pos == -1)
1019 /* didn't find a full line; need to buffer some more bytes */
1021 GBufferedInputStream *buffer = G_BUFFERED_INPUT_STREAM (data->stream);
1024 size = g_buffered_input_stream_get_buffer_size (buffer);
1026 if (g_buffered_input_stream_get_available (buffer) == size)
1027 /* need to grow the buffer */
1028 g_buffered_input_stream_set_buffer_size (buffer, size * 2);
1031 g_buffered_input_stream_fill_async (buffer, -1, data->io_priority,
1033 g_data_input_stream_read_line_ready,
1038 /* read the line and the EOL. no error is possible. */
1039 g_data_input_stream_read_complete (data, found_pos,
1040 newline_len, result == NULL);
1045 g_data_input_stream_read_data_free (gpointer user_data)
1047 GDataInputStreamReadData *data = user_data;
1049 /* we don't hold a ref to ->simple because it keeps a ref to us.
1050 * we are called because it is being finalized.
1053 g_free (data->stop_chars);
1054 if (data->cancellable)
1055 g_object_unref (data->cancellable);
1056 g_free (data->line);
1057 g_slice_free (GDataInputStreamReadData, data);
1061 g_data_input_stream_read_async (GDataInputStream *stream,
1062 const gchar *stop_chars,
1064 GCancellable *cancellable,
1065 GAsyncReadyCallback callback,
1067 gpointer source_tag)
1069 GDataInputStreamReadData *data;
1071 data = g_slice_new (GDataInputStreamReadData);
1072 data->stream = stream;
1074 g_object_ref (cancellable);
1075 data->cancellable = cancellable;
1076 data->stop_chars = g_strdup (stop_chars);
1077 data->io_priority = io_priority;
1078 data->last_saw_cr = FALSE;
1082 data->simple = g_simple_async_result_new (G_OBJECT (stream), callback,
1083 user_data, source_tag);
1084 g_simple_async_result_set_op_res_gpointer (data->simple, data,
1085 g_data_input_stream_read_data_free);
1086 g_data_input_stream_read_line_ready (NULL, NULL, data);
1090 g_data_input_stream_read_finish (GDataInputStream *stream,
1091 GAsyncResult *result,
1095 GDataInputStreamReadData *data;
1096 GSimpleAsyncResult *simple;
1099 simple = G_SIMPLE_ASYNC_RESULT (result);
1101 if (g_simple_async_result_propagate_error (simple, error))
1104 data = g_simple_async_result_get_op_res_gpointer (simple);
1110 *length = data->length;
1116 * g_data_input_stream_read_line_async:
1117 * @stream: a given #GDataInputStream.
1118 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1120 * @cancellable: optional #GCancellable object, %NULL to ignore.
1121 * @callback: callback to call when the request is satisfied.
1122 * @user_data: the data to pass to callback function.
1124 * The asynchronous version of g_data_input_stream_read_line(). It is
1125 * an error to have two outstanding calls to this function.
1127 * When the operation is finished, @callback will be called. You
1128 * can then call g_data_input_stream_read_line_finish() to get
1129 * the result of the operation.
1134 g_data_input_stream_read_line_async (GDataInputStream *stream,
1136 GCancellable *cancellable,
1137 GAsyncReadyCallback callback,
1140 g_return_if_fail (G_IS_DATA_INPUT_STREAM (stream));
1141 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1143 g_data_input_stream_read_async (stream, NULL, io_priority,
1144 cancellable, callback, user_data,
1145 g_data_input_stream_read_line_async);
1149 * g_data_input_stream_read_until_async:
1150 * @stream: a given #GDataInputStream.
1151 * @stop_chars: characters to terminate the read.
1152 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1154 * @cancellable: optional #GCancellable object, %NULL to ignore.
1155 * @callback: callback to call when the request is satisfied.
1156 * @user_data: the data to pass to callback function.
1158 * The asynchronous version of g_data_input_stream_read_until().
1159 * It is an error to have two outstanding calls to this function.
1161 * When the operation is finished, @callback will be called. You
1162 * can then call g_data_input_stream_read_until_finish() to get
1163 * the result of the operation.
1168 g_data_input_stream_read_until_async (GDataInputStream *stream,
1169 const gchar *stop_chars,
1171 GCancellable *cancellable,
1172 GAsyncReadyCallback callback,
1175 g_return_if_fail (G_IS_DATA_INPUT_STREAM (stream));
1176 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
1177 g_return_if_fail (stop_chars != NULL);
1179 g_data_input_stream_read_async (stream, stop_chars, io_priority,
1180 cancellable, callback, user_data,
1181 g_data_input_stream_read_until_async);
1185 * g_data_input_stream_read_line_finish:
1186 * @stream: a given #GDataInputStream.
1187 * @result: the #GAsyncResult that was provided to the callback.
1188 * @length: a #gsize to get the length of the data read in.
1189 * @error: #GError for error reporting.
1191 * Finish an asynchronous call started by
1192 * g_data_input_stream_read_line_async().
1194 * Returns: a string with the line that was read in (without the newlines).
1195 * Set @length to a #gsize to get the length of the read line.
1196 * On an error, it will return %NULL and @error will be set. If there's no
1197 * content to read, it will still return %NULL, but @error won't be set.
1202 g_data_input_stream_read_line_finish (GDataInputStream *stream,
1203 GAsyncResult *result,
1207 g_return_val_if_fail (
1208 g_simple_async_result_is_valid (result, G_OBJECT (stream),
1209 g_data_input_stream_read_line_async), NULL);
1211 return g_data_input_stream_read_finish (stream, result, length, error);
1215 * g_data_input_stream_read_until_finish:
1216 * @stream: a given #GDataInputStream.
1217 * @result: the #GAsyncResult that was provided to the callback.
1218 * @length: a #gsize to get the length of the data read in.
1219 * @error: #GError for error reporting.
1221 * Finish an asynchronous call started by
1222 * g_data_input_stream_read_until_async().
1226 * Returns: a string with the data that was read before encountering
1227 * any of the stop characters. Set @length to a #gsize to get the length
1228 * of the string. This function will return %NULL on an error.
1231 g_data_input_stream_read_until_finish (GDataInputStream *stream,
1232 GAsyncResult *result,
1236 g_return_val_if_fail (
1237 g_simple_async_result_is_valid (result, G_OBJECT (stream),
1238 g_data_input_stream_read_until_async), NULL);
1240 return g_data_input_stream_read_finish (stream, result, length, error);
1244 #define __G_DATA_INPUT_STREAM_C__
1245 #include "gioaliasdef.c"