glib/gerror.h

   1 /* gerror.h - Error reporting system
   2  *
   3  *  Copyright 2000 Red Hat, Inc.
   4  *
   5  * The Gnome Library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * The Gnome 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 Public
  16  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
  17  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  *   Boston, MA 02111-1307, USA.
  19  */
  20
  21 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  22 #error "Only <glib.h> can be included directly."
  23 #endif
  24
  25 #ifndef __G_ERROR_H__
  26 #define __G_ERROR_H__
  27
  28 #include <stdarg.h>
  29
  30 #include <glib/gquark.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /**
  35  * GError:
  36  * @domain: error domain, e.g. #G_FILE_ERROR
  37  * @code: error code, e.g. %G_FILE_ERROR_NOENT
  38  * @message: human-readable informative error message
  39  *
  40  * The <structname>GError</structname> structure contains
  41  * information about an error that has occurred.
  42  */
  43 typedef struct _GError GError;
  44
  45 struct _GError
  46 {
  47   GQuark       domain;
  48   gint         code;
  49   gchar       *message;
  50 };
  51
  52 GError*  g_error_new           (GQuark         domain,
  53                                 gint           code,
  54                                 const gchar   *format,
  55                                 ...) G_GNUC_PRINTF (3, 4);
  56
  57 GError*  g_error_new_literal   (GQuark         domain,
  58                                 gint           code,
  59                                 const gchar   *message);
  60 GError*  g_error_new_valist    (GQuark         domain,
  61                                 gint           code,
  62                                 const gchar   *format,
  63                                 va_list        args);
  64
  65 void     g_error_free          (GError        *error);
  66 GError*  g_error_copy          (const GError  *error);
  67
  68 gboolean g_error_matches       (const GError  *error,
  69                                 GQuark         domain,
  70                                 gint           code);
  71
  72 /* if (err) *err = g_error_new(domain, code, format, ...), also has
  73  * some sanity checks.
  74  */
  75 void     g_set_error           (GError       **err,
  76                                 GQuark         domain,
  77                                 gint           code,
  78                                 const gchar   *format,
  79                                 ...) G_GNUC_PRINTF (4, 5);
  80
  81 void     g_set_error_literal   (GError       **err,
  82                                 GQuark         domain,
  83                                 gint           code,
  84                                 const gchar   *message);
  85
  86 /* if (dest) *dest = src; also has some sanity checks.
  87  */
  88 void     g_propagate_error     (GError       **dest,
  89                                 GError        *src);
  90
  91 /* if (err && *err) { g_error_free(*err); *err = NULL; } */
  92 void     g_clear_error         (GError       **err);
  93
  94 /* if (err) prefix the formatted string to the ->message */
  95 void     g_prefix_error               (GError       **err,
  96                                        const gchar   *format,
  97                                        ...) G_GNUC_PRINTF (2, 3);
  98
  99 /* g_propagate_error then g_error_prefix on dest */
 100 void     g_propagate_prefixed_error   (GError       **dest,
 101                                        GError        *src,
 102                                        const gchar   *format,
 103                                        ...) G_GNUC_PRINTF (3, 4);
 104
 105 G_END_DECLS
 106
 107 #endif /* __G_ERROR_H__ */