The cl-ascii-table Reference Manual

This is the cl-ascii-table Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:30:52 2022 GMT+0.

1 Introduction

cl-ascii-table

Common Lisp library to present tabular data in ascii-art table.

Installation

Clone into a directory visible to quicklisp

git clone https://github.com/telephil/cl-ascii-table

Load the library

(ql:quickload "cl-ascii-table")

API

function
make-table columns &key header => ascii-table

Create a new table

columns a list of strings
header title to display above the table if not nil

method
add-row (table ascii-table) columns

Add a row of values to table

columns a list of values. The list length should be equal to the length of the columns list passed in make-table

method
add-separator (table ascii-table)

Add a separating line in the table

method
display-table (table ascii-table) &optional out

Display the table to out.

out an open stream. Defaults to *standard-output*

Sample

(let ((table (ascii-table:make-table '("Id" "Name" "Amount") :header "Infos")))
  (ascii-table:add-row table '(1 "Bob" 150))
  (ascii-table:add-row table '(2 "Joe" 200))
  (ascii-table:add-separator table)
  (ascii-table:add-row table '("" "Total" 350))
  (ascii-table:display table))

; => outputs
.---------------------.  
|        Infos        |
+----+-------+--------+  
| ID | Name  | Amount |  
+----+-------+--------+  
|  1 | Bob   |    150 |  
|  2 | Joe   |    200 |  
+----+-------+--------+  
|    | TOTAL |    350 |  
+----+-------+--------+

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2 Systems

The main system appears first, followed by any subsystem dependency.

cl-ascii-table

2.1 `cl-ascii-table`

Common Lisp library to present tabular data in ascii-art table.

Author

Philippe MECHAI <philippe.mechai@gmail.com>

Home Page

https://github.com/telephil/cl-ascii-table/

Source Control

(GIT git@github.com:telephil/cl-ascii-table.git)

Bug Tracker

https://github.com/telephil/cl-ascii-table/issues

License

MIT

Source

cl-ascii-table.asd.

Child Components

package.lisp (file).
cl-ascii-table.lisp (file).

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

3.1.1 `cl-ascii-table/cl-ascii-table.asd`

Source: cl-ascii-table.asd.
Parent Component: cl-ascii-table (system).
ASDF Systems: cl-ascii-table.

3.1.2 `cl-ascii-table/package.lisp`

Source: cl-ascii-table.asd.
Parent Component: cl-ascii-table (system).
Packages: ascii-table.

3.1.3 `cl-ascii-table/cl-ascii-table.lisp`

Dependency

package.lisp (file).

Source

cl-ascii-table.asd.

Parent Component

cl-ascii-table (system).

Public Interface

*default-value-formatter* (special variable).
add-row (generic function).
add-separator (generic function).
display (generic function).
make-table (function).
print-object (method).

Internals

ascii-table (class).
cols (reader method).
(setf cols) (writer method).
cols-count (reader method).
(setf cols-count) (writer method).
cols-formatters (reader method).
(setf cols-formatters) (writer method).
cols-widths (reader method).
(setf cols-widths) (writer method).
compute-col-width (function).
display-col (function).
display-header (function).
display-row (function).
display-separator (function).
header (reader method).
rows (reader method).
(setf rows) (writer method).
string-pad (function).
string-pad-right (function).
test (function).

4 Packages

Packages are listed by definition order.

ascii-table

4.1 `ascii-table`

Source

package.lisp.

Nickname

table

Use List

common-lisp.

Public Interface

*default-value-formatter* (special variable).
add-row (generic function).
add-separator (generic function).
display (generic function).
make-table (function).

Internals

ascii-table (class).
cols (generic reader).
(setf cols) (generic writer).
cols-count (generic reader).
(setf cols-count) (generic writer).
cols-formatters (generic reader).
(setf cols-formatters) (generic writer).
cols-widths (generic reader).
(setf cols-widths) (generic writer).
compute-col-width (function).
display-col (function).
display-header (function).
display-row (function).
display-separator (function).
header (generic reader).
rows (generic reader).
(setf rows) (generic writer).
string-pad (function).
string-pad-right (function).
test (function).

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

5.1 Public Interface

Special variables
Ordinary functions
Generic functions
Standalone methods

5.1.1 Special variables

Special Variable: *default-value-formatter* ¶

Package: ascii-table.
Source: cl-ascii-table.lisp.

5.1.2 Ordinary functions

Function: make-table (columns &key header formatters) ¶

Package: ascii-table.
Source: cl-ascii-table.lisp.

5.1.3 Generic functions

Generic Function: add-row (ascii-table columns) ¶

Package

	Index Entry	Section

(
	`(setf cols)`:	Private generic functions
	`(setf cols)`:	Private generic functions
	`(setf cols-count)`:	Private generic functions
	`(setf cols-count)`:	Private generic functions
	`(setf cols-formatters)`:	Private generic functions
	`(setf cols-formatters)`:	Private generic functions
	`(setf cols-widths)`:	Private generic functions
	`(setf cols-widths)`:	Private generic functions
	`(setf rows)`:	Private generic functions
	`(setf rows)`:	Private generic functions

A
	`add-row`:	Public generic functions
	`add-row`:	Public generic functions
	`add-separator`:	Public generic functions
	`add-separator`:	Public generic functions

C
	`cols`:	Private generic functions
	`cols`:	Private generic functions
	`cols-count`:	Private generic functions
	`cols-count`:	Private generic functions
	`cols-formatters`:	Private generic functions
	`cols-formatters`:	Private generic functions
	`cols-widths`:	Private generic functions
	`cols-widths`:	Private generic functions
	`compute-col-width`:	Private ordinary functions

D
	`display`:	Public generic functions
	`display`:	Public generic functions
	`display-col`:	Private ordinary functions
	`display-header`:	Private ordinary functions
	`display-row`:	Private ordinary functions
	`display-separator`:	Private ordinary functions

F
	`Function, compute-col-width`:	Private ordinary functions
	`Function, display-col`:	Private ordinary functions
	`Function, display-header`:	Private ordinary functions
	`Function, display-row`:	Private ordinary functions
	`Function, display-separator`:	Private ordinary functions
	`Function, make-table`:	Public ordinary functions
	`Function, string-pad`:	Private ordinary functions
	`Function, string-pad-right`:	Private ordinary functions
	`Function, test`:	Private ordinary functions

G
	`Generic Function, (setf cols)`:	Private generic functions
	`Generic Function, (setf cols-count)`:	Private generic functions
	`Generic Function, (setf cols-formatters)`:	Private generic functions
	`Generic Function, (setf cols-widths)`:	Private generic functions
	`Generic Function, (setf rows)`:	Private generic functions
	`Generic Function, add-row`:	Public generic functions
	`Generic Function, add-separator`:	Public generic functions
	`Generic Function, cols`:	Private generic functions
	`Generic Function, cols-count`:	Private generic functions
	`Generic Function, cols-formatters`:	Private generic functions
	`Generic Function, cols-widths`:	Private generic functions
	`Generic Function, display`:	Public generic functions
	`Generic Function, header`:	Private generic functions
	`Generic Function, rows`:	Private generic functions

H
	`header`:	Private generic functions
	`header`:	Private generic functions

M
	`make-table`:	Public ordinary functions
	`Method, (setf cols)`:	Private generic functions
	`Method, (setf cols-count)`:	Private generic functions
	`Method, (setf cols-formatters)`:	Private generic functions
	`Method, (setf cols-widths)`:	Private generic functions
	`Method, (setf rows)`:	Private generic functions
	`Method, add-row`:	Public generic functions
	`Method, add-separator`:	Public generic functions
	`Method, cols`:	Private generic functions
	`Method, cols-count`:	Private generic functions
	`Method, cols-formatters`:	Private generic functions
	`Method, cols-widths`:	Private generic functions
	`Method, display`:	Public generic functions
	`Method, header`:	Private generic functions
	`Method, print-object`:	Public standalone methods
	`Method, rows`:	Private generic functions

P
	`print-object`:	Public standalone methods

R
	`rows`:	Private generic functions
	`rows`:	Private generic functions

S
	`string-pad`:	Private ordinary functions
	`string-pad-right`:	Private ordinary functions

T
	`test`:	Private ordinary functions

	Index Entry	Section

*
	`default-value-formatter`:	Public special variables

C
	`cols`:	Private classes
	`cols-count`:	Private classes
	`cols-formatters`:	Private classes
	`cols-widths`:	Private classes

H
	`header`:	Private classes

R
	`rows`:	Private classes

S
	`Slot, cols`:	Private classes
	`Slot, cols-count`:	Private classes
	`Slot, cols-formatters`:	Private classes
	`Slot, cols-widths`:	Private classes
	`Slot, header`:	Private classes
	`Slot, rows`:	Private classes
	`Special Variable, default-value-formatter`:	Public special variables

	Index Entry	Section

A
	`ascii-table`:	The ascii-table package
	`ascii-table`:	Private classes

C
	`cl-ascii-table`:	The cl-ascii-table system
	`cl-ascii-table.asd`:	The cl-ascii-table/cl-ascii-table․asd file
	`cl-ascii-table.lisp`:	The cl-ascii-table/cl-ascii-table․lisp file
	`Class, ascii-table`:	Private classes

F
	`File, cl-ascii-table.asd`:	The cl-ascii-table/cl-ascii-table․asd file
	`File, cl-ascii-table.lisp`:	The cl-ascii-table/cl-ascii-table․lisp file
	`File, package.lisp`:	The cl-ascii-table/package․lisp file

P
	`Package, ascii-table`:	The ascii-table package
	`package.lisp`:	The cl-ascii-table/package․lisp file

S
	`System, cl-ascii-table`:	The cl-ascii-table system

The cl-ascii-table Reference Manual

The cl-ascii-table Reference Manual

Table of Contents

1 Introduction

cl-ascii-table

Installation

API

Sample

License

2 Systems

2.1 cl-ascii-table

3 Files

3.1 Lisp

3.1.1 cl-ascii-table/cl-ascii-table.asd

3.1.2 cl-ascii-table/package.lisp

3.1.3 cl-ascii-table/cl-ascii-table.lisp

4 Packages

4.1 ascii-table

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Standalone methods

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Generic functions

5.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-ascii-table`

3.1.1 `cl-ascii-table/cl-ascii-table.asd`

3.1.2 `cl-ascii-table/package.lisp`

3.1.3 `cl-ascii-table/cl-ascii-table.lisp`

4.1 `ascii-table`