Logging utility functions. More...

Collaboration diagram for Logging:

Detailed Description

Macros
#define	BJ_MAXIMUM_LOG_LEN 120
	Maximum length of log messages.

#define	bj_log(LEVEL, ...)
	Log a message using the given level `LEVEL`.

#define	bj_trace(...)
	Log a message using the `BJ_LOG_TRACE` level.

#define	bj_debug(...)
	Log a message using the `BJ_LOG_DEBUG` level.

#define	bj_info(...)
	Log a message using the `BJ_LOG_INFO` level.

#define	bj_warn(...)
	Log a message using the `BJ_LOG_WARN` level.

#define	bj_err(...)
	Log a message using the `BJ_LOG_ERROR` level.

#define	bj_fatal(...)
	Log a message using the `BJ_LOG_FATAL` level.

Enumerations
enum	{ BJ_LOG_TRACE , BJ_LOG_DEBUG , BJ_LOG_INFO , BJ_LOG_WARN , BJ_LOG_ERROR , BJ_LOG_FATAL }
	Log Levels. More...

Functions
const char *	bj_log_get_level_string (int level)
	Returns a string describing the given `level`.

void	bj_log_set_level (int level)
	Sets the default log level.

int	bj_log_get_level (void)
	Gets the current log level set by bj_log_set_level.

size_t	bj_message (int level, const char p_file, int line, const char p_format,...)
	Generic message reporting function.

Macro Definition Documentation

◆ bj_debug

#define bj_debug ( ... )

Value:

bj_log(DEBUG, __VA_ARGS__)

bj_log

#define bj_log(LEVEL,...)

Log a message using the given level LEVEL.

Definition log.h:60

The function effectively calls bj_message, forwarding arguments to format the input string.

This function is preferred over calling bj_log of bj_message directly for clarity.

Parameters

...	The string formatting, forwarded to the last arguments of bj_message.

See also: bj_trace, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal. Log using BJ_LOG_DEBUG level.

◆ bj_err

#define bj_err ( ... )

Value:

bj_log(ERROR, __VA_ARGS__)

The function effectively calls bj_message, forwarding arguments to format the input string.

This function is preferred over calling bj_log of bj_message directly for clarity.

Parameters

...	The string formatting, forwarded to the last arguments of bj_message.

See also: bj_warn, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal. Log using BJ_LOG_ERROR level.

Examples: audio_pcm.c, bitmap_blit.c, drawing_2d.c, events.c, load_bmp.c, logging.c, shaders.c, sprite_animation.c, time.c, and window.c.

◆ bj_fatal

#define bj_fatal ( ... )

Value:

bj_log(FATAL, __VA_ARGS__)

The function effectively calls bj_message, forwarding arguments to format the input string.

This function is preferred over calling bj_log of bj_message directly for clarity.

Parameters

...	The string formatting, forwarded to the last arguments of bj_message.

See also: bj_err, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal. Log using BJ_LOG_FATAL level.

◆ bj_info

#define bj_info ( ... )

Value:

bj_log(INFO, __VA_ARGS__)

The function effectively calls bj_message, forwarding arguments to format the input string.

This function is preferred over calling bj_log of bj_message directly for clarity.

Parameters

...	The string formatting, forwarded to the last arguments of bj_message.

See also: bj_debug, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal. Log using BJ_LOG_INFO level.

Examples: array.c, build_info.c, events.c, handling_errors.c, htable.c, logging.c, and window.c.

◆ bj_log

#define bj_log	(		LEVEL,
			... )

Value:

bj_message(BJ_LOG_ ## LEVEL, __FILE__, __LINE__, __VA_ARGS__)

bj_message

size_t bj_message(int level, const char *p_file, int line, const char *p_format,...)

Generic message reporting function.

Any integer value can be used for LEVEL, but usually any of BJ_LOG_TRACE, BJ_LOG_DEBUG, BJ_LOG_INFO, BJ_LOG_WARN, BJ_LOG_ERROR or BJ_LOG_FATAL is used.

When a message is sent with a given level, it will be reported only if the value set with bj_log_set_level is at least the same value.

The function effectively calls bj_message, forwarding arguments to format the input string.

Parameters

LEVEL	The log level to report the message in.
...	Arguments forwarded to bj_message.

See also: bj_message, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal.

Examples: logging.c.

◆ BJ_MAXIMUM_LOG_LEN

#define BJ_MAXIMUM_LOG_LEN 120

Log messages, including header information such as timestamp and log level, cannot have a size in bytes larger than BJ_MAXIMUM_LOG_LEN, excluding the null character. In case a message is longer than this limit, the content is truncated in order of priority as described in bj_message.

◆ bj_trace

#define bj_trace ( ... )

Value:

bj_log(TRACE, __VA_ARGS__)

The function effectively calls bj_message, forwarding arguments to format the input string.

This function is preferred over calling bj_log of bj_message directly for clarity.

Parameters

...	The string formatting, forwarded to the last arguments of bj_message.

See also: bj_log, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal. Log using BJ_LOG_TRACE level.

Examples: time.c.

◆ bj_warn

#define bj_warn ( ... )

Value:

bj_log(WARN, __VA_ARGS__)

The function effectively calls bj_message, forwarding arguments to format the input string.

This function is preferred over calling bj_log of bj_message directly for clarity.

Parameters

...	The string formatting, forwarded to the last arguments of bj_message.

See also: bj_info, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal. Log using BJ_LOG_WARN level.

Examples: logging.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Level values are ordered from 0.

Enumerator
BJ_LOG_TRACE	Fine-grained diagnostic details.
BJ_LOG_DEBUG	Detailed information for debugging.
BJ_LOG_INFO	Informational messages about execution.
BJ_LOG_WARN	Warnings for potential issues.
BJ_LOG_ERROR	Errors preventing correct function.
BJ_LOG_FATAL	Critical errors leading to termination.

Function Documentation

◆ bj_log_get_level()

int bj_log_get_level ( void )

Returns: An integer value describing the current log level.

Examples: logging.c.

◆ bj_log_get_level_string()

const char * bj_log_get_level_string ( int level )

The function is only valid if called with BJ_LOG_TRACE, BJ_LOG_DEBUG, BJ_LOG_INFO, BJ_LOG_WARN, BJ_LOG_ERROR or BJ_LOG_FATAL.

The returned value is owned by the callee.

Parameters

level The log level to get the description from.

Returns: A C-String describing level.

◆ bj_log_set_level()

void bj_log_set_level ( int level )

Once set, any call to bj_message, bj_log and helper macros will only report a message is its level is at least level.

Parameters

level The level to set.

If not set, default is BJ_LOG_TRACE.

Examples: logging.c.

◆ bj_message()

size_t bj_message	(	int	level,
		const char *	p_file,
		int	line,
		const char *	p_format,
			... )

Sends a message using the given level. Message will only be reported if level is at least the value set as a parameter to bj_log_set_level (or BJ_LOG_TRACE if never called).

The more convenient functions bj_log, bj_trace, ... should be used for simplicity.

The string formatting follows standard printf signature and behaviour.

Parameters

level	The log level the message is reported in.
p_file	The file name the message is reported from.
line	The line number the message is reported from.
p_format,...	The formatted string to report.

Returns: The actual number of characters written, excluding the null-terminating symbol.

Format and Behavior

The log message will have the following format:

TIME LEVEL: (SOURCE) MESSAGE Where:
TIME is in the format "HH:MM:SS" and takes 8 characters
LEVEL, in square brackets, is the result of calling bj_log_get_level_string. It takes up to 4 to 5 characters.
SOURCE is in the format "FILE:LINE" and takes an undetermined number of characters. This is only present in a debug build.
MESSAGE is the result of calling snprintf(p_format, ...) and the number of character varies.

For example: 12:23:34 WARN: logging.c:27 Warning level message

The maximum length a log message will take is hardcoded to the value set for BJ_MAXIMUM_LOG_LEN.

A first buffer is filled in with the expansion of the message. This message is truncated to fit the BJ_MAXIMUM_LOG_LEN characters limit entirely. If this limit is already reached, the message is logged as-is.

Then, in the order of below priority:

If BJ_CONFIG_LOG_COLOR is set and but is not enough space for colored source (Debug only), SOURCE is not colored.
If BJ_CONFIG_LOG_COLOR is set and but is not enough space for colored level, LEVEL is not colored.
If there is not enough space left for TIME, it is not present.
If there is not enough space for SOURCE (Debug only), it is not present.
If there is not enough space for LEVEL, it is not present.

See also: bj_log, bj_trace, bj_debug, bj_info, bj_warn, bj_err, bj_fatal

Detailed Description

Macros

Enumerations

Functions

Macro Definition Documentation

◆ bj_debug

◆ bj_err

◆ bj_fatal

◆ bj_info

◆ bj_log

◆ BJ_MAXIMUM_LOG_LEN

◆ bj_trace

◆ bj_warn

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ bj_log_get_level()

◆ bj_log_get_level_string()

◆ bj_log_set_level()

◆ bj_message()