The monkeylib-html Reference Manual

Table of Contents

The monkeylib-html Reference Manual

This is the monkeylib-html Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:26:28 2020 GMT+0.

1 Systems

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

1.1 monkeylib-html

Author

Peter Seibel <peter@gigamonkeys.com>

License

BSD

Description

HTML generation

Version

1.0

Dependencies

• com.gigamonkeys.macro-utilities
• com.gigamonkeys.test-framework
• com.gigamonkeys.pathnames
• com.gigamonkeys.utilities
• monkeylib-text-output
• monkeylib-text-languages

Source

monkeylib-html.asd (file)

Components

• packages.lisp (file)
• string-escaping.lisp (file)
• html.lisp (file)
• html-tests.lisp (file)
• xml.lisp (file)
• xml-macros.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 monkeylib-html.asd

Location

monkeylib-html.asd

Systems

monkeylib-html (system)

2.1.2 monkeylib-html/packages.lisp

Parent

monkeylib-html (system)

Location

packages.lisp

Packages

monkeylib-html

2.1.3 monkeylib-html/string-escaping.lisp

Dependency

packages.lisp (file)

Parent

monkeylib-html (system)

Location

string-escaping.lisp

Internal Definitions

• escape (function)
• escape-char (function)

2.1.4 monkeylib-html/html.lisp

Dependencies

• packages.lisp (file)
• string-escaping.lisp (file)
• xml.lisp (file)

Parent

monkeylib-html (system)

Location

html.lisp

Exported Definitions

• define-html-macro (macro)
• define-html-special-operator (macro)
• emit-html (function)
• emit-xhtml (function)
• html (macro)
• html (class)
• with-html-output (macro)
• xhtml (macro)
• xhtml (class)

Internal Definitions

• emit-close-tag (method)
• emit-open-tag (method)
• empty-element-p (function)

2.1.5 monkeylib-html/html-tests.lisp

Dependencies

• packages.lisp (file)
• html.lisp (file)

Parent

monkeylib-html (system)

Location

html-tests.lisp

Internal Definitions

• *testfiles* (special variable)
• html->string (function)
• look (function)
• new-test (function)
• new-tests (function)
• next-number (function)
• ok (function)
• test-file (function)

2.1.6 monkeylib-html/xml.lisp

Dependency

packages.lisp (file)

Parent

monkeylib-html (system)

Location

xml.lisp

Exported Definitions

• define-xml-language (macro)
• emit-xml (function)
• xml (macro)
• xml (class)

Internal Definitions

• *attribute-escapes* (special variable)
• *element-escapes* (special variable)
• block-element-p (function)
• cons-form-p (function)
• define-xml-macro (macro)
• define-xml-special-operator (macro)
• emit-attributes (generic function)
• emit-attributes (method)
• emit-close-tag (generic function)
• emit-close-tag (method)
• emit-element-body (generic function)
• emit-element-body (method)
• emit-open-tag (generic function)
• emit-open-tag (method)
• environment-value (function)
• escapes (function)
• generate-xml-macro-with-attributes (function)
• in-attribute (function)
• in-attribute-p (function)
• name-converter (method)
• (setf name-converter) (method)
• new-env (function)
• non-empty-element-p (function)
• paragraph-element-p (function)
• parse-cons-form (function)
• parse-explicit-attributes-sexp (function)
• parse-implicit-attributes-sexp (function)
• parse-xml-macro-lambda-list (function)
• preserve-whitespace-p (function)
• process-cons-sexp-xml (function)

2.1.7 monkeylib-html/xml-macros.lisp

Dependencies

• packages.lisp (file)
• xml.lisp (file)

Parent

monkeylib-html (system)

Location

xml-macros.lisp

3 Packages

Packages are listed by definition order.

3.1 monkeylib-html

Source

packages.lisp (file)

Use List

• monkeylib-text-languages
• monkeylib-text-output
• com.gigamonkeys.pathnames
• com.gigamonkeys.test
• com.gigamonkeys.utilities
• common-lisp

Exported Definitions

• define-html-macro (macro)
• define-html-special-operator (macro)
• define-xml-language (macro)
• emit-html (function)
• emit-xhtml (function)
• emit-xml (function)
• html (macro)
• html (class)
• with-html-output (macro)
• xhtml (macro)
• xhtml (class)
• xml (macro)
• xml (class)

Internal Definitions

• *attribute-escapes* (special variable)
• *element-escapes* (special variable)
• *testfiles* (special variable)
• block-element-p (function)
• cons-form-p (function)
• define-xml-macro (macro)
• define-xml-special-operator (macro)
• emit-attributes (generic function)
• emit-attributes (method)
• emit-close-tag (generic function)
• emit-close-tag (method)
• emit-close-tag (method)
• emit-element-body (generic function)
• emit-element-body (method)
• emit-open-tag (generic function)
• emit-open-tag (method)
• emit-open-tag (method)
• empty-element-p (function)
• environment-value (function)
• escape (function)
• escape-char (function)
• escapes (function)
• generate-xml-macro-with-attributes (function)
• html->string (function)
• in-attribute (function)
• in-attribute-p (function)
• look (function)
• name-converter (generic function)
• name-converter (method)
• (setf name-converter) (method)
• (setf name-converter) (generic function)
• new-env (function)
• new-test (function)
• new-tests (function)
• next-number (function)
• non-empty-element-p (function)
• ok (function)
• paragraph-element-p (function)
• parse-cons-form (function)
• parse-explicit-attributes-sexp (function)
• parse-implicit-attributes-sexp (function)
• parse-xml-macro-lambda-list (function)
• preserve-whitespace-p (function)
• process-cons-sexp-xml (function)
• test-file (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: define-html-macro NAME (&rest PARAMETERS) &body BODY

Package

monkeylib-html

Source

html.lisp (file)

Macro: define-html-special-operator NAME (LANGUAGE PROCESSOR &rest OTHER-PARAMETERS) &body BODY

Package

monkeylib-html

Source

html.lisp (file)

Macro: define-xml-language NAME &body ELEMENT-DEFS

Package

monkeylib-html

Source

xml.lisp (file)

Macro: html &body BODY

Package

monkeylib-html

Source

html.lisp (file)

Macro: with-html-output (STREAM &key PRETTY) &body BODY

Package

monkeylib-html

Source

html.lisp (file)

Macro: xhtml &body BODY

Package

monkeylib-html

Source

html.lisp (file)

Macro: xml &body BODY

Package

monkeylib-html

Source

xml.lisp (file)

4.1.2 Functions

Function: emit-html SEXP

Package

monkeylib-html

Source

html.lisp (file)

Function: emit-xhtml SEXP

Package

monkeylib-html

Source

html.lisp (file)

Function: emit-xml SEXP

Package

monkeylib-html

Source

xml.lisp (file)

4.1.3 Classes

Class: html ()

Package

monkeylib-html

Source

html.lisp (file)

Direct superclasses

xml (class)

Direct methods

• top-level-environment (method)
• emit-close-tag (method)
• emit-open-tag (method)
• initialize-instance (method)

Direct Default Initargs

Initarg	Value
:output-file-type	"html"
:input-readtable	(copy-readtable)

Class: xhtml ()

Package

monkeylib-html

Source

html.lisp (file)

Direct superclasses

xml (class)

Direct methods

top-level-environment (method)

Class: xml ()

Package

monkeylib-html

Source

xml.lisp (file)

Direct superclasses

language (class)

Direct subclasses

• html (class)
• xhtml (class)

Direct methods

• comment (method)
• top-level-environment (method)
• emit-close-tag (method)
• emit-element-body (method)
• emit-attributes (method)
• emit-open-tag (method)
• process-sexp (method)
• embeddable-value-form (method)
• sexp-form-p (method)
• identifier (method)
• initialize-instance (method)
• name-converter (method)
• name-converter (method)

Direct slots

Slot: name-converter

Initargs

:name-converter

Initform

(function string-downcase)

Readers

name-converter (generic function)

Writers

(setf name-converter) (generic function)

Direct Default Initargs

Initarg	Value
:input-readtable	(monkeylib-text-languages:case-preserving-readtable)
:input-package	(find-package :keyword)
:output-file-type	"xml"

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *attribute-escapes*

Package

monkeylib-html

Source

xml.lisp (file)

Special Variable: *element-escapes*

Package

monkeylib-html

Source

xml.lisp (file)

Special Variable: *testfiles*

Package

monkeylib-html

Source

html-tests.lisp (file)

4.2.2 Macros

Macro: define-xml-macro NAME (&rest PARAMETERS) &body BODY

Package

monkeylib-html

Source

xml.lisp (file)

Macro: define-xml-special-operator NAME (LANGUAGE PROCESSOR &rest OTHER-PARAMETERS) &body BODY

Package

monkeylib-html

Source

xml.lisp (file)

4.2.3 Functions

Function: block-element-p TAG ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: cons-form-p FORM &optional TEST

Package

monkeylib-html

Source

xml.lisp (file)

Function: empty-element-p TAG ENV

Package

monkeylib-html

Source

html.lisp (file)

Function: environment-value KEY ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: escape IN TO-ESCAPE

Package

monkeylib-html

Source

string-escaping.lisp (file)

Function: escape-char CHAR

Package

monkeylib-html

Source

string-escaping.lisp (file)

Function: escapes ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: generate-xml-macro-with-attributes NAME MACRO-SYMBOL ATTRIBUTES PARAMETERS BODY

Package

monkeylib-html

Source

xml.lisp (file)

Function: html->string SEXP

Package

monkeylib-html

Source

html-tests.lisp (file)

Function: in-attribute ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: in-attribute-p ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: look NUMBER

Package

monkeylib-html

Source

html-tests.lisp (file)

Function: new-env KEY VALUE ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: new-test SEXP &optional NUMBER

Package

monkeylib-html

Source

html-tests.lisp (file)

Function: new-tests ()

Package

monkeylib-html

Source

html-tests.lisp (file)

Function: next-number ()

Package

monkeylib-html

Source

html-tests.lisp (file)

Function: non-empty-element-p TAG ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: ok NUMBER

Package

monkeylib-html

Source

html-tests.lisp (file)

Function: paragraph-element-p TAG ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: parse-cons-form SEXP

Package

monkeylib-html

Source

xml.lisp (file)

Function: parse-explicit-attributes-sexp SEXP

Package

monkeylib-html

Source

xml.lisp (file)

Function: parse-implicit-attributes-sexp SEXP

Package

monkeylib-html

Source

xml.lisp (file)

Function: parse-xml-macro-lambda-list ARGS

Package

monkeylib-html

Source

xml.lisp (file)

Function: preserve-whitespace-p TAG ENV

Package

monkeylib-html

Source

xml.lisp (file)

Function: process-cons-sexp-xml LANGUAGE PROCESSOR FORM ENVIRONMENT

Package

monkeylib-html

Source

xml.lisp (file)

Function: test-file INPUT

Package

monkeylib-html

Source

html-tests.lisp (file)

4.2.4 Generic functions

Generic Function: emit-attributes LANGUAGE PROCESSOR ATTRIBUTES ENVIRONMENT

Package

monkeylib-html

Source

xml.lisp (file)

Methods

Method: emit-attributes (LANGUAGE xml) PROCESSOR ATTRIBUTES ENVIRONMENT

Generic Function: emit-close-tag LANGUAGE PROCESSOR TAG BODY-P ENVIRONMENT

Package

monkeylib-html

Source

xml.lisp (file)

Methods

Method: emit-close-tag (LANGUAGE html) PROCESSOR TAG BODY-P ENVIRONMENT

Source

html.lisp (file)

Method: emit-close-tag (LANGUAGE xml) PROCESSOR TAG BODY-P ENVIRONMENT

Generic Function: emit-element-body LANGUAGE PROCESSOR TAG BODY ENVIRONMENT

Package

monkeylib-html

Source

xml.lisp (file)

Methods

Method: emit-element-body (LANGUAGE xml) PROCESSOR TAG BODY ENVIRONMENT

Generic Function: emit-open-tag LANGUAGE PROCESSOR TAG BODY-P ATTRIBUTES ENVIRONMENT

Package

monkeylib-html

Source

xml.lisp (file)

Methods

Method: emit-open-tag (LANGUAGE html) PROCESSOR TAG BODY-P ATTRIBUTES ENVIRONMENT

Source

html.lisp (file)

Method: emit-open-tag (LANGUAGE xml) PROCESSOR TAG BODY-P ATTRIBUTES ENVIRONMENT

Generic Function: name-converter OBJECT

Generic Function: (setf name-converter) NEW-VALUE OBJECT

Package

monkeylib-html

Methods

Method: name-converter (XML xml)

automatically generated reader method

Source

xml.lisp (file)

Method: (setf name-converter) NEW-VALUE (XML xml)

automatically generated writer method

Source

xml.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types