Home

Awesome

cl-ansi-term

License GPL 3

<!-- [![Build Status](https://travis-ci.org/mrkkrp/cl-ansi-term.svg?branch=master)](https://travis-ci.org/mrkkrp/cl-ansi-term) -->

Quicklisp

cl-ansi-term allows to print various primitives on ANSI-compliant terminals. It also supports coloration and effects. cl-ansi-term is not something like ncurses, because it works with primitives that you can output in your terminal, as well as redirect to a file. In other words, it's more about good ol' textual interface than emulation of GUI in terminal. An example of user interface created with cl-ansi-term is here.

cl-ansi-term uses the concept of style sheet to manage coloration of output. Define styles, give them names, specify foreground colors, background colors, and effects for every style.

The library is capable of detecting whether the output goes to a terminal or a file. If the latter case takes place, no escape sequences will be outputted. It's also possible to disable all effects and coloration.

cl-ansi-term can print the following things:

Print tables:

+---------+---------+---------+
|A        |1        |1        |
+---------+---------+---------+
|B        |2        |2        |
+---------+---------+---------+
|C        |3        |3        |
+---------+---------+---------+

Hooks are applied before and after each printing primitive, see our documentation.

and

Installation

Via Quicklisp (recommended):

(ql:quickload "cl-ansi-term")

Then you can use the term global nickname.

cl-ansi-term depends on:

Documentation

See the doc directory. The documentation is also available online:

https://vindarel.github.io/cl-ansi-term

Quick snippets:

Print ordered and unordered lists: o-list, u-list

(term:o-list '((:one one-a (:one-b :one-b-1 :one-b-2)) :two))
1. ONE
   1. ONE-A
   2. ONE-B
      1. ONE-B-1
      2. ONE-B-2
2. TWO

(term:u-list '((:one one-a (:one-b :one-b-1 :one-b-2)) :two)
              :bullet \"+-\")
+ ONE
  - ONE-A
  - ONE-B
    + ONE-B-1
    + ONE-B-2
+ TWO

Print tables: table and vtable

table and vtable accept:

The KEYS and EXCLUDE arguments allow to filter in or filter out the rows to display.

;; The first list, headers, as the first row:
(term:table (list '("name" "age")
                  '("me" "7")))
+---------+---------+
|name     |age      |
+---------+---------+
|me       |7        |
+---------+---------+

;; Headers as the first column:
(term:vtable (list '("name" "age")
                         '("me" "7")))
+---------+---------+
|name     |me       |
+---------+---------+
|age      |7        |
+---------+---------+

Print lists of hash-tables or lists of plists:

(defparameter *my-plist* '(:a 1 :b 2 :c 3))
(table (list *my-plist* *my-plist*) :plist t)
+---------+---------+---------+
|A        |B        |C        |
+---------+---------+---------+
|1        |2        |3        |
+---------+---------+---------+
|1        |2        |3        |
+---------+---------+---------+

(vtable (list *my-plist* *my-plist*) :plist t)
+---------+---------+---------+
|A        |1        |1        |
+---------+---------+---------+
|B        |2        |2        |
+---------+---------+---------+
|C        |3        |3        |
+---------+---------+---------+

See also hts-table, hts-vtable, plists-table and plists-table.

You can choose a set of keys (headers) or exclude some of them:

(those can be a single element)

(table (list plist plist) :plist t :exclude :c)
=>
+---------+---------+
|A        |B        |
+---------+---------+
|1        |2        |
+---------+---------+
|1        |2        |
+---------+---------+

No borders

Feel free and ignore borders with :border-style nil:

A   B
1   2
1   2

Adapting the columns' widths

The table function adapts to the viewport.

It respects the terminal's width (*TERMINAL-WIDTH*).

If one or more columns take too much width (see *LONG-COLUMN-WIDTH*), they are truncated and their cells content will be shortened with the unicode "…".

(term:table '(("name" "age" "email")
              ("me" 7 "some@blah")
              ("this name is also very very very very long and too long" 7 "some@with-some-very-very-very-very-very-longer.email")))

+-------------------------------------+---+-------------------------------------+
|name                                 |age|email                                |
+-------------------------------------+---+-------------------------------------+
|me                                   |7  |some@blah                            |
+-------------------------------------+---+-------------------------------------+
|this name is also very very very ver…|7  |some@with-some-very-very-very-very-v…|
+-------------------------------------+---+-------------------------------------+

Each column can have the same width or a different one. :column-width can be a number or a list of numbers:

(term:table '(("name" "age" "email")
              ("me" 7 "some@blah")
              ("me" 7 "some@with-some-longer.email"))
             :column-width '(10 4 20))
+---------+---+-------------------+
|name     |age|email              |
+---------+---+-------------------+
|me       |7  |some@blah          |
+---------+---+-------------------+
|me       |7  |some@with-some-lon…|
+---------+---+-------------------+

Also set :max-column-width (defaults to 80) to change the maximum width of any column.

Print horizontal lines: hr

(term:hr :filler "=")
================================================================================

(term:cat-print '(:abc :def :ghi) :align :center)
                                   ABCDEFGHI

Print vertical space: vspace

Use vspace, arguments:

Print a title in a banner: banner, banner-fmt

Print a title in between 2 horizontal lines, with vertical space before and after.

(banner "My title" :space 1)

--------------------------------------------------------------------------------
     My title
--------------------------------------------------------------------------------

banner-fmt accepts TITLE with FORMAT control strings and calls FORMAT on it with ARGS.

     (banner-fmt \"file ~a\" \"test.csv\")

title is a banner with no borders.

Print text centered, with margin, with stylesheets: cat-print and print-styled

Print text with CAT-PRINT, but apply CONTROL-STRING with the arguments from ARGS, where each tilde character of CONTROL-STRING is replaced with an argument.

A special syntax can be used to apply styles.

Example:

(term:print-styled "~ and ~" :args '("foo" "bar") :align :center)

is equivalent to

(term:cat-print "foo and bar" :align :center)

Any region of text in CONTROL-STRING can be printed in a specified style following this pattern:

[text](:name-of-style)

where :name-of-style is a downcase keyword in the style sheet.

The style of the rest of the output defaults to BASE-STYLE.

ALIGN can be :LEFT (default), :CENTER, and :RIGHT.

MARGIN is the length of the left margin.

FILL-COLUMN sets the column width:

(term:print "~ and ~" :args '("foo" "bar") :align :center :fill-column 10)
                                    foo and
                                      bar

Output goes to STREAM."

Print a progress bar

(term:progress-bar "test" 82)
test   ##################################################################################

On an interactive terminal, next calls erase the progress bar to print it again and have an effect of… progress.

The progress bar respects styles with BAR-STYLE, LABEL-STYLE and NUM-STYLE.

See also progressons.

Stylesheets and colorized text

Start by defining your stylesheet.

(term:update-style-sheet
 '((:header :cyan   :underline)
   (:mark   :red    :reverse)
   (:term   :yellow :bold)))

:header, :mark and :term are your own vocabulary. Anytime you use functions that accept a style, reference them.

Example:

(term:table (list '(:name :age) '(:me 7)) :header-style :header)

To see colors in a "dumb" terminal like in Emacs Slime, install the package slime-repl-ansi-color, "require" it and enable it ith M-x slime-repl-ansi-color-mode.

You can also disable styles in non-interactive terminals with term::*enable-effects-on-dumb-terminals*.

Please see our online documentation.

Style individual table cells programmatically

The CELL-STYLE argument can be either a keyword, denoting a style in use, either a lambda function, that can compute a style for a given cell.

This feature is experimental. It only works for regular a table (not vtable).

The function takes two arguments: the cell value, the header, and a key :default argument.

Example:

Below we print in red prices that are superior to 10, we print in cyan the other prices, and we print in green the other cells.

(update-style-sheet
'((:color :cyan   :bold)
    (:danger :red :bold)
    (:green :green)
    (:default :green)
    ))

(setf *default-cell-style* :green)

(defparameter objects '(("pk" "title" "price")
                          (1 "lisp" 9.90)
                          (2 "common lisp" 100)
                          ))

(table objects
        :cell-style (lambda (val header)
                      (when (equal "price" header)
                        (if (> val 10)
                            :danger
                            :color))))

Print tables to string

See term:with-table-output-to-string.

Docstrings

table

Print a table filling cells with OBJECTS.

  OBJECTS can be:

  - a list of lists of string designators with equal lengths
.   - generally, the first list is a list of headers.
  - a list of hash-tables
    - the table displays the first hash-table keys and all the hash-tables values.
    - see also HTS-TABLE
  - a list of property-lists
    - the table prints the keys and all the plists' values
    - to help the TABLE understand the arguments are plists
      and not regular lists, set the PLIST key argument to T
      or the variable *prefer-plists-in-tables* to T.
    - see also PLISTS-TABLE
  - a single hash-table
  - a single plist.

  KEYS is a list of keys to display. The associated rows or columns will be displayed.
    With list of regular lists, the default headers are considered to be in the first list.

  EXCLUDE is a list of keys to NOT display.
Example:

   (table '((:A :B :C) (1 2 3)))

=>

    +---------+---------+---------+
    |A        |B        |C        |
    +---------+---------+---------+
    |1        |2        |3        |
    +---------+---------+---------+
    |10       |20       |30       |
    +---------+---------+---------+


See VTABLE to print the table vertically.

If BORDER-STYLE is NIL, no border will be
printed, otherwise BORDER-STYLE is expected to be a keyword that denotes
the style in which borders of the table should be printed.

HEADER-STYLE will be
applied to the first row of the table (also to the first column if
COL-HEADER is not NIL) and CELL-STYLE will be applied to all other rows. If
CELL-STYLE is a list, its elements will be used to differently render every
column.

Objects that end with MARK-SUFFIX will be printed using MARK-STYLE.

COLUMN-WIDTH is 10 by default. It can be an integer that applies to
all columns, or a list designator to set a different
width for every column. A cell content is truncated to fit the width. See `str:*ellipsis*'
for the ellusion string, `(…)' by default.

ALIGN controls the alignmet inside a cell. It can take the values :LEFT (default value), :CENTER, and :RIGHT.

MARGIN, an integer, is the left margin of the whole table.

Output goes to STREAM.

See also

Blog posts:

Lisp?!

I have done some preliminary Common Lisp exploration prior to this course but had a lot of questions regarding practical use and development workflows. This course was amazing for this! I learned a lot of useful techniques for actually writing the code in Emacs, as well as conversational explanations of concepts that had previously confused me in text-heavy resources. Please keep up the good work and continue with this line of topics, it is well worth the price!

Preston

License

Copyright © 2015–2018 Mark Karpov Copyright © 2018–2024 Vindarel

Distributed under GNU GPL, version 3.