C++ Utilities  4.9.2
Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities
Enumerations | Functions
EscapeCodes Namespace Reference

Encapsulates functions for formatted terminal output using ANSI escape codes. More...

Enumerations

enum  Color : char {
  Color::Black = '0', Color::Red, Color::Green, Color::Yellow,
  Color::Blue, Color::Purple, Color::Cyan, Color::White
}
 
enum  ColorContext : char { ColorContext::Foreground = '3', ColorContext::Background = '4' }
 
enum  TextAttribute : char {
  TextAttribute::Reset = '0', TextAttribute::Bold = '1', TextAttribute::Dim = '2', TextAttribute::Italic = '3',
  TextAttribute::Underscore = '4', TextAttribute::Blink = '5', TextAttribute::ReverseVideo = '7', TextAttribute::Concealed = '8'
}
 
enum  Direction : char { Direction::Up = 'A', Direction::Down = 'B', Direction::Forward = 'C', Direction::Backward = 'D' }
 

Functions

void setStyle (std::ostream &stream, TextAttribute displayAttribute=TextAttribute::Reset)
 
void setStyle (std::ostream &stream, Color color, ColorContext context=ColorContext::Foreground, TextAttribute displayAttribute=TextAttribute::Reset)
 
void setStyle (std::ostream &stream, Color foregroundColor, Color backgroundColor, TextAttribute displayAttribute=TextAttribute::Reset)
 
void resetStyle (std::ostream &stream)
 
void setCursor (std::ostream &stream, unsigned int row=0, unsigned int col=0)
 
void moveCursor (std::ostream &stream, unsigned int cells, Direction direction)
 
void saveCursor (std::ostream &stream)
 
void restoreCursor (std::ostream &stream)
 
void eraseDisplay (std::ostream &stream)
 
void eraseLine (std::ostream &stream)
 

Detailed Description

Encapsulates functions for formatted terminal output using ANSI escape codes.

Remarks
The functions haven't been tested yet and are still experimental. API/ABI might change in next minor release.

Enumeration Type Documentation

◆ Color

enum EscapeCodes::Color : char
strong
Enumerator
Black 
Red 
Green 
Yellow 
Blue 
Purple 
Cyan 
White 

Definition at line 14 of file ansiescapecodes.h.

◆ ColorContext

enum EscapeCodes::ColorContext : char
strong
Enumerator
Foreground 
Background 

Definition at line 16 of file ansiescapecodes.h.

◆ Direction

enum EscapeCodes::Direction : char
strong
Enumerator
Up 
Down 
Forward 
Backward 

Definition at line 29 of file ansiescapecodes.h.

◆ TextAttribute

enum EscapeCodes::TextAttribute : char
strong
Enumerator
Reset 
Bold 
Dim 
Italic 
Underscore 
Blink 
ReverseVideo 
Concealed 

Definition at line 18 of file ansiescapecodes.h.

Function Documentation

◆ eraseDisplay()

void EscapeCodes::eraseDisplay ( std::ostream &  stream)
inline

Definition at line 73 of file ansiescapecodes.h.

◆ eraseLine()

void EscapeCodes::eraseLine ( std::ostream &  stream)
inline

Definition at line 78 of file ansiescapecodes.h.

◆ moveCursor()

void EscapeCodes::moveCursor ( std::ostream &  stream,
unsigned int  cells,
Direction  direction 
)
inline

Definition at line 58 of file ansiescapecodes.h.

◆ resetStyle()

void EscapeCodes::resetStyle ( std::ostream &  stream)
inline

Definition at line 48 of file ansiescapecodes.h.

◆ restoreCursor()

void EscapeCodes::restoreCursor ( std::ostream &  stream)
inline

Definition at line 68 of file ansiescapecodes.h.

◆ saveCursor()

void EscapeCodes::saveCursor ( std::ostream &  stream)
inline

Definition at line 63 of file ansiescapecodes.h.

◆ setCursor()

void EscapeCodes::setCursor ( std::ostream &  stream,
unsigned int  row = 0,
unsigned int  col = 0 
)
inline

Definition at line 53 of file ansiescapecodes.h.

◆ setStyle() [1/3]

void EscapeCodes::setStyle ( std::ostream &  stream,
TextAttribute  displayAttribute = TextAttribute::Reset 
)
inline

Definition at line 31 of file ansiescapecodes.h.

◆ setStyle() [2/3]

void EscapeCodes::setStyle ( std::ostream &  stream,
Color  color,
ColorContext  context = ColorContext::Foreground,
TextAttribute  displayAttribute = TextAttribute::Reset 
)
inline

Definition at line 36 of file ansiescapecodes.h.

◆ setStyle() [3/3]

void EscapeCodes::setStyle ( std::ostream &  stream,
Color  foregroundColor,
Color  backgroundColor,
TextAttribute  displayAttribute = TextAttribute::Reset 
)
inline

Definition at line 42 of file ansiescapecodes.h.