glib/gerror.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GLib Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 /**
  26  * SECTION:error_reporting
  27  * @Title: Error Reporting
  28  * @Short_description: a system for reporting errors
  29  *
  30  * GLib provides a standard method of reporting errors from a called
  31  * function to the calling code. (This is the same problem solved by
  32  * exceptions in other languages.) It's important to understand that
  33  * this method is both a data type (the #GError struct) and a set of
  34  * rules. If you use #GError incorrectly, then your code will not
  35  * properly interoperate with other code that uses #GError, and users
  36  * of your API will probably get confused.
  37  *
  38  * First and foremost: #GError should only be used to report recoverable
  39  * runtime errors, never to report programming errors. If the programmer
  40  * has screwed up, then you should use g_warning(), g_return_if_fail(),
  41  * g_assert(), g_error(), or some similar facility. (Incidentally,
  42  * remember that the g_error() function should only be used for
  43  * programming errors, it should not be used to print any error
  44  * reportable via #GError.)
  45  *
  46  * Examples of recoverable runtime errors are "file not found" or
  47  * "failed to parse input." Examples of programming errors are "NULL
  48  * passed to strcmp()" or "attempted to free the same pointer twice."
  49  * These two kinds of errors are fundamentally different: runtime errors
  50  * should be handled or reported to the user, programming errors should
  51  * be eliminated by fixing the bug in the program. This is why most
  52  * functions in GLib and GTK+ do not use the #GError facility.
  53  *
  54  * Functions that can fail take a return location for a #GError as their
  55  * last argument. For example:
  56  * |[
  57  * gboolean g_file_get_contents (const gchar  *filename,
  58  *                               gchar       **contents,
  59  *                               gsize        *length,
  60  *                               GError      **error);
  61  * ]|
  62  * If you pass a non-%NULL value for the <literal>error</literal>
  63  * argument, it should point to a location where an error can be placed.
  64  * For example:
  65  * |[
  66  * gchar *contents;
  67  * GError *err = NULL;
  68  * g_file_get_contents ("foo.txt", &amp;contents, NULL, &amp;err);
  69  * g_assert ((contents == NULL &amp;&amp; err != NULL) || (contents != NULL &amp;&amp; err == NULL));
  70  * if (err != NULL)
  71  *   {
  72  *     /&ast; Report error to user, and free error &ast;/
  73  *     g_assert (contents == NULL);
  74  *     fprintf (stderr, "Unable to read file: &percnt;s\n", err->message);
  75  *     g_error_free (err);
  76  *   }
  77  * else
  78  *   {
  79  *     /&ast; Use file contents &ast;/
  80  *     g_assert (contents != NULL);
  81  *   }
  82  * ]|
  83  * Note that <literal>err != NULL</literal> in this example is a
  84  * reliable indicator of whether g_file_get_contents() failed.
  85  * Additionally, g_file_get_contents() returns a boolean which
  86  * indicates whether it was successful.
  87  *
  88  * Because g_file_get_contents() returns %FALSE on failure, if you
  89  * are only interested in whether it failed and don't need to display
  90  * an error message, you can pass %NULL for the @error argument:
  91  * |[
  92  * if (g_file_get_contents ("foo.txt", &amp;contents, NULL, NULL)) /&ast; ignore errors &ast;/
  93  *   /&ast; no error occurred &ast;/ ;
  94  * else
  95  *   /&ast; error &ast;/ ;
  96  * ]|
  97  *
  98  * The #GError object contains three fields: @domain indicates the module
  99  * the error-reporting function is located in, @code indicates the specific
 100  * error that occurred, and @message is a user-readable error message with
 101  * as many details as possible. Several functions are provided to deal
 102  * with an error received from a called function: g_error_matches()
 103  * returns %TRUE if the error matches a given domain and code,
 104  * g_propagate_error() copies an error into an error location (so the
 105  * calling function will receive it), and g_clear_error() clears an
 106  * error location by freeing the error and resetting the location to
 107  * %NULL. To display an error to the user, simply display the @message,
 108  * perhaps along with additional context known only to the calling
 109  * function (the file being opened, or whatever - though in the
 110  * g_file_get_contents() case, the @message already contains a filename).
 111  *
 112  * When implementing a function that can report errors, the basic
 113  * tool is g_set_error(). Typically, if a fatal error occurs you
 114  * want to g_set_error(), then return immediately. g_set_error()
 115  * does nothing if the error location passed to it is %NULL.
 116  * Here's an example:
 117  * |[
 118  * gint
 119  * foo_open_file (GError **error)
 120  * {
 121  *   gint fd;
 122  *
 123  *   fd = open ("file.txt", O_RDONLY);
 124  *
 125  *   if (fd &lt; 0)
 126  *     {
 127  *       g_set_error (error,
 128  *                    FOO_ERROR,                 /&ast; error domain &ast;/
 129  *                    FOO_ERROR_BLAH,            /&ast; error code &ast;/
 130  *                    "Failed to open file: &percnt;s", /&ast; error message format string &ast;/
 131  *                    g_strerror (errno));
 132  *       return -1;
 133  *     }
 134  *   else
 135  *     return fd;
 136  * }
 137  * ]|
 138  *
 139  * Things are somewhat more complicated if you yourself call another
 140  * function that can report a #GError. If the sub-function indicates
 141  * fatal errors in some way other than reporting a #GError, such as
 142  * by returning %TRUE on success, you can simply do the following:
 143  * |[
 144  * gboolean
 145  * my_function_that_can_fail (GError **err)
 146  * {
 147  *   g_return_val_if_fail (err == NULL || *err == NULL, FALSE);
 148  *
 149  *   if (!sub_function_that_can_fail (err))
 150  *     {
 151  *       /&ast; assert that error was set by the sub-function &ast;/
 152  *       g_assert (err == NULL || *err != NULL);
 153  *       return FALSE;
 154  *     }
 155  *
 156  *   /&ast; otherwise continue, no error occurred &ast;/
 157  *   g_assert (err == NULL || *err == NULL);
 158  * }
 159  * ]|
 160  *
 161  * If the sub-function does not indicate errors other than by
 162  * reporting a #GError, you need to create a temporary #GError
 163  * since the passed-in one may be %NULL. g_propagate_error() is
 164  * intended for use in this case.
 165  * |[
 166  * gboolean
 167  * my_function_that_can_fail (GError **err)
 168  * {
 169  *   GError *tmp_error;
 170  *
 171  *   g_return_val_if_fail (err == NULL || *err == NULL, FALSE);
 172  *
 173  *   tmp_error = NULL;
 174  *   sub_function_that_can_fail (&amp;tmp_error);
 175  *
 176  *   if (tmp_error != NULL)
 177  *     {
 178  *       /&ast; store tmp_error in err, if err != NULL,
 179  *        &ast; otherwise call g_error_free() on tmp_error
 180  *        &ast;/
 181  *       g_propagate_error (err, tmp_error);
 182  *       return FALSE;
 183  *     }
 184  *
 185  *   /&ast; otherwise continue, no error occurred &ast;/
 186  * }
 187  * ]|
 188  *
 189  * Error pileups are always a bug. For example, this code is incorrect:
 190  * |[
 191  * gboolean
 192  * my_function_that_can_fail (GError **err)
 193  * {
 194  *   GError *tmp_error;
 195  *
 196  *   g_return_val_if_fail (err == NULL || *err == NULL, FALSE);
 197  *
 198  *   tmp_error = NULL;
 199  *   sub_function_that_can_fail (&amp;tmp_error);
 200  *   other_function_that_can_fail (&amp;tmp_error);
 201  *
 202  *   if (tmp_error != NULL)
 203  *     {
 204  *       g_propagate_error (err, tmp_error);
 205  *       return FALSE;
 206  *     }
 207  * }
 208  * ]|
 209  * @tmp_error should be checked immediately after sub_function_that_can_fail(),
 210  * and either cleared or propagated upward. The rule is: after each error,
 211  * you must either handle the error, or return it to the calling function.
 212  *
 213  * Note that passing %NULL for the error location is the equivalent
 214  * of handling an error by always doing nothing about it. So the
 215  * following code is fine, assuming errors in sub_function_that_can_fail()
 216  * are not fatal to my_function_that_can_fail():
 217  * |[
 218  * gboolean
 219  * my_function_that_can_fail (GError **err)
 220  * {
 221  *   GError *tmp_error;
 222  *
 223  *   g_return_val_if_fail (err == NULL || *err == NULL, FALSE);
 224  *
 225  *   sub_function_that_can_fail (NULL); /&ast; ignore errors &ast;/
 226  *
 227  *   tmp_error = NULL;
 228  *   other_function_that_can_fail (&amp;tmp_error);
 229  *
 230  *   if (tmp_error != NULL)
 231  *     {
 232  *       g_propagate_error (err, tmp_error);
 233  *       return FALSE;
 234  *     }
 235  * }
 236  * ]|
 237  *
 238  * Note that passing %NULL for the error location ignores errors; it's
 239  * equivalent to
 240  * <literal>try { sub_function_that_can_fail (); } catch (...) {}</literal>
 241  * in C++. It does not mean to leave errors unhandled; it means to
 242  * handle them by doing nothing.
 243  *
 244  * Error domains and codes are conventionally named as follows:
 245  *
 246  * - The error domain is called &lt;NAMESPACE&gt;_&lt;MODULE&gt;_ERROR,
 247  *   for example %G_SPAWN_ERROR or %G_THREAD_ERROR:
 248  *   |[
 249  *   #define G_SPAWN_ERROR g_spawn_error_quark ()
 250  *
 251  *   GQuark
 252  *   g_spawn_error_quark (void)
 253  *   {
 254  *       return g_quark_from_static_string ("g-spawn-error-quark");
 255  *   }
 256  *   ]|
 257  *
 258  * - The quark function for the error domain is called
 259  *   &lt;namespace&gt;_&lt;module&gt;_error_quark,
 260  *   for example g_spawn_error_quark() or g_thread_error_quark().
 261  *
 262  * - The error codes are in an enumeration called
 263  *   &lt;Namespace&gt;&lt;Module&gt;Error;
 264  *   for example,#GThreadError or #GSpawnError.
 265  *
 266  * - Members of the error code enumeration are called
 267  *   &lt;NAMESPACE&gt;_&lt;MODULE&gt;_ERROR_&lt;CODE&gt;,
 268  *   for example %G_SPAWN_ERROR_FORK or %G_THREAD_ERROR_AGAIN.
 269  *
 270  * - If there's a "generic" or "unknown" error code for unrecoverable
 271  *   errors it doesn't make sense to distinguish with specific codes,
 272  *   it should be called &lt;NAMESPACE&gt;_&lt;MODULE&gt;_ERROR_FAILED,
 273  *   for example %G_SPAWN_ERROR_FAILED.
 274  *
 275  * Summary of rules for use of #GError:
 276  *
 277  * - Do not report programming errors via #GError.
 278  *
 279  * - The last argument of a function that returns an error should
 280  *   be a location where a #GError can be placed (i.e. "#GError** error").
 281  *   If #GError is used with varargs, the #GError** should be the last
 282  *   argument before the "...".
 283  *
 284  * - The caller may pass %NULL for the #GError** if they are not interested
 285  *   in details of the exact error that occurred.
 286  *
 287  * - If %NULL is passed for the #GError** argument, then errors should
 288  *   not be returned to the caller, but your function should still
 289  *   abort and return if an error occurs. That is, control flow should
 290  *   not be affected by whether the caller wants to get a #GError.
 291  *
 292  * - If a #GError is reported, then your function by definition had a
 293  *   fatal failure and did not complete whatever it was supposed to do.
 294  *   If the failure was not fatal, then you handled it and you should not
 295  *   report it. If it was fatal, then you must report it and discontinue
 296  *   whatever you were doing immediately.
 297  *
 298  * - If a #GError is reported, out parameters are not guaranteed to
 299  *   be set to any defined value.
 300  *
 301  * - A #GError* must be initialized to %NULL before passing its address
 302  *   to a function that can report errors.
 303  *
 304  * - "Piling up" errors is always a bug. That is, if you assign a
 305  *   new #GError to a #GError* that is non-%NULL, thus overwriting
 306  *   the previous error, it indicates that you should have aborted
 307  *   the operation instead of continuing. If you were able to continue,
 308  *   you should have cleared the previous error with g_clear_error().
 309  *   g_set_error() will complain if you pile up errors.
 310  *
 311  * - By convention, if you return a boolean value indicating success
 312  *   then %TRUE means success and %FALSE means failure. If %FALSE is
 313  *   returned, the error must be set to a non-%NULL value.
 314  *
 315  * - A %NULL return value is also frequently used to mean that an error
 316  *   occurred. You should make clear in your documentation whether %NULL
 317  *   is a valid return value in non-error cases; if %NULL is a valid value,
 318  *   then users must check whether an error was returned to see if the
 319  *   function succeeded.
 320  *
 321  * - When implementing a function that can report errors, you may want
 322  *   to add a check at the top of your function that the error return
 323  *   location is either %NULL or contains a %NULL error (e.g.
 324  *   <literal>g_return_if_fail (error == NULL || *error == NULL);</literal>).
 325  */
 326
 327 #include "config.h"
 328
 329 #include "gerror.h"
 330
 331 #include "gslice.h"
 332 #include "gstrfuncs.h"
 333 #include "gtestutils.h"
 334
 335 /**
 336  * g_error_new_valist:
 337  * @domain: error domain
 338  * @code: error code
 339  * @format: printf()-style format for error message
 340  * @args: #va_list of parameters for the message format
 341  *
 342  * Creates a new #GError with the given @domain and @code,
 343  * and a message formatted with @format.
 344  *
 345  * Returns: a new #GError
 346  *
 347  * Since: 2.22
 348  */
 349 GError*
 350 g_error_new_valist (GQuark       domain,
 351                     gint         code,
 352                     const gchar *format,
 353                     va_list      args)
 354 {
 355   GError *error;
 356
 357   /* Historically, GError allowed this (although it was never meant to work),
 358    * and it has significant use in the wild, which g_return_val_if_fail
 359    * would break. It should maybe g_return_val_if_fail in GLib 4.
 360    * (GNOME#660371, GNOME#560482)
 361    */
 362   g_warn_if_fail (domain != 0);
 363   g_warn_if_fail (format != NULL);
 364
 365   error = g_slice_new (GError);
 366
 367   error->domain = domain;
 368   error->code = code;
 369   error->message = g_strdup_vprintf (format, args);
 370
 371   return error;
 372 }
 373
 374 /**
 375  * g_error_new:
 376  * @domain: error domain
 377  * @code: error code
 378  * @format: printf()-style format for error message
 379  * @...: parameters for message format
 380  *
 381  * Creates a new #GError with the given @domain and @code,
 382  * and a message formatted with @format.
 383  *
 384  * Return value: a new #GError
 385  */
 386 GError*
 387 g_error_new (GQuark       domain,
 388              gint         code,
 389              const gchar *format,
 390              ...)
 391 {
 392   GError* error;
 393   va_list args;
 394
 395   g_return_val_if_fail (format != NULL, NULL);
 396   g_return_val_if_fail (domain != 0, NULL);
 397
 398   va_start (args, format);
 399   error = g_error_new_valist (domain, code, format, args);
 400   va_end (args);
 401
 402   return error;
 403 }
 404
 405 /**
 406  * g_error_new_literal:
 407  * @domain: error domain
 408  * @code: error code
 409  * @message: error message
 410  *
 411  * Creates a new #GError; unlike g_error_new(), @message is
 412  * not a printf()-style format string. Use this function if
 413  * @message contains text you don't have control over,
 414  * that could include printf() escape sequences.
 415  *
 416  * Return value: a new #GError
 417  **/
 418 GError*
 419 g_error_new_literal (GQuark         domain,
 420                      gint           code,
 421                      const gchar   *message)
 422 {
 423   GError* err;
 424
 425   g_return_val_if_fail (message != NULL, NULL);
 426   g_return_val_if_fail (domain != 0, NULL);
 427
 428   err = g_slice_new (GError);
 429
 430   err->domain = domain;
 431   err->code = code;
 432   err->message = g_strdup (message);
 433
 434   return err;
 435 }
 436
 437 /**
 438  * g_error_free:
 439  * @error: a #GError
 440  *
 441  * Frees a #GError and associated resources.
 442  */
 443 void
 444 g_error_free (GError *error)
 445 {
 446   g_return_if_fail (error != NULL);
 447
 448   g_free (error->message);
 449
 450   g_slice_free (GError, error);
 451 }
 452
 453 /**
 454  * g_error_copy:
 455  * @error: a #GError
 456  *
 457  * Makes a copy of @error.
 458  *
 459  * Return value: a new #GError
 460  */
 461 GError*
 462 g_error_copy (const GError *error)
 463 {
 464   GError *copy;
 465
 466   g_return_val_if_fail (error != NULL, NULL);
 467   /* See g_error_new_valist for why these don't return */
 468   g_warn_if_fail (error->domain != 0);
 469   g_warn_if_fail (error->message != NULL);
 470
 471   copy = g_slice_new (GError);
 472
 473   *copy = *error;
 474
 475   copy->message = g_strdup (error->message);
 476
 477   return copy;
 478 }
 479
 480 /**
 481  * g_error_matches:
 482  * @error: (allow-none): a #GError or %NULL
 483  * @domain: an error domain
 484  * @code: an error code
 485  *
 486  * Returns %TRUE if @error matches @domain and @code, %FALSE
 487  * otherwise. In particular, when @error is %NULL, %FALSE will
 488  * be returned.
 489  *
 490  * Return value: whether @error has @domain and @code
 491  */
 492 gboolean
 493 g_error_matches (const GError *error,
 494                  GQuark        domain,
 495                  gint          code)
 496 {
 497   return error &&
 498     error->domain == domain &&
 499     error->code == code;
 500 }
 501
 502 #define ERROR_OVERWRITTEN_WARNING "GError set over the top of a previous GError or uninitialized memory.\n" \
 503                "This indicates a bug in someone's code. You must ensure an error is NULL before it's set.\n" \
 504                "The overwriting error message was: %s"
 505
 506 /**
 507  * g_set_error:
 508  * @err: (allow-none): a return location for a #GError, or %NULL
 509  * @domain: error domain
 510  * @code: error code
 511  * @format: printf()-style format
 512  * @...: args for @format
 513  *
 514  * Does nothing if @err is %NULL; if @err is non-%NULL, then *@err
 515  * must be %NULL. A new #GError is created and assigned to *@err.
 516  */
 517 void
 518 g_set_error (GError      **err,
 519              GQuark        domain,
 520              gint          code,
 521              const gchar  *format,
 522              ...)
 523 {
 524   GError *new;
 525
 526   va_list args;
 527
 528   if (err == NULL)
 529     return;
 530
 531   va_start (args, format);
 532   new = g_error_new_valist (domain, code, format, args);
 533   va_end (args);
 534
 535   if (*err == NULL)
 536     *err = new;
 537   else
 538     {
 539       g_warning (ERROR_OVERWRITTEN_WARNING, new->message);
 540       g_error_free (new);
 541     }
 542 }
 543
 544 /**
 545  * g_set_error_literal:
 546  * @err: (allow-none): a return location for a #GError, or %NULL
 547  * @domain: error domain
 548  * @code: error code
 549  * @message: error message
 550  *
 551  * Does nothing if @err is %NULL; if @err is non-%NULL, then *@err
 552  * must be %NULL. A new #GError is created and assigned to *@err.
 553  * Unlike g_set_error(), @message is not a printf()-style format string.
 554  * Use this function if @message contains text you don't have control over,
 555  * that could include printf() escape sequences.
 556  *
 557  * Since: 2.18
 558  */
 559 void
 560 g_set_error_literal (GError      **err,
 561                      GQuark        domain,
 562                      gint          code,
 563                      const gchar  *message)
 564 {
 565   if (err == NULL)
 566     return;
 567
 568   if (*err == NULL)
 569     *err = g_error_new_literal (domain, code, message);
 570   else
 571     g_warning (ERROR_OVERWRITTEN_WARNING, message);
 572 }
 573
 574 /**
 575  * g_propagate_error:
 576  * @dest: error return location
 577  * @src: error to move into the return location
 578  *
 579  * If @dest is %NULL, free @src; otherwise, moves @src into *@dest.
 580  * The error variable @dest points to must be %NULL.
 581  */
 582 void
 583 g_propagate_error (GError **dest,
 584                    GError  *src)
 585 {
 586   g_return_if_fail (src != NULL);
 587
 588   if (dest == NULL)
 589     {
 590       if (src)
 591         g_error_free (src);
 592       return;
 593     }
 594   else
 595     {
 596       if (*dest != NULL)
 597         {
 598           g_warning (ERROR_OVERWRITTEN_WARNING, src->message);
 599           g_error_free (src);
 600         }
 601       else
 602         *dest = src;
 603     }
 604 }
 605
 606 /**
 607  * g_clear_error:
 608  * @err: a #GError return location
 609  *
 610  * If @err is %NULL, does nothing. If @err is non-%NULL,
 611  * calls g_error_free() on *@err and sets *@err to %NULL.
 612  */
 613 void
 614 g_clear_error (GError **err)
 615 {
 616   if (err && *err)
 617     {
 618       g_error_free (*err);
 619       *err = NULL;
 620     }
 621 }
 622
 623 G_GNUC_PRINTF(2, 0)
 624 static void
 625 g_error_add_prefix (gchar       **string,
 626                     const gchar  *format,
 627                     va_list       ap)
 628 {
 629   gchar *oldstring;
 630   gchar *prefix;
 631
 632   prefix = g_strdup_vprintf (format, ap);
 633   oldstring = *string;
 634   *string = g_strconcat (prefix, oldstring, NULL);
 635   g_free (oldstring);
 636   g_free (prefix);
 637 }
 638
 639 /**
 640  * g_prefix_error:
 641  * @err: (allow-none): a return location for a #GError, or %NULL
 642  * @format: printf()-style format string
 643  * @...: arguments to @format
 644  *
 645  * Formats a string according to @format and prefix it to an existing
 646  * error message. If @err is %NULL (ie: no error variable) then do
 647  * nothing.
 648  *
 649  * If *@err is %NULL (ie: an error variable is present but there is no
 650  * error condition) then also do nothing. Whether or not it makes sense
 651  * to take advantage of this feature is up to you.
 652  *
 653  * Since: 2.16
 654  */
 655 void
 656 g_prefix_error (GError      **err,
 657                 const gchar  *format,
 658                 ...)
 659 {
 660   if (err && *err)
 661     {
 662       va_list ap;
 663
 664       va_start (ap, format);
 665       g_error_add_prefix (&(*err)->message, format, ap);
 666       va_end (ap);
 667     }
 668 }
 669
 670 /**
 671  * g_propagate_prefixed_error:
 672  * @dest: error return location
 673  * @src: error to move into the return location
 674  * @format: printf()-style format string
 675  * @...: arguments to @format
 676  *
 677  * If @dest is %NULL, free @src; otherwise, moves @src into *@dest.
 678  * *@dest must be %NULL. After the move, add a prefix as with
 679  * g_prefix_error().
 680  *
 681  * Since: 2.16
 682  **/
 683 void
 684 g_propagate_prefixed_error (GError      **dest,
 685                             GError       *src,
 686                             const gchar  *format,
 687                             ...)
 688 {
 689   g_propagate_error (dest, src);
 690
 691   if (dest && *dest)
 692     {
 693       va_list ap;
 694
 695       va_start (ap, format);
 696       g_error_add_prefix (&(*dest)->message, format, ap);
 697       va_end (ap);
 698     }
 699 }