GRand: move docs from tmpl to inline comments
[platform/upstream/glib.git] / glib / gbacktrace.h
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 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
29 #endif
30
31 #ifndef __G_BACKTRACE_H__
32 #define __G_BACKTRACE_H__
33
34 #include <glib/gtypes.h>
35 #include <signal.h>
36
37 G_BEGIN_DECLS
38
39 /* Fatal error handlers.
40  * g_on_error_query() will prompt the user to either
41  * [E]xit, [H]alt, [P]roceed or show [S]tack trace.
42  * g_on_error_stack_trace() invokes gdb, which attaches to the current
43  * process and shows a stack trace.
44  * These function may cause different actions on non-unix platforms.
45  * The prg_name arg is required by gdb to find the executable, if it is
46  * passed as NULL, g_on_error_query() will try g_get_prgname().
47  */
48 void g_on_error_query (const gchar *prg_name);
49 void g_on_error_stack_trace (const gchar *prg_name);
50
51 /* Hacker macro to place breakpoints for selected machines.
52  * Actual use is strongly discouraged of course ;)
53  */
54 #if (defined (__i386__) || defined (__x86_64__)) && defined (__GNUC__) && __GNUC__ >= 2
55 #  define G_BREAKPOINT()        G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
56 #elif (defined (_MSC_VER) || defined (__DMC__)) && defined (_M_IX86)
57 #  define G_BREAKPOINT()        G_STMT_START{ __asm int 3h }G_STMT_END
58 #elif defined (_MSC_VER)
59 #  define G_BREAKPOINT()        G_STMT_START{ __debugbreak(); }G_STMT_END
60 #elif defined (__alpha__) && !defined(__osf__) && defined (__GNUC__) && __GNUC__ >= 2
61 #  define G_BREAKPOINT()        G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
62 #else   /* !__i386__ && !__alpha__ */
63 #  define G_BREAKPOINT()        G_STMT_START{ raise (SIGTRAP); }G_STMT_END
64 #endif  /* __i386__ */
65
66 G_END_DECLS
67
68 #endif /* __G_BACKTRACE_H__ */