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