ConsoleSink

Classes
struct	sl::log::ConsoleTextStyle
	Collection of possible style and color options for text printed onto the console. More...
class	sl::log::ConsoleTextStyleTable< TProjection, TTable >
	Convenience class for setting up style policies for a given Record member. More...
class	sl::log::ConsoleSink< TRecord >
	Sink class for directly logging onto std::cout. More...

Functions
std::ostream &	sl::log::operator<< (std::ostream &out, const ConsoleTextStyle &style)
	Operator << overload for ConsoleTextStyle type. More...
template<Record TRecord, std::invocable< const TRecord & > TProjection, class TTable = std::unordered_map< std::remove_cvref_t<std::invoke_result_t<TProjection, const TRecord&>>, ConsoleTextStyle >>
auto	sl::log::makeConsoleTextStyleTableFor (TProjection projection, TTable table)
	The factory function for creating ConsoleTextStyleTable instances. More...

Variables
template<class T , class TRecord >
concept	sl::log::ConsoleTextStylePolicyFor
	Concept which checks for validity of given text style policy. More...
constexpr ConsoleTextStyle	sl::log::defaultConsoleTextStyle
	A constant object used for resetting the style back to default. More...

Detailed Description

ConsoleSink ConsoleSinks are tightly linked to the std::cout object.

Colorize Messages

The library offers a quick way setting up your intended color (and style) table, based on any Record property. Here is a quick example which illustrates the setup:

#include <Simple-Log/PresetTypes.hpp>
 
// just pull everything into the current namespace
using namespace sl::log::preset;
using namespace sl::log;
 
int main()
{
    Core_t core;
    auto log = makeLogger<Logger_t>(core, SevLvl::info);
    
    auto& gConsoleSink = core.makeSink<ConsoleSink_t>();
 
    using Color = ConsoleTextStyle::Color;
    using Style = ConsoleTextStyle::Style;
    gConsoleSink.setTextStylePolicy(
        makeConsoleTextStyleTableFor<Record_t>(
            &Record_t::severity,    // use the severity property
            {
                // the desired SevLvl gets linked to a color and style setup
                { SevLvl::debug,    { .textColor = Color::yellow, .bgColor = Color::gray } },
                { SevLvl::hint,     { .bgColor = Color::green } },
                { SevLvl::warning,  { .bgColor = Color::yellow } },
                { SevLvl::error,    { .style = Style::bold,     .textColor = Color::red,    .bgColor = Color::yellow } },
                { SevLvl::fatal,    { .style = Style::crossed,  .textColor = Color::gray,   .bgColor = Color::red } }
            }
        )
    );
        
    log() << "Hello, World!";
    log() << SetSev(SevLvl::debug) << "Mighty debug message";
    log() << "Print as hint!" << SetSev(SevLvl::hint);
    log() << SetSev(SevLvl::warning) << "be warned...";
    log() << "Print my important error!" << SetSev(SevLvl::error);
    log() << "Print it fatal!" << SetSev(SevLvl::fatal);
}
// Above lines will be printed nicely colorful onto the console. Go, test it out ;)

Function Documentation

makeConsoleTextStyleTableFor()

template<Record TRecord, std::invocable< const TRecord & > TProjection, class TTable = std::unordered_map< std::remove_cvref_t<std::invoke_result_t<TProjection, const TRecord&>>, ConsoleTextStyle >>

auto sl::log::makeConsoleTextStyleTableFor	(	TProjection	projection,
		TTable	table
	)

The factory function for creating ConsoleTextStyleTable instances.

Template Parameters

TRecord	The currently used Record type
TProjection	The projection type
TTable	The table type. The default type is of std::unordered_map. Users may exchange this with std::map.

Parameters

projection	The projection to a member of the currently used Record type
table	The finally established container object

Returns

Returns a newly created ConsoleTextStyleTable instance

This is the preferable way creating a ConsoleTextStyleTable object for a Record property, because the projection and the table type becomes strong checked via concept and therefore will provide much clearer feedback in cases of error, while creating ConsoleTextStyleTable objects manually will probably result in harder to read error message.

Version

since alpha-0.6

operator<<()

std::ostream& sl::log::operator<< ( std::ostream &  out, const ConsoleTextStyle &  style  )

inline

Operator << overload for ConsoleTextStyle type.

Parameters

out	the stream object
style	the provided style

Returns

Returns the parameter out as reference

Version

since alpha-0.6

Examples

CustomizeBaseRecord/main.cpp.

Variable Documentation

ConsoleTextStylePolicyFor

template<class T , class TRecord >

concept sl::log::ConsoleTextStylePolicyFor

Initial value:

=
    Record<TRecord> &&
    std::is_invocable_r_v<ConsoleTextStyle, T, const TRecord&>

Concept which checks for validity of given text style policy.

defaultConsoleTextStyle

constexpr ConsoleTextStyle sl::log::defaultConsoleTextStyle

constexpr

A constant object used for resetting the style back to default.

Version

since alpha-0.6