The monkeylib-text-output Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The monkeylib-text-output Reference Manual

This is the monkeylib-text-output Reference Manual, version 1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:20:14 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 monkeylib-text-output

Author

Peter Seibel <peter@gigamonkeys.com>

License

BSD

Description

Formatted text output.

Version

1.0

Dependencies
Source

monkeylib-text-output.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 monkeylib-text-output.asd

Location

monkeylib-text-output.asd

Systems

monkeylib-text-output (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 monkeylib-text-output/packages.lisp

Parent

monkeylib-text-output (system)

Location

packages.lisp

Packages

monkeylib-text-output


Previous: , Up: Lisp files   [Contents][Index]

2.1.3 monkeylib-text-output/text-output.lisp

Dependency

packages.lisp (file)

Parent

monkeylib-text-output (system)

Location

text-output.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

3.1 monkeylib-text-output

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Special variables

Special Variable: *pretty*

Controls whether output is generated with indentation and tracking of newlines for emitting freshlines.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Special Variable: *text-output*

The stream to which output is sent. Can be bound to any character output stream.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Special Variable: *text-pretty-printer*

The current instance of text-pretty-printer wrapped around *text-output* when *pretty* is true.

Package

monkeylib-text-output

Source

text-output.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Macros

Macro: with-text-output (STREAM &key PRETTY) &body BODY
Package

monkeylib-text-output

Source

text-output.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Functions

Function: codegen-text OPS PRETTY

Given a vector of ops, return a Common Lisp translation, i.e. Common Lisp code that will emit the same output as the text-pretty-printer would if it was given the same ops.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: get-pretty-printer ()
Package

monkeylib-text-output

Source

text-output.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.4 Generic functions

Generic Function: embed-code PROCESSOR CODE

Run arbitrary Lisp code which will presumably emit some output.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: embed-code (COMPILER text-compiler) CODE
Method: embed-code (PP text-pretty-printer) CODE
Generic Function: embed-value PROCESSOR VALUE

Emit a literal value.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: embed-value (COMPILER text-compiler) VALUE
Method: embed-value (PP text-pretty-printer) VALUE
Generic Function: freshline PROCESSOR

Emit a newline unless the last character emitted was a newline.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: freshline (COMPILER text-compiler)
Method: freshline (PP text-pretty-printer)
Generic Function: indent PROCESSOR

Increase the indentation level by some fixed amount.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: indent (COMPILER text-compiler)
Method: indent (PP text-pretty-printer)
Generic Function: newline PROCESSOR

Unconditionally emit a newline.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: newline (COMPILER text-compiler)
Method: newline (PP text-pretty-printer)
Generic Function: ops OBJECT
Generic Function: (setf ops) NEW-VALUE OBJECT
Package

monkeylib-text-output

Methods
Method: ops (TEXT-COMPILER text-compiler)

automatically generated reader method

Source

text-output.lisp (file)

Method: (setf ops) NEW-VALUE (TEXT-COMPILER text-compiler)

automatically generated writer method

Source

text-output.lisp (file)

Generic Function: raw-string PROCESSOR STRING &optional CHECK-FOR-NEWLINES

Emit a string with no escaping. When
CHECK-FOR-NEWLINES is true, string should still be scanned for newlines in order to deal with indentation. In general CHECK-FOR-NEWLINES should be true unless the string is known not to contain newlines.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: raw-string (COMPILER text-compiler) STRING &optional NEWLINES-P
Method: raw-string (PP text-pretty-printer) STRING &optional NEWLINES-P
Generic Function: toggle-indenting PROCESSOR

Temporarily turn of indentation without changing the current indentation value.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: toggle-indenting (COMPILER text-compiler)
Method: toggle-indenting (PP text-pretty-printer)
Generic Function: unindent PROCESSOR

Decrease the indentation level by some fixed amount.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: unindent (COMPILER text-compiler)
Method: unindent (PP text-pretty-printer)

Previous: , Up: Exported definitions   [Contents][Index]

4.1.5 Classes

Class: text-compiler ()
Package

monkeylib-text-output

Source

text-output.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: ops
Initform

(monkeylib-text-output::make-op-buffer)

Readers

ops (generic function)

Writers

(setf ops) (generic function)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Special variables

Special Variable: *default-tab-width*
Package

monkeylib-text-output

Source

text-output.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Functions

Function: compile-buffer BUF OPS

Compile a string possibly containing newlines into a sequence of :raw-string and :newline ops.

Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: emit IP STRING
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: emit-freshline IP
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: emit-newline IP
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: emit/no-newlines IP STRING &key START END
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: generate-code OPS
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: indent-if-necessary IP
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: make-op-buffer ()
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: new-pretty-printer ()
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: optimize-static-output OPS
Package

monkeylib-text-output

Source

text-output.lisp (file)

Function: push-op OP OPS-BUFFER
Package

monkeylib-text-output

Source

text-output.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Generic functions

Generic Function: beginning-of-line-p OBJECT
Generic Function: (setf beginning-of-line-p) NEW-VALUE OBJECT
Package

monkeylib-text-output

Methods
Method: beginning-of-line-p (INDENTING-PRINTER indenting-printer)

automatically generated reader method

Source

text-output.lisp (file)

Method: (setf beginning-of-line-p) NEW-VALUE (INDENTING-PRINTER indenting-printer)

automatically generated writer method

Source

text-output.lisp (file)

Generic Function: indentation OBJECT
Generic Function: (setf indentation) NEW-VALUE OBJECT
Package

monkeylib-text-output

Methods
Method: indentation (INDENTING-PRINTER indenting-printer)

automatically generated reader method

Source

text-output.lisp (file)

Method: (setf indentation) NEW-VALUE (INDENTING-PRINTER indenting-printer)

automatically generated writer method

Source

text-output.lisp (file)

Generic Function: indenting-p OBJECT
Generic Function: (setf indenting-p) NEW-VALUE OBJECT
Package

monkeylib-text-output

Methods
Method: indenting-p (INDENTING-PRINTER indenting-printer)

automatically generated reader method

Source

text-output.lisp (file)

Method: (setf indenting-p) NEW-VALUE (INDENTING-PRINTER indenting-printer)

automatically generated writer method

Source

text-output.lisp (file)

Generic Function: op->code OP &rest OPERANDS
Package

monkeylib-text-output

Source

text-output.lisp (file)

Methods
Method: op->code (OP (eql embed-code)) &rest OPERANDS
Method: op->code (OP (eql embed-value)) &rest OPERANDS
Method: op->code (OP (eql toggle-indenting)) &rest OPERANDS
Method: op->code (OP (eql unindent)) &rest OPERANDS
Method: op->code (OP (eql indent)) &rest OPERANDS
Method: op->code (OP (eql freshline)) &rest OPERANDS
Method: op->code (OP (eql newline)) &rest OPERANDS
Method: op->code (OP (eql raw-string)) &rest OPERANDS
Generic Function: out OBJECT
Generic Function: (setf out) NEW-VALUE OBJECT
Package

monkeylib-text-output

Methods
Method: out (INDENTING-PRINTER indenting-printer)

automatically generated reader method

Source

text-output.lisp (file)

Method: (setf out) NEW-VALUE (INDENTING-PRINTER indenting-printer)

automatically generated writer method

Source

text-output.lisp (file)

Generic Function: printer OBJECT
Generic Function: (setf printer) NEW-VALUE OBJECT
Package

monkeylib-text-output

Methods
Method: printer (TEXT-PRETTY-PRINTER text-pretty-printer)

automatically generated reader method

Source

text-output.lisp (file)

Method: (setf printer) NEW-VALUE (TEXT-PRETTY-PRINTER text-pretty-printer)

automatically generated writer method

Source

text-output.lisp (file)

Generic Function: tab-width OBJECT
Generic Function: (setf tab-width) NEW-VALUE OBJECT
Package

monkeylib-text-output

Methods
Method: tab-width (TEXT-PRETTY-PRINTER text-pretty-printer)

automatically generated reader method

Source

text-output.lisp (file)

Method: (setf tab-width) NEW-VALUE (TEXT-PRETTY-PRINTER text-pretty-printer)

automatically generated writer method

Source

text-output.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.4 Classes

Class: indenting-printer ()
Package

monkeylib-text-output

Source

text-output.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: out
Initargs

:out

Readers

out (generic function)

Writers

(setf out) (generic function)

Slot: beginning-of-line-p
Initform

t

Readers

beginning-of-line-p (generic function)

Writers

(setf beginning-of-line-p) (generic function)

Slot: indentation
Initform

0

Readers

indentation (generic function)

Writers

(setf indentation) (generic function)

Slot: indenting-p
Initform

t

Readers

indenting-p (generic function)

Writers

(setf indenting-p) (generic function)

Class: text-pretty-printer ()
Package

monkeylib-text-output

Source

text-output.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: printer
Initargs

:printer

Readers

printer (generic function)

Writers

(setf printer) (generic function)

Slot: tab-width
Initargs

:tab-width

Initform

monkeylib-text-output::*default-tab-width*

Readers

tab-width (generic function)

Writers

(setf tab-width) (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, monkeylib-text-output.asd: The monkeylib-text-output<dot>asd file
File, Lisp, monkeylib-text-output/packages.lisp: The monkeylib-text-output/packages<dot>lisp file
File, Lisp, monkeylib-text-output/text-output.lisp: The monkeylib-text-output/text-output<dot>lisp file

L
Lisp File, monkeylib-text-output.asd: The monkeylib-text-output<dot>asd file
Lisp File, monkeylib-text-output/packages.lisp: The monkeylib-text-output/packages<dot>lisp file
Lisp File, monkeylib-text-output/text-output.lisp: The monkeylib-text-output/text-output<dot>lisp file

M
monkeylib-text-output.asd: The monkeylib-text-output<dot>asd file
monkeylib-text-output/packages.lisp: The monkeylib-text-output/packages<dot>lisp file
monkeylib-text-output/text-output.lisp: The monkeylib-text-output/text-output<dot>lisp file

Jump to:   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
B   C   E   F   G   I   M   N   O   P   R   T   U   W  
Index Entry  Section

(
(setf beginning-of-line-p): Internal generic functions
(setf beginning-of-line-p): Internal generic functions
(setf indentation): Internal generic functions
(setf indentation): Internal generic functions
(setf indenting-p): Internal generic functions
(setf indenting-p): Internal generic functions
(setf ops): Exported generic functions
(setf ops): Exported generic functions
(setf out): Internal generic functions
(setf out): Internal generic functions
(setf printer): Internal generic functions
(setf printer): Internal generic functions
(setf tab-width): Internal generic functions
(setf tab-width): Internal generic functions

B
beginning-of-line-p: Internal generic functions
beginning-of-line-p: Internal generic functions

C
codegen-text: Exported functions
compile-buffer: Internal functions

E
embed-code: Exported generic functions
embed-code: Exported generic functions
embed-code: Exported generic functions
embed-value: Exported generic functions
embed-value: Exported generic functions
embed-value: Exported generic functions
emit: Internal functions
emit-freshline: Internal functions
emit-newline: Internal functions
emit/no-newlines: Internal functions

F
freshline: Exported generic functions
freshline: Exported generic functions
freshline: Exported generic functions
Function, codegen-text: Exported functions
Function, compile-buffer: Internal functions
Function, emit: Internal functions
Function, emit-freshline: Internal functions
Function, emit-newline: Internal functions
Function, emit/no-newlines: Internal functions
Function, generate-code: Internal functions
Function, get-pretty-printer: Exported functions
Function, indent-if-necessary: Internal functions
Function, make-op-buffer: Internal functions
Function, new-pretty-printer: Internal functions
Function, optimize-static-output: Internal functions
Function, push-op: Internal functions

G
generate-code: Internal functions
Generic Function, (setf beginning-of-line-p): Internal generic functions
Generic Function, (setf indentation): Internal generic functions
Generic Function, (setf indenting-p): Internal generic functions
Generic Function, (setf ops): Exported generic functions
Generic Function, (setf out): Internal generic functions
Generic Function, (setf printer): Internal generic functions
Generic Function, (setf tab-width): Internal generic functions
Generic Function, beginning-of-line-p: Internal generic functions
Generic Function, embed-code: Exported generic functions
Generic Function, embed-value: Exported generic functions
Generic Function, freshline: Exported generic functions
Generic Function, indent: Exported generic functions
Generic Function, indentation: Internal generic functions
Generic Function, indenting-p: Internal generic functions
Generic Function, newline: Exported generic functions
Generic Function, op->code: Internal generic functions
Generic Function, ops: Exported generic functions
Generic Function, out: Internal generic functions
Generic Function, printer: Internal generic functions
Generic Function, raw-string: Exported generic functions
Generic Function, tab-width: Internal generic functions
Generic Function, toggle-indenting: Exported generic functions
Generic Function, unindent: Exported generic functions
get-pretty-printer: Exported functions

I
indent: Exported generic functions
indent: Exported generic functions
indent: Exported generic functions
indent-if-necessary: Internal functions
indentation: Internal generic functions
indentation: Internal generic functions
indenting-p: Internal generic functions
indenting-p: Internal generic functions

M
Macro, with-text-output: Exported macros
make-op-buffer: Internal functions
Method, (setf beginning-of-line-p): Internal generic functions
Method, (setf indentation): Internal generic functions
Method, (setf indenting-p): Internal generic functions
Method, (setf ops): Exported generic functions
Method, (setf out): Internal generic functions
Method, (setf printer): Internal generic functions
Method, (setf tab-width): Internal generic functions
Method, beginning-of-line-p: Internal generic functions
Method, embed-code: Exported generic functions
Method, embed-code: Exported generic functions
Method, embed-value: Exported generic functions
Method, embed-value: Exported generic functions
Method, freshline: Exported generic functions
Method, freshline: Exported generic functions
Method, indent: Exported generic functions
Method, indent: Exported generic functions
Method, indentation: Internal generic functions
Method, indenting-p: Internal generic functions
Method, newline: Exported generic functions
Method, newline: Exported generic functions
Method, op->code: Internal generic functions
Method, op->code: Internal generic functions
Method, op->code: Internal generic functions
Method, op->code: Internal generic functions
Method, op->code: Internal generic functions
Method, op->code: Internal generic functions
Method, op->code: Internal generic functions
Method, op->code: Internal generic functions
Method, ops: Exported generic functions
Method, out: Internal generic functions
Method, printer: Internal generic functions
Method, raw-string: Exported generic functions
Method, raw-string: Exported generic functions
Method, tab-width: Internal generic functions
Method, toggle-indenting: Exported generic functions
Method, toggle-indenting: Exported generic functions
Method, unindent: Exported generic functions
Method, unindent: Exported generic functions

N
new-pretty-printer: Internal functions
newline: Exported generic functions
newline: Exported generic functions
newline: Exported generic functions

O
op->code: Internal generic functions
op->code: Internal generic functions
op->code: Internal generic functions
op->code: Internal generic functions
op->code: Internal generic functions
op->code: Internal generic functions
op->code: Internal generic functions
op->code: Internal generic functions
op->code: Internal generic functions
ops: Exported generic functions
ops: Exported generic functions
optimize-static-output: Internal functions
out: Internal generic functions
out: Internal generic functions

P
printer: Internal generic functions
printer: Internal generic functions
push-op: Internal functions

R
raw-string: Exported generic functions
raw-string: Exported generic functions
raw-string: Exported generic functions

T
tab-width: Internal generic functions
tab-width: Internal generic functions
toggle-indenting: Exported generic functions
toggle-indenting: Exported generic functions
toggle-indenting: Exported generic functions

U
unindent: Exported generic functions
unindent: Exported generic functions
unindent: Exported generic functions

W
with-text-output: Exported macros

Jump to:   (  
B   C   E   F   G   I   M   N   O   P   R   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
B   I   O   P   S   T  
Index Entry  Section

*
*default-tab-width*: Internal special variables
*pretty*: Exported special variables
*text-output*: Exported special variables
*text-pretty-printer*: Exported special variables

B
beginning-of-line-p: Internal classes

I
indentation: Internal classes
indenting-p: Internal classes

O
ops: Exported classes
out: Internal classes

P
printer: Internal classes

S
Slot, beginning-of-line-p: Internal classes
Slot, indentation: Internal classes
Slot, indenting-p: Internal classes
Slot, ops: Exported classes
Slot, out: Internal classes
Slot, printer: Internal classes
Slot, tab-width: Internal classes
Special Variable, *default-tab-width*: Internal special variables
Special Variable, *pretty*: Exported special variables
Special Variable, *text-output*: Exported special variables
Special Variable, *text-pretty-printer*: Exported special variables

T
tab-width: Internal classes

Jump to:   *  
B   I   O   P   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   I   M   P   S   T  
Index Entry  Section

C
Class, indenting-printer: Internal classes
Class, text-compiler: Exported classes
Class, text-pretty-printer: Internal classes

I
indenting-printer: Internal classes

M
monkeylib-text-output: The monkeylib-text-output system
monkeylib-text-output: The monkeylib-text-output package

P
Package, monkeylib-text-output: The monkeylib-text-output package

S
System, monkeylib-text-output: The monkeylib-text-output system

T
text-compiler: Exported classes
text-pretty-printer: Internal classes

Jump to:   C   I   M   P   S   T