code/logging_8h_source.html

#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 */

log_disp_file
int log_disp_file(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Save a log line to a file - Implements log_dispatcher_t -.
Definition: logging.c:245

log_disp_terminal
int log_disp_terminal(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Save a log line to the terminal - Implements log_dispatcher_t -.
Definition: logging.c:440

MuttLogger
log_dispatcher_t MuttLogger
The log dispatcher -.
Definition: logging.c:52

log_disp_queue
int log_disp_queue(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Save a log line to an internal queue - Implements log_dispatcher_t -.
Definition: logging.c:398

log_disp_null
int log_disp_null(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Discard log lines - Implements log_dispatcher_t -.
Definition: logging.c:499

log_file_open
int log_file_open(bool verbose)
Start logging to a file.
Definition: logging.c:119

STAILQ_HEAD
STAILQ_HEAD(LogLineList, LogLine)

log_queue_empty
void log_queue_empty(void)
Free the contents of the queue.
Definition: logging.c:324

log_queue_set_max_size
void log_queue_set_max_size(int size)
Set a upper limit for the queue length.
Definition: logging.c:312

log_file_set_level
int log_file_set_level(enum LogLevel level, bool verbose)
Set the logging level.
Definition: logging.c:175

log_file_running
bool log_file_running(void)
Is the log file running?
Definition: logging.c:229

log_queue_flush
void log_queue_flush(log_dispatcher_t disp)
Replay the log queue.
Definition: logging.c:346

log_dispatcher_t
int(* log_dispatcher_t)(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Definition: logging.h:65

LogLevel
LogLevel
Names for the Logging Levels.
Definition: logging.h:35

LL_DEBUG4
@ LL_DEBUG4
Log at debug level 4.
Definition: logging.h:43

LL_ERROR
@ LL_ERROR
Log error.
Definition: logging.h:37

LL_DEBUG3
@ LL_DEBUG3
Log at debug level 3.
Definition: logging.h:42

LL_PERROR
@ LL_PERROR
Log perror (using errno)
Definition: logging.h:36

LL_DEBUG5
@ LL_DEBUG5
Log at debug level 5.
Definition: logging.h:44

LL_WARNING
@ LL_WARNING
Log warning.
Definition: logging.h:38

LL_MESSAGE
@ LL_MESSAGE
Log informational message.
Definition: logging.h:39

LL_DEBUG2
@ LL_DEBUG2
Log at debug level 2.
Definition: logging.h:41

LL_DEBUG1
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40

LL_NOTIFY
@ LL_NOTIFY
Log of notifications.
Definition: logging.h:45

LL_MAX
@ LL_MAX
Definition: logging.h:47

log_queue_save
int log_queue_save(FILE *fp)
Save the contents of the queue to a temporary file.
Definition: logging.c:367

log_file_close
void log_file_close(bool verbose)
Close the log file.
Definition: logging.c:98

log_file_set_filename
int log_file_set_filename(const char *file, bool verbose)
Set the filename for the log.
Definition: logging.c:149

log_queue_add
int log_queue_add(struct LogLine *ll)
Add a LogLine to the queue.
Definition: logging.c:285

log_file_set_version
void log_file_set_version(const char *version)
Set the program's version number.
Definition: logging.c:220

queue.h

LogLine
A Log line.
Definition: logging.h:73

LogLine::file
const char * file
Source file.
Definition: logging.h:75

LogLine::message
char * message
Message to be logged.
Definition: logging.h:79

LogLine::function
const char * function
C function.
Definition: logging.h:77

LogLine::line
int line
Line number in source file.
Definition: logging.h:76

LogLine::STAILQ_ENTRY
STAILQ_ENTRY(LogLine) entries
Linked list.

LogLine::level
enum LogLevel level
Log level, e.g. LL_DEBUG1.
Definition: logging.h:78

LogLine::time
time_t time
Timestamp of the message.
Definition: logging.h:74