Description:

This class defines "escape sequences" that influence the formatting of log output. Specific implementations of class Logger have to convert or interpret this classes definitions of escape sequences when processing log data. If no formatting of the output is supported by a specific Logger implementation, such logger should filter and discard escape sequences defined here.

The sequences are similar to ANSI Escape sequences and logger classes that log to 'VT100' compatible terminals will simply convert them.

The name of the class was intentionally chosen to be short, because the escape codes defined with this class will be concatenated to log strings like that:

Log_Info( "The result is: ", ESC::RED, 42 )

Note: With the introduction of own, ALox specific escape codes, software that uses ALox becomes independent from any underlying, platform-specific sequences. For example, ALox is not relying on ANSI color codes, which are not supported by colorful Windows consoles. Instead, on each platform, dedicated Loggers will perform the translation of ALox codes to platform-specific ones.

Definition at line 182 of file alox/alox.hpp.

#include <alox.hpp>

Public Static Field Index:
static constexpr character	BG_BLACK [4] { A_CHAR("\033C6") }
	Select red color for background.

static constexpr character	BG_BLUE [4] { A_CHAR("\033C3") }
	Select blue color for background.

static constexpr character	BG_CYAN [4] { A_CHAR("\033C5") }
	Select blue color for background.

static constexpr character	BG_GRAY [4] { A_CHAR("\033C8") }
	Select gray color for background.

static constexpr character	BG_GREEN [4] { A_CHAR("\033C1") }
	Select green color for background.

static constexpr character	BG_MAGENTA [4] { A_CHAR("\033C4") }
	Select blue color for background.

static constexpr character	BG_RED [4] { A_CHAR("\033C0") }
	Select red color for background.

static constexpr character	BG_RESET [4] { A_CHAR("\033C9") }
	Select std color for background.

static constexpr character	BG_WHITE [4] { A_CHAR("\033C7") }
	Select blue color for background.

static constexpr character	BG_YELLOW [4] { A_CHAR("\033C2") }
	Select yellow color for background.

static constexpr character	BLACK [4] { A_CHAR("\033c6") }
	Select black color for foreground.

static constexpr character	BLUE [4] { A_CHAR("\033c3") }
	Select blue color for foreground.

static constexpr character	BOLD [4] { A_CHAR("\033sB") }
	Select bold font style.

static constexpr character	CYAN [4] { A_CHAR("\033c5") }
	Select cyan color for foreground.

static constexpr character	EOMETA [4] { A_CHAR("\033A0") }
	End of meta information in log string.

static constexpr character	FG_RESET [4] { A_CHAR("\033c9") }
	Select std color for foreground.

static constexpr character	GRAY [4] { A_CHAR("\033c8") }
	Select gray color for foreground.

static constexpr character	GREEN [4] { A_CHAR("\033c1") }
	Select green color for foreground.

static constexpr character	ITALICS [4] { A_CHAR("\033sI") }
	Select italics font style.

static constexpr character	MAGENTA [4] { A_CHAR("\033c4") }
	Select magenta color for foreground.

static constexpr character	RED [4] { A_CHAR("\033c0") }
	Select red color for foreground.

static constexpr character	RESET [4] { A_CHAR("\033sa") }
	Reset color and style.

static constexpr character	STYLE_RESET [4] { A_CHAR("\033sr") }
	Select standard font style.

static constexpr character	TAB [4] { A_CHAR("\033t0") }
	Go to next tab. Usually, text loggers will increase the tab position automatically.

static constexpr character	URL_END [4] { A_CHAR("\033lE") }
	Mark the end of an URL.

static constexpr character	URL_START [4] { A_CHAR("\033lS") }
	Mark the start of an URL.

static constexpr character	WHITE [4] { A_CHAR("\033c7") }
	Select white color for foreground.

static constexpr character	YELLOW [4] { A_CHAR("\033c2") }
	Select yellow color for foreground.

Public Static Method Index:
static ALIB_API void	ReplaceToReadable (AString &target, integer startIdx)

Field Details:

◆ BG_BLACK

constexpr character BG_BLACK[4] { A_CHAR("\033C6") }

staticconstexpr

Select red color for background.

Definition at line 202 of file alox/alox.hpp.

◆ BG_BLUE

constexpr character BG_BLUE[4] { A_CHAR("\033C3") }

staticconstexpr

Select blue color for background.

Definition at line 199 of file alox/alox.hpp.

◆ BG_CYAN

constexpr character BG_CYAN[4] { A_CHAR("\033C5") }

staticconstexpr

Select blue color for background.

Definition at line 201 of file alox/alox.hpp.

◆ BG_GRAY

constexpr character BG_GRAY[4] { A_CHAR("\033C8") }

staticconstexpr

Select gray color for background.

Definition at line 204 of file alox/alox.hpp.

◆ BG_GREEN

constexpr character BG_GREEN[4] { A_CHAR("\033C1") }

staticconstexpr

Select green color for background.

Definition at line 197 of file alox/alox.hpp.

◆ BG_MAGENTA

constexpr character BG_MAGENTA[4] { A_CHAR("\033C4") }

staticconstexpr

Select blue color for background.

Definition at line 200 of file alox/alox.hpp.

◆ BG_RED

constexpr character BG_RED[4] { A_CHAR("\033C0") }

staticconstexpr

Select red color for background.

Definition at line 196 of file alox/alox.hpp.

◆ BG_RESET

constexpr character BG_RESET[4] { A_CHAR("\033C9") }

staticconstexpr

Select std color for background.

Definition at line 205 of file alox/alox.hpp.

◆ BG_WHITE

constexpr character BG_WHITE[4] { A_CHAR("\033C7") }

staticconstexpr

Select blue color for background.

Definition at line 203 of file alox/alox.hpp.

◆ BG_YELLOW

constexpr character BG_YELLOW[4] { A_CHAR("\033C2") }

staticconstexpr

Select yellow color for background.

Definition at line 198 of file alox/alox.hpp.

◆ BLACK

constexpr character BLACK[4] { A_CHAR("\033c6") }

staticconstexpr

Select black color for foreground.

Definition at line 191 of file alox/alox.hpp.

◆ BLUE

constexpr character BLUE[4] { A_CHAR("\033c3") }

staticconstexpr

Select blue color for foreground.

Definition at line 188 of file alox/alox.hpp.

◆ BOLD

constexpr character BOLD[4] { A_CHAR("\033sB") }

staticconstexpr

Select bold font style.

Definition at line 207 of file alox/alox.hpp.

◆ CYAN

constexpr character CYAN[4] { A_CHAR("\033c5") }

staticconstexpr

Select cyan color for foreground.

Definition at line 190 of file alox/alox.hpp.

◆ EOMETA

constexpr character EOMETA[4] { A_CHAR("\033A0") }

staticconstexpr

End of meta information in log string.

Definition at line 216 of file alox/alox.hpp.

◆ FG_RESET

constexpr character FG_RESET[4] { A_CHAR("\033c9") }

staticconstexpr

Select std color for foreground.

Definition at line 194 of file alox/alox.hpp.

◆ GRAY

constexpr character GRAY[4] { A_CHAR("\033c8") }

staticconstexpr

Select gray color for foreground.

Definition at line 193 of file alox/alox.hpp.

◆ GREEN

constexpr character GREEN[4] { A_CHAR("\033c1") }

staticconstexpr

Select green color for foreground.

Definition at line 186 of file alox/alox.hpp.

◆ ITALICS

constexpr character ITALICS[4] { A_CHAR("\033sI") }

staticconstexpr

Select italics font style.

Definition at line 208 of file alox/alox.hpp.

◆ MAGENTA

constexpr character MAGENTA[4] { A_CHAR("\033c4") }

staticconstexpr

Select magenta color for foreground.

Definition at line 189 of file alox/alox.hpp.

◆ RED

constexpr character RED[4] { A_CHAR("\033c0") }

staticconstexpr

Select red color for foreground.

Definition at line 185 of file alox/alox.hpp.

◆ RESET

constexpr character RESET[4] { A_CHAR("\033sa") }

staticconstexpr

Reset color and style.

Definition at line 210 of file alox/alox.hpp.

◆ STYLE_RESET

constexpr character STYLE_RESET[4] { A_CHAR("\033sr") }

staticconstexpr

Select standard font style.

Definition at line 209 of file alox/alox.hpp.

◆ TAB

constexpr character TAB[4] { A_CHAR("\033t0") }

staticconstexpr

Go to next tab. Usually, text loggers will increase the tab position automatically.

Definition at line 214 of file alox/alox.hpp.

◆ URL_END

constexpr character URL_END[4] { A_CHAR("\033lE") }

staticconstexpr

Mark the end of an URL.

Definition at line 213 of file alox/alox.hpp.

◆ URL_START

constexpr character URL_START[4] { A_CHAR("\033lS") }

staticconstexpr

Mark the start of an URL.

Definition at line 212 of file alox/alox.hpp.

◆ WHITE

constexpr character WHITE[4] { A_CHAR("\033c7") }

staticconstexpr

Select white color for foreground.

Definition at line 192 of file alox/alox.hpp.

◆ YELLOW

constexpr character YELLOW[4] { A_CHAR("\033c2") }

staticconstexpr

Select yellow color for foreground.

Definition at line 187 of file alox/alox.hpp.

Method Details:

◆ ReplaceToReadable()

void ReplaceToReadable	(	AString &	target,
		integer	startIdx )

static

Replaces ESC codes in a string reversely to "ESC::XXX".

Parameters

target	The string to replace in.
startIdx	The index to start searching for ESC codes.

Definition at line 395 of file aloxmodule.cpp.

Here is the call graph for this function:

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

Description:

Public Static Field Index:

Public Static Method Index:

Field Details:

◆ BG_BLACK

◆ BG_BLUE

◆ BG_CYAN

◆ BG_GRAY

◆ BG_GREEN

◆ BG_MAGENTA

◆ BG_RED

◆ BG_RESET

◆ BG_WHITE

◆ BG_YELLOW

◆ BLACK

◆ BLUE

◆ BOLD

◆ CYAN

◆ EOMETA

◆ FG_RESET

◆ GRAY

◆ GREEN

◆ ITALICS

◆ MAGENTA

◆ RED

◆ RESET

◆ STYLE_RESET

◆ TAB

◆ URL_END

◆ URL_START

◆ WHITE

◆ YELLOW

Method Details:

◆ ReplaceToReadable()