gnc-trace.h

Go to the documentation of this file.

/********************************************************************\
 * gnc-trace.h -- QOF logging and tracing facility                  *
 * Copyright (C) 1998-2003 Linas Vepstas <linas@linas.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, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
 *                                                                  *
 *   Author: Linas Vepstas (linas@linas.org)                        *
\********************************************************************/

#ifndef GNC_TRACE_H
#define GNC_TRACE_H

#include <glib.h>
#include <stdarg.h>
#include <stdio.h>
#include "gnc-engine-util.h"

#define QOF_MOD_ENGINE "qof-engine"

#define LOG_LEVEL_LIST(_) \
  _(GNC_LOG_FATAL, = 0)   \
  _(GNC_LOG_ERROR, = 1)   \
  _(GNC_LOG_WARNING, = 2) \
  _(GNC_LOG_INFO, = 3)    \
  _(GNC_LOG_DEBUG, = 4)   \
  _(GNC_LOG_DETAIL, = 5)  \
  _(GNC_LOG_TRACE, = 6)

DEFINE_ENUM (gncLogLevel, LOG_LEVEL_LIST)


AS_STRING_DEC(gncLogLevel, LOG_LEVEL_LIST)

FROM_STRING_DEC(gncLogLevel, LOG_LEVEL_LIST)

#define GNC_TRACE_INDENT_WIDTH 4

void gnc_log_init (void);

void gnc_set_log_level(QofLogModule module, gncLogLevel level);

void gnc_set_log_level_global(gncLogLevel level);

void gnc_set_logfile (FILE *outfile);

void qof_log_init_filename (const gchar* logfilename);

void qof_log_shutdown (void);

const char * gnc_log_prettify (const char *name);

gboolean gnc_should_log(QofLogModule log_module, gncLogLevel log_level);

void qof_log_set_default(gncLogLevel log_level);

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

void qof_log_module_foreach(QofLogCB cb, gpointer data);

gint qof_log_module_count(void);

#define FUNK gnc_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 (gnc_should_log (log_module, GNC_LOG_ERROR)) {    \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,     \
      "Error: %s(): " format, FUNK , ## args);     \
  }                                                \
} while (0)

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

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

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

#define ENTER(format, args...) do {                 \
  extern gint gnc_trace_num_spaces;                \
  if (gnc_should_log (log_module, GNC_LOG_DEBUG)) {    \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Enter in %s: %s()" format, __FILE__,        \
      FUNK , ## args);                             \
    gnc_trace_num_spaces += GNC_TRACE_INDENT_WIDTH; \
  }                                                \
} while (0)

#define LEAVE(format, args...) do {                 \
  extern gint gnc_trace_num_spaces;                \
  if (gnc_should_log (log_module, GNC_LOG_DEBUG)) {    \
    gnc_trace_num_spaces -= GNC_TRACE_INDENT_WIDTH; \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Leave: %s()" format,                        \
      FUNK , ## args);                             \
  }                                                \
} while (0)

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

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

/* -------------------------------------------------------- */
void gnc_start_clock (int clockno, QofLogModule log_module, gncLogLevel log_level,
                      const char *function_name, const char *format, ...);

void gnc_report_clock (int clockno,
                       QofLogModule log_module,
                       gncLogLevel log_level,
                       const char *function_name,
                       const char *format, ...);

void gnc_report_clock_total (int clockno,
                             QofLogModule log_module,
                             gncLogLevel log_level,
                             const char *function_name,
                             const char *format, ...);

#define START_CLOCK(clockno,format, args...) do {        \
  if (gnc_should_log (log_module, GNC_LOG_INFO))                \
    gnc_start_clock (clockno, log_module, GNC_LOG_INFO,  \
             __FUNCTION__, format , ## args);               \
} while (0)

#define REPORT_CLOCK(clockno,format, args...) do {       \
  if (gnc_should_log (log_module, GNC_LOG_INFO))                \
    gnc_report_clock (clockno, log_module, GNC_LOG_INFO, \
             __FUNCTION__, format , ## args);               \
} while (0)

#define REPORT_CLOCK_TOTAL(clockno,format, args...) do {       \
  if (gnc_should_log (log_module, GNC_LOG_INFO))                \
    gnc_report_clock_total (clockno, log_module, GNC_LOG_INFO, \
             __FUNCTION__, format , ## args);               \
} while (0)

#endif /* GNC_TRACE_H */
/* @} */

---