The cl-indentify Reference Manual

This is the cl-indentify Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:06:50 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-indentify

A code beautifier for Common Lisp.

Author

Tarn W. Burton

License

MIT

Version

0.1

Dependencies
  • alexandria (system).
  • uiop (system).
  • trivial-gray-streams (system).
Source

cl-indentify.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-indentify/src

Source

cl-indentify.asd.

Parent Component

cl-indentify (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-indentify/cl-indentify.asd

Source

cl-indentify.asd.

Parent Component

cl-indentify (system).

ASDF Systems

cl-indentify.


4.1.2 cl-indentify/src/package.lisp

Source

cl-indentify.asd.

Parent Component

src (module).

Packages

indentify.


4.1.3 cl-indentify/src/verbatim-stream.lisp

Dependency

package.lisp (file).

Source

cl-indentify.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 cl-indentify/src/defaults.lisp

Dependency

verbatim-stream.lisp (file).

Source

cl-indentify.asd.

Parent Component

src (module).

Internals

4.1.5 cl-indentify/src/indenter.lisp

Dependency

defaults.lisp (file).

Source

cl-indentify.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 indentify

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *indent-templates*
Package

indentify.

Source

indenter.lisp.


6.1.2 Ordinary functions

Function: indent-template (name)
Package

indentify.

Source

indenter.lisp.

Function: indentify (&optional input-stream output-stream)
Package

indentify.

Source

indenter.lisp.

Function: initialize-templates ()
Package

indentify.

Source

indenter.lisp.

Function: load-default-templates ()
Package

indentify.

Source

indenter.lisp.

Function: load-template-file (path)
Package

indentify.

Source

indenter.lisp.

Function: load-templates (&rest template-groups)
Package

indentify.

Source

indenter.lisp.

Function: load-user-templates ()
Package

indentify.

Source

indenter.lisp.


6.1.3 Generic functions

Generic Function: (setf indent-template) (name)
Package

indentify.

Source

indenter.lisp.

Methods
Method: (setf indent-template) ((sym symbol))
Method: (setf indent-template) ((name string))

6.1.4 Standalone methods

Method: stream-finish-output ((stream verbatim-stream))
Package

sb-gray.

Source

verbatim-stream.lisp.

Method: stream-line-column ((stream verbatim-stream))
Package

sb-gray.

Source

verbatim-stream.lisp.

Method: stream-listen ((stream verbatim-stream))
Package

sb-gray.

Source

verbatim-stream.lisp.

Method: stream-peek-char ((stream verbatim-stream))
Package

sb-gray.

Source

verbatim-stream.lisp.

Method: stream-read-char ((stream verbatim-stream))
Package

sb-gray.

Source

verbatim-stream.lisp.

Method: stream-unread-char ((stream verbatim-stream) char)
Package

sb-gray.

Source

verbatim-stream.lisp.

Method: stream-write-char ((stream verbatim-stream) char)
Package

sb-gray.

Source

verbatim-stream.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: +alexandria-templates+
Package

indentify.

Source

defaults.lisp.

Special Variable: +asdf-templates+
Package

indentify.

Source

defaults.lisp.

Special Variable: +common-lisp-templates+
Package

indentify.

Source

defaults.lisp.

Special Variable: +uiop-templates+
Package

indentify.

Source

defaults.lisp.


6.2.2 Macros

Macro: increment-column (column char)
Package

indentify.

Source

verbatim-stream.lisp.

Macro: with-verbatim (stream &body body)
Package

indentify.

Source

verbatim-stream.lisp.


6.2.3 Ordinary functions

Function: align-with-spaces (stream)
Package

indentify.

Source

verbatim-stream.lisp.

Function: normalize-template (template)
Package

indentify.

Source

indenter.lisp.

Function: number-token-p (token)
Package

indentify.

Source

indenter.lisp.

Function: scan-chunk (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-form (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-forms (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-indent (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-line-comment (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-sharpsign (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-sharpsign-asterisk (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-sharpsign-backslash (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-sharpsign-rational (digits stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-sharpsign-vertical-bar (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-string (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: scan-token (stream &optional template)
Package

indentify.

Source

indenter.lisp.

Function: select-subtemplate (pos templates)
Package

indentify.

Source

indenter.lisp.

Function: select-template (template completed-form-count)
Package

indentify.

Source

indenter.lisp.

Function: symbol-char-p (char)
Package

indentify.

Source

indenter.lisp.

Function: symbol-names (sym)
Package

indentify.

Source

indenter.lisp.

Function: write-symbol-to-string (package-name symbol-name &key exported)
Package

indentify.

Source

indenter.lisp.


6.2.4 Generic functions

Generic Reader: input-column (object)
Package

indentify.

Methods
Reader Method: input-column ((verbatim-stream verbatim-stream))

automatically generated reader method

Source

verbatim-stream.lisp.

Target Slot

input-column.

Generic Writer: (setf input-column) (object)
Package

indentify.

Methods
Writer Method: (setf input-column) ((verbatim-stream verbatim-stream))

automatically generated writer method

Source

verbatim-stream.lisp.

Target Slot

input-column.

Generic Reader: input-stream (object)
Package

indentify.

Methods
Reader Method: input-stream ((verbatim-stream verbatim-stream))

automatically generated reader method

Source

verbatim-stream.lisp.

Target Slot

input-stream.

Generic Writer: (setf input-stream) (object)
Package

indentify.

Methods
Writer Method: (setf input-stream) ((verbatim-stream verbatim-stream))

automatically generated writer method

Source

verbatim-stream.lisp.

Target Slot

input-stream.

Generic Reader: output-column (object)
Package

indentify.

Methods
Reader Method: output-column ((verbatim-stream verbatim-stream))

automatically generated reader method

Source

verbatim-stream.lisp.

Target Slot

output-column.

Generic Writer: (setf output-column) (object)
Package

indentify.

Methods
Writer Method: (setf output-column) ((verbatim-stream verbatim-stream))

automatically generated writer method

Source

verbatim-stream.lisp.

Target Slot

output-column.

Generic Reader: output-stream (object)
Package

indentify.

Methods
Reader Method: output-stream ((verbatim-stream verbatim-stream))

automatically generated reader method

Source

verbatim-stream.lisp.

Target Slot

output-stream.

Generic Writer: (setf output-stream) (object)
Package

indentify.

Methods
Writer Method: (setf output-stream) ((verbatim-stream verbatim-stream))

automatically generated writer method

Source

verbatim-stream.lisp.

Target Slot

output-stream.

Generic Reader: verbatim (object)
Package

indentify.

Methods
Reader Method: verbatim ((verbatim-stream verbatim-stream))

automatically generated reader method

Source

verbatim-stream.lisp.

Target Slot

verbatim.

Generic Writer: (setf verbatim) (object)
Package

indentify.

Methods
Writer Method: (setf verbatim) ((verbatim-stream verbatim-stream))

automatically generated writer method

Source

verbatim-stream.lisp.

Target Slot

verbatim.


6.2.5 Classes

Class: verbatim-stream
Package

indentify.

Source

verbatim-stream.lisp.

Direct superclasses
  • fundamental-character-input-stream.
  • fundamental-character-output-stream.
Direct methods
Direct slots
Slot: input-stream
Initargs

:input-stream

Readers

input-stream.

Writers

(setf input-stream).

Slot: output-stream
Initargs

:output-stream

Readers

output-stream.

Writers

(setf output-stream).

Slot: input-column
Initform

0

Initargs

:input-column

Readers

input-column.

Writers

(setf input-column).

Slot: output-column
Initform

0

Initargs

:output-column

Readers

output-column.

Writers

(setf output-column).

Slot: verbatim
Initargs

:verbatim

Readers

verbatim.

Writers

(setf verbatim).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   F   G   I   L   M   N   O   S   V   W  
Index Entry  Section

(
(setf indent-template): Public generic functions
(setf indent-template): Public generic functions
(setf indent-template): Public generic functions
(setf input-column): Private generic functions
(setf input-column): Private generic functions
(setf input-stream): Private generic functions
(setf input-stream): Private generic functions
(setf output-column): Private generic functions
(setf output-column): Private generic functions
(setf output-stream): Private generic functions
(setf output-stream): Private generic functions
(setf verbatim): Private generic functions
(setf verbatim): Private generic functions

A
align-with-spaces: Private ordinary functions

F
Function, align-with-spaces: Private ordinary functions
Function, indent-template: Public ordinary functions
Function, indentify: Public ordinary functions
Function, initialize-templates: Public ordinary functions
Function, load-default-templates: Public ordinary functions
Function, load-template-file: Public ordinary functions
Function, load-templates: Public ordinary functions
Function, load-user-templates: Public ordinary functions
Function, normalize-template: Private ordinary functions
Function, number-token-p: Private ordinary functions
Function, scan-chunk: Private ordinary functions
Function, scan-form: Private ordinary functions
Function, scan-forms: Private ordinary functions
Function, scan-indent: Private ordinary functions
Function, scan-line-comment: Private ordinary functions
Function, scan-sharpsign: Private ordinary functions
Function, scan-sharpsign-asterisk: Private ordinary functions
Function, scan-sharpsign-backslash: Private ordinary functions
Function, scan-sharpsign-rational: Private ordinary functions
Function, scan-sharpsign-vertical-bar: Private ordinary functions
Function, scan-string: Private ordinary functions
Function, scan-token: Private ordinary functions
Function, select-subtemplate: Private ordinary functions
Function, select-template: Private ordinary functions
Function, symbol-char-p: Private ordinary functions
Function, symbol-names: Private ordinary functions
Function, write-symbol-to-string: Private ordinary functions

G
Generic Function, (setf indent-template): Public generic functions
Generic Function, (setf input-column): Private generic functions
Generic Function, (setf input-stream): Private generic functions
Generic Function, (setf output-column): Private generic functions
Generic Function, (setf output-stream): Private generic functions
Generic Function, (setf verbatim): Private generic functions
Generic Function, input-column: Private generic functions
Generic Function, input-stream: Private generic functions
Generic Function, output-column: Private generic functions
Generic Function, output-stream: Private generic functions
Generic Function, verbatim: Private generic functions

I
increment-column: Private macros
indent-template: Public ordinary functions
indentify: Public ordinary functions
initialize-templates: Public ordinary functions
input-column: Private generic functions
input-column: Private generic functions
input-stream: Private generic functions
input-stream: Private generic functions

L
load-default-templates: Public ordinary functions
load-template-file: Public ordinary functions
load-templates: Public ordinary functions
load-user-templates: Public ordinary functions

M
Macro, increment-column: Private macros
Macro, with-verbatim: Private macros
Method, (setf indent-template): Public generic functions
Method, (setf indent-template): Public generic functions
Method, (setf input-column): Private generic functions
Method, (setf input-stream): Private generic functions
Method, (setf output-column): Private generic functions
Method, (setf output-stream): Private generic functions
Method, (setf verbatim): Private generic functions
Method, input-column: Private generic functions
Method, input-stream: Private generic functions
Method, output-column: Private generic functions
Method, output-stream: Private generic functions
Method, stream-finish-output: Public standalone methods
Method, stream-line-column: Public standalone methods
Method, stream-listen: Public standalone methods
Method, stream-peek-char: Public standalone methods
Method, stream-read-char: Public standalone methods
Method, stream-unread-char: Public standalone methods
Method, stream-write-char: Public standalone methods
Method, verbatim: Private generic functions

N
normalize-template: Private ordinary functions
number-token-p: Private ordinary functions

O
output-column: Private generic functions
output-column: Private generic functions
output-stream: Private generic functions
output-stream: Private generic functions

S
scan-chunk: Private ordinary functions
scan-form: Private ordinary functions
scan-forms: Private ordinary functions
scan-indent: Private ordinary functions
scan-line-comment: Private ordinary functions
scan-sharpsign: Private ordinary functions
scan-sharpsign-asterisk: Private ordinary functions
scan-sharpsign-backslash: Private ordinary functions
scan-sharpsign-rational: Private ordinary functions
scan-sharpsign-vertical-bar: Private ordinary functions
scan-string: Private ordinary functions
scan-token: Private ordinary functions
select-subtemplate: Private ordinary functions
select-template: Private ordinary functions
stream-finish-output: Public standalone methods
stream-line-column: Public standalone methods
stream-listen: Public standalone methods
stream-peek-char: Public standalone methods
stream-read-char: Public standalone methods
stream-unread-char: Public standalone methods
stream-write-char: Public standalone methods
symbol-char-p: Private ordinary functions
symbol-names: Private ordinary functions

V
verbatim: Private generic functions
verbatim: Private generic functions

W
with-verbatim: Private macros
write-symbol-to-string: Private ordinary functions