Blame glib/glib/gmessages.c

Packit db3073
/* GLIB - Library of useful routines for C programming
Packit db3073
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
Packit db3073
 *
Packit db3073
 * This library is free software; you can redistribute it and/or
Packit db3073
 * modify it under the terms of the GNU Lesser General Public
Packit db3073
 * License as published by the Free Software Foundation; either
Packit db3073
 * version 2 of the License, or (at your option) any later version.
Packit db3073
 *
Packit db3073
 * This library is distributed in the hope that it will be useful,
Packit db3073
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit db3073
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
Packit db3073
 * Lesser General Public License for more details.
Packit db3073
 *
Packit db3073
 * You should have received a copy of the GNU Lesser General Public
Packit db3073
 * License along with this library; if not, write to the
Packit db3073
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Packit db3073
 * Boston, MA 02111-1307, USA.
Packit db3073
 */
Packit db3073
Packit db3073
/*
Packit db3073
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
Packit db3073
 * file for a list of people on the GLib Team.  See the ChangeLog
Packit db3073
 * files for a list of changes.  These files are distributed with
Packit db3073
 * GLib at ftp://ftp.gtk.org/pub/gtk/.
Packit db3073
 */
Packit db3073
Packit db3073
/*
Packit db3073
 * MT safe
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * SECTION:warnings
Packit db3073
 * @Title: Message Output and Debugging Functions
Packit db3073
 * @Short_description: functions to output messages and help debug applications
Packit db3073
 *
Packit db3073
 * These functions provide support for outputting messages.
Packit db3073
 *
Packit db3073
 * The <function>g_return</function> family of macros (g_return_if_fail(),
Packit db3073
 * g_return_val_if_fail(), g_return_if_reached(), g_return_val_if_reached())
Packit db3073
 * should only be used for programming errors, a typical use case is
Packit db3073
 * checking for invalid parameters at the beginning of a public function.
Packit db3073
 * They should not be used if you just mean "if (error) return", they
Packit db3073
 * should only be used if you mean "if (bug in program) return".
Packit db3073
 * The program behavior is generally considered undefined after one
Packit db3073
 * of these checks fails. They are not intended for normal control
Packit db3073
 * flow, only to give a perhaps-helpful warning before giving up.
Packit db3073
 */
Packit db3073
Packit db3073
#include "config.h"
Packit db3073
Packit db3073
#include <stdlib.h>
Packit db3073
#include <stdarg.h>
Packit db3073
#include <stdio.h>
Packit db3073
#include <string.h>
Packit db3073
#ifdef HAVE_UNISTD_H
Packit db3073
#include <unistd.h>
Packit db3073
#endif
Packit db3073
#include <signal.h>
Packit db3073
#include <locale.h>
Packit db3073
#include <errno.h>
Packit db3073
Packit db3073
#include "gmessages.h"
Packit db3073
Packit db3073
#include "glib-init.h"
Packit db3073
#include "gbacktrace.h"
Packit db3073
#include "gcharset.h"
Packit db3073
#include "gconvert.h"
Packit db3073
#include "genviron.h"
Packit db3073
#include "gmem.h"
Packit db3073
#include "gprintfint.h"
Packit db3073
#include "gtestutils.h"
Packit db3073
#include "gthread.h"
Packit db3073
#include "gstrfuncs.h"
Packit db3073
#include "gstring.h"
Packit db3073
Packit db3073
#ifdef G_OS_WIN32
Packit db3073
#include <process.h>		/* For getpid() */
Packit db3073
#include <io.h>
Packit db3073
#  define _WIN32_WINDOWS 0x0401 /* to get IsDebuggerPresent */
Packit db3073
#  include <windows.h>
Packit db3073
#endif
Packit db3073
Packit db3073
Packit db3073
/**
Packit db3073
 * SECTION:messages
Packit db3073
 * @title: Message Logging
Packit db3073
 * @short_description: versatile support for logging messages
Packit db3073
 *     with different levels of importance
Packit db3073
 *
Packit db3073
 * These functions provide support for logging error messages
Packit db3073
 * or messages used for debugging.
Packit db3073
 *
Packit db3073
 * There are several built-in levels of messages, defined in
Packit db3073
 * #GLogLevelFlags. These can be extended with user-defined levels.
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * G_LOG_DOMAIN:
Packit db3073
 *
Packit db3073
 * Defines the log domain.
Packit db3073
 *
Packit db3073
 * For applications, this is typically left as the default %NULL
Packit db3073
 * (or "") domain. Libraries should define this so that any messages
Packit db3073
 * which they log can be differentiated from messages from other
Packit db3073
 * libraries and application code. But be careful not to define
Packit db3073
 * it in any public header files.
Packit db3073
 *
Packit db3073
 * For example, GTK+ uses this in its Makefile.am:
Packit db3073
 * |[
Packit db3073
 * INCLUDES = -DG_LOG_DOMAIN=\"Gtk\"
Packit db3073
 * ]|
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * G_LOG_FATAL_MASK:
Packit db3073
 *
Packit db3073
 * GLib log levels that are considered fatal by default.
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * GLogFunc:
Packit db3073
 * @log_domain: the log domain of the message
Packit db3073
 * @log_level: the log level of the message (including the
Packit db3073
 *     fatal and recursion flags)
Packit db3073
 * @message: the message to process
Packit db3073
 * @user_data: user data, set in g_log_set_handler()
Packit db3073
 *
Packit db3073
 * Specifies the prototype of log handler functions.
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * GLogLevelFlags:
Packit db3073
 * @G_LOG_FLAG_RECURSION: internal flag
Packit db3073
 * @G_LOG_FLAG_FATAL: internal flag
Packit db3073
 * @G_LOG_LEVEL_ERROR: log level for errors, see g_error().
Packit db3073
 *     This level is also used for messages produced by g_assert().
Packit db3073
 * @G_LOG_LEVEL_CRITICAL: log level for critical messages, see g_critical().
Packit db3073
 *     This level is also used for messages produced by g_return_if_fail()
Packit db3073
 *     and g_return_val_if_fail().
Packit db3073
 * @G_LOG_LEVEL_WARNING: log level for warnings, see g_warning()
Packit db3073
 * @G_LOG_LEVEL_MESSAGE: log level for messages, see g_message()
Packit db3073
 * @G_LOG_LEVEL_INFO: log level for informational messages
Packit db3073
 * @G_LOG_LEVEL_DEBUG: log level for debug messages, see g_debug()
Packit db3073
 * @G_LOG_LEVEL_MASK: a mask including all log levels
Packit db3073
 *
Packit db3073
 * Flags specifying the level of log messages.
Packit db3073
 *
Packit db3073
 * It is possible to change how GLib treats messages of the various
Packit db3073
 * levels using g_log_set_handler() and g_log_set_fatal_mask().
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * g_message:
Packit db3073
 * @...: format string, followed by parameters to insert
Packit db3073
 *     into the format string (as with printf())
Packit db3073
 *
Packit db3073
 * A convenience function/macro to log a normal message.
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * g_warning:
Packit db3073
 * @...: format string, followed by parameters to insert
Packit db3073
 *     into the format string (as with printf())
Packit db3073
 *
Packit db3073
 * A convenience function/macro to log a warning message.
Packit db3073
 *
Packit db3073
 * You can make warnings fatal at runtime by setting the
Packit db3073
 * <envar>G_DEBUG</envar> environment variable (see
Packit db3073
 * <ulink url="glib-running.html">Running GLib Applications</ulink>).
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * g_critical:
Packit db3073
 * @...: format string, followed by parameters to insert
Packit db3073
 *     into the format string (as with printf())
Packit db3073
 *
Packit db3073
 * Logs a "critical warning" (#G_LOG_LEVEL_CRITICAL).
Packit db3073
 * It's more or less application-defined what constitutes
Packit db3073
 * a critical vs. a regular warning. You could call
Packit db3073
 * g_log_set_always_fatal() to make critical warnings exit
Packit db3073
 * the program, then use g_critical() for fatal errors, for
Packit db3073
 * example.
Packit db3073
 *
Packit db3073
 * You can also make critical warnings fatal at runtime by
Packit db3073
 * setting the <envar>G_DEBUG</envar> environment variable (see
Packit db3073
 * <ulink url="glib-running.html">Running GLib Applications</ulink>).
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * g_error:
Packit db3073
 * @...: format string, followed by parameters to insert
Packit db3073
 *     into the format string (as with printf())
Packit db3073
 *
Packit db3073
 * A convenience function/macro to log an error message.
Packit db3073
 *
Packit db3073
 * Error messages are always fatal, resulting in a call to
Packit db3073
 * abort() to terminate the application. This function will
Packit db3073
 * result in a core dump; don't use it for errors you expect.
Packit db3073
 * Using this function indicates a bug in your program, i.e.
Packit db3073
 * an assertion failure.
Packit db3073
 *
Packit db3073
 */
Packit db3073
Packit db3073
/**
Packit db3073
 * g_debug:
Packit db3073
 * @...: format string, followed by parameters to insert
Packit db3073
 *     into the format string (as with printf())
Packit db3073
 *
Packit db3073
 * A convenience function/macro to log a debug message.
Packit db3073
 *
Packit db3073
 * Since: 2.6
Packit db3073
 */
Packit db3073
Packit db3073
/* --- structures --- */
Packit db3073
typedef struct _GLogDomain	GLogDomain;
Packit db3073
typedef struct _GLogHandler	GLogHandler;
Packit db3073
struct _GLogDomain
Packit db3073
{
Packit db3073
  gchar		*log_domain;
Packit db3073
  GLogLevelFlags fatal_mask;
Packit db3073
  GLogHandler	*handlers;
Packit db3073
  GLogDomain	*next;
Packit db3073
};
Packit db3073
struct _GLogHandler
Packit db3073
{
Packit db3073
  guint		 id;
Packit db3073
  GLogLevelFlags log_level;
Packit db3073
  GLogFunc	 log_func;
Packit db3073
  gpointer	 data;
Packit db3073
  GLogHandler	*next;
Packit db3073
};
Packit db3073
Packit db3073
Packit db3073
/* --- variables --- */
Packit db3073
static GMutex         g_messages_lock;
Packit db3073
static GLogDomain    *g_log_domains = NULL;
Packit db3073
static GPrintFunc     glib_print_func = NULL;
Packit db3073
static GPrintFunc     glib_printerr_func = NULL;
Packit db3073
static GPrivate       g_log_depth;
Packit db3073
static GLogFunc       default_log_func = g_log_default_handler;
Packit db3073
static gpointer       default_log_data = NULL;
Packit db3073
static GTestLogFatalFunc fatal_log_func = NULL;
Packit db3073
static gpointer          fatal_log_data;
Packit db3073
Packit db3073
/* --- functions --- */
Packit db3073
#ifdef G_OS_WIN32
Packit db3073
#  include <windows.h>
Packit db3073
static gboolean win32_keep_fatal_message = FALSE;
Packit db3073
Packit db3073
/* This default message will usually be overwritten. */
Packit db3073
/* Yes, a fixed size buffer is bad. So sue me. But g_error() is never
Packit db3073
 * called with huge strings, is it?
Packit db3073
 */
Packit db3073
static gchar  fatal_msg_buf[1000] = "Unspecified fatal error encountered, aborting.";
Packit db3073
static gchar *fatal_msg_ptr = fatal_msg_buf;
Packit db3073
Packit db3073
#undef write
Packit db3073
static inline int
Packit db3073
dowrite (int          fd,
Packit db3073
	 const void  *buf,
Packit db3073
	 unsigned int len)
Packit db3073
{
Packit db3073
  if (win32_keep_fatal_message)
Packit db3073
    {
Packit db3073
      memcpy (fatal_msg_ptr, buf, len);
Packit db3073
      fatal_msg_ptr += len;
Packit db3073
      *fatal_msg_ptr = 0;
Packit db3073
      return len;
Packit db3073
    }
Packit db3073
Packit db3073
  write (fd, buf, len);
Packit db3073
Packit db3073
  return len;
Packit db3073
}
Packit db3073
#define write(fd, buf, len) dowrite(fd, buf, len)
Packit db3073
Packit db3073
#endif
Packit db3073
Packit db3073
static void
Packit db3073
write_string (int          fd,
Packit db3073
	      const gchar *string)
Packit db3073
{
Packit db3073
  write (fd, string, strlen (string));
Packit db3073
}
Packit db3073
Packit db3073
static GLogDomain*
Packit db3073
g_log_find_domain_L (const gchar *log_domain)
Packit db3073
{
Packit db3073
  register GLogDomain *domain;
Packit db3073
  
Packit db3073
  domain = g_log_domains;
Packit db3073
  while (domain)
Packit db3073
    {
Packit db3073
      if (strcmp (domain->log_domain, log_domain) == 0)
Packit db3073
	return domain;
Packit db3073
      domain = domain->next;
Packit db3073
    }
Packit db3073
  return NULL;
Packit db3073
}
Packit db3073
Packit db3073
static GLogDomain*
Packit db3073
g_log_domain_new_L (const gchar *log_domain)
Packit db3073
{
Packit db3073
  register GLogDomain *domain;
Packit db3073
Packit db3073
  domain = g_new (GLogDomain, 1);
Packit db3073
  domain->log_domain = g_strdup (log_domain);
Packit db3073
  domain->fatal_mask = G_LOG_FATAL_MASK;
Packit db3073
  domain->handlers = NULL;
Packit db3073
  
Packit db3073
  domain->next = g_log_domains;
Packit db3073
  g_log_domains = domain;
Packit db3073
  
Packit db3073
  return domain;
Packit db3073
}
Packit db3073
Packit db3073
static void
Packit db3073
g_log_domain_check_free_L (GLogDomain *domain)
Packit db3073
{
Packit db3073
  if (domain->fatal_mask == G_LOG_FATAL_MASK &&
Packit db3073
      domain->handlers == NULL)
Packit db3073
    {
Packit db3073
      register GLogDomain *last, *work;
Packit db3073
      
Packit db3073
      last = NULL;  
Packit db3073
Packit db3073
      work = g_log_domains;
Packit db3073
      while (work)
Packit db3073
	{
Packit db3073
	  if (work == domain)
Packit db3073
	    {
Packit db3073
	      if (last)
Packit db3073
		last->next = domain->next;
Packit db3073
	      else
Packit db3073
		g_log_domains = domain->next;
Packit db3073
	      g_free (domain->log_domain);
Packit db3073
	      g_free (domain);
Packit db3073
	      break;
Packit db3073
	    }
Packit db3073
	  last = work;
Packit db3073
	  work = last->next;
Packit db3073
	}  
Packit db3073
    }
Packit db3073
}
Packit db3073
Packit db3073
static GLogFunc
Packit db3073
g_log_domain_get_handler_L (GLogDomain	*domain,
Packit db3073
			    GLogLevelFlags log_level,
Packit db3073
			    gpointer	*data)
Packit db3073
{
Packit db3073
  if (domain && log_level)
Packit db3073
    {
Packit db3073
      register GLogHandler *handler;
Packit db3073
      
Packit db3073
      handler = domain->handlers;
Packit db3073
      while (handler)
Packit db3073
	{
Packit db3073
	  if ((handler->log_level & log_level) == log_level)
Packit db3073
	    {
Packit db3073
	      *data = handler->data;
Packit db3073
	      return handler->log_func;
Packit db3073
	    }
Packit db3073
	  handler = handler->next;
Packit db3073
	}
Packit db3073
    }
Packit db3073
Packit db3073
  *data = default_log_data;
Packit db3073
  return default_log_func;
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_log_set_always_fatal:
Packit db3073
 * @fatal_mask: the mask containing bits set for each level
Packit db3073
 *     of error which is to be fatal
Packit db3073
 *
Packit db3073
 * Sets the message levels which are always fatal, in any log domain.
Packit db3073
 * When a message with any of these levels is logged the program terminates.
Packit db3073
 * You can only set the levels defined by GLib to be fatal.
Packit db3073
 * %G_LOG_LEVEL_ERROR is always fatal.
Packit db3073
 *
Packit db3073
 * You can also make some message levels fatal at runtime by setting
Packit db3073
 * the <envar>G_DEBUG</envar> environment variable (see
Packit db3073
 * <ulink url="glib-running.html">Running GLib Applications</ulink>).
Packit db3073
 *
Packit db3073
 * Returns: the old fatal mask
Packit db3073
 */
Packit db3073
GLogLevelFlags
Packit db3073
g_log_set_always_fatal (GLogLevelFlags fatal_mask)
Packit db3073
{
Packit db3073
  GLogLevelFlags old_mask;
Packit db3073
Packit db3073
  /* restrict the global mask to levels that are known to glib
Packit db3073
   * since this setting applies to all domains
Packit db3073
   */
Packit db3073
  fatal_mask &= (1 << G_LOG_LEVEL_USER_SHIFT) - 1;
Packit db3073
  /* force errors to be fatal */
Packit db3073
  fatal_mask |= G_LOG_LEVEL_ERROR;
Packit db3073
  /* remove bogus flag */
Packit db3073
  fatal_mask &= ~G_LOG_FLAG_FATAL;
Packit db3073
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  old_mask = g_log_always_fatal;
Packit db3073
  g_log_always_fatal = fatal_mask;
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
Packit db3073
  return old_mask;
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_log_set_fatal_mask:
Packit db3073
 * @log_domain: the log domain
Packit db3073
 * @fatal_mask: the new fatal mask
Packit db3073
 *
Packit db3073
 * Sets the log levels which are fatal in the given domain.
Packit db3073
 * %G_LOG_LEVEL_ERROR is always fatal.
Packit db3073
 *
Packit db3073
 * Returns: the old fatal mask for the log domain
Packit db3073
 */
Packit db3073
GLogLevelFlags
Packit db3073
g_log_set_fatal_mask (const gchar   *log_domain,
Packit db3073
		      GLogLevelFlags fatal_mask)
Packit db3073
{
Packit db3073
  GLogLevelFlags old_flags;
Packit db3073
  register GLogDomain *domain;
Packit db3073
  
Packit db3073
  if (!log_domain)
Packit db3073
    log_domain = "";
Packit db3073
  
Packit db3073
  /* force errors to be fatal */
Packit db3073
  fatal_mask |= G_LOG_LEVEL_ERROR;
Packit db3073
  /* remove bogus flag */
Packit db3073
  fatal_mask &= ~G_LOG_FLAG_FATAL;
Packit db3073
  
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
Packit db3073
  domain = g_log_find_domain_L (log_domain);
Packit db3073
  if (!domain)
Packit db3073
    domain = g_log_domain_new_L (log_domain);
Packit db3073
  old_flags = domain->fatal_mask;
Packit db3073
  
Packit db3073
  domain->fatal_mask = fatal_mask;
Packit db3073
  g_log_domain_check_free_L (domain);
Packit db3073
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
Packit db3073
  return old_flags;
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_log_set_handler:
Packit db3073
 * @log_domain: (allow-none): the log domain, or %NULL for the default ""
Packit db3073
 *     application domain
Packit db3073
 * @log_levels: the log levels to apply the log handler for.
Packit db3073
 *     To handle fatal and recursive messages as well, combine
Packit db3073
 *     the log levels with the #G_LOG_FLAG_FATAL and
Packit db3073
 *     #G_LOG_FLAG_RECURSION bit flags.
Packit db3073
 * @log_func: the log handler function
Packit db3073
 * @user_data: data passed to the log handler
Packit db3073
 *
Packit db3073
 * Sets the log handler for a domain and a set of log levels.
Packit db3073
 * To handle fatal and recursive messages the @log_levels parameter
Packit db3073
 * must be combined with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION
Packit db3073
 * bit flags.
Packit db3073
 *
Packit db3073
 * Note that since the #G_LOG_LEVEL_ERROR log level is always fatal, if
Packit db3073
 * you want to set a handler for this log level you must combine it with
Packit db3073
 * #G_LOG_FLAG_FATAL.
Packit db3073
 *
Packit db3073
 * <example>
Packit db3073
 * <title>Adding a log handler for all warning messages in the default
Packit db3073
 * (application) domain</title>
Packit db3073
 * <programlisting>
Packit db3073
 * g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
Packit db3073
 *                    | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
Packit db3073
 * </programlisting>
Packit db3073
 * </example>
Packit db3073
 *
Packit db3073
 * <example>
Packit db3073
 * <title>Adding a log handler for all critical messages from GTK+</title>
Packit db3073
 * <programlisting>
Packit db3073
 * g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL
Packit db3073
 *                    | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
Packit db3073
 * </programlisting>
Packit db3073
 * </example>
Packit db3073
 *
Packit db3073
 * <example>
Packit db3073
 * <title>Adding a log handler for <emphasis>all</emphasis> messages from
Packit db3073
 * GLib</title>
Packit db3073
 * <programlisting>
Packit db3073
 * g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL
Packit db3073
 *                    | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
Packit db3073
 * </programlisting>
Packit db3073
 * </example>
Packit db3073
 *
Packit db3073
 * Returns: the id of the new handler
Packit db3073
 */
Packit db3073
guint
Packit db3073
g_log_set_handler (const gchar	 *log_domain,
Packit db3073
		   GLogLevelFlags log_levels,
Packit db3073
		   GLogFunc	  log_func,
Packit db3073
		   gpointer	  user_data)
Packit db3073
{
Packit db3073
  static guint handler_id = 0;
Packit db3073
  GLogDomain *domain;
Packit db3073
  GLogHandler *handler;
Packit db3073
  
Packit db3073
  g_return_val_if_fail ((log_levels & G_LOG_LEVEL_MASK) != 0, 0);
Packit db3073
  g_return_val_if_fail (log_func != NULL, 0);
Packit db3073
  
Packit db3073
  if (!log_domain)
Packit db3073
    log_domain = "";
Packit db3073
Packit db3073
  handler = g_new (GLogHandler, 1);
Packit db3073
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
Packit db3073
  domain = g_log_find_domain_L (log_domain);
Packit db3073
  if (!domain)
Packit db3073
    domain = g_log_domain_new_L (log_domain);
Packit db3073
  
Packit db3073
  handler->id = ++handler_id;
Packit db3073
  handler->log_level = log_levels;
Packit db3073
  handler->log_func = log_func;
Packit db3073
  handler->data = user_data;
Packit db3073
  handler->next = domain->handlers;
Packit db3073
  domain->handlers = handler;
Packit db3073
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
  
Packit db3073
  return handler_id;
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_log_set_default_handler:
Packit db3073
 * @log_func: the log handler function
Packit db3073
 * @user_data: data passed to the log handler
Packit db3073
 *
Packit db3073
 * Installs a default log handler which is used if no
Packit db3073
 * log handler has been set for the particular log domain
Packit db3073
 * and log level combination. By default, GLib uses
Packit db3073
 * g_log_default_handler() as default log handler.
Packit db3073
 *
Packit db3073
 * Returns: the previous default log handler
Packit db3073
 *
Packit db3073
 * Since: 2.6
Packit db3073
 */
Packit db3073
GLogFunc
Packit db3073
g_log_set_default_handler (GLogFunc log_func,
Packit db3073
			   gpointer user_data)
Packit db3073
{
Packit db3073
  GLogFunc old_log_func;
Packit db3073
  
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  old_log_func = default_log_func;
Packit db3073
  default_log_func = log_func;
Packit db3073
  default_log_data = user_data;
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
  
Packit db3073
  return old_log_func;
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_test_log_set_fatal_handler:
Packit db3073
 * @log_func: the log handler function.
Packit db3073
 * @user_data: data passed to the log handler.
Packit db3073
 *
Packit db3073
 * Installs a non-error fatal log handler which can be
Packit db3073
 * used to decide whether log messages which are counted
Packit db3073
 * as fatal abort the program.
Packit db3073
 *
Packit db3073
 * The use case here is that you are running a test case
Packit db3073
 * that depends on particular libraries or circumstances
Packit db3073
 * and cannot prevent certain known critical or warning
Packit db3073
 * messages. So you install a handler that compares the
Packit db3073
 * domain and message to precisely not abort in such a case.
Packit db3073
 *
Packit db3073
 * Note that the handler is reset at the beginning of
Packit db3073
 * any test case, so you have to set it inside each test
Packit db3073
 * function which needs the special behavior.
Packit db3073
 *
Packit db3073
 * This handler has no effect on g_error messages.
Packit db3073
 *
Packit db3073
 * Since: 2.22
Packit db3073
 **/
Packit db3073
void
Packit db3073
g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
Packit db3073
                              gpointer          user_data)
Packit db3073
{
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  fatal_log_func = log_func;
Packit db3073
  fatal_log_data = user_data;
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_log_remove_handler:
Packit db3073
 * @log_domain: the log domain
Packit db3073
 * @handler_id: the id of the handler, which was returned
Packit db3073
 *     in g_log_set_handler()
Packit db3073
 *
Packit db3073
 * Removes the log handler.
Packit db3073
 */
Packit db3073
void
Packit db3073
g_log_remove_handler (const gchar *log_domain,
Packit db3073
		      guint	   handler_id)
Packit db3073
{
Packit db3073
  register GLogDomain *domain;
Packit db3073
  
Packit db3073
  g_return_if_fail (handler_id > 0);
Packit db3073
  
Packit db3073
  if (!log_domain)
Packit db3073
    log_domain = "";
Packit db3073
  
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  domain = g_log_find_domain_L (log_domain);
Packit db3073
  if (domain)
Packit db3073
    {
Packit db3073
      GLogHandler *work, *last;
Packit db3073
      
Packit db3073
      last = NULL;
Packit db3073
      work = domain->handlers;
Packit db3073
      while (work)
Packit db3073
	{
Packit db3073
	  if (work->id == handler_id)
Packit db3073
	    {
Packit db3073
	      if (last)
Packit db3073
		last->next = work->next;
Packit db3073
	      else
Packit db3073
		domain->handlers = work->next;
Packit db3073
	      g_log_domain_check_free_L (domain); 
Packit db3073
	      g_mutex_unlock (&g_messages_lock);
Packit db3073
	      g_free (work);
Packit db3073
	      return;
Packit db3073
	    }
Packit db3073
	  last = work;
Packit db3073
	  work = last->next;
Packit db3073
	}
Packit db3073
    } 
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
  g_warning ("%s: could not find handler with id `%d' for domain \"%s\"",
Packit db3073
	     G_STRLOC, handler_id, log_domain);
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_logv:
Packit db3073
 * @log_domain: the log domain
Packit db3073
 * @log_level: the log level
Packit db3073
 * @format: the message format. See the printf() documentation
Packit db3073
 * @args: the parameters to insert into the format string
Packit db3073
 *
Packit db3073
 * Logs an error or debugging message.
Packit db3073
 *
Packit db3073
 * If the log level has been set as fatal, the abort()
Packit db3073
 * function is called to terminate the program.
Packit db3073
 */
Packit db3073
void
Packit db3073
g_logv (const gchar   *log_domain,
Packit db3073
	GLogLevelFlags log_level,
Packit db3073
	const gchar   *format,
Packit db3073
	va_list	       args1)
Packit db3073
{
Packit db3073
  gboolean was_fatal = (log_level & G_LOG_FLAG_FATAL) != 0;
Packit db3073
  gboolean was_recursion = (log_level & G_LOG_FLAG_RECURSION) != 0;
Packit db3073
  gint i;
Packit db3073
Packit db3073
  log_level &= G_LOG_LEVEL_MASK;
Packit db3073
  if (!log_level)
Packit db3073
    return;
Packit db3073
Packit db3073
  for (i = g_bit_nth_msf (log_level, -1); i >= 0; i = g_bit_nth_msf (log_level, i))
Packit db3073
    {
Packit db3073
      register GLogLevelFlags test_level;
Packit db3073
Packit db3073
      test_level = 1 << i;
Packit db3073
      if (log_level & test_level)
Packit db3073
	{
Packit db3073
	  GLogDomain *domain;
Packit db3073
	  GLogFunc log_func;
Packit db3073
	  GLogLevelFlags domain_fatal_mask;
Packit db3073
	  gpointer data = NULL;
Packit db3073
          gboolean masquerade_fatal = FALSE;
Packit db3073
          guint depth;
Packit db3073
Packit db3073
	  if (was_fatal)
Packit db3073
	    test_level |= G_LOG_FLAG_FATAL;
Packit db3073
	  if (was_recursion)
Packit db3073
	    test_level |= G_LOG_FLAG_RECURSION;
Packit db3073
Packit db3073
	  /* check recursion and lookup handler */
Packit db3073
	  g_mutex_lock (&g_messages_lock);
Packit db3073
          depth = GPOINTER_TO_UINT (g_private_get (&g_log_depth));
Packit db3073
	  domain = g_log_find_domain_L (log_domain ? log_domain : "");
Packit db3073
	  if (depth)
Packit db3073
	    test_level |= G_LOG_FLAG_RECURSION;
Packit db3073
	  depth++;
Packit db3073
	  domain_fatal_mask = domain ? domain->fatal_mask : G_LOG_FATAL_MASK;
Packit db3073
	  if ((domain_fatal_mask | g_log_always_fatal) & test_level)
Packit db3073
	    test_level |= G_LOG_FLAG_FATAL;
Packit db3073
	  if (test_level & G_LOG_FLAG_RECURSION)
Packit db3073
	    log_func = _g_log_fallback_handler;
Packit db3073
	  else
Packit db3073
	    log_func = g_log_domain_get_handler_L (domain, test_level, &data);
Packit db3073
	  domain = NULL;
Packit db3073
	  g_mutex_unlock (&g_messages_lock);
Packit db3073
Packit db3073
	  g_private_set (&g_log_depth, GUINT_TO_POINTER (depth));
Packit db3073
Packit db3073
Packit db3073
	  if (test_level & G_LOG_FLAG_RECURSION)
Packit db3073
	    {
Packit db3073
	      /* we use a stack buffer of fixed size, since we're likely
Packit db3073
	       * in an out-of-memory situation
Packit db3073
	       */
Packit db3073
	      gchar buffer[1025];
Packit db3073
              gsize size G_GNUC_UNUSED;
Packit db3073
              va_list args2;
Packit db3073
Packit db3073
              G_VA_COPY (args2, args1);
Packit db3073
	      size = _g_vsnprintf (buffer, 1024, format, args2);
Packit db3073
              va_end (args2);
Packit db3073
Packit db3073
	      log_func (log_domain, test_level, buffer, data);
Packit db3073
	    }
Packit db3073
	  else
Packit db3073
	    {
Packit db3073
	      gchar *msg;
Packit db3073
              va_list args2;
Packit db3073
Packit db3073
              G_VA_COPY (args2, args1);
Packit db3073
              msg = g_strdup_vprintf (format, args2);
Packit db3073
              va_end (args2);
Packit db3073
Packit db3073
	      log_func (log_domain, test_level, msg, data);
Packit db3073
Packit db3073
              if ((test_level & G_LOG_FLAG_FATAL)
Packit db3073
                && !(test_level & G_LOG_LEVEL_ERROR))
Packit db3073
                {
Packit db3073
                  masquerade_fatal = fatal_log_func
Packit db3073
                    && !fatal_log_func (log_domain, test_level, msg, fatal_log_data);
Packit db3073
                }
Packit db3073
Packit db3073
	      g_free (msg);
Packit db3073
	    }
Packit db3073
Packit db3073
	  if ((test_level & G_LOG_FLAG_FATAL) && !masquerade_fatal)
Packit db3073
            {
Packit db3073
#ifdef G_OS_WIN32
Packit db3073
	      gchar *locale_msg = g_locale_from_utf8 (fatal_msg_buf, -1, NULL, NULL, NULL);
Packit db3073
	      
Packit db3073
	      MessageBox (NULL, locale_msg, NULL,
Packit db3073
			  MB_ICONERROR|MB_SETFOREGROUND);
Packit db3073
	      if (IsDebuggerPresent () && !(test_level & G_LOG_FLAG_RECURSION))
Packit db3073
		G_BREAKPOINT ();
Packit db3073
	      else
Packit db3073
		abort ();
Packit db3073
#else
Packit db3073
	      if (!(test_level & G_LOG_FLAG_RECURSION))
Packit db3073
		G_BREAKPOINT ();
Packit db3073
	      else
Packit db3073
		abort ();
Packit db3073
#endif /* !G_OS_WIN32 */
Packit db3073
	    }
Packit db3073
	  
Packit db3073
	  depth--;
Packit db3073
	  g_private_set (&g_log_depth, GUINT_TO_POINTER (depth));
Packit db3073
	}
Packit db3073
    }
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_log:
Packit db3073
 * @log_domain: the log domain, usually #G_LOG_DOMAIN
Packit db3073
 * @log_level: the log level, either from #GLogLevelFlags
Packit db3073
 *     or a user-defined level
Packit db3073
 * @format: the message format. See the printf() documentation
Packit db3073
 * @...: the parameters to insert into the format string
Packit db3073
 *
Packit db3073
 * Logs an error or debugging message.
Packit db3073
 *
Packit db3073
 * If the log level has been set as fatal, the abort()
Packit db3073
 * function is called to terminate the program.
Packit db3073
 */
Packit db3073
void
Packit db3073
g_log (const gchar   *log_domain,
Packit db3073
       GLogLevelFlags log_level,
Packit db3073
       const gchar   *format,
Packit db3073
       ...)
Packit db3073
{
Packit db3073
  va_list args;
Packit db3073
  
Packit db3073
  va_start (args, format);
Packit db3073
  g_logv (log_domain, log_level, format, args);
Packit db3073
  va_end (args);
Packit db3073
}
Packit db3073
Packit db3073
void
Packit db3073
g_return_if_fail_warning (const char *log_domain,
Packit db3073
			  const char *pretty_function,
Packit db3073
			  const char *expression)
Packit db3073
{
Packit db3073
  g_log (log_domain,
Packit db3073
	 G_LOG_LEVEL_CRITICAL,
Packit db3073
	 "%s: assertion `%s' failed",
Packit db3073
	 pretty_function,
Packit db3073
	 expression);
Packit db3073
}
Packit db3073
Packit db3073
void
Packit db3073
g_warn_message (const char     *domain,
Packit db3073
                const char     *file,
Packit db3073
                int             line,
Packit db3073
                const char     *func,
Packit db3073
                const char     *warnexpr)
Packit db3073
{
Packit db3073
  char *s, lstr[32];
Packit db3073
  g_snprintf (lstr, 32, "%d", line);
Packit db3073
  if (warnexpr)
Packit db3073
    s = g_strconcat ("(", file, ":", lstr, "):",
Packit db3073
                     func, func[0] ? ":" : "",
Packit db3073
                     " runtime check failed: (", warnexpr, ")", NULL);
Packit db3073
  else
Packit db3073
    s = g_strconcat ("(", file, ":", lstr, "):",
Packit db3073
                     func, func[0] ? ":" : "",
Packit db3073
                     " ", "code should not be reached", NULL);
Packit db3073
  g_log (domain, G_LOG_LEVEL_WARNING, "%s", s);
Packit db3073
  g_free (s);
Packit db3073
}
Packit db3073
Packit db3073
void
Packit db3073
g_assert_warning (const char *log_domain,
Packit db3073
		  const char *file,
Packit db3073
		  const int   line,
Packit db3073
		  const char *pretty_function,
Packit db3073
		  const char *expression)
Packit db3073
{
Packit db3073
  g_log (log_domain,
Packit db3073
	 G_LOG_LEVEL_ERROR,
Packit db3073
	 expression 
Packit db3073
	 ? "file %s: line %d (%s): assertion failed: (%s)"
Packit db3073
	 : "file %s: line %d (%s): should not be reached",
Packit db3073
	 file, 
Packit db3073
	 line, 
Packit db3073
	 pretty_function,
Packit db3073
	 expression);
Packit db3073
  abort ();
Packit db3073
}
Packit db3073
Packit db3073
#define CHAR_IS_SAFE(wc) (!((wc < 0x20 && wc != '\t' && wc != '\n' && wc != '\r') || \
Packit db3073
			    (wc == 0x7f) || \
Packit db3073
			    (wc >= 0x80 && wc < 0xa0)))
Packit db3073
     
Packit db3073
static gchar*
Packit db3073
strdup_convert (const gchar *string,
Packit db3073
		const gchar *charset)
Packit db3073
{
Packit db3073
  if (!g_utf8_validate (string, -1, NULL))
Packit db3073
    {
Packit db3073
      GString *gstring = g_string_new ("[Invalid UTF-8] ");
Packit db3073
      guchar *p;
Packit db3073
Packit db3073
      for (p = (guchar *)string; *p; p++)
Packit db3073
	{
Packit db3073
	  if (CHAR_IS_SAFE(*p) &&
Packit db3073
	      !(*p == '\r' && *(p + 1) != '\n') &&
Packit db3073
	      *p < 0x80)
Packit db3073
	    g_string_append_c (gstring, *p);
Packit db3073
	  else
Packit db3073
	    g_string_append_printf (gstring, "\\x%02x", (guint)(guchar)*p);
Packit db3073
	}
Packit db3073
      
Packit db3073
      return g_string_free (gstring, FALSE);
Packit db3073
    }
Packit db3073
  else
Packit db3073
    {
Packit db3073
      GError *err = NULL;
Packit db3073
      
Packit db3073
      gchar *result = g_convert_with_fallback (string, -1, charset, "UTF-8", "?", NULL, NULL, &err;;
Packit db3073
      if (result)
Packit db3073
	return result;
Packit db3073
      else
Packit db3073
	{
Packit db3073
	  /* Not thread-safe, but doesn't matter if we print the warning twice
Packit db3073
	   */
Packit db3073
	  static gboolean warned = FALSE; 
Packit db3073
	  if (!warned)
Packit db3073
	    {
Packit db3073
	      warned = TRUE;
Packit db3073
	      _g_fprintf (stderr, "GLib: Cannot convert message: %s\n", err->message);
Packit db3073
	    }
Packit db3073
	  g_error_free (err);
Packit db3073
	  
Packit db3073
	  return g_strdup (string);
Packit db3073
	}
Packit db3073
    }
Packit db3073
}
Packit db3073
Packit db3073
/* For a radix of 8 we need at most 3 output bytes for 1 input
Packit db3073
 * byte. Additionally we might need up to 2 output bytes for the
Packit db3073
 * readix prefix and 1 byte for the trailing NULL.
Packit db3073
 */
Packit db3073
#define FORMAT_UNSIGNED_BUFSIZE ((GLIB_SIZEOF_LONG * 3) + 3)
Packit db3073
Packit db3073
static void
Packit db3073
format_unsigned (gchar  *buf,
Packit db3073
		 gulong  num,
Packit db3073
		 guint   radix)
Packit db3073
{
Packit db3073
  gulong tmp;
Packit db3073
  gchar c;
Packit db3073
  gint i, n;
Packit db3073
Packit db3073
  /* we may not call _any_ GLib functions here (or macros like g_return_if_fail()) */
Packit db3073
Packit db3073
  if (radix != 8 && radix != 10 && radix != 16)
Packit db3073
    {
Packit db3073
      *buf = '\000';
Packit db3073
      return;
Packit db3073
    }
Packit db3073
  
Packit db3073
  if (!num)
Packit db3073
    {
Packit db3073
      *buf++ = '0';
Packit db3073
      *buf = '\000';
Packit db3073
      return;
Packit db3073
    } 
Packit db3073
  
Packit db3073
  if (radix == 16)
Packit db3073
    {
Packit db3073
      *buf++ = '0';
Packit db3073
      *buf++ = 'x';
Packit db3073
    }
Packit db3073
  else if (radix == 8)
Packit db3073
    {
Packit db3073
      *buf++ = '0';
Packit db3073
    }
Packit db3073
	
Packit db3073
  n = 0;
Packit db3073
  tmp = num;
Packit db3073
  while (tmp)
Packit db3073
    {
Packit db3073
      tmp /= radix;
Packit db3073
      n++;
Packit db3073
    }
Packit db3073
Packit db3073
  i = n;
Packit db3073
Packit db3073
  /* Again we can't use g_assert; actually this check should _never_ fail. */
Packit db3073
  if (n > FORMAT_UNSIGNED_BUFSIZE - 3)
Packit db3073
    {
Packit db3073
      *buf = '\000';
Packit db3073
      return;
Packit db3073
    }
Packit db3073
Packit db3073
  while (num)
Packit db3073
    {
Packit db3073
      i--;
Packit db3073
      c = (num % radix);
Packit db3073
      if (c < 10)
Packit db3073
	buf[i] = c + '0';
Packit db3073
      else
Packit db3073
	buf[i] = c + 'a' - 10;
Packit db3073
      num /= radix;
Packit db3073
    }
Packit db3073
  
Packit db3073
  buf[n] = '\000';
Packit db3073
}
Packit db3073
Packit db3073
/* string size big enough to hold level prefix */
Packit db3073
#define	STRING_BUFFER_SIZE	(FORMAT_UNSIGNED_BUFSIZE + 32)
Packit db3073
Packit db3073
#define	ALERT_LEVELS		(G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
Packit db3073
Packit db3073
/* these are emitted by the default log handler */
Packit db3073
#define DEFAULT_LEVELS (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_MESSAGE)
Packit db3073
/* these are filtered by G_MESSAGES_DEBUG by the default log handler */
Packit db3073
#define INFO_LEVELS (G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG)
Packit db3073
Packit db3073
static int
Packit db3073
mklevel_prefix (gchar          level_prefix[STRING_BUFFER_SIZE],
Packit db3073
		GLogLevelFlags log_level)
Packit db3073
{
Packit db3073
  gboolean to_stdout = TRUE;
Packit db3073
Packit db3073
  /* we may not call _any_ GLib functions here */
Packit db3073
Packit db3073
  switch (log_level & G_LOG_LEVEL_MASK)
Packit db3073
    {
Packit db3073
    case G_LOG_LEVEL_ERROR:
Packit db3073
      strcpy (level_prefix, "ERROR");
Packit db3073
      to_stdout = FALSE;
Packit db3073
      break;
Packit db3073
    case G_LOG_LEVEL_CRITICAL:
Packit db3073
      strcpy (level_prefix, "CRITICAL");
Packit db3073
      to_stdout = FALSE;
Packit db3073
      break;
Packit db3073
    case G_LOG_LEVEL_WARNING:
Packit db3073
      strcpy (level_prefix, "WARNING");
Packit db3073
      to_stdout = FALSE;
Packit db3073
      break;
Packit db3073
    case G_LOG_LEVEL_MESSAGE:
Packit db3073
      strcpy (level_prefix, "Message");
Packit db3073
      to_stdout = FALSE;
Packit db3073
      break;
Packit db3073
    case G_LOG_LEVEL_INFO:
Packit db3073
      strcpy (level_prefix, "INFO");
Packit db3073
      break;
Packit db3073
    case G_LOG_LEVEL_DEBUG:
Packit db3073
      strcpy (level_prefix, "DEBUG");
Packit db3073
      break;
Packit db3073
    default:
Packit db3073
      if (log_level)
Packit db3073
	{
Packit db3073
	  strcpy (level_prefix, "LOG-");
Packit db3073
	  format_unsigned (level_prefix + 4, log_level & G_LOG_LEVEL_MASK, 16);
Packit db3073
	}
Packit db3073
      else
Packit db3073
	strcpy (level_prefix, "LOG");
Packit db3073
      break;
Packit db3073
    }
Packit db3073
  if (log_level & G_LOG_FLAG_RECURSION)
Packit db3073
    strcat (level_prefix, " (recursed)");
Packit db3073
  if (log_level & ALERT_LEVELS)
Packit db3073
    strcat (level_prefix, " **");
Packit db3073
Packit db3073
#ifdef G_OS_WIN32
Packit db3073
  win32_keep_fatal_message = (log_level & G_LOG_FLAG_FATAL) != 0;
Packit db3073
#endif
Packit db3073
  return to_stdout ? 1 : 2;
Packit db3073
}
Packit db3073
Packit db3073
void
Packit db3073
_g_log_fallback_handler (const gchar   *log_domain,
Packit db3073
			 GLogLevelFlags log_level,
Packit db3073
			 const gchar   *message,
Packit db3073
			 gpointer       unused_data)
Packit db3073
{
Packit db3073
  gchar level_prefix[STRING_BUFFER_SIZE];
Packit db3073
#ifndef G_OS_WIN32
Packit db3073
  gchar pid_string[FORMAT_UNSIGNED_BUFSIZE];
Packit db3073
#endif
Packit db3073
  int fd;
Packit db3073
Packit db3073
  /* we cannot call _any_ GLib functions in this fallback handler,
Packit db3073
   * which is why we skip UTF-8 conversion, etc.
Packit db3073
   * since we either recursed or ran out of memory, we're in a pretty
Packit db3073
   * pathologic situation anyways, what we can do is giving the
Packit db3073
   * the process ID unconditionally however.
Packit db3073
   */
Packit db3073
Packit db3073
  fd = mklevel_prefix (level_prefix, log_level);
Packit db3073
  if (!message)
Packit db3073
    message = "(NULL) message";
Packit db3073
Packit db3073
#ifndef G_OS_WIN32
Packit db3073
  format_unsigned (pid_string, getpid (), 10);
Packit db3073
#endif
Packit db3073
Packit db3073
  if (log_domain)
Packit db3073
    write_string (fd, "\n");
Packit db3073
  else
Packit db3073
    write_string (fd, "\n** ");
Packit db3073
Packit db3073
#ifndef G_OS_WIN32
Packit db3073
  write_string (fd, "(process:");
Packit db3073
  write_string (fd, pid_string);
Packit db3073
  write_string (fd, "): ");
Packit db3073
#endif
Packit db3073
Packit db3073
  if (log_domain)
Packit db3073
    {
Packit db3073
      write_string (fd, log_domain);
Packit db3073
      write_string (fd, "-");
Packit db3073
    }
Packit db3073
  write_string (fd, level_prefix);
Packit db3073
  write_string (fd, ": ");
Packit db3073
  write_string (fd, message);
Packit db3073
}
Packit db3073
Packit db3073
static void
Packit db3073
escape_string (GString *string)
Packit db3073
{
Packit db3073
  const char *p = string->str;
Packit db3073
  gunichar wc;
Packit db3073
Packit db3073
  while (p < string->str + string->len)
Packit db3073
    {
Packit db3073
      gboolean safe;
Packit db3073
	    
Packit db3073
      wc = g_utf8_get_char_validated (p, -1);
Packit db3073
      if (wc == (gunichar)-1 || wc == (gunichar)-2)  
Packit db3073
	{
Packit db3073
	  gchar *tmp;
Packit db3073
	  guint pos;
Packit db3073
Packit db3073
	  pos = p - string->str;
Packit db3073
Packit db3073
	  /* Emit invalid UTF-8 as hex escapes 
Packit db3073
           */
Packit db3073
	  tmp = g_strdup_printf ("\\x%02x", (guint)(guchar)*p);
Packit db3073
	  g_string_erase (string, pos, 1);
Packit db3073
	  g_string_insert (string, pos, tmp);
Packit db3073
Packit db3073
	  p = string->str + (pos + 4); /* Skip over escape sequence */
Packit db3073
Packit db3073
	  g_free (tmp);
Packit db3073
	  continue;
Packit db3073
	}
Packit db3073
      if (wc == '\r')
Packit db3073
	{
Packit db3073
	  safe = *(p + 1) == '\n';
Packit db3073
	}
Packit db3073
      else
Packit db3073
	{
Packit db3073
	  safe = CHAR_IS_SAFE (wc);
Packit db3073
	}
Packit db3073
      
Packit db3073
      if (!safe)
Packit db3073
	{
Packit db3073
	  gchar *tmp;
Packit db3073
	  guint pos;
Packit db3073
Packit db3073
	  pos = p - string->str;
Packit db3073
	  
Packit db3073
	  /* Largest char we escape is 0x0a, so we don't have to worry
Packit db3073
	   * about 8-digit \Uxxxxyyyy
Packit db3073
	   */
Packit db3073
	  tmp = g_strdup_printf ("\\u%04x", wc); 
Packit db3073
	  g_string_erase (string, pos, g_utf8_next_char (p) - p);
Packit db3073
	  g_string_insert (string, pos, tmp);
Packit db3073
	  g_free (tmp);
Packit db3073
Packit db3073
	  p = string->str + (pos + 6); /* Skip over escape sequence */
Packit db3073
	}
Packit db3073
      else
Packit db3073
	p = g_utf8_next_char (p);
Packit db3073
    }
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_log_default_handler:
Packit db3073
 * @log_domain: the log domain of the message
Packit db3073
 * @log_level: the level of the message
Packit db3073
 * @message: the message
Packit db3073
 * @unused_data: data passed from g_log() which is unused
Packit db3073
 *
Packit db3073
 * The default log handler set up by GLib; g_log_set_default_handler()
Packit db3073
 * allows to install an alternate default log handler.
Packit db3073
 * This is used if no log handler has been set for the particular log
Packit db3073
 * domain and log level combination. It outputs the message to stderr
Packit db3073
 * or stdout and if the log level is fatal it calls abort().
Packit db3073
 *
Packit db3073
 * The behavior of this log handler can be influenced by a number of
Packit db3073
 * environment variables:
Packit db3073
 * <variablelist>
Packit db3073
 *   <varlistentry>
Packit db3073
 *     <term><envar>G_MESSAGES_PREFIXED</envar></term>
Packit db3073
 *     <listitem>
Packit db3073
 *       A :-separated list of log levels for which messages should
Packit db3073
 *       be prefixed by the program name and PID of the aplication.
Packit db3073
 *     </listitem>
Packit db3073
 *   </varlistentry>
Packit db3073
 *   <varlistentry>
Packit db3073
 *     <term><envar>G_MESSAGES_DEBUG</envar></term>
Packit db3073
 *     <listitem>
Packit db3073
 *       A space-separated list of log domains for which debug and
Packit db3073
 *       informational messages are printed. By default these
Packit db3073
 *       messages are not printed.
Packit db3073
 *     </listitem>
Packit db3073
 *   </varlistentry>
Packit db3073
 * </variablelist>
Packit db3073
 *
Packit db3073
 * stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL,
Packit db3073
 * %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for
Packit db3073
 * the rest.
Packit db3073
 */
Packit db3073
void
Packit db3073
g_log_default_handler (const gchar   *log_domain,
Packit db3073
		       GLogLevelFlags log_level,
Packit db3073
		       const gchar   *message,
Packit db3073
		       gpointer	      unused_data)
Packit db3073
{
Packit db3073
  gchar level_prefix[STRING_BUFFER_SIZE], *string;
Packit db3073
  GString *gstring;
Packit db3073
  int fd;
Packit db3073
  const gchar *domains;
Packit db3073
Packit db3073
  if ((log_level & DEFAULT_LEVELS) || (log_level >> G_LOG_LEVEL_USER_SHIFT))
Packit db3073
    goto emit;
Packit db3073
Packit db3073
  domains = g_getenv ("G_MESSAGES_DEBUG");
Packit db3073
  if (((log_level & INFO_LEVELS) == 0) ||
Packit db3073
      domains == NULL ||
Packit db3073
      (strcmp (domains, "all") != 0 && (!log_domain || !strstr (domains, log_domain))))
Packit db3073
    return;
Packit db3073
Packit db3073
 emit:
Packit db3073
  /* we can be called externally with recursion for whatever reason */
Packit db3073
  if (log_level & G_LOG_FLAG_RECURSION)
Packit db3073
    {
Packit db3073
      _g_log_fallback_handler (log_domain, log_level, message, unused_data);
Packit db3073
      return;
Packit db3073
    }
Packit db3073
Packit db3073
  fd = mklevel_prefix (level_prefix, log_level);
Packit db3073
Packit db3073
  gstring = g_string_new (NULL);
Packit db3073
  if (log_level & ALERT_LEVELS)
Packit db3073
    g_string_append (gstring, "\n");
Packit db3073
  if (!log_domain)
Packit db3073
    g_string_append (gstring, "** ");
Packit db3073
Packit db3073
  if ((g_log_msg_prefix & (log_level & G_LOG_LEVEL_MASK)) == (log_level & G_LOG_LEVEL_MASK))
Packit db3073
    {
Packit db3073
      const gchar *prg_name = g_get_prgname ();
Packit db3073
      
Packit db3073
      if (!prg_name)
Packit db3073
	g_string_append_printf (gstring, "(process:%lu): ", (gulong)getpid ());
Packit db3073
      else
Packit db3073
	g_string_append_printf (gstring, "(%s:%lu): ", prg_name, (gulong)getpid ());
Packit db3073
    }
Packit db3073
Packit db3073
  if (log_domain)
Packit db3073
    {
Packit db3073
      g_string_append (gstring, log_domain);
Packit db3073
      g_string_append_c (gstring, '-');
Packit db3073
    }
Packit db3073
  g_string_append (gstring, level_prefix);
Packit db3073
Packit db3073
  g_string_append (gstring, ": ");
Packit db3073
  if (!message)
Packit db3073
    g_string_append (gstring, "(NULL) message");
Packit db3073
  else
Packit db3073
    {
Packit db3073
      GString *msg;
Packit db3073
      const gchar *charset;
Packit db3073
Packit db3073
      msg = g_string_new (message);
Packit db3073
      escape_string (msg);
Packit db3073
Packit db3073
      if (g_get_charset (&charset))
Packit db3073
	g_string_append (gstring, msg->str);	/* charset is UTF-8 already */
Packit db3073
      else
Packit db3073
	{
Packit db3073
	  string = strdup_convert (msg->str, charset);
Packit db3073
	  g_string_append (gstring, string);
Packit db3073
	  g_free (string);
Packit db3073
	}
Packit db3073
Packit db3073
      g_string_free (msg, TRUE);
Packit db3073
    }
Packit db3073
  g_string_append (gstring, "\n");
Packit db3073
Packit db3073
  string = g_string_free (gstring, FALSE);
Packit db3073
Packit db3073
  write_string (fd, string);
Packit db3073
  g_free (string);
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_set_print_handler:
Packit db3073
 * @func: the new print handler
Packit db3073
 *
Packit db3073
 * Sets the print handler.
Packit db3073
 *
Packit db3073
 * Any messages passed to g_print() will be output via
Packit db3073
 * the new handler. The default handler simply outputs
Packit db3073
 * the message to stdout. By providing your own handler
Packit db3073
 * you can redirect the output, to a GTK+ widget or a
Packit db3073
 * log file for example.
Packit db3073
 *
Packit db3073
 * Returns: the old print handler
Packit db3073
 */
Packit db3073
GPrintFunc
Packit db3073
g_set_print_handler (GPrintFunc func)
Packit db3073
{
Packit db3073
  GPrintFunc old_print_func;
Packit db3073
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  old_print_func = glib_print_func;
Packit db3073
  glib_print_func = func;
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
Packit db3073
  return old_print_func;
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_print:
Packit db3073
 * @format: the message format. See the printf() documentation
Packit db3073
 * @...: the parameters to insert into the format string
Packit db3073
 *
Packit db3073
 * Outputs a formatted message via the print handler.
Packit db3073
 * The default print handler simply outputs the message to stdout.
Packit db3073
 *
Packit db3073
 * g_print() should not be used from within libraries for debugging
Packit db3073
 * messages, since it may be redirected by applications to special
Packit db3073
 * purpose message windows or even files. Instead, libraries should
Packit db3073
 * use g_log(), or the convenience functions g_message(), g_warning()
Packit db3073
 * and g_error().
Packit db3073
 */
Packit db3073
void
Packit db3073
g_print (const gchar *format,
Packit db3073
         ...)
Packit db3073
{
Packit db3073
  va_list args;
Packit db3073
  gchar *string;
Packit db3073
  GPrintFunc local_glib_print_func;
Packit db3073
Packit db3073
  g_return_if_fail (format != NULL);
Packit db3073
Packit db3073
  va_start (args, format);
Packit db3073
  string = g_strdup_vprintf (format, args);
Packit db3073
  va_end (args);
Packit db3073
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  local_glib_print_func = glib_print_func;
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
Packit db3073
  if (local_glib_print_func)
Packit db3073
    local_glib_print_func (string);
Packit db3073
  else
Packit db3073
    {
Packit db3073
      const gchar *charset;
Packit db3073
Packit db3073
      if (g_get_charset (&charset))
Packit db3073
        fputs (string, stdout); /* charset is UTF-8 already */
Packit db3073
      else
Packit db3073
        {
Packit db3073
          gchar *lstring = strdup_convert (string, charset);
Packit db3073
Packit db3073
          fputs (lstring, stdout);
Packit db3073
          g_free (lstring);
Packit db3073
        }
Packit db3073
      fflush (stdout);
Packit db3073
    }
Packit db3073
  g_free (string);
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_set_printerr_handler:
Packit db3073
 * @func: the new error message handler
Packit db3073
 *
Packit db3073
 * Sets the handler for printing error messages.
Packit db3073
 *
Packit db3073
 * Any messages passed to g_printerr() will be output via
Packit db3073
 * the new handler. The default handler simply outputs the
Packit db3073
 * message to stderr. By providing your own handler you can
Packit db3073
 * redirect the output, to a GTK+ widget or a log file for
Packit db3073
 * example.
Packit db3073
 *
Packit db3073
 * Returns: the old error message handler
Packit db3073
 */
Packit db3073
GPrintFunc
Packit db3073
g_set_printerr_handler (GPrintFunc func)
Packit db3073
{
Packit db3073
  GPrintFunc old_printerr_func;
Packit db3073
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  old_printerr_func = glib_printerr_func;
Packit db3073
  glib_printerr_func = func;
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
Packit db3073
  return old_printerr_func;
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_printerr:
Packit db3073
 * @format: the message format. See the printf() documentation
Packit db3073
 * @...: the parameters to insert into the format string
Packit db3073
 *
Packit db3073
 * Outputs a formatted message via the error message handler.
Packit db3073
 * The default handler simply outputs the message to stderr.
Packit db3073
 *
Packit db3073
 * g_printerr() should not be used from within libraries.
Packit db3073
 * Instead g_log() should be used, or the convenience functions
Packit db3073
 * g_message(), g_warning() and g_error().
Packit db3073
 */
Packit db3073
void
Packit db3073
g_printerr (const gchar *format,
Packit db3073
            ...)
Packit db3073
{
Packit db3073
  va_list args;
Packit db3073
  gchar *string;
Packit db3073
  GPrintFunc local_glib_printerr_func;
Packit db3073
Packit db3073
  g_return_if_fail (format != NULL);
Packit db3073
Packit db3073
  va_start (args, format);
Packit db3073
  string = g_strdup_vprintf (format, args);
Packit db3073
  va_end (args);
Packit db3073
Packit db3073
  g_mutex_lock (&g_messages_lock);
Packit db3073
  local_glib_printerr_func = glib_printerr_func;
Packit db3073
  g_mutex_unlock (&g_messages_lock);
Packit db3073
Packit db3073
  if (local_glib_printerr_func)
Packit db3073
    local_glib_printerr_func (string);
Packit db3073
  else
Packit db3073
    {
Packit db3073
      const gchar *charset;
Packit db3073
Packit db3073
      if (g_get_charset (&charset))
Packit db3073
        fputs (string, stderr); /* charset is UTF-8 already */
Packit db3073
      else
Packit db3073
        {
Packit db3073
          gchar *lstring = strdup_convert (string, charset);
Packit db3073
Packit db3073
          fputs (lstring, stderr);
Packit db3073
          g_free (lstring);
Packit db3073
        }
Packit db3073
      fflush (stderr);
Packit db3073
    }
Packit db3073
  g_free (string);
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_printf_string_upper_bound:
Packit db3073
 * @format: the format string. See the printf() documentation
Packit db3073
 * @args: the parameters to be inserted into the format string
Packit db3073
 *
Packit db3073
 * Calculates the maximum space needed to store the output
Packit db3073
 * of the sprintf() function.
Packit db3073
 *
Packit db3073
 * Returns: the maximum space needed to store the formatted string
Packit db3073
 */
Packit db3073
gsize
Packit db3073
g_printf_string_upper_bound (const gchar *format,
Packit db3073
                             va_list      args)
Packit db3073
{
Packit db3073
  gchar c;
Packit db3073
  return _g_vsnprintf (&c, 1, format, args) + 1;
Packit db3073
}