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 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
31 #ifndef __G_MESSAGES_H__
32 #define __G_MESSAGES_H__
35 #include <glib/gtypes.h>
36 #include <glib/gmacros.h>
38 /* Suppress warnings when GCC is in -pedantic mode and not -std=c99
40 #if (__GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96))
41 #pragma GCC system_header
46 /* calculate a string size, guaranteed to fit format + args.
48 gsize g_printf_string_upper_bound (const gchar* format,
51 /* Log level shift offset for user defined
52 * log levels (0-7 are used by GLib).
54 #define G_LOG_LEVEL_USER_SHIFT (8)
56 /* Glib log levels and flags.
61 G_LOG_FLAG_RECURSION = 1 << 0,
62 G_LOG_FLAG_FATAL = 1 << 1,
65 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
66 G_LOG_LEVEL_CRITICAL = 1 << 3,
67 G_LOG_LEVEL_WARNING = 1 << 4,
68 G_LOG_LEVEL_MESSAGE = 1 << 5,
69 G_LOG_LEVEL_INFO = 1 << 6,
70 G_LOG_LEVEL_DEBUG = 1 << 7,
72 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
75 /* GLib log levels that are considered fatal by default */
76 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
78 typedef void (*GLogFunc) (const gchar *log_domain,
79 GLogLevelFlags log_level,
85 guint g_log_set_handler (const gchar *log_domain,
86 GLogLevelFlags log_levels,
89 void g_log_remove_handler (const gchar *log_domain,
91 void g_log_default_handler (const gchar *log_domain,
92 GLogLevelFlags log_level,
94 gpointer unused_data);
95 GLogFunc g_log_set_default_handler (GLogFunc log_func,
97 void g_log (const gchar *log_domain,
98 GLogLevelFlags log_level,
100 ...) G_GNUC_PRINTF (3, 4);
101 void g_logv (const gchar *log_domain,
102 GLogLevelFlags log_level,
105 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
106 GLogLevelFlags fatal_mask);
107 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
110 G_GNUC_INTERNAL void _g_log_fallback_handler (const gchar *log_domain,
111 GLogLevelFlags log_level,
112 const gchar *message,
113 gpointer unused_data);
115 /* Internal functions, used to implement the following macros */
116 void g_return_if_fail_warning (const char *log_domain,
117 const char *pretty_function,
118 const char *expression);
119 void g_warn_message (const char *domain,
123 const char *warnexpr);
124 #ifndef G_DISABLE_DEPRECATED
125 void g_assert_warning (const char *log_domain,
128 const char *pretty_function,
129 const char *expression) G_GNUC_NORETURN;
130 #endif /* !G_DISABLE_DEPRECATED */
134 #define G_LOG_DOMAIN ((gchar*) 0)
135 #endif /* G_LOG_DOMAIN */
136 #ifdef G_HAVE_ISO_VARARGS
137 /* for(;;) ; so that GCC knows that control doesn't go past g_error().
138 * Put space before ending semicolon to avoid C++ build warnings.
140 #define g_error(...) G_STMT_START { \
141 g_log (G_LOG_DOMAIN, \
147 #define g_message(...) g_log (G_LOG_DOMAIN, \
148 G_LOG_LEVEL_MESSAGE, \
150 #define g_critical(...) g_log (G_LOG_DOMAIN, \
151 G_LOG_LEVEL_CRITICAL, \
153 #define g_warning(...) g_log (G_LOG_DOMAIN, \
154 G_LOG_LEVEL_WARNING, \
156 #define g_debug(...) g_log (G_LOG_DOMAIN, \
159 #elif defined(G_HAVE_GNUC_VARARGS)
160 #define g_error(format...) G_STMT_START { \
161 g_log (G_LOG_DOMAIN, \
167 #define g_message(format...) g_log (G_LOG_DOMAIN, \
168 G_LOG_LEVEL_MESSAGE, \
170 #define g_critical(format...) g_log (G_LOG_DOMAIN, \
171 G_LOG_LEVEL_CRITICAL, \
173 #define g_warning(format...) g_log (G_LOG_DOMAIN, \
174 G_LOG_LEVEL_WARNING, \
176 #define g_debug(format...) g_log (G_LOG_DOMAIN, \
179 #else /* no varargs macros */
181 g_error (const gchar *format,
185 va_start (args, format);
186 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
192 g_message (const gchar *format,
196 va_start (args, format);
197 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
201 g_critical (const gchar *format,
205 va_start (args, format);
206 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
210 g_warning (const gchar *format,
214 va_start (args, format);
215 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
219 g_debug (const gchar *format,
223 va_start (args, format);
224 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format, args);
227 #endif /* !__GNUC__ */
231 * @string: the message to output
233 * Specifies the type of the print handler functions.
234 * These are called with the complete formatted string to output.
236 typedef void (*GPrintFunc) (const gchar *string);
237 void g_print (const gchar *format,
238 ...) G_GNUC_PRINTF (1, 2);
239 GPrintFunc g_set_print_handler (GPrintFunc func);
240 void g_printerr (const gchar *format,
241 ...) G_GNUC_PRINTF (1, 2);
242 GPrintFunc g_set_printerr_handler (GPrintFunc func);
247 * Logs a critical warning.
251 #define g_warn_if_reached() \
253 g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); \
258 * @expr: the expression to check
260 * Logs a warning if the expression is not true.
264 #define g_warn_if_fail(expr) \
266 if G_LIKELY (expr) ; \
267 else g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, #expr); \
270 #ifdef G_DISABLE_CHECKS
274 * @expr: the expression to check
276 * Verifies that the expression evaluates to %TRUE. If the expression
277 * evaluates to %FALSE, a critical message is logged and the current
278 * function returns. This can only be used in functions which do not
281 * If G_DISABLE_CHECKS is defined then the check is not performed. You
282 * should therefore not depend on any side effects of @expr.
284 #define g_return_if_fail(expr) G_STMT_START{ (void)0; }G_STMT_END
287 * g_return_val_if_fail:
288 * @expr: the expression to check
289 * @val: the value to return from the current function
290 * if the expression is not true
292 * Verifies that the expression evaluates to %TRUE. If the expression
293 * evaluates to %FALSE, a critical message is logged and @val is
294 * returned from the current function.
296 * If G_DISABLE_CHECKS is defined then the check is not performed. You
297 * should therefore not depend on any side effects of @expr.
299 #define g_return_val_if_fail(expr,val) G_STMT_START{ (void)0; }G_STMT_END
302 * g_return_if_reached:
304 * Logs a critical message and returns from the current function.
305 * This can only be used in functions which do not return a value.
307 #define g_return_if_reached() G_STMT_START{ return; }G_STMT_END
310 * g_return_val_if_reached:
311 * @val: the value to return from the current function
313 * Logs a critical message and returns @val.
315 #define g_return_val_if_reached(val) G_STMT_START{ return (val); }G_STMT_END
317 #else /* !G_DISABLE_CHECKS */
321 #define g_return_if_fail(expr) G_STMT_START{ \
322 if G_LIKELY(expr) { } else \
324 g_return_if_fail_warning (G_LOG_DOMAIN, \
325 __PRETTY_FUNCTION__, \
330 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
331 if G_LIKELY(expr) { } else \
333 g_return_if_fail_warning (G_LOG_DOMAIN, \
334 __PRETTY_FUNCTION__, \
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 (%s): should not be reached", \
345 __PRETTY_FUNCTION__); \
348 #define g_return_val_if_reached(val) G_STMT_START{ \
349 g_log (G_LOG_DOMAIN, \
350 G_LOG_LEVEL_CRITICAL, \
351 "file %s: line %d (%s): should not be reached", \
354 __PRETTY_FUNCTION__); \
355 return (val); }G_STMT_END
357 #else /* !__GNUC__ */
359 #define g_return_if_fail(expr) G_STMT_START{ \
362 g_log (G_LOG_DOMAIN, \
363 G_LOG_LEVEL_CRITICAL, \
364 "file %s: line %d: assertion `%s' failed", \
371 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
374 g_log (G_LOG_DOMAIN, \
375 G_LOG_LEVEL_CRITICAL, \
376 "file %s: line %d: assertion `%s' failed", \
383 #define g_return_if_reached() G_STMT_START{ \
384 g_log (G_LOG_DOMAIN, \
385 G_LOG_LEVEL_CRITICAL, \
386 "file %s: line %d: should not be reached", \
391 #define g_return_val_if_reached(val) G_STMT_START{ \
392 g_log (G_LOG_DOMAIN, \
393 G_LOG_LEVEL_CRITICAL, \
394 "file %s: line %d: should not be reached", \
397 return (val); }G_STMT_END
399 #endif /* !__GNUC__ */
401 #endif /* !G_DISABLE_CHECKS */
405 #endif /* __G_MESSAGES_H__ */