hsuantinglu / ansi-escape

ANSI escape codes wrapped in C++ streams

Ansi-Escape

ANSI escape codes wrapped in C++ string streams.

It's everything you need for advanced terminal control, wrapped in light headers ready for inclusion.

Table of Contents

• About Ansi-Escape
• Quickstart
• Install
• Links

About Ansi-Escape

Ansi-Escape, or AESC, is an effort to wrap common terminal controls and colors for prettier terminal output. It is built and tested on macOS, but probably will work in other *NIX systems as well.

To maximize compatibility, we choose to support C++11, with CMake-3.9 as a build dependency.

Quickstart

AESC implemented most ANSI escape sequences, including text coloring and cursor controlling

there are example codes in the examples/ directory, see Install for more information.

Find detailed list of available APIs at docs and wikipedia

Simple example of text coloring

#include <iostream>
#include "aesc.hpp"
using namespace std;
using aesc::color;

int main() {
    cout << red << " foreground is red" << endl;

    cout << bright::red << bright::background::cyan
         << " background bright cyan, foreground bright red" << endl;

    cout << aesc::color256::RGB::foreground(2, 3, 0) << "256 color RGB test sequence"
         << endl;

    cout << aesc::truecolor::RGB::foreground(130, 250, 0)
         << "24-bit true color RGB test sequence" << aesc::render::reset << endl;
}

Simple example of cursor control

See the provided example at examples/show_color.cpp

Install

Install it with Homebrew, or build it using CMake

Install with Homebrew

brew tap hsuantinglu/utils
brew install ansi-escape

Build with CMake

CMake is the official build system. At least version 3.9 is needed.

mkdir build; cd build/

# Config and build
cmake .. && make showcolor

# execute example
./examples/showcolor

ansi-escape's Issues

if CMAKE version at least 3.9

https://github.com/HsuanTingLu/ansi-escape/blob/16fda7682e06e0ad42aaf24db921027d23506736/CMakeLists.txt#L26-L31

---

This issue was generated by todo based on a @todo comment in 16fda76. It's been assigned to @HsuanTingLu because they committed the code.

Change license

assert 0 <= n <= 23

https://github.com/HsuanTingLu/ansi-escape/blob/535e380b83f88f161cd20093d6d4e5377bbbd252/aesc/csi.hpp#L460-L465

---

This issue was generated by todo based on a @todo comment in 535e380. It's been assigned to @HsuanTingLu because they committed the code.

Upgrade library install steps

modernize CMake steps

Update documents and code map

Implement full xterm control sequence for macOS terminal

We are ought to implement xterm control sequences in some foreseeable future.

ref: hsweif/cpp-logger#7

Fix link issue in README

a tag seems to be off

Add CI

try github actions or travis

Add tests

with coverage report

Change internal include path

change from using project global path to relative path so adding another building system would be easier

Use unformatted output when possible

e.g. https://github.com/HsuanTingLu/ansi-escape/blob/de0a162c7e10f43b9b7ec15ab7af088a2a0ad816/aesc/control/cursor.cpp#L31-L36

use std::cout.write() instead

assert 0 <= r,g,b <= 5

https://github.com/HsuanTingLu/ansi-escape/blob/535e380b83f88f161cd20093d6d4e5377bbbd252/aesc/csi.hpp#L436-L441

---

This issue was generated by todo based on a @todo comment in 535e380. It's been assigned to @HsuanTingLu because they committed the code.

assert 0 <= r,g,b <= 255

https://github.com/HsuanTingLu/ansi-escape/blob/6417a420dc1c02869d4d20ca111d51cf930ce2af/aesc/csi.hpp#L486-L491

---

This issue was generated by todo based on a @todo comment in 6417a42. It's been assigned to @HsuanTingLu because they committed the code.