qoflog.h

Go to the documentation of this file.

/***************************************************************************
 *            qof-log.h
 *
 *  Mon Nov 21 14:35:26 2005
 *  Author: Rob Clark (rclark@cs.hmc.edu)
 *  Copyright (C) 1998-2003 Linas Vepstas <linas@linas.org>
 *  Copyright  2005  Neil Williams
 *  linux@codehelp.co.uk
 ****************************************************************************/
/*
 *  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 "qofutil.h"

#define QOF_MOD_ENGINE "qof-engine"

#define LOG_LEVEL_LIST(_) \
  _(QOF_LOG_FATAL, = 0)   \
  _(QOF_LOG_ERROR, = 1)   \
  _(QOF_LOG_WARNING, = 2) \
  _(QOF_LOG_INFO, = 3)    \
  _(QOF_LOG_DEBUG, = 4)   \
  _(QOF_LOG_DETAIL, = 5)  \
  _(QOF_LOG_TRACE, = 6)

DEFINE_ENUM (QofLogLevel, LOG_LEVEL_LIST) 


AS_STRING_DEC (QofLogLevel, LOG_LEVEL_LIST)

FROM_STRING_DEC (QofLogLevel, LOG_LEVEL_LIST)

void qof_log_add_indent (void);

gint qof_log_get_indent (void);

void qof_log_drop_indent (void);

void qof_log_init (void);

void qof_log_set_level (QofLogModule module, QofLogLevel level);

void qof_log_set_level_registered (QofLogLevel level);

void qof_log_set_file (FILE * outfile);

void qof_log_init_filename (const gchar * logfilename);

void qof_log_shutdown (void);

const gchar *qof_log_prettify (const gchar * name);

gboolean qof_log_check (QofLogModule log_module, QofLogLevel log_level);

void qof_log_set_default (QofLogLevel log_level);

typedef void (*QofLogCB) (QofLogModule log_module,
                       QofLogLevel * log_level, gpointer user_data);

void qof_log_module_foreach (QofLogCB cb, gpointer data);

gint qof_log_module_count (void);

#define FUNK qof_log_prettify(__FUNCTION__)

#define FATAL(format, args...) do {                  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR,          \
      "Fatal Error: %s(): " format, FUNK , ## args); \
} while (0)

#define PERR(format, args...) do {                   \
  if (qof_log_check (log_module, QOF_LOG_ERROR)) {   \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,     \
      "Error: %s(): " format, FUNK , ## args);     \
  }                                                \
} while (0)

#define PWARN(format, args...) do {                    \
  if (qof_log_check (log_module, QOF_LOG_WARNING)) {   \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING,      \
      "Warning: %s(): " format, FUNK , ## args);   \
  }                                                \
} while (0)

#define PINFO(format, args...) do {                 \
  if (qof_log_check (log_module, QOF_LOG_INFO)) {   \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO,         \
      "Info: %s(): " format,                       \
      FUNK , ## args);                             \
  }                                                \
} while (0)

#define DEBUG(format, args...) do {                 \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Debug: %s(): " format,                      \
      FUNK , ## args);                             \
  }                                                \
} while (0)

#define ENTER(format, args...) do {                 \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Enter in %s: %s()" format, __FILE__,        \
      FUNK , ## args);                             \
    qof_log_add_indent();                           \
  }                                                \
} while (0)

#define LEAVE(format, args...) do {                 \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
    qof_log_drop_indent();                          \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Leave: %s()" format,                        \
      FUNK , ## args);                             \
  }                                                \
} while (0)

#define TRACE(format, args...) do {                 \
  if (qof_log_check (log_module, QOF_LOG_TRACE)) {  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Trace: %s(): " format, FUNK , ## args);     \
  }                                                \
} while (0)

#define DEBUGCMD(x) do {                            \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
        (x);                                        \
    }                                               \
} while (0)

#endif /* _QOF_LOG_H */

---