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.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 GLogFunc default_log_func = g_log_default_handler;
242 static gpointer default_log_data = NULL;
243 static GTestLogFatalFunc fatal_log_func = NULL;
244 static gpointer fatal_log_data;
246 /* --- functions --- */
248 # include <windows.h>
249 static gboolean win32_keep_fatal_message = FALSE;
251 /* This default message will usually be overwritten. */
252 /* Yes, a fixed size buffer is bad. So sue me. But g_error() is never
253 * called with huge strings, is it?
255 static gchar fatal_msg_buf[1000] = "Unspecified fatal error encountered, aborting.";
256 static gchar *fatal_msg_ptr = fatal_msg_buf;
264 if (win32_keep_fatal_message)
266 memcpy (fatal_msg_ptr, buf, len);
267 fatal_msg_ptr += len;
272 write (fd, buf, len);
276 #define write(fd, buf, len) dowrite(fd, buf, len)
281 write_string (int fd,
286 res = write (fd, string, strlen (string));
287 while (G_UNLIKELY (res == -1 && errno == EINTR));
291 g_log_find_domain_L (const gchar *log_domain)
293 register GLogDomain *domain;
295 domain = g_log_domains;
298 if (strcmp (domain->log_domain, log_domain) == 0)
300 domain = domain->next;
306 g_log_domain_new_L (const gchar *log_domain)
308 register GLogDomain *domain;
310 domain = g_new (GLogDomain, 1);
311 domain->log_domain = g_strdup (log_domain);
312 domain->fatal_mask = G_LOG_FATAL_MASK;
313 domain->handlers = NULL;
315 domain->next = g_log_domains;
316 g_log_domains = domain;
322 g_log_domain_check_free_L (GLogDomain *domain)
324 if (domain->fatal_mask == G_LOG_FATAL_MASK &&
325 domain->handlers == NULL)
327 register GLogDomain *last, *work;
331 work = g_log_domains;
337 last->next = domain->next;
339 g_log_domains = domain->next;
340 g_free (domain->log_domain);
351 g_log_domain_get_handler_L (GLogDomain *domain,
352 GLogLevelFlags log_level,
355 if (domain && log_level)
357 register GLogHandler *handler;
359 handler = domain->handlers;
362 if ((handler->log_level & log_level) == log_level)
364 *data = handler->data;
365 return handler->log_func;
367 handler = handler->next;
371 *data = default_log_data;
372 return default_log_func;
376 * g_log_set_always_fatal:
377 * @fatal_mask: the mask containing bits set for each level
378 * of error which is to be fatal
380 * Sets the message levels which are always fatal, in any log domain.
381 * When a message with any of these levels is logged the program terminates.
382 * You can only set the levels defined by GLib to be fatal.
383 * %G_LOG_LEVEL_ERROR is always fatal.
385 * You can also make some message levels fatal at runtime by setting
386 * the <envar>G_DEBUG</envar> environment variable (see
387 * <ulink url="glib-running.html">Running GLib Applications</ulink>).
389 * Returns: the old fatal mask
392 g_log_set_always_fatal (GLogLevelFlags fatal_mask)
394 GLogLevelFlags old_mask;
396 /* restrict the global mask to levels that are known to glib
397 * since this setting applies to all domains
399 fatal_mask &= (1 << G_LOG_LEVEL_USER_SHIFT) - 1;
400 /* force errors to be fatal */
401 fatal_mask |= G_LOG_LEVEL_ERROR;
402 /* remove bogus flag */
403 fatal_mask &= ~G_LOG_FLAG_FATAL;
405 g_mutex_lock (&g_messages_lock);
406 old_mask = g_log_always_fatal;
407 g_log_always_fatal = fatal_mask;
408 g_mutex_unlock (&g_messages_lock);
414 * g_log_set_fatal_mask:
415 * @log_domain: the log domain
416 * @fatal_mask: the new fatal mask
418 * Sets the log levels which are fatal in the given domain.
419 * %G_LOG_LEVEL_ERROR is always fatal.
421 * Returns: the old fatal mask for the log domain
424 g_log_set_fatal_mask (const gchar *log_domain,
425 GLogLevelFlags fatal_mask)
427 GLogLevelFlags old_flags;
428 register GLogDomain *domain;
433 /* force errors to be fatal */
434 fatal_mask |= G_LOG_LEVEL_ERROR;
435 /* remove bogus flag */
436 fatal_mask &= ~G_LOG_FLAG_FATAL;
438 g_mutex_lock (&g_messages_lock);
440 domain = g_log_find_domain_L (log_domain);
442 domain = g_log_domain_new_L (log_domain);
443 old_flags = domain->fatal_mask;
445 domain->fatal_mask = fatal_mask;
446 g_log_domain_check_free_L (domain);
448 g_mutex_unlock (&g_messages_lock);
455 * @log_domain: (allow-none): the log domain, or %NULL for the default ""
457 * @log_levels: the log levels to apply the log handler for.
458 * To handle fatal and recursive messages as well, combine
459 * the log levels with the #G_LOG_FLAG_FATAL and
460 * #G_LOG_FLAG_RECURSION bit flags.
461 * @log_func: the log handler function
462 * @user_data: data passed to the log handler
464 * Sets the log handler for a domain and a set of log levels.
465 * To handle fatal and recursive messages the @log_levels parameter
466 * must be combined with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION
469 * Note that since the #G_LOG_LEVEL_ERROR log level is always fatal, if
470 * you want to set a handler for this log level you must combine it with
474 * <title>Adding a log handler for all warning messages in the default
475 * (application) domain</title>
477 * g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
478 * | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
483 * <title>Adding a log handler for all critical messages from GTK+</title>
485 * g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL
486 * | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
491 * <title>Adding a log handler for <emphasis>all</emphasis> messages from
494 * g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL
495 * | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
499 * Returns: the id of the new handler
502 g_log_set_handler (const gchar *log_domain,
503 GLogLevelFlags log_levels,
507 static guint handler_id = 0;
509 GLogHandler *handler;
511 g_return_val_if_fail ((log_levels & G_LOG_LEVEL_MASK) != 0, 0);
512 g_return_val_if_fail (log_func != NULL, 0);
517 handler = g_new (GLogHandler, 1);
519 g_mutex_lock (&g_messages_lock);
521 domain = g_log_find_domain_L (log_domain);
523 domain = g_log_domain_new_L (log_domain);
525 handler->id = ++handler_id;
526 handler->log_level = log_levels;
527 handler->log_func = log_func;
528 handler->data = user_data;
529 handler->next = domain->handlers;
530 domain->handlers = handler;
532 g_mutex_unlock (&g_messages_lock);
538 * g_log_set_default_handler:
539 * @log_func: the log handler function
540 * @user_data: data passed to the log handler
542 * Installs a default log handler which is used if no
543 * log handler has been set for the particular log domain
544 * and log level combination. By default, GLib uses
545 * g_log_default_handler() as default log handler.
547 * Returns: the previous default log handler
552 g_log_set_default_handler (GLogFunc log_func,
555 GLogFunc old_log_func;
557 g_mutex_lock (&g_messages_lock);
558 old_log_func = default_log_func;
559 default_log_func = log_func;
560 default_log_data = user_data;
561 g_mutex_unlock (&g_messages_lock);
567 * g_test_log_set_fatal_handler:
568 * @log_func: the log handler function.
569 * @user_data: data passed to the log handler.
571 * Installs a non-error fatal log handler which can be
572 * used to decide whether log messages which are counted
573 * as fatal abort the program.
575 * The use case here is that you are running a test case
576 * that depends on particular libraries or circumstances
577 * and cannot prevent certain known critical or warning
578 * messages. So you install a handler that compares the
579 * domain and message to precisely not abort in such a case.
581 * Note that the handler is reset at the beginning of
582 * any test case, so you have to set it inside each test
583 * function which needs the special behavior.
585 * This handler has no effect on g_error messages.
590 g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
593 g_mutex_lock (&g_messages_lock);
594 fatal_log_func = log_func;
595 fatal_log_data = user_data;
596 g_mutex_unlock (&g_messages_lock);
600 * g_log_remove_handler:
601 * @log_domain: the log domain
602 * @handler_id: the id of the handler, which was returned
603 * in g_log_set_handler()
605 * Removes the log handler.
608 g_log_remove_handler (const gchar *log_domain,
611 register GLogDomain *domain;
613 g_return_if_fail (handler_id > 0);
618 g_mutex_lock (&g_messages_lock);
619 domain = g_log_find_domain_L (log_domain);
622 GLogHandler *work, *last;
625 work = domain->handlers;
628 if (work->id == handler_id)
631 last->next = work->next;
633 domain->handlers = work->next;
634 g_log_domain_check_free_L (domain);
635 g_mutex_unlock (&g_messages_lock);
643 g_mutex_unlock (&g_messages_lock);
644 g_warning ("%s: could not find handler with id `%d' for domain \"%s\"",
645 G_STRLOC, handler_id, log_domain);
648 #define CHAR_IS_SAFE(wc) (!((wc < 0x20 && wc != '\t' && wc != '\n' && wc != '\r') || \
650 (wc >= 0x80 && wc < 0xa0)))
653 strdup_convert (const gchar *string,
654 const gchar *charset)
656 if (!g_utf8_validate (string, -1, NULL))
658 GString *gstring = g_string_new ("[Invalid UTF-8] ");
661 for (p = (guchar *)string; *p; p++)
663 if (CHAR_IS_SAFE(*p) &&
664 !(*p == '\r' && *(p + 1) != '\n') &&
666 g_string_append_c (gstring, *p);
668 g_string_append_printf (gstring, "\\x%02x", (guint)(guchar)*p);
671 return g_string_free (gstring, FALSE);
677 gchar *result = g_convert_with_fallback (string, -1, charset, "UTF-8", "?", NULL, NULL, &err);
682 /* Not thread-safe, but doesn't matter if we print the warning twice
684 static gboolean warned = FALSE;
688 _g_fprintf (stderr, "GLib: Cannot convert message: %s\n", err->message);
692 return g_strdup (string);
697 /* For a radix of 8 we need at most 3 output bytes for 1 input
698 * byte. Additionally we might need up to 2 output bytes for the
699 * readix prefix and 1 byte for the trailing NULL.
701 #define FORMAT_UNSIGNED_BUFSIZE ((GLIB_SIZEOF_LONG * 3) + 3)
704 format_unsigned (gchar *buf,
712 /* we may not call _any_ GLib functions here (or macros like g_return_if_fail()) */
714 if (radix != 8 && radix != 10 && radix != 16)
747 /* Again we can't use g_assert; actually this check should _never_ fail. */
748 if (n > FORMAT_UNSIGNED_BUFSIZE - 3)
761 buf[i] = c + 'a' - 10;
768 /* string size big enough to hold level prefix */
769 #define STRING_BUFFER_SIZE (FORMAT_UNSIGNED_BUFSIZE + 32)
771 #define ALERT_LEVELS (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
773 /* these are emitted by the default log handler */
774 #define DEFAULT_LEVELS (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_MESSAGE)
775 /* these are filtered by G_MESSAGES_DEBUG by the default log handler */
776 #define INFO_LEVELS (G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG)
779 mklevel_prefix (gchar level_prefix[STRING_BUFFER_SIZE],
780 GLogLevelFlags log_level)
782 gboolean to_stdout = TRUE;
784 /* we may not call _any_ GLib functions here */
786 switch (log_level & G_LOG_LEVEL_MASK)
788 case G_LOG_LEVEL_ERROR:
789 strcpy (level_prefix, "ERROR");
792 case G_LOG_LEVEL_CRITICAL:
793 strcpy (level_prefix, "CRITICAL");
796 case G_LOG_LEVEL_WARNING:
797 strcpy (level_prefix, "WARNING");
800 case G_LOG_LEVEL_MESSAGE:
801 strcpy (level_prefix, "Message");
804 case G_LOG_LEVEL_INFO:
805 strcpy (level_prefix, "INFO");
807 case G_LOG_LEVEL_DEBUG:
808 strcpy (level_prefix, "DEBUG");
813 strcpy (level_prefix, "LOG-");
814 format_unsigned (level_prefix + 4, log_level & G_LOG_LEVEL_MASK, 16);
817 strcpy (level_prefix, "LOG");
820 if (log_level & G_LOG_FLAG_RECURSION)
821 strcat (level_prefix, " (recursed)");
822 if (log_level & ALERT_LEVELS)
823 strcat (level_prefix, " **");
826 if ((log_level & G_LOG_FLAG_FATAL) != 0 && !g_test_initialized ())
827 win32_keep_fatal_message = TRUE;
829 return to_stdout ? 1 : 2;
834 GLogLevelFlags log_level;
836 } GTestExpectedMessage;
838 static GSList *expected_messages = NULL;
842 * @log_domain: the log domain
843 * @log_level: the log level
844 * @format: the message format. See the printf() documentation
845 * @args: the parameters to insert into the format string
847 * Logs an error or debugging message.
849 * If the log level has been set as fatal, the abort()
850 * function is called to terminate the program.
853 g_logv (const gchar *log_domain,
854 GLogLevelFlags log_level,
858 gboolean was_fatal = (log_level & G_LOG_FLAG_FATAL) != 0;
859 gboolean was_recursion = (log_level & G_LOG_FLAG_RECURSION) != 0;
860 gchar buffer[1025], *msg, *msg_alloc = NULL;
863 log_level &= G_LOG_LEVEL_MASK;
867 if (log_level & G_LOG_FLAG_RECURSION)
869 /* we use a stack buffer of fixed size, since we're likely
870 * in an out-of-memory situation
872 gsize size G_GNUC_UNUSED;
874 size = _g_vsnprintf (buffer, 1024, format, args);
878 msg = msg_alloc = g_strdup_vprintf (format, args);
880 if (expected_messages)
882 GTestExpectedMessage *expected = expected_messages->data;
884 expected_messages = g_slist_delete_link (expected_messages,
886 if (strcmp (expected->log_domain, log_domain) == 0 &&
887 ((log_level & expected->log_level) == expected->log_level) &&
888 g_pattern_match_simple (expected->pattern, msg))
890 g_free (expected->log_domain);
891 g_free (expected->pattern);
898 gchar level_prefix[STRING_BUFFER_SIZE];
899 gchar *expected_message;
901 mklevel_prefix (level_prefix, expected->log_level);
902 expected_message = g_strdup_printf ("Did not see expected message %s: %s",
903 level_prefix, expected->pattern);
904 g_log_default_handler (log_domain, log_level, expected_message, NULL);
905 g_free (expected_message);
907 log_level |= G_LOG_FLAG_FATAL;
911 for (i = g_bit_nth_msf (log_level, -1); i >= 0; i = g_bit_nth_msf (log_level, i))
913 register GLogLevelFlags test_level;
916 if (log_level & test_level)
920 GLogLevelFlags domain_fatal_mask;
921 gpointer data = NULL;
922 gboolean masquerade_fatal = FALSE;
926 test_level |= G_LOG_FLAG_FATAL;
928 test_level |= G_LOG_FLAG_RECURSION;
930 /* check recursion and lookup handler */
931 g_mutex_lock (&g_messages_lock);
932 depth = GPOINTER_TO_UINT (g_private_get (&g_log_depth));
933 domain = g_log_find_domain_L (log_domain ? log_domain : "");
935 test_level |= G_LOG_FLAG_RECURSION;
937 domain_fatal_mask = domain ? domain->fatal_mask : G_LOG_FATAL_MASK;
938 if ((domain_fatal_mask | g_log_always_fatal) & test_level)
939 test_level |= G_LOG_FLAG_FATAL;
940 if (test_level & G_LOG_FLAG_RECURSION)
941 log_func = _g_log_fallback_handler;
943 log_func = g_log_domain_get_handler_L (domain, test_level, &data);
945 g_mutex_unlock (&g_messages_lock);
947 g_private_set (&g_log_depth, GUINT_TO_POINTER (depth));
949 log_func (log_domain, test_level, msg, data);
951 if ((test_level & G_LOG_FLAG_FATAL)
952 && !(test_level & G_LOG_LEVEL_ERROR))
954 masquerade_fatal = fatal_log_func
955 && !fatal_log_func (log_domain, test_level, msg, fatal_log_data);
958 if ((test_level & G_LOG_FLAG_FATAL) && !masquerade_fatal)
961 if (win32_keep_fatal_message)
963 gchar *locale_msg = g_locale_from_utf8 (fatal_msg_buf, -1, NULL, NULL, NULL);
965 MessageBox (NULL, locale_msg, NULL,
966 MB_ICONERROR|MB_SETFOREGROUND);
968 if (IsDebuggerPresent () && !(test_level & G_LOG_FLAG_RECURSION))
973 if (!(test_level & G_LOG_FLAG_RECURSION))
977 #endif /* !G_OS_WIN32 */
981 g_private_set (&g_log_depth, GUINT_TO_POINTER (depth));
990 * @log_domain: the log domain, usually #G_LOG_DOMAIN
991 * @log_level: the log level, either from #GLogLevelFlags
992 * or a user-defined level
993 * @format: the message format. See the printf() documentation
994 * @...: the parameters to insert into the format string
996 * Logs an error or debugging message.
998 * If the log level has been set as fatal, the abort()
999 * function is called to terminate the program.
1002 g_log (const gchar *log_domain,
1003 GLogLevelFlags log_level,
1004 const gchar *format,
1009 va_start (args, format);
1010 g_logv (log_domain, log_level, format, args);
1015 g_return_if_fail_warning (const char *log_domain,
1016 const char *pretty_function,
1017 const char *expression)
1020 G_LOG_LEVEL_CRITICAL,
1021 "%s: assertion `%s' failed",
1027 g_warn_message (const char *domain,
1031 const char *warnexpr)
1034 g_snprintf (lstr, 32, "%d", line);
1036 s = g_strconcat ("(", file, ":", lstr, "):",
1037 func, func[0] ? ":" : "",
1038 " runtime check failed: (", warnexpr, ")", NULL);
1040 s = g_strconcat ("(", file, ":", lstr, "):",
1041 func, func[0] ? ":" : "",
1042 " ", "code should not be reached", NULL);
1043 g_log (domain, G_LOG_LEVEL_WARNING, "%s", s);
1048 g_assert_warning (const char *log_domain,
1051 const char *pretty_function,
1052 const char *expression)
1057 ? "file %s: line %d (%s): assertion failed: (%s)"
1058 : "file %s: line %d (%s): should not be reached",
1067 * g_test_expect_message:
1068 * @log_domain: the log domain of the message
1069 * @log_level: the log level of the message
1070 * @pattern: a glob-style
1071 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
1073 * Indicates that a message with the given @log_domain and @log_level,
1074 * with text matching @pattern, is expected to be logged. When this
1075 * message is logged, it will not be printed, and the test case will
1078 * Use g_test_assert_expected_messages() to assert that all
1079 * previously-expected messages have been seen and suppressed.
1081 * You can call this multiple times in a row, if multiple messages are
1082 * expected as a result of a single call. (The messages must appear in
1083 * the same order as the calls to g_test_expect_message().)
1088 * /* g_main_context_push_thread_default() should fail if the
1089 * * context is already owned by another thread.
1091 * g_test_expect_message (G_LOG_DOMAIN,
1092 * G_LOG_LEVEL_CRITICAL,
1093 * "assertion*acquired_context*failed");
1094 * g_main_context_push_thread_default (bad_context);
1095 * g_test_assert_expected_messages ();
1098 * Note that you cannot use this to test g_error() messages, since
1099 * g_error() intentionally never returns even if the program doesn't
1100 * abort; use g_test_trap_subprocess() in this case.
1105 g_test_expect_message (const gchar *log_domain,
1106 GLogLevelFlags log_level,
1107 const gchar *pattern)
1109 GTestExpectedMessage *expected;
1111 g_return_if_fail (log_domain != NULL);
1112 g_return_if_fail (log_level != 0);
1113 g_return_if_fail (pattern != NULL);
1115 expected = g_new (GTestExpectedMessage, 1);
1116 expected->log_domain = g_strdup (log_domain);
1117 expected->log_level = log_level;
1118 expected->pattern = g_strdup (pattern);
1120 expected_messages = g_slist_append (expected_messages, expected);
1124 g_test_assert_expected_messages_internal (const char *domain,
1129 if (expected_messages)
1131 GTestExpectedMessage *expected;
1132 gchar level_prefix[STRING_BUFFER_SIZE];
1135 expected = expected_messages->data;
1137 mklevel_prefix (level_prefix, expected->log_level);
1138 message = g_strdup_printf ("Did not see expected message %s: %s",
1139 level_prefix, expected->pattern);
1140 g_assertion_message (domain, file, line, func, message);
1146 * g_test_assert_expected_messages:
1148 * Asserts that all messages previously indicated via
1149 * g_test_expect_message() have been seen and suppressed.
1155 _g_log_fallback_handler (const gchar *log_domain,
1156 GLogLevelFlags log_level,
1157 const gchar *message,
1158 gpointer unused_data)
1160 gchar level_prefix[STRING_BUFFER_SIZE];
1162 gchar pid_string[FORMAT_UNSIGNED_BUFSIZE];
1166 /* we cannot call _any_ GLib functions in this fallback handler,
1167 * which is why we skip UTF-8 conversion, etc.
1168 * since we either recursed or ran out of memory, we're in a pretty
1169 * pathologic situation anyways, what we can do is giving the
1170 * the process ID unconditionally however.
1173 fd = mklevel_prefix (level_prefix, log_level);
1175 message = "(NULL) message";
1178 format_unsigned (pid_string, getpid (), 10);
1182 write_string (fd, "\n");
1184 write_string (fd, "\n** ");
1187 write_string (fd, "(process:");
1188 write_string (fd, pid_string);
1189 write_string (fd, "): ");
1194 write_string (fd, log_domain);
1195 write_string (fd, "-");
1197 write_string (fd, level_prefix);
1198 write_string (fd, ": ");
1199 write_string (fd, message);
1203 escape_string (GString *string)
1205 const char *p = string->str;
1208 while (p < string->str + string->len)
1212 wc = g_utf8_get_char_validated (p, -1);
1213 if (wc == (gunichar)-1 || wc == (gunichar)-2)
1218 pos = p - string->str;
1220 /* Emit invalid UTF-8 as hex escapes
1222 tmp = g_strdup_printf ("\\x%02x", (guint)(guchar)*p);
1223 g_string_erase (string, pos, 1);
1224 g_string_insert (string, pos, tmp);
1226 p = string->str + (pos + 4); /* Skip over escape sequence */
1233 safe = *(p + 1) == '\n';
1237 safe = CHAR_IS_SAFE (wc);
1245 pos = p - string->str;
1247 /* Largest char we escape is 0x0a, so we don't have to worry
1248 * about 8-digit \Uxxxxyyyy
1250 tmp = g_strdup_printf ("\\u%04x", wc);
1251 g_string_erase (string, pos, g_utf8_next_char (p) - p);
1252 g_string_insert (string, pos, tmp);
1255 p = string->str + (pos + 6); /* Skip over escape sequence */
1258 p = g_utf8_next_char (p);
1263 * g_log_default_handler:
1264 * @log_domain: the log domain of the message
1265 * @log_level: the level of the message
1266 * @message: the message
1267 * @unused_data: data passed from g_log() which is unused
1269 * The default log handler set up by GLib; g_log_set_default_handler()
1270 * allows to install an alternate default log handler.
1271 * This is used if no log handler has been set for the particular log
1272 * domain and log level combination. It outputs the message to stderr
1273 * or stdout and if the log level is fatal it calls abort().
1275 * The behavior of this log handler can be influenced by a number of
1276 * environment variables:
1279 * <term><envar>G_MESSAGES_PREFIXED</envar></term>
1281 * A :-separated list of log levels for which messages should
1282 * be prefixed by the program name and PID of the aplication.
1286 * <term><envar>G_MESSAGES_DEBUG</envar></term>
1288 * A space-separated list of log domains for which debug and
1289 * informational messages are printed. By default these
1290 * messages are not printed.
1295 * stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL,
1296 * %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for
1300 g_log_default_handler (const gchar *log_domain,
1301 GLogLevelFlags log_level,
1302 const gchar *message,
1303 gpointer unused_data)
1305 gchar level_prefix[STRING_BUFFER_SIZE], *string;
1308 const gchar *domains;
1310 if ((log_level & DEFAULT_LEVELS) || (log_level >> G_LOG_LEVEL_USER_SHIFT))
1313 domains = g_getenv ("G_MESSAGES_DEBUG");
1314 if (((log_level & INFO_LEVELS) == 0) ||
1316 (strcmp (domains, "all") != 0 && (!log_domain || !strstr (domains, log_domain))))
1320 /* we can be called externally with recursion for whatever reason */
1321 if (log_level & G_LOG_FLAG_RECURSION)
1323 _g_log_fallback_handler (log_domain, log_level, message, unused_data);
1327 fd = mklevel_prefix (level_prefix, log_level);
1329 gstring = g_string_new (NULL);
1330 if (log_level & ALERT_LEVELS)
1331 g_string_append (gstring, "\n");
1333 g_string_append (gstring, "** ");
1335 if ((g_log_msg_prefix & (log_level & G_LOG_LEVEL_MASK)) == (log_level & G_LOG_LEVEL_MASK))
1337 const gchar *prg_name = g_get_prgname ();
1340 g_string_append_printf (gstring, "(process:%lu): ", (gulong)getpid ());
1342 g_string_append_printf (gstring, "(%s:%lu): ", prg_name, (gulong)getpid ());
1347 g_string_append (gstring, log_domain);
1348 g_string_append_c (gstring, '-');
1350 g_string_append (gstring, level_prefix);
1352 g_string_append (gstring, ": ");
1354 g_string_append (gstring, "(NULL) message");
1358 const gchar *charset;
1360 msg = g_string_new (message);
1361 escape_string (msg);
1363 if (g_get_charset (&charset))
1364 g_string_append (gstring, msg->str); /* charset is UTF-8 already */
1367 string = strdup_convert (msg->str, charset);
1368 g_string_append (gstring, string);
1372 g_string_free (msg, TRUE);
1374 g_string_append (gstring, "\n");
1376 string = g_string_free (gstring, FALSE);
1378 write_string (fd, string);
1383 * g_set_print_handler:
1384 * @func: the new print handler
1386 * Sets the print handler.
1388 * Any messages passed to g_print() will be output via
1389 * the new handler. The default handler simply outputs
1390 * the message to stdout. By providing your own handler
1391 * you can redirect the output, to a GTK+ widget or a
1392 * log file for example.
1394 * Returns: the old print handler
1397 g_set_print_handler (GPrintFunc func)
1399 GPrintFunc old_print_func;
1401 g_mutex_lock (&g_messages_lock);
1402 old_print_func = glib_print_func;
1403 glib_print_func = func;
1404 g_mutex_unlock (&g_messages_lock);
1406 return old_print_func;
1411 * @format: the message format. See the printf() documentation
1412 * @...: the parameters to insert into the format string
1414 * Outputs a formatted message via the print handler.
1415 * The default print handler simply outputs the message to stdout.
1417 * g_print() should not be used from within libraries for debugging
1418 * messages, since it may be redirected by applications to special
1419 * purpose message windows or even files. Instead, libraries should
1420 * use g_log(), or the convenience functions g_message(), g_warning()
1424 g_print (const gchar *format,
1429 GPrintFunc local_glib_print_func;
1431 g_return_if_fail (format != NULL);
1433 va_start (args, format);
1434 string = g_strdup_vprintf (format, args);
1437 g_mutex_lock (&g_messages_lock);
1438 local_glib_print_func = glib_print_func;
1439 g_mutex_unlock (&g_messages_lock);
1441 if (local_glib_print_func)
1442 local_glib_print_func (string);
1445 const gchar *charset;
1447 if (g_get_charset (&charset))
1448 fputs (string, stdout); /* charset is UTF-8 already */
1451 gchar *lstring = strdup_convert (string, charset);
1453 fputs (lstring, stdout);
1462 * g_set_printerr_handler:
1463 * @func: the new error message handler
1465 * Sets the handler for printing error messages.
1467 * Any messages passed to g_printerr() will be output via
1468 * the new handler. The default handler simply outputs the
1469 * message to stderr. By providing your own handler you can
1470 * redirect the output, to a GTK+ widget or a log file for
1473 * Returns: the old error message handler
1476 g_set_printerr_handler (GPrintFunc func)
1478 GPrintFunc old_printerr_func;
1480 g_mutex_lock (&g_messages_lock);
1481 old_printerr_func = glib_printerr_func;
1482 glib_printerr_func = func;
1483 g_mutex_unlock (&g_messages_lock);
1485 return old_printerr_func;
1490 * @format: the message format. See the printf() documentation
1491 * @...: the parameters to insert into the format string
1493 * Outputs a formatted message via the error message handler.
1494 * The default handler simply outputs the message to stderr.
1496 * g_printerr() should not be used from within libraries.
1497 * Instead g_log() should be used, or the convenience functions
1498 * g_message(), g_warning() and g_error().
1501 g_printerr (const gchar *format,
1506 GPrintFunc local_glib_printerr_func;
1508 g_return_if_fail (format != NULL);
1510 va_start (args, format);
1511 string = g_strdup_vprintf (format, args);
1514 g_mutex_lock (&g_messages_lock);
1515 local_glib_printerr_func = glib_printerr_func;
1516 g_mutex_unlock (&g_messages_lock);
1518 if (local_glib_printerr_func)
1519 local_glib_printerr_func (string);
1522 const gchar *charset;
1524 if (g_get_charset (&charset))
1525 fputs (string, stderr); /* charset is UTF-8 already */
1528 gchar *lstring = strdup_convert (string, charset);
1530 fputs (lstring, stderr);
1539 * g_printf_string_upper_bound:
1540 * @format: the format string. See the printf() documentation
1541 * @args: the parameters to be inserted into the format string
1543 * Calculates the maximum space needed to store the output
1544 * of the sprintf() function.
1546 * Returns: the maximum space needed to store the formatted string
1549 g_printf_string_upper_bound (const gchar *format,
1553 return _g_vsnprintf (&c, 1, format, args) + 1;