The format-string-builder Reference Manual

This is the format-string-builder Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:26:48 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 format-string-builder

A DSL wrapping cl:format’s syntax with something more lispy.

Author

fiddlerwoaroof

License

MIT

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

format-string-builder.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 format-string-builder/format-string-builder.asd

Source

format-string-builder.asd.

Parent Component

format-string-builder (system).

ASDF Systems

format-string-builder.


3.1.2 format-string-builder/package.lisp

Source

format-string-builder.asd.

Parent Component

format-string-builder (system).

Packages

format-string-builder.


3.1.3 format-string-builder/format-string-builder.lisp

Dependency

package.lisp (file).

Source

format-string-builder.asd.

Parent Component

format-string-builder (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 format-string-builder

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 Macros

Macro: define-message (name (stream-arg &rest args) &body spec)

Define a function called NAME that takes a stream argument and a variable argument list that formats the arguments according to the spec passed as the body.

Package

format-string-builder.

Source

format-string-builder.lisp.

Macro: format* (stream format-spec &rest args)
Package

format-string-builder.

Source

format-string-builder.lisp.


5.1.2 Ordinary functions

Function: make-format-string (forms)
Package

format-string-builder.

Source

format-string-builder.lisp.


5.1.3 Standalone methods

Method: print-object ((obj compound-format-string-command) s)
Source

format-string-builder.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *format-string-registry*
Package

format-string-builder.

Source

format-string-builder.lisp.


5.2.2 Macros

Macro: define-compound-format-chars (&body specs)
Package

format-string-builder.

Source

format-string-builder.lisp.

Macro: define-format-chars (&body body)
Package

format-string-builder.

Source

format-string-builder.lisp.

Macro: define-simple-format-chars (&body specs)
Package

format-string-builder.

Source

format-string-builder.lisp.


5.2.3 Ordinary functions

Function: convert-modifier (modifier)
Package

format-string-builder.

Source

format-string-builder.lisp.

Function: define-compound-format-char (name start-char end-char &key at-p colon-p)
Package

format-string-builder.

Source

format-string-builder.lisp.

Function: define-sectioned-format-char (name start-char end-char &key at-p colon-p)
Package

format-string-builder.

Source

format-string-builder.lisp.

Function: define-simple-format-char (name format-char &key at-p colon-p)
Package

format-string-builder.

Source

format-string-builder.lisp.

Function: form-step (form)
Package

format-string-builder.

Source

format-string-builder.lisp.

Function: generate-function-defs ()
Package

format-string-builder.

Source

format-string-builder.lisp.


5.2.4 Generic functions

Generic Reader: at-p (object)
Package

format-string-builder.

Methods
Reader Method: at-p ((format-string-command format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

at-p.

Generic Writer: (setf at-p) (object)
Package

format-string-builder.

Methods
Writer Method: (setf at-p) ((format-string-command format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

at-p.

Generic Reader: colon-p (object)
Package

format-string-builder.

Methods
Reader Method: colon-p ((format-string-command format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

colon-p.

Generic Writer: (setf colon-p) (object)
Package

format-string-builder.

Methods
Writer Method: (setf colon-p) ((format-string-command format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

colon-p.

Generic Reader: contents (object)
Package

format-string-builder.

Methods
Reader Method: contents ((compound-format-string-command compound-format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

contents.

Generic Writer: (setf contents) (object)
Package

format-string-builder.

Methods
Writer Method: (setf contents) ((compound-format-string-command compound-format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

contents.

Generic Function: dispatch-command (command args)
Package

format-string-builder.

Source

format-string-builder.lisp.

Methods
Method: dispatch-command ((command simple-format-string-command) args)
Method: dispatch-command ((command compound-format-string-command) args)
Generic Reader: end-char (object)
Package

format-string-builder.

Methods
Reader Method: end-char ((compound-format-string-command compound-format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

end-char.

Generic Writer: (setf end-char) (object)
Package

format-string-builder.

Methods
Writer Method: (setf end-char) ((compound-format-string-command compound-format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

end-char.

Generic Reader: format-char (object)
Package

format-string-builder.

Methods
Reader Method: format-char ((simple-format-string-command simple-format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

format-char.

Generic Writer: (setf format-char) (object)
Package

format-string-builder.

Methods
Writer Method: (setf format-char) ((simple-format-string-command simple-format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

format-char.

Generic Reader: modifiers (object)
Package

format-string-builder.

Methods
Reader Method: modifiers ((compound-format-string-command compound-format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

modifiers.

Reader Method: modifiers ((simple-format-string-command simple-format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

modifiers.

Generic Writer: (setf modifiers) (object)
Package

format-string-builder.

Methods
Writer Method: (setf modifiers) ((compound-format-string-command compound-format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

modifiers.

Writer Method: (setf modifiers) ((simple-format-string-command simple-format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

modifiers.

Generic Function: print-format-modifiers (command stream)
Package

format-string-builder.

Source

format-string-builder.lisp.

Methods
Method: print-format-modifiers ((command format-string-command) s)
Generic Function: print-format-representation (command stream)

Prints the appropriate control sequence to the stream passed in The :before method will print the Tilde.

Package

format-string-builder.

Source

format-string-builder.lisp.

Methods
Method: print-format-representation ((command sectioned-format-string-command) s)
Method: print-format-representation :after ((command compound-format-string-command) s)
Method: print-format-representation ((command compound-format-string-command) s)
Method: print-format-representation :before ((command compound-format-string-command) s)
Method: print-format-representation ((command simple-format-string-command) s)
Method: print-format-representation :around ((command format-string-command) s)
Method: print-format-representation ((literal string) s)
Method: print-format-representation ((literal integer) s)
Method: print-format-representation ((literal character) s)
Method: print-format-representation ((commands list) s)
Generic Reader: start-char (object)
Package

format-string-builder.

Methods
Reader Method: start-char ((compound-format-string-command compound-format-string-command))

automatically generated reader method

Source

format-string-builder.lisp.

Target Slot

start-char.

Generic Writer: (setf start-char) (object)
Package

format-string-builder.

Methods
Writer Method: (setf start-char) ((compound-format-string-command compound-format-string-command))

automatically generated writer method

Source

format-string-builder.lisp.

Target Slot

start-char.


5.2.5 Classes

Class: compound-format-string-command
Package

format-string-builder.

Source

format-string-builder.lisp.

Direct superclasses

format-string-command.

Direct subclasses

sectioned-format-string-command.

Direct methods
Direct slots
Slot: start-char
Initargs

:start-char

Readers

start-char.

Writers

(setf start-char).

Slot: contents
Initargs

:contents

Readers

contents.

Writers

(setf contents).

Slot: end-char
Initargs

:end-char

Readers

end-char.

Writers

(setf end-char).

Slot: modifiers
Initargs

:modifiers

Readers

modifiers.

Writers

(setf modifiers).

Class: format-string-command
Package

format-string-builder.

Source

format-string-builder.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: at-p
Initargs

:at-p

Readers

at-p.

Writers

(setf at-p).

Slot: colon-p
Initargs

:colon-p

Readers

colon-p.

Writers

(setf colon-p).

Class: sectioned-format-string-command
Package

format-string-builder.

Source

format-string-builder.lisp.

Direct superclasses

compound-format-string-command.

Direct methods

print-format-representation.

Class: simple-format-string-command
Package

format-string-builder.

Source

format-string-builder.lisp.

Direct superclasses

format-string-command.

Direct methods
Direct slots
Slot: format-char
Initargs

:format-char

Readers

format-char.

Writers

(setf format-char).

Slot: modifiers
Initargs

:modifiers

Readers

modifiers.

Writers

(setf modifiers).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   M   P   S  
Index Entry  Section

(
(setf at-p): Private generic functions
(setf at-p): Private generic functions
(setf colon-p): Private generic functions
(setf colon-p): Private generic functions
(setf contents): Private generic functions
(setf contents): Private generic functions
(setf end-char): Private generic functions
(setf end-char): Private generic functions
(setf format-char): Private generic functions
(setf format-char): Private generic functions
(setf modifiers): Private generic functions
(setf modifiers): Private generic functions
(setf modifiers): Private generic functions
(setf start-char): Private generic functions
(setf start-char): Private generic functions

A
at-p: Private generic functions
at-p: Private generic functions

C
colon-p: Private generic functions
colon-p: Private generic functions
contents: Private generic functions
contents: Private generic functions
convert-modifier: Private ordinary functions

D
define-compound-format-char: Private ordinary functions
define-compound-format-chars: Private macros
define-format-chars: Private macros
define-message: Public macros
define-sectioned-format-char: Private ordinary functions
define-simple-format-char: Private ordinary functions
define-simple-format-chars: Private macros
dispatch-command: Private generic functions
dispatch-command: Private generic functions
dispatch-command: Private generic functions

E
end-char: Private generic functions
end-char: Private generic functions

F
form-step: Private ordinary functions
format*: Public macros
format-char: Private generic functions
format-char: Private generic functions
Function, convert-modifier: Private ordinary functions
Function, define-compound-format-char: Private ordinary functions
Function, define-sectioned-format-char: Private ordinary functions
Function, define-simple-format-char: Private ordinary functions
Function, form-step: Private ordinary functions
Function, generate-function-defs: Private ordinary functions
Function, make-format-string: Public ordinary functions

G
generate-function-defs: Private ordinary functions
Generic Function, (setf at-p): Private generic functions
Generic Function, (setf colon-p): Private generic functions
Generic Function, (setf contents): Private generic functions
Generic Function, (setf end-char): Private generic functions
Generic Function, (setf format-char): Private generic functions
Generic Function, (setf modifiers): Private generic functions
Generic Function, (setf start-char): Private generic functions
Generic Function, at-p: Private generic functions
Generic Function, colon-p: Private generic functions
Generic Function, contents: Private generic functions
Generic Function, dispatch-command: Private generic functions
Generic Function, end-char: Private generic functions
Generic Function, format-char: Private generic functions
Generic Function, modifiers: Private generic functions
Generic Function, print-format-modifiers: Private generic functions
Generic Function, print-format-representation: Private generic functions
Generic Function, start-char: Private generic functions

M
Macro, define-compound-format-chars: Private macros
Macro, define-format-chars: Private macros
Macro, define-message: Public macros
Macro, define-simple-format-chars: Private macros
Macro, format*: Public macros
make-format-string: Public ordinary functions
Method, (setf at-p): Private generic functions
Method, (setf colon-p): Private generic functions
Method, (setf contents): Private generic functions
Method, (setf end-char): Private generic functions
Method, (setf format-char): Private generic functions
Method, (setf modifiers): Private generic functions
Method, (setf modifiers): Private generic functions
Method, (setf start-char): Private generic functions
Method, at-p: Private generic functions
Method, colon-p: Private generic functions
Method, contents: Private generic functions
Method, dispatch-command: Private generic functions
Method, dispatch-command: Private generic functions
Method, end-char: Private generic functions
Method, format-char: Private generic functions
Method, modifiers: Private generic functions
Method, modifiers: Private generic functions
Method, print-format-modifiers: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-format-representation: Private generic functions
Method, print-object: Public standalone methods
Method, start-char: Private generic functions
modifiers: Private generic functions
modifiers: Private generic functions
modifiers: Private generic functions

P
print-format-modifiers: Private generic functions
print-format-modifiers: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-format-representation: Private generic functions
print-object: Public standalone methods

S
start-char: Private generic functions
start-char: Private generic functions