vt_helper.h File Reference

Provides types for using virtual terminal sequences with console output. More...

#include "console_helper.h"
#include "scope_helper.h"
#include <string_view>
#include <locale>

Include dependency graph for vt_helper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	ookii::vt::virtual_terminal_support
	Handles the lifetime of virtual terminal support. More...

Namespaces
	ookii
	Namespace containing the core Ookii.CommandLine.Cpp types.
	ookii::vt
	Namespace containing functions and types for working with virtual terminal sequences.
	ookii::vt::text_format
	Provides constants for various virtual terminal sequences that control text format.

Functions
template<typename CharType = ookii::details::default_char_type>
std::basic_string< CharType >	ookii::vt::text_format::get_extended_color (int red, int green, int blue, bool foreground=true)
	Returns the virtual terminal sequence to the foreground or background color to an RGB color. More...

Variables
constexpr const char *	ookii::vt::text_format::background_black = "\x1b[40m"
	Sets the background color to black.
constexpr const char *	ookii::vt::text_format::background_blue = "\x1b[44m"
	Sets the background color to blue.
constexpr const char *	ookii::vt::text_format::background_cyan = "\x1b[46m"
	Sets the background color to cyan.
constexpr const char *	ookii::vt::text_format::background_default = "\x1b[49m"
	Sets the background color to default.
constexpr const char *	ookii::vt::text_format::background_green = "\x1b[42m"
	Sets the background color to green.
constexpr const char *	ookii::vt::text_format::background_magenta = "\x1b[45m"
	Sets the background color to magenta.
constexpr const char *	ookii::vt::text_format::background_red = "\x1b[41m"
	Sets the background color to red.
constexpr const char *	ookii::vt::text_format::background_white = "\x1b[47m"
	Sets the background color to white.
constexpr const char *	ookii::vt::text_format::background_yellow = "\x1b[43m"
	Sets the background color to yellow.
constexpr const char *	ookii::vt::text_format::bold_bright = "\x1b[1m"
	Applies the brightness/intensity flag to the foreground color.
constexpr const char *	ookii::vt::text_format::bright_background_black = "\x1b[100m"
	Sets the background color to bright black.
constexpr const char *	ookii::vt::text_format::bright_background_blue = "\x1b[104m"
	Sets the background color to bright blue.
constexpr const char *	ookii::vt::text_format::bright_background_cyan = "\x1b[106m"
	Sets the background color to bright cyan.
constexpr const char *	ookii::vt::text_format::bright_background_green = "\x1b[102m"
	Sets the background color to bright green.
constexpr const char *	ookii::vt::text_format::bright_background_magenta = "\x1b[105m"
	Sets the background color to bright magenta.
constexpr const char *	ookii::vt::text_format::bright_background_red = "\x1b[101m"
	Sets the background color to bright red.
constexpr const char *	ookii::vt::text_format::bright_background_white = "\x1b[107m"
	Sets the background color to bright white.
constexpr const char *	ookii::vt::text_format::bright_background_yellow = "\x1b[103m"
	Sets the background color to bright yellow.
constexpr const char *	ookii::vt::text_format::bright_foreground_black = "\x1b[90m"
	Sets the foreground color to bright black.
constexpr const char *	ookii::vt::text_format::bright_foreground_blue = "\x1b[94m"
	Sets the foreground color to bright blue.
constexpr const char *	ookii::vt::text_format::bright_foreground_cyan = "\x1b[96m"
	Sets the foreground color to bright cyan.
constexpr const char *	ookii::vt::text_format::bright_foreground_green = "\x1b[92m"
	Sets the foreground color to bright green.
constexpr const char *	ookii::vt::text_format::bright_foreground_magenta = "\x1b[95m"
	Sets the foreground color to bright magenta.
constexpr const char *	ookii::vt::text_format::bright_foreground_red = "\x1b[91m"
	Sets the foreground color to bright red.
constexpr const char *	ookii::vt::text_format::bright_foreground_white = "\x1b[97m"
	Sets the foreground color to bright white.
constexpr const char *	ookii::vt::text_format::bright_foreground_yellow = "\x1b[93m"
	Sets the foreground color to bright yellow.
constexpr const char *	ookii::vt::text_format::default_format = "\x1b[0m"
	Resets the text format to the settings before modification.
constexpr const char *	ookii::vt::text_format::foreground_black = "\x1b[30m"
	Sets the foreground color to black.
constexpr const char *	ookii::vt::text_format::foreground_blue = "\x1b[34m"
	Sets the foreground color to blue.
constexpr const char *	ookii::vt::text_format::foreground_cyan = "\x1b[36m"
	Sets the foreground color to cyan.
constexpr const char *	ookii::vt::text_format::foreground_default = "\x1b[39m"
	Sets the foreground color to default.
constexpr const char *	ookii::vt::text_format::foreground_green = "\x1b[32m"
	Sets the foreground color to green.
constexpr const char *	ookii::vt::text_format::foreground_magenta = "\x1b[35m"
	Sets the foreground color to magenta.
constexpr const char *	ookii::vt::text_format::foreground_red = "\x1b[31m"
	Sets the foreground color to red.
constexpr const char *	ookii::vt::text_format::foreground_white = "\x1b[37m"
	Sets the foreground color to white.
constexpr const char *	ookii::vt::text_format::foreground_yellow = "\x1b[33m"
	Sets the foreground color to yellow.
constexpr const char *	ookii::vt::text_format::negative = "\x1b[7m"
	Swaps foreground and background colors.
constexpr const char *	ookii::vt::text_format::no_bold_bright = "\x1b[22m"
	Removes the brightness/intensity flag to the foreground color.
constexpr const char *	ookii::vt::text_format::no_underline = "\x1b[24m"
	Removes underline.
constexpr const char *	ookii::vt::text_format::positive = "\x1b[27m"
	Returns foreground and background colors to normal.
constexpr const char *	ookii::vt::text_format::underline = "\x1b[4m"
	Adds underline.

Detailed Description

Provides types for using virtual terminal sequences with console output.