icex2
df8bf56d0c
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
87 lines
2.3 KiB
C
87 lines
2.3 KiB
C
#ifndef CORE_LOG_BT_H
|
|
#define CORE_LOG_BT_H
|
|
|
|
#include "core/log-sink.h"
|
|
|
|
/**
|
|
* Log API implementation for games/applications without AVS
|
|
*/
|
|
|
|
enum core_log_bt_log_level {
|
|
CORE_LOG_BT_LOG_LEVEL_OFF = 0,
|
|
CORE_LOG_BT_LOG_LEVEL_FATAL = 1,
|
|
CORE_LOG_BT_LOG_LEVEL_WARNING = 2,
|
|
CORE_LOG_BT_LOG_LEVEL_INFO = 3,
|
|
CORE_LOG_BT_LOG_LEVEL_MISC = 4,
|
|
};
|
|
|
|
/**
|
|
* Initialize the logging backend
|
|
*
|
|
* This must be called as early as possible in your application to setup
|
|
* a logging sink according to your needs. Until this is finished, no
|
|
* log output is available.
|
|
*
|
|
* By default, logging is turned off entirely and must be enabled by setting
|
|
* a desired logging level explicitly.
|
|
*
|
|
* @param sink Pointer to a log sink implementation. The caller owns the memory
|
|
* of this.
|
|
*/
|
|
void core_log_bt_init(const struct core_log_sink *sink);
|
|
|
|
/**
|
|
* Set the current logging level. This can be changed at any given time, e.g.
|
|
* to increase/decrease verbosity.
|
|
*
|
|
* @param level The logging level to set.
|
|
*/
|
|
void core_log_bt_level_set(enum core_log_bt_log_level level);
|
|
|
|
/**
|
|
* Cleanup the logging backend.
|
|
*
|
|
* Ensure to call this on application exit and cleanup.
|
|
*/
|
|
void core_log_bt_fini();
|
|
|
|
/**
|
|
* Implementation of the log API.
|
|
*/
|
|
void core_log_bt_log_fatal(const char *module, const char *fmt, ...);
|
|
|
|
/**
|
|
* Implementation of the log API.
|
|
*/
|
|
void core_log_bt_log_warning(const char *module, const char *fmt, ...);
|
|
|
|
/**
|
|
* Implementation of the log API.
|
|
*/
|
|
void core_log_bt_log_info(const char *module, const char *fmt, ...);
|
|
|
|
/**
|
|
* Implementation of the log API.
|
|
*/
|
|
void core_log_bt_log_misc(const char *module, const char *fmt, ...);
|
|
|
|
/**
|
|
* Allow AVS to by-pass the core log API/engine.
|
|
*
|
|
* This function must only be called by AVS in an appropriate log callback
|
|
* function that is passed to avs_boot.
|
|
*
|
|
* AVS has it's own logging engine and manages aspects such as async logging,
|
|
* log levels and decorating log messages.
|
|
*
|
|
* Thus, proper interoperability only requires the writer/sink part to be shared
|
|
* with AVS.
|
|
*
|
|
* @param chars Buffer with text data to write to the configured sinks. The
|
|
* buffer might contain several log messages separated by newline
|
|
* characters.
|
|
* @param nchars Number of chars to write to the sink.
|
|
*/
|
|
void core_log_bt_direct_sink_write(const char *chars, size_t nchars);
|
|
|
|
#endif |