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 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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
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/.
27 #ifndef __G_MESSAGES_H__
28 #define __G_MESSAGES_H__
31 #include <glib/gtypes.h>
32 #include <glib/gmacros.h>
34 /* Suppress warnings when GCC is in -pedantic mode and not -std=c99
36 #if (__GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96))
37 #pragma GCC system_header
42 /* calculate a string size, guaranteed to fit format + args.
44 gsize g_printf_string_upper_bound (const gchar* format,
47 /* Log level shift offset for user defined
48 * log levels (0-7 are used by GLib).
50 #define G_LOG_LEVEL_USER_SHIFT (8)
52 /* Glib log levels and flags.
57 G_LOG_FLAG_RECURSION = 1 << 0,
58 G_LOG_FLAG_FATAL = 1 << 1,
61 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
62 G_LOG_LEVEL_CRITICAL = 1 << 3,
63 G_LOG_LEVEL_WARNING = 1 << 4,
64 G_LOG_LEVEL_MESSAGE = 1 << 5,
65 G_LOG_LEVEL_INFO = 1 << 6,
66 G_LOG_LEVEL_DEBUG = 1 << 7,
68 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
71 /* GLib log levels that are considered fatal by default */
72 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
74 typedef void (*GLogFunc) (const gchar *log_domain,
75 GLogLevelFlags log_level,
81 guint g_log_set_handler (const gchar *log_domain,
82 GLogLevelFlags log_levels,
85 void g_log_remove_handler (const gchar *log_domain,
87 void g_log_default_handler (const gchar *log_domain,
88 GLogLevelFlags log_level,
90 gpointer unused_data);
91 GLogFunc g_log_set_default_handler (GLogFunc log_func,
93 void g_log (const gchar *log_domain,
94 GLogLevelFlags log_level,
96 ...) G_GNUC_PRINTF (3, 4);
97 void g_logv (const gchar *log_domain,
98 GLogLevelFlags log_level,
101 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
102 GLogLevelFlags fatal_mask);
103 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
106 void _g_log_fallback_handler (const gchar *log_domain,
107 GLogLevelFlags log_level,
108 const gchar *message,
109 gpointer unused_data) G_GNUC_INTERNAL;
111 /* Internal function, used to implement the following macros */
112 void g_return_if_fail_warning (const char *log_domain,
113 const char *pretty_function,
114 const char *expression);
118 #define G_LOG_DOMAIN ((gchar*) 0)
119 #endif /* G_LOG_DOMAIN */
120 #ifdef G_HAVE_ISO_VARARGS
121 #define g_error(...) g_log (G_LOG_DOMAIN, \
124 #define g_message(...) g_log (G_LOG_DOMAIN, \
125 G_LOG_LEVEL_MESSAGE, \
127 #define g_critical(...) g_log (G_LOG_DOMAIN, \
128 G_LOG_LEVEL_CRITICAL, \
130 #define g_warning(...) g_log (G_LOG_DOMAIN, \
131 G_LOG_LEVEL_WARNING, \
133 #define g_debug(...) g_log (G_LOG_DOMAIN, \
136 #elif defined(G_HAVE_GNUC_VARARGS)
137 #define g_error(format...) g_log (G_LOG_DOMAIN, \
140 #define g_message(format...) g_log (G_LOG_DOMAIN, \
141 G_LOG_LEVEL_MESSAGE, \
143 #define g_critical(format...) g_log (G_LOG_DOMAIN, \
144 G_LOG_LEVEL_CRITICAL, \
146 #define g_warning(format...) g_log (G_LOG_DOMAIN, \
147 G_LOG_LEVEL_WARNING, \
149 #define g_debug(format...) g_log (G_LOG_DOMAIN, \
150 G_LOG_LEVEL_WARNING, \
152 #else /* no varargs macros */
154 g_error (const gchar *format,
158 va_start (args, format);
159 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
163 g_message (const gchar *format,
167 va_start (args, format);
168 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
172 g_critical (const gchar *format,
176 va_start (args, format);
177 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
181 g_warning (const gchar *format,
185 va_start (args, format);
186 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
190 g_debug (const gchar *format,
194 va_start (args, format);
195 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format, args);
198 #endif /* !__GNUC__ */
200 typedef void (*GPrintFunc) (const gchar *string);
201 void g_print (const gchar *format,
202 ...) G_GNUC_PRINTF (1, 2);
203 GPrintFunc g_set_print_handler (GPrintFunc func);
204 void g_printerr (const gchar *format,
205 ...) G_GNUC_PRINTF (1, 2);
206 GPrintFunc g_set_printerr_handler (GPrintFunc func);
209 /* Provide macros for error handling. The "assert" macros will
210 * exit on failure. The "return" macros will exit the current
211 * function. Two different definitions are given for the macros
212 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
213 * __PRETTY_FUNCTION__ capability.
216 #ifdef G_DISABLE_ASSERT
218 #define g_assert(expr) G_STMT_START{ (void)0; }G_STMT_END
219 #define g_assert_not_reached() G_STMT_START{ (void)0; }G_STMT_END
221 #else /* !G_DISABLE_ASSERT */
225 #define g_assert(expr) G_STMT_START{ \
226 if G_LIKELY(expr) { } else \
227 g_log (G_LOG_DOMAIN, \
229 "file %s: line %d (%s): assertion failed: (%s)", \
232 __PRETTY_FUNCTION__, \
235 #define g_assert_not_reached() G_STMT_START{ \
236 g_log (G_LOG_DOMAIN, \
238 "file %s: line %d (%s): should not be reached", \
241 __PRETTY_FUNCTION__); }G_STMT_END
243 #else /* !__GNUC__ */
245 #define g_assert(expr) G_STMT_START{ \
247 g_log (G_LOG_DOMAIN, \
249 "file %s: line %d: assertion failed: (%s)", \
254 #define g_assert_not_reached() G_STMT_START{ \
255 g_log (G_LOG_DOMAIN, \
257 "file %s: line %d: should not be reached", \
259 __LINE__); }G_STMT_END
261 #endif /* __GNUC__ */
263 #endif /* !G_DISABLE_ASSERT */
266 #ifdef G_DISABLE_CHECKS
268 #define g_return_if_fail(expr) G_STMT_START{ (void)0; }G_STMT_END
269 #define g_return_val_if_fail(expr,val) G_STMT_START{ (void)0; }G_STMT_END
270 #define g_return_if_reached() G_STMT_START{ return; }G_STMT_END
271 #define g_return_val_if_reached(val) G_STMT_START{ return (val); }G_STMT_END
273 #else /* !G_DISABLE_CHECKS */
277 #define g_return_if_fail(expr) G_STMT_START{ \
278 if G_LIKELY(expr) { } else \
280 g_return_if_fail_warning (G_LOG_DOMAIN, \
281 __PRETTY_FUNCTION__, \
286 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
287 if G_LIKELY(expr) { } else \
289 g_return_if_fail_warning (G_LOG_DOMAIN, \
290 __PRETTY_FUNCTION__, \
295 #define g_return_if_reached() G_STMT_START{ \
296 g_log (G_LOG_DOMAIN, \
297 G_LOG_LEVEL_CRITICAL, \
298 "file %s: line %d (%s): should not be reached", \
301 __PRETTY_FUNCTION__); \
304 #define g_return_val_if_reached(val) G_STMT_START{ \
305 g_log (G_LOG_DOMAIN, \
306 G_LOG_LEVEL_CRITICAL, \
307 "file %s: line %d (%s): should not be reached", \
310 __PRETTY_FUNCTION__); \
311 return (val); }G_STMT_END
313 #else /* !__GNUC__ */
315 #define g_return_if_fail(expr) G_STMT_START{ \
318 g_log (G_LOG_DOMAIN, \
319 G_LOG_LEVEL_CRITICAL, \
320 "file %s: line %d: assertion `%s' failed", \
327 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
330 g_log (G_LOG_DOMAIN, \
331 G_LOG_LEVEL_CRITICAL, \
332 "file %s: line %d: assertion `%s' failed", \
339 #define g_return_if_reached() G_STMT_START{ \
340 g_log (G_LOG_DOMAIN, \
341 G_LOG_LEVEL_CRITICAL, \
342 "file %s: line %d: should not be reached", \
347 #define g_return_val_if_reached(val) G_STMT_START{ \
348 g_log (G_LOG_DOMAIN, \
349 G_LOG_LEVEL_CRITICAL, \
350 "file %s: line %d: should not be reached", \
353 return (val); }G_STMT_END
355 #endif /* !__GNUC__ */
357 #endif /* !G_DISABLE_CHECKS */
361 #endif /* __G_MESSAGES_H__ */