text-table

8.2

top ← prev up next →

text-table

Laurent Orseau

(require text-table)

package: text-table

A simple package to display utf-8 textual tables.

To install:

raco pkg install text-table

See the example in the main submodule of the "main.rkt" file. You can observe the results by running:

racket -l text-table

Examples:

; Minimalistic example:
> (print-table
   '((a b c d e f gggg h)
     (123 456 77 54 1  5646547987 41 1)
     (111 22 3333 44 5 6 7 8888)))
┌───┬───┬────┬──┬─┬──────────┬────┬────┐
│a  │b  │c   │d │e│f         │gggg│h   │
├───┼───┼────┼──┼─┼──────────┼────┼────┤
│123│456│77  │54│1│5646547987│41  │1   │
├───┼───┼────┼──┼─┼──────────┼────┼────┤
│111│22 │3333│44│5│6         │7   │8888│
└───┴───┴────┴──┴─┴──────────┴────┴────┘
; With more bells and whistles
> (print-table
   '((a b c d e f gggg h)
     (123 456 77 54 1  5646547987 41 1)
     (111 22 3333 44 5 6 7 8888))
   #:border-style 'double
   #:framed? #f
   #:row-sep? #t
   #:align '(left center center center center center center right))
a  ║ b ║ c  ║d ║e║    f     ║gggg║   h
═══╬═══╬════╬══╬═╬══════════╬════╬════
123║456║ 77 ║54║1║5646547987║ 41 ║   1
═══╬═══╬════╬══╬═╬══════════╬════╬════
111║22 ║3333║44║5║    6     ║ 7  ║8888
; Custom border style
> (print-table '((abc abc abc)
                 (abcdef ab abcdef)
                 (a abcdef abc))
               #:border-style
               '(#\x ; row sep
                 ("A" "B" "C") ; col seps
                 ("D" "E" "F") ; first-row corners
                 ("G" "H" "I") ; mid-row corners
                 ("J" "K" "L")) ; last-row corners
               #:framed? #t
               #:row-sep? #t)
DxxxxxxExxxxxxExxxxxxF
Aabc   Babc   Babc   C
GxxxxxxHxxxxxxHxxxxxxI
AabcdefBab    BabcdefC
GxxxxxxHxxxxxxHxxxxxxI
Aa     BabcdefBabc   C
JxxxxxxKxxxxxxKxxxxxxL

procedure
(table->string table
[ #:->string to-string
#:border-style border-style
#:framed? framed?
#:row-sep? row-sep?
#:align align]) → string?
  table : (listof list?)
  to-string : procedure? = ~a
  border-style : border-style/c = 'single
  framed? : boolean? = #t
  row-sep? : boolean? = #t
   align :
(or/c (listof (or/c 'left 'center 'right))
      (or/c 'left 'center 'right))
= 'left

Accepts a table specified as a list of lists, and returns a string representing the table. The lists must all be of the same length.

The to-string procedure is used to convert cell values to strings.

The border-style specifies the style of lines to be used in drawing the table.

When framed? is #true, a frame is drawn around the outside of the table.

When row-sep? is false, no separators are drawn between the rows.

The align specification indicates how the contents of the cells are to be aligned within their cells. A single-symbol specification applies to all cells, or a list of symbols of the same length as the rows can be applied in order to specify the alignment of each column independently. When align is a list, it is trimmed to the length of the columns if it is too long, or the last element of the list is used for the remaining columns if it is too short.

procedure
(simple-table->string table
[ #:->string to-string]
#:border-style border-style/c
[ #:framed? framed?
#:row-sep? row-sep?
#:align align]) → string?
  table : (listof list?)
  to-string : procedure? = ~a
  border-style/c : 'space
  framed? : boolean? = #f
  row-sep? : boolean? = #f
   align :
(or/c (listof (or/c 'left 'center 'right))
      (or/c 'left 'center 'right))
= 'left

Like table->string, but prints the table instead of returning it and uses default arguments for a minimalistic table.

Example:

> (displayln
   (simple-table->string
    #:align '(left right)
    '((a b c d e f gggg h)
      (123 456 77 54 1  5646547987 41 1)
      (111 22 3333 44 5 6 7 8888))))
a     b    c  d e          f gggg    h
123 456   77 54 1 5646547987   41    1
111  22 3333 44 5          6    7 8888

syntax
(print-table args ...)

Shorthand form for (displayln (table->string args ...)). Takes the same arguments as table->string.

syntax
(print-simple-table args ...)

Shorthand form for (displayln (simple-table->string args ...)). Takes the same arguments as simple-table->string.

value
border-style/c : contract?
=
(or/c
latex space space-single single rounded double
(list/c char? ; row sep
    '(#\x
         (list/c string? string? string?) ; col seps
         (list/c string? string? string?) ; first-row corners
         (list/c string? string? string?) ; mid-row corners
         (list/c string? string? string?))) ; last-row corners)

Border style contract. The list element is for custom border styles. See the example at the top of this document.

top ← prev up next →