gio/gsimpleasyncresult.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <string.h>
  28 #include <errno.h>
  29 #include <fcntl.h>
  30 #ifdef HAVE_UNISTD_H
  31 #include <unistd.h>
  32 #endif
  33
  34 #include "gsimpleasyncresult.h"
  35 #include "gasyncresult.h"
  36 #include "gcancellable.h"
  37 #include "gioscheduler.h"
  38 #include <gio/gioerror.h>
  39 #include "glibintl.h"
  40
  41
  42 /**
  43  * SECTION:gsimpleasyncresult
  44  * @short_description: Simple asynchronous results implementation
  45  * @include: gio/gio.h
  46  * @see_also: #GAsyncResult
  47  *
  48  * Implements #GAsyncResult for simple cases. Most of the time, this
  49  * will be all an application needs, and will be used transparently.
  50  * Because of this, #GSimpleAsyncResult is used throughout GIO for
  51  * handling asynchronous functions.
  52  *
  53  * GSimpleAsyncResult handles #GAsyncReadyCallback<!-- -->s, error
  54  * reporting, operation cancellation and the final state of an operation,
  55  * completely transparent to the application. Results can be returned
  56  * as a pointer e.g. for functions that return data that is collected
  57  * asynchronously, a boolean value for checking the success or failure
  58  * of an operation, or a #gssize for operations which return the number
  59  * of bytes modified by the operation; all of the simple return cases
  60  * are covered.
  61  *
  62  * Most of the time, an application will not need to know of the details
  63  * of this API; it is handled transparently, and any necessary operations
  64  * are handled by #GAsyncResult's interface. However, if implementing a
  65  * new GIO module, for writing language bindings, or for complex
  66  * applications that need better control of how asynchronous operations
  67  * are completed, it is important to understand this functionality.
  68  *
  69  * GSimpleAsyncResults are tagged with the calling function to ensure
  70  * that asynchronous functions and their finishing functions are used
  71  * together correctly.
  72  *
  73  * To create a new #GSimpleAsyncResult, call g_simple_async_result_new().
  74  * If the result needs to be created for a #GError, use
  75  * g_simple_async_result_new_from_error() or
  76  * g_simple_async_result_new_take_error(). If a #GError is not available
  77  * (e.g. the asynchronous operation's doesn't take a #GError argument),
  78  * but the result still needs to be created for an error condition, use
  79  * g_simple_async_result_new_error() (or g_simple_async_result_set_error_va()
  80  * if your application or binding requires passing a variable argument list
  81  * directly), and the error can then be propagated through the use of
  82  * g_simple_async_result_propagate_error().
  83  *
  84  * An asynchronous operation can be made to ignore a cancellation event by
  85  * calling g_simple_async_result_set_handle_cancellation() with a
  86  * #GSimpleAsyncResult for the operation and %FALSE. This is useful for
  87  * operations that are dangerous to cancel, such as close (which would
  88  * cause a leak if cancelled before being run).
  89  *
  90  * GSimpleAsyncResult can integrate into GLib's event loop, #GMainLoop,
  91  * or it can use #GThread<!-- -->s if available.
  92  * g_simple_async_result_complete() will finish an I/O task directly
  93  * from the point where it is called. g_simple_async_result_complete_in_idle()
  94  * will finish it from an idle handler in the <link
  95  * linkend="g-main-context-push-thread-default">thread-default main
  96  * context</link>. g_simple_async_result_run_in_thread() will run the
  97  * job in a separate thread and then deliver the result to the
  98  * thread-default main context.
  99  *
 100  * To set the results of an asynchronous function,
 101  * g_simple_async_result_set_op_res_gpointer(),
 102  * g_simple_async_result_set_op_res_gboolean(), and
 103  * g_simple_async_result_set_op_res_gssize()
 104  * are provided, setting the operation's result to a gpointer, gboolean, or
 105  * gssize, respectively.
 106  *
 107  * Likewise, to get the result of an asynchronous function,
 108  * g_simple_async_result_get_op_res_gpointer(),
 109  * g_simple_async_result_get_op_res_gboolean(), and
 110  * g_simple_async_result_get_op_res_gssize() are
 111  * provided, getting the operation's result as a gpointer, gboolean, and
 112  * gssize, respectively.
 113  *
 114  * For the details of the requirements implementations must respect, see
 115  * #GAsyncResult.  A typical implementation of an asynchronous operation
 116  * using GSimpleAsyncResult looks something like this:
 117  *
 118  * |[
 119  * static void
 120  * baked_cb (Cake    *cake,
 121  *           gpointer user_data)
 122  * {
 123  *   /&ast; In this example, this callback is not given a reference to the cake, so
 124  *    &ast; the GSimpleAsyncResult has to take a reference to it.
 125  *    &ast;/
 126  *   GSimpleAsyncResult *result = user_data;
 127  *
 128  *   if (cake == NULL)
 129  *     g_simple_async_result_set_error (result,
 130  *                                      BAKER_ERRORS,
 131  *                                      BAKER_ERROR_NO_FLOUR,
 132  *                                      "Go to the supermarket");
 133  *   else
 134  *     g_simple_async_result_set_op_res_gpointer (result,
 135  *                                                g_object_ref (cake),
 136  *                                                g_object_unref);
 137  *
 138  *
 139  *   /&ast; In this example, we assume that baked_cb is called as a callback from
 140  *    &ast; the mainloop, so it's safe to complete the operation synchronously here.
 141  *    &ast; If, however, _baker_prepare_cake () might call its callback without
 142  *    &ast; first returning to the mainloop — inadvisable, but some APIs do so —
 143  *    &ast; we would need to use g_simple_async_result_complete_in_idle().
 144  *    &ast;/
 145  *   g_simple_async_result_complete (result);
 146  *   g_object_unref (result);
 147  * }
 148  *
 149  * void
 150  * baker_bake_cake_async (Baker              *self,
 151  *                        guint               radius,
 152  *                        GAsyncReadyCallback callback,
 153  *                        gpointer            user_data)
 154  * {
 155  *   GSimpleAsyncResult *simple;
 156  *   Cake               *cake;
 157  *
 158  *   if (radius < 3)
 159  *     {
 160  *       g_simple_async_report_error_in_idle (G_OBJECT (self),
 161  *                                            callback,
 162  *                                            user_data,
 163  *                                            BAKER_ERRORS,
 164  *                                            BAKER_ERROR_TOO_SMALL,
 165  *                                            "%ucm radius cakes are silly",
 166  *                                            radius);
 167  *       return;
 168  *     }
 169  *
 170  *   simple = g_simple_async_result_new (G_OBJECT (self),
 171  *                                       callback,
 172  *                                       user_data,
 173  *                                       baker_bake_cake_async);
 174  *   cake = _baker_get_cached_cake (self, radius);
 175  *
 176  *   if (cake != NULL)
 177  *     {
 178  *       g_simple_async_result_set_op_res_gpointer (simple,
 179  *                                                  g_object_ref (cake),
 180  *                                                  g_object_unref);
 181  *       g_simple_async_result_complete_in_idle (simple);
 182  *       g_object_unref (simple);
 183  *       /&ast; Drop the reference returned by _baker_get_cached_cake(); the
 184  *        &ast; GSimpleAsyncResult has taken its own reference.
 185  *        &ast;/
 186  *       g_object_unref (cake);
 187  *       return;
 188  *     }
 189  *
 190  *   _baker_prepare_cake (self, radius, baked_cb, simple);
 191  * }
 192  *
 193  * Cake *
 194  * baker_bake_cake_finish (Baker        *self,
 195  *                         GAsyncResult *result,
 196  *                         GError      **error)
 197  * {
 198  *   GSimpleAsyncResult *simple;
 199  *   Cake               *cake;
 200  *
 201  *   g_return_val_if_fail (g_simple_async_result_is_valid (result,
 202  *                                                         G_OBJECT (self),
 203  *                                                         baker_bake_cake_async),
 204  *                         NULL);
 205  *
 206  *   simple = (GSimpleAsyncResult *) result;
 207  *
 208  *   if (g_simple_async_result_propagate_error (simple, error))
 209  *     return NULL;
 210  *
 211  *   cake = CAKE (g_simple_async_result_get_op_res_gpointer (simple));
 212  *   return g_object_ref (cake);
 213  * }
 214  * ]|
 215  */
 216
 217 static void g_simple_async_result_async_result_iface_init (GAsyncResultIface       *iface);
 218
 219 struct _GSimpleAsyncResult
 220 {
 221   GObject parent_instance;
 222
 223   GObject *source_object;
 224   GAsyncReadyCallback callback;
 225   gpointer user_data;
 226   GMainContext *context;
 227   GError *error;
 228   gboolean failed;
 229   gboolean handle_cancellation;
 230
 231   gpointer source_tag;
 232
 233   union {
 234     gpointer v_pointer;
 235     gboolean v_boolean;
 236     gssize   v_ssize;
 237   } op_res;
 238
 239   GDestroyNotify destroy_op_res;
 240 };
 241
 242 struct _GSimpleAsyncResultClass
 243 {
 244   GObjectClass parent_class;
 245 };
 246
 247
 248 G_DEFINE_TYPE_WITH_CODE (GSimpleAsyncResult, g_simple_async_result, G_TYPE_OBJECT,
 249                          G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_RESULT,
 250                                                 g_simple_async_result_async_result_iface_init))
 251
 252 static void
 253 clear_op_res (GSimpleAsyncResult *simple)
 254 {
 255   if (simple->destroy_op_res)
 256     simple->destroy_op_res (simple->op_res.v_pointer);
 257   simple->destroy_op_res = NULL;
 258   simple->op_res.v_ssize = 0;
 259 }
 260
 261 static void
 262 g_simple_async_result_finalize (GObject *object)
 263 {
 264   GSimpleAsyncResult *simple;
 265
 266   simple = G_SIMPLE_ASYNC_RESULT (object);
 267
 268   if (simple->source_object)
 269     g_object_unref (simple->source_object);
 270
 271   if (simple->context)
 272     g_main_context_unref (simple->context);
 273
 274   clear_op_res (simple);
 275
 276   if (simple->error)
 277     g_error_free (simple->error);
 278
 279   G_OBJECT_CLASS (g_simple_async_result_parent_class)->finalize (object);
 280 }
 281
 282 static void
 283 g_simple_async_result_class_init (GSimpleAsyncResultClass *klass)
 284 {
 285   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 286
 287   gobject_class->finalize = g_simple_async_result_finalize;
 288 }
 289
 290 static void
 291 g_simple_async_result_init (GSimpleAsyncResult *simple)
 292 {
 293   simple->handle_cancellation = TRUE;
 294
 295   simple->context = g_main_context_get_thread_default ();
 296   if (simple->context)
 297     g_main_context_ref (simple->context);
 298 }
 299
 300 /**
 301  * g_simple_async_result_new:
 302  * @source_object: (allow-none): a #GObject, or %NULL.
 303  * @callback: a #GAsyncReadyCallback.
 304  * @user_data: user data passed to @callback.
 305  * @source_tag: the asynchronous function.
 306  *
 307  * Creates a #GSimpleAsyncResult.
 308  *
 309  * Returns: a #GSimpleAsyncResult.
 310  **/
 311 GSimpleAsyncResult *
 312 g_simple_async_result_new (GObject             *source_object,
 313                            GAsyncReadyCallback  callback,
 314                            gpointer             user_data,
 315                            gpointer             source_tag)
 316 {
 317   GSimpleAsyncResult *simple;
 318
 319   g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
 320
 321   simple = g_object_new (G_TYPE_SIMPLE_ASYNC_RESULT, NULL);
 322   simple->callback = callback;
 323   if (source_object)
 324     simple->source_object = g_object_ref (source_object);
 325   else
 326     simple->source_object = NULL;
 327   simple->user_data = user_data;
 328   simple->source_tag = source_tag;
 329
 330   return simple;
 331 }
 332
 333 /**
 334  * g_simple_async_result_new_from_error:
 335  * @source_object: (allow-none): a #GObject, or %NULL.
 336  * @callback: a #GAsyncReadyCallback.
 337  * @user_data: user data passed to @callback.
 338  * @error: a #GError
 339  *
 340  * Creates a #GSimpleAsyncResult from an error condition.
 341  *
 342  * Returns: a #GSimpleAsyncResult.
 343  **/
 344 GSimpleAsyncResult *
 345 g_simple_async_result_new_from_error (GObject             *source_object,
 346                                       GAsyncReadyCallback  callback,
 347                                       gpointer             user_data,
 348                                       const GError        *error)
 349 {
 350   GSimpleAsyncResult *simple;
 351
 352   g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
 353
 354   simple = g_simple_async_result_new (source_object,
 355                                       callback,
 356                                       user_data, NULL);
 357   g_simple_async_result_set_from_error (simple, error);
 358
 359   return simple;
 360 }
 361
 362 /**
 363  * g_simple_async_result_new_take_error:
 364  * @source_object: (allow-none): a #GObject, or %NULL
 365  * @callback: a #GAsyncReadyCallback
 366  * @user_data: (allow-none): user data passed to @callback
 367  * @error: a #GError
 368  *
 369  * Creates a #GSimpleAsyncResult from an error condition, and takes over the
 370  * caller's ownership of @error, so the caller does not need to free it anymore.
 371  *
 372  * Returns: a #GSimpleAsyncResult
 373  *
 374  * Since: 2.28
 375  **/
 376 GSimpleAsyncResult *
 377 g_simple_async_result_new_take_error (GObject             *source_object,
 378                                       GAsyncReadyCallback  callback,
 379                                       gpointer             user_data,
 380                                       GError              *error)
 381 {
 382   GSimpleAsyncResult *simple;
 383
 384   g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
 385
 386   simple = g_simple_async_result_new (source_object,
 387                                       callback,
 388                                       user_data, NULL);
 389   g_simple_async_result_take_error (simple, error);
 390
 391   return simple;
 392 }
 393
 394 /**
 395  * g_simple_async_result_new_error:
 396  * @source_object: (allow-none): a #GObject, or %NULL.
 397  * @callback: a #GAsyncReadyCallback.
 398  * @user_data: user data passed to @callback.
 399  * @domain: a #GQuark.
 400  * @code: an error code.
 401  * @format: a string with format characters.
 402  * @...: a list of values to insert into @format.
 403  *
 404  * Creates a new #GSimpleAsyncResult with a set error.
 405  *
 406  * Returns: a #GSimpleAsyncResult.
 407  **/
 408 GSimpleAsyncResult *
 409 g_simple_async_result_new_error (GObject             *source_object,
 410                                  GAsyncReadyCallback  callback,
 411                                  gpointer             user_data,
 412                                  GQuark               domain,
 413                                  gint                 code,
 414                                  const char          *format,
 415                                  ...)
 416 {
 417   GSimpleAsyncResult *simple;
 418   va_list args;
 419
 420   g_return_val_if_fail (!source_object || G_IS_OBJECT (source_object), NULL);
 421   g_return_val_if_fail (domain != 0, NULL);
 422   g_return_val_if_fail (format != NULL, NULL);
 423
 424   simple = g_simple_async_result_new (source_object,
 425                                       callback,
 426                                       user_data, NULL);
 427
 428   va_start (args, format);
 429   g_simple_async_result_set_error_va (simple, domain, code, format, args);
 430   va_end (args);
 431
 432   return simple;
 433 }
 434
 435
 436 static gpointer
 437 g_simple_async_result_get_user_data (GAsyncResult *res)
 438 {
 439   return G_SIMPLE_ASYNC_RESULT (res)->user_data;
 440 }
 441
 442 static GObject *
 443 g_simple_async_result_get_source_object (GAsyncResult *res)
 444 {
 445   if (G_SIMPLE_ASYNC_RESULT (res)->source_object)
 446     return g_object_ref (G_SIMPLE_ASYNC_RESULT (res)->source_object);
 447   return NULL;
 448 }
 449
 450 static void
 451 g_simple_async_result_async_result_iface_init (GAsyncResultIface *iface)
 452 {
 453   iface->get_user_data = g_simple_async_result_get_user_data;
 454   iface->get_source_object = g_simple_async_result_get_source_object;
 455 }
 456
 457 /**
 458  * g_simple_async_result_set_handle_cancellation:
 459  * @simple: a #GSimpleAsyncResult.
 460  * @handle_cancellation: a #gboolean.
 461  *
 462  * Sets whether to handle cancellation within the asynchronous operation.
 463  *
 464  **/
 465 void
 466 g_simple_async_result_set_handle_cancellation (GSimpleAsyncResult *simple,
 467                                                gboolean            handle_cancellation)
 468 {
 469   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 470   simple->handle_cancellation = handle_cancellation;
 471 }
 472
 473 /**
 474  * g_simple_async_result_get_source_tag: (skip)
 475  * @simple: a #GSimpleAsyncResult.
 476  *
 477  * Gets the source tag for the #GSimpleAsyncResult.
 478  *
 479  * Returns: a #gpointer to the source object for the #GSimpleAsyncResult.
 480  **/
 481 gpointer
 482 g_simple_async_result_get_source_tag (GSimpleAsyncResult *simple)
 483 {
 484   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), NULL);
 485   return simple->source_tag;
 486 }
 487
 488 /**
 489  * g_simple_async_result_propagate_error:
 490  * @simple: a #GSimpleAsyncResult.
 491  * @dest: a location to propegate the error to.
 492  *
 493  * Propagates an error from within the simple asynchronous result to
 494  * a given destination.
 495  *
 496  * Returns: %TRUE if the error was propagated to @dest. %FALSE otherwise.
 497  **/
 498 gboolean
 499 g_simple_async_result_propagate_error (GSimpleAsyncResult  *simple,
 500                                        GError             **dest)
 501 {
 502   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), FALSE);
 503
 504   if (simple->failed)
 505     {
 506       g_propagate_error (dest, simple->error);
 507       simple->error = NULL;
 508       return TRUE;
 509     }
 510
 511   return FALSE;
 512 }
 513
 514 /**
 515  * g_simple_async_result_set_op_res_gpointer:
 516  * @simple: a #GSimpleAsyncResult.
 517  * @op_res: a pointer result from an asynchronous function.
 518  * @destroy_op_res: a #GDestroyNotify function.
 519  *
 520  * Sets the operation result within the asynchronous result to a pointer.
 521  **/
 522 void
 523 g_simple_async_result_set_op_res_gpointer (GSimpleAsyncResult *simple,
 524                                            gpointer            op_res,
 525                                            GDestroyNotify      destroy_op_res)
 526 {
 527   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 528
 529   clear_op_res (simple);
 530   simple->op_res.v_pointer = op_res;
 531   simple->destroy_op_res = destroy_op_res;
 532 }
 533
 534 /**
 535  * g_simple_async_result_get_op_res_gpointer: (skip)
 536  * @simple: a #GSimpleAsyncResult.
 537  *
 538  * Gets a pointer result as returned by the asynchronous function.
 539  *
 540  * Returns: a pointer from the result.
 541  **/
 542 gpointer
 543 g_simple_async_result_get_op_res_gpointer (GSimpleAsyncResult *simple)
 544 {
 545   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), NULL);
 546   return simple->op_res.v_pointer;
 547 }
 548
 549 /**
 550  * g_simple_async_result_set_op_res_gssize:
 551  * @simple: a #GSimpleAsyncResult.
 552  * @op_res: a #gssize.
 553  *
 554  * Sets the operation result within the asynchronous result to
 555  * the given @op_res.
 556  **/
 557 void
 558 g_simple_async_result_set_op_res_gssize (GSimpleAsyncResult *simple,
 559                                          gssize              op_res)
 560 {
 561   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 562   clear_op_res (simple);
 563   simple->op_res.v_ssize = op_res;
 564 }
 565
 566 /**
 567  * g_simple_async_result_get_op_res_gssize:
 568  * @simple: a #GSimpleAsyncResult.
 569  *
 570  * Gets a gssize from the asynchronous result.
 571  *
 572  * Returns: a gssize returned from the asynchronous function.
 573  **/
 574 gssize
 575 g_simple_async_result_get_op_res_gssize (GSimpleAsyncResult *simple)
 576 {
 577   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), 0);
 578   return simple->op_res.v_ssize;
 579 }
 580
 581 /**
 582  * g_simple_async_result_set_op_res_gboolean:
 583  * @simple: a #GSimpleAsyncResult.
 584  * @op_res: a #gboolean.
 585  *
 586  * Sets the operation result to a boolean within the asynchronous result.
 587  **/
 588 void
 589 g_simple_async_result_set_op_res_gboolean (GSimpleAsyncResult *simple,
 590                                            gboolean            op_res)
 591 {
 592   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 593   clear_op_res (simple);
 594   simple->op_res.v_boolean = !!op_res;
 595 }
 596
 597 /**
 598  * g_simple_async_result_get_op_res_gboolean:
 599  * @simple: a #GSimpleAsyncResult.
 600  *
 601  * Gets the operation result boolean from within the asynchronous result.
 602  *
 603  * Returns: %TRUE if the operation's result was %TRUE, %FALSE
 604  *     if the operation's result was %FALSE.
 605  **/
 606 gboolean
 607 g_simple_async_result_get_op_res_gboolean (GSimpleAsyncResult *simple)
 608 {
 609   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple), FALSE);
 610   return simple->op_res.v_boolean;
 611 }
 612
 613 /**
 614  * g_simple_async_result_set_from_error:
 615  * @simple: a #GSimpleAsyncResult.
 616  * @error: #GError.
 617  *
 618  * Sets the result from a #GError.
 619  **/
 620 void
 621 g_simple_async_result_set_from_error (GSimpleAsyncResult *simple,
 622                                       const GError       *error)
 623 {
 624   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 625   g_return_if_fail (error != NULL);
 626
 627   if (simple->error)
 628     g_error_free (simple->error);
 629   simple->error = g_error_copy (error);
 630   simple->failed = TRUE;
 631 }
 632
 633 /**
 634  * g_simple_async_result_take_error:
 635  * @simple: a #GSimpleAsyncResult
 636  * @error: a #GError
 637  *
 638  * Sets the result from @error, and takes over the caller's ownership
 639  * of @error, so the caller does not need to free it any more.
 640  *
 641  * Since: 2.28
 642  **/
 643 void
 644 g_simple_async_result_take_error (GSimpleAsyncResult *simple,
 645                                   GError             *error)
 646 {
 647   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 648   g_return_if_fail (error != NULL);
 649
 650   if (simple->error)
 651     g_error_free (simple->error);
 652   simple->error = error;
 653   simple->failed = TRUE;
 654 }
 655
 656 /**
 657  * g_simple_async_result_set_error_va:
 658  * @simple: a #GSimpleAsyncResult.
 659  * @domain: a #GQuark (usually #G_IO_ERROR).
 660  * @code: an error code.
 661  * @format: a formatted error reporting string.
 662  * @args: va_list of arguments.
 663  *
 664  * Sets an error within the asynchronous result without a #GError.
 665  * Unless writing a binding, see g_simple_async_result_set_error().
 666  **/
 667 void
 668 g_simple_async_result_set_error_va (GSimpleAsyncResult *simple,
 669                                     GQuark              domain,
 670                                     gint                code,
 671                                     const char         *format,
 672                                     va_list             args)
 673 {
 674   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 675   g_return_if_fail (domain != 0);
 676   g_return_if_fail (format != NULL);
 677
 678   if (simple->error)
 679     g_error_free (simple->error);
 680   simple->error = g_error_new_valist (domain, code, format, args);
 681   simple->failed = TRUE;
 682 }
 683
 684 /**
 685  * g_simple_async_result_set_error:
 686  * @simple: a #GSimpleAsyncResult.
 687  * @domain: a #GQuark (usually #G_IO_ERROR).
 688  * @code: an error code.
 689  * @format: a formatted error reporting string.
 690  * @...: a list of variables to fill in @format.
 691  *
 692  * Sets an error within the asynchronous result without a #GError.
 693  **/
 694 void
 695 g_simple_async_result_set_error (GSimpleAsyncResult *simple,
 696                                  GQuark              domain,
 697                                  gint                code,
 698                                  const char         *format,
 699                                  ...)
 700 {
 701   va_list args;
 702
 703   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 704   g_return_if_fail (domain != 0);
 705   g_return_if_fail (format != NULL);
 706
 707   va_start (args, format);
 708   g_simple_async_result_set_error_va (simple, domain, code, format, args);
 709   va_end (args);
 710 }
 711
 712 /**
 713  * g_simple_async_result_complete:
 714  * @simple: a #GSimpleAsyncResult.
 715  *
 716  * Completes an asynchronous I/O job immediately. Must be called in
 717  * the thread where the asynchronous result was to be delivered, as it
 718  * invokes the callback directly. If you are in a different thread use
 719  * g_simple_async_result_complete_in_idle().
 720  *
 721  * Calling this function takes a reference to @simple for as long as
 722  * is needed to complete the call.
 723  **/
 724 void
 725 g_simple_async_result_complete (GSimpleAsyncResult *simple)
 726 {
 727 #ifndef G_DISABLE_CHECKS
 728   GSource *current_source;
 729   GMainContext *current_context;
 730 #endif
 731
 732   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 733
 734 #ifndef G_DISABLE_CHECKS
 735   current_source = g_main_current_source ();
 736   if (current_source && !g_source_is_destroyed (current_source))
 737     {
 738       current_context = g_source_get_context (current_source);
 739       if (current_context == g_main_context_default ())
 740         current_context = NULL;
 741       if (simple->context != current_context)
 742         g_warning ("g_simple_async_result_complete() called from wrong context!");
 743     }
 744 #endif
 745
 746   if (simple->callback)
 747     simple->callback (simple->source_object,
 748                       G_ASYNC_RESULT (simple),
 749                       simple->user_data);
 750 }
 751
 752 static gboolean
 753 complete_in_idle_cb (gpointer data)
 754 {
 755   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (data);
 756
 757   g_simple_async_result_complete (simple);
 758
 759   return FALSE;
 760 }
 761
 762 /**
 763  * g_simple_async_result_complete_in_idle:
 764  * @simple: a #GSimpleAsyncResult.
 765  *
 766  * Completes an asynchronous function in an idle handler in the <link
 767  * linkend="g-main-context-push-thread-default">thread-default main
 768  * loop</link> of the thread that @simple was initially created in.
 769  *
 770  * Calling this function takes a reference to @simple for as long as
 771  * is needed to complete the call.
 772  */
 773 void
 774 g_simple_async_result_complete_in_idle (GSimpleAsyncResult *simple)
 775 {
 776   GSource *source;
 777
 778   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 779
 780   g_object_ref (simple);
 781
 782   source = g_idle_source_new ();
 783   g_source_set_priority (source, G_PRIORITY_DEFAULT);
 784   g_source_set_callback (source, complete_in_idle_cb, simple, g_object_unref);
 785
 786   g_source_attach (source, simple->context);
 787   g_source_unref (source);
 788 }
 789
 790 typedef struct {
 791   GSimpleAsyncResult *simple;
 792   GCancellable *cancellable;
 793   GSimpleAsyncThreadFunc func;
 794 } RunInThreadData;
 795
 796
 797 static gboolean
 798 complete_in_idle_cb_for_thread (gpointer _data)
 799 {
 800   RunInThreadData *data = _data;
 801   GSimpleAsyncResult *simple;
 802
 803   simple = data->simple;
 804
 805   if (simple->handle_cancellation &&
 806       g_cancellable_is_cancelled (data->cancellable))
 807     g_simple_async_result_set_error (simple,
 808                                      G_IO_ERROR,
 809                                      G_IO_ERROR_CANCELLED,
 810                                      "%s", _("Operation was cancelled"));
 811
 812   g_simple_async_result_complete (simple);
 813
 814   if (data->cancellable)
 815     g_object_unref (data->cancellable);
 816   g_object_unref (data->simple);
 817   g_free (data);
 818
 819   return FALSE;
 820 }
 821
 822 static gboolean
 823 run_in_thread (GIOSchedulerJob *job,
 824                GCancellable    *c,
 825                gpointer         _data)
 826 {
 827   RunInThreadData *data = _data;
 828   GSimpleAsyncResult *simple = data->simple;
 829   GSource *source;
 830
 831   if (simple->handle_cancellation &&
 832       g_cancellable_is_cancelled (c))
 833     g_simple_async_result_set_error (simple,
 834                                      G_IO_ERROR,
 835                                      G_IO_ERROR_CANCELLED,
 836                                      "%s", _("Operation was cancelled"));
 837   else
 838     data->func (simple,
 839                 simple->source_object,
 840                 c);
 841
 842   source = g_idle_source_new ();
 843   g_source_set_priority (source, G_PRIORITY_DEFAULT);
 844   g_source_set_callback (source, complete_in_idle_cb_for_thread, data, NULL);
 845
 846   g_source_attach (source, simple->context);
 847   g_source_unref (source);
 848
 849   return FALSE;
 850 }
 851
 852 /**
 853  * g_simple_async_result_run_in_thread:
 854  * @simple: a #GSimpleAsyncResult.
 855  * @func: a #GSimpleAsyncThreadFunc.
 856  * @io_priority: the io priority of the request.
 857  * @cancellable: optional #GCancellable object, %NULL to ignore.
 858  *
 859  * Runs the asynchronous job in a separate thread and then calls
 860  * g_simple_async_result_complete_in_idle() on @simple to return
 861  * the result to the appropriate main loop.
 862  *
 863  * Calling this function takes a reference to @simple for as long as
 864  * is needed to run the job and report its completion.
 865  */
 866 void
 867 g_simple_async_result_run_in_thread (GSimpleAsyncResult     *simple,
 868                                      GSimpleAsyncThreadFunc  func,
 869                                      int                     io_priority,
 870                                      GCancellable           *cancellable)
 871 {
 872   RunInThreadData *data;
 873
 874   g_return_if_fail (G_IS_SIMPLE_ASYNC_RESULT (simple));
 875   g_return_if_fail (func != NULL);
 876
 877   data = g_new (RunInThreadData, 1);
 878   data->func = func;
 879   data->simple = g_object_ref (simple);
 880   data->cancellable = cancellable;
 881   if (cancellable)
 882     g_object_ref (cancellable);
 883   g_io_scheduler_push_job (run_in_thread, data, NULL, io_priority, cancellable);
 884 }
 885
 886 /**
 887  * g_simple_async_result_is_valid:
 888  * @result: the #GAsyncResult passed to the _finish function.
 889  * @source: the #GObject passed to the _finish function.
 890  * @source_tag: the asynchronous function.
 891  *
 892  * Ensures that the data passed to the _finish function of an async
 893  * operation is consistent.  Three checks are performed.
 894  *
 895  * First, @result is checked to ensure that it is really a
 896  * #GSimpleAsyncResult.  Second, @source is checked to ensure that it
 897  * matches the source object of @result.  Third, @source_tag is
 898  * checked to ensure that it is either %NULL (as it is when the result was
 899  * created by g_simple_async_report_error_in_idle() or
 900  * g_simple_async_report_gerror_in_idle()) or equal to the
 901  * @source_tag argument given to g_simple_async_result_new() (which, by
 902  * convention, is a pointer to the _async function corresponding to the
 903  * _finish function from which this function is called).
 904  *
 905  * Returns: #TRUE if all checks passed or #FALSE if any failed.
 906  *
 907  * Since: 2.20
 908  **/
 909 gboolean
 910 g_simple_async_result_is_valid (GAsyncResult *result,
 911                                 GObject      *source,
 912                                 gpointer      source_tag)
 913 {
 914   GSimpleAsyncResult *simple;
 915   GObject *cmp_source;
 916
 917   if (!G_IS_SIMPLE_ASYNC_RESULT (result))
 918     return FALSE;
 919   simple = (GSimpleAsyncResult *)result;
 920
 921   cmp_source = g_async_result_get_source_object (result);
 922   if (cmp_source != source)
 923     {
 924       if (cmp_source != NULL)
 925         g_object_unref (cmp_source);
 926       return FALSE;
 927     }
 928   if (cmp_source != NULL)
 929     g_object_unref (cmp_source);
 930
 931   return source_tag == NULL ||
 932          source_tag == g_simple_async_result_get_source_tag (simple);
 933 }
 934
 935 /**
 936  * g_simple_async_report_error_in_idle:
 937  * @object: (allow-none): a #GObject, or %NULL.
 938  * @callback: a #GAsyncReadyCallback.
 939  * @user_data: user data passed to @callback.
 940  * @domain: a #GQuark containing the error domain (usually #G_IO_ERROR).
 941  * @code: a specific error code.
 942  * @format: a formatted error reporting string.
 943  * @...: a list of variables to fill in @format.
 944  *
 945  * Reports an error in an asynchronous function in an idle function by
 946  * directly setting the contents of the #GAsyncResult with the given error
 947  * information.
 948  **/
 949 void
 950 g_simple_async_report_error_in_idle (GObject             *object,
 951                                      GAsyncReadyCallback  callback,
 952                                      gpointer             user_data,
 953                                      GQuark               domain,
 954                                      gint                 code,
 955                                      const char          *format,
 956                                      ...)
 957 {
 958   GSimpleAsyncResult *simple;
 959   va_list args;
 960
 961   g_return_if_fail (!object || G_IS_OBJECT (object));
 962   g_return_if_fail (domain != 0);
 963   g_return_if_fail (format != NULL);
 964
 965   simple = g_simple_async_result_new (object,
 966                                       callback,
 967                                       user_data, NULL);
 968
 969   va_start (args, format);
 970   g_simple_async_result_set_error_va (simple, domain, code, format, args);
 971   va_end (args);
 972   g_simple_async_result_complete_in_idle (simple);
 973   g_object_unref (simple);
 974 }
 975
 976 /**
 977  * g_simple_async_report_gerror_in_idle:
 978  * @object: (allow-none): a #GObject, or %NULL
 979  * @callback: a #GAsyncReadyCallback.
 980  * @user_data: user data passed to @callback.
 981  * @error: the #GError to report
 982  *
 983  * Reports an error in an idle function. Similar to
 984  * g_simple_async_report_error_in_idle(), but takes a #GError rather
 985  * than building a new one.
 986  **/
 987 void
 988 g_simple_async_report_gerror_in_idle (GObject *object,
 989                                       GAsyncReadyCallback callback,
 990                                       gpointer user_data,
 991                                       const GError *error)
 992 {
 993   GSimpleAsyncResult *simple;
 994
 995   g_return_if_fail (!object || G_IS_OBJECT (object));
 996   g_return_if_fail (error != NULL);
 997
 998   simple = g_simple_async_result_new_from_error (object,
 999                                                  callback,
1000                                                  user_data,
1001                                                  error);
1002   g_simple_async_result_complete_in_idle (simple);
1003   g_object_unref (simple);
1004 }
1005
1006 /**
1007  * g_simple_async_report_take_gerror_in_idle:
1008  * @object: (allow-none): a #GObject, or %NULL
1009  * @callback: a #GAsyncReadyCallback.
1010  * @user_data: user data passed to @callback.
1011  * @error: the #GError to report
1012  *
1013  * Reports an error in an idle function. Similar to
1014  * g_simple_async_report_gerror_in_idle(), but takes over the caller's
1015  * ownership of @error, so the caller does not have to free it any more.
1016  *
1017  * Since: 2.28
1018  **/
1019 void
1020 g_simple_async_report_take_gerror_in_idle (GObject *object,
1021                                            GAsyncReadyCallback callback,
1022                                            gpointer user_data,
1023                                            GError *error)
1024 {
1025   GSimpleAsyncResult *simple;
1026
1027   g_return_if_fail (!object || G_IS_OBJECT (object));
1028   g_return_if_fail (error != NULL);
1029
1030   simple = g_simple_async_result_new_take_error (object,
1031                                                  callback,
1032                                                  user_data,
1033                                                  error);
1034   g_simple_async_result_complete_in_idle (simple);
1035   g_object_unref (simple);
1036 }