gmessages: Clarify documentation about aborting on fatal log levels
[glib.git] / glib / gbacktrace.h
blob9e9cba151cb84cf438a12b336ab8899a87cfacbc
1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.1 of the License, or (at your option) any later version.
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.
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/>.
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/.
25 #ifndef __G_BACKTRACE_H__
26 #define __G_BACKTRACE_H__
28 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
29 #error "Only <glib.h> can be included directly."
30 #endif
32 #include <glib/gtypes.h>
33 #ifdef __sun__
34 #include <sys/select.h>
35 #endif
36 #include <signal.h>
38 G_BEGIN_DECLS
40 GLIB_AVAILABLE_IN_ALL
41 void g_on_error_query (const gchar *prg_name);
42 GLIB_AVAILABLE_IN_ALL
43 void g_on_error_stack_trace (const gchar *prg_name);
45 /**
46 * G_BREAKPOINT:
48 * Inserts a breakpoint instruction into the code.
50 * On architectures which support it, this is implemented as a soft interrupt
51 * and on other architectures it raises a `SIGTRAP` signal.
53 * `SIGTRAP` is used rather than abort() to allow breakpoints to be skipped past
54 * in a debugger if they are not the desired target of debugging.
56 #if (defined (__i386__) || defined (__x86_64__)) && defined (__GNUC__) && __GNUC__ >= 2
57 # define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
58 #elif (defined (_MSC_VER) || defined (__DMC__)) && defined (_M_IX86)
59 # define G_BREAKPOINT() G_STMT_START{ __asm int 3h }G_STMT_END
60 #elif defined (_MSC_VER)
61 # define G_BREAKPOINT() G_STMT_START{ __debugbreak(); }G_STMT_END
62 #elif defined (__alpha__) && !defined(__osf__) && defined (__GNUC__) && __GNUC__ >= 2
63 # define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
64 #elif defined (__APPLE__)
65 # define G_BREAKPOINT() G_STMT_START{ __builtin_trap(); }G_STMT_END
66 #else /* !__i386__ && !__alpha__ */
67 # define G_BREAKPOINT() G_STMT_START{ raise (SIGTRAP); }G_STMT_END
68 #endif /* __i386__ */
70 G_END_DECLS
72 #endif /* __G_BACKTRACE_H__ */