Usage example -
The main macro is
with-color, which creates an enviroment where everything that is put on
stream gets colored according to
Color options comes in several forms.
Basic 8 colors in the 3-bit color mode are supported, which are
* (with-color (:red) (princ "Gets printed red...") (princ "and this too!")) ; Gets printed red...and this too! ; => "and this too!"
These are color structures from
CL-COLORS2 (a maintained fork of
CL-COLORS2 has several constants e.g.
cl-colors:+red+ that holds the corresponding color values.
CL-COLORS2 also supports useful blending operations on colors.
CL-COLORS2 library provides a package
These are CSS-style color strings such as
Integer as a 24-bit color
It treats an integer as a hex string. The bottom 8 bit is used for the blue, the 8th to 16th bits are used for green, the 16th to 24th bits are used for red. Remaining bits are ignored.
List of numbers as a 24-bit color
It takes a list of three numbers (RGB) between 0 and 256.
Function interface for printing in specific colors
We provide shorthand functions for generating a colored strings:
* (yellow "Yellow string") ; => "Yellow string" * (princ (yellow "String with yellow background" :style :background)) ; "String with yellow background" ; => "String with yellow background" * (princ (concatenate 'string (yellow "Five") " test results went " (red "terribly wrong") "!")) ; Five test results went terribly wrong! ; => "Five test results went terribly wrong!"
You can bind the
*enabled* special variable to
nil to control the colorization:
* (let (cl-ansi-text:*enabled*) (princ (red "This string is printed normally")))
(or unsigned-byte (cons (real 0 256) (cons (real 0 256) (cons (real 0 256) nil))) cl-colors:rgb cl-colors:hsv term-colors color-string)
(member :black :red :green :yellow :blue :magenta :cyan :white)
A string of length 3, 4, 6, or 7, that optionally starts with a
the rest consists of 3 or 6 hexademical alphadigits (case-insensitive).
with-color (color &key (stream t) (effect :unset) (style :foreground)) &body body
Writes out the ANSI escape code string
style, and a switch to
color, then executes
then writes out the string that resets the decoration.
make-color-string color &key (effect :unset) (style :foreground) enabled
Takes an object of
color-specifier and returns a string sufficient to change to the given color.
Colorization is controlled by enabled unless manually specified otherwise by
Function black, red, green, yellow, blue, magenta, cyan, white
Shortcut functions that takes a single argument,
string, and returns a string
decorated by the corresponding color.
Turns on/off the colorization.
Controls the way
make-color-string emits the color code.
It should be one of the following keyword symbols:
The specified color is converted to the nearest color in the color space.
The default value is
Note that the actual appearance of the screen in the
:3bit mode may be affected by
the terminal setting -- For example, many terminals do not use
FF0000 for the red.
A constant string that resets the color state of the terminal.
./testscr.ros with Roswell. You can also manually run the test with
(ql:quickload :cl-ansi-text.test) (fiveam:run! :cl-ansi-text).
You can view the list of lisp implementation this library is tested on the Github Action tab. The testing environment is Linux, but we believe this should work also on OSX.
Note that your terminal MUST be ANSI-compliant to show these colors.
SLIME REPL does not display these colors by default (2019.12.13).
To make it understand the ANSI escape sequence,
slime-repl-ansi-color package available from MELPA
package-install and add the following in
(with-eval-after-load 'slime-repl (require 'slime-repl-ansi-color)) (add-hook 'slime-repl-mode-hook 'slime-repl-ansi-color-mode)