1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #ifndef __MODEST_DEBUG_H__
31 #define __MODEST_DEBUG_H__
34 #include <glib-object.h>
38 #define MODEST_DEBUG "MODEST_DEBUG"
41 MODEST_DEBUG_ABORT_ON_WARNING = 1 << 0,
42 MODEST_DEBUG_LOG_ACTIONS = 1 << 1, /* not in use atm */
43 MODEST_DEBUG_DEBUG_OBJECTS = 1 << 2, /* for g_type_init */
44 MODEST_DEBUG_DEBUG_SIGNALS = 1 << 3 /* for g_type_init */
49 * modest_debug_get_flags
51 * get the debug flags for modest; they are read from the MODEST_DEBUG
52 * environment variable; the flags specified as strings, separated by ':'.
53 * Possible values are:
54 * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
55 * useful when running in debugger
56 * - "log-actions": log user actions (not in use atm)
57 * - "track-object": track the use of (g)objects in the program. this option influences
58 * g_type_init_with_debug_flags
59 * - "track-signals": track the use of (g)signals in the program. this option influences
60 * g_type_init_with_debug_flags
61 * if you would want to track signals and log actions, you could do something like:
62 * MODEST_DEBUG="log-actions:track-signals" ./modest
63 * NOTE that the flags will stay the same during the run of the program, even
64 * if the environment variable changes.
66 * Returns: the bitwise OR of the debug flags
68 ModestDebugFlags modest_debug_get_flags (void) G_GNUC_CONST;
73 * do a g_type_init_with_debug_flags based on the modest debug flags
75 void modest_debug_g_type_init (void);
80 * do set the logging based on the modest debug flags (ie. whether
81 * we should abort when a warning occurs.
83 void modest_debug_logging_init (void);
87 #endif /*__MODEST_DEBUG_H__*/