format.h File Reference

Go to the source code of this file.

Data Structures
struct	log_format_spec_t
	A single parsed format specifier. More...
struct	log_template_t
	Compiled log format ready for use in log_template_apply() More...

Enumerations
enum	log_template_type_t {   LOG_FORMAT_LITERAL , LOG_FORMAT_TIME , LOG_FORMAT_LEVEL , LOG_FORMAT_LEVEL_ALIGNED ,   LOG_FORMAT_FILE , LOG_FORMAT_FILE_RELATIVE , LOG_FORMAT_LINE , LOG_FORMAT_FUNC ,   LOG_FORMAT_TID , LOG_FORMAT_TNAME , LOG_FORMAT_MESSAGE , LOG_FORMAT_COLORLOG_LEVEL ,   LOG_FORMAT_COLOR , LOG_FORMAT_COLORED_MESSAGE , LOG_FORMAT_MICROSECONDS , LOG_FORMAT_NANOSECONDS ,   LOG_FORMAT_STRFTIME_CODE , LOG_FORMAT_NEWLINE }
	Types of format specifiers that can appear in a format string. More...

Functions
log_template_t *	log_template_parse (const char *format_str, bool console_only)
	Parse a format string into compiled format structure.
void	log_template_free (log_template_t *format)
	Free compiled format structure.
int	log_template_apply (const log_template_t *format, char *buf, size_t buf_size, log_level_t level, const char *timestamp, const char *file, int line, const char *func, uint64_t tid, const char *message, bool use_colors, uint64_t time_nanoseconds)
	Apply format to a log entry and write result to buffer.

Enumeration Type Documentation

log_template_type_t

enum log_template_type_t

Types of format specifiers that can appear in a format string.

Enumerator
LOG_FORMAT_LITERAL
LOG_FORMAT_TIME
LOG_FORMAT_LEVEL
LOG_FORMAT_LEVEL_ALIGNED
LOG_FORMAT_FILE
LOG_FORMAT_FILE_RELATIVE
LOG_FORMAT_LINE
LOG_FORMAT_FUNC
LOG_FORMAT_TID
LOG_FORMAT_TNAME
LOG_FORMAT_MESSAGE
LOG_FORMAT_COLORLOG_LEVEL
LOG_FORMAT_COLOR
LOG_FORMAT_COLORED_MESSAGE
LOG_FORMAT_MICROSECONDS
LOG_FORMAT_NANOSECONDS
LOG_FORMAT_STRFTIME_CODE
LOG_FORMAT_NEWLINE

Definition at line 25 of file log/format.h.

             {
  LOG_FORMAT_LITERAL,         /* Plain text (no % prefix) */
  LOG_FORMAT_TIME,            /* %time(fmt) - custom time format */
  LOG_FORMAT_LEVEL,           /* %level - log level as string */
  LOG_FORMAT_LEVEL_ALIGNED,   /* %level_aligned - log level padded */
  LOG_FORMAT_FILE,            /* %file - file path */
  LOG_FORMAT_FILE_RELATIVE,   /* %file_relative - file path relative to project root */
  LOG_FORMAT_LINE,            /* %line - line number */
  LOG_FORMAT_FUNC,            /* %func - function name */
  LOG_FORMAT_TID,             /* %tid - thread ID */
  LOG_FORMAT_TNAME,           /* %tname - thread name (from debug registry) */
  LOG_FORMAT_MESSAGE,         /* %message - log message */
  LOG_FORMAT_COLORLOG_LEVEL,  /* %colorlog_level_string_to_color - color code */
  LOG_FORMAT_COLOR,           /* %color(LEVEL, content) - colorize content using LEVEL's color */
  LOG_FORMAT_COLORED_MESSAGE, /* %colored_message - message with things like filenames and 0x numbers colored */
  LOG_FORMAT_MICROSECONDS,    /* %ms - microseconds component of current time (000000-999999) */
  LOG_FORMAT_NANOSECONDS,     /* %ns - nanoseconds component of current time (000000000-999999999) */
  LOG_FORMAT_STRFTIME_CODE,   /* %H, %M, %S, %A, %B, etc. - strftime format codes */
  LOG_FORMAT_NEWLINE,         /* Platform-aware newline (\n) */
} log_template_type_t;