smilyorg/ansi

Haxe utility for working with ANSI escape sequences.

ansi

Haxe utility for working with ANSI escape sequences.

Provides functions that return a String with the appropriate ANSI escape sequence. This is usually written to standard output for the hosting console to process.

Note: If the console doesn't support the escape sequences (e.g. default Command Prompt on Windows), you're going to see garbage.

Tested with the neko target and ansicon.

Examples

Text Color

Sys.stdout().writeString(ANSI.set(ANSI.attr.Green) + "green text");

or shortened by importing ANSI and with it the Attribute enum:

import ANSI;
...
Sys.stdout().writeString(ANSI.set(Green) + "green text");

---

Sys.stdout().writeString(
	ANSI.set(Green, Bold) + "vivid green text" +
	ANSI.set(DefaultForeground) + " normal text"
);

---

Move and Delete

Sys.stdout().writeString("hello world" + ANSI.moveLeft(5) + ANSI.deleteChars(5) + "ansi");

---

Window Title

Sys.stdout().writeString(ANSI.title("Window title goes here"));

---

Particles!

See Test.hx.

ansi's Issues

Haxelib

Are you planning to release it on haxelib?

Copyright and license

I would like to use this (or, more specifically, a variant of this) in an open-source project.

Is this code open-source and, if so, can you add copyright and license information to the repository?

`Attribute` enum is not compatible with PHP 8

In PHP 8, Attribute is a reserved class name due to the introduction of attributes.
When the Attribute enum is compiled to PHP, an Attribute PHP class is generated, resulting in this error at runtime:

PHP Fatal error:  Uncaught Error: Call to undefined method Attribute::Off() in [...]\ANSI.php:598

So the Attribute enum should be renamed. Or better this library should be put in a package instead of the root namespace.

Investigate adding more / different escape codes

More extensive source: http://ascii-table.com/ansi-escape-sequences.php
Needs testing against ansicon and/or bash.

Win10 support

I believe win10 supports escape sequences but with different syntax: http://stackoverflow.com/questions/2048509/how-to-echo-with-different-colors-in-the-windows-command-line

Request: add helper to get cursor position

I guess it would need to write CSI 6 n (Device Status Report) to stdout and read CSI row ; column R from stdin.

Or is there a better way?

This would also allow us to get the terminal width, with a small hack: move the cursor really far, then read its position.