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