#include <wincolor_sink.h>

Inheritance diagram for spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >:

Public Member Functions
	wincolor_sink ()

	~wincolor_sink () override

	wincolor_sink (const wincolor_sink &other)=delete

wincolor_sink &	operator= (const wincolor_sink &other)=delete

void	set_color (level::level_enum level, WORD color)

void	log (const details::log_msg &msg) final override

void	flush () final override

void	set_pattern (const std::string &pattern) override final

void	set_formatter (std::unique_ptr< spdlog::formatter > sink_formatter) override final

Public Member Functions inherited from spdlog::sinks::sink
	sink ()

	sink (std::unique_ptr< spdlog::pattern_formatter > formatter)

virtual	~sink ()=default

bool	should_log (level::level_enum msg_level) const

void	set_level (level::level_enum log_level)

level::level_enum	level () const

Public Attributes
const WORD	BOLD = FOREGROUND_INTENSITY

const WORD	RED = FOREGROUND_RED

const WORD	GREEN = FOREGROUND_GREEN

const WORD	CYAN = FOREGROUND_GREEN \| FOREGROUND_BLUE

const WORD	WHITE = FOREGROUND_RED \| FOREGROUND_GREEN \| FOREGROUND_BLUE

const WORD	YELLOW = FOREGROUND_RED \| FOREGROUND_GREEN

Private Types
using	mutex_t = typename ConsoleMutex::mutex_t

Private Member Functions
WORD	set_console_attribs (WORD attribs)

void	print_range_ (const fmt::memory_buffer &formatted, size_t start, size_t end)

Private Attributes
HANDLE	out_handle_

mutex_t &	mutex_

std::unordered_map< level::level_enum, WORD, level::level_hasher >	colors_

Additional Inherited Members
Protected Attributes inherited from spdlog::sinks::sink
level_t	level_

std::unique_ptr< spdlog::formatter >	formatter_

Detailed Description

template<typename OutHandle, typename ConsoleMutex>
class spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >

Definition at line 30 of file wincolor_sink.h.

Member Typedef Documentation

template<typename OutHandle , typename ConsoleMutex >

using spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::mutex_t = typename ConsoleMutex::mutex_t

private

Definition at line 110 of file wincolor_sink.h.

Constructor & Destructor Documentation

template<typename OutHandle , typename ConsoleMutex >

spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::wincolor_sink ( )

inline

Definition at line 40 of file wincolor_sink.h.

         : out_handle_(OutHandle::handle())
         , mutex_(ConsoleMutex::mutex())
     {
         colors_[level::trace] = WHITE;
         colors_[level::debug] = CYAN;
         colors_[level::info] = GREEN;
         colors_[level::warn] = YELLOW | BOLD;
         colors_[level::err] = RED | BOLD;                         // red bold
         colors_[level::critical] = BACKGROUND_RED | WHITE | BOLD; // white bold on red background
         colors_[level::off] = 0;
     }

template<typename OutHandle , typename ConsoleMutex >

spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::~wincolor_sink ( )

inlineoverride

Definition at line 53 of file wincolor_sink.h.

     {
         this->flush();
     }

template<typename OutHandle , typename ConsoleMutex >

spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::wincolor_sink ( const wincolor_sink< OutHandle, ConsoleMutex > & other )

delete

Member Function Documentation

template<typename OutHandle , typename ConsoleMutex >

void spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::flush ( )

inlinefinaloverridevirtual

Implements spdlog::sinks::sink.

Definition at line 92 of file wincolor_sink.h.

     {
         // windows console always flushed?
     }

template<typename OutHandle , typename ConsoleMutex >

void spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::log ( const details::log_msg & msg )

inlinefinaloverridevirtual

Implements spdlog::sinks::sink.

Definition at line 68 of file wincolor_sink.h.

     {
         std::lock_guard<mutex_t> lock(mutex_);
         fmt::memory_buffer formatted;
         formatter_->format(msg, formatted);
         if (msg.color_range_end > msg.color_range_start)
         {
             // before color range
             print_range_(formatted, 0, msg.color_range_start);
 
             // in color range
             auto orig_attribs = set_console_attribs(colors_[msg.level]);
             print_range_(formatted, msg.color_range_start, msg.color_range_end);
             ::SetConsoleTextAttribute(out_handle_,
                 orig_attribs); // reset to orig colors
                                // after color range
             print_range_(formatted, msg.color_range_end, formatted.size());
         }
         else // print without colors if color range is invalid
         {
             print_range_(formatted, 0, formatted.size());
         }
     }

template<typename OutHandle , typename ConsoleMutex >

wincolor_sink& spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::operator= ( const wincolor_sink< OutHandle, ConsoleMutex > & other )

delete

template<typename OutHandle , typename ConsoleMutex >

void spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::print_range_	(	const fmt::memory_buffer &	formatted,
		size_t	start,
		size_t	end
	)

inlineprivate

Definition at line 125 of file wincolor_sink.h.

     {
         auto size = static_cast<DWORD>(end - start);
         ::WriteConsoleA(out_handle_, formatted.data() + start, size, nullptr, nullptr);
     }

template<typename OutHandle , typename ConsoleMutex >

void spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::set_color	(	level::level_enum	level,
		WORD	color
	)

inline

Definition at line 62 of file wincolor_sink.h.

     {
         std::lock_guard<mutex_t> lock(mutex_);
         colors_[level] = color;
     }

template<typename OutHandle , typename ConsoleMutex >

WORD spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::set_console_attribs ( WORD attribs )

inlineprivate

Definition at line 112 of file wincolor_sink.h.

     {
         CONSOLE_SCREEN_BUFFER_INFO orig_buffer_info;
         ::GetConsoleScreenBufferInfo(out_handle_, &orig_buffer_info);
         WORD back_color = orig_buffer_info.wAttributes;
         // retrieve the current background color
         back_color &= static_cast<WORD>(~(FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE | FOREGROUND_INTENSITY));
         // keep the background color unchanged
         ::SetConsoleTextAttribute(out_handle_, attribs | back_color);
         return orig_buffer_info.wAttributes; // return orig attribs
     }

template<typename OutHandle , typename ConsoleMutex >

void spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::set_formatter ( std::unique_ptr< spdlog::formatter > sink_formatter )

inlinefinaloverridevirtual

Implements spdlog::sinks::sink.

Definition at line 103 of file wincolor_sink.h.

     {
         std::lock_guard<mutex_t> lock(mutex_);
         formatter_ = std::move(sink_formatter);
     }

template<typename OutHandle , typename ConsoleMutex >

void spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::set_pattern ( const std::string & pattern )

inlinefinaloverridevirtual

Implements spdlog::sinks::sink.

Definition at line 97 of file wincolor_sink.h.

     {
         std::lock_guard<mutex_t> lock(mutex_);
         formatter_ = std::unique_ptr<spdlog::formatter>(new pattern_formatter(pattern));
     }

Member Data Documentation

template<typename OutHandle , typename ConsoleMutex >

const WORD spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::BOLD = FOREGROUND_INTENSITY

Definition at line 33 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

std::unordered_map<level::level_enum, WORD, level::level_hasher> spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::colors_

private

Definition at line 133 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

const WORD spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::CYAN = FOREGROUND_GREEN | FOREGROUND_BLUE

Definition at line 36 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

const WORD spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::GREEN = FOREGROUND_GREEN

Definition at line 35 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

mutex_t& spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::mutex_

private

Definition at line 132 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

HANDLE spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::out_handle_

private

Definition at line 131 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

const WORD spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::RED = FOREGROUND_RED

Definition at line 34 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

const WORD spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::WHITE = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE

Definition at line 37 of file wincolor_sink.h.

template<typename OutHandle , typename ConsoleMutex >

const WORD spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >::YELLOW = FOREGROUND_RED | FOREGROUND_GREEN

Definition at line 38 of file wincolor_sink.h.

The documentation for this class was generated from the following file:

wire-cell-build/util/inc/spdlog/sinks/wincolor_sink.h

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename OutHandle, typename ConsoleMutex> class spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename OutHandle, typename ConsoleMutex>
class spdlog::sinks::wincolor_sink< OutHandle, ConsoleMutex >