ANSI escape sequences. More...

Namespaces
	csi
	CSI (Control Sequence Introducer)

Functions
omw::string	seq (char type, const omw::string &argstr="")
	Root of all sequence builders. More...

Variables
constexpr char	argDelimiter = ';'

constexpr char	escChar = '\x1B'

Sequence Types
constexpr char	SS2 = 'N'

constexpr char	SS3 = 'O'

constexpr char	DCS = 'P'

constexpr char	CSI = '['

constexpr char	ST = '\\'

constexpr char	OSC = ']'

constexpr char	SOS = 'X'

constexpr char	PM = '^'

constexpr char	APC = '_'

constexpr char	RIS = 'c'

Sequence Types Aliases
constexpr char	singleShiftTwo = SS2

constexpr char	singleShiftThree = SS3

constexpr char	deviceControlString = DCS

constexpr char	controlSequenceIntroducer = CSI

constexpr char	stringTerminator = ST

constexpr char	osCommand = OSC

constexpr char	startOfString = SOS

constexpr char	privacyMessage = PM

constexpr char	appProgramCommand = APC

constexpr char	resetToInitialState = RIS

ANSI escape sequence builder mode
enum	MODE { MODE_DEFAULT = 0, MODE_DISABLED, MODE_ENABLED }
	ANSI escape sequence builder mode. More...

void	setMode (int mode)

int	getMode ()

void	enable (bool state=true)

void	disable ()

bool	isEnabled ()

Detailed Description

ANSI escape sequences.

Further information on ANSI Escape Code (Wikipedia).

ANSI escape sequence builder mode

The mode setting is a library internal global variable, it is not thread save.

On Windows the default mode is processed as disabled, and as enabled on all other platforms.

Enumeration Type Documentation

◆ MODE

enum omw::ansiesc::MODE

ANSI escape sequence builder mode.

Enumerator
MODE_DEFAULT	Default. See ANSI escape sequence builder mode
MODE_DISABLED	Disabled. The sequence builders return an empty string.
MODE_ENABLED	Enabled

Function Documentation

◆ disable()

void omw::ansiesc::disable ( )

Sets the mode to omw::ansiesc::MODE_DISABLED.

◆ enable()

void omw::ansiesc::enable ( bool state = true )

Sets the mode to omw::ansiesc::MODE_ENABLED or omw::ansiesc::MODE_DISABLED.

◆ getMode()

int omw::ansiesc::getMode ( )

Returns: The current mode. One of omw::ansiesc::MODE

See ANSI escape sequence builder mode.

◆ seq()

omw::string omw::ansiesc::seq	(	char	type,
		const omw::string &	argstr = `""`
	)

Root of all sequence builders.

Parameters

type	Escape sequence type
argstr	The arguments of the sequence

Builds an escape sequence: ESC <type> <argstr>.

As the root sequence builder, it takes care of the ANSI escape sequence builder mode.

◆ setMode()

void omw::ansiesc::setMode ( int mode )

Parameters

mode	One of `omw::ansiesc::MODE`

See ANSI escape sequence builder mode.

Namespaces

Functions

Variables