/*
 * $Id: log.h,v 1.28 2003/10/16 18:50:54 jasta Exp $
 *
 * Copyright (C) 2001-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 __LOG_H
#define __LOG_H

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

/**
 * @file log.h
 *
 * @brief Log debugging, warning and error messages.
 *
 * These logging facilities provide greater control over the end output
 * location, whether it be to stdout/stderr, a simple log file, or even
 * syslog facilities.
 */

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

#ifdef HAVE_SYSLOG_H
# include <syslog.h>
#endif

#ifndef LOG_PERROR
# define LOG_PERROR 0x20
#endif

#ifndef LOG_PFX
# define LOG_PFX NULL
#endif

#ifndef LOG_USER
# define LOG_USER (1 << 31)
#endif

#ifndef LOG_EMERG
# define LOG_EMERG   0     /* system is unusable */
#endif

#ifndef LOG_ALERT
# define LOG_ALERT   1     /* action must be taken immediately */
#endif

#ifndef LOG_CRIT
# define LOG_CRIT    2     /* critical conditions */
#endif

#ifndef LOG_ERR
# define LOG_ERR     3     /* error conditions */
#endif

#ifndef LOG_WARNING
# define LOG_WARNING 4     /* warning conditions */
#endif

#ifndef LOG_NOTICE
# define LOG_NOTICE  5     /* normal but significant condition */
#endif

#ifndef LOG_INFO
# define LOG_INFO    6     /* informational */
#endif

#ifndef LOG_DEBUG
# define LOG_DEBUG   7     /* debug-level messages */
#endif

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

typedef enum
{
	GLOG_NONE        = 0x00, /* turn logging off */
	GLOG_STDERR      = 0x01, /* log to stderr, the default */
	GLOG_STDOUT      = 0x02, /* log to stdout */
	GLOG_SYSLOG      = 0x04, /* log to syslog (*nix) or Event Log (Win32) */
	GLOG_FILE        = 0x08, /* log to the specified file */
	GLOG_DEBUGGER    = 0x10  /* log to debugger, if running within debugger */
} LogOptions;

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

#define GIFT_INFO(args)   (log_info  args)
#define GIFT_WARN(args)   (log_warn  args)
#define GIFT_ERROR(args)  (log_error args)
#define GIFT_FATAL(args)  (log_fatal args), exit(0)
#define GIFT_ERRNO()      (platform_errno())
#define GIFT_STRERROR()   (platform_error())
#define GIFT_NETERROR()   (platform_net_error())

#ifdef LIBGIFT_DEBUG

# define GIFT_DBG(args) \
	(log_debug args)
# define GIFT_TRACE(args) \
	(log_trace_pfx (LOG_PFX, __FILE__, __LINE__, __PRETTY_FUNCTION__, NULL), \
	 log_trace args)
# define GIFT_TRACEFN \
	GIFT_TRACE (("entered"))
# define GIFT_TRACEMEM(ptr, len) \
	(log_dump_memory ((void *)(ptr), (unsigned long)(len)))

# define GLOG_DEBUG GLOG_DEBUGGER

#else /* !LIBGIFT_DEBUG */

# define GIFT_DBG(args)
# define GIFT_TRACE(args)
# define GIFT_TRACEFN
# define GIFT_TRACEMEM(ptr, len)
# define GLOG_DEBUG

#endif /* LIBGIFT_DEBUG */

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

#ifdef DEBUG_STDERR
# define GLOG_DEFAULT GLOG_FILE | GLOG_STDERR
#else
# define GLOG_DEFAULT GLOG_FILE
#endif

#if defined (__GNUC__) && 0
# define GIFT_FMTATTR(f,v) __attribute__ ((__format__ (__printf__, f, v)))
#else
# define GIFT_FMTATTR(f,v)
#endif /* __GNUC__ */

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

EXTERN_C_BEGIN

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

/**
 * Initialize the log subsystem
 *
 * @param options
 * @param ident
 * @param syslog_option
 * @param facility
 * @param log_file
 *
 * @retval TRUE  Successful initialization
 * @retval FALSE Unable to load logging subsystem
 */
LIBGIFT_EXPORT
  int log_init (LogOptions options, char *ident, int syslog_option,
                int facility, char *log_file);

/**
 * Cleanup the log subsystem
 */
LIBGIFT_EXPORT
  void log_cleanup ();

/**
 * Direct interface to the log printing facility.  Avoid using this at all
 * costs.
 */
LIBGIFT_EXPORT
  void log_print (int priority, char *msg);

/*
 * Usage:
 * GIFT_WARN (("cant open %s: %s", file, platform_error()));
 * or
 * GIFT_WARN (("cant open %s: %s", file, GIFT_STRERROR()));
 */
LIBGIFT_EXPORT
  void log_info  (const char *fmt, ...) GIFT_FMTATTR (1, 2);
LIBGIFT_EXPORT
  void log_warn  (const char *fmt, ...) GIFT_FMTATTR (1, 2);
LIBGIFT_EXPORT
  void log_error (const char *fmt, ...) GIFT_FMTATTR (1, 2);
LIBGIFT_EXPORT
  void log_fatal (const char *fmt, ...) GIFT_FMTATTR (1, 2);

#ifdef LIBGIFT_DEBUG

LIBGIFT_EXPORT
  void log_debug     (const char *fmt, ...) GIFT_FMTATTR (1, 2);
LIBGIFT_EXPORT
  void log_trace_pfx (const char *pfx, const char *file, int line, const char *func, const char *extra);
LIBGIFT_EXPORT
  void log_trace     (const char *fmt, ...) GIFT_FMTATTR (1, 2);

/**
 * @brief Log a hexidecimal dump of memory
 *
 * This function is available only when debugging is enabled at compile
 * time.  Avoid usage if possible.
 *
 * @param ptr pointer to memory area
 * @param len length of memory to dump.
 */
LIBGIFT_EXPORT
  void log_dump_memory (void *ptr, unsigned int len);

#endif /* LIBGIFT_DEBUG */

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

EXTERN_C_END

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

#endif /* __LOG_H */
