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/.
33 * @Title: Message Output and Debugging Functions
34 * @Short_description: functions to output messages and help debug applications
36 * These functions provide support for outputting messages.
38 * The <function>g_return</function> family of macros (g_return_if_fail(),
39 * g_return_val_if_fail(), g_return_if_reached(), g_return_val_if_reached())
40 * should only be used for programming errors, a typical use case is
41 * checking for invalid parameters at the beginning of a public function.
42 * They should not be used if you just mean "if (error) return", they
43 * should only be used if you mean "if (bug in program) return".
44 * The program behavior is generally considered undefined after one
45 * of these checks fails. They are not intended for normal control
46 * flow, only to give a perhaps-helpful warning before giving up.
62 #include "gmessages-private.h"
64 #include "glib-init.h"
65 #include "gbacktrace.h"
70 #include "gprintfint.h"
71 #include "gtestutils.h"
73 #include "gstrfuncs.h"
78 #include <process.h> /* For getpid() */
80 # define _WIN32_WINDOWS 0x0401 /* to get IsDebuggerPresent */
87 * @title: Message Logging
88 * @short_description: versatile support for logging messages
89 * with different levels of importance
91 * These functions provide support for logging error messages
92 * or messages used for debugging.
94 * There are several built-in levels of messages, defined in
95 * #GLogLevelFlags. These can be extended with user-defined levels.
101 * Defines the log domain.
103 * For applications, this is typically left as the default %NULL
104 * (or "") domain. Libraries should define this so that any messages
105 * which they log can be differentiated from messages from other
106 * libraries and application code. But be careful not to define
107 * it in any public header files.
109 * For example, GTK+ uses this in its Makefile.am:
111 * INCLUDES = -DG_LOG_DOMAIN=\"Gtk\"
118 * GLib log levels that are considered fatal by default.
123 * @log_domain: the log domain of the message
124 * @log_level: the log level of the message (including the
125 * fatal and recursion flags)
126 * @message: the message to process
127 * @user_data: user data, set in g_log_set_handler()
129 * Specifies the prototype of log handler functions.
134 * @G_LOG_FLAG_RECURSION: internal flag
135 * @G_LOG_FLAG_FATAL: internal flag
136 * @G_LOG_LEVEL_ERROR: log level for errors, see g_error().
137 * This level is also used for messages produced by g_assert().
138 * @G_LOG_LEVEL_CRITICAL: log level for critical messages, see g_critical().
139 * This level is also used for messages produced by g_return_if_fail()
140 * and g_return_val_if_fail().
141 * @G_LOG_LEVEL_WARNING: log level for warnings, see g_warning()
142 * @G_LOG_LEVEL_MESSAGE: log level for messages, see g_message()
143 * @G_LOG_LEVEL_INFO: log level for informational messages
144 * @G_LOG_LEVEL_DEBUG: log level for debug messages, see g_debug()
145 * @G_LOG_LEVEL_MASK: a mask including all log levels
147 * Flags specifying the level of log messages.
149 * It is possible to change how GLib treats messages of the various
150 * levels using g_log_set_handler() and g_log_set_fatal_mask().
155 * @...: format string, followed by parameters to insert
156 * into the format string (as with printf())
158 * A convenience function/macro to log a normal message.
163 * @...: format string, followed by parameters to insert
164 * into the format string (as with printf())
166 * A convenience function/macro to log a warning message.
168 * You can make warnings fatal at runtime by setting the
169 * <envar>G_DEBUG</envar> environment variable (see
170 * <ulink url="glib-running.html">Running GLib Applications</ulink>).
175 * @...: format string, followed by parameters to insert
176 * into the format string (as with printf())
178 * Logs a "critical warning" (#G_LOG_LEVEL_CRITICAL).
179 * It's more or less application-defined what constitutes
180 * a critical vs. a regular warning. You could call
181 * g_log_set_always_fatal() to make critical warnings exit
182 * the program, then use g_critical() for fatal errors, for
185 * You can also make critical warnings fatal at runtime by
186 * setting the <envar>G_DEBUG</envar> environment variable (see
187 * <ulink url="glib-running.html">Running GLib Applications</ulink>).
192 * @...: format string, followed by parameters to insert
193 * into the format string (as with printf())
195 * A convenience function/macro to log an error message.
197 * Error messages are always fatal, resulting in a call to
198 * abort() to terminate the application. This function will
199 * result in a core dump; don't use it for errors you expect.
200 * Using this function indicates a bug in your program, i.e.
201 * an assertion failure.
207 * @...: format string, followed by parameters to insert
208 * into the format string (as with printf())
210 * A convenience function/macro to log a debug message.
215 /* --- structures --- */
216 typedef struct _GLogDomain GLogDomain;
217 typedef struct _GLogHandler GLogHandler;
221 GLogLevelFlags fatal_mask;
222 GLogHandler *handlers;
228 GLogLevelFlags log_level;
235 /* --- variables --- */
236 static GMutex g_messages_lock;
237 static GLogDomain *g_log_domains = NULL;
238 static GPrintFunc glib_print_func = NULL;
239 static GPrintFunc glib_printerr_func = NULL;
240 static GPrivate g_log_depth;
241 static gboolean exit_on_fatal;
242 static GLogFunc default_log_func = g_log_default_handler;
243 static gpointer default_log_data = NULL;
244 static GTestLogFatalFunc fatal_log_func = NULL;
245 static gpointer fatal_log_data;
247 /* --- functions --- */
259 # include <windows.h>
260 static gboolean win32_keep_fatal_message = FALSE;
262 /* This default message will usually be overwritten. */
263 /* Yes, a fixed size buffer is bad. So sue me. But g_error() is never
264 * called with huge strings, is it?
266 static gchar fatal_msg_buf[1000] = "Unspecified fatal error encountered, aborting.";
267 static gchar *fatal_msg_ptr = fatal_msg_buf;
275 if (win32_keep_fatal_message)
277 memcpy (fatal_msg_ptr, buf, len);
278 fatal_msg_ptr += len;
283 write (fd, buf, len);
287 #define write(fd, buf, len) dowrite(fd, buf, len)
292 write_string (int fd,
297 res = write (fd, string, strlen (string));
298 while (G_UNLIKELY (res == -1 && errno == EINTR));
302 g_log_find_domain_L (const gchar *log_domain)
304 register GLogDomain *domain;
306 domain = g_log_domains;
309 if (strcmp (domain->log_domain, log_domain) == 0)
311 domain = domain->next;
317 g_log_domain_new_L (const gchar *log_domain)
319 register GLogDomain *domain;
321 domain = g_new (GLogDomain, 1);
322 domain->log_domain = g_strdup (log_domain);
323 domain->fatal_mask = G_LOG_FATAL_MASK;
324 domain->handlers = NULL;
326 domain->next = g_log_domains;
327 g_log_domains = domain;
333 g_log_domain_check_free_L (GLogDomain *domain)
335 if (domain->fatal_mask == G_LOG_FATAL_MASK &&
336 domain->handlers == NULL)
338 register GLogDomain *last, *work;
342 work = g_log_domains;
348 last->next = domain->next;
350 g_log_domains = domain->next;
351 g_free (domain->log_domain);
362 g_log_domain_get_handler_L (GLogDomain *domain,
363 GLogLevelFlags log_level,
366 if (domain && log_level)
368 register GLogHandler *handler;
370 handler = domain->handlers;
373 if ((handler->log_level & log_level) == log_level)
375 *data = handler->data;
376 return handler->log_func;
378 handler = handler->next;
382 *data = default_log_data;
383 return default_log_func;
387 * g_log_set_always_fatal:
388 * @fatal_mask: the mask containing bits set for each level
389 * of error which is to be fatal
391 * Sets the message levels which are always fatal, in any log domain.
392 * When a message with any of these levels is logged the program terminates.
393 * You can only set the levels defined by GLib to be fatal.
394 * %G_LOG_LEVEL_ERROR is always fatal.
396 * You can also make some message levels fatal at runtime by setting
397 * the <envar>G_DEBUG</envar> environment variable (see
398 * <ulink url="glib-running.html">Running GLib Applications</ulink>).
400 * Returns: the old fatal mask
403 g_log_set_always_fatal (GLogLevelFlags fatal_mask)
405 GLogLevelFlags old_mask;
407 /* restrict the global mask to levels that are known to glib
408 * since this setting applies to all domains
410 fatal_mask &= (1 << G_LOG_LEVEL_USER_SHIFT) - 1;
411 /* force errors to be fatal */
412 fatal_mask |= G_LOG_LEVEL_ERROR;
413 /* remove bogus flag */
414 fatal_mask &= ~G_LOG_FLAG_FATAL;
416 g_mutex_lock (&g_messages_lock);
417 old_mask = g_log_always_fatal;
418 g_log_always_fatal = fatal_mask;
419 g_mutex_unlock (&g_messages_lock);
425 * g_log_set_fatal_mask:
426 * @log_domain: the log domain
427 * @fatal_mask: the new fatal mask
429 * Sets the log levels which are fatal in the given domain.
430 * %G_LOG_LEVEL_ERROR is always fatal.
432 * Returns: the old fatal mask for the log domain
435 g_log_set_fatal_mask (const gchar *log_domain,
436 GLogLevelFlags fatal_mask)
438 GLogLevelFlags old_flags;
439 register GLogDomain *domain;
444 /* force errors to be fatal */
445 fatal_mask |= G_LOG_LEVEL_ERROR;
446 /* remove bogus flag */
447 fatal_mask &= ~G_LOG_FLAG_FATAL;
449 g_mutex_lock (&g_messages_lock);
451 domain = g_log_find_domain_L (log_domain);
453 domain = g_log_domain_new_L (log_domain);
454 old_flags = domain->fatal_mask;
456 domain->fatal_mask = fatal_mask;
457 g_log_domain_check_free_L (domain);
459 g_mutex_unlock (&g_messages_lock);
466 * @log_domain: (allow-none): the log domain, or %NULL for the default ""
468 * @log_levels: the log levels to apply the log handler for.
469 * To handle fatal and recursive messages as well, combine
470 * the log levels with the #G_LOG_FLAG_FATAL and
471 * #G_LOG_FLAG_RECURSION bit flags.
472 * @log_func: the log handler function
473 * @user_data: data passed to the log handler
475 * Sets the log handler for a domain and a set of log levels.
476 * To handle fatal and recursive messages the @log_levels parameter
477 * must be combined with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION
480 * Note that since the #G_LOG_LEVEL_ERROR log level is always fatal, if
481 * you want to set a handler for this log level you must combine it with
485 * <title>Adding a log handler for all warning messages in the default
486 * (application) domain</title>
488 * g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
489 * | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
494 * <title>Adding a log handler for all critical messages from GTK+</title>
496 * g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL
497 * | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
502 * <title>Adding a log handler for <emphasis>all</emphasis> messages from
505 * g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL
506 * | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
510 * Returns: the id of the new handler
513 g_log_set_handler (const gchar *log_domain,
514 GLogLevelFlags log_levels,
518 static guint handler_id = 0;
520 GLogHandler *handler;
522 g_return_val_if_fail ((log_levels & G_LOG_LEVEL_MASK) != 0, 0);
523 g_return_val_if_fail (log_func != NULL, 0);
528 handler = g_new (GLogHandler, 1);
530 g_mutex_lock (&g_messages_lock);
532 domain = g_log_find_domain_L (log_domain);
534 domain = g_log_domain_new_L (log_domain);
536 handler->id = ++handler_id;
537 handler->log_level = log_levels;
538 handler->log_func = log_func;
539 handler->data = user_data;
540 handler->next = domain->handlers;
541 domain->handlers = handler;
543 g_mutex_unlock (&g_messages_lock);
549 * g_log_set_default_handler:
550 * @log_func: the log handler function
551 * @user_data: data passed to the log handler
553 * Installs a default log handler which is used if no
554 * log handler has been set for the particular log domain
555 * and log level combination. By default, GLib uses
556 * g_log_default_handler() as default log handler.
558 * Returns: the previous default log handler
563 g_log_set_default_handler (GLogFunc log_func,
566 GLogFunc old_log_func;
568 g_mutex_lock (&g_messages_lock);
569 old_log_func = default_log_func;
570 default_log_func = log_func;
571 default_log_data = user_data;
572 g_mutex_unlock (&g_messages_lock);
578 * g_test_log_set_fatal_handler:
579 * @log_func: the log handler function.
580 * @user_data: data passed to the log handler.
582 * Installs a non-error fatal log handler which can be
583 * used to decide whether log messages which are counted
584 * as fatal abort the program.
586 * The use case here is that you are running a test case
587 * that depends on particular libraries or circumstances
588 * and cannot prevent certain known critical or warning
589 * messages. So you install a handler that compares the
590 * domain and message to precisely not abort in such a case.
592 * Note that the handler is reset at the beginning of
593 * any test case, so you have to set it inside each test
594 * function which needs the special behavior.
596 * This handler has no effect on g_error messages.
601 g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
604 g_mutex_lock (&g_messages_lock);
605 fatal_log_func = log_func;
606 fatal_log_data = user_data;
607 g_mutex_unlock (&g_messages_lock);
611 * g_log_remove_handler:
612 * @log_domain: the log domain
613 * @handler_id: the id of the handler, which was returned
614 * in g_log_set_handler()
616 * Removes the log handler.
619 g_log_remove_handler (const gchar *log_domain,
622 register GLogDomain *domain;
624 g_return_if_fail (handler_id > 0);
629 g_mutex_lock (&g_messages_lock);
630 domain = g_log_find_domain_L (log_domain);
633 GLogHandler *work, *last;
636 work = domain->handlers;
639 if (work->id == handler_id)
642 last->next = work->next;
644 domain->handlers = work->next;
645 g_log_domain_check_free_L (domain);
646 g_mutex_unlock (&g_messages_lock);
654 g_mutex_unlock (&g_messages_lock);
655 g_warning ("%s: could not find handler with id '%d' for domain \"%s\"",
656 G_STRLOC, handler_id, log_domain);
659 #define CHAR_IS_SAFE(wc) (!((wc < 0x20 && wc != '\t' && wc != '\n' && wc != '\r') || \
661 (wc >= 0x80 && wc < 0xa0)))
664 strdup_convert (const gchar *string,
665 const gchar *charset)
667 if (!g_utf8_validate (string, -1, NULL))
669 GString *gstring = g_string_new ("[Invalid UTF-8] ");
672 for (p = (guchar *)string; *p; p++)
674 if (CHAR_IS_SAFE(*p) &&
675 !(*p == '\r' && *(p + 1) != '\n') &&
677 g_string_append_c (gstring, *p);
679 g_string_append_printf (gstring, "\\x%02x", (guint)(guchar)*p);
682 return g_string_free (gstring, FALSE);
688 gchar *result = g_convert_with_fallback (string, -1, charset, "UTF-8", "?", NULL, NULL, &err);
693 /* Not thread-safe, but doesn't matter if we print the warning twice
695 static gboolean warned = FALSE;
699 _g_fprintf (stderr, "GLib: Cannot convert message: %s\n", err->message);
703 return g_strdup (string);
708 /* For a radix of 8 we need at most 3 output bytes for 1 input
709 * byte. Additionally we might need up to 2 output bytes for the
710 * readix prefix and 1 byte for the trailing NULL.
712 #define FORMAT_UNSIGNED_BUFSIZE ((GLIB_SIZEOF_LONG * 3) + 3)
715 format_unsigned (gchar *buf,
723 /* we may not call _any_ GLib functions here (or macros like g_return_if_fail()) */
725 if (radix != 8 && radix != 10 && radix != 16)
758 /* Again we can't use g_assert; actually this check should _never_ fail. */
759 if (n > FORMAT_UNSIGNED_BUFSIZE - 3)
772 buf[i] = c + 'a' - 10;
779 /* string size big enough to hold level prefix */
780 #define STRING_BUFFER_SIZE (FORMAT_UNSIGNED_BUFSIZE + 32)
782 #define ALERT_LEVELS (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
784 /* these are emitted by the default log handler */
785 #define DEFAULT_LEVELS (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_MESSAGE)
786 /* these are filtered by G_MESSAGES_DEBUG by the default log handler */
787 #define INFO_LEVELS (G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG)
790 mklevel_prefix (gchar level_prefix[STRING_BUFFER_SIZE],
791 GLogLevelFlags log_level)
793 gboolean to_stdout = TRUE;
795 /* we may not call _any_ GLib functions here */
797 switch (log_level & G_LOG_LEVEL_MASK)
799 case G_LOG_LEVEL_ERROR:
800 strcpy (level_prefix, "ERROR");
803 case G_LOG_LEVEL_CRITICAL:
804 strcpy (level_prefix, "CRITICAL");
807 case G_LOG_LEVEL_WARNING:
808 strcpy (level_prefix, "WARNING");
811 case G_LOG_LEVEL_MESSAGE:
812 strcpy (level_prefix, "Message");
815 case G_LOG_LEVEL_INFO:
816 strcpy (level_prefix, "INFO");
818 case G_LOG_LEVEL_DEBUG:
819 strcpy (level_prefix, "DEBUG");
824 strcpy (level_prefix, "LOG-");
825 format_unsigned (level_prefix + 4, log_level & G_LOG_LEVEL_MASK, 16);
828 strcpy (level_prefix, "LOG");
831 if (log_level & G_LOG_FLAG_RECURSION)
832 strcat (level_prefix, " (recursed)");
833 if (log_level & ALERT_LEVELS)
834 strcat (level_prefix, " **");
837 if ((log_level & G_LOG_FLAG_FATAL) != 0 && !g_test_initialized ())
838 win32_keep_fatal_message = TRUE;
840 return to_stdout ? 1 : 2;
845 GLogLevelFlags log_level;
847 } GTestExpectedMessage;
849 static GSList *expected_messages = NULL;
853 * @log_domain: the log domain
854 * @log_level: the log level
855 * @format: the message format. See the printf() documentation
856 * @args: the parameters to insert into the format string
858 * Logs an error or debugging message.
860 * If the log level has been set as fatal, the abort()
861 * function is called to terminate the program.
864 g_logv (const gchar *log_domain,
865 GLogLevelFlags log_level,
869 gboolean was_fatal = (log_level & G_LOG_FLAG_FATAL) != 0;
870 gboolean was_recursion = (log_level & G_LOG_FLAG_RECURSION) != 0;
871 gchar buffer[1025], *msg, *msg_alloc = NULL;
874 log_level &= G_LOG_LEVEL_MASK;
878 if (log_level & G_LOG_FLAG_RECURSION)
880 /* we use a stack buffer of fixed size, since we're likely
881 * in an out-of-memory situation
883 gsize size G_GNUC_UNUSED;
885 size = _g_vsnprintf (buffer, 1024, format, args);
889 msg = msg_alloc = g_strdup_vprintf (format, args);
891 if (expected_messages)
893 GTestExpectedMessage *expected = expected_messages->data;
895 expected_messages = g_slist_delete_link (expected_messages,
897 if (strcmp (expected->log_domain, log_domain) == 0 &&
898 ((log_level & expected->log_level) == expected->log_level) &&
899 g_pattern_match_simple (expected->pattern, msg))
901 g_free (expected->log_domain);
902 g_free (expected->pattern);
909 gchar level_prefix[STRING_BUFFER_SIZE];
910 gchar *expected_message;
912 mklevel_prefix (level_prefix, expected->log_level);
913 expected_message = g_strdup_printf ("Did not see expected message %s: %s",
914 level_prefix, expected->pattern);
915 g_log_default_handler (log_domain, log_level, expected_message, NULL);
916 g_free (expected_message);
918 log_level |= G_LOG_FLAG_FATAL;
922 for (i = g_bit_nth_msf (log_level, -1); i >= 0; i = g_bit_nth_msf (log_level, i))
924 register GLogLevelFlags test_level;
927 if (log_level & test_level)
931 GLogLevelFlags domain_fatal_mask;
932 gpointer data = NULL;
933 gboolean masquerade_fatal = FALSE;
937 test_level |= G_LOG_FLAG_FATAL;
939 test_level |= G_LOG_FLAG_RECURSION;
941 /* check recursion and lookup handler */
942 g_mutex_lock (&g_messages_lock);
943 depth = GPOINTER_TO_UINT (g_private_get (&g_log_depth));
944 domain = g_log_find_domain_L (log_domain ? log_domain : "");
946 test_level |= G_LOG_FLAG_RECURSION;
948 domain_fatal_mask = domain ? domain->fatal_mask : G_LOG_FATAL_MASK;
949 if ((domain_fatal_mask | g_log_always_fatal) & test_level)
950 test_level |= G_LOG_FLAG_FATAL;
951 if (test_level & G_LOG_FLAG_RECURSION)
952 log_func = _g_log_fallback_handler;
954 log_func = g_log_domain_get_handler_L (domain, test_level, &data);
956 g_mutex_unlock (&g_messages_lock);
958 g_private_set (&g_log_depth, GUINT_TO_POINTER (depth));
960 log_func (log_domain, test_level, msg, data);
962 if ((test_level & G_LOG_FLAG_FATAL)
963 && !(test_level & G_LOG_LEVEL_ERROR))
965 masquerade_fatal = fatal_log_func
966 && !fatal_log_func (log_domain, test_level, msg, fatal_log_data);
969 if ((test_level & G_LOG_FLAG_FATAL) && exit_on_fatal && !masquerade_fatal)
973 else if ((test_level & G_LOG_FLAG_FATAL) && !masquerade_fatal)
976 if (win32_keep_fatal_message)
978 gchar *locale_msg = g_locale_from_utf8 (fatal_msg_buf, -1, NULL, NULL, NULL);
980 MessageBox (NULL, locale_msg, NULL,
981 MB_ICONERROR|MB_SETFOREGROUND);
983 if (IsDebuggerPresent () && !(test_level & G_LOG_FLAG_RECURSION))
988 if (!(test_level & G_LOG_FLAG_RECURSION))
992 #endif /* !G_OS_WIN32 */
996 g_private_set (&g_log_depth, GUINT_TO_POINTER (depth));
1005 * @log_domain: the log domain, usually #G_LOG_DOMAIN
1006 * @log_level: the log level, either from #GLogLevelFlags
1007 * or a user-defined level
1008 * @format: the message format. See the printf() documentation
1009 * @...: the parameters to insert into the format string
1011 * Logs an error or debugging message.
1013 * If the log level has been set as fatal, the abort()
1014 * function is called to terminate the program.
1017 g_log (const gchar *log_domain,
1018 GLogLevelFlags log_level,
1019 const gchar *format,
1024 va_start (args, format);
1025 g_logv (log_domain, log_level, format, args);
1030 g_return_if_fail_warning (const char *log_domain,
1031 const char *pretty_function,
1032 const char *expression)
1035 G_LOG_LEVEL_CRITICAL,
1036 "%s: assertion '%s' failed",
1042 g_warn_message (const char *domain,
1046 const char *warnexpr)
1049 g_snprintf (lstr, 32, "%d", line);
1051 s = g_strconcat ("(", file, ":", lstr, "):",
1052 func, func[0] ? ":" : "",
1053 " runtime check failed: (", warnexpr, ")", NULL);
1055 s = g_strconcat ("(", file, ":", lstr, "):",
1056 func, func[0] ? ":" : "",
1057 " ", "code should not be reached", NULL);
1058 g_log (domain, G_LOG_LEVEL_WARNING, "%s", s);
1063 g_assert_warning (const char *log_domain,
1066 const char *pretty_function,
1067 const char *expression)
1072 ? "file %s: line %d (%s): assertion failed: (%s)"
1073 : "file %s: line %d (%s): should not be reached",
1082 * g_test_expect_message:
1083 * @log_domain: the log domain of the message
1084 * @log_level: the log level of the message
1085 * @pattern: a glob-style
1086 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
1088 * Indicates that a message with the given @log_domain and @log_level,
1089 * with text matching @pattern, is expected to be logged. When this
1090 * message is logged, it will not be printed, and the test case will
1093 * Use g_test_assert_expected_messages() to assert that all
1094 * previously-expected messages have been seen and suppressed.
1096 * You can call this multiple times in a row, if multiple messages are
1097 * expected as a result of a single call. (The messages must appear in
1098 * the same order as the calls to g_test_expect_message().)
1103 * /* g_main_context_push_thread_default() should fail if the
1104 * * context is already owned by another thread.
1106 * g_test_expect_message (G_LOG_DOMAIN,
1107 * G_LOG_LEVEL_CRITICAL,
1108 * "assertion*acquired_context*failed");
1109 * g_main_context_push_thread_default (bad_context);
1110 * g_test_assert_expected_messages ();
1113 * Note that you cannot use this to test g_error() messages, since
1114 * g_error() intentionally never returns even if the program doesn't
1115 * abort; use g_test_trap_subprocess() in this case.
1120 g_test_expect_message (const gchar *log_domain,
1121 GLogLevelFlags log_level,
1122 const gchar *pattern)
1124 GTestExpectedMessage *expected;
1126 g_return_if_fail (log_domain != NULL);
1127 g_return_if_fail (log_level != 0);
1128 g_return_if_fail (pattern != NULL);
1130 expected = g_new (GTestExpectedMessage, 1);
1131 expected->log_domain = g_strdup (log_domain);
1132 expected->log_level = log_level;
1133 expected->pattern = g_strdup (pattern);
1135 expected_messages = g_slist_append (expected_messages, expected);
1139 g_test_assert_expected_messages_internal (const char *domain,
1144 if (expected_messages)
1146 GTestExpectedMessage *expected;
1147 gchar level_prefix[STRING_BUFFER_SIZE];
1150 expected = expected_messages->data;
1152 mklevel_prefix (level_prefix, expected->log_level);
1153 message = g_strdup_printf ("Did not see expected message %s: %s",
1154 level_prefix, expected->pattern);
1155 g_assertion_message (domain, file, line, func, message);
1161 * g_test_assert_expected_messages:
1163 * Asserts that all messages previously indicated via
1164 * g_test_expect_message() have been seen and suppressed.
1170 _g_log_fallback_handler (const gchar *log_domain,
1171 GLogLevelFlags log_level,
1172 const gchar *message,
1173 gpointer unused_data)
1175 gchar level_prefix[STRING_BUFFER_SIZE];
1177 gchar pid_string[FORMAT_UNSIGNED_BUFSIZE];
1181 /* we cannot call _any_ GLib functions in this fallback handler,
1182 * which is why we skip UTF-8 conversion, etc.
1183 * since we either recursed or ran out of memory, we're in a pretty
1184 * pathologic situation anyways, what we can do is giving the
1185 * the process ID unconditionally however.
1188 fd = mklevel_prefix (level_prefix, log_level);
1190 message = "(NULL) message";
1193 format_unsigned (pid_string, getpid (), 10);
1197 write_string (fd, "\n");
1199 write_string (fd, "\n** ");
1202 write_string (fd, "(process:");
1203 write_string (fd, pid_string);
1204 write_string (fd, "): ");
1209 write_string (fd, log_domain);
1210 write_string (fd, "-");
1212 write_string (fd, level_prefix);
1213 write_string (fd, ": ");
1214 write_string (fd, message);
1218 escape_string (GString *string)
1220 const char *p = string->str;
1223 while (p < string->str + string->len)
1227 wc = g_utf8_get_char_validated (p, -1);
1228 if (wc == (gunichar)-1 || wc == (gunichar)-2)
1233 pos = p - string->str;
1235 /* Emit invalid UTF-8 as hex escapes
1237 tmp = g_strdup_printf ("\\x%02x", (guint)(guchar)*p);
1238 g_string_erase (string, pos, 1);
1239 g_string_insert (string, pos, tmp);
1241 p = string->str + (pos + 4); /* Skip over escape sequence */
1248 safe = *(p + 1) == '\n';
1252 safe = CHAR_IS_SAFE (wc);
1260 pos = p - string->str;
1262 /* Largest char we escape is 0x0a, so we don't have to worry
1263 * about 8-digit \Uxxxxyyyy
1265 tmp = g_strdup_printf ("\\u%04x", wc);
1266 g_string_erase (string, pos, g_utf8_next_char (p) - p);
1267 g_string_insert (string, pos, tmp);
1270 p = string->str + (pos + 6); /* Skip over escape sequence */
1273 p = g_utf8_next_char (p);
1278 * g_log_default_handler:
1279 * @log_domain: the log domain of the message
1280 * @log_level: the level of the message
1281 * @message: the message
1282 * @unused_data: data passed from g_log() which is unused
1284 * The default log handler set up by GLib; g_log_set_default_handler()
1285 * allows to install an alternate default log handler.
1286 * This is used if no log handler has been set for the particular log
1287 * domain and log level combination. It outputs the message to stderr
1288 * or stdout and if the log level is fatal it calls abort().
1290 * The behavior of this log handler can be influenced by a number of
1291 * environment variables:
1294 * <term><envar>G_MESSAGES_PREFIXED</envar></term>
1296 * A :-separated list of log levels for which messages should
1297 * be prefixed by the program name and PID of the aplication.
1301 * <term><envar>G_MESSAGES_DEBUG</envar></term>
1303 * A space-separated list of log domains for which debug and
1304 * informational messages are printed. By default these
1305 * messages are not printed.
1310 * stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL,
1311 * %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for
1315 g_log_default_handler (const gchar *log_domain,
1316 GLogLevelFlags log_level,
1317 const gchar *message,
1318 gpointer unused_data)
1320 gchar level_prefix[STRING_BUFFER_SIZE], *string;
1323 const gchar *domains;
1325 if ((log_level & DEFAULT_LEVELS) || (log_level >> G_LOG_LEVEL_USER_SHIFT))
1328 domains = g_getenv ("G_MESSAGES_DEBUG");
1329 if (((log_level & INFO_LEVELS) == 0) ||
1331 (strcmp (domains, "all") != 0 && (!log_domain || !strstr (domains, log_domain))))
1335 /* we can be called externally with recursion for whatever reason */
1336 if (log_level & G_LOG_FLAG_RECURSION)
1338 _g_log_fallback_handler (log_domain, log_level, message, unused_data);
1342 fd = mklevel_prefix (level_prefix, log_level);
1344 gstring = g_string_new (NULL);
1345 if (log_level & ALERT_LEVELS)
1346 g_string_append (gstring, "\n");
1348 g_string_append (gstring, "** ");
1350 if ((g_log_msg_prefix & (log_level & G_LOG_LEVEL_MASK)) == (log_level & G_LOG_LEVEL_MASK))
1352 const gchar *prg_name = g_get_prgname ();
1355 g_string_append_printf (gstring, "(process:%lu): ", (gulong)getpid ());
1357 g_string_append_printf (gstring, "(%s:%lu): ", prg_name, (gulong)getpid ());
1362 g_string_append (gstring, log_domain);
1363 g_string_append_c (gstring, '-');
1365 g_string_append (gstring, level_prefix);
1367 g_string_append (gstring, ": ");
1369 g_string_append (gstring, "(NULL) message");
1373 const gchar *charset;
1375 msg = g_string_new (message);
1376 escape_string (msg);
1378 if (g_get_charset (&charset))
1379 g_string_append (gstring, msg->str); /* charset is UTF-8 already */
1382 string = strdup_convert (msg->str, charset);
1383 g_string_append (gstring, string);
1387 g_string_free (msg, TRUE);
1389 g_string_append (gstring, "\n");
1391 string = g_string_free (gstring, FALSE);
1393 write_string (fd, string);
1398 * g_set_print_handler:
1399 * @func: the new print handler
1401 * Sets the print handler.
1403 * Any messages passed to g_print() will be output via
1404 * the new handler. The default handler simply outputs
1405 * the message to stdout. By providing your own handler
1406 * you can redirect the output, to a GTK+ widget or a
1407 * log file for example.
1409 * Returns: the old print handler
1412 g_set_print_handler (GPrintFunc func)
1414 GPrintFunc old_print_func;
1416 g_mutex_lock (&g_messages_lock);
1417 old_print_func = glib_print_func;
1418 glib_print_func = func;
1419 g_mutex_unlock (&g_messages_lock);
1421 return old_print_func;
1426 * @format: the message format. See the printf() documentation
1427 * @...: the parameters to insert into the format string
1429 * Outputs a formatted message via the print handler.
1430 * The default print handler simply outputs the message to stdout.
1432 * g_print() should not be used from within libraries for debugging
1433 * messages, since it may be redirected by applications to special
1434 * purpose message windows or even files. Instead, libraries should
1435 * use g_log(), or the convenience functions g_message(), g_warning()
1439 g_print (const gchar *format,
1444 GPrintFunc local_glib_print_func;
1446 g_return_if_fail (format != NULL);
1448 va_start (args, format);
1449 string = g_strdup_vprintf (format, args);
1452 g_mutex_lock (&g_messages_lock);
1453 local_glib_print_func = glib_print_func;
1454 g_mutex_unlock (&g_messages_lock);
1456 if (local_glib_print_func)
1457 local_glib_print_func (string);
1460 const gchar *charset;
1462 if (g_get_charset (&charset))
1463 fputs (string, stdout); /* charset is UTF-8 already */
1466 gchar *lstring = strdup_convert (string, charset);
1468 fputs (lstring, stdout);
1477 * g_set_printerr_handler:
1478 * @func: the new error message handler
1480 * Sets the handler for printing error messages.
1482 * Any messages passed to g_printerr() will be output via
1483 * the new handler. The default handler simply outputs the
1484 * message to stderr. By providing your own handler you can
1485 * redirect the output, to a GTK+ widget or a log file for
1488 * Returns: the old error message handler
1491 g_set_printerr_handler (GPrintFunc func)
1493 GPrintFunc old_printerr_func;
1495 g_mutex_lock (&g_messages_lock);
1496 old_printerr_func = glib_printerr_func;
1497 glib_printerr_func = func;
1498 g_mutex_unlock (&g_messages_lock);
1500 return old_printerr_func;
1505 * @format: the message format. See the printf() documentation
1506 * @...: the parameters to insert into the format string
1508 * Outputs a formatted message via the error message handler.
1509 * The default handler simply outputs the message to stderr.
1511 * g_printerr() should not be used from within libraries.
1512 * Instead g_log() should be used, or the convenience functions
1513 * g_message(), g_warning() and g_error().
1516 g_printerr (const gchar *format,
1521 GPrintFunc local_glib_printerr_func;
1523 g_return_if_fail (format != NULL);
1525 va_start (args, format);
1526 string = g_strdup_vprintf (format, args);
1529 g_mutex_lock (&g_messages_lock);
1530 local_glib_printerr_func = glib_printerr_func;
1531 g_mutex_unlock (&g_messages_lock);
1533 if (local_glib_printerr_func)
1534 local_glib_printerr_func (string);
1537 const gchar *charset;
1539 if (g_get_charset (&charset))
1540 fputs (string, stderr); /* charset is UTF-8 already */
1543 gchar *lstring = strdup_convert (string, charset);
1545 fputs (lstring, stderr);
1554 * g_printf_string_upper_bound:
1555 * @format: the format string. See the printf() documentation
1556 * @args: the parameters to be inserted into the format string
1558 * Calculates the maximum space needed to store the output
1559 * of the sprintf() function.
1561 * Returns: the maximum space needed to store the formatted string
1564 g_printf_string_upper_bound (const gchar *format,
1568 return _g_vsnprintf (&c, 1, format, args) + 1;
1572 _g_log_set_exit_on_fatal (void)
1574 exit_on_fatal = TRUE;