logging.h

Go to the documentation of this file.

 
#ifndef MUTT_LIB_LOGGING_H
#define MUTT_LIB_LOGGING_H
 
#include <stdbool.h>
#include <stdio.h>
#include <time.h>
#include "queue.h"
 
enum LogLevel
{
  LL_PERROR  = -3, 
  LL_ERROR   = -2, 
  LL_WARNING = -1, 
  LL_MESSAGE =  0, 
  LL_DEBUG1  =  1, 
  LL_DEBUG2  =  2, 
  LL_DEBUG3  =  3, 
  LL_DEBUG4  =  4, 
  LL_DEBUG5  =  5, 
  LL_NOTIFY  =  6, 
 
  LL_MAX,
};
 
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
{
  time_t time;                   
  const char *file;              
  int line;                      
  const char *function;          
  enum LogLevel level;           
  char *message;                 
  STAILQ_ENTRY(LogLine) entries; 
};
STAILQ_HEAD(LogLineList, LogLine);
 
#define mutt_debug(LEVEL, ...) MuttLogger(0, __FILE__, __LINE__, __func__, LEVEL,      __VA_ARGS__)
#define mutt_warning(...)      MuttLogger(0, __FILE__, __LINE__, __func__, LL_WARNING, __VA_ARGS__)
#define mutt_message(...)      MuttLogger(0, __FILE__, __LINE__, __func__, LL_MESSAGE, __VA_ARGS__)
#define mutt_error(...)        MuttLogger(0, __FILE__, __LINE__, __func__, LL_ERROR,   __VA_ARGS__)
#define mutt_perror(...)       MuttLogger(0, __FILE__, __LINE__, __func__, LL_PERROR,  __VA_ARGS__)
 
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 */