This is the chlorophyll Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 03:36:33 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
chlorophyllANSI escape code library for Common Lisp
Mikhail Gorozhin <m.gorozhin@gmail.com>
Expat
‘chlorophyll‘ is a ANSI escape code library for Common Lisp.
## Installation
### Quicklisp
Set up [Quicklisp](https://www.quicklisp.org/beta/), load ‘chlorophyll‘:
“‘common-lisp
(ql:quickload "chlorophyll")
“‘
### Ultralisp
Set up [Quicklisp](https://www.quicklisp.org/beta/) and [Ultralisp](https://ultralisp.org/), load ‘chlorophyll‘:
“‘common-lisp
(ql:quickload "chlorophyll")
“‘
## Usage
“‘common-lisp
(let ((very-peri (chlorophyll:create-rgb-color 102 103 171))
(hot-pink (chlorophyll:create-rgb-color 255 105 180)))
(format t "~A~%~A~%" (chlorophyll:bold "overline text")
(chlorophyll:stylize
(chlorophyll:new-style
:bold t
:foreground hot-pink
:background very-peri)
"beautiful text")))
“‘
0.0.1
alexandria (system).
uiop (system).
src (module).
Modules are listed depth-first from the system components tree.
chlorophyll/srcchlorophyll (system).
package.lisp (file).
profile.lisp (file).
color.lisp (file).
color-converter.lisp (file).
style.lisp (file).
positioning.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
chlorophyll/chlorophyll.asdchlorophyll/src/package.lispchlorophyll/src/profile.lispchlorophyll/src/color.lispchlorophyll/src/color-converter.lispchlorophyll/src/style.lispchlorophyll/src/positioning.lispchlorophyll/chlorophyll.asdchlorophyll (system).
chlorophyll/src/profile.lispsrc (module).
*profile* (special variable).
create-profile (function).
new-ansi-256-terminal (function).
new-ansi-terminal (function).
new-ascii-terminal (function).
new-profile-from-env (function).
new-terminal (function).
new-truecolor-terminal (function).
ansi-256-terminal (class).
ansi-terminal (class).
ascii-terminal (class).
dynamic-profile (class).
new-dynamic-profile (function).
new-profile-from-env-momoised (function).
profile (class).
supports-effects-p (method).
supports-effects-p (method).
supports-effects-p (method).
supports-effects-p (method).
supports-effects-p (method).
terminal (method).
terminal (reader method).
terminal (class).
truecolor-terminal (class).
chlorophyll/src/color.lispsrc (module).
create-ansi-256-color (function).
create-ansi-color (function).
create-no-color (function).
create-rgb-color (function).
*ansi-256-color-cube-normalized-lengths* (special variable).
*ansi-colors* (special variable).
*predefined-colors* (special variable).
*shades-of-grey* (special variable).
+ansi-256-color-cube-dimension+ (constant).
+ansi-256-normalization-factor+ (constant).
+ansi-256-start+ (constant).
+ansi-black+ (constant).
+extended-ansi-start+ (constant).
+grey-codes-end+ (constant).
+grey-codes-start+ (constant).
+grey-initial-offset+ (constant).
+grey-step+ (constant).
ansi-256-color (class).
ansi-color (class).
blue (reader method).
(setf blue) (writer method).
color (class).
color-id (reader method).
color-id (reader method).
(setf color-id) (writer method).
(setf color-id) (writer method).
extended-ansi-p (method).
green (reader method).
(setf green) (writer method).
no-color (class).
red (reader method).
(setf red) (writer method).
rgb-color (class).
chlorophyll/src/color-converter.lispsrc (module).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
adapt (method).
distance (method).
to-ansi-256-color (method).
to-ansi-256-color (method).
to-ansi-256-color (method).
to-ansi-256-color (method).
to-ansi-color (method).
to-ansi-color (method).
to-ansi-color (method).
to-ansi-color (method).
to-no-color (method).
to-rgb-color (method).
to-rgb-color (method).
to-rgb-color (method).
to-rgb-color (method).
chlorophyll/src/style.lispsrc (module).
+background+ (constant).
+background-ansi-addup+ (constant).
+background-extended-ansi-addup+ (constant).
+background-mode+ (constant).
+blink+ (constant).
+bold+ (constant).
+crossout+ (constant).
+faint+ (constant).
+foreground+ (constant).
+foreground-ansi-addup+ (constant).
+foreground-extended-ansi-addup+ (constant).
+foreground-mode+ (constant).
+invert+ (constant).
+italic+ (constant).
+overline+ (constant).
+reset+ (constant).
+underline+ (constant).
background-mode (class).
blinkp (reader method).
boldp (reader method).
color-mode (class).
crossoutp (reader method).
equal-mode (method).
equal-mode (method).
equal-mode (method).
equal-mode (method).
equal-mode (method).
equal-mode (method).
faintp (reader method).
foreground-mode (class).
get-background (reader method).
get-foreground (reader method).
invertp (reader method).
italicp (reader method).
overlinep (reader method).
style (class).
to-sequence (method).
to-sequence (method).
to-sequence (method).
to-sequence (method).
to-sequence (method).
to-sequence (method).
to-sequence (method).
underlinep (reader method).
chlorophyll/src/positioning.lispsrc (module).
cursor-backward (function).
cursor-down (function).
cursor-forward (function).
cursor-next-line (function).
cursor-previous-line (function).
cursor-up (function).
move-cursor (function).
restore-cursor-position (function).
save-cursor-position (function).
Packages are listed by definition order.
chlorophyllalexandria.
common-lisp.
*profile* (special variable).
background (function).
blink (function).
bold (function).
create-ansi-256-color (function).
create-ansi-color (function).
create-no-color (function).
create-profile (function).
create-rgb-color (function).
crossout (function).
cursor-backward (function).
cursor-down (function).
cursor-forward (function).
cursor-next-line (function).
cursor-previous-line (function).
cursor-up (function).
faint (function).
foreground (function).
invert (function).
italic (function).
move-cursor (function).
new-ansi-256-terminal (function).
new-ansi-terminal (function).
new-ascii-terminal (function).
new-profile-from-env (function).
new-style (function).
new-terminal (function).
new-truecolor-terminal (function).
overline (function).
restore-cursor-position (function).
save-cursor-position (function).
stylize (generic function).
underline (function).
*ansi-256-color-cube-normalized-lengths* (special variable).
*ansi-colors* (special variable).
*predefined-colors* (special variable).
*shades-of-grey* (special variable).
+ansi-256-color-cube-dimension+ (constant).
+ansi-256-normalization-factor+ (constant).
+ansi-256-start+ (constant).
+ansi-black+ (constant).
+background+ (constant).
+background-ansi-addup+ (constant).
+background-extended-ansi-addup+ (constant).
+background-mode+ (constant).
+blink+ (constant).
+bold+ (constant).
+crossout+ (constant).
+extended-ansi-start+ (constant).
+faint+ (constant).
+foreground+ (constant).
+foreground-ansi-addup+ (constant).
+foreground-extended-ansi-addup+ (constant).
+foreground-mode+ (constant).
+grey-codes-end+ (constant).
+grey-codes-start+ (constant).
+grey-initial-offset+ (constant).
+grey-step+ (constant).
+invert+ (constant).
+italic+ (constant).
+overline+ (constant).
+reset+ (constant).
+underline+ (constant).
adapt (generic function).
ansi-256-color (class).
ansi-256-terminal (class).
ansi-color (class).
ansi-terminal (class).
ascii-terminal (class).
background-mode (class).
blinkp (generic reader).
blue (generic reader).
(setf blue) (generic writer).
boldp (generic reader).
color (class).
color-id (generic reader).
(setf color-id) (generic writer).
color-mode (class).
crossoutp (generic reader).
distance (generic function).
dynamic-profile (class).
equal-mode (generic function).
extended-ansi-p (generic function).
faintp (generic reader).
foreground-mode (class).
get-background (generic reader).
get-foreground (generic reader).
green (generic reader).
(setf green) (generic writer).
invertp (generic reader).
italicp (generic reader).
new-dynamic-profile (function).
new-profile-from-env-momoised (function).
no-color (class).
overlinep (generic reader).
profile (class).
red (generic reader).
(setf red) (generic writer).
rgb-color (class).
style (class).
supports-effects-p (generic function).
terminal (generic function).
terminal (class).
to-ansi-256-color (generic function).
to-ansi-color (generic function).
to-no-color (generic function).
to-rgb-color (generic function).
to-sequence (generic function).
truecolor-terminal (class).
underlinep (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Eloquent constructor setting BACKGROUND
Eloquent constructor setting BLINK
Eloquent constructor setting BOLD
Constructor for an ANSI-256-COLOR
Constructor for an ANSI-COLOR
Constructor for an NO-COLOR
Constructor for an RGB-COLOR
Eloquent constructor setting CROSSOUT
Moves cursor N columns backward
Moves cursor N rows down
Moves cursor N columns forward
Moves cursor to beginning of the line n lines up
Moves cursor to beginning of the line n lines down
Moves cursor N rows up
Eloquent constructor setting FAINT
Eloquent constructor setting FOREGROUND
Eloquent constructor setting INVERT
Eloquent constructor setting ITALIC
Moves cursor to desired position
Constructor for a STYLE
Eloquent constructor setting OVERLINE
Restores the cursor position
Saves current cursor position
Eloquent constructor setting UNDERLINE
ANSI defined constant for a foreground color
addup constant for a foreground color
addup constant for a foreground color
ANSI defined constant for blinking text
ANSI defined constant for bold text
ANSI defined constant for crossedout text
Code point representing start of extended ANSI set of colors
ANSI defined constant for faint text
ANSI defined constant for a background color
addup constant for a background color
addup constant for a background color
ANSI defined constant for inverted colors
ANSI defined constant for italic text
ANSI defined constant for an overlined text
ANSI defined constant for a reset action
ANSI defined constant for an underlined text
ansi-color) (terminal ansi-terminal)) ¶ansi-color) (terminal ansi-256-terminal)) ¶ansi-color) (terminal truecolor-terminal)) ¶ansi-256-color) (terminal ansi-terminal)) ¶ansi-256-color) (terminal ansi-256-terminal)) ¶ansi-256-color) (terminal truecolor-terminal)) ¶rgb-color) (terminal ansi-terminal)) ¶rgb-color) (terminal ansi-256-terminal)) ¶rgb-color) (terminal truecolor-terminal)) ¶color) (terminal ascii-terminal)) ¶ansi-256-color)) ¶ansi-256-color)) ¶Position in a predefined set of colors
ansi-color)) ¶ansi-color)) ¶Position in a predefined set of colors
background-mode) (y background-mode)) ¶background-mode)) ¶background-mode) y) ¶foreground-mode) (y foreground-mode)) ¶foreground-mode)) ¶foreground-mode) y) ¶ansi-color)) ¶truecolor-terminal)) ¶ansi-256-terminal)) ¶ansi-terminal)) ¶ascii-terminal)) ¶dynamic-profile)) ¶ansi-256-color)) ¶ansi-color)) ¶ansi-256-color)) ¶ansi-color)) ¶ansi-256-color)) ¶ansi-color)) ¶ansi-256-color) (mode foreground-mode)) ¶Converts ANSI-256-COLOR to an escape sequence color definition
ansi-256-color) (mode background-mode)) ¶Converts ANSI-256-COLOR to an escape sequence color definition
rgb-color) (mode foreground-mode)) ¶Converts RGB-COLOR to an escape sequence color definition
rgb-color) (mode background-mode)) ¶Converts RGB-COLOR to an escape sequence color definition
ansi-color) (mode background-mode)) ¶Converts ANSI-COLOR to an escape sequence color definition
ansi-color) (mode foreground-mode)) ¶Converts ANSI-COLOR to an escape sequence color definition
no-color) (mode color-mode)) ¶Converts NO-COLOR to a ANSI escape sequence color definition
Represents a color from predefined ANSI set of colors
Position in a predefined set of colors
(integer 0 255)
:color-id
Represents 8 bit color terminal
Represents a color from predefined ANSI set of colors
Position in a predefined set of colors
(integer 0 15)
:color-id
Represents 3(4) bit color terminal
Represents dumb terminal, no colors, no effects.
defines background color mode
Base class representing color, not to be used directly
defines mode in which color is used, not to be used directly
defines foreground color mode
NOOP color class, not representing any real color
Chlorophyll profile
Represents a 24-bit RGB color
Amount of GREEN in color
(integer 0 255)
:green
Represents a styleset appliable for the text
Defines whether text should be bold
boolean
:bold
This slot is read-only.
Defines whether text should be faint
boolean
:faint
This slot is read-only.
Defines whether text should be italic
boolean
:italic
This slot is read-only.
Defines whether text should be underlined
boolean
:underline
This slot is read-only.
Defines whether text should blink
boolean
:blink
This slot is read-only.
Defines whether text should have inverted foreground/background
boolean
:invert
This slot is read-only.
Defines whether text should be overlined
boolean
:overline
This slot is read-only.
Defines a foreground color for the text
(or chlorophyll::color null)
:foreground
This slot is read-only.
Defines a background color for the text
(or chlorophyll::color null)
:background
This slot is read-only.
Base class representing terminal type, not to be used directly
Representing 8 bit color terminal
| Jump to: | (
A B C D E F G I M N O R S T U |
|---|
| Jump to: | (
A B C D E F G I M N O R S T U |
|---|
| Jump to: | *
+
B C F G I O R S T U |
|---|
| Jump to: | *
+
B C F G I O R S T U |
|---|
| Jump to: | A B C D F M N P R S T |
|---|
| Jump to: | A B C D F M N P R S T |
|---|