qoflog.h

/* qof-log.h
 * Author: Rob Clark <rclark@cs.hmc.edu>
 * Copyright (C) 1998-2003 Linas Vepstas <linas@linas.org>
 * Copyright 2005 Neil Williams <linux@codehelp.co.uk>
 * Copyright 2007 Joshua Sled <jsled@asynchronous.org>
 */
 
/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 *  02110-1301,  USA
 */
 
#ifndef _QOF_LOG_H
#define _QOF_LOG_H
 
#include <stdarg.h>
#include <stdio.h>
#include <glib.h>
#include "qofutil.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef const gchar* QofLogModule;
 
#define QOF_MOD_ENGINE "qof.engine"
 
typedef enum
{
    QOF_LOG_FATAL   = G_LOG_LEVEL_ERROR,
    QOF_LOG_ERROR   = G_LOG_LEVEL_CRITICAL,
    QOF_LOG_WARNING = G_LOG_LEVEL_WARNING,
    QOF_LOG_MESSAGE = G_LOG_LEVEL_MESSAGE,
    QOF_LOG_INFO    = G_LOG_LEVEL_INFO,
    QOF_LOG_DEBUG   = G_LOG_LEVEL_DEBUG
} QofLogLevel;
 
const char* qof_log_level_to_string(QofLogLevel lvl);
QofLogLevel qof_log_level_from_string(const char *str);
 
void qof_log_indent(void);
 
void qof_log_dedent(void);
 
void qof_log_init (void);
 
void qof_log_set_level(QofLogModule module, QofLogLevel level);
 
void qof_log_set_file (FILE *outfile);
 
void qof_log_init_filename (const gchar* logfilename);
 
void qof_log_init_filename_special(const char *log_to_filename);
 
void qof_log_parse_log_config(const char *filename);
 
void qof_log_shutdown (void);
 
const gchar * qof_log_prettify (const gchar *name);
 
gboolean qof_log_check(QofLogModule log_module, QofLogLevel log_level);
 
#define PRETTY_FUNC_NAME qof_log_prettify(G_STRFUNC)
 
#ifdef _MSC_VER
/* Microsoft Visual Studio: MSVC compiler has a different syntax for
 * macros with variadic argument list. */
 
/* TODO: After the C++2a feature __VA_OPT__ gets implemented in both
 * flavors, it should be inserted before __VA_ARGS__ and the else branch
 * gets obsolete and should be removed.
 */
 
#define FATAL(format, ...) do { \
    g_log (log_module, G_LOG_LEVEL_ERROR, \
      "[%s()] " format, PRETTY_FUNC_NAME , __VA_ARGS__); \
} while (0)
 
#define PERR(format, ...) do { \
    g_log (log_module, G_LOG_LEVEL_CRITICAL, \
      "[%s()] " format, PRETTY_FUNC_NAME , __VA_ARGS__); \
} while (0)
 
#define PWARN(format, ...) do { \
    g_log (log_module, G_LOG_LEVEL_WARNING, \
      "[%s()] " format, PRETTY_FUNC_NAME , __VA_ARGS__); \
} while (0)
 
#define PINFO(format, ...) \
    if (qof_log_check(log_module, QOF_LOG_INFO) {    \
    g_log (log_module, G_LOG_LEVEL_INFO, \
      "[%s] " format, PRETTY_FUNC_NAME , __VA_ARGS__); \
}
 
#define DEBUG(format, ...) \
    if (qof_log_check(log_module, QOF_LOG_DEBUG) {    \
        g_log (log_module, G_LOG_LEVEL_DEBUG,                           \
               "[%s] " format, PRETTY_FUNC_NAME , __VA_ARGS__);         \
}
 
#define ENTER(format, ...) \
    if (qof_log_check(log_module, QOFLOG_DEBUG)) { \
      g_log (log_module, G_LOG_LEVEL_DEBUG, \
        "[enter %s:%s()] " format, __FILE__, \
        PRETTY_FUNC_NAME , __VA_ARGS__); \
      qof_log_indent(); \
}
 
#define LEAVE(format, ...) \
    if (qof_log_check(log_module, QOF_LOG_DEBUG)) { \
      qof_log_dedent(); \
      g_log (log_module, G_LOG_LEVEL_DEBUG, \
        "[leave %s()] " format, \
        PRETTY_FUNC_NAME , __VA_ARGS__); \
}
 
#else /* _MSC_VER */
 
#define FATAL(format, args...) do { \
    g_log (log_module, G_LOG_LEVEL_ERROR, \
      "[%s()] " format, PRETTY_FUNC_NAME , ## args); \
} while (0)
 
#define PERR(format, args...) do { \
    g_log (log_module, G_LOG_LEVEL_CRITICAL, \
      "[%s()] " format, PRETTY_FUNC_NAME , ## args); \
} while (0)
 
#define PWARN(format, args...) do { \
    g_log (log_module, G_LOG_LEVEL_WARNING, \
      "[%s()] " format, PRETTY_FUNC_NAME , ## args); \
} while (0)
 
#define PINFO(format, args...) do {                  \
    if (qof_log_check(log_module, QOF_LOG_INFO)) {   \
        g_log (log_module, G_LOG_LEVEL_INFO,         \
               "[%s] " format, PRETTY_FUNC_NAME , ## args);     \
    } \
} while (0)
 
#define DEBUG(format, args...) do {                      \
    if (qof_log_check(log_module, QOF_LOG_DEBUG)) {      \
        g_log (log_module, G_LOG_LEVEL_DEBUG,         \
               "[%s] " format, PRETTY_FUNC_NAME , ## args);     \
    } \
} while(0)
 
#define ENTER(format, args...) do {                     \
    if (qof_log_check(log_module, QOF_LOG_DEBUG)) {     \
        g_log (log_module, G_LOG_LEVEL_DEBUG,           \
               "[enter %s:%s()] " format, __FILE__,     \
               PRETTY_FUNC_NAME , ## args);             \
        qof_log_indent();                               \
    } \
} while (0)
 
#define LEAVE(format, args...) do {                     \
    if (qof_log_check(log_module, QOF_LOG_DEBUG)) {     \
        qof_log_dedent();                               \
        g_log (log_module, G_LOG_LEVEL_DEBUG,           \
               "[leave %s()] " format,                  \
               PRETTY_FUNC_NAME , ## args);             \
    }                                                   \
} while (0)
 
#endif /* _MSC_VER */
 
#define gnc_leave_return_val_if_fail(test, val) do { \
  if (! (test)) { LEAVE(""); } \
  g_return_val_if_fail(test, val); \
} while (0);
 
#define gnc_leave_return_if_fail(test) do { \
  if (! (test)) { LEAVE(""); } \
  g_return_if_fail(test); \
} while (0);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* _QOF_LOG_H */