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>
33 /* Suppress warnings when GCC is in -pedantic mode and not -std=c99
35 #if (__GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96))
36 #pragma GCC system_header
41 /* calculate a string size, guarranteed to fit format + args.
43 gsize g_printf_string_upper_bound (const gchar* format,
46 /* Log level shift offset for user defined
47 * log levels (0-7 are used by GLib).
49 #define G_LOG_LEVEL_USER_SHIFT (8)
51 /* Glib log levels and flags.
56 G_LOG_FLAG_RECURSION = 1 << 0,
57 G_LOG_FLAG_FATAL = 1 << 1,
60 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
61 G_LOG_LEVEL_CRITICAL = 1 << 3,
62 G_LOG_LEVEL_WARNING = 1 << 4,
63 G_LOG_LEVEL_MESSAGE = 1 << 5,
64 G_LOG_LEVEL_INFO = 1 << 6,
65 G_LOG_LEVEL_DEBUG = 1 << 7,
67 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
70 /* GLib log levels that are considered fatal by default */
71 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
73 typedef void (*GLogFunc) (const gchar *log_domain,
74 GLogLevelFlags log_level,
80 guint g_log_set_handler (const gchar *log_domain,
81 GLogLevelFlags log_levels,
84 void g_log_remove_handler (const gchar *log_domain,
86 void g_log_default_handler (const gchar *log_domain,
87 GLogLevelFlags log_level,
89 gpointer unused_data);
90 void g_log (const gchar *log_domain,
91 GLogLevelFlags log_level,
93 ...) G_GNUC_PRINTF (3, 4);
94 void g_logv (const gchar *log_domain,
95 GLogLevelFlags log_level,
98 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
99 GLogLevelFlags fatal_mask);
100 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
103 #define G_LOG_DOMAIN ((gchar*) 0)
104 #endif /* G_LOG_DOMAIN */
105 #ifdef G_HAVE_ISO_VARARGS
106 #define g_error(...) g_log (G_LOG_DOMAIN, \
109 #define g_message(...) g_log (G_LOG_DOMAIN, \
110 G_LOG_LEVEL_MESSAGE, \
112 #define g_critical(...) g_log (G_LOG_DOMAIN, \
113 G_LOG_LEVEL_CRITICAL, \
115 #define g_warning(...) g_log (G_LOG_DOMAIN, \
116 G_LOG_LEVEL_WARNING, \
118 #elif defined(G_HAVE_GNUC_VARARGS)
119 #define g_error(format...) g_log (G_LOG_DOMAIN, \
122 #define g_message(format...) g_log (G_LOG_DOMAIN, \
123 G_LOG_LEVEL_MESSAGE, \
125 #define g_critical(format...) g_log (G_LOG_DOMAIN, \
126 G_LOG_LEVEL_CRITICAL, \
128 #define g_warning(format...) g_log (G_LOG_DOMAIN, \
129 G_LOG_LEVEL_WARNING, \
131 #else /* no varargs macros */
133 g_error (const gchar *format,
137 va_start (args, format);
138 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
142 g_message (const gchar *format,
146 va_start (args, format);
147 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
151 g_critical (const gchar *format,
155 va_start (args, format);
156 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
160 g_warning (const gchar *format,
164 va_start (args, format);
165 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
168 #endif /* !__GNUC__ */
170 typedef void (*GPrintFunc) (const gchar *string);
171 void g_print (const gchar *format,
172 ...) G_GNUC_PRINTF (1, 2);
173 GPrintFunc g_set_print_handler (GPrintFunc func);
174 void g_printerr (const gchar *format,
175 ...) G_GNUC_PRINTF (1, 2);
176 GPrintFunc g_set_printerr_handler (GPrintFunc func);
179 /* Provide macros for error handling. The "assert" macros will
180 * exit on failure. The "return" macros will exit the current
181 * function. Two different definitions are given for the macros
182 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
183 * __PRETTY_FUNCTION__ capability.
186 #ifdef G_DISABLE_ASSERT
188 #define g_assert(expr) G_STMT_START{ }G_STMT_END
189 #define g_assert_not_reached() G_STMT_START{ }G_STMT_END
191 #else /* !G_DISABLE_ASSERT */
195 #define g_assert(expr) G_STMT_START{ \
197 g_log (G_LOG_DOMAIN, \
199 "file %s: line %d (%s): assertion failed: (%s)", \
202 __PRETTY_FUNCTION__, \
205 #define g_assert_not_reached() G_STMT_START{ \
206 g_log (G_LOG_DOMAIN, \
208 "file %s: line %d (%s): should not be reached", \
211 __PRETTY_FUNCTION__); }G_STMT_END
213 #else /* !__GNUC__ */
215 #define g_assert(expr) G_STMT_START{ \
217 g_log (G_LOG_DOMAIN, \
219 "file %s: line %d: assertion failed: (%s)", \
224 #define g_assert_not_reached() G_STMT_START{ \
225 g_log (G_LOG_DOMAIN, \
227 "file %s: line %d: should not be reached", \
229 __LINE__); }G_STMT_END
231 #endif /* __GNUC__ */
233 #endif /* !G_DISABLE_ASSERT */
236 #ifdef G_DISABLE_CHECKS
238 #define g_return_if_fail(expr) G_STMT_START{ }G_STMT_END
239 #define g_return_val_if_fail(expr,val) G_STMT_START{ }G_STMT_END
240 #define g_return_if_reached() G_STMT_START{ return; }G_STMT_END
241 #define g_return_val_if_reached(val) G_STMT_START{ return (val); }G_STMT_END
243 #else /* !G_DISABLE_CHECKS */
247 #define g_return_if_fail(expr) G_STMT_START{ \
250 g_log (G_LOG_DOMAIN, \
251 G_LOG_LEVEL_CRITICAL, \
252 "file %s: line %d (%s): assertion `%s' failed", \
255 __PRETTY_FUNCTION__, \
260 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
263 g_log (G_LOG_DOMAIN, \
264 G_LOG_LEVEL_CRITICAL, \
265 "file %s: line %d (%s): assertion `%s' failed", \
268 __PRETTY_FUNCTION__, \
273 #define g_return_if_reached() G_STMT_START{ \
274 g_log (G_LOG_DOMAIN, \
275 G_LOG_LEVEL_CRITICAL, \
276 "file %s: line %d (%s): should not be reached", \
279 __PRETTY_FUNCTION__); \
282 #define g_return_val_if_reached(val) G_STMT_START{ \
283 g_log (G_LOG_DOMAIN, \
284 G_LOG_LEVEL_CRITICAL, \
285 "file %s: line %d (%s): should not be reached", \
288 __PRETTY_FUNCTION__); \
289 return (val); }G_STMT_END
291 #else /* !__GNUC__ */
293 #define g_return_if_fail(expr) G_STMT_START{ \
296 g_log (G_LOG_DOMAIN, \
297 G_LOG_LEVEL_CRITICAL, \
298 "file %s: line %d: assertion `%s' failed", \
305 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
308 g_log (G_LOG_DOMAIN, \
309 G_LOG_LEVEL_CRITICAL, \
310 "file %s: line %d: assertion `%s' failed", \
317 #define g_return_if_reached() G_STMT_START{ \
318 g_log (G_LOG_DOMAIN, \
319 G_LOG_LEVEL_CRITICAL, \
320 "file %s: line %d: should not be reached", \
325 #define g_return_val_if_reached(val) G_STMT_START{ \
326 g_log (G_LOG_DOMAIN, \
327 G_LOG_LEVEL_CRITICAL, \
328 "file %s: line %d: should not be reached", \
331 return (val); }G_STMT_END
333 #endif /* !__GNUC__ */
335 #endif /* !G_DISABLE_CHECKS */
339 #endif /* __G_MESSAGES_H__ */