The cl-haml Reference Manual

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

• *doctypes* (special variable).
• *escape-html* (special variable).
• *function-package* (special variable).
• *html-mode* (special variable).
• *output-indent-p* (special variable).

Internals

• *whitespace-chars* (special variable).
• +eof+ (constant).
• +filter+ (constant).
• +haml+ (constant).
• +haml-line-comment+ (constant).
• +haml-multiple-comment+ (constant).
• +lisp+ (constant).
• defconstant (macro).

---

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

• .class (function).
• .id (function).

Internals

• -_a-za-z0-9p (function).
• concat-continue-lines (function).
• flatten (function).
• get-insert-point (function).

---

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

• add-class (function).
• add-id (function).
• read-attribute-key (function).
• read-attributes (function).
• read-class (function).
• read-content (function).
• read-contents (function).
• read-haml-element-line (function).
• read-id (function).
• read-lisp-content (function).
• read-options (function).
• read-tag (function).

---

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

• read-haml-comment (function).
• read-haml-lisp-block (function).

---

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

• *filter-convertion* (special variable).
• read-filter-line (function).

---

3.1.9 cl-haml/src/reader.lisp

Dependency

src/read-filter.lisp (file).

Source

cl-haml.asd.

Parent Component

cl-haml (system).

Internals

• eol-or-eof-p (function).
• haml-reader-dispatch (function).
• read-haml-body (function).
• read-haml-line (function).

---

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

• clear-haml (function).
• clear-haml-all (function).
• execute-haml (function).
• register-haml (function).

Internals

• *functions* (special variable).
• *locking-function* (special variable).
• copy-haml-function (function).
• execute-haml-from-string (function).
• get-haml-function (function).
• haml-fn-args (function).
• haml-function (structure).
• haml-function-function (reader).
• (setf haml-function-function) (writer).
• haml-function-p (function).
• haml-function-path (reader).
• (setf haml-function-path) (writer).
• haml-function-time (reader).
• (setf haml-function-time) (writer).
• make-haml-fn (function).
• make-haml-function (function).
• make-haml-readtable (function).
• read-doctype (function).
• read-haml (function).
• with-lock (macro).

---

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.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).

---