logging.h

/**
 * @file
 * Logging Dispatcher
 *
 * @authors
 * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
 *
 * @copyright
 * 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef MUTT_LIB_LOGGING_H
#define MUTT_LIB_LOGGING_H

#include <stdbool.h>
#include <stdio.h>
#include <time.h>
#include "queue.h"

/**
 * enum LogLevel - Names for the Logging Levels
 */
enum LogLevel
{
  LL_PERROR  = -3, ///< Log perror (using errno)
  LL_ERROR   = -2, ///< Log error
  LL_WARNING = -1, ///< Log warning
  LL_MESSAGE =  0, ///< Log informational message
  LL_DEBUG1  =  1, ///< Log at debug level 1
  LL_DEBUG2  =  2, ///< Log at debug level 2
  LL_DEBUG3  =  3, ///< Log at debug level 3
  LL_DEBUG4  =  4, ///< Log at debug level 4
  LL_DEBUG5  =  5, ///< Log at debug level 5
  LL_NOTIFY  =  6, ///< Log of notifications

  LL_MAX,
};

/**
 * @defgroup logging_api Logging API
 *
 * Prototype for a Logging Function
 *
 * @param stamp    Unix time (optional)
 * @param file     Source file
 * @param line     Source line
 * @param function Source function
 * @param level    Logging level, e.g. #LL_WARNING
 * @param ...      Format string and parameters, like printf()
 * @retval -1 Error
 * @retval  0 Success, filtered
 * @retval >0 Success, number of characters written
 */
typedef int (*log_dispatcher_t)(time_t stamp, const char *file, int line, const char *function, enum LogLevel level, ...);

extern log_dispatcher_t MuttLogger;

/**
 * struct LogLine - A Log line
 */
struct LogLine
{
  time_t time;                   ///< Timestamp of the message
  const char *file;              ///< Source file
  int line;                      ///< Line number in source file
  const char *function;          ///< C function
  enum LogLevel level;           ///< Log level, e.g. #LL_DEBUG1
  char *message;                 ///< Message to be logged
  STAILQ_ENTRY(LogLine) entries; ///< Linked list
};
STAILQ_HEAD(LogLineList, LogLine);

#define mutt_debug(LEVEL, ...) MuttLogger(0, __FILE__, __LINE__, __func__, LEVEL,      __VA_ARGS__) ///< @ingroup logging_api
#define mutt_warning(...)      MuttLogger(0, __FILE__, __LINE__, __func__, LL_WARNING, __VA_ARGS__) ///< @ingroup logging_api
#define mutt_message(...)      MuttLogger(0, __FILE__, __LINE__, __func__, LL_MESSAGE, __VA_ARGS__) ///< @ingroup logging_api
#define mutt_error(...)        MuttLogger(0, __FILE__, __LINE__, __func__, LL_ERROR,   __VA_ARGS__) ///< @ingroup logging_api
#define mutt_perror(...)       MuttLogger(0, __FILE__, __LINE__, __func__, LL_PERROR,  __VA_ARGS__) ///< @ingroup logging_api

int  log_disp_file    (time_t stamp, const char *file, int line, const char *function, enum LogLevel level, ...);
int  log_disp_null    (time_t stamp, const char *file, int line, const char *function, enum LogLevel level, ...);
int  log_disp_queue   (time_t stamp, const char *file, int line, const char *function, enum LogLevel level, ...);
int  log_disp_terminal(time_t stamp, const char *file, int line, const char *function, enum LogLevel level, ...);

int  log_queue_add(struct LogLine *ll);
void log_queue_empty(void);
void log_queue_flush(log_dispatcher_t disp);
int  log_queue_save(FILE *fp);
void log_queue_set_max_size(int size);

void log_file_close(bool verbose);
int  log_file_open(bool verbose);
bool log_file_running(void);
int  log_file_set_filename(const char *file, bool verbose);
int  log_file_set_level(enum LogLevel level, bool verbose);
void log_file_set_version(const char *version);

#endif /* MUTT_LIB_LOGGING_H */