/** Logging and debugging routines
 *
 * @file
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @copyright 2014-2016, Institute for Automation of Complex Power Systems, EONERC
 *   This file is part of VILLASnode. All Rights Reserved. Proprietary and confidential.
 *   Unauthorized copying of this file, via any medium is strictly prohibited. 
 *********************************************************************************/
 
#ifndef _LOG_H_
#define _LOG_H_

#include <stdarg.h>
#include <libconfig.h>

#ifdef __GNUC__
  #define INDENT	int __attribute__ ((__cleanup__(log_outdent), unused)) _old_indent = log_indent(1);
#else
  #define INDENT	;
#endif

/* The log level which is passed as first argument to print() */
#define DEBUG		GRY("Debug")
#define INFO		    "" 
#define WARN		YEL("Warn ")
#define ERROR		RED("Error")
#define STATS		MAG("Stats")

/** Debug facilities.
 *
 * To be or-ed with the debug level
 */
enum debug_facilities {
	DBG_POOL =	(1 <<  8),
	DBG_QUEUE =	(1 <<  9),
	DBG_CONFIG =	(1 << 10),
	DBG_HOOK =	(1 << 11),
	DBG_PATH =	(1 << 12),
	
	/* Node-types */
	DBG_SOCKET =	(1 << 16),
	DBG_FILE =	(1 << 17),
	DBG_GTFPGA =	(1 << 18),
	DBG_NGSI =	(1 << 19),
	DBG_WEBSOCKET =	(1 << 20),
	DBG_OPAL =	(1 << 21),
	DBG_NODE =   (0xFF << 16)
};

/** Change log indention  for current thread.
 *
 * The argument level can be negative!
 */
int log_indent(int levels);

/** A helper function the restore the previous log indention level.
 *
 * This function is usually called by a __cleanup__ handler (GCC C Extension).
 * See INDENT macro.
 */
void log_outdent(int *);

/** Set the verbosity level of debug messages.
 *
 * @param lvl The new debug level.
 * @param fac The new mask for debug facilities.
 */
void log_setlevel(int lvl, int fac);

/** Reset the wallclock of debug messages. */
void log_init();

/** Logs variadic messages to stdout.
 *
 * @param lvl The log level
 * @param fmt The format string (printf alike)
 */
void log_print(const char *lvl, const char *fmt, ...)
	__attribute__ ((format(printf, 2, 3)));

/** Logs variadic messages to stdout.
 *
 * @param lvl The log level
 * @param fmt The format string (printf alike)
 * @param va The variadic argument list (see stdarg.h)
 */	
void log_vprint(const char *lvl, const char *fmt, va_list va);

/** Printf alike debug message with level. */
void debug(int lvl, const char *fmt, ...)
	__attribute__ ((format(printf, 2, 3)));

/** Print a horizontal line. */
void line();

/** Printf alike info message. */
void info(const char *fmt, ...)
	__attribute__ ((format(printf, 1, 2)));

/** Printf alike warning message. */
void warn(const char *fmt, ...)
	__attribute__ ((format(printf, 1, 2)));

/** Printf alike statistics message. */
void stats(const char *fmt, ...)
	__attribute__ ((format(printf, 1, 2)));

/** Print error and exit. */
void error(const char *fmt, ...)
	__attribute__ ((format(printf, 1, 2)));

/** Print error and strerror(errno). */
void serror(const char *fmt, ...)
	__attribute__ ((format(printf, 1, 2)));

/** Print configuration error and exit. */
void cerror(config_setting_t *cfg, const char *fmt, ...)
	__attribute__ ((format(printf, 2, 3)));

#endif /* _LOG_H_ */