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 typedef struct _GError GError;
  35
  36 struct _GError
  37 {
  38   GQuark       domain;
  39   gint         code;
  40   gchar       *message;
  41 };
  42
  43 GError*  g_error_new           (GQuark         domain,
  44                                 gint           code,
  45                                 const gchar   *format,
  46                                 ...) G_GNUC_PRINTF (3, 4);
  47
  48 GError*  g_error_new_literal   (GQuark         domain,
  49                                 gint           code,
  50                                 const gchar   *message);
  51 GError*  g_error_new_valist    (GQuark         domain,
  52                                 gint           code,
  53                                 const gchar   *format,
  54                                 va_list        args);
  55
  56 void     g_error_free          (GError        *error);
  57 GError*  g_error_copy          (const GError  *error);
  58
  59 gboolean g_error_matches       (const GError  *error,
  60                                 GQuark         domain,
  61                                 gint           code);
  62
  63 /* if (err) *err = g_error_new(domain, code, format, ...), also has
  64  * some sanity checks.
  65  */
  66 void     g_set_error           (GError       **err,
  67                                 GQuark         domain,
  68                                 gint           code,
  69                                 const gchar   *format,
  70                                 ...) G_GNUC_PRINTF (4, 5);
  71
  72 void     g_set_error_literal   (GError       **err,
  73                                 GQuark         domain,
  74                                 gint           code,
  75                                 const gchar   *message);
  76
  77 /* if (dest) *dest = src; also has some sanity checks.
  78  */
  79 void     g_propagate_error     (GError       **dest,
  80                                 GError        *src);
  81
  82 /* if (err && *err) { g_error_free(*err); *err = NULL; } */
  83 void     g_clear_error         (GError       **err);
  84
  85 /* if (err) prefix the formatted string to the ->message */
  86 void     g_prefix_error               (GError       **err,
  87                                        const gchar   *format,
  88                                        ...) G_GNUC_PRINTF (2, 3);
  89
  90 /* g_propagate_error then g_error_prefix on dest */
  91 void     g_propagate_prefixed_error   (GError       **dest,
  92                                        GError        *src,
  93                                        const gchar   *format,
  94                                        ...) G_GNUC_PRINTF (3, 4);
  95
  96 G_END_DECLS
  97
  98 #endif /* __G_ERROR_H__ */