gi_log.h

Go to the documentation of this file.

/*
 * $Id: gi_log.h,v 1.1.2.11 2004/08/06 09:51:47 jasta Exp $
 *
 * Copyright (C) 2003 giFT project (gift.sourceforge.net)
 *
 * 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, 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.
 */

#ifndef __GI_LOG_H
#define __GI_LOG_H

/*****************************************************************************/

/*****************************************************************************/

#define GI_LOG_FATAL       (0x01)
#define GI_LOG_EMERG       (0x02)
#define GI_LOG_ERROR       (0x04)
#define GI_LOG_WARNING     (0x08)
#define GI_LOG_DEBUG       (0x20)
#define GI_LOG_DEPRECATED  (0x100)

#define GI_LOG_ALL         (0x13f)
#define GI_LOG_NONE        (0x00)

#define GI_LOG_STDOUT      (0x01)
#define GI_LOG_STDERR      (0x02)
#define GI_LOG_TIMESTAMP   (0x20)      /* prepend a timestamp to each msg */
#define GI_LOG_NODOMAINPFX (0x40)

/*****************************************************************************/

EXTERN_C_BEGIN

/*****************************************************************************/

LIBGIFT_EXPORT
  void gi_log_init (const char *ident, int output, int domain_mask, int level);

LIBGIFT_EXPORT
  void gi_log_finish (void);

LIBGIFT_EXPORT
  FILE *gi_log_open (const char *pathname);

LIBGIFT_EXPORT
  void gi_log_close (FILE *f);

/*****************************************************************************/

LIBGIFT_EXPORT
  int gi_log_vprintf (const char *file, unsigned int line, const char *funcname,
                      int domain, int level, const char *fmt, va_list args);

LIBGIFT_EXPORT
  int gi_log_printf (int domain, int level, const char *fmt, ...);

/*****************************************************************************/

/*
 * When we're on a gcc platform, provide printf format vigilance during
 * compilation.
 */
#if defined(__GNUC__)
# define GI_PRINTF_ATTR(f,v) __attribute__ ((__format__ (__printf__, f, v)))
#else
# define GI_PRINTF_ATTR(f,v)
#endif

#define GI_LOG_WRAPPER(__funcfn__)                   \
  LIBGIFT_EXPORT                                     \
    int __funcfn__ (int level, const char *fmt, ...) \
      GI_PRINTF_ATTR (2, 3)

GI_LOG_WRAPPER(gi_log_simple);
GI_LOG_WRAPPER(gi_log_warning);
GI_LOG_WRAPPER(gi_log_error);
GI_LOG_WRAPPER(gi_log_emerg);
GI_LOG_WRAPPER(gi_log_fatal);

/*****************************************************************************/

#ifndef __FUNCTION__
#define __FUNCTION__ __func__
#endif

#define GI_TRACE  __FILE__, __LINE__, __FUNCTION__
#define GI_TRACEL __FILE__,        0, NULL

#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
# define gi_log_debug(lvl,fmt,...)   gi_log_debugfn(GI_TRACE,lvl,fmt,__VA_ARGS__)
# define gi_log_message(lvl,fmt,...) gi_log_debugfn(GI_TRACEL,lvl,fmt,__VA_ARGS__)
#elif defined(__GNUC__)
# define gi_log_debug(lvl,fmt...)    gi_log_debugfn(GI_TRACE,lvl,fmt)
# define gi_log_message(lvl,fmt...)  gi_log_debugfn(GI_TRACEL,lvl,fmt)
#else
# define gi_log_debug                gi_log_simple
# define gi_log_message              gi_log_simple
#endif

LIBGIFT_EXPORT
  int gi_log_debugfn (const char *file, unsigned int line, const char *funcname,
                      int level, const char *fmt, ...)
    GI_PRINTF_ATTR (5, 6);

/*****************************************************************************/

EXTERN_C_END

/*****************************************************************************/

#endif /* __GI_LOG_H */

---