The cl-haml Reference Manual

This is the cl-haml Reference Manual, version 1.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:15:12 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-haml

Haml like XHTML generator.

Author

Hiroyuki Tokunaga <>

License

MIT License

Version

1.0.2

Dependency

cl-who (system).

Source

cl-haml.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 cl-haml/cl-haml.asd

Source

cl-haml.asd.

Parent Component

cl-haml (system).

ASDF Systems

cl-haml.

Packages

cl-haml-asd.


3.1.2 cl-haml/src/package.lisp

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Packages

cl-haml.


3.1.3 cl-haml/src/specials.lisp

Dependency

src/package.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Public Interface
Internals

3.1.4 cl-haml/src/read-util.lisp

Dependency

src/specials.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Public Interface
Internals

3.1.5 cl-haml/src/read-element.lisp

Dependency

src/read-util.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Internals

3.1.6 cl-haml/src/read-insert.lisp

Dependency

src/read-element.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Internals

read-haml-insert-line (function).


3.1.7 cl-haml/src/read-lisp-block.lisp

Dependency

src/read-insert.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Internals

3.1.8 cl-haml/src/read-filter.lisp

Dependency

src/read-lisp-block.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Internals

3.1.9 cl-haml/src/reader.lisp

Dependency

src/read-filter.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Internals

3.1.10 cl-haml/src/cl-who-patch.lisp

Dependency

src/reader.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).


3.1.11 cl-haml/src/cl-haml.lisp

Dependency

src/cl-who-patch.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-haml-asd

Source

cl-haml.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 cl-haml

Source

src/package.lisp.

Use List

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: *doctypes*

DOCTYPE alist.

Package

cl-haml.

Source

src/specials.lisp.

Special Variable: *escape-html*
Package

cl-haml.

Source

src/specials.lisp.

Special Variable: *function-package*
Package

cl-haml.

Source

src/specials.lisp.

Special Variable: *html-mode*
Package

cl-haml.

Source

src/specials.lisp.

Special Variable: *output-indent-p*
Package

cl-haml.

Source

src/specials.lisp.


5.1.2 Ordinary functions

Function: .class (&rest args)
Package

cl-haml.

Source

src/read-util.lisp.

Function: .id (&rest args)
Package

cl-haml.

Source

src/read-util.lisp.

Function: clear-haml (name)

Remove named CL-HAML code.

Package

cl-haml.

Source

src/cl-haml.lisp.

Function: clear-haml-all ()

Remove all registered CL-HAML code.

Package

cl-haml.

Source

src/cl-haml.lisp.

Function: execute-haml (name &key env)

Execute named CL-HAML code. Returns a string.
Keyword parameter $var{ENV} to pass objects to the code. $var{ENV} must be a plist.

Package

cl-haml.

Source

src/cl-haml.lisp.

Function: register-haml (name code &optional obj)
Package

cl-haml.

Source

src/cl-haml.lisp.


5.2 Internals


5.2.1 Constants

Constant: +eof+
Package

cl-haml.

Source

src/specials.lisp.

Constant: +filter+
Package

cl-haml.

Source

src/specials.lisp.

Constant: +haml+
Package

cl-haml.

Source

src/specials.lisp.

Constant: +haml-line-comment+
Package

cl-haml.

Source

src/specials.lisp.

Constant: +haml-multiple-comment+
Package

cl-haml.

Source

src/specials.lisp.

Constant: +lisp+
Package

cl-haml.

Source

src/specials.lisp.


5.2.2 Special variables

Special Variable: *filter-convertion*
Package

cl-haml.

Source

src/read-filter.lisp.

Special Variable: *functions*

Table mapping names to haml-function instances.

Package

cl-haml.

Source

src/cl-haml.lisp.

Special Variable: *locking-function*

Function to call to lock access to an internal hash table.
Must accept a function designater which must be called with the lock hold.

Package

cl-haml.

Source

src/cl-haml.lisp.

Special Variable: *whitespace-chars*
Package

cl-haml.

Source

src/specials.lisp.


5.2.3 Macros

Macro: defconstant (name value &optional doc)

Make sure VALUE is evaluated only once.

Package

cl-haml.

Source

src/specials.lisp.

Macro: with-lock (&body body)

Locking all accesses to *functions*

Package

cl-haml.

Source

src/cl-haml.lisp.


5.2.4 Ordinary functions

Function: -_a-za-z0-9p (char)

[-_a-zA-Z0-9]

Package

cl-haml.

Source

src/read-util.lisp.

Function: add-class (class attr-list)
Package

cl-haml.

Source

src/read-element.lisp.

Function: add-id (id attr-list)
Package

cl-haml.

Source

src/read-element.lisp.

Function: concat-continue-lines (in line)
Package

cl-haml.

Source

src/read-util.lisp.

Function: copy-haml-function (instance)
Package

cl-haml.

Source

src/cl-haml.lisp.

Function: eol-or-eof-p (char eof-value)
Package

cl-haml.

Source

src/reader.lisp.

Function: execute-haml-from-string (code &key env)

Execute string CL-HAML code. Returns a string.
Keyword parameter $var{CODE} to string objects to the code. $var{ENV} must be a plist.

Package

cl-haml.

Source

src/cl-haml.lisp.

Function: flatten (list)

tree -> flat list.

Package

cl-haml.

Source

src/read-util.lisp.

Function: get-haml-function (name)

Returns the named function implementing a registered CL-HAML code. Rebuilds it when text template was a file which has been modified.

Package

cl-haml.

Source

src/cl-haml.lisp.

Function: get-insert-point (type sexp)
Package

cl-haml.

Source

src/read-util.lisp.

Function: haml-fn-args (sexp)
Package

cl-haml.

Source

src/cl-haml.lisp.

Reader: haml-function-function (instance)
Writer: (setf haml-function-function) (instance)
Package

cl-haml.

Source

src/cl-haml.lisp.

Target Slot

function.

Function: haml-function-p (object)
Package

cl-haml.

Source

src/cl-haml.lisp.

Reader: haml-function-path (instance)
Writer: (setf haml-function-path) (instance)
Package

cl-haml.

Source

src/cl-haml.lisp.

Target Slot

path.

Reader: haml-function-time (instance)
Writer: (setf haml-function-time) (instance)
Package

cl-haml.

Source

src/cl-haml.lisp.

Target Slot

time.

Function: haml-reader-dispatch (parent-type stream &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/reader.lisp.

Function: make-haml-fn (stream)
Package

cl-haml.

Source

src/cl-haml.lisp.

Function: make-haml-function (&key path time function)
Package

cl-haml.

Source

src/cl-haml.lisp.

Function: make-haml-readtable ()
Package

cl-haml.

Source

src/cl-haml.lisp.

Function: read-attribute-key (stream &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/read-element.lisp.

Function: read-attributes (stream &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/read-element.lisp.

Function: read-class (stream)

Read Haml Class. ex) .class1.class2 -> "class1 class2".

Package

cl-haml.

Source

src/read-element.lisp.

Function: read-content (stream &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/read-element.lisp.

Function: read-contents (stream options &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/read-element.lisp.

Function: read-doctype (in)
Package

cl-haml.

Source

src/cl-haml.lisp.

Function: read-filter-line (stream)
Package

cl-haml.

Source

src/read-filter.lisp.

Function: read-haml (stream)
Package

cl-haml.

Source

src/cl-haml.lisp.

Function: read-haml-body (stream indent parent-type)
Package

cl-haml.

Source

src/reader.lisp.

Function: read-haml-comment (stream eof-value)
Package

cl-haml.

Source

src/read-lisp-block.lisp.

Function: read-haml-element-line (stream &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/read-element.lisp.

Function: read-haml-insert-line (stream &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/read-insert.lisp.

Function: read-haml-line (parent-type stream indent &optional eof-error-p eof-value)
Package

cl-haml.

Source

src/reader.lisp.

Function: read-haml-lisp-block (stream)
Package

cl-haml.

Source

src/read-lisp-block.lisp.

Function: read-id (stream)

Read Haml Id. ex) #identification -> "identification".

Package

cl-haml.

Source

src/read-element.lisp.

Function: read-lisp-content (in)
Package

cl-haml.

Source

src/read-element.lisp.

Function: read-options (stream &optional eof-error-p eof-value)

Read options.
But Ignore ‘self-closing’, ‘inside-whitespace-remove’ and ‘outside-whitespace-remove’ option.

Package

cl-haml.

Source

src/read-element.lisp.

Function: read-tag (stream)

Read Haml Tag. ex) %xxx -> :|xxx|.

Package

cl-haml.

Source

src/read-element.lisp.


5.2.5 Structures

Structure: haml-function
Package

cl-haml.

Source

src/cl-haml.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: path
Readers

haml-function-path.

Writers

(setf haml-function-path).

Slot: time
Package

common-lisp.

Readers

haml-function-time.

Writers

(setf haml-function-time).

Slot: function
Package

common-lisp.

Readers

haml-function-function.

Writers

(setf haml-function-function).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (   -   .  
A   C   D   E   F   G   H   M   R   W  
Index Entry  Section

(
(setf haml-function-function): Private ordinary functions
(setf haml-function-path): Private ordinary functions
(setf haml-function-time): Private ordinary functions

-
-_a-za-z0-9p: Private ordinary functions

.
.class: Public ordinary functions
.id: Public ordinary functions

A
add-class: Private ordinary functions
add-id: Private ordinary functions

C
clear-haml: Public ordinary functions
clear-haml-all: Public ordinary functions
concat-continue-lines: Private ordinary functions
copy-haml-function: Private ordinary functions

D
defconstant: Private macros

E
eol-or-eof-p: Private ordinary functions
execute-haml: Public ordinary functions
execute-haml-from-string: Private ordinary functions

F
flatten: Private ordinary functions
Function, (setf haml-function-function): Private ordinary functions
Function, (setf haml-function-path): Private ordinary functions
Function, (setf haml-function-time): Private ordinary functions
Function, -_a-za-z0-9p: Private ordinary functions
Function, .class: Public ordinary functions
Function, .id: Public ordinary functions
Function, add-class: Private ordinary functions
Function, add-id: Private ordinary functions
Function, clear-haml: Public ordinary functions
Function, clear-haml-all: Public ordinary functions
Function, concat-continue-lines: Private ordinary functions
Function, copy-haml-function: Private ordinary functions
Function, eol-or-eof-p: Private ordinary functions
Function, execute-haml: Public ordinary functions
Function, execute-haml-from-string: Private ordinary functions
Function, flatten: Private ordinary functions
Function, get-haml-function: Private ordinary functions
Function, get-insert-point: Private ordinary functions
Function, haml-fn-args: Private ordinary functions
Function, haml-function-function: Private ordinary functions
Function, haml-function-p: Private ordinary functions
Function, haml-function-path: Private ordinary functions
Function, haml-function-time: Private ordinary functions
Function, haml-reader-dispatch: Private ordinary functions
Function, make-haml-fn: Private ordinary functions
Function, make-haml-function: Private ordinary functions
Function, make-haml-readtable: Private ordinary functions
Function, read-attribute-key: Private ordinary functions
Function, read-attributes: Private ordinary functions
Function, read-class: Private ordinary functions
Function, read-content: Private ordinary functions
Function, read-contents: Private ordinary functions
Function, read-doctype: Private ordinary functions
Function, read-filter-line: Private ordinary functions
Function, read-haml: Private ordinary functions
Function, read-haml-body: Private ordinary functions
Function, read-haml-comment: Private ordinary functions
Function, read-haml-element-line: Private ordinary functions
Function, read-haml-insert-line: Private ordinary functions
Function, read-haml-line: Private ordinary functions
Function, read-haml-lisp-block: Private ordinary functions
Function, read-id: Private ordinary functions
Function, read-lisp-content: Private ordinary functions
Function, read-options: Private ordinary functions
Function, read-tag: Private ordinary functions
Function, register-haml: Public ordinary functions

G
get-haml-function: Private ordinary functions
get-insert-point: Private ordinary functions

H
haml-fn-args: Private ordinary functions
haml-function-function: Private ordinary functions
haml-function-p: Private ordinary functions
haml-function-path: Private ordinary functions
haml-function-time: Private ordinary functions
haml-reader-dispatch: Private ordinary functions

M
Macro, defconstant: Private macros
Macro, with-lock: Private macros
make-haml-fn: Private ordinary functions
make-haml-function: Private ordinary functions
make-haml-readtable: Private ordinary functions

R
read-attribute-key: Private ordinary functions
read-attributes: Private ordinary functions
read-class: Private ordinary functions
read-content: Private ordinary functions
read-contents: Private ordinary functions
read-doctype: Private ordinary functions
read-filter-line: Private ordinary functions
read-haml: Private ordinary functions
read-haml-body: Private ordinary functions
read-haml-comment: Private ordinary functions
read-haml-element-line: Private ordinary functions
read-haml-insert-line: Private ordinary functions
read-haml-line: Private ordinary functions
read-haml-lisp-block: Private ordinary functions
read-id: Private ordinary functions
read-lisp-content: Private ordinary functions
read-options: Private ordinary functions
read-tag: Private ordinary functions
register-haml: Public ordinary functions

W
with-lock: Private macros


A.3 Variables

Jump to:   *   +  
C   F   P   S   T  
Index Entry  Section

*
*doctypes*: Public special variables
*escape-html*: Public special variables
*filter-convertion*: Private special variables
*function-package*: Public special variables
*functions*: Private special variables
*html-mode*: Public special variables
*locking-function*: Private special variables
*output-indent-p*: Public special variables
*whitespace-chars*: Private special variables

+
+eof+: Private constants
+filter+: Private constants
+haml+: Private constants
+haml-line-comment+: Private constants
+haml-multiple-comment+: Private constants
+lisp+: Private constants

C
Constant, +eof+: Private constants
Constant, +filter+: Private constants
Constant, +haml+: Private constants
Constant, +haml-line-comment+: Private constants
Constant, +haml-multiple-comment+: Private constants
Constant, +lisp+: Private constants

F
function: Private structures

P
path: Private structures

S
Slot, function: Private structures
Slot, path: Private structures
Slot, time: Private structures
Special Variable, *doctypes*: Public special variables
Special Variable, *escape-html*: Public special variables
Special Variable, *filter-convertion*: Private special variables
Special Variable, *function-package*: Public special variables
Special Variable, *functions*: Private special variables
Special Variable, *html-mode*: Public special variables
Special Variable, *locking-function*: Private special variables
Special Variable, *output-indent-p*: Public special variables
Special Variable, *whitespace-chars*: Private special variables

T
time: Private structures


A.4 Data types

Jump to:   C   F   H   P   S  
Index Entry  Section

C
cl-haml: The cl-haml system
cl-haml: The cl-haml package
cl-haml-asd: The cl-haml-asd package
cl-haml.asd: The cl-haml/cl-haml․asd file

F
File, cl-haml.asd: The cl-haml/cl-haml․asd file
File, src/cl-haml.lisp: The cl-haml/src/cl-haml․lisp file
File, src/cl-who-patch.lisp: The cl-haml/src/cl-who-patch․lisp file
File, src/package.lisp: The cl-haml/src/package․lisp file
File, src/read-element.lisp: The cl-haml/src/read-element․lisp file
File, src/read-filter.lisp: The cl-haml/src/read-filter․lisp file
File, src/read-insert.lisp: The cl-haml/src/read-insert․lisp file
File, src/read-lisp-block.lisp: The cl-haml/src/read-lisp-block․lisp file
File, src/read-util.lisp: The cl-haml/src/read-util․lisp file
File, src/reader.lisp: The cl-haml/src/reader․lisp file
File, src/specials.lisp: The cl-haml/src/specials․lisp file

H
haml-function: Private structures

P
Package, cl-haml: The cl-haml package
Package, cl-haml-asd: The cl-haml-asd package

S
src/cl-haml.lisp: The cl-haml/src/cl-haml․lisp file
src/cl-who-patch.lisp: The cl-haml/src/cl-who-patch․lisp file
src/package.lisp: The cl-haml/src/package․lisp file
src/read-element.lisp: The cl-haml/src/read-element․lisp file
src/read-filter.lisp: The cl-haml/src/read-filter․lisp file
src/read-insert.lisp: The cl-haml/src/read-insert․lisp file
src/read-lisp-block.lisp: The cl-haml/src/read-lisp-block․lisp file
src/read-util.lisp: The cl-haml/src/read-util․lisp file
src/reader.lisp: The cl-haml/src/reader․lisp file
src/specials.lisp: The cl-haml/src/specials․lisp file
Structure, haml-function: Private structures
System, cl-haml: The cl-haml system