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/.
46 #include "gprintfint.h"
47 #include "gthreadinit.h"
51 #include <process.h> /* For getpid() */
53 # define STRICT /* Strict typing, please */
54 # define _WIN32_WINDOWS 0x0401 /* to get IsDebuggerPresent */
59 /* --- structures --- */
60 typedef struct _GLogDomain GLogDomain;
61 typedef struct _GLogHandler GLogHandler;
65 GLogLevelFlags fatal_mask;
66 GLogHandler *handlers;
72 GLogLevelFlags log_level;
79 /* --- variables --- */
80 static GMutex *g_messages_lock = NULL;
81 static GLogDomain *g_log_domains = NULL;
82 static GLogLevelFlags g_log_always_fatal = G_LOG_FATAL_MASK;
83 static GPrintFunc glib_print_func = NULL;
84 static GPrintFunc glib_printerr_func = NULL;
85 static GPrivate *g_log_depth = NULL;
86 static GLogLevelFlags g_log_msg_prefix = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_DEBUG;
87 static GLogFunc default_log_func = g_log_default_handler;
88 static gpointer default_log_data = NULL;
90 /* --- functions --- */
95 static gboolean win32_keep_fatal_message = FALSE;
97 /* This default message will usually be overwritten. */
98 /* Yes, a fixed size buffer is bad. So sue me. But g_error() is never
99 * called with huge strings, is it?
101 static gchar fatal_msg_buf[1000] = "Unspecified fatal error encountered, aborting.";
102 static gchar *fatal_msg_ptr = fatal_msg_buf;
110 if (win32_keep_fatal_message)
112 memcpy (fatal_msg_ptr, buf, len);
113 fatal_msg_ptr += len;
118 write (fd, buf, len);
122 #define write(fd, buf, len) dowrite(fd, buf, len)
127 write_string (int fd,
130 write (fd, string, strlen (string));
134 g_messages_prefixed_init (void)
136 static gboolean initialized = FALSE;
143 val = g_getenv ("G_MESSAGES_PREFIXED");
147 static const GDebugKey keys[] = {
148 { "error", G_LOG_LEVEL_ERROR },
149 { "critical", G_LOG_LEVEL_CRITICAL },
150 { "warning", G_LOG_LEVEL_WARNING },
151 { "message", G_LOG_LEVEL_MESSAGE },
152 { "info", G_LOG_LEVEL_INFO },
153 { "debug", G_LOG_LEVEL_DEBUG }
156 g_log_msg_prefix = g_parse_debug_string (val, keys, G_N_ELEMENTS (keys));
162 g_log_find_domain_L (const gchar *log_domain)
164 register GLogDomain *domain;
166 domain = g_log_domains;
169 if (strcmp (domain->log_domain, log_domain) == 0)
171 domain = domain->next;
177 g_log_domain_new_L (const gchar *log_domain)
179 register GLogDomain *domain;
181 domain = g_new (GLogDomain, 1);
182 domain->log_domain = g_strdup (log_domain);
183 domain->fatal_mask = G_LOG_FATAL_MASK;
184 domain->handlers = NULL;
186 domain->next = g_log_domains;
187 g_log_domains = domain;
193 g_log_domain_check_free_L (GLogDomain *domain)
195 if (domain->fatal_mask == G_LOG_FATAL_MASK &&
196 domain->handlers == NULL)
198 register GLogDomain *last, *work;
202 work = g_log_domains;
208 last->next = domain->next;
210 g_log_domains = domain->next;
211 g_free (domain->log_domain);
222 g_log_domain_get_handler_L (GLogDomain *domain,
223 GLogLevelFlags log_level,
226 if (domain && log_level)
228 register GLogHandler *handler;
230 handler = domain->handlers;
233 if ((handler->log_level & log_level) == log_level)
235 *data = handler->data;
236 return handler->log_func;
238 handler = handler->next;
242 *data = default_log_data;
243 return default_log_func;
247 g_log_set_always_fatal (GLogLevelFlags fatal_mask)
249 GLogLevelFlags old_mask;
251 /* restrict the global mask to levels that are known to glib
252 * since this setting applies to all domains
254 fatal_mask &= (1 << G_LOG_LEVEL_USER_SHIFT) - 1;
255 /* force errors to be fatal */
256 fatal_mask |= G_LOG_LEVEL_ERROR;
257 /* remove bogus flag */
258 fatal_mask &= ~G_LOG_FLAG_FATAL;
260 g_mutex_lock (g_messages_lock);
261 old_mask = g_log_always_fatal;
262 g_log_always_fatal = fatal_mask;
263 g_mutex_unlock (g_messages_lock);
269 g_log_set_fatal_mask (const gchar *log_domain,
270 GLogLevelFlags fatal_mask)
272 GLogLevelFlags old_flags;
273 register GLogDomain *domain;
278 /* force errors to be fatal */
279 fatal_mask |= G_LOG_LEVEL_ERROR;
280 /* remove bogus flag */
281 fatal_mask &= ~G_LOG_FLAG_FATAL;
283 g_mutex_lock (g_messages_lock);
285 domain = g_log_find_domain_L (log_domain);
287 domain = g_log_domain_new_L (log_domain);
288 old_flags = domain->fatal_mask;
290 domain->fatal_mask = fatal_mask;
291 g_log_domain_check_free_L (domain);
293 g_mutex_unlock (g_messages_lock);
299 g_log_set_handler (const gchar *log_domain,
300 GLogLevelFlags log_levels,
304 static guint handler_id = 0;
306 GLogHandler *handler;
308 g_return_val_if_fail ((log_levels & G_LOG_LEVEL_MASK) != 0, 0);
309 g_return_val_if_fail (log_func != NULL, 0);
314 handler = g_new (GLogHandler, 1);
316 g_mutex_lock (g_messages_lock);
318 domain = g_log_find_domain_L (log_domain);
320 domain = g_log_domain_new_L (log_domain);
322 handler->id = ++handler_id;
323 handler->log_level = log_levels;
324 handler->log_func = log_func;
325 handler->data = user_data;
326 handler->next = domain->handlers;
327 domain->handlers = handler;
329 g_mutex_unlock (g_messages_lock);
335 g_log_set_default_handler (GLogFunc log_func,
338 GLogFunc old_log_func;
340 g_mutex_lock (g_messages_lock);
341 old_log_func = default_log_func;
342 default_log_func = log_func;
343 default_log_data = user_data;
344 g_mutex_unlock (g_messages_lock);
350 g_log_remove_handler (const gchar *log_domain,
353 register GLogDomain *domain;
355 g_return_if_fail (handler_id > 0);
360 g_mutex_lock (g_messages_lock);
361 domain = g_log_find_domain_L (log_domain);
364 GLogHandler *work, *last;
367 work = domain->handlers;
370 if (work->id == handler_id)
373 last->next = work->next;
375 domain->handlers = work->next;
376 g_log_domain_check_free_L (domain);
377 g_mutex_unlock (g_messages_lock);
385 g_mutex_unlock (g_messages_lock);
386 g_warning ("%s: could not find handler with id `%d' for domain \"%s\"",
387 G_STRLOC, handler_id, log_domain);
391 g_logv (const gchar *log_domain,
392 GLogLevelFlags log_level,
396 gboolean was_fatal = (log_level & G_LOG_FLAG_FATAL) != 0;
397 gboolean was_recursion = (log_level & G_LOG_FLAG_RECURSION) != 0;
400 log_level &= G_LOG_LEVEL_MASK;
404 for (i = g_bit_nth_msf (log_level, -1); i >= 0; i = g_bit_nth_msf (log_level, i))
406 register GLogLevelFlags test_level;
409 if (log_level & test_level)
411 guint depth = GPOINTER_TO_UINT (g_private_get (g_log_depth));
414 GLogLevelFlags domain_fatal_mask;
415 gpointer data = NULL;
418 test_level |= G_LOG_FLAG_FATAL;
420 test_level |= G_LOG_FLAG_RECURSION;
422 /* check recursion and lookup handler */
423 g_mutex_lock (g_messages_lock);
424 domain = g_log_find_domain_L (log_domain ? log_domain : "");
426 test_level |= G_LOG_FLAG_RECURSION;
428 domain_fatal_mask = domain ? domain->fatal_mask : G_LOG_FATAL_MASK;
429 if ((domain_fatal_mask | g_log_always_fatal) & test_level)
430 test_level |= G_LOG_FLAG_FATAL;
431 if (test_level & G_LOG_FLAG_RECURSION)
432 log_func = _g_log_fallback_handler;
434 log_func = g_log_domain_get_handler_L (domain, test_level, &data);
436 g_mutex_unlock (g_messages_lock);
438 g_private_set (g_log_depth, GUINT_TO_POINTER (depth));
440 /* had to defer debug initialization until we can keep track of recursion */
441 if (!(test_level & G_LOG_FLAG_RECURSION) && !_g_debug_initialized)
443 GLogLevelFlags orig_test_level = test_level;
446 if ((domain_fatal_mask | g_log_always_fatal) & test_level)
447 test_level |= G_LOG_FLAG_FATAL;
448 if (test_level != orig_test_level)
450 /* need a relookup, not nice, but not too bad either */
451 g_mutex_lock (g_messages_lock);
452 domain = g_log_find_domain_L (log_domain ? log_domain : "");
453 log_func = g_log_domain_get_handler_L (domain, test_level, &data);
455 g_mutex_unlock (g_messages_lock);
459 if (test_level & G_LOG_FLAG_RECURSION)
461 /* we use a stack buffer of fixed size, since we're likely
462 * in an out-of-memory situation
466 size = _g_vsnprintf (buffer, 1024, format, args1);
468 log_func (log_domain, test_level, buffer, data);
472 gchar *msg = g_strdup_vprintf (format, args1);
474 log_func (log_domain, test_level, msg, data);
479 if (test_level & G_LOG_FLAG_FATAL)
482 gchar *locale_msg = g_locale_from_utf8 (fatal_msg_buf, -1, NULL, NULL, NULL);
484 MessageBox (NULL, locale_msg, NULL,
485 MB_ICONERROR|MB_SETFOREGROUND);
486 if (IsDebuggerPresent () && !(test_level & G_LOG_FLAG_RECURSION))
491 #if defined (G_ENABLE_DEBUG) && defined (SIGTRAP)
492 if (!(test_level & G_LOG_FLAG_RECURSION))
496 #else /* !G_ENABLE_DEBUG || !SIGTRAP */
498 #endif /* !G_ENABLE_DEBUG || !SIGTRAP */
499 #endif /* !G_OS_WIN32 */
503 g_private_set (g_log_depth, GUINT_TO_POINTER (depth));
509 g_log (const gchar *log_domain,
510 GLogLevelFlags log_level,
516 va_start (args, format);
517 g_logv (log_domain, log_level, format, args);
522 g_return_if_fail_warning (const char *log_domain,
523 const char *pretty_function,
524 const char *expression)
527 * Omit the prefix used by the PLT-reduction
528 * technique used in GTK+.
530 if (g_str_has_prefix (pretty_function, "IA__"))
531 pretty_function += 4;
533 G_LOG_LEVEL_CRITICAL,
534 "%s: assertion `%s' failed",
540 g_assert_warning (const char *log_domain,
543 const char *pretty_function,
544 const char *expression)
547 * Omit the prefix used by the PLT-reduction
548 * technique used in GTK+.
550 if (g_str_has_prefix (pretty_function, "IA__"))
551 pretty_function += 4;
555 ? "file %s: line %d (%s): assertion failed: (%s)"
556 : "file %s: line %d (%s): should not be reached",
564 #define CHAR_IS_SAFE(wc) (!((wc < 0x20 && wc != '\t' && wc != '\n' && wc != '\r') || \
566 (wc >= 0x80 && wc < 0xa0)))
569 strdup_convert (const gchar *string,
570 const gchar *charset)
572 if (!g_utf8_validate (string, -1, NULL))
574 GString *gstring = g_string_new ("[Invalid UTF-8] ");
577 for (p = (guchar *)string; *p; p++)
579 if (CHAR_IS_SAFE(*p) &&
580 !(*p == '\r' && *(p + 1) != '\n') &&
582 g_string_append_c (gstring, *p);
584 g_string_append_printf (gstring, "\\x%02x", (guint)(guchar)*p);
587 return g_string_free (gstring, FALSE);
593 gchar *result = g_convert_with_fallback (string, -1, charset, "UTF-8", "?", NULL, NULL, &err);
598 /* Not thread-safe, but doesn't matter if we print the warning twice
600 static gboolean warned = FALSE;
604 _g_fprintf (stderr, "GLib: Cannot convert message: %s\n", err->message);
608 return g_strdup (string);
613 /* For a radix of 8 we need at most 3 output bytes for 1 input
614 * byte. Additionally we might need up to 2 output bytes for the
615 * readix prefix and 1 byte for the trailing NULL.
617 #define FORMAT_UNSIGNED_BUFSIZE ((GLIB_SIZEOF_LONG * 3) + 3)
620 format_unsigned (gchar *buf,
628 /* we may not call _any_ GLib functions here (or macros like g_return_if_fail()) */
630 if (radix != 8 && radix != 10 && radix != 16)
663 /* Again we can't use g_assert; actually this check should _never_ fail. */
664 if (n > FORMAT_UNSIGNED_BUFSIZE - 3)
677 buf[i] = c + 'a' - 10;
684 /* string size big enough to hold level prefix */
685 #define STRING_BUFFER_SIZE (FORMAT_UNSIGNED_BUFSIZE + 32)
687 #define ALERT_LEVELS (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
690 mklevel_prefix (gchar level_prefix[STRING_BUFFER_SIZE],
691 GLogLevelFlags log_level)
693 gboolean to_stdout = TRUE;
695 /* we may not call _any_ GLib functions here */
697 switch (log_level & G_LOG_LEVEL_MASK)
699 case G_LOG_LEVEL_ERROR:
700 strcpy (level_prefix, "ERROR");
703 case G_LOG_LEVEL_CRITICAL:
704 strcpy (level_prefix, "CRITICAL");
707 case G_LOG_LEVEL_WARNING:
708 strcpy (level_prefix, "WARNING");
711 case G_LOG_LEVEL_MESSAGE:
712 strcpy (level_prefix, "Message");
715 case G_LOG_LEVEL_INFO:
716 strcpy (level_prefix, "INFO");
718 case G_LOG_LEVEL_DEBUG:
719 strcpy (level_prefix, "DEBUG");
724 strcpy (level_prefix, "LOG-");
725 format_unsigned (level_prefix + 4, log_level & G_LOG_LEVEL_MASK, 16);
728 strcpy (level_prefix, "LOG");
731 if (log_level & G_LOG_FLAG_RECURSION)
732 strcat (level_prefix, " (recursed)");
733 if (log_level & ALERT_LEVELS)
734 strcat (level_prefix, " **");
737 win32_keep_fatal_message = (log_level & G_LOG_FLAG_FATAL) != 0;
739 return to_stdout ? 1 : 2;
743 _g_log_fallback_handler (const gchar *log_domain,
744 GLogLevelFlags log_level,
745 const gchar *message,
746 gpointer unused_data)
748 gchar level_prefix[STRING_BUFFER_SIZE];
750 gchar pid_string[FORMAT_UNSIGNED_BUFSIZE];
752 gboolean is_fatal = (log_level & G_LOG_FLAG_FATAL) != 0;
755 /* we can not call _any_ GLib functions in this fallback handler,
756 * which is why we skip UTF-8 conversion, etc.
757 * since we either recursed or ran out of memory, we're in a pretty
758 * pathologic situation anyways, what we can do is giving the
759 * the process ID unconditionally however.
762 fd = mklevel_prefix (level_prefix, log_level);
764 message = "(NULL) message";
767 format_unsigned (pid_string, getpid (), 10);
771 write_string (fd, "\n");
773 write_string (fd, "\n** ");
776 write_string (fd, "(process:");
777 write_string (fd, pid_string);
778 write_string (fd, "): ");
783 write_string (fd, log_domain);
784 write_string (fd, "-");
786 write_string (fd, level_prefix);
787 write_string (fd, ": ");
788 write_string (fd, message);
790 write_string (fd, "\naborting...\n");
792 write_string (fd, "\n");
796 escape_string (GString *string)
798 const char *p = string->str;
801 while (p < string->str + string->len)
805 wc = g_utf8_get_char_validated (p, -1);
806 if (wc == (gunichar)-1 || wc == (gunichar)-2)
811 pos = p - string->str;
813 /* Emit invalid UTF-8 as hex escapes
815 tmp = g_strdup_printf ("\\x%02x", (guint)(guchar)*p);
816 g_string_erase (string, pos, 1);
817 g_string_insert (string, pos, tmp);
819 p = string->str + (pos + 4); /* Skip over escape sequence */
826 safe = *(p + 1) == '\n';
830 safe = CHAR_IS_SAFE (wc);
838 pos = p - string->str;
840 /* Largest char we escape is 0x0a, so we don't have to worry
841 * about 8-digit \Uxxxxyyyy
843 tmp = g_strdup_printf ("\\u%04x", wc);
844 g_string_erase (string, pos, g_utf8_next_char (p) - p);
845 g_string_insert (string, pos, tmp);
848 p = string->str + (pos + 6); /* Skip over escape sequence */
851 p = g_utf8_next_char (p);
856 g_log_default_handler (const gchar *log_domain,
857 GLogLevelFlags log_level,
858 const gchar *message,
859 gpointer unused_data)
861 gboolean is_fatal = (log_level & G_LOG_FLAG_FATAL) != 0;
862 gchar level_prefix[STRING_BUFFER_SIZE], *string;
866 /* we can be called externally with recursion for whatever reason */
867 if (log_level & G_LOG_FLAG_RECURSION)
869 _g_log_fallback_handler (log_domain, log_level, message, unused_data);
873 g_messages_prefixed_init ();
875 fd = mklevel_prefix (level_prefix, log_level);
877 gstring = g_string_new (NULL);
878 if (log_level & ALERT_LEVELS)
879 g_string_append (gstring, "\n");
881 g_string_append (gstring, "** ");
883 if ((g_log_msg_prefix & log_level) == log_level)
885 const gchar *prg_name = g_get_prgname ();
888 g_string_append_printf (gstring, "(process:%lu): ", (gulong)getpid ());
890 g_string_append_printf (gstring, "(%s:%lu): ", prg_name, (gulong)getpid ());
895 g_string_append (gstring, log_domain);
896 g_string_append_c (gstring, '-');
898 g_string_append (gstring, level_prefix);
900 g_string_append (gstring, ": ");
902 g_string_append (gstring, "(NULL) message");
906 const gchar *charset;
908 msg = g_string_new (message);
911 if (g_get_charset (&charset))
912 g_string_append (gstring, msg->str); /* charset is UTF-8 already */
915 string = strdup_convert (msg->str, charset);
916 g_string_append (gstring, string);
920 g_string_free (msg, TRUE);
923 g_string_append (gstring, "\naborting...\n");
925 g_string_append (gstring, "\n");
927 string = g_string_free (gstring, FALSE);
929 write_string (fd, string);
934 g_set_print_handler (GPrintFunc func)
936 GPrintFunc old_print_func;
938 g_mutex_lock (g_messages_lock);
939 old_print_func = glib_print_func;
940 glib_print_func = func;
941 g_mutex_unlock (g_messages_lock);
943 return old_print_func;
947 g_print (const gchar *format,
952 GPrintFunc local_glib_print_func;
954 g_return_if_fail (format != NULL);
956 va_start (args, format);
957 string = g_strdup_vprintf (format, args);
960 g_mutex_lock (g_messages_lock);
961 local_glib_print_func = glib_print_func;
962 g_mutex_unlock (g_messages_lock);
964 if (local_glib_print_func)
965 local_glib_print_func (string);
968 const gchar *charset;
970 if (g_get_charset (&charset))
971 fputs (string, stdout); /* charset is UTF-8 already */
974 gchar *lstring = strdup_convert (string, charset);
976 fputs (lstring, stdout);
985 g_set_printerr_handler (GPrintFunc func)
987 GPrintFunc old_printerr_func;
989 g_mutex_lock (g_messages_lock);
990 old_printerr_func = glib_printerr_func;
991 glib_printerr_func = func;
992 g_mutex_unlock (g_messages_lock);
994 return old_printerr_func;
998 g_printerr (const gchar *format,
1003 GPrintFunc local_glib_printerr_func;
1005 g_return_if_fail (format != NULL);
1007 va_start (args, format);
1008 string = g_strdup_vprintf (format, args);
1011 g_mutex_lock (g_messages_lock);
1012 local_glib_printerr_func = glib_printerr_func;
1013 g_mutex_unlock (g_messages_lock);
1015 if (local_glib_printerr_func)
1016 local_glib_printerr_func (string);
1019 const gchar *charset;
1021 if (g_get_charset (&charset))
1022 fputs (string, stderr); /* charset is UTF-8 already */
1025 gchar *lstring = strdup_convert (string, charset);
1027 fputs (lstring, stderr);
1036 g_printf_string_upper_bound (const gchar *format,
1040 return _g_vsnprintf (&c, 1, format, args) + 1;
1044 _g_messages_thread_init (void)
1046 g_messages_lock = g_mutex_new ();
1047 g_messages_prefixed_init ();
1052 _g_messages_thread_private_init (void)
1054 g_assert (g_log_depth == NULL);
1055 g_log_depth = g_private_new (NULL);
1058 gboolean _g_debug_initialized = FALSE;
1059 guint _g_debug_flags = 0;
1062 _g_debug_init (void)
1066 _g_debug_initialized = TRUE;
1068 val = g_getenv ("G_DEBUG");
1071 static const GDebugKey keys[] = {
1072 {"fatal_warnings", G_DEBUG_FATAL_WARNINGS},
1073 {"fatal_criticals", G_DEBUG_FATAL_CRITICALS}
1076 _g_debug_flags = g_parse_debug_string (val, keys, G_N_ELEMENTS (keys));
1079 if (_g_debug_flags & G_DEBUG_FATAL_WARNINGS)
1081 GLogLevelFlags fatal_mask;
1083 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
1084 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
1085 g_log_set_always_fatal (fatal_mask);
1088 if (_g_debug_flags & G_DEBUG_FATAL_CRITICALS)
1090 GLogLevelFlags fatal_mask;
1092 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
1093 fatal_mask |= G_LOG_LEVEL_CRITICAL;
1094 g_log_set_always_fatal (fatal_mask);
1098 #define __G_MESSAGES_C__
1099 #include "galiasdef.c"