icex2
87b7e53973
This module contains the "core" (API) of bemanitools which includes an abstraction layer for threads and logging at this time. The threads API is very close to what util/thread already was with some structural enhancements which make it easier to understand and work with the API, I hope. Some additional helpers (*-ext module) support in doing common tasks, e.g. setting up the thread API with other modules. The log(ging) part receives a major overhaul to address known limitations and issues with the util/log module: - Cleaner API layer - Separate sinks from actual logging engine - Sinks are composable - Improved and cleaner compatibility layer with AVS logging API Additional "extensions" (*-ext modules) add various helper functions for common tasks like setting up the logging engine with a file and stdout sink. The sinks also improved significantly with the file sink now supporting proper appending and log rotation. Logging to stdout/stderr supports coloring of log messages which works across logging engines. Overall, this refactored foundation is expected to support future developments and removes known limitations at the current scale of bemanitools such as: - Reducing boiler plate code across hooks - Interop of bemanitools and AVS (and setting the foundation for addressing currently missing interop, e.g. for dealing with property structures without AVS) - Addressing performance issues in the logging engine due to incorrect interop with AVS
59 lines
1.8 KiB
C
59 lines
1.8 KiB
C
#ifndef CORE_LOG_BT_EXT_H
|
|
#define CORE_LOG_BT_EXT_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
* Set the current thread API implementation to use the bemanitools log
|
|
* implementation
|
|
*/
|
|
void core_log_bt_ext_impl_set();
|
|
|
|
/**
|
|
* Helper to setup the bemanitools log implementation with a stdout sink.
|
|
*/
|
|
void core_log_bt_ext_init_with_stdout();
|
|
|
|
/**
|
|
* Helper to setup the bemanitools log implementation with a stderr sink.
|
|
*/
|
|
void core_log_bt_ext_init_with_stderr();
|
|
|
|
/**
|
|
* Helper to setup the bemanitools log implementation with a OutputDebugStr
|
|
* sink.
|
|
*/
|
|
void core_log_bt_ext_init_with_debug();
|
|
|
|
/**
|
|
* Helper to setup the bemanitools log implementation with a file sink
|
|
*
|
|
* @param path Path to the log file to write the log output to
|
|
* @param append If true, then append to an existing file, false to overwrite
|
|
* any existing file
|
|
* @param rotate If true, rotates an existing log file and creates a new one
|
|
* for this session
|
|
* @param max_rotations Max number of rotations for the log files
|
|
*/
|
|
void core_log_bt_ext_init_with_file(
|
|
const char *path, bool append, bool rotate, uint8_t max_rotations);
|
|
|
|
/**
|
|
* Helper to setup the bemanitools log implementation with a stdout and file
|
|
* sink
|
|
*
|
|
* Important: This combined sink is guarded by a mutex to avoid data races on
|
|
* logging to two different sinks.
|
|
*
|
|
* @param path Path to the log file to write the log output to
|
|
* @param append If true, then append to an existing file, false to overwrite
|
|
* any existing file
|
|
* @param rotate If true, rotates an existing log file and creates a new one
|
|
* for this session
|
|
* @param max_rotations Max number of rotations for the log files
|
|
*/
|
|
void core_log_bt_ext_init_with_stdout_and_file(
|
|
const char *path, bool append, bool rotate, uint8_t max_rotations);
|
|
|
|
#endif |