Command Line Interface Library

Namespaces
	omw::ansiesc
	ANSI escape sequences.

Out Stream Manipulators
omw::ansiesc_ostream_manip_t	omw::backColor (int color8bit)
omw::ansiesc_ostream_manip_t	omw::backColor (uint8_t r, uint8_t g, uint8_t b)
omw::ansiesc_ostream_manip_t	omw::backColor (const omw::Color &color)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBlack (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBlue (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightBlack (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightBlue (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightCyan (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightGreen (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightMagenta (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightRed (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightWhite (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgBrightYellow (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgCyan (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgDefault (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgGreen (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgMagenta (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgRed (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgWhite (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bgYellow (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::blinkFast (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::blinkOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::blinkSlow (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::bold (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::boldOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::conceal (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::concealOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::defaultBackColor (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::defaultColors (std::basic_ostream< CharT, Traits > &os)
	Resets all color settings. More...
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::defaultFont (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::defaultForeColor (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::defaultUnderlineColor (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::encircled (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::encircledOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::faint (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::faintOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBlack (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBlue (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightBlack (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightBlue (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightCyan (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightGreen (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightMagenta (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightRed (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightWhite (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgBrightYellow (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgCyan (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgDefault (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgGreen (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgMagenta (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgRed (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgWhite (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fgYellow (std::basic_ostream< CharT, Traits > &os)
omw::ansiesc_ostream_manip_t	omw::font (int index)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font0 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font1 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font2 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font3 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font4 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font5 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font6 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font7 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font8 (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::font9 (std::basic_ostream< CharT, Traits > &os)
omw::ansiesc_ostream_manip_t	omw::foreColor (int color8bit)
omw::ansiesc_ostream_manip_t	omw::foreColor (uint8_t r, uint8_t g, uint8_t b)
omw::ansiesc_ostream_manip_t	omw::foreColor (const omw::Color &color)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::fraktur (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::frakturOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::framed (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::framedOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::italic (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::italicOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::normal (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::overlined (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::overlinedOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::reveal (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::reverseVideo (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::reverseVideoOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::strike (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::strikeOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::sub (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::subOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::super (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::superOff (std::basic_ostream< CharT, Traits > &os)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::underline (std::basic_ostream< CharT, Traits > &os)
omw::ansiesc_ostream_manip_t	omw::underlineColor (int color8bit)
omw::ansiesc_ostream_manip_t	omw::underlineColor (uint8_t r, uint8_t g, uint8_t b)
omw::ansiesc_ostream_manip_t	omw::underlineColor (const omw::Color &color)
template<class CharT , class Traits = std::char_traits<CharT>>
std::basic_ostream< CharT, Traits > &	omw::underlineOff (std::basic_ostream< CharT, Traits > &os)

Detailed Description

#include <omw/cli.h>

ANSI escape on Windows

The parsing of ANSI escape sequences (VT100) has to be enabled. Depending of the result, the mode of the omw library can be set:

#include <iostream>
 
#include <omw/omw.h>
#include <omw/windows/windows.h>
 
using std::cout;
using std::endl;
 
int main()
{
#ifdef OMW_PLAT_WIN
    const bool vtEnable = omw::windows::consoleEnVirtualTermProc();
    omw::ansiesc::enable(vtEnable);
    if(!vtEnable) cout << "faild to enable virtual terminal processing" << endl;
#else // optional
    const bool vtEnable = true;
    omw::ansiesc::enable(vtEnable);
#endif
 
    // app code ...
    // ...
    // ...
 
    return 0;
}

See also ANSI escape sequence builder mode and omw::windows::consoleEnVirtualTermProc().

Function Documentation

defaultColors()

template<class CharT , class Traits = std::char_traits<CharT>>

std::basic_ostream<CharT, Traits>& omw::defaultColors ( std::basic_ostream< CharT, Traits > &  os )

inline

Resets all color settings.

• omw::defaultBackColor
• omw::defaultForeColor
• omw::defaultUnderlineColor