gerror.h 3.48 KB
Newer Older
Havoc Pennington's avatar
Havoc Pennington committed
1 2 3 4 5
/* gerror.h - Error reporting system
 *
 *  Copyright 2000 Red Hat, Inc.
 *
 * 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
Havoc Pennington's avatar
Havoc Pennington committed
7 8 9 10 11 12
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * The Gnome Library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13
 * Lesser General Public License for more details.
Havoc Pennington's avatar
Havoc Pennington committed
14
 *
15
 * You should have received a copy of the GNU Lesser General Public
Havoc Pennington's avatar
Havoc Pennington committed
16 17 18 19 20
 * License along with the Gnome Library; see the file COPYING.LIB.  If not,
 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 *   Boston, MA 02111-1307, USA.
 */

21
#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
22 23 24
#error "Only <glib.h> can be included directly."
#endif

25 26
#ifndef __G_ERROR_H__
#define __G_ERROR_H__
Havoc Pennington's avatar
Havoc Pennington committed
27

28 29
#include <stdarg.h>

30
#include <glib/gquark.h>
31 32

G_BEGIN_DECLS
Havoc Pennington's avatar
Havoc Pennington committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

typedef struct _GError GError;

struct _GError
{
  GQuark       domain;
  gint         code;
  gchar       *message;
};

GError*  g_error_new           (GQuark         domain,
                                gint           code,
                                const gchar   *format,
                                ...) G_GNUC_PRINTF (3, 4);

GError*  g_error_new_literal   (GQuark         domain,
                                gint           code,
                                const gchar   *message);
51 52 53 54
GError*  g_error_new_valist    (GQuark         domain,
                                gint           code,
                                const gchar   *format,
                                va_list        args);
Havoc Pennington's avatar
Havoc Pennington committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

void     g_error_free          (GError        *error);
GError*  g_error_copy          (const GError  *error);

gboolean g_error_matches       (const GError  *error,
                                GQuark         domain,
                                gint           code);

/* if (err) *err = g_error_new(domain, code, format, ...), also has
 * some sanity checks.
 */
void     g_set_error           (GError       **err,
                                GQuark         domain,
                                gint           code,
                                const gchar   *format,
                                ...) G_GNUC_PRINTF (4, 5);

72 73 74 75 76
void     g_set_error_literal   (GError       **err,
                                GQuark         domain,
                                gint           code,
                                const gchar   *message);

77 78 79 80 81
/* if (dest) *dest = src; also has some sanity checks.
 */
void     g_propagate_error     (GError       **dest,
				GError        *src);

Havoc Pennington's avatar
Havoc Pennington committed
82 83 84
/* if (err && *err) { g_error_free(*err); *err = NULL; } */
void     g_clear_error         (GError       **err);

85 86 87 88 89 90 91 92 93 94
/* if (err) prefix the formatted string to the ->message */
void     g_prefix_error               (GError       **err,
                                       const gchar   *format,
                                       ...) G_GNUC_PRINTF (2, 3);

/* g_propagate_error then g_error_prefix on dest */
void     g_propagate_prefixed_error   (GError       **dest,
                                       GError        *src,
                                       const gchar   *format,
                                       ...) G_GNUC_PRINTF (3, 4);
Havoc Pennington's avatar
Havoc Pennington committed
95

96
G_END_DECLS
Havoc Pennington's avatar
Havoc Pennington committed
97

98
#endif /* __G_ERROR_H__ */