feat: Add core module #290

Open
icex2 wants to merge 7 commits from pr290 into master
icex2 commented 2024-02-23 19:42:56 +03:00 (Migrated from github.com)

feat: Add core module

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

Stack created with Sapling. Best reviewed with ReviewStack.

feat: Add core module 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 --- [//]: # (BEGIN SAPLING FOOTER) Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/djhackersdev/bemanitools/pull/290). * #298 * #297 * #296 * #295 * #294 * #293 * #292 * #291 * __->__ #290 * #289 * #299 * #288 * #287 * #286 * #285
This pull request has changes conflicting with the target branch.
  • Module.mk
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin pr290:pr290
git checkout pr290
Sign in to join this conversation.