/* GLIB - Library of useful routines for C programming * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ /* * Modified by the GLib Team and others 1997-2000. See the AUTHORS * file for a list of people on the GLib Team. See the ChangeLog * files for a list of changes. These files are distributed with * GLib at ftp://ftp.gtk.org/pub/gtk/. */ /* * MT safe */ #include "config.h" #include #include #include #include #ifdef HAVE_UNISTD_H #include #endif #include #include #include #include "glib.h" #include "gdebug.h" #include "gprintfint.h" #include "gthreadinit.h" #ifdef G_OS_WIN32 #include typedef FILE* GFileDescriptor; #else typedef gint GFileDescriptor; #endif /* --- structures --- */ typedef struct _GLogDomain GLogDomain; typedef struct _GLogHandler GLogHandler; struct _GLogDomain { gchar *log_domain; GLogLevelFlags fatal_mask; GLogHandler *handlers; GLogDomain *next; }; struct _GLogHandler { guint id; GLogLevelFlags log_level; GLogFunc log_func; gpointer data; GLogHandler *next; }; /* --- variables --- */ static GMutex *g_messages_lock = NULL; static GLogDomain *g_log_domains = NULL; static GLogLevelFlags g_log_always_fatal = G_LOG_FATAL_MASK; static GPrintFunc glib_print_func = NULL; static GPrintFunc glib_printerr_func = NULL; static GPrivate *g_log_depth = NULL; static GLogLevelFlags g_log_msg_prefix = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_DEBUG; /* --- functions --- */ #ifdef G_OS_WIN32 # define STRICT # include # undef STRICT # include /* For _getpid() */ static gboolean win32_keep_fatal_message = FALSE; /* This default message will usually be overwritten. */ /* Yes, a fixed size buffer is bad. So sue me. But g_error is never * with huge strings, is it? */ static gchar fatal_msg_buf[1000] = "Unspecified fatal error encountered, aborting."; static gchar *fatal_msg_ptr = fatal_msg_buf; /* Just use stdio. If we're out of memory, we're hosed anyway. */ #undef write static inline int dowrite (GFileDescriptor fd, const void *buf, unsigned int len) { if (win32_keep_fatal_message) { memcpy (fatal_msg_ptr, buf, len); fatal_msg_ptr += len; *fatal_msg_ptr = 0; return len; } fwrite (buf, len, 1, fd); fflush (fd); return len; } #define write(fd, buf, len) dowrite(fd, buf, len) static void ensure_stdout_valid (void) { static gboolean alloc_console_called = FALSE; HANDLE handle; if (win32_keep_fatal_message) return; if (!alloc_console_called) { handle = (HANDLE) _get_osfhandle (fileno (stdout)); if (handle == INVALID_HANDLE_VALUE) { AllocConsole (); alloc_console_called = TRUE; freopen ("CONOUT$", "w", stdout); } } } static void ensure_stderr_valid (void) { static gboolean alloc_console_called = FALSE; HANDLE handle; if (win32_keep_fatal_message) return; if (!alloc_console_called) { handle = (HANDLE) _get_osfhandle (fileno (stderr)); if (handle == INVALID_HANDLE_VALUE) { AllocConsole (); alloc_console_called = TRUE; freopen ("CONOUT$", "w", stderr); } } } #else #define ensure_stdout_valid() /* Define as empty */ #define ensure_stderr_valid() #endif static void write_string (GFileDescriptor fd, const gchar *string) { write (fd, string, strlen (string)); } static void g_messages_prefixed_init (void) { static gboolean initialized = FALSE; if (!initialized) { const gchar *val; initialized = TRUE; val = g_getenv ("G_MESSAGES_PREFIXED"); if (val) { static const GDebugKey keys[] = { { "error", G_LOG_LEVEL_ERROR }, { "critical", G_LOG_LEVEL_CRITICAL }, { "warning", G_LOG_LEVEL_WARNING }, { "message", G_LOG_LEVEL_MESSAGE }, { "info", G_LOG_LEVEL_INFO }, { "debug", G_LOG_LEVEL_DEBUG } }; g_log_msg_prefix = g_parse_debug_string (val, keys, G_N_ELEMENTS (keys)); } } } static GLogDomain* g_log_find_domain_L (const gchar *log_domain) { register GLogDomain *domain; domain = g_log_domains; while (domain) { if (strcmp (domain->log_domain, log_domain) == 0) return domain; domain = domain->next; } return NULL; } static GLogDomain* g_log_domain_new_L (const gchar *log_domain) { register GLogDomain *domain; domain = g_new (GLogDomain, 1); domain->log_domain = g_strdup (log_domain); domain->fatal_mask = G_LOG_FATAL_MASK; domain->handlers = NULL; domain->next = g_log_domains; g_log_domains = domain; return domain; } static void g_log_domain_check_free_L (GLogDomain *domain) { if (domain->fatal_mask == G_LOG_FATAL_MASK && domain->handlers == NULL) { register GLogDomain *last, *work; last = NULL; work = g_log_domains; while (work) { if (work == domain) { if (last) last->next = domain->next; else g_log_domains = domain->next; g_free (domain->log_domain); g_free (domain); break; } last = work; work = last->next; } } } static GLogFunc g_log_domain_get_handler_L (GLogDomain *domain, GLogLevelFlags log_level, gpointer *data) { if (domain && log_level) { register GLogHandler *handler; handler = domain->handlers; while (handler) { if ((handler->log_level & log_level) == log_level) { *data = handler->data; return handler->log_func; } handler = handler->next; } } return g_log_default_handler; } GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask) { GLogLevelFlags old_mask; /* restrict the global mask to levels that are known to glib * since this setting applies to all domains */ fatal_mask &= (1 << G_LOG_LEVEL_USER_SHIFT) - 1; /* force errors to be fatal */ fatal_mask |= G_LOG_LEVEL_ERROR; /* remove bogus flag */ fatal_mask &= ~G_LOG_FLAG_FATAL; g_mutex_lock (g_messages_lock); old_mask = g_log_always_fatal; g_log_always_fatal = fatal_mask; g_mutex_unlock (g_messages_lock); return old_mask; } GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain, GLogLevelFlags fatal_mask) { GLogLevelFlags old_flags; register GLogDomain *domain; if (!log_domain) log_domain = ""; /* force errors to be fatal */ fatal_mask |= G_LOG_LEVEL_ERROR; /* remove bogus flag */ fatal_mask &= ~G_LOG_FLAG_FATAL; g_mutex_lock (g_messages_lock); domain = g_log_find_domain_L (log_domain); if (!domain) domain = g_log_domain_new_L (log_domain); old_flags = domain->fatal_mask; domain->fatal_mask = fatal_mask; g_log_domain_check_free_L (domain); g_mutex_unlock (g_messages_lock); return old_flags; } guint g_log_set_handler (const gchar *log_domain, GLogLevelFlags log_levels, GLogFunc log_func, gpointer user_data) { static guint handler_id = 0; GLogDomain *domain; GLogHandler *handler; g_return_val_if_fail ((log_levels & G_LOG_LEVEL_MASK) != 0, 0); g_return_val_if_fail (log_func != NULL, 0); if (!log_domain) log_domain = ""; handler = g_new (GLogHandler, 1); g_mutex_lock (g_messages_lock); domain = g_log_find_domain_L (log_domain); if (!domain) domain = g_log_domain_new_L (log_domain); handler->id = ++handler_id; handler->log_level = log_levels; handler->log_func = log_func; handler->data = user_data; handler->next = domain->handlers; domain->handlers = handler; g_mutex_unlock (g_messages_lock); return handler_id; } void g_log_remove_handler (const gchar *log_domain, guint handler_id) { register GLogDomain *domain; g_return_if_fail (handler_id > 0); if (!log_domain) log_domain = ""; g_mutex_lock (g_messages_lock); domain = g_log_find_domain_L (log_domain); if (domain) { GLogHandler *work, *last; last = NULL; work = domain->handlers; while (work) { if (work->id == handler_id) { if (last) last->next = work->next; else domain->handlers = work->next; g_log_domain_check_free_L (domain); g_mutex_unlock (g_messages_lock); g_free (work); return; } last = work; work = last->next; } } g_mutex_unlock (g_messages_lock); g_warning ("%s: could not find handler with id `%d' for domain \"%s\"", G_STRLOC, handler_id, log_domain); } void g_logv (const gchar *log_domain, GLogLevelFlags log_level, const gchar *format, va_list args1) { gboolean was_fatal = (log_level & G_LOG_FLAG_FATAL) != 0; gboolean was_recursion = (log_level & G_LOG_FLAG_RECURSION) != 0; gint i; log_level &= G_LOG_LEVEL_MASK; if (!log_level) return; for (i = g_bit_nth_msf (log_level, -1); i >= 0; i = g_bit_nth_msf (log_level, i)) { register GLogLevelFlags test_level; test_level = 1 << i; if (log_level & test_level) { guint depth = GPOINTER_TO_UINT (g_private_get (g_log_depth)); GLogDomain *domain; GLogFunc log_func; guint domain_fatal_mask; gpointer data = NULL; if (was_fatal) test_level |= G_LOG_FLAG_FATAL; if (was_recursion) test_level |= G_LOG_FLAG_RECURSION; /* check recursion and lookup handler */ g_mutex_lock (g_messages_lock); domain = g_log_find_domain_L (log_domain ? log_domain : ""); if (depth) test_level |= G_LOG_FLAG_RECURSION; depth++; domain_fatal_mask = domain ? domain->fatal_mask : G_LOG_FATAL_MASK; if ((domain_fatal_mask | g_log_always_fatal) & test_level) test_level |= G_LOG_FLAG_FATAL; if (test_level & G_LOG_FLAG_RECURSION) log_func = _g_log_fallback_handler; else log_func = g_log_domain_get_handler_L (domain, test_level, &data); domain = NULL; g_mutex_unlock (g_messages_lock); g_private_set (g_log_depth, GUINT_TO_POINTER (depth)); /* had to defer debug initialization until we can keep track of recursion */ if (!(test_level & G_LOG_FLAG_RECURSION) && !_g_debug_initialized) { guint orig_test_level = test_level; _g_debug_init (); if ((domain_fatal_mask | g_log_always_fatal) & test_level) test_level |= G_LOG_FLAG_FATAL; if (test_level != orig_test_level) { /* need a relookup, not nice, but not too bad either */ g_mutex_lock (g_messages_lock); domain = g_log_find_domain_L (log_domain ? log_domain : ""); log_func = g_log_domain_get_handler_L (domain, test_level, &data); domain = NULL; g_mutex_unlock (g_messages_lock); } } if (test_level & G_LOG_FLAG_RECURSION) { /* we use a stack buffer of fixed size, since we're likely * in an out-of-memory situation */ gchar buffer[1025]; gint size; size = _g_vsnprintf (buffer, 1024, format, args1); log_func (log_domain, test_level, buffer, data); } else { gchar *msg = g_strdup_vprintf (format, args1); log_func (log_domain, test_level, msg, data); g_free (msg); } if (test_level & G_LOG_FLAG_FATAL) { #ifdef G_OS_WIN32 gchar *locale_msg = g_locale_from_utf8 (fatal_msg_buf, -1, NULL, NULL, NULL); MessageBox (NULL, locale_msg, NULL, MB_ICONERROR|MB_SETFOREGROUND); #endif #if defined (G_ENABLE_DEBUG) && (defined (SIGTRAP) || defined (G_OS_WIN32)) if (!(test_level & G_LOG_FLAG_RECURSION)) G_BREAKPOINT (); else abort (); #else /* !G_ENABLE_DEBUG || !(SIGTRAP || G_OS_WIN32) */ abort (); #endif /* !G_ENABLE_DEBUG || !(SIGTRAP || G_OS_WIN32) */ } depth--; g_private_set (g_log_depth, GUINT_TO_POINTER (depth)); } } } void g_log (const gchar *log_domain, GLogLevelFlags log_level, const gchar *format, ...) { va_list args; va_start (args, format); g_logv (log_domain, log_level, format, args); va_end (args); } #define CHAR_IS_SAFE(wc) (!((wc < 0x20 && wc != '\t' && wc != '\n' && wc != '\r') || \ (wc == 0x7f) || \ (wc >= 0x80 && wc < 0xa0))) static gchar* strdup_convert (const gchar *string, const gchar *charset) { if (!g_utf8_validate (string, -1, NULL)) { GString *gstring = g_string_new ("[Invalid UTF-8] "); guchar *p; for (p = (guchar *)string; *p; p++) { if (CHAR_IS_SAFE(*p) && !(*p == '\r' && *(p + 1) != '\n') && *p < 0x80) g_string_append_c (gstring, *p); else g_string_append_printf (gstring, "\\%03o", *p); } return g_string_free (gstring, FALSE); } else { GError *err = NULL; gchar *result = g_convert_with_fallback (string, -1, charset, "UTF-8", "?", NULL, NULL, &err); if (result) return result; else { /* Not thread-safe, but doesn't matter if we print the warning twice */ static gboolean warned = FALSE; if (!warned) { warned = TRUE; ensure_stderr_valid (); _g_fprintf (stderr, "GLib: Cannot convert message: %s\n", err->message); } g_error_free (err); return g_strdup (string); } } } /* For a radix of 8 we need at most 3 output bytes for 1 input * byte. Additionally we might need up to 2 output bytes for the * readix prefix and 1 byte for the trailing NULL. */ #define FORMAT_UNSIGNED_BUFSIZE ((GLIB_SIZEOF_LONG * 3) + 3) static void format_unsigned (gchar *buf, gulong num, guint radix) { gulong tmp; gchar c; gint i, n; /* we may not call _any_ GLib functions here (or macros like g_return_if_fail()) */ if (radix != 8 && radix != 10 && radix != 16) { *buf = '\000'; return; } if (!num) { *buf++ = '0'; *buf = '\000'; return; } if (radix == 16) { *buf++ = '0'; *buf++ = 'x'; } else if (radix == 8) { *buf++ = '0'; } n = 0; tmp = num; while (tmp) { tmp /= radix; n++; } i = n; /* Again we can't use g_assert; actually this check should _never_ fail. */ if (n > FORMAT_UNSIGNED_BUFSIZE - 3) { *buf = '\000'; return; } while (num) { i--; c = (num % radix); if (c < 10) buf[i] = c + '0'; else buf[i] = c + 'a' - 10; num /= radix; } buf[n] = '\000'; } /* string size big enough to hold level prefix */ #define STRING_BUFFER_SIZE (FORMAT_UNSIGNED_BUFSIZE + 32) #define ALERT_LEVELS (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING) static GFileDescriptor mklevel_prefix (gchar level_prefix[STRING_BUFFER_SIZE], guint log_level) { gboolean to_stdout = TRUE; /* we may not call _any_ GLib functions here */ switch (log_level & G_LOG_LEVEL_MASK) { case G_LOG_LEVEL_ERROR: strcpy (level_prefix, "ERROR"); to_stdout = FALSE; break; case G_LOG_LEVEL_CRITICAL: strcpy (level_prefix, "CRITICAL"); to_stdout = FALSE; break; case G_LOG_LEVEL_WARNING: strcpy (level_prefix, "WARNING"); to_stdout = FALSE; break; case G_LOG_LEVEL_MESSAGE: strcpy (level_prefix, "Message"); to_stdout = FALSE; break; case G_LOG_LEVEL_INFO: strcpy (level_prefix, "INFO"); break; case G_LOG_LEVEL_DEBUG: strcpy (level_prefix, "DEBUG"); break; default: if (log_level) { strcpy (level_prefix, "LOG-"); format_unsigned (level_prefix + 4, log_level & G_LOG_LEVEL_MASK, 16); } else strcpy (level_prefix, "LOG"); break; } if (log_level & G_LOG_FLAG_RECURSION) strcat (level_prefix, " (recursed)"); if (log_level & ALERT_LEVELS) strcat (level_prefix, " **"); #ifdef G_OS_WIN32 win32_keep_fatal_message = (log_level & G_LOG_FLAG_FATAL) != 0; if (to_stdout) { ensure_stdout_valid (); return stdout; } else { ensure_stderr_valid (); return stderr; } #else return to_stdout ? 1 : 2; #endif } void _g_log_fallback_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer unused_data) { gchar level_prefix[STRING_BUFFER_SIZE], pid_string[FORMAT_UNSIGNED_BUFSIZE]; gboolean is_fatal = (log_level & G_LOG_FLAG_FATAL) != 0; GFileDescriptor fd; /* we can not call _any_ GLib functions in this fallback handler, * which is why we skip UTF-8 conversion, etc. * since we either recursed or ran out of memory, we're in a pretty * pathologic situation anyways, what we can do is giving the * the process ID unconditionally however. */ fd = mklevel_prefix (level_prefix, log_level); if (!message) message = "(NULL) message"; format_unsigned (pid_string, getpid (), 10); if (log_domain) write_string (fd, "\n"); else write_string (fd, "\n** "); write_string (fd, "(process:"); write_string (fd, pid_string); write_string (fd, "): "); if (log_domain) { write_string (fd, log_domain); write_string (fd, "-"); } write_string (fd, level_prefix); write_string (fd, ": "); write_string (fd, message); if (is_fatal) write_string (fd, "\naborting...\n"); else write_string (fd, "\n"); } static void escape_string (GString *string) { const char *p = string->str; gunichar wc; while (p < string->str + string->len) { gboolean safe; wc = g_utf8_get_char (p); if (wc == '\r') { safe = *(p + 1) == '\n'; } else { safe = CHAR_IS_SAFE (wc); } if (!safe) { gchar *tmp; g_string_erase (string, p - string->str, g_utf8_next_char (p) - p); /* Largest char we escape is 0x0a, so we don't have to worry * about 8-digit \Uxxxxyyyy */ tmp = g_strdup_printf ("\\u%04x", wc); g_string_insert (string, p - string->str, tmp); g_free (tmp); p += 6; /* Skip over escape sequence */ } else p = g_utf8_next_char (p); } } void g_log_default_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer unused_data) { gboolean is_fatal = (log_level & G_LOG_FLAG_FATAL) != 0; gchar level_prefix[STRING_BUFFER_SIZE], *string; GString *gstring; GFileDescriptor fd; /* we can be called externally with recursion for whatever reason */ if (log_level & G_LOG_FLAG_RECURSION) { _g_log_fallback_handler (log_domain, log_level, message, unused_data); return; } g_messages_prefixed_init (); fd = mklevel_prefix (level_prefix, log_level); gstring = g_string_new (NULL); if (log_level & ALERT_LEVELS) g_string_append (gstring, "\n"); if (!log_domain) g_string_append (gstring, "** "); if ((g_log_msg_prefix & log_level) == log_level) { const gchar *prg_name = g_get_prgname (); if (!prg_name) g_string_append_printf (gstring, "(process:%lu): ", (gulong)getpid ()); else g_string_append_printf (gstring, "(%s:%lu): ", prg_name, (gulong)getpid ()); } if (log_domain) { g_string_append (gstring, log_domain); g_string_append_c (gstring, '-'); } g_string_append (gstring, level_prefix); g_string_append (gstring, ": "); if (!message) g_string_append (gstring, "(NULL) message"); else { const gchar *charset; if (g_get_charset (&charset)) g_string_append (gstring, message); /* charset is UTF-8 already */ else { string = strdup_convert (message, charset); g_string_append (gstring, string); g_free (string); } escape_string (gstring); } if (is_fatal) g_string_append (gstring, "\naborting...\n"); else g_string_append (gstring, "\n"); string = g_string_free (gstring, FALSE); write_string (fd, string); g_free (string); } GPrintFunc g_set_print_handler (GPrintFunc func) { GPrintFunc old_print_func; g_mutex_lock (g_messages_lock); old_print_func = glib_print_func; glib_print_func = func; g_mutex_unlock (g_messages_lock); return old_print_func; } void g_print (const gchar *format, ...) { va_list args; gchar *string; GPrintFunc local_glib_print_func; g_return_if_fail (format != NULL); va_start (args, format); string = g_strdup_vprintf (format, args); va_end (args); g_mutex_lock (g_messages_lock); local_glib_print_func = glib_print_func; g_mutex_unlock (g_messages_lock); if (local_glib_print_func) local_glib_print_func (string); else { const gchar *charset; ensure_stdout_valid (); if (g_get_charset (&charset)) fputs (string, stdout); /* charset is UTF-8 already */ else { gchar *lstring = strdup_convert (string, charset); fputs (lstring, stdout); g_free (lstring); } fflush (stdout); } g_free (string); } GPrintFunc g_set_printerr_handler (GPrintFunc func) { GPrintFunc old_printerr_func; g_mutex_lock (g_messages_lock); old_printerr_func = glib_printerr_func; glib_printerr_func = func; g_mutex_unlock (g_messages_lock); return old_printerr_func; } void g_printerr (const gchar *format, ...) { va_list args; gchar *string; GPrintFunc local_glib_printerr_func; g_return_if_fail (format != NULL); va_start (args, format); string = g_strdup_vprintf (format, args); va_end (args); g_mutex_lock (g_messages_lock); local_glib_printerr_func = glib_printerr_func; g_mutex_unlock (g_messages_lock); if (local_glib_printerr_func) local_glib_printerr_func (string); else { const gchar *charset; ensure_stderr_valid (); if (g_get_charset (&charset)) fputs (string, stderr); /* charset is UTF-8 already */ else { gchar *lstring = strdup_convert (string, charset); fputs (lstring, stderr); g_free (lstring); } fflush (stderr); } g_free (string); } gsize g_printf_string_upper_bound (const gchar *format, va_list args) { gchar c; return _g_vsnprintf (&c, 1, format, args) + 1; } void _g_messages_thread_init (void) { g_messages_lock = g_mutex_new (); g_messages_prefixed_init (); _g_debug_init (); } void _g_messages_thread_private_init (void) { g_assert (g_log_depth == NULL); g_log_depth = g_private_new (NULL); } gboolean _g_debug_initialized = FALSE; guint _g_debug_flags = 0; void _g_debug_init (void) { const gchar *val; _g_debug_initialized = TRUE; val = g_getenv ("G_DEBUG"); if (val != NULL) { static const GDebugKey keys[] = { {"fatal_warnings", G_DEBUG_FATAL_WARNINGS} }; _g_debug_flags = g_parse_debug_string (val, keys, G_N_ELEMENTS (keys)); } if (_g_debug_flags & G_DEBUG_FATAL_WARNINGS) { GLogLevelFlags fatal_mask; fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK); fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL; g_log_set_always_fatal (fatal_mask); } }