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__
30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
31 #error "Only <glib.h> can be included directly."
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.
49 gsize
g_printf_string_upper_bound (const gchar
* format
,
50 va_list args
) G_GNUC_PRINTF(1, 0);
52 /* Log level shift offset for user defined
53 * log levels (0-7 are used by GLib).
55 #define G_LOG_LEVEL_USER_SHIFT (8)
57 /* Glib log levels and flags.
62 G_LOG_FLAG_RECURSION
= 1 << 0,
63 G_LOG_FLAG_FATAL
= 1 << 1,
66 G_LOG_LEVEL_ERROR
= 1 << 2, /* always fatal */
67 G_LOG_LEVEL_CRITICAL
= 1 << 3,
68 G_LOG_LEVEL_WARNING
= 1 << 4,
69 G_LOG_LEVEL_MESSAGE
= 1 << 5,
70 G_LOG_LEVEL_INFO
= 1 << 6,
71 G_LOG_LEVEL_DEBUG
= 1 << 7,
73 G_LOG_LEVEL_MASK
= ~(G_LOG_FLAG_RECURSION
| G_LOG_FLAG_FATAL
)
76 /* GLib log levels that are considered fatal by default */
77 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
79 typedef void (*GLogFunc
) (const gchar
*log_domain
,
80 GLogLevelFlags log_level
,
87 guint
g_log_set_handler (const gchar
*log_domain
,
88 GLogLevelFlags log_levels
,
92 void g_log_remove_handler (const gchar
*log_domain
,
95 void g_log_default_handler (const gchar
*log_domain
,
96 GLogLevelFlags log_level
,
98 gpointer unused_data
);
100 GLogFunc
g_log_set_default_handler (GLogFunc log_func
,
102 GLIB_AVAILABLE_IN_ALL
103 void g_log (const gchar
*log_domain
,
104 GLogLevelFlags log_level
,
106 ...) G_GNUC_PRINTF (3, 4);
107 GLIB_AVAILABLE_IN_ALL
108 void g_logv (const gchar
*log_domain
,
109 GLogLevelFlags log_level
,
111 va_list args
) G_GNUC_PRINTF(3, 0);
112 GLIB_AVAILABLE_IN_ALL
113 GLogLevelFlags
g_log_set_fatal_mask (const gchar
*log_domain
,
114 GLogLevelFlags fatal_mask
);
115 GLIB_AVAILABLE_IN_ALL
116 GLogLevelFlags
g_log_set_always_fatal (GLogLevelFlags fatal_mask
);
119 void _g_log_fallback_handler (const gchar
*log_domain
,
120 GLogLevelFlags log_level
,
121 const gchar
*message
,
122 gpointer unused_data
);
124 /* Internal functions, used to implement the following macros */
125 GLIB_AVAILABLE_IN_ALL
126 void g_return_if_fail_warning (const char *log_domain
,
127 const char *pretty_function
,
128 const char *expression
) G_ANALYZER_NORETURN
;
129 GLIB_AVAILABLE_IN_ALL
130 void g_warn_message (const char *domain
,
134 const char *warnexpr
) G_ANALYZER_NORETURN
;
136 void g_assert_warning (const char *log_domain
,
139 const char *pretty_function
,
140 const char *expression
) G_GNUC_NORETURN
;
144 #define G_LOG_DOMAIN ((gchar*) 0)
145 #endif /* G_LOG_DOMAIN */
147 #if defined(G_HAVE_ISO_VARARGS) && !G_ANALYZER_ANALYZING
148 /* for(;;) ; so that GCC knows that control doesn't go past g_error().
149 * Put space before ending semicolon to avoid C++ build warnings.
151 #define g_error(...) G_STMT_START { \
152 g_log (G_LOG_DOMAIN, \
158 #define g_message(...) g_log (G_LOG_DOMAIN, \
159 G_LOG_LEVEL_MESSAGE, \
161 #define g_critical(...) g_log (G_LOG_DOMAIN, \
162 G_LOG_LEVEL_CRITICAL, \
164 #define g_warning(...) g_log (G_LOG_DOMAIN, \
165 G_LOG_LEVEL_WARNING, \
167 #define g_info(...) g_log (G_LOG_DOMAIN, \
170 #define g_debug(...) g_log (G_LOG_DOMAIN, \
173 #elif defined(G_HAVE_GNUC_VARARGS) && !G_ANALYZER_ANALYZING
174 #define g_error(format...) G_STMT_START { \
175 g_log (G_LOG_DOMAIN, \
181 #define g_message(format...) g_log (G_LOG_DOMAIN, \
182 G_LOG_LEVEL_MESSAGE, \
184 #define g_critical(format...) g_log (G_LOG_DOMAIN, \
185 G_LOG_LEVEL_CRITICAL, \
187 #define g_warning(format...) g_log (G_LOG_DOMAIN, \
188 G_LOG_LEVEL_WARNING, \
190 #define g_info(format...) g_log (G_LOG_DOMAIN, \
193 #define g_debug(format...) g_log (G_LOG_DOMAIN, \
196 #else /* no varargs macros */
197 static void g_error (const gchar
*format
, ...) G_ANALYZER_NORETURN
;
198 static void g_critical (const gchar
*format
, ...) G_ANALYZER_NORETURN
;
201 g_error (const gchar
*format
,
205 va_start (args
, format
);
206 g_logv (G_LOG_DOMAIN
, G_LOG_LEVEL_ERROR
, format
, args
);
212 g_message (const gchar
*format
,
216 va_start (args
, format
);
217 g_logv (G_LOG_DOMAIN
, G_LOG_LEVEL_MESSAGE
, format
, args
);
221 g_critical (const gchar
*format
,
225 va_start (args
, format
);
226 g_logv (G_LOG_DOMAIN
, G_LOG_LEVEL_CRITICAL
, format
, args
);
230 g_warning (const gchar
*format
,
234 va_start (args
, format
);
235 g_logv (G_LOG_DOMAIN
, G_LOG_LEVEL_WARNING
, format
, args
);
239 g_info (const gchar
*format
,
243 va_start (args
, format
);
244 g_logv (G_LOG_DOMAIN
, G_LOG_LEVEL_INFO
, format
, args
);
248 g_debug (const gchar
*format
,
252 va_start (args
, format
);
253 g_logv (G_LOG_DOMAIN
, G_LOG_LEVEL_DEBUG
, format
, args
);
256 #endif /* !__GNUC__ */
260 * @string: the message to output
262 * Specifies the type of the print handler functions.
263 * These are called with the complete formatted string to output.
265 typedef void (*GPrintFunc
) (const gchar
*string
);
266 GLIB_AVAILABLE_IN_ALL
267 void g_print (const gchar
*format
,
268 ...) G_GNUC_PRINTF (1, 2);
269 GLIB_AVAILABLE_IN_ALL
270 GPrintFunc
g_set_print_handler (GPrintFunc func
);
271 GLIB_AVAILABLE_IN_ALL
272 void g_printerr (const gchar
*format
,
273 ...) G_GNUC_PRINTF (1, 2);
274 GLIB_AVAILABLE_IN_ALL
275 GPrintFunc
g_set_printerr_handler (GPrintFunc func
);
280 * Logs a critical warning.
284 #define g_warn_if_reached() \
286 g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); \
291 * @expr: the expression to check
293 * Logs a warning if the expression is not true.
297 #define g_warn_if_fail(expr) \
299 if G_LIKELY (expr) ; \
300 else g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, #expr); \
303 #ifdef G_DISABLE_CHECKS
307 * @expr: the expression to check
309 * Verifies that the expression evaluates to %TRUE. If the expression
310 * evaluates to %FALSE, a critical message is logged and the current
311 * function returns. This can only be used in functions which do not
314 * If G_DISABLE_CHECKS is defined then the check is not performed. You
315 * should therefore not depend on any side effects of @expr.
317 #define g_return_if_fail(expr) G_STMT_START{ (void)0; }G_STMT_END
320 * g_return_val_if_fail:
321 * @expr: the expression to check
322 * @val: the value to return from the current function
323 * if the expression is not true
325 * Verifies that the expression evaluates to %TRUE. If the expression
326 * evaluates to %FALSE, a critical message is logged and @val is
327 * returned from the current function.
329 * If G_DISABLE_CHECKS is defined then the check is not performed. You
330 * should therefore not depend on any side effects of @expr.
332 #define g_return_val_if_fail(expr,val) G_STMT_START{ (void)0; }G_STMT_END
335 * g_return_if_reached:
337 * Logs a critical message and returns from the current function.
338 * This can only be used in functions which do not return a value.
340 #define g_return_if_reached() G_STMT_START{ return; }G_STMT_END
343 * g_return_val_if_reached:
344 * @val: the value to return from the current function
346 * Logs a critical message and returns @val.
348 #define g_return_val_if_reached(val) G_STMT_START{ return (val); }G_STMT_END
350 #else /* !G_DISABLE_CHECKS */
352 #define g_return_if_fail(expr) G_STMT_START{ \
353 if G_LIKELY(expr) { } else \
355 g_return_if_fail_warning (G_LOG_DOMAIN, \
361 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
362 if G_LIKELY(expr) { } else \
364 g_return_if_fail_warning (G_LOG_DOMAIN, \
370 #define g_return_if_reached() G_STMT_START{ \
371 g_log (G_LOG_DOMAIN, \
372 G_LOG_LEVEL_CRITICAL, \
373 "file %s: line %d (%s): should not be reached", \
379 #define g_return_val_if_reached(val) G_STMT_START{ \
380 g_log (G_LOG_DOMAIN, \
381 G_LOG_LEVEL_CRITICAL, \
382 "file %s: line %d (%s): should not be reached", \
386 return (val); }G_STMT_END
388 #endif /* !G_DISABLE_CHECKS */
392 #endif /* __G_MESSAGES_H__ */