ginputstream.c 42.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/* GIO - GLib Input, Output and Streaming Library
 * 
 * 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
 * version 2 of the License, or (at your option) any later version.
 *
 * 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
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

23
#include "config.h"
24 25 26 27 28
#include <glib.h>
#include "glibintl.h"

#include "ginputstream.h"
#include "gseekable.h"
29 30
#include "gcancellable.h"
#include "gasyncresult.h"
31
#include "gsimpleasyncresult.h"
32
#include "gioerror.h"
33
#include "gpollableinputstream.h"
34

35 36
/**
 * SECTION:ginputstream
Matthias Clasen's avatar
Matthias Clasen committed
37
 * @short_description: Base class for implementing streaming input
Matthias Clasen's avatar
Matthias Clasen committed
38
 * @include: gio/gio.h
39
 *
Dan Winship's avatar
Dan Winship committed
40
 * #GInputStream has functions to read from a stream (g_input_stream_read()),
Matthias Clasen's avatar
Matthias Clasen committed
41 42 43 44 45 46 47
 * to close a stream (g_input_stream_close()) and to skip some content
 * (g_input_stream_skip()). 
 *
 * To copy the content of an input stream to an output stream without 
 * manually handling the reads and writes, use g_output_stream_splice(). 
 *
 * All of these functions have async variants too.
48 49
 **/

50
G_DEFINE_ABSTRACT_TYPE (GInputStream, g_input_stream, G_TYPE_OBJECT);
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92

struct _GInputStreamPrivate {
  guint closed : 1;
  guint pending : 1;
  GAsyncReadyCallback outstanding_callback;
};

static gssize   g_input_stream_real_skip         (GInputStream         *stream,
						  gsize                 count,
						  GCancellable         *cancellable,
						  GError              **error);
static void     g_input_stream_real_read_async   (GInputStream         *stream,
						  void                 *buffer,
						  gsize                 count,
						  int                   io_priority,
						  GCancellable         *cancellable,
						  GAsyncReadyCallback   callback,
						  gpointer              user_data);
static gssize   g_input_stream_real_read_finish  (GInputStream         *stream,
						  GAsyncResult         *result,
						  GError              **error);
static void     g_input_stream_real_skip_async   (GInputStream         *stream,
						  gsize                 count,
						  int                   io_priority,
						  GCancellable         *cancellable,
						  GAsyncReadyCallback   callback,
						  gpointer              data);
static gssize   g_input_stream_real_skip_finish  (GInputStream         *stream,
						  GAsyncResult         *result,
						  GError              **error);
static void     g_input_stream_real_close_async  (GInputStream         *stream,
						  int                   io_priority,
						  GCancellable         *cancellable,
						  GAsyncReadyCallback   callback,
						  gpointer              data);
static gboolean g_input_stream_real_close_finish (GInputStream         *stream,
						  GAsyncResult         *result,
						  GError              **error);

static void
g_input_stream_finalize (GObject *object)
{
93
  G_OBJECT_CLASS (g_input_stream_parent_class)->finalize (object);
94 95 96 97 98 99 100 101 102 103 104
}

static void
g_input_stream_dispose (GObject *object)
{
  GInputStream *stream;

  stream = G_INPUT_STREAM (object);
  
  if (!stream->priv->closed)
    g_input_stream_close (stream, NULL, NULL);
105 106

  G_OBJECT_CLASS (g_input_stream_parent_class)->dispose (object);
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
}


static void
g_input_stream_class_init (GInputStreamClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  
  g_type_class_add_private (klass, sizeof (GInputStreamPrivate));
  
  gobject_class->finalize = g_input_stream_finalize;
  gobject_class->dispose = g_input_stream_dispose;
  
  klass->skip = g_input_stream_real_skip;
  klass->read_async = g_input_stream_real_read_async;
  klass->read_finish = g_input_stream_real_read_finish;
  klass->skip_async = g_input_stream_real_skip_async;
  klass->skip_finish = g_input_stream_real_skip_finish;
  klass->close_async = g_input_stream_real_close_async;
  klass->close_finish = g_input_stream_real_close_finish;
}

static void
g_input_stream_init (GInputStream *stream)
{
  stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
					      G_TYPE_INPUT_STREAM,
					      GInputStreamPrivate);
}

/**
 * g_input_stream_read:
 * @stream: a #GInputStream.
 * @buffer: a buffer to read data into (which should be at least count bytes long).
 * @count: the number of bytes that will be read from the stream
142
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
Matthias Clasen's avatar
Matthias Clasen committed
143
 * @error: location to store the error occurring, or %NULL to ignore
144 145 146 147 148 149 150 151 152 153 154 155
 *
 * Tries to read @count bytes from the stream into the buffer starting at
 * @buffer. Will block during this read.
 * 
 * If count is zero returns zero and does nothing. A value of @count
 * larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
 *
 * On success, the number of bytes read into the buffer is returned.
 * It is not an error if this is not the same as the requested size, as it
 * can happen e.g. near the end of a file. Zero is returned on end of file
 * (or if @count is zero),  but never otherwise.
 *
Dan Winship's avatar
Dan Winship committed
156
 * If @cancellable is not %NULL, then the operation can be cancelled by
157
 * triggering the cancellable object from another thread. If the operation
Dan Winship's avatar
Dan Winship committed
158
 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
159 160 161 162 163
 * operation was partially finished when the operation was cancelled the
 * partial result will be returned, without an error.
 *
 * On error -1 is returned and @error is set accordingly.
 * 
164
 * Return value: Number of bytes read, or -1 on error, or 0 on end of file.
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
 **/
gssize
g_input_stream_read  (GInputStream  *stream,
		      void          *buffer,
		      gsize          count,
		      GCancellable  *cancellable,
		      GError       **error)
{
  GInputStreamClass *class;
  gssize res;

  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);
  g_return_val_if_fail (buffer != NULL, 0);

  if (count == 0)
    return 0;
  
  if (((gssize) count) < 0)
    {
      g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
185
		   _("Too large count value passed to %s"), G_STRFUNC);
186 187 188 189 190
      return -1;
    }

  class = G_INPUT_STREAM_GET_CLASS (stream);

191
  if (class->read_fn == NULL) 
192
    {
193 194
      g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
                           _("Input stream doesn't implement read"));
195 196 197
      return -1;
    }

198 199 200
  if (!g_input_stream_set_pending (stream, error))
    return -1;

201
  if (cancellable)
202
    g_cancellable_push_current (cancellable);
203
  
204
  res = class->read_fn (stream, buffer, count, cancellable, error);
205 206

  if (cancellable)
207
    g_cancellable_pop_current (cancellable);
208
  
209 210
  g_input_stream_clear_pending (stream);

211 212 213 214 215 216 217 218
  return res;
}

/**
 * g_input_stream_read_all:
 * @stream: a #GInputStream.
 * @buffer: a buffer to read data into (which should be at least count bytes long).
 * @count: the number of bytes that will be read from the stream
219 220
 * @bytes_read: (out): location to store the number of bytes that was read from the stream
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
Matthias Clasen's avatar
Matthias Clasen committed
221
 * @error: location to store the error occurring, or %NULL to ignore
222 223 224 225 226 227 228 229
 *
 * Tries to read @count bytes from the stream into the buffer starting at
 * @buffer. Will block during this read.
 *
 * This function is similar to g_input_stream_read(), except it tries to
 * read as many bytes as requested, only stopping on an error or end of stream.
 *
 * On a successful read of @count bytes, or if we reached the end of the
230
 * stream,  %TRUE is returned, and @bytes_read is set to the number of bytes
231 232
 * read into @buffer.
 * 
233
 * If there is an error during the operation %FALSE is returned and @error
234
 * is set to indicate the error status, @bytes_read is updated to contain
235
 * the number of bytes read into @buffer before the error occurred.
236
 *
237
 * Return value: %TRUE on success, %FALSE if there was an error
238 239
 **/
gboolean
Matthias Clasen's avatar
Matthias Clasen committed
240 241 242 243 244 245
g_input_stream_read_all (GInputStream  *stream,
			 void          *buffer,
			 gsize          count,
			 gsize         *bytes_read,
			 GCancellable  *cancellable,
			 GError       **error)
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
{
  gsize _bytes_read;
  gssize res;

  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
  g_return_val_if_fail (buffer != NULL, FALSE);

  _bytes_read = 0;
  while (_bytes_read < count)
    {
      res = g_input_stream_read (stream, (char *)buffer + _bytes_read, count - _bytes_read,
				 cancellable, error);
      if (res == -1)
	{
	  if (bytes_read)
	    *bytes_read = _bytes_read;
	  return FALSE;
	}
      
      if (res == 0)
	break;

      _bytes_read += res;
    }

  if (bytes_read)
    *bytes_read = _bytes_read;
  return TRUE;
}

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
/**
 * g_input_stream_read_bytes:
 * @stream: a #GInputStream.
 * @count: maximum number of bytes that will be read from the stream. Common
 * values include 4096 and 8192.
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 * @error: location to store the error occurring, or %NULL to ignore
 *
 * Like g_input_stream_read(), this tries to read @count bytes from
 * the stream in a blocking fashion. However, rather than reading into
 * a user-supplied buffer, this will create a new #GBytes containing
 * the data that was read. This may be easier to use from language
 * bindings.
 *
 * If count is zero, returns a zero-length #GBytes and does nothing. A
 * value of @count larger than %G_MAXSSIZE will cause a
 * %G_IO_ERROR_INVALID_ARGUMENT error.
 *
 * On success, a new #GBytes is returned. It is not an error if the
 * size of this object is not the same as the requested size, as it
 * can happen e.g. near the end of a file. A zero-length #GBytes is
 * returned on end of file (or if @count is zero), but never
 * otherwise.
 *
 * If @cancellable is not %NULL, then the operation can be cancelled by
 * triggering the cancellable object from another thread. If the operation
 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
 * operation was partially finished when the operation was cancelled the
 * partial result will be returned, without an error.
 *
 * On error %NULL is returned and @error is set accordingly.
 *
 * Return value: a new #GBytes, or %NULL on error
 **/
GBytes *
g_input_stream_read_bytes (GInputStream  *stream,
			   gsize          count,
			   GCancellable  *cancellable,
			   GError       **error)
{
  guchar *buf;
  gssize nread;

  buf = g_malloc (count);
  nread = g_input_stream_read (stream, buf, count, cancellable, error);
  if (nread == -1)
    {
      g_free (buf);
      return NULL;
    }
  else if (nread == 0)
    {
      g_free (buf);
      return g_bytes_new_static ("", 0);
    }
  else
    return g_bytes_new_take (buf, nread);
}

335 336 337 338
/**
 * g_input_stream_skip:
 * @stream: a #GInputStream.
 * @count: the number of bytes that will be skipped from the stream
339
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. 
Matthias Clasen's avatar
Matthias Clasen committed
340
 * @error: location to store the error occurring, or %NULL to ignore
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
 *
 * Tries to skip @count bytes from the stream. Will block during the operation.
 *
 * This is identical to g_input_stream_read(), from a behaviour standpoint,
 * but the bytes that are skipped are not returned to the user. Some
 * streams have an implementation that is more efficient than reading the data.
 *
 * This function is optional for inherited classes, as the default implementation
 * emulates it using read.
 *
 * If @cancellable is not %NULL, then the operation can be cancelled by
 * triggering the cancellable object from another thread. If the operation
 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
 * operation was partially finished when the operation was cancelled the
 * partial result will be returned, without an error.
 *
 * Return value: Number of bytes skipped, or -1 on error
 **/
gssize
Matthias Clasen's avatar
Matthias Clasen committed
360 361 362 363
g_input_stream_skip (GInputStream  *stream,
		     gsize          count,
		     GCancellable  *cancellable,
		     GError       **error)
364 365 366 367 368 369 370 371 372 373 374 375
{
  GInputStreamClass *class;
  gssize res;

  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);

  if (count == 0)
    return 0;

  if (((gssize) count) < 0)
    {
      g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
376
		   _("Too large count value passed to %s"), G_STRFUNC);
377 378 379 380 381
      return -1;
    }
  
  class = G_INPUT_STREAM_GET_CLASS (stream);

382 383 384
  if (!g_input_stream_set_pending (stream, error))
    return -1;

385
  if (cancellable)
386
    g_cancellable_push_current (cancellable);
387 388 389 390
  
  res = class->skip (stream, count, cancellable, error);

  if (cancellable)
391
    g_cancellable_pop_current (cancellable);
392
  
393 394
  g_input_stream_clear_pending (stream);

395 396 397 398
  return res;
}

static gssize
Matthias Clasen's avatar
Matthias Clasen committed
399 400 401 402
g_input_stream_real_skip (GInputStream  *stream,
			  gsize          count,
			  GCancellable  *cancellable,
			  GError       **error)
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
{
  GInputStreamClass *class;
  gssize ret, read_bytes;
  char buffer[8192];
  GError *my_error;

  if (G_IS_SEEKABLE (stream) && g_seekable_can_seek (G_SEEKABLE (stream)))
    {
      if (g_seekable_seek (G_SEEKABLE (stream),
			   count,
			   G_SEEK_CUR,
			   cancellable,
			   NULL))
	return count;
    }

  /* If not seekable, or seek failed, fall back to reading data: */

  class = G_INPUT_STREAM_GET_CLASS (stream);
422

423 424 425 426 427
  read_bytes = 0;
  while (1)
    {
      my_error = NULL;

428
      ret = class->read_fn (stream, buffer, MIN (sizeof (buffer), count),
429
                            cancellable, &my_error);
430 431 432 433 434 435 436 437 438
      if (ret == -1)
	{
	  if (read_bytes > 0 &&
	      my_error->domain == G_IO_ERROR &&
	      my_error->code == G_IO_ERROR_CANCELLED)
	    {
	      g_error_free (my_error);
	      return read_bytes;
	    }
439

440 441 442 443 444 445
	  g_propagate_error (error, my_error);
	  return -1;
	}

      count -= ret;
      read_bytes += ret;
446

447
      if (ret == 0 || count == 0)
448
        return read_bytes;
449 450 451 452 453 454
    }
}

/**
 * g_input_stream_close:
 * @stream: A #GInputStream.
455
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
Matthias Clasen's avatar
Matthias Clasen committed
456
 * @error: location to store the error occurring, or %NULL to ignore
457 458 459 460 461 462 463
 *
 * Closes the stream, releasing resources related to it.
 *
 * Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
 * Closing a stream multiple times will not return an error.
 *
 * Streams will be automatically closed when the last reference
464 465
 * is dropped, but you might want to call this function to make sure 
 * resources are released as early as possible.
466 467 468 469 470 471 472
 *
 * Some streams might keep the backing store of the stream (e.g. a file descriptor)
 * open after the stream is closed. See the documentation for the individual
 * stream for details.
 *
 * On failure the first error that happened will be reported, but the close
 * operation will finish as much as possible. A stream that failed to
473
 * close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
474 475
 * is important to check and report the error to the user.
 *
Dan Winship's avatar
Dan Winship committed
476
 * If @cancellable is not %NULL, then the operation can be cancelled by
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
 * triggering the cancellable object from another thread. If the operation
 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
 * Cancelling a close will still leave the stream closed, but some streams
 * can use a faster close that doesn't block to e.g. check errors. 
 *
 * Return value: %TRUE on success, %FALSE on failure
 **/
gboolean
g_input_stream_close (GInputStream  *stream,
		      GCancellable  *cancellable,
		      GError       **error)
{
  GInputStreamClass *class;
  gboolean res;

  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);

  class = G_INPUT_STREAM_GET_CLASS (stream);

  if (stream->priv->closed)
    return TRUE;

  res = TRUE;

501 502
  if (!g_input_stream_set_pending (stream, error))
    return FALSE;
503 504

  if (cancellable)
505
    g_cancellable_push_current (cancellable);
506

507 508
  if (class->close_fn)
    res = class->close_fn (stream, cancellable, error);
509 510

  if (cancellable)
511
    g_cancellable_pop_current (cancellable);
512 513

  g_input_stream_clear_pending (stream);
514 515 516 517 518 519 520
  
  stream->priv->closed = TRUE;
  
  return res;
}

static void
Matthias Clasen's avatar
Matthias Clasen committed
521
async_ready_callback_wrapper (GObject      *source_object,
522 523 524 525 526
			      GAsyncResult *res,
			      gpointer      user_data)
{
  GInputStream *stream = G_INPUT_STREAM (source_object);

527
  g_input_stream_clear_pending (stream);
528 529 530 531 532 533
  if (stream->priv->outstanding_callback)
    (*stream->priv->outstanding_callback) (source_object, res, user_data);
  g_object_unref (stream);
}

static void
Matthias Clasen's avatar
Matthias Clasen committed
534
async_ready_close_callback_wrapper (GObject      *source_object,
535 536 537 538 539
				    GAsyncResult *res,
				    gpointer      user_data)
{
  GInputStream *stream = G_INPUT_STREAM (source_object);

540
  g_input_stream_clear_pending (stream);
541 542 543 544 545 546 547 548 549 550 551
  stream->priv->closed = TRUE;
  if (stream->priv->outstanding_callback)
    (*stream->priv->outstanding_callback) (source_object, res, user_data);
  g_object_unref (stream);
}

/**
 * g_input_stream_read_async:
 * @stream: A #GInputStream.
 * @buffer: a buffer to read data into (which should be at least count bytes long).
 * @count: the number of bytes that will be read from the stream
Matthias Clasen's avatar
Matthias Clasen committed
552
 * @io_priority: the <link linkend="io-priority">I/O priority</link> 
553
 * of the request. 
554 555 556
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 * @callback: (scope async): callback to call when the request is satisfied
 * @user_data: (closure): the data to pass to callback function
557 558
 *
 * Request an asynchronous read of @count bytes from the stream into the buffer
559 560 561
 * starting at @buffer. When the operation is finished @callback will be called. 
 * You can then call g_input_stream_read_finish() to get the result of the 
 * operation.
562
 *
563
 * During an async request no other sync and async calls are allowed on @stream, and will
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
 * result in %G_IO_ERROR_PENDING errors. 
 *
 * A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
 *
 * On success, the number of bytes read into the buffer will be passed to the
 * callback. It is not an error if this is not the same as the requested size, as it
 * can happen e.g. near the end of a file, but generally we try to read
 * as many bytes as requested. Zero is returned on end of file
 * (or if @count is zero),  but never otherwise.
 *
 * Any outstanding i/o request with higher priority (lower numerical value) will
 * be executed before an outstanding request with lower priority. Default
 * priority is %G_PRIORITY_DEFAULT.
 *
 * The asyncronous methods have a default fallback that uses threads to implement
 * asynchronicity, so they are optional for inheriting classes. However, if you
 * override one you must override all.
 **/
void
g_input_stream_read_async (GInputStream        *stream,
			   void                *buffer,
			   gsize                count,
			   int                  io_priority,
			   GCancellable        *cancellable,
			   GAsyncReadyCallback  callback,
			   gpointer             user_data)
{
  GInputStreamClass *class;
  GSimpleAsyncResult *simple;
593
  GError *error = NULL;
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614

  g_return_if_fail (G_IS_INPUT_STREAM (stream));
  g_return_if_fail (buffer != NULL);

  if (count == 0)
    {
      simple = g_simple_async_result_new (G_OBJECT (stream),
					  callback,
					  user_data,
					  g_input_stream_read_async);
      g_simple_async_result_complete_in_idle (simple);
      g_object_unref (simple);
      return;
    }
  
  if (((gssize) count) < 0)
    {
      g_simple_async_report_error_in_idle (G_OBJECT (stream),
					   callback,
					   user_data,
					   G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
Matthias Clasen's avatar
Matthias Clasen committed
615
					   _("Too large count value passed to %s"),
616
					   G_STRFUNC);
617 618 619
      return;
    }

620
  if (!g_input_stream_set_pending (stream, &error))
621
    {
622
      g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
623 624 625
					    callback,
					    user_data,
					    error);
626 627 628 629 630 631 632 633 634 635 636 637
      return;
    }

  class = G_INPUT_STREAM_GET_CLASS (stream);
  stream->priv->outstanding_callback = callback;
  g_object_ref (stream);
  class->read_async (stream, buffer, count, io_priority, cancellable,
		     async_ready_callback_wrapper, user_data);
}

/**
 * g_input_stream_read_finish:
638 639
 * @stream: a #GInputStream.
 * @result: a #GAsyncResult.
Matthias Clasen's avatar
Matthias Clasen committed
640
 * @error: a #GError location to store the error occurring, or %NULL to 
641
 * ignore.
642 643 644
 * 
 * Finishes an asynchronous stream read operation. 
 * 
645
 * Returns: number of bytes read in, or -1 on error, or 0 on end of file.
646 647
 **/
gssize
Matthias Clasen's avatar
Matthias Clasen committed
648 649 650
g_input_stream_read_finish (GInputStream  *stream,
			    GAsyncResult  *result,
			    GError       **error)
651 652 653 654 655 656
{
  GInputStreamClass *class;
  
  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);
  g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);

657 658
  if (g_async_result_legacy_propagate_error (result, error))
    return -1;
659
  else if (g_async_result_is_tagged (result, g_input_stream_read_async))
660 661
    {
      /* Special case read of 0 bytes */
662
      return 0;
663 664 665 666 667 668
    }

  class = G_INPUT_STREAM_GET_CLASS (stream);
  return class->read_finish (stream, result, error);
}

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
static void
read_bytes_callback (GObject      *stream,
		     GAsyncResult *result,
		     gpointer      user_data)
{
  GSimpleAsyncResult *simple = user_data;
  guchar *buf = g_simple_async_result_get_op_res_gpointer (simple);
  GError *error = NULL;
  gssize nread;
  GBytes *bytes = NULL;

  nread = g_input_stream_read_finish (G_INPUT_STREAM (stream),
				      result, &error);
  if (nread == -1)
    {
      g_free (buf);
      g_simple_async_result_take_error (simple, error);
    }
  else if (nread == 0)
    {
      g_free (buf);
      bytes = g_bytes_new_static ("", 0);
    }
  else
    bytes = g_bytes_new_take (buf, nread);

  if (bytes)
    {
      g_simple_async_result_set_op_res_gpointer (simple, bytes,
						 (GDestroyNotify)g_bytes_unref);
    }
  g_simple_async_result_complete (simple);
  g_object_unref (simple);
}

/**
 * g_input_stream_read_bytes_async:
 * @stream: A #GInputStream.
 * @count: the number of bytes that will be read from the stream
 * @io_priority: the <link linkend="io-priority">I/O priority</link>
 *   of the request.
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 * @callback: (scope async): callback to call when the request is satisfied
 * @user_data: (closure): the data to pass to callback function
 *
 * Request an asynchronous read of @count bytes from the stream into a
 * new #GBytes. When the operation is finished @callback will be
 * called. You can then call g_input_stream_read_bytes_finish() to get the
 * result of the operation.
 *
 * During an async request no other sync and async calls are allowed
 * on @stream, and will result in %G_IO_ERROR_PENDING errors.
 *
 * A value of @count larger than %G_MAXSSIZE will cause a
 * %G_IO_ERROR_INVALID_ARGUMENT error.
 *
 * On success, the new #GBytes will be passed to the callback. It is
 * not an error if this is smaller than the requested size, as it can
 * happen e.g. near the end of a file, but generally we try to read as
 * many bytes as requested. Zero is returned on end of file (or if
 * @count is zero), but never otherwise.
 *
 * Any outstanding I/O request with higher priority (lower numerical
 * value) will be executed before an outstanding request with lower
 * priority. Default priority is %G_PRIORITY_DEFAULT.
 **/
void
g_input_stream_read_bytes_async (GInputStream          *stream,
				 gsize                  count,
				 int                    io_priority,
				 GCancellable          *cancellable,
				 GAsyncReadyCallback    callback,
				 gpointer               user_data)
{
  GSimpleAsyncResult *simple;
  guchar *buf;

  simple = g_simple_async_result_new (G_OBJECT (stream),
				      callback, user_data,
				      g_input_stream_read_bytes_async);
  buf = g_malloc (count);
  g_simple_async_result_set_op_res_gpointer (simple, buf, NULL);

  g_input_stream_read_async (stream, buf, count,
			     io_priority, cancellable,
			     read_bytes_callback, simple);
}

/**
 * g_input_stream_read_bytes_finish:
 * @stream: a #GInputStream.
 * @result: a #GAsyncResult.
 * @error: a #GError location to store the error occurring, or %NULL to
 *   ignore.
 *
 * Finishes an asynchronous stream read-into-#GBytes operation.
 *
 * Returns: the newly-allocated #GBytes, or %NULL on error
 **/
GBytes *
g_input_stream_read_bytes_finish (GInputStream  *stream,
				  GAsyncResult  *result,
				  GError       **error)
{
  GSimpleAsyncResult *simple;

  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), NULL);
  g_return_val_if_fail (g_simple_async_result_is_valid (result, G_OBJECT (stream), g_input_stream_read_bytes_async), NULL);

  simple = G_SIMPLE_ASYNC_RESULT (result);
  if (g_simple_async_result_propagate_error (simple, error))
    return NULL;
  return g_bytes_ref (g_simple_async_result_get_op_res_gpointer (simple));
}

784 785 786 787
/**
 * g_input_stream_skip_async:
 * @stream: A #GInputStream.
 * @count: the number of bytes that will be skipped from the stream
788 789
 * @io_priority: the <link linkend="io-priority">I/O priority</link>
 * of the request.
790 791 792
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 * @callback: (scope async): callback to call when the request is satisfied
 * @user_data: (closure): the data to pass to callback function
793
 *
794
 * Request an asynchronous skip of @count bytes from the stream.
795 796 797
 * When the operation is finished @callback will be called.
 * You can then call g_input_stream_skip_finish() to get the result
 * of the operation.
798
 *
799 800
 * During an async request no other sync and async calls are allowed,
 * and will result in %G_IO_ERROR_PENDING errors.
801 802 803
 *
 * A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
 *
804 805
 * On success, the number of bytes skipped will be passed to the callback.
 * It is not an error if this is not the same as the requested size, as it
806 807 808 809
 * can happen e.g. near the end of a file, but generally we try to skip
 * as many bytes as requested. Zero is returned on end of file
 * (or if @count is zero), but never otherwise.
 *
810 811 812
 * Any outstanding i/o request with higher priority (lower numerical value)
 * will be executed before an outstanding request with lower priority.
 * Default priority is %G_PRIORITY_DEFAULT.
813
 *
814 815 816
 * The asynchronous methods have a default fallback that uses threads to
 * implement asynchronicity, so they are optional for inheriting classes.
 * However, if you override one, you must override all.
817 818 819 820 821 822 823 824 825 826 827
 **/
void
g_input_stream_skip_async (GInputStream        *stream,
			   gsize                count,
			   int                  io_priority,
			   GCancellable        *cancellable,
			   GAsyncReadyCallback  callback,
			   gpointer             user_data)
{
  GInputStreamClass *class;
  GSimpleAsyncResult *simple;
828
  GError *error = NULL;
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

  g_return_if_fail (G_IS_INPUT_STREAM (stream));

  if (count == 0)
    {
      simple = g_simple_async_result_new (G_OBJECT (stream),
					  callback,
					  user_data,
					  g_input_stream_skip_async);

      g_simple_async_result_complete_in_idle (simple);
      g_object_unref (simple);
      return;
    }
  
  if (((gssize) count) < 0)
    {
      g_simple_async_report_error_in_idle (G_OBJECT (stream),
					   callback,
					   user_data,
					   G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
Matthias Clasen's avatar
Matthias Clasen committed
850
					   _("Too large count value passed to %s"),
851
					   G_STRFUNC);
852 853 854
      return;
    }

855
  if (!g_input_stream_set_pending (stream, &error))
856
    {
857
      g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
858 859 860
					    callback,
					    user_data,
					    error);
861 862 863 864 865 866 867 868 869 870 871 872
      return;
    }

  class = G_INPUT_STREAM_GET_CLASS (stream);
  stream->priv->outstanding_callback = callback;
  g_object_ref (stream);
  class->skip_async (stream, count, io_priority, cancellable,
		     async_ready_callback_wrapper, user_data);
}

/**
 * g_input_stream_skip_finish:
873 874
 * @stream: a #GInputStream.
 * @result: a #GAsyncResult.
Matthias Clasen's avatar
Matthias Clasen committed
875
 * @error: a #GError location to store the error occurring, or %NULL to 
876
 * ignore.
877 878 879 880
 * 
 * Finishes a stream skip operation.
 * 
 * Returns: the size of the bytes skipped, or %-1 on error.
881 882
 **/
gssize
Matthias Clasen's avatar
Matthias Clasen committed
883 884 885
g_input_stream_skip_finish (GInputStream  *stream,
			    GAsyncResult  *result,
			    GError       **error)
886 887 888 889 890 891
{
  GInputStreamClass *class;

  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), -1);
  g_return_val_if_fail (G_IS_ASYNC_RESULT (result), -1);

892 893
  if (g_async_result_legacy_propagate_error (result, error))
    return -1;
894
  else if (g_async_result_is_tagged (result, g_input_stream_skip_async))
895 896
    {
      /* Special case skip of 0 bytes */
897
      return 0;
898 899 900 901 902 903 904 905 906
    }

  class = G_INPUT_STREAM_GET_CLASS (stream);
  return class->skip_finish (stream, result, error);
}

/**
 * g_input_stream_close_async:
 * @stream: A #GInputStream.
Matthias Clasen's avatar
Matthias Clasen committed
907
 * @io_priority: the <link linkend="io-priority">I/O priority</link> 
908
 * of the request. 
909 910 911
 * @cancellable: (allow-none): optional cancellable object
 * @callback: (scope async): callback to call when the request is satisfied
 * @user_data: (closure): the data to pass to callback function
912 913
 *
 * Requests an asynchronous closes of the stream, releasing resources related to it.
914 915 916
 * When the operation is finished @callback will be called. 
 * You can then call g_input_stream_close_finish() to get the result of the 
 * operation.
917 918 919 920 921 922 923 924
 *
 * For behaviour details see g_input_stream_close().
 *
 * The asyncronous methods have a default fallback that uses threads to implement
 * asynchronicity, so they are optional for inheriting classes. However, if you
 * override one you must override all.
 **/
void
Matthias Clasen's avatar
Matthias Clasen committed
925 926 927 928 929
g_input_stream_close_async (GInputStream        *stream,
			    int                  io_priority,
			    GCancellable        *cancellable,
			    GAsyncReadyCallback  callback,
			    gpointer             user_data)
930 931 932
{
  GInputStreamClass *class;
  GSimpleAsyncResult *simple;
933
  GError *error = NULL;
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948

  g_return_if_fail (G_IS_INPUT_STREAM (stream));

  if (stream->priv->closed)
    {
      simple = g_simple_async_result_new (G_OBJECT (stream),
					  callback,
					  user_data,
					  g_input_stream_close_async);

      g_simple_async_result_complete_in_idle (simple);
      g_object_unref (simple);
      return;
    }

949
  if (!g_input_stream_set_pending (stream, &error))
950
    {
951
      g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
952 953 954
					    callback,
					    user_data,
					    error);
955 956 957 958 959 960 961 962 963 964 965 966
      return;
    }
  
  class = G_INPUT_STREAM_GET_CLASS (stream);
  stream->priv->outstanding_callback = callback;
  g_object_ref (stream);
  class->close_async (stream, io_priority, cancellable,
		      async_ready_close_callback_wrapper, user_data);
}

/**
 * g_input_stream_close_finish:
967 968
 * @stream: a #GInputStream.
 * @result: a #GAsyncResult.
Matthias Clasen's avatar
Matthias Clasen committed
969
 * @error: a #GError location to store the error occurring, or %NULL to 
970
 * ignore.
971 972 973 974
 * 
 * Finishes closing a stream asynchronously, started from g_input_stream_close_async().
 * 
 * Returns: %TRUE if the stream was closed successfully.
975 976
 **/
gboolean
Matthias Clasen's avatar
Matthias Clasen committed
977 978 979
g_input_stream_close_finish (GInputStream  *stream,
			     GAsyncResult  *result,
			     GError       **error)
980 981 982 983 984 985
{
  GInputStreamClass *class;

  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
  g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);

986 987
  if (g_async_result_legacy_propagate_error (result, error))
    return FALSE;
988
  else if (g_async_result_is_tagged (result, g_input_stream_close_async))
989 990
    {
      /* Special case already closed */
991
      return TRUE;
992 993 994 995 996 997 998 999 1000 1001
    }

  class = G_INPUT_STREAM_GET_CLASS (stream);
  return class->close_finish (stream, result, error);
}

/**
 * g_input_stream_is_closed:
 * @stream: input stream.
 * 
1002 1003
 * Checks if an input stream is closed.
 * 
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
 * Returns: %TRUE if the stream is closed.
 **/
gboolean
g_input_stream_is_closed (GInputStream *stream)
{
  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), TRUE);
  
  return stream->priv->closed;
}
 
/**
 * g_input_stream_has_pending:
 * @stream: input stream.
 * 
1018 1019
 * Checks if an input stream has pending actions.
 * 
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
 * Returns: %TRUE if @stream has pending actions.
 **/  
gboolean
g_input_stream_has_pending (GInputStream *stream)
{
  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), TRUE);
  
  return stream->priv->pending;
}

/**
 * g_input_stream_set_pending:
 * @stream: input stream
Matthias Clasen's avatar
Matthias Clasen committed
1033
 * @error: a #GError location to store the error occurring, or %NULL to 
1034
 * ignore.
1035
 * 
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
 * Sets @stream to have actions pending. If the pending flag is
 * already set or @stream is closed, it will return %FALSE and set
 * @error.
 *
 * Return value: %TRUE if pending was previously unset and is now set.
 **/
gboolean
g_input_stream_set_pending (GInputStream *stream, GError **error)
{
  g_return_val_if_fail (G_IS_INPUT_STREAM (stream), FALSE);
  
  if (stream->priv->closed)
    {
1049 1050
      g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
                           _("Stream is already closed"));
1051 1052 1053 1054 1055
      return FALSE;
    }
  
  if (stream->priv->pending)
    {
1056
      g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PENDING,
1057 1058 1059 1060
		/* Translators: This is an error you get if there is already an
		 * operation running against this stream when you try to start
		 * one */
		 _("Stream has outstanding operation"));
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
      return FALSE;
    }
  
  stream->priv->pending = TRUE;
  return TRUE;
}

/**
 * g_input_stream_clear_pending:
 * @stream: input stream
 * 
 * Clears the pending flag on @stream.
1073 1074
 **/
void
1075
g_input_stream_clear_pending (GInputStream *stream)
1076 1077 1078
{
  g_return_if_fail (G_IS_INPUT_STREAM (stream));
  
1079
  stream->priv->pending = FALSE;
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
}

/********************************************
 *   Default implementation of async ops    *
 ********************************************/

typedef struct {
  void              *buffer;
  gsize              count_requested;
  gssize             count_read;
1090 1091 1092 1093

  GCancellable      *cancellable;
  gint               io_priority;
  gboolean           need_idle;
1094 1095
} ReadData;

1096 1097 1098 1099 1100 1101 1102 1103
static void
free_read_data (ReadData *op)
{
  if (op->cancellable)
    g_object_unref (op->cancellable);
  g_slice_free (ReadData, op);
}

1104 1105
static void
read_async_thread (GSimpleAsyncResult *res,
Matthias Clasen's avatar
Matthias Clasen committed
1106 1107
		   GObject            *object,
		   GCancellable       *cancellable)
1108 1109 1110 1111 1112 1113 1114 1115 1116
{
  ReadData *op;
  GInputStreamClass *class;
  GError *error = NULL;
 
  op = g_simple_async_result_get_op_res_gpointer (res);

  class = G_INPUT_STREAM_GET_CLASS (object);

1117 1118 1119
  op->count_read = class->read_fn (G_INPUT_STREAM (object),
				   op->buffer, op->count_requested,
				   cancellable, &error);
1120
  if (op->count_read == -1)
1121
    g_simple_async_result_take_error (res, error);
1122 1123
}

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
static void read_async_pollable (GPollableInputStream *stream,
				 GSimpleAsyncResult   *result);

static gboolean
read_async_pollable_ready (GPollableInputStream *stream,
			   gpointer              user_data)
{
  GSimpleAsyncResult *result = user_data;

  read_async_pollable (stream, result);
  return FALSE;
}

static void
read_async_pollable (GPollableInputStream *stream,
		     GSimpleAsyncResult   *result)
{
  GError *error = NULL;
  ReadData *op = g_simple_async_result_get_op_res_gpointer (result);

  if (g_cancellable_set_error_if_cancelled (op->cancellable, &error))
    op->count_read = -1;
  else
    {
      op->count_read = G_POLLABLE_INPUT_STREAM_GET_INTERFACE (stream)->
	read_nonblocking (stream, op->buffer, op->count_requested, &error);
    }

  if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
    {
      GSource *source;

      g_error_free (error);
      op->need_idle = FALSE;

      source = g_pollable_input_stream_create_source (stream, op->cancellable);
      g_source_set_callback (source,
			     (GSourceFunc) read_async_pollable_ready,
			     g_object_ref (result), g_object_unref);
      g_source_set_priority (source, op->io_priority);
      g_source_attach (source, g_main_context_get_thread_default ());
      g_source_unref (source);
      return;
    }

  if (op->count_read == -1)
    g_simple_async_result_take_error (result, error);

  if (op->need_idle)
    g_simple_async_result_complete_in_idle (result);
  else
    g_simple_async_result_complete (result);
}

1178
static void
Matthias Clasen's avatar
Matthias Clasen committed
1179 1180 1181 1182 1183 1184 1185
g_input_stream_real_read_async (GInputStream        *stream,
				void                *buffer,
				gsize                count,
				int                  io_priority,
				GCancellable        *cancellable,
				GAsyncReadyCallback  callback,
				gpointer             user_data)
1186 1187 1188 1189
{
  GSimpleAsyncResult *res;
  ReadData *op;
  
1190
  op = g_slice_new0 (ReadData);
1191
  res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data, g_input_stream_real_read_async);
1192
  g_simple_async_result_set_op_res_gpointer (res, op, (GDestroyNotify) free_read_data);
1193 1194
  op->buffer = buffer;
  op->count_requested = count;
1195 1196 1197 1198 1199 1200 1201 1202 1203
  op->cancellable = cancellable ? g_object_ref (cancellable) : NULL;
  op->io_priority = io_priority;
  op->need_idle = TRUE;

  if (G_IS_POLLABLE_INPUT_STREAM (stream) &&
      g_pollable_input_stream_can_poll (G_POLLABLE_INPUT_STREAM (stream)))
    read_async_pollable (G_POLLABLE_INPUT_STREAM (stream), res);
  else
    g_simple_async_result_run_in_thread (res, read_async_thread, io_priority, cancellable);
1204 1205 1206 1207
  g_object_unref (res);
}

static gssize
Matthias Clasen's avatar
Matthias Clasen committed
1208 1209 1210
g_input_stream_real_read_finish (GInputStream  *stream,
				 GAsyncResult  *result,
				 GError       **error)
1211 1212 1213 1214
{
  GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
  ReadData *op;

1215
  g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == 
1216 1217
	    g_input_stream_real_read_async);

1218 1219 1220
  if (g_simple_async_result_propagate_error (simple, error))
    return -1;

1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
  op = g_simple_async_result_get_op_res_gpointer (simple);

  return op->count_read;
}

typedef struct {
  gsize count_requested;
  gssize count_skipped;
} SkipData;


static void
skip_async_thread (GSimpleAsyncResult *res,
Matthias Clasen's avatar
Matthias Clasen committed
1234 1235
		   GObject            *object,
		   GCancellable       *cancellable)
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
{
  SkipData *op;
  GInputStreamClass *class;
  GError *error = NULL;
  
  class = G_INPUT_STREAM_GET_CLASS (object);
  op = g_simple_async_result_get_op_res_gpointer (res);
  op->count_skipped = class->skip (G_INPUT_STREAM (object),
				   op->count_requested,
				   cancellable, &error);
  if (op->count_skipped == -1)
1247
    g_simple_async_result_take_error (res, error);
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
}

typedef struct {
  char buffer[8192];
  gsize count;
  gsize count_skipped;
  int io_prio;
  GCancellable *cancellable;
  gpointer user_data;
  GAsyncReadyCallback callback;
} SkipFallbackAsyncData;

static void
Matthias Clasen's avatar
Matthias Clasen committed
1261
skip_callback_wrapper (GObject      *source_object,
1262
		       GAsyncResult *res,
Matthias Clasen's avatar
Matthias Clasen committed
1263
		       gpointer      user_data)
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
{
  GInputStreamClass *class;
  SkipFallbackAsyncData *data = user_data;
  SkipData *op;
  GSimpleAsyncResult *simple;
  GError *error = NULL;
  gssize ret;

  ret = g_input_stream_read_finish (G_INPUT_STREAM (source_object), res, &error);

  if (ret > 0)
    {
      data->count -= ret;
      data->count_skipped += ret;

      if (data->count > 0)
	{
	  class = G_INPUT_STREAM_GET_CLASS (source_object);
	  class->read_async (G_INPUT_STREAM (source_object), data->buffer, MIN (8192, data->count), data->io_prio, data->cancellable,
			     skip_callback_wrapper, data);
	  return;
	}
    }

  op = g_new0 (SkipData, 1);
  op->count_skipped = data->count_skipped;
  simple = g_simple_async_result_new (source_object,
				      data->callback, data->user_data,
				      g_input_stream_real_skip_async);

  g_simple_async_result_set_op_res_gpointer (simple, op, g_free);

  if (ret == -1)
    {
1298 1299 1300 1301
      if (data->count_skipped &&
          g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
	/* No error, return partial read */
	g_error_free (error);
1302
      else
1303
	g_simple_async_result_take_error (simple, error);
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
    }

  /* Complete immediately, not in idle, since we're already in a mainloop callout */
  g_simple_async_result_complete (simple);
  g_object_unref (simple);
  
  g_free (data);
 }

static void
g_input_stream_real_skip_async (GInputStream        *stream,
				gsize                count,
				int                  io_priority,
				GCancellable        *cancellable,
				GAsyncReadyCallback  callback,
				gpointer             user_data)
{
  GInputStreamClass *class;
  SkipData *op;
  SkipFallbackAsyncData *data;
  GSimpleAsyncResult *res;

  class = G_INPUT_STREAM_GET_CLASS (stream);

  if (class->read_async == g_input_stream_real_read_async)
    {
      /* Read is thread-using async fallback.
       * Make skip use threads too, so that we can use a possible sync skip
       * implementation. */
      op = g_new0 (SkipData, 1);
      
      res = g_simple_async_result_new (G_OBJECT (stream), callback, user_data,
				       g_input_stream_real_skip_async);

      g_simple_async_result_set_op_res_gpointer (res, op, g_free);

      op->count_requested = count;

      g_simple_async_result_run_in_thread (res, skip_async_thread, io_priority, cancellable);
      g_object_unref (res);
    }
  else
    {
      /* TODO: Skip fallback uses too much memory, should do multiple read calls */
      
      /* There is a custom async read function, lets use that. */
      data = g_new (SkipFallbackAsyncData, 1);
      data->count = count;
      data->count_skipped = 0;
      data->io_prio = io_priority;
      data->cancellable = cancellable;
      data->callback = callback;
      data->user_data = user_data;
      class->read_async (stream, data->buffer, MIN (8192, count), io_priority, cancellable,
			 skip_callback_wrapper, data);
    }

}

static gssize
Matthias Clasen's avatar
Matthias Clasen committed
1364 1365 1366
g_input_stream_real_skip_finish (GInputStream  *stream,
				 GAsyncResult  *result,
				 GError       **error)
1367 1368 1369 1370
{
  GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
  SkipData *op;

1371
  g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_input_stream_real_skip_async);
1372 1373 1374 1375

  if (g_simple_async_result_propagate_error (simple, error))
    return -1;

1376 1377 1378 1379 1380 1381
  op = g_simple_async_result_get_op_res_gpointer (simple);
  return op->count_skipped;
}

static void
close_async_thread (GSimpleAsyncResult *res,
Matthias Clasen's avatar
Matthias Clasen committed
1382 1383
		    GObject            *object,
		    GCancellable       *cancellable)
1384 1385 1386 1387 1388 1389 1390 1391 1392
{
  GInputStreamClass *class;
  GError *error = NULL;
  gboolean result;

  /* Auto handling of cancelation disabled, and ignore
     cancellation, since we want to close things anyway, although
     possibly in a quick-n-dirty way. At least we never want to leak
     open handles */
1393

1394
  class = G_INPUT_STREAM_GET_CLASS (object);
1395
  if (class->close_fn)
1396
    {
1397 1398
      result = class->close_fn (G_INPUT_STREAM (object), cancellable, &error);
      if (!result)
1399
        g_simple_async_result_take_error (res, error);
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
    }
}

static void
g_input_stream_real_close_async (GInputStream        *stream,
				 int                  io_priority,
				 GCancellable        *cancellable,
				 GAsyncReadyCallback  callback,
				 gpointer             user_data)
{
  GSimpleAsyncResult *res;
  
  res = g_simple_async_result_new (G_OBJECT (stream),
				   callback,
				   user_data,
				   g_input_stream_real_close_async);

  g_simple_async_result_set_handle_cancellation (res, FALSE);
  
  g_simple_async_result_run_in_thread (res,
				       close_async_thread,
				       io_priority,
				       cancellable);
  g_object_unref (res);
}

static gboolean
Matthias Clasen's avatar
Matthias Clasen committed
1427 1428 1429
g_input_stream_real_close_finish (GInputStream  *stream,
				  GAsyncResult  *result,
				  GError       **error)
1430 1431
{
  GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
1432

1433
  g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_input_stream_real_close_async);
1434 1435 1436 1437

  if (g_simple_async_result_propagate_error (simple, error))
    return FALSE;

1438 1439
  return TRUE;
}