A small C++11 library which gathers pieces of code, patterns and functions whose its author found useful during his programming career.
All the components are compiled as single tiny library, both static and shared. Most components are header-only.
This project is licensed under MIT license. Please note that Google Test package, which is used to build and run unit tests, is neither a part of core library, nor its required component. It's licensed separately.
Macros which start with $ character look a bit unusual. Although, this way they won't
clash with normal identifiers and are easily distinguishable in code. So it's pure aesthetic choice.
- Log - tiny logging library, mostly implementation of "logging facade" concept along with some very simple building blocks for cases when you don't need huge and complex logging logic
- Util - set of functions and reusable code pieces which either don't fit into other modules or are simply too small to make them into separate module
A small C++11 library for covering your code with log messages.
Unlike existing huge libraries like pantheios, Boost.Log, log4cpp etc.,
it focuses only on logging macros in user's code and provides single
initialization point, with easily understandable interface, to make them alive.
Actually, library user is intended to use this library for traces and then
implement full logger backend based on one of aforementioned libraries.
There are some simple "combinators" and "sinks", but they're placed in library mostly for conveinence, in case someone wants very simple logging out-of-the-box.
Heavily inspired by Rust's log package (https://crates.io/crates/log).
#include <log_facade/Log.hpp>
void do_stuff(int first, double second)
{
$log_trace("Function started");
$log_debug("first: ", first, " second: ", second);
// ... do actual stuff
$log_trace("Function ended");
}TODO
The most used set of macros. Actually, you most probably need only these.
$log_error(...)$log_warn(...)$log_info(...)$log_debug(...)$log_trace(...)
Each of these sends message to logger, with relevant severity level. Each accepts variadic arguments, which will be written to log.
Please note that actual way objects are formatted depends on selected formatter. For convenience, default formatter behavior is stream output operator. Custom formatter stuff is discussed later.
Besides severity level and message location, Log has such concept as 'channel'
Channel is simply a user-defined string which somehow describes current scope of messages,
or their purpose, or whatever user deems applicable.
Channel can be established for current scope via $LogChannel($chan) macro, where $chan should be
string literal. This macro can be used in global scope or as part of class declaration -
but not inside function body.
$log_error_at($channel, $location, ...)$log_warn_at($channel, $location, ...)$log_info_at($channel, $location, ...)$log_debug_at($channel, $location, ...)$log_trace_at($channel, $location, ...)
Each of these macros accepts logging channel and location explicitly, and then just treats all ellipsis arguments as message.
$log_perform_write_fmt($severity, $channel, $location, ...)
This macro receives all data about context explicitly via arguments Ellipsis arguments are passed to currently selected formatter factory. Equivalent to$log_perform_write($severity, $channel, $location, $log_format(__VA_ARGS__)).$log_perform_write($severity, $channel, $location, $fmtfunc)
Base macro, through which all other logging macros are implemented. Behaves almost like previous one, but its fourth argument should be a formatter function, i.e. anything callable which accepts reference to STL output stream.
TODO: description of components available