gmessages.h

Go to the documentation of this file.

/* 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/. 
 */

#ifndef __G_MESSAGES_H__
#define __G_MESSAGES_H__

#include <stdarg.h>
#include <glib/gtypes.h>

G_BEGIN_DECLS

/* calculate a string size, guarranteed to fit format + args.
 */
gsize g_printf_string_upper_bound (const gchar* format,
                 va_list     args);

/* Log level shift offset for user defined
 * log levels (0-7 are used by GLib).
 */
#define G_LOG_LEVEL_USER_SHIFT  (8)

/* Glib log levels and flags.
 */
typedef enum
{
  /* log flags */
  G_LOG_FLAG_RECURSION          = 1 << 0,
  G_LOG_FLAG_FATAL              = 1 << 1,

  /* GLib log levels */
  G_LOG_LEVEL_ERROR             = 1 << 2,       /* always fatal */
  G_LOG_LEVEL_CRITICAL          = 1 << 3,
  G_LOG_LEVEL_WARNING           = 1 << 4,
  G_LOG_LEVEL_MESSAGE           = 1 << 5,
  G_LOG_LEVEL_INFO              = 1 << 6,
  G_LOG_LEVEL_DEBUG             = 1 << 7,

  G_LOG_LEVEL_MASK              = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
} GLogLevelFlags;

/* GLib log levels that are considered fatal by default */
#define G_LOG_FATAL_MASK        (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)

typedef void            (*GLogFunc)             (const gchar   *log_domain,
                                                 GLogLevelFlags log_level,
                                                 const gchar   *message,
                                                 gpointer       user_data);

/* Logging mechanism
 */
GLIB_VAR        const gchar             *g_log_domain_glib;
guint           g_log_set_handler       (const gchar    *log_domain,
                                         GLogLevelFlags  log_levels,
                                         GLogFunc        log_func,
                                         gpointer        user_data);
void            g_log_remove_handler    (const gchar    *log_domain,
                                         guint           handler_id);
void            g_log_default_handler   (const gchar    *log_domain,
                                         GLogLevelFlags  log_level,
                                         const gchar    *message,
                                         gpointer        unused_data);
void            g_log                   (const gchar    *log_domain,
                                         GLogLevelFlags  log_level,
                                         const gchar    *format,
                                         ...) G_GNUC_PRINTF (3, 4);
void            g_logv                  (const gchar    *log_domain,
                                         GLogLevelFlags  log_level,
                                         const gchar    *format,
                                         va_list         args);
GLogLevelFlags  g_log_set_fatal_mask    (const gchar    *log_domain,
                                         GLogLevelFlags  fatal_mask);
GLogLevelFlags  g_log_set_always_fatal  (GLogLevelFlags  fatal_mask);

#ifndef G_LOG_DOMAIN
#define G_LOG_DOMAIN    ((gchar*) 0)
#endif  /* G_LOG_DOMAIN */
#ifdef G_HAVE_ISO_VARARGS
#define g_error(...)    g_log (G_LOG_DOMAIN,         \
                               G_LOG_LEVEL_ERROR,    \
                               __VA_ARGS__)
#define g_message(...)  g_log (G_LOG_DOMAIN,         \
                               G_LOG_LEVEL_MESSAGE,  \
                               __VA_ARGS__)
#define g_critical(...) g_log (G_LOG_DOMAIN,         \
                               G_LOG_LEVEL_CRITICAL, \
                               __VA_ARGS__)
#define g_warning(...)  g_log (G_LOG_DOMAIN,         \
                               G_LOG_LEVEL_WARNING,  \
                               __VA_ARGS__)
#elif defined(G_HAVE_GNUC_VARARGS)
#define g_error(format...)      g_log (G_LOG_DOMAIN,         \
                                       G_LOG_LEVEL_ERROR,    \
                                       format)
#define g_message(format...)    g_log (G_LOG_DOMAIN,         \
                                       G_LOG_LEVEL_MESSAGE,  \
                                       format)
#define g_critical(format...)   g_log (G_LOG_DOMAIN,         \
                                       G_LOG_LEVEL_CRITICAL, \
                                       format)
#define g_warning(format...)    g_log (G_LOG_DOMAIN,         \
                                       G_LOG_LEVEL_WARNING,  \
                                       format)
#else   /* no varargs macros */
static void
g_error (const gchar *format,
         ...)
{
  va_list args;
  va_start (args, format);
  g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
  va_end (args);
}
static void
g_message (const gchar *format,
           ...)
{
  va_list args;
  va_start (args, format);
  g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
  va_end (args);
}
static void
g_critical (const gchar *format,
            ...)
{
  va_list args;
  va_start (args, format);
  g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
  va_end (args);
}
static void
g_warning (const gchar *format,
           ...)
{
  va_list args;
  va_start (args, format);
  g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
  va_end (args);
}
#endif  /* !__GNUC__ */

typedef void    (*GPrintFunc)           (const gchar    *string);
void            g_print                 (const gchar    *format,
                                         ...) G_GNUC_PRINTF (1, 2);
GPrintFunc      g_set_print_handler     (GPrintFunc      func);
void            g_printerr              (const gchar    *format,
                                         ...) G_GNUC_PRINTF (1, 2);
GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);


/* Provide macros for error handling. The "assert" macros will
 *  exit on failure. The "return" macros will exit the current
 *  function. Two different definitions are given for the macros
 *  if G_DISABLE_ASSERT is not defined, in order to support gcc's
 *  __PRETTY_FUNCTION__ capability.
 */

#ifdef G_DISABLE_ASSERT

#define g_assert(expr)     G_STMT_START{ }G_STMT_END
#define g_assert_not_reached()   G_STMT_START{ }G_STMT_END

#else /* !G_DISABLE_ASSERT */

#ifdef __GNUC__

#define g_assert(expr)        G_STMT_START{     \
     if (!(expr))                \
       g_log (G_LOG_DOMAIN,               \
         G_LOG_LEVEL_ERROR,            \
         "file %s: line %d (%s): assertion failed: (%s)",   \
         __FILE__,                  \
         __LINE__,                  \
         __PRETTY_FUNCTION__,          \
         #expr);        }G_STMT_END

#define g_assert_not_reached()      G_STMT_START{     \
     g_log (G_LOG_DOMAIN,              \
       G_LOG_LEVEL_ERROR,              \
       "file %s: line %d (%s): should not be reached",   \
       __FILE__,                 \
       __LINE__,                 \
       __PRETTY_FUNCTION__);  }G_STMT_END

#else /* !__GNUC__ */

#define g_assert(expr)        G_STMT_START{     \
     if (!(expr))                \
       g_log (G_LOG_DOMAIN,               \
         G_LOG_LEVEL_ERROR,            \
         "file %s: line %d: assertion failed: (%s)",  \
         __FILE__,                  \
         __LINE__,                  \
         #expr);        }G_STMT_END

#define g_assert_not_reached()      G_STMT_START{  \
     g_log (G_LOG_DOMAIN,           \
       G_LOG_LEVEL_ERROR,           \
       "file %s: line %d: should not be reached",  \
       __FILE__,              \
       __LINE__);    }G_STMT_END

#endif /* __GNUC__ */

#endif /* !G_DISABLE_ASSERT */


#ifdef G_DISABLE_CHECKS

#define g_return_if_fail(expr)         G_STMT_START{ }G_STMT_END
#define g_return_val_if_fail(expr,val)    G_STMT_START{ }G_STMT_END
#define g_return_if_reached()       G_STMT_START{ return; }G_STMT_END
#define g_return_val_if_reached(val)      G_STMT_START{ return (val); }G_STMT_END

#else /* !G_DISABLE_CHECKS */

#ifdef __GNUC__

#define g_return_if_fail(expr)      G_STMT_START{        \
     if (!(expr))                   \
       {                      \
    g_log (G_LOG_DOMAIN,                  \
      G_LOG_LEVEL_CRITICAL,               \
      "file %s: line %d (%s): assertion `%s' failed",    \
      __FILE__,                  \
      __LINE__,                  \
      __PRETTY_FUNCTION__,             \
      #expr);                    \
    return;                   \
       };            }G_STMT_END

#define g_return_val_if_fail(expr,val) G_STMT_START{        \
     if (!(expr))                   \
       {                      \
    g_log (G_LOG_DOMAIN,                  \
      G_LOG_LEVEL_CRITICAL,               \
      "file %s: line %d (%s): assertion `%s' failed",    \
      __FILE__,                  \
      __LINE__,                  \
      __PRETTY_FUNCTION__,             \
      #expr);                    \
    return (val);                   \
       };            }G_STMT_END

#define g_return_if_reached()    G_STMT_START{        \
     g_log (G_LOG_DOMAIN,                 \
       G_LOG_LEVEL_CRITICAL,              \
       "file %s: line %d (%s): should not be reached",      \
       __FILE__,                    \
       __LINE__,                    \
       __PRETTY_FUNCTION__);              \
     return;            }G_STMT_END

#define g_return_val_if_reached(val)   G_STMT_START{        \
     g_log (G_LOG_DOMAIN,                 \
       G_LOG_LEVEL_CRITICAL,              \
       "file %s: line %d (%s): should not be reached",      \
       __FILE__,                    \
       __LINE__,                    \
       __PRETTY_FUNCTION__);              \
     return (val);         }G_STMT_END

#else /* !__GNUC__ */

#define g_return_if_fail(expr)      G_STMT_START{     \
     if (!(expr))                \
       {                   \
    g_log (G_LOG_DOMAIN,               \
      G_LOG_LEVEL_CRITICAL,            \
      "file %s: line %d: assertion `%s' failed",   \
      __FILE__,               \
      __LINE__,               \
      #expr);                 \
    return;                \
       };            }G_STMT_END

#define g_return_val_if_fail(expr, val)   G_STMT_START{     \
     if (!(expr))                \
       {                   \
    g_log (G_LOG_DOMAIN,               \
      G_LOG_LEVEL_CRITICAL,            \
      "file %s: line %d: assertion `%s' failed",   \
      __FILE__,               \
      __LINE__,               \
      #expr);                 \
    return (val);                \
       };            }G_STMT_END

#define g_return_if_reached()    G_STMT_START{     \
     g_log (G_LOG_DOMAIN,              \
       G_LOG_LEVEL_CRITICAL,           \
       "file %s: line %d: should not be reached",     \
       __FILE__,                 \
       __LINE__);                \
     return;            }G_STMT_END

#define g_return_val_if_reached(val)   G_STMT_START{     \
     g_log (G_LOG_DOMAIN,              \
       G_LOG_LEVEL_CRITICAL,           \
       "file %s: line %d: should not be reached",     \
       __FILE__,                 \
       __LINE__);                \
     return (val);         }G_STMT_END

#endif /* !__GNUC__ */

#endif /* !G_DISABLE_CHECKS */

G_END_DECLS

#endif /* __G_MESSAGES_H__ */