The lsx Reference Manual

Next: lsx/tag, Previous: lsx/main, Up: Systems [Contents][Index]

2.3 `lsx/reader`

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

lsx/tag (system).
lsx/html (system).
named-readtables (system).

Source

Next: lsx/html, Previous: lsx/reader, Up: Systems [Contents][Index]

2.4 `lsx/tag`

Author: Eitaro Fukamachi
License: BSD 2-Clause
Dependency: lsx/html (system).
Source: lsx.asd.

Next: lsx/file, Previous: lsx/tag, Up: Systems [Contents][Index]

2.5 `lsx/html`

Author: Eitaro Fukamachi
License: BSD 2-Clause
Source: lsx.asd.

Next: lsx/template, Previous: lsx/html, Up: Systems [Contents][Index]

2.6 `lsx/file`

Author: Eitaro Fukamachi
License: BSD 2-Clause
Dependency: lsx/reader (system).
Source: lsx.asd.

Previous: lsx/file, Up: Systems [Contents][Index]

2.7 `lsx/template`

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

lsx/html (system).
closer-mop (system).

Source

Next: Packages, Previous: Systems, Up: The lsx Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: lsx/main/file-type.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `lsx/lsx.asd`

Source

Parent Component

lsx (system).

ASDF Systems

lsx.
lsx/main.
lsx/reader.
lsx/tag.
lsx/html.
lsx/file.
lsx/template.

Next: lsx/reader/file-type.lisp, Previous: lsx/lsx.asd, Up: Lisp [Contents][Index]

3.1.2 `lsx/main/file-type.lisp`

Source: lsx.asd.
Parent Component: lsx/main (system).
Packages: lsx.

Next: lsx/tag/file-type.lisp, Previous: lsx/main/file-type.lisp, Up: Lisp [Contents][Index]

3.1.3 `lsx/reader/file-type.lisp`

Source

Parent Component

lsx/reader (system).

Packages

lsx/reader.

Public Interface

disable-lsx-syntax (macro).
enable-lsx-syntax (macro).

Internals

%disable-lsx-syntax (function).
%enable-lsx-syntax (function).
*default-readtable* (special variable).
*previous-readtables* (special variable).
*reading-tag* (special variable).
*reading-tag-children* (special variable).
do-nothing (function).
inline-lisp-reader (function).
read-as-string (function).
read-attribute (function).
read-attribute-key (function).
read-attribute-value (function).
read-element-name (function).
read-html-tag (function).
read-html-tag-children (function).
read-html-tag-inner (function).
skip-while (function).
space-char-p (function).

Next: lsx/html/file-type.lisp, Previous: lsx/reader/file-type.lisp, Up: Lisp [Contents][Index]

3.1.4 `lsx/tag/file-type.lisp`

Source

Parent Component

lsx/tag (system).

Packages

lsx/tag.

Public Interface

deftag (macro).
h (function).

Internals

*user-tags* (special variable).
html-attributes-to-plist (function).

Next: lsx/file/file-type.lisp, Previous: lsx/tag/file-type.lisp, Up: Lisp [Contents][Index]

3.1.5 `lsx/html/file-type.lisp`

Source

Parent Component

lsx/html (system).

Packages

Public Interface

*auto-escape* (special variable).
attribute (structure).
attribute-name (reader).
(setf attribute-name) (writer).
attribute-value (reader).
(setf attribute-value) (writer).
danger-element (structure).
declaration-element (structure).
element (structure).
element-attributes (reader).
(setf element-attributes) (writer).
element-children (reader).
(setf element-children) (writer).
element-list (structure).
element-name (reader).
(setf element-name) (writer).
element-self-closing (reader).
(setf element-self-closing) (writer).
h* (function).
html-mode (function).
(setf html-mode) (function).
make-danger-element (function).
make-element (function).
print-object (method).
print-object (method).
print-object (method).
prologue (function).
render-object (generic function).
void-tag-p (function).

Internals

*escape-map* (special variable).
*html-mode* (special variable).
*void-tag-map* (special variable).
attribute-p (function).
copy-attribute (function).
copy-danger-element (function).
copy-declaration-element (function).
copy-element (function).
copy-element-list (function).
danger-element-element (reader).
(setf danger-element-element) (writer).
danger-element-p (function).
declaration-element-attributes (function).
(setf declaration-element-attributes) (function).
declaration-element-children (function).
(setf declaration-element-children) (function).
declaration-element-content (reader).
(setf declaration-element-content) (writer).
declaration-element-name (reader).
(setf declaration-element-name) (writer).
declaration-element-p (function).
declaration-element-self-closing (function).
(setf declaration-element-self-closing) (function).
declaration-element-void-tag (function).
(setf declaration-element-void-tag) (function).
element-list-elements (reader).
(setf element-list-elements) (writer).
element-list-p (function).
element-p (function).
element-void-tag (reader).
(setf element-void-tag) (writer).
make-attribute (function).
make-declaration-element (function).
make-element-list (function).
print-escaped-text (function).

Next: lsx/template/file-type.lisp, Previous: lsx/html/file-type.lisp, Up: Lisp [Contents][Index]

3.1.6 `lsx/file/file-type.lisp`

Source

Parent Component

lsx/file (system).

Packages

lsx/file.

Public Interface

read-lsx-file (function).
read-lsx-string (function).
with-lsx-syntax (macro).

Previous: lsx/file/file-type.lisp, Up: Lisp [Contents][Index]

3.1.7 `lsx/template/file-type.lisp`

Source

Parent Component

lsx/template (system).

Packages

Public Interface

deftemplate (macro).
direct-slot-definition-class (method).
initialize-instance (method).
initialize-instance (method).
reinitialize-instance (method).
reinitialize-instance (method).
render (generic function).
render-object (method).
template (class).
template-class (class).
validate-superclass (method).

Internals

define-initialize-instance (macro).
template-slot-class (class).

Next: Definitions, Previous: Files, Up: The lsx Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

lsx
lsx/html
lsx/reader
lsx/template
lsx/file
lsx/tag

Next: lsx/html, Previous: Packages, Up: Packages [Contents][Index]

4.1 `lsx`

Source

Nickname

lsx/main

Use List

common-lisp.
lsx/file.
lsx/html.
lsx/reader.
lsx/tag.
lsx/template.

Next: lsx/reader, Previous: lsx, Up: Packages [Contents][Index]

4.2 `lsx/html`

Source

Use List

common-lisp.

Used By List

Public Interface

*auto-escape* (special variable).
attribute (structure).
attribute-name (reader).
(setf attribute-name) (writer).
attribute-value (reader).
(setf attribute-value) (writer).
danger-element (structure).
declaration-element (structure).
element (structure).
element-attributes (reader).
(setf element-attributes) (writer).
element-children (reader).
(setf element-children) (writer).
element-list (structure).
element-name (reader).
(setf element-name) (writer).
element-self-closing (reader).
(setf element-self-closing) (writer).
h* (function).
html-mode (function).
(setf html-mode) (function).
make-danger-element (function).
make-element (function).
prologue (function).
render-object (generic function).
void-tag-p (function).

Internals

*escape-map* (special variable).
*html-mode* (special variable).
*void-tag-map* (special variable).
attribute-p (function).
copy-attribute (function).
copy-danger-element (function).
copy-declaration-element (function).
copy-element (function).
copy-element-list (function).
danger-element-element (reader).
(setf danger-element-element) (writer).
danger-element-p (function).
declaration-element-attributes (function).
(setf declaration-element-attributes) (function).
declaration-element-children (function).
(setf declaration-element-children) (function).
declaration-element-content (reader).
(setf declaration-element-content) (writer).
declaration-element-name (reader).
(setf declaration-element-name) (writer).
declaration-element-p (function).
declaration-element-self-closing (function).
(setf declaration-element-self-closing) (function).
declaration-element-void-tag (function).
(setf declaration-element-void-tag) (function).
element-list-elements (reader).
(setf element-list-elements) (writer).
element-list-p (function).
element-p (function).
element-void-tag (reader).
(setf element-void-tag) (writer).
make-attribute (function).
make-declaration-element (function).
make-element-list (function).
print-escaped-text (function).

Next: lsx/template, Previous: lsx/html, Up: Packages [Contents][Index]

4.3 `lsx/reader`

Source

Use List

common-lisp.

Used By List

Public Interface

disable-lsx-syntax (macro).
enable-lsx-syntax (macro).

Internals

%disable-lsx-syntax (function).
%enable-lsx-syntax (function).
*default-readtable* (special variable).
*previous-readtables* (special variable).
*reading-tag* (special variable).
*reading-tag-children* (special variable).
do-nothing (function).
inline-lisp-reader (function).
read-as-string (function).
read-attribute (function).
read-attribute-key (function).
read-attribute-value (function).
read-element-name (function).
read-html-tag (function).
read-html-tag-children (function).
read-html-tag-inner (function).
skip-while (function).
space-char-p (function).

Next: lsx/file, Previous: lsx/reader, Up: Packages [Contents][Index]

4.4 `lsx/template`

Source

Use List

common-lisp.

Used By List

Public Interface

deftemplate (macro).
render (generic function).
template (class).
template-class (class).

Internals

define-initialize-instance (macro).
template-slot-class (class).

Next: lsx/tag, Previous: lsx/template, Up: Packages [Contents][Index]

4.5 `lsx/file`

Source

Use List

common-lisp.

Used By List

Public Interface

read-lsx-file (function).
read-lsx-string (function).
with-lsx-syntax (macro).

Previous: lsx/file, Up: Packages [Contents][Index]

4.6 `lsx/tag`

Source

Use List

common-lisp.

Used By List

Public Interface

deftag (macro).
h (function).

Internals

*user-tags* (special variable).
html-attributes-to-plist (function).

Next: Indexes, Previous: Packages, Up: The lsx Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Macros
Ordinary functions
Generic functions
Standalone methods
Structures
Classes

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *auto-escape* ¶

Package: lsx/html.
Source: file-type.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

5.1.2 Macros

Macro: deftag (name lambda-list &body body) ¶

Package: lsx/tag.
Source: file-type.lisp.

Macro: deftemplate (name superclasses slot-definitions &rest class-options) ¶

Package: lsx/template.
Source: file-type.lisp.

Macro: disable-lsx-syntax () ¶

Package: lsx/reader.
Source: file-type.lisp.

Macro: enable-lsx-syntax () ¶

Package: lsx/reader.
Source: file-type.lisp.

Macro: with-lsx-syntax (&body body) ¶

Package: lsx/file.
Source: file-type.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.3 Ordinary functions

Reader: attribute-name (instance) ¶

Writer: (setf attribute-name) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: name.

Reader: attribute-value (instance) ¶

Writer: (setf attribute-value) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: value.

Reader: element-attributes (instance) ¶

Writer: (setf element-attributes) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: attributes.

Reader: element-children (instance) ¶

Writer: (setf element-children) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: children.

Reader: element-name (instance) ¶

Writer: (setf element-name) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: name.

Reader: element-self-closing (instance) ¶

Writer: (setf element-self-closing) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: self-closing.

Function: h (tag-name &optional attributes children) ¶

Package: lsx/tag.
Source: file-type.lisp.

Function: h* (tag-name &optional attributes children) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: html-mode () ¶

Package: lsx/html.
Source: file-type.lisp.

Function: (setf html-mode) () ¶

Package: lsx/html.
Source: file-type.lisp.

Function: make-danger-element (&key element) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: make-element (&key name attributes children self-closing void-tag) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: prologue () ¶

Package: lsx/html.
Source: file-type.lisp.

Function: read-lsx-file (file) ¶

Package: lsx/file.
Source: file-type.lisp.

Function: read-lsx-string (string) ¶

Package: lsx/file.
Source: file-type.lisp.

Function: void-tag-p (name) ¶

Package: lsx/html.
Source: file-type.lisp.

Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.4 Generic functions

Generic Function: render (template &rest args) ¶

Package

Source

Methods

Method: render ((template template-class) &rest args) ¶

Method: render ((template symbol) &rest args) ¶

Generic Function: render-object (object stream) ¶

Package

Source

Methods

Method: render-object ((object template) stream) ¶

Source: file-type.lisp.

Method: render-object ((object function) stream) ¶

Method: render-object ((object (eql t)) stream) ¶

Method: render-object ((object cons) stream) ¶

Method: render-object ((object null) stream) ¶

Method: render-object ((object number) stream) ¶

Method: render-object ((object string) stream) ¶

Method: render-object ((object declaration-element) stream) ¶

Method: render-object ((object danger-element) stream) ¶

Method: render-object ((object element-list) stream) ¶

Method: render-object ((attribute attribute) stream) ¶

Method: render-object ((element element) stream) ¶

Method: render-object (object stream) ¶

Method: render-object :around (object (stream (eql t))) ¶

Method: render-object :around (object (stream (eql nil))) ¶

Next: Structures, Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.5 Standalone methods

Method: direct-slot-definition-class ((class template-class) &key &allow-other-keys) ¶

Package: sb-mop.
Source: file-type.lisp.

Method: initialize-instance :after ((class template-class) &rest initargs &key direct-slots render &allow-other-keys) ¶

Source: file-type.lisp.

Method: initialize-instance :around ((class template-slot-class) &rest args &key name &allow-other-keys) ¶

Source: file-type.lisp.

Method: print-object ((object element-list) stream) ¶

Source: file-type.lisp.

Method: print-object ((object danger-element) stream) ¶

Source: file-type.lisp.

Method: print-object ((object element) stream) ¶

Source: file-type.lisp.

Method: reinitialize-instance :after ((class template-class) &rest initargs &key direct-slots render &allow-other-keys) ¶

Source: file-type.lisp.

Method: reinitialize-instance :around ((class template-slot-class) &rest args &key name &allow-other-keys) ¶

Source: file-type.lisp.

Method: validate-superclass ((class template-class) (super standard-class)) ¶

Package: sb-mop.
Source: file-type.lisp.

Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.6 Structures

Structure: attribute ¶

Package

Source

Direct superclasses

structure-object.

Direct methods

render-object.

Direct slots

Slot: name ¶

Type: string
Readers: attribute-name.
Writers: (setf attribute-name).

Slot: value ¶

Readers: attribute-value.
Writers: (setf attribute-value).

Structure: danger-element ¶

Package

Source

Direct superclasses

structure-object.

Direct methods

print-object.
render-object.

Direct slots

Slot: element ¶

Readers: danger-element-element.
Writers: (setf danger-element-element).

Structure: declaration-element ¶

Package

Source

Direct superclasses

element.

Direct methods

render-object.

Direct slots

Slot: name ¶

Type: string
Readers: declaration-element-name.
Writers: (setf declaration-element-name).

Slot: content ¶

Type: string
Readers: declaration-element-content.
Writers: (setf declaration-element-content).

Structure: element ¶

Package

Source

Direct superclasses

structure-object.

Direct subclasses

declaration-element.

Direct methods

print-object.
render-object.

Direct slots

Slot: name ¶

Type: string
Readers: element-name.
Writers: (setf element-name).

Slot: attributes ¶

Type: list
Readers: element-attributes.
Writers: (setf element-attributes).

Slot: children ¶

Type: list
Readers: element-children.
Writers: (setf element-children).

Slot: self-closing ¶

Type: boolean
Readers: element-self-closing.
Writers: (setf element-self-closing).

Slot: void-tag ¶

Type: boolean
Readers: element-void-tag.
Writers: (setf element-void-tag).

Structure: element-list ¶

Package

Source

Direct superclasses

structure-object.

Direct methods

print-object.
render-object.

Direct slots

Slot: elements ¶

Type: list
Readers: element-list-elements.
Writers: (setf element-list-elements).

Previous: Structures, Up: Public Interface [Contents][Index]

5.1.7 Classes

Class: template ¶

Package: lsx/template.
Source: file-type.lisp.
Direct methods: render-object.

Class: template-class ¶

Package

Source

Direct superclasses

standard-class.

Direct methods

direct-slot-definition-class.
initialize-instance.
reinitialize-instance.
render.
validate-superclass.

Direct slots

Slot: render ¶

Initargs: :render

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

5.2 Internals

Special variables
Macros
Ordinary functions
Classes

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *default-readtable* ¶

Package: lsx/reader.
Source: file-type.lisp.

Special Variable: *escape-map* ¶

Package: lsx/html.
Source: file-type.lisp.

Special Variable: *html-mode* ¶

Package: lsx/html.
Source: file-type.lisp.

Special Variable: *previous-readtables* ¶

Package: lsx/reader.
Source: file-type.lisp.

Special Variable: *reading-tag* ¶

Package: lsx/reader.
Source: file-type.lisp.

Special Variable: *reading-tag-children* ¶

Package: lsx/reader.
Source: file-type.lisp.

Special Variable: *user-tags* ¶

Package: lsx/tag.
Source: file-type.lisp.

Special Variable: *void-tag-map* ¶

Package: lsx/html.
Source: file-type.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Macros

Macro: define-initialize-instance (method-qualifier lambda-list &body body) ¶

Package: lsx/template.
Source: file-type.lisp.

Next: Classes, Previous: Macros, Up: Internals [Contents][Index]

5.2.3 Ordinary functions

Function: %disable-lsx-syntax () ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: %enable-lsx-syntax () ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: attribute-p (object) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: copy-attribute (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: copy-danger-element (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: copy-declaration-element (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: copy-element (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: copy-element-list (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Reader: danger-element-element (instance) ¶

Writer: (setf danger-element-element) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: element.

Function: danger-element-p (object) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: declaration-element-attributes (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: (setf declaration-element-attributes) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: declaration-element-children (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: (setf declaration-element-children) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Reader: declaration-element-content (instance) ¶

Writer: (setf declaration-element-content) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: content.

Reader: declaration-element-name (instance) ¶

Writer: (setf declaration-element-name) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: name.

Function: declaration-element-p (object) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: declaration-element-self-closing (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: (setf declaration-element-self-closing) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: declaration-element-void-tag (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: (setf declaration-element-void-tag) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: do-nothing (stream char) ¶

Package: lsx/reader.
Source: file-type.lisp.

Reader: element-list-elements (instance) ¶

Writer: (setf element-list-elements) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: elements.

Function: element-list-p (object) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: element-p (object) ¶

Package: lsx/html.
Source: file-type.lisp.

Reader: element-void-tag (instance) ¶

Writer: (setf element-void-tag) (instance) ¶

Package: lsx/html.
Source: file-type.lisp.
Target Slot: void-tag.

Function: html-attributes-to-plist (attributes) ¶

Package: lsx/tag.
Source: file-type.lisp.

Function: inline-lisp-reader (stream char) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: make-attribute (&key name value) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: make-declaration-element (&key name attributes children self-closing void-tag content) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: make-element-list (&key elements) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: print-escaped-text (value stream) ¶

Package: lsx/html.
Source: file-type.lisp.

Function: read-as-string (stream while) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: read-attribute (stream) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: read-attribute-key (stream) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: read-attribute-value (stream) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: read-element-name (stream) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: read-html-tag (stream char) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: read-html-tag-children (stream name attrs) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: read-html-tag-inner (stream) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: skip-while (stream while) ¶

Package: lsx/reader.
Source: file-type.lisp.

Function: space-char-p (char) ¶

Package: lsx/reader.
Source: file-type.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.4 Classes

Class: template-slot-class ¶

Package

Source