ESC Class Reference

Class 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: to use the shortcut ESC.XYZ like this, you have to place an using statement in your source code file:

using cs.aworx.lox;

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.

Public Static Fields
static readonly String	BG_BLACK = "\x001BC6"
	Select red color for background.
static readonly String	BG_BLUE = "\x001BC3"
	Select blue color for background.
static readonly String	BG_CYAN = "\x001BC5"
	Select blue color for background.
static readonly String	BG_GRAY = "\x001BC8"
	Select gray color for background.
static readonly String	BG_GREEN = "\x001BC1"
	Select green color for background.
static readonly String	BG_MAGENTA = "\x001BC4"
	Select blue color for background.
static readonly String	BG_RED = "\x001BC0"
	Select red color for background.
static readonly String	BG_RESET = "\x001BC9"
	Select std color for background.
static readonly String	BG_WHITE = "\x001BC7"
	Select blue color for background.
static readonly String	BG_YELLOW = "\x001BC2"
	Select yellow color for background.
static readonly String	BLACK = "\x001Bc6"
	Select black color for foreground.
static readonly String	BLUE = "\x001Bc3"
	Select blue color for foreground.
static readonly String	BOLD = "\x001BsB"
	Select bold font style.
static readonly String	CYAN = "\x001Bc5"
	Select cyan color for foreground.
static readonly String	EOMETA = "\x001BA0"
	End of meta information in log string.
static readonly String	FG_RESET = "\x001Bc9"
	Select std color for foreground.
static readonly String	GRAY = "\x001Bc8"
	Select gray color for foreground.
static readonly String	GREEN = "\x001Bc1"
	Select green color for foreground.
static readonly String	ITALICS = "\x001BsI"
	Select italics font style.
static readonly String	MAGENTA = "\x001Bc4"
	Select magenta color for foreground.
static readonly String	RED = "\x001Bc0"
	Select red color for foreground.
static readonly String	RESET = "\x001Bsa"
	Reset color and style.
static readonly String	STYLE_RESET = "\x001Bsr"
	Select standard font style.
static readonly String	TAB = "\x001Bt0"
static readonly String	URL_END = "\x001BlE"
	Mark the end of an URL.
static readonly String	URL_START = "\x001BlS"
	Mark the start of an URL.
static readonly String	WHITE = "\x001Bc7"
	Select white color for foreground.
static readonly String	YELLOW = "\x001Bc2"
	Select yellow color for foreground.

Public Static Methods
static void	ReplaceToReadable (AString target, int startIdx)

Member Function Documentation

ReplaceToReadable()

static void ReplaceToReadable ( AString  target, int  startIdx  )

inlinestatic

---

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.

Member Data Documentation

TAB

readonly String TAB = "\x001Bt0"

static

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

---

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

• ALoxTypesAndEnums.cs