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 void g_log (const gchar *log_domain,
92 GLogLevelFlags log_level,
94 ...) G_GNUC_PRINTF (3, 4);
95 void g_logv (const gchar *log_domain,
96 GLogLevelFlags log_level,
99 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
100 GLogLevelFlags fatal_mask);
101 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
104 void _g_log_fallback_handler (const gchar *log_domain,
105 GLogLevelFlags log_level,
106 const gchar *message,
107 gpointer unused_data);
111 #define G_LOG_DOMAIN ((gchar*) 0)
112 #endif /* G_LOG_DOMAIN */
113 #ifdef G_HAVE_ISO_VARARGS
114 #define g_error(...) g_log (G_LOG_DOMAIN, \
117 #define g_message(...) g_log (G_LOG_DOMAIN, \
118 G_LOG_LEVEL_MESSAGE, \
120 #define g_critical(...) g_log (G_LOG_DOMAIN, \
121 G_LOG_LEVEL_CRITICAL, \
123 #define g_warning(...) g_log (G_LOG_DOMAIN, \
124 G_LOG_LEVEL_WARNING, \
126 #elif defined(G_HAVE_GNUC_VARARGS)
127 #define g_error(format...) g_log (G_LOG_DOMAIN, \
130 #define g_message(format...) g_log (G_LOG_DOMAIN, \
131 G_LOG_LEVEL_MESSAGE, \
133 #define g_critical(format...) g_log (G_LOG_DOMAIN, \
134 G_LOG_LEVEL_CRITICAL, \
136 #define g_warning(format...) g_log (G_LOG_DOMAIN, \
137 G_LOG_LEVEL_WARNING, \
139 #else /* no varargs macros */
141 g_error (const gchar *format,
145 va_start (args, format);
146 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
150 g_message (const gchar *format,
154 va_start (args, format);
155 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
159 g_critical (const gchar *format,
163 va_start (args, format);
164 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
168 g_warning (const gchar *format,
172 va_start (args, format);
173 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
176 #endif /* !__GNUC__ */
178 typedef void (*GPrintFunc) (const gchar *string);
179 void g_print (const gchar *format,
180 ...) G_GNUC_PRINTF (1, 2);
181 GPrintFunc g_set_print_handler (GPrintFunc func);
182 void g_printerr (const gchar *format,
183 ...) G_GNUC_PRINTF (1, 2);
184 GPrintFunc g_set_printerr_handler (GPrintFunc func);
187 /* Provide macros for error handling. The "assert" macros will
188 * exit on failure. The "return" macros will exit the current
189 * function. Two different definitions are given for the macros
190 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
191 * __PRETTY_FUNCTION__ capability.
194 #ifdef G_DISABLE_ASSERT
196 #define g_assert(expr) G_STMT_START{ (void)0; }G_STMT_END
197 #define g_assert_not_reached() G_STMT_START{ (void)0; }G_STMT_END
199 #else /* !G_DISABLE_ASSERT */
203 #define g_assert(expr) G_STMT_START{ \
204 if G_LIKELY(expr) { } else \
205 g_log (G_LOG_DOMAIN, \
207 "file %s: line %d (%s): assertion failed: (%s)", \
210 __PRETTY_FUNCTION__, \
213 #define g_assert_not_reached() G_STMT_START{ \
214 g_log (G_LOG_DOMAIN, \
216 "file %s: line %d (%s): should not be reached", \
219 __PRETTY_FUNCTION__); }G_STMT_END
221 #else /* !__GNUC__ */
223 #define g_assert(expr) G_STMT_START{ \
225 g_log (G_LOG_DOMAIN, \
227 "file %s: line %d: assertion failed: (%s)", \
232 #define g_assert_not_reached() G_STMT_START{ \
233 g_log (G_LOG_DOMAIN, \
235 "file %s: line %d: should not be reached", \
237 __LINE__); }G_STMT_END
239 #endif /* __GNUC__ */
241 #endif /* !G_DISABLE_ASSERT */
244 #ifdef G_DISABLE_CHECKS
246 #define g_return_if_fail(expr) G_STMT_START{ (void)0; }G_STMT_END
247 #define g_return_val_if_fail(expr,val) G_STMT_START{ (void)0; }G_STMT_END
248 #define g_return_if_reached() G_STMT_START{ return; }G_STMT_END
249 #define g_return_val_if_reached(val) G_STMT_START{ return (val); }G_STMT_END
251 #else /* !G_DISABLE_CHECKS */
255 #define g_return_if_fail(expr) G_STMT_START{ \
256 if G_LIKELY(expr) { } else \
258 g_log (G_LOG_DOMAIN, \
259 G_LOG_LEVEL_CRITICAL, \
260 "file %s: line %d (%s): assertion `%s' failed", \
263 __PRETTY_FUNCTION__, \
268 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
269 if G_LIKELY(expr) { } else \
271 g_log (G_LOG_DOMAIN, \
272 G_LOG_LEVEL_CRITICAL, \
273 "file %s: line %d (%s): assertion `%s' failed", \
276 __PRETTY_FUNCTION__, \
281 #define g_return_if_reached() G_STMT_START{ \
282 g_log (G_LOG_DOMAIN, \
283 G_LOG_LEVEL_CRITICAL, \
284 "file %s: line %d (%s): should not be reached", \
287 __PRETTY_FUNCTION__); \
290 #define g_return_val_if_reached(val) G_STMT_START{ \
291 g_log (G_LOG_DOMAIN, \
292 G_LOG_LEVEL_CRITICAL, \
293 "file %s: line %d (%s): should not be reached", \
296 __PRETTY_FUNCTION__); \
297 return (val); }G_STMT_END
299 #else /* !__GNUC__ */
301 #define g_return_if_fail(expr) G_STMT_START{ \
304 g_log (G_LOG_DOMAIN, \
305 G_LOG_LEVEL_CRITICAL, \
306 "file %s: line %d: assertion `%s' failed", \
313 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
316 g_log (G_LOG_DOMAIN, \
317 G_LOG_LEVEL_CRITICAL, \
318 "file %s: line %d: assertion `%s' failed", \
325 #define g_return_if_reached() G_STMT_START{ \
326 g_log (G_LOG_DOMAIN, \
327 G_LOG_LEVEL_CRITICAL, \
328 "file %s: line %d: should not be reached", \
333 #define g_return_val_if_reached(val) G_STMT_START{ \
334 g_log (G_LOG_DOMAIN, \
335 G_LOG_LEVEL_CRITICAL, \
336 "file %s: line %d: should not be reached", \
339 return (val); }G_STMT_END
341 #endif /* !__GNUC__ */
343 #endif /* !G_DISABLE_CHECKS */
347 #endif /* __G_MESSAGES_H__ */