Detailed Description

template<typename ConsoleMutex>
class spdlog::sinks::ansicolor_sink< ConsoleMutex >

This sink prefixes the output with an ANSI escape sequence color code depending on the severity of the message. If no color terminal detected, omit the escape codes.

Definition at line 25 of file ansicolor_sink.h.

#include <ansicolor_sink.h>

Inheritance diagram for spdlog::sinks::ansicolor_sink< ConsoleMutex >:

[legend]

Public Types
using	mutex_t = typename ConsoleMutex::mutex_t

Public Member Functions
	ansicolor_sink (FILE *target_file, color_mode mode)

	~ansicolor_sink () override=default

	ansicolor_sink (const ansicolor_sink &other)=delete

	ansicolor_sink (ansicolor_sink &&other)=delete

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

ansicolor_sink &	operator= (ansicolor_sink &&other)=delete

void	set_color (level::level_enum color_level, string_view_t color)

void	set_color_mode (color_mode mode)

bool	should_color ()

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

void	flush () override

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

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

void	set_level (level::level_enum log_level)

level::level_enum	level () const

bool	should_log (level::level_enum msg_level) const

Public Attributes
const string_view_t	reset = "\033[m"

const string_view_t	bold = "\033[1m"

const string_view_t	dark = "\033[2m"

const string_view_t	underline = "\033[4m"

const string_view_t	blink = "\033[5m"

const string_view_t	reverse = "\033[7m"

const string_view_t	concealed = "\033[8m"

const string_view_t	clear_line = "\033[K"

const string_view_t	black = "\033[30m"

const string_view_t	red = "\033[31m"

const string_view_t	green = "\033[32m"

const string_view_t	yellow = "\033[33m"

const string_view_t	blue = "\033[34m"

const string_view_t	magenta = "\033[35m"

const string_view_t	cyan = "\033[36m"

const string_view_t	white = "\033[37m"

const string_view_t	on_black = "\033[40m"
	Background colors.

const string_view_t	on_red = "\033[41m"

const string_view_t	on_green = "\033[42m"

const string_view_t	on_yellow = "\033[43m"

const string_view_t	on_blue = "\033[44m"

const string_view_t	on_magenta = "\033[45m"

const string_view_t	on_cyan = "\033[46m"

const string_view_t	on_white = "\033[47m"

const string_view_t	yellow_bold = "\033[33m\033[1m"
	Bold colors.

const string_view_t	red_bold = "\033[31m\033[1m"

const string_view_t	bold_on_red = "\033[1m\033[41m"

Protected Attributes
level_t	level_ {level::trace}

Private Member Functions
void	print_ccode_ (const string_view_t &color_code)

void	print_range_ (const memory_buf_t &formatted, size_t start, size_t end)

Static Private Member Functions
static std::string	to_string_ (const string_view_t &sv)

Private Attributes
FILE *	target_file_

mutex_t &	mutex_

bool	should_do_colors_

std::unique_ptr< spdlog::formatter >	formatter_

std::array< std::string, level::n_levels >	colors_

Member Typedef Documentation

◆ mutex_t

template<typename ConsoleMutex >

using spdlog::sinks::ansicolor_sink< ConsoleMutex >::mutex_t = typename ConsoleMutex::mutex_t

Definition at line 28 of file ansicolor_sink.h.

Constructor & Destructor Documentation

◆ ansicolor_sink() [1/3]

template<typename ConsoleMutex >

SPDLOG_INLINE spdlog::sinks::ansicolor_sink< ConsoleMutex >::ansicolor_sink	(	FILE *	target_file,
		color_mode	mode
	)

Definition at line 17 of file ansicolor_sink-inl.h.

◆ ~ansicolor_sink()

template<typename ConsoleMutex >

spdlog::sinks::ansicolor_sink< ConsoleMutex >::~ansicolor_sink ( )

overridedefault

◆ ansicolor_sink() [2/3]

template<typename ConsoleMutex >

spdlog::sinks::ansicolor_sink< ConsoleMutex >::ansicolor_sink ( const ansicolor_sink< ConsoleMutex > & other )

delete

◆ ansicolor_sink() [3/3]

template<typename ConsoleMutex >

spdlog::sinks::ansicolor_sink< ConsoleMutex >::ansicolor_sink ( ansicolor_sink< ConsoleMutex > && other )

delete

Member Function Documentation

◆ flush()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::flush ( )

overridevirtual

Implements spdlog::sinks::sink.

Definition at line 69 of file ansicolor_sink-inl.h.

◆ level()

SPDLOG_INLINE spdlog::level::level_enum spdlog::sinks::sink::level ( ) const

inherited

Definition at line 22 of file sink-inl.h.

◆ log()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::log ( const details::log_msg & msg )

overridevirtual

Implements spdlog::sinks::sink.

Definition at line 41 of file ansicolor_sink-inl.h.

◆ operator=() [1/2]

template<typename ConsoleMutex >

ansicolor_sink & spdlog::sinks::ansicolor_sink< ConsoleMutex >::operator= ( ansicolor_sink< ConsoleMutex > && other )

delete

◆ operator=() [2/2]

template<typename ConsoleMutex >

ansicolor_sink & spdlog::sinks::ansicolor_sink< ConsoleMutex >::operator= ( const ansicolor_sink< ConsoleMutex > & other )

delete

◆ print_ccode_()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::print_ccode_ ( const string_view_t & color_code )

private

Definition at line 115 of file ansicolor_sink-inl.h.

◆ print_range_()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::print_range_	(	const memory_buf_t &	formatted,
		size_t	start,
		size_t	end
	)

private

Definition at line 121 of file ansicolor_sink-inl.h.

◆ set_color()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::set_color	(	level::level_enum	color_level,
		string_view_t	color
	)

Definition at line 34 of file ansicolor_sink-inl.h.

◆ set_color_mode()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::set_color_mode ( color_mode mode )

Definition at line 96 of file ansicolor_sink-inl.h.

◆ set_formatter()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::set_formatter ( std::unique_ptr< spdlog::formatter > sink_formatter )

overridevirtual

Implements spdlog::sinks::sink.

Definition at line 83 of file ansicolor_sink-inl.h.

◆ set_level()

SPDLOG_INLINE void spdlog::sinks::sink::set_level ( level::level_enum log_level )

inherited

Definition at line 17 of file sink-inl.h.

◆ set_pattern()

template<typename ConsoleMutex >

SPDLOG_INLINE void spdlog::sinks::ansicolor_sink< ConsoleMutex >::set_pattern ( const std::string & pattern )

finalvirtual

Implements spdlog::sinks::sink.

Definition at line 76 of file ansicolor_sink-inl.h.

◆ should_color()

template<typename ConsoleMutex >

SPDLOG_INLINE bool spdlog::sinks::ansicolor_sink< ConsoleMutex >::should_color ( )

Definition at line 90 of file ansicolor_sink-inl.h.

◆ should_log()

SPDLOG_INLINE bool spdlog::sinks::sink::should_log ( level::level_enum msg_level ) const

inherited

Definition at line 12 of file sink-inl.h.

◆ to_string_()

template<typename ConsoleMutex >

SPDLOG_INLINE std::string spdlog::sinks::ansicolor_sink< ConsoleMutex >::to_string_ ( const string_view_t & sv )

staticprivate

Definition at line 127 of file ansicolor_sink-inl.h.

Member Data Documentation

◆ black

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::black = "\033[30m"

Definition at line 58 of file ansicolor_sink.h.

◆ blink

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::blink = "\033[5m"

Definition at line 52 of file ansicolor_sink.h.

◆ blue

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::blue = "\033[34m"

Definition at line 62 of file ansicolor_sink.h.

◆ bold

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::bold = "\033[1m"

Definition at line 49 of file ansicolor_sink.h.

◆ bold_on_red

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::bold_on_red = "\033[1m\033[41m"

Definition at line 80 of file ansicolor_sink.h.

◆ clear_line

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::clear_line = "\033[K"

Definition at line 55 of file ansicolor_sink.h.

◆ colors_

template<typename ConsoleMutex >

std::array<std::string, level::n_levels> spdlog::sinks::ansicolor_sink< ConsoleMutex >::colors_

private

Definition at line 87 of file ansicolor_sink.h.

◆ concealed

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::concealed = "\033[8m"

Definition at line 54 of file ansicolor_sink.h.

◆ cyan

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::cyan = "\033[36m"

Definition at line 64 of file ansicolor_sink.h.

◆ dark

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::dark = "\033[2m"

Definition at line 50 of file ansicolor_sink.h.

◆ formatter_

template<typename ConsoleMutex >

std::unique_ptr<spdlog::formatter> spdlog::sinks::ansicolor_sink< ConsoleMutex >::formatter_

private

Definition at line 86 of file ansicolor_sink.h.

◆ green

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::green = "\033[32m"

Definition at line 60 of file ansicolor_sink.h.

◆ level_

level_t spdlog::sinks::sink::level_ {level::trace}

protectedinherited

Definition at line 27 of file sink.h.

◆ magenta

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::magenta = "\033[35m"

Definition at line 63 of file ansicolor_sink.h.

◆ mutex_

template<typename ConsoleMutex >

mutex_t& spdlog::sinks::ansicolor_sink< ConsoleMutex >::mutex_

private

Definition at line 84 of file ansicolor_sink.h.

◆ on_black

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_black = "\033[40m"

Background colors.

Definition at line 68 of file ansicolor_sink.h.

◆ on_blue

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_blue = "\033[44m"

Definition at line 72 of file ansicolor_sink.h.

◆ on_cyan

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_cyan = "\033[46m"

Definition at line 74 of file ansicolor_sink.h.

◆ on_green

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_green = "\033[42m"

Definition at line 70 of file ansicolor_sink.h.

◆ on_magenta

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_magenta = "\033[45m"

Definition at line 73 of file ansicolor_sink.h.

◆ on_red

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_red = "\033[41m"

Definition at line 69 of file ansicolor_sink.h.

◆ on_white

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_white = "\033[47m"

Definition at line 75 of file ansicolor_sink.h.

◆ on_yellow

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::on_yellow = "\033[43m"

Definition at line 71 of file ansicolor_sink.h.

◆ red

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::red = "\033[31m"

Definition at line 59 of file ansicolor_sink.h.

◆ red_bold

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::red_bold = "\033[31m\033[1m"

Definition at line 79 of file ansicolor_sink.h.

◆ reset

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::reset = "\033[m"

Definition at line 48 of file ansicolor_sink.h.

◆ reverse

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::reverse = "\033[7m"

Definition at line 53 of file ansicolor_sink.h.

◆ should_do_colors_

template<typename ConsoleMutex >

bool spdlog::sinks::ansicolor_sink< ConsoleMutex >::should_do_colors_

private

Definition at line 85 of file ansicolor_sink.h.

◆ target_file_

template<typename ConsoleMutex >

FILE* spdlog::sinks::ansicolor_sink< ConsoleMutex >::target_file_

private

Definition at line 83 of file ansicolor_sink.h.

◆ underline

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::underline = "\033[4m"

Definition at line 51 of file ansicolor_sink.h.

◆ white

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::white = "\033[37m"

Definition at line 65 of file ansicolor_sink.h.

◆ yellow

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::yellow = "\033[33m"

Definition at line 61 of file ansicolor_sink.h.

◆ yellow_bold

template<typename ConsoleMutex >

const string_view_t spdlog::sinks::ansicolor_sink< ConsoleMutex >::yellow_bold = "\033[33m\033[1m"

Bold colors.

Definition at line 78 of file ansicolor_sink.h.

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

Detailed Description

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Member Typedef Documentation

◆ mutex_t

Constructor & Destructor Documentation

◆ ansicolor_sink() [1/3]

◆ ~ansicolor_sink()

◆ ansicolor_sink() [2/3]

◆ ansicolor_sink() [3/3]

Member Function Documentation

◆ flush()

◆ level()

◆ log()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print_ccode_()

◆ print_range_()

◆ set_color()

◆ set_color_mode()

◆ set_formatter()

◆ set_level()

◆ set_pattern()

◆ should_color()

◆ should_log()

◆ to_string_()

Member Data Documentation

◆ black

◆ blink

◆ blue

◆ bold

◆ bold_on_red

◆ clear_line

◆ colors_

◆ concealed

◆ cyan

◆ dark

◆ formatter_

◆ green

◆ level_

◆ magenta

◆ mutex_

◆ on_black

◆ on_blue

◆ on_cyan

◆ on_green

◆ on_magenta

◆ on_red

◆ on_white

◆ on_yellow

◆ red

◆ red_bold

◆ reset

◆ reverse

◆ should_do_colors_

◆ target_file_

◆ underline

◆ white

◆ yellow

◆ yellow_bold