The prettier-builtins Reference Manual

This is the prettier-builtins Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:34:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 prettier-builtins

A lightweight library to pretty print builtin arrays and hash-tables.

Author

<>

License

MIT

Dependencies
  • alexandria (system).
  • uiop (system).
Source

prettier-builtins.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 prettier-builtins/prettier-builtins.asd

Source

prettier-builtins.asd.

Parent Component

prettier-builtins (system).

ASDF Systems

prettier-builtins.


3.1.2 prettier-builtins/package.lisp

Source

prettier-builtins.asd.

Parent Component

prettier-builtins (system).

Packages

prettier-builtins.

Public Interface
Internals

3.1.3 prettier-builtins/array.lisp

Source

prettier-builtins.asd.

Parent Component

prettier-builtins (system).

Internals

3.1.4 prettier-builtins/hash-table.lisp

Source

prettier-builtins.asd.

Parent Component

prettier-builtins (system).

Public Interface
Internals

pretty-print-hash-table (function).


4 Packages

Packages are listed by definition order.


4.1 prettier-builtins

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *hash-table-print-spec*

Should be a list of 3 elements indicating:
the tab-size used before and after the separator
the separator between the key and value as a string
the minimum offset column after which to place the separator

Package

prettier-builtins.

Source

hash-table.lisp.

Special Variable: *print-hash-table*

When NIL, pretty-printing does not print the elements of the hash-table.

Package

prettier-builtins.

Source

hash-table.lisp.


5.1.2 Ordinary functions

Function: prettify (&rest types)
Package

prettier-builtins.

Source

package.lisp.

Function: unprettify (&rest types)
Package

prettier-builtins.

Source

package.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *array-element-print-format*

The format control string used to print the elements of DENSE-ARRAYS:ARRAY.

It is possible to set this value to "~/USER-DEFINED-FUNCTION/" where USER-DEFINED-FUNCTION should accept at least four arguments.

Also see:
- https://en.wikipedia.org/wiki/Format_(Common_Lisp)
- http://www.gigamonkeys.com/book/a-few-format-recipes.html

Package

prettier-builtins.

Source

array.lisp.

Special Variable: *pprint-table*
Package

prettier-builtins.

Source

package.lisp.

Special Variable: *pretty-types-alist*
Package

prettier-builtins.

Source

package.lisp.


5.2.2 Ordinary functions

Function: array-storage (array)
Package

prettier-builtins.

Source

array.lisp.

Function: array-stride (array axis)
Package

prettier-builtins.

Source

array.lisp.

Function: pretty-print-array (stream array)
Package

prettier-builtins.

Source

array.lisp.

Function: pretty-print-hash-table (stream hash-table)
Package

prettier-builtins.

Source

hash-table.lisp.

Function: pretty-print-number (stream arg colon-modifier-p at-modifier-p)
Package

prettier-builtins.

Source

array.lisp.


Appendix A Indexes


A.1 Concepts