The cl-haml Reference Manual

Table of Contents

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

The cl-haml Reference Manual

This is the cl-haml Reference Manual, version 1.0.2, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:06:20 2018 GMT+0.


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

1 Introduction

CL-HAML

What is CL-HAML?

CL-HAML is HTML generator for Common Lisp. Syntax similar to Ruby's library, Haml.

Install

CL-HAML is available on QuickLisp.

(ql:quickload :cl-haml)

or git clone from Github.

git clone https://github.com/Unspeakable/cl-haml.git

Execute

CL-USER> (ASDF:LOAD-SYSTEM :CL-HAML)
CL-USER> (CL-HAML:EXECUTE-HAML (MERGE-PATHNAMES
                                  "examples/example2.haml"
                                  (ASDF:SYSTEM-SOURCE-DIRECTORY :CL-HAML))
                               :ENV '(:ARGUMENT "Hello!"))

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

2 Systems

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


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

2.1 cl-haml

Author

Hiroyuki Tokunaga <inuzini.jiro@gmail.com>

License

MIT License

Description

Haml like XHTML generator.

Version

1.0.2

Dependency

cl-who

Source

cl-haml.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 cl-haml.asd

Location

cl-haml.asd

Systems

cl-haml (system)

Packages

cl-haml-asd


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

3.1.2 cl-haml/src/package.lisp

Parent

cl-haml (system)

Location

src/package.lisp

Packages

cl-haml


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

3.1.3 cl-haml/src/specials.lisp

Dependency

src/package.lisp (file)

Parent

cl-haml (system)

Location

src/specials.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

src/specials.lisp (file)

Parent

cl-haml (system)

Location

src/read-util.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

src/read-util.lisp (file)

Parent

cl-haml (system)

Location

src/read-element.lisp

Internal Definitions

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

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

Dependency

src/read-element.lisp (file)

Parent

cl-haml (system)

Location

src/read-insert.lisp

Internal Definitions

read-haml-insert-line (function)


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

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

Dependency

src/read-insert.lisp (file)

Parent

cl-haml (system)

Location

src/read-lisp-block.lisp

Internal Definitions

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

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

Dependency

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

Parent

cl-haml (system)

Location

src/read-filter.lisp

Internal Definitions

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

3.1.9 cl-haml/src/reader.lisp

Dependency

src/read-filter.lisp (file)

Parent

cl-haml (system)

Location

src/reader.lisp

Internal Definitions

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

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

Dependency

src/reader.lisp (file)

Parent

cl-haml (system)

Location

src/cl-who-patch.lisp


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

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

Dependency

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

Parent

cl-haml (system)

Location

src/cl-haml.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-haml-asd

Source

cl-haml.asd

Use List

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

4.2 cl-haml

Source

src/package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *doctypes*

DOCTYPE alist.

Package

cl-haml

Source

src/specials.lisp (file)

Special Variable: *escape-html*
Package

cl-haml

Source

src/specials.lisp (file)

Special Variable: *function-package*
Package

cl-haml

Source

src/specials.lisp (file)

Special Variable: *html-mode*
Package

cl-haml

Source

src/specials.lisp (file)

Special Variable: *output-indent-p*
Package

cl-haml

Source

src/specials.lisp (file)


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

5.1.2 Functions

Function: .class &rest ARGS
Package

cl-haml

Source

src/read-util.lisp (file)

Function: .id &rest ARGS
Package

cl-haml

Source

src/read-util.lisp (file)

Function: clear-haml NAME

Remove named CL-HAML code.

Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: clear-haml-all ()

Remove all registered CL-HAML code.

Package

cl-haml

Source

src/cl-haml.lisp (file)

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 (file)

Function: register-haml NAME CODE &optional OBJ
Package

cl-haml

Source

src/cl-haml.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: +eof+
Package

cl-haml

Source

src/specials.lisp (file)

Constant: +filter+
Package

cl-haml

Source

src/specials.lisp (file)

Constant: +haml+
Package

cl-haml

Source

src/specials.lisp (file)

Constant: +haml-line-comment+
Package

cl-haml

Source

src/specials.lisp (file)

Constant: +haml-multiple-comment+
Package

cl-haml

Source

src/specials.lisp (file)

Constant: +lisp+
Package

cl-haml

Source

src/specials.lisp (file)


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

5.2.2 Special variables

Special Variable: *filter-convertion*
Package

cl-haml

Source

src/read-filter.lisp (file)

Special Variable: *functions*

Table mapping names to haml-function instances.

Package

cl-haml

Source

src/cl-haml.lisp (file)

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 (file)

Special Variable: *whitespace-chars*
Package

cl-haml

Source

src/specials.lisp (file)


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

5.2.3 Macros

Macro: defconstant NAME VALUE &optional DOC

Make sure VALUE is evaluated only once.

Package

cl-haml

Source

src/specials.lisp (file)

Macro: with-lock &body BODY

Locking all accesses to *functions*

Package

cl-haml

Source

src/cl-haml.lisp (file)


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

5.2.4 Functions

Function: -_a-za-z0-9p CHAR

[-_a-zA-Z0-9]

Package

cl-haml

Source

src/read-util.lisp (file)

Function: add-class CLASS ATTR-LIST
Package

cl-haml

Source

src/read-element.lisp (file)

Function: add-id ID ATTR-LIST
Package

cl-haml

Source

src/read-element.lisp (file)

Function: concat-continue-lines IN LINE
Package

cl-haml

Source

src/read-util.lisp (file)

Function: copy-haml-function INSTANCE
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: eol-or-eof-p CHAR EOF-VALUE
Package

cl-haml

Source

src/reader.lisp (file)

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 (file)

Function: flatten LIST

tree -> flat list.

Package

cl-haml

Source

src/read-util.lisp (file)

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 (file)

Function: get-insert-point TYPE SEXP
Package

cl-haml

Source

src/read-util.lisp (file)

Function: haml-fn-args SEXP
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: haml-function-function INSTANCE
Function: (setf haml-function-function) VALUE INSTANCE
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: haml-function-p OBJECT
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: haml-function-path INSTANCE
Function: (setf haml-function-path) VALUE INSTANCE
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: haml-function-time INSTANCE
Function: (setf haml-function-time) VALUE INSTANCE
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: haml-reader-dispatch PARENT-TYPE STREAM &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/reader.lisp (file)

Function: make-haml-fn STREAM
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: make-haml-function &key (PATH PATH) (TIME TIME) (FUNCTION FUNCTION)
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: make-haml-readtable ()
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: read-attribute-key STREAM &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/read-element.lisp (file)

Function: read-attributes STREAM &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/read-element.lisp (file)

Function: read-class STREAM

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

Package

cl-haml

Source

src/read-element.lisp (file)

Function: read-content STREAM &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/read-element.lisp (file)

Function: read-contents STREAM OPTIONS &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/read-element.lisp (file)

Function: read-doctype IN
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: read-filter-line STREAM
Package

cl-haml

Source

src/read-filter.lisp (file)

Function: read-haml STREAM
Package

cl-haml

Source

src/cl-haml.lisp (file)

Function: read-haml-body STREAM INDENT PARENT-TYPE
Package

cl-haml

Source

src/reader.lisp (file)

Function: read-haml-comment STREAM EOF-VALUE
Package

cl-haml

Source

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

Function: read-haml-element-line STREAM &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/read-element.lisp (file)

Function: read-haml-insert-line STREAM &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/read-insert.lisp (file)

Function: read-haml-line PARENT-TYPE STREAM INDENT &optional EOF-ERROR-P EOF-VALUE
Package

cl-haml

Source

src/reader.lisp (file)

Function: read-haml-lisp-block STREAM
Package

cl-haml

Source

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

Function: read-id STREAM

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

Package

cl-haml

Source

src/read-element.lisp (file)

Function: read-lisp-content IN
Package

cl-haml

Source

src/read-element.lisp (file)

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 (file)

Function: read-tag STREAM

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

Package

cl-haml

Source

src/read-element.lisp (file)


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

5.2.5 Structures

Structure: haml-function ()
Package

cl-haml

Source

src/cl-haml.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: path
Readers

haml-function-path (function)

Writers

(setf haml-function-path) (function)

Slot: time
Readers

haml-function-time (function)

Writers

(setf haml-function-time) (function)

Slot: function
Readers

haml-function-function (function)

Writers

(setf haml-function-function) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-haml.asd: The cl-haml<dot>asd file
cl-haml/src/cl-haml.lisp: The cl-haml/src/cl-haml<dot>lisp file
cl-haml/src/cl-who-patch.lisp: The cl-haml/src/cl-who-patch<dot>lisp file
cl-haml/src/package.lisp: The cl-haml/src/package<dot>lisp file
cl-haml/src/read-element.lisp: The cl-haml/src/read-element<dot>lisp file
cl-haml/src/read-filter.lisp: The cl-haml/src/read-filter<dot>lisp file
cl-haml/src/read-insert.lisp: The cl-haml/src/read-insert<dot>lisp file
cl-haml/src/read-lisp-block.lisp: The cl-haml/src/read-lisp-block<dot>lisp file
cl-haml/src/read-util.lisp: The cl-haml/src/read-util<dot>lisp file
cl-haml/src/reader.lisp: The cl-haml/src/reader<dot>lisp file
cl-haml/src/specials.lisp: The cl-haml/src/specials<dot>lisp file

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

L
Lisp File, cl-haml.asd: The cl-haml<dot>asd file
Lisp File, cl-haml/src/cl-haml.lisp: The cl-haml/src/cl-haml<dot>lisp file
Lisp File, cl-haml/src/cl-who-patch.lisp: The cl-haml/src/cl-who-patch<dot>lisp file
Lisp File, cl-haml/src/package.lisp: The cl-haml/src/package<dot>lisp file
Lisp File, cl-haml/src/read-element.lisp: The cl-haml/src/read-element<dot>lisp file
Lisp File, cl-haml/src/read-filter.lisp: The cl-haml/src/read-filter<dot>lisp file
Lisp File, cl-haml/src/read-insert.lisp: The cl-haml/src/read-insert<dot>lisp file
Lisp File, cl-haml/src/read-lisp-block.lisp: The cl-haml/src/read-lisp-block<dot>lisp file
Lisp File, cl-haml/src/read-util.lisp: The cl-haml/src/read-util<dot>lisp file
Lisp File, cl-haml/src/reader.lisp: The cl-haml/src/reader<dot>lisp file
Lisp File, cl-haml/src/specials.lisp: The cl-haml/src/specials<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

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

(
(setf haml-function-function): Internal functions
(setf haml-function-path): Internal functions
(setf haml-function-time): Internal functions

-
-_a-za-z0-9p: Internal functions

.
.class: Exported functions
.id: Exported functions

A
add-class: Internal functions
add-id: Internal functions

C
clear-haml: Exported functions
clear-haml-all: Exported functions
concat-continue-lines: Internal functions
copy-haml-function: Internal functions

D
defconstant: Internal macros

E
eol-or-eof-p: Internal functions
execute-haml: Exported functions
execute-haml-from-string: Internal functions

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

G
get-haml-function: Internal functions
get-insert-point: Internal functions

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

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

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

W
with-lock: Internal macros

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

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

A.3 Variables

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

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

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

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

F
function: Internal structures

P
path: Internal structures

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

T
time: Internal structures

Jump to:   *   +  
C   F   P   S   T  

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

A.4 Data types

Jump to:   C   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

H
haml-function: Internal structures

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

S
Structure, haml-function: Internal structures
System, cl-haml: The cl-haml system

Jump to:   C   H   P   S