The lisp-preprocessor Reference Manual

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

Table of Contents


1 Introduction


2 Systems

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


2.1 lisp-preprocessor

Common Lisp embedded template engine

Author

cxxxr

License

MIT

Dependencies
  • alexandria (system).
  • split-sequence (system).
  • trivial-gray-streams (system).
  • trivia (system).
  • cl-ppcre (system).
Source

lisp-preprocessor.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 lisp-preprocessor/lisp-preprocessor.asd

Source

lisp-preprocessor.asd.

Parent Component

lisp-preprocessor (system).

ASDF Systems

lisp-preprocessor.


3.1.3 lisp-preprocessor/stream.lisp

Dependency

packages.lisp (file).

Source

lisp-preprocessor.asd.

Parent Component

lisp-preprocessor (system).

Public Interface
Internals

3.1.4 lisp-preprocessor/lisp-preprocessor.lisp

Dependency

stream.lisp (file).

Source

lisp-preprocessor.asd.

Parent Component

lisp-preprocessor (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 lisp-preprocessor.stream

Source

packages.lisp.

Use List
  • common-lisp.
  • trivial-gray-streams.
Public Interface
Internals

4.2 lisp-preprocessor.in-template

Source

packages.lisp.

Use List
  • alexandria.
  • common-lisp.
  • split-sequence.
Public Interface

with-indent (macro).

Internals

invoke-with-indent (function).


4.3 lisp-preprocessor

Source

packages.lisp.

Use List
  • alexandria.
  • common-lisp.
  • split-sequence.
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: *in-template-package*
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.


5.1.2 Macros

Macro: with-indent (emitter indent &body body)
Package

lisp-preprocessor.stream.

Source

stream.lisp.

Macro: with-indent (indent &body body)
Package

lisp-preprocessor.in-template.

Source

lisp-preprocessor.lisp.


5.1.3 Ordinary functions

Function: compile-template (string-or-pathname &key template-begin template-end in-template-package arguments)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: run-template-into-file (compiland file &rest arguments)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: run-template-into-stream (compiland stream &rest arguments)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: run-template-into-string (compiland &rest arguments)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.


5.1.4 Standalone methods

Method: stream-element-type ((stream emitter))
Source

stream.lisp.

Method: stream-fresh-line ((stream emitter))
Package

sb-gray.

Source

stream.lisp.

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

sb-gray.

Source

stream.lisp.

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

sb-gray.

Source

stream.lisp.

Method: stream-write-string ((stream emitter) string &optional start end)
Package

sb-gray.

Source

stream.lisp.


5.1.5 Classes

Class: emitter
Package

lisp-preprocessor.stream.

Source

stream.lisp.

Direct superclasses

fundamental-output-stream.

Direct methods
Direct slots
Slot: column
Initform

0

Readers

emitter-column.

Writers

(setf emitter-column).

Slot: indent
Initform

0

Readers

emitter-indent.

Writers

(setf emitter-indent).

Slot: stream
Package

common-lisp.

Initform

*standard-output*

Initargs

:stream

Readers

emitter-stream.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *template-begin*
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Special Variable: *template-end*
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Special Variable: +tab-width+
Package

lisp-preprocessor.stream.

Source

stream.lisp.

Special Variable: +whitespaces+
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.


5.2.2 Ordinary functions

Function: add-character-width (character column)
Package

lisp-preprocessor.stream.

Source

stream.lisp.

Function: begin+ (pos)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: blank-line-p (text pos)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: call-with-indent (emitter indent function)
Package

lisp-preprocessor.stream.

Source

stream.lisp.

Function: chop-in-forms (forms)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: compute-column (text pos)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: empty-string-p (string)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: end+ (pos)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: end-of-line-p (text pos)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: ensure-compiled-template (compiland)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: invoke-with-indent (indent function)
Package

lisp-preprocessor.in-template.

Source

lisp-preprocessor.lisp.

Function: load-template (string-or-pathname)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: read-template-form (stream text column)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.

Function: reintern-symbol (symbol)
Package

lisp-preprocessor.

Source

lisp-preprocessor.lisp.


5.2.3 Generic functions

Generic Reader: emitter-column (object)
Package

lisp-preprocessor.stream.

Methods
Reader Method: emitter-column ((emitter emitter))

automatically generated reader method

Source

stream.lisp.

Target Slot

column.

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

lisp-preprocessor.stream.

Methods
Writer Method: (setf emitter-column) ((emitter emitter))

automatically generated writer method

Source

stream.lisp.

Target Slot

column.

Generic Reader: emitter-indent (object)
Package

lisp-preprocessor.stream.

Methods
Reader Method: emitter-indent ((emitter emitter))

automatically generated reader method

Source

stream.lisp.

Target Slot

indent.

Generic Writer: (setf emitter-indent) (object)
Package

lisp-preprocessor.stream.

Methods
Writer Method: (setf emitter-indent) ((emitter emitter))

automatically generated writer method

Source

stream.lisp.

Target Slot

indent.

Generic Reader: emitter-stream (object)
Package

lisp-preprocessor.stream.

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

automatically generated reader method

Source

stream.lisp.

Target Slot

stream.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   E   F   G   I   L   M   R   S   W  
Index Entry  Section

(
(setf emitter-column): Private generic functions
(setf emitter-column): Private generic functions
(setf emitter-indent): Private generic functions
(setf emitter-indent): Private generic functions

A
add-character-width: Private ordinary functions

B
begin+: Private ordinary functions
blank-line-p: Private ordinary functions

C
call-with-indent: Private ordinary functions
chop-in-forms: Private ordinary functions
compile-template: Public ordinary functions
compute-column: Private ordinary functions

E
emitter-column: Private generic functions
emitter-column: Private generic functions
emitter-indent: Private generic functions
emitter-indent: Private generic functions
emitter-stream: Private generic functions
emitter-stream: Private generic functions
empty-string-p: Private ordinary functions
end+: Private ordinary functions
end-of-line-p: Private ordinary functions
ensure-compiled-template: Private ordinary functions

F
Function, add-character-width: Private ordinary functions
Function, begin+: Private ordinary functions
Function, blank-line-p: Private ordinary functions
Function, call-with-indent: Private ordinary functions
Function, chop-in-forms: Private ordinary functions
Function, compile-template: Public ordinary functions
Function, compute-column: Private ordinary functions
Function, empty-string-p: Private ordinary functions
Function, end+: Private ordinary functions
Function, end-of-line-p: Private ordinary functions
Function, ensure-compiled-template: Private ordinary functions
Function, invoke-with-indent: Private ordinary functions
Function, load-template: Private ordinary functions
Function, read-template-form: Private ordinary functions
Function, reintern-symbol: Private ordinary functions
Function, run-template-into-file: Public ordinary functions
Function, run-template-into-stream: Public ordinary functions
Function, run-template-into-string: Public ordinary functions

G
Generic Function, (setf emitter-column): Private generic functions
Generic Function, (setf emitter-indent): Private generic functions
Generic Function, emitter-column: Private generic functions
Generic Function, emitter-indent: Private generic functions
Generic Function, emitter-stream: Private generic functions

I
invoke-with-indent: Private ordinary functions

L
load-template: Private ordinary functions

M
Macro, with-indent: Public macros
Macro, with-indent: Public macros
Method, (setf emitter-column): Private generic functions
Method, (setf emitter-indent): Private generic functions
Method, emitter-column: Private generic functions
Method, emitter-indent: Private generic functions
Method, emitter-stream: Private generic functions
Method, stream-element-type: Public standalone methods
Method, stream-fresh-line: Public standalone methods
Method, stream-line-column: Public standalone methods
Method, stream-write-char: Public standalone methods
Method, stream-write-string: Public standalone methods

R
read-template-form: Private ordinary functions
reintern-symbol: Private ordinary functions
run-template-into-file: Public ordinary functions
run-template-into-stream: Public ordinary functions
run-template-into-string: Public ordinary functions

S
stream-element-type: Public standalone methods
stream-fresh-line: Public standalone methods
stream-line-column: Public standalone methods
stream-write-char: Public standalone methods
stream-write-string: Public standalone methods

W
with-indent: Public macros
with-indent: Public macros