The buildnode Reference Manual

Table of Contents

The buildnode Reference Manual

This is the buildnode Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:50:58 2018 GMT+0.

1 Introduction

Buildnode: A libary to ease interaction with cxml:dom documents and nodes

Examples

Please see the examples directory for runable examples in each XML dialect

Primary Goals

• To define packages of functions that can generate specific xml dialects (see the src/tags directory and associated asd files).

• To add iterate drivers for various dom interactions

• To provide a reasonable base of funcationality for smoothing common dom interactions such as:

  • adding, removing, moving nodes
  • adjusting attributes and values
  • adjusting css classes

• To provide a flexible tool for programatically generating and manipulating various and sundry xml formats

Authors

• Acceleration.net Donate
• Russ Tyndall
• Nathan Bird
• Ryan Davis

;; Copyright (c) 2011 Russ Tyndall , Acceleration.net http://www.acceleration.net
;; All rights reserved.
;;
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions are
;; met:
;;
;;  - Redistributions of source code must retain the above copyright
;;    notice, this list of conditions and the following disclaimer.
;;
;;  - Redistributions in binary form must reproduce the above copyright
;;    notice, this list of conditions and the following disclaimer in the
;;    documentation and/or other materials provided with the distribution.
;;
;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
;; A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2 Systems

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

2.1 buildnode

Author

http://www.acceleration.net

License

BSD

Description

Tool for building up an xml dom nicely.

Dependencies

• cxml
• alexandria
• iterate
• flexi-streams
• split-sequence
• swank
• cl-interpol
• collectors
• closure-html
• cl-ppcre
• symbol-munger

Source

buildnode.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 buildnode/src

Parent

buildnode (system)

Location

src/

Components

• packages.lisp (file)
• dom-walker.lisp (file)
• buildnode.lisp (file)
• tags (module)

3.2 buildnode/src/tags

Dependency

buildnode.lisp (file)

Parent

src (module)

Location

src/tags/

Component

tags.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 buildnode.asd

Location

buildnode.asd

Systems

buildnode (system)

Packages

net.acceleration.buildnode.system

4.1.2 buildnode/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

net.acceleration.buildnode

4.1.3 buildnode/src/dom-walker.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/dom-walker.lisp

Exported Definitions

• dom-walk (generic function)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)

Internal Definitions

compute-attributes (function)

4.1.4 buildnode/src/buildnode.lisp

Dependency

dom-walker.lisp (file)

Parent

src (module)

Location

src/buildnode.lisp

Exported Definitions

• *cdata-script-blocks* (special variable)
• *document* (special variable)
• *html-compatibility-mode* (special variable)
• *namespace-prefix-map* (special variable)
• add-children (function)
• add-css-class (generic function)
• add-css-class (method)
• add-css-class-helper (function)
• add-css-classes (generic function)
• add-css-classes (method)
• append-nodes (function)
• create-complete-element (function)
• css-classes (generic function)
• css-classes (method)
• document-to-string (function)
• get-attribute (generic function)
• get-attribute (method)
• inner-html (function)
• insert-children (function)
• insert-html-string (function)
• insert-nodes (function)
• join-text (function)
• make-output-sink (function)
• make-scoped-dom-builder (function)
• push-new-attribute (function)
• push-new-attributes (function)
• remove-all-children (generic function)
• remove-all-children (method)
• remove-attribute (generic function)
• remove-attribute (method)
• remove-attributes (function)
• remove-css-class (generic function)
• remove-css-class (method)
• remove-css-classes (generic function)
• remove-css-classes (method)
• scoped-dom-builder (class)
• set-attribute (generic function)
• set-attribute (method)
• set-attributes (function)
• text-of-dom-snippet (generic function)
• text-of-dom-snippet (method)
• with-document (macro)
• with-document-to-file (macro)
• with-html-document (macro)
• with-html-document-to-file (macro)
• with-html-document-to-string (macro)
• with-html-snippet (macro)
• with-html5-document (macro)
• with-html5-document-to-file (macro)
• with-html5-document-to-string (macro)
• with-html5-snippet (macro)
• with-xhtml-document (macro)
• with-xhtml-document-to-file (macro)
• with-xhtml-frameset-document (macro)
• with-xhtml-snippet (macro)
• write-doc-to-file (function)
• write-document (function)

Internal Definitions

• %buffer-xml-output (function)
• %enstream (function)
• %merge-conts (function)
• %walk-dom-cont (function)
• %with-snippet (macro)
• *snippet-output-stream* (special variable)
• *xhtml1-transitional-extid* (special variable)
• +common-white-space-trimbag+ (special variable)
• attribute-uri (function)
• buffer-xml-output (macro)
• calc-complete-tagname (function)
• clause-for-in-dom-1 (macro)
• clause-for-in-dom-children-3 (macro)
• clause-for-in-dom-parents-2 (macro)
• depth-first-nodes (function)
• document-of (function)
• eval-always (macro)
• flatten-children (function)
• get-namespace-from-prefix (function)
• get-prefix (function)
• html-output? (generic function)
• html-output? (method)
• html-whitespace-remover (class)
• html5-capable-character-output-sink (function)
• html5-capable-character-output-sink (class)
• prepare-attribute-name (function)
• prepare-attribute-value (function)
• trim-and-nullify (function)
• trim-and-nullify! (macro)
• trim-whitespace (function)
• write-document-to-character-stream (function)
• write-document-to-octet-stream (function)
• write-normalized-document-to-sink (function)
• xmls-to-dom-snippet (function)

4.1.5 buildnode/src/tags/tags.lisp

Parent

tags (module)

Location

src/tags/tags.lisp

Exported Definitions

• ?processing-instruction (function)
• ?xml-stylesheet (function)
• cdata (function)
• def-tag-node (macro)
• dom-comment (function)
• script-block (function)
• stylesheet-block (function)

Internal Definitions

• *tags-indentation-hints* (special variable)
• do-def-tag-node (function)
• make-script-block-fn (function)
• make-script-fn (function)

5 Packages

Packages are listed by definition order.

5.1 net.acceleration.buildnode.system

Source

buildnode.asd

Use List

• asdf/interface
• common-lisp

5.2 net.acceleration.buildnode

Source

packages.lisp (file)

Nickname

buildnode

Use List

• iterate
• cxml
• common-lisp

Exported Definitions

• *cdata-script-blocks* (special variable)
• *document* (special variable)
• *html-compatibility-mode* (special variable)
• *namespace-prefix-map* (special variable)
• ?processing-instruction (function)
• ?xml-stylesheet (function)
• add-children (function)
• add-css-class (generic function)
• add-css-class (method)
• add-css-class-helper (function)
• add-css-classes (generic function)
• add-css-classes (method)
• append-nodes (function)
• cdata (function)
• create-complete-element (function)
• css-classes (generic function)
• css-classes (method)
• def-tag-node (macro)
• document-to-string (function)
• dom-comment (function)
• dom-walk (generic function)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• dom-walk (method)
• get-attribute (generic function)
• get-attribute (method)
• inner-html (function)
• insert-children (function)
• insert-html-string (function)
• insert-nodes (function)
• join-text (function)
• make-output-sink (function)
• make-scoped-dom-builder (function)
• push-new-attribute (function)
• push-new-attributes (function)
• remove-all-children (generic function)
• remove-all-children (method)
• remove-attribute (generic function)
• remove-attribute (method)
• remove-attributes (function)
• remove-css-class (generic function)
• remove-css-class (method)
• remove-css-classes (generic function)
• remove-css-classes (method)
• scoped-dom-builder (class)
• script-block (function)
• set-attribute (generic function)
• set-attribute (method)
• set-attributes (function)
• stylesheet-block (function)
• text-of-dom-snippet (generic function)
• text-of-dom-snippet (method)
• with-document (macro)
• with-document-to-file (macro)
• with-html-document (macro)
• with-html-document-to-file (macro)
• with-html-document-to-string (macro)
• with-html-snippet (macro)
• with-html5-document (macro)
• with-html5-document-to-file (macro)
• with-html5-document-to-string (macro)
• with-html5-snippet (macro)
• with-xhtml-document (macro)
• with-xhtml-document-to-file (macro)
• with-xhtml-frameset-document (macro)
• with-xhtml-snippet (macro)
• write-doc-to-file (function)
• write-document (function)

Internal Definitions

• %buffer-xml-output (function)
• %enstream (function)
• %merge-conts (function)
• %walk-dom-cont (function)
• %with-snippet (macro)
• *snippet-output-stream* (special variable)
• *tags-indentation-hints* (special variable)
• *xhtml1-transitional-extid* (special variable)
• +common-white-space-trimbag+ (special variable)
• attribute-uri (function)
• buffer-xml-output (macro)
• calc-complete-tagname (function)
• clause-for-in-dom-1 (macro)
• clause-for-in-dom-children-3 (macro)
• clause-for-in-dom-parents-2 (macro)
• compute-attributes (function)
• depth-first-nodes (function)
• do-def-tag-node (function)
• document-of (function)
• eval-always (macro)
• flatten-children (function)
• get-namespace-from-prefix (function)
• get-prefix (function)
• html-output? (generic function)
• html-output? (method)
• html-whitespace-remover (class)
• html5-capable-character-output-sink (function)
• html5-capable-character-output-sink (class)
• make-script-block-fn (function)
• make-script-fn (function)
• prepare-attribute-name (function)
• prepare-attribute-value (function)
• trim-and-nullify (function)
• trim-and-nullify! (macro)
• trim-whitespace (function)
• write-document-to-character-stream (function)
• write-document-to-octet-stream (function)
• write-normalized-document-to-sink (function)
• xmls-to-dom-snippet (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *cdata-script-blocks*

Should script blocks have a cdata?

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *document*

A variable that holds the current document that is being built. see with-document.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *html-compatibility-mode*

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *namespace-prefix-map*

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

6.1.2 Macros

Macro: def-tag-node PACKAGE NAME NAMESPACE DOCSTRING &optional FN-NAME

Defines a tag function in the package with the name and prefix specified
for example: :net.acceleration.xul "box" "xul" will create a function #’box in the :net.acceleration.xul
lisp namespace. When this function is called it will create a ’xul:box’ node in the xmlns provided in the namespace param

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Macro: with-document &body CHILLINS

(with-document ( a bunch of child nodes of the document )) –> cxml:dom document Creates an environment in which the special variable *document* is available a document is necessary to create dom nodes and the document the nodes end up on must be the document on which they were created. At the end of the form, the complete document is returned

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-document-to-file FILENAME &body CHILLINS

Creates a document block with-document upon which to add the chillins (southern for children). When the document is complete, it is written out to the specified file.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-document &body BODY

(with-html-document ( a bunch of child nodes of the document )) –> cxml:dom document Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on must be the document on which they were created. At the end of the form, the complete document is returned.
This sets the doctype to be html 4.01 strict.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-document-to-file (FILENAME) &body BODY

Creates an html-document, writes out the results to filename

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-document-to-string () &body BODY

trys to output a string containing all

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-snippet (&optional STREAM SINK) &body BODY

builds a little piece of html-dom and renders that to a string / stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-document &body BODY

(with-html5-document ( a bunch of child nodes of the document )) –> cxml:dom document Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on must be the document on which they were created. At the end of the form, the complete document is returned.
This sets the doctype to be html5 compatible <!DOCTYPE html>.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-document-to-file (FILENAME) &body BODY

Creates an html-document, writes out the results to filename

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-document-to-string () &body BODY

trys to output a string containing all

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-snippet (&optional STREAM SINK) &body BODY

builds a little piece of html-dom and renders that to a string / stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-document &body CHILLINS

(with-xhtml-document ( a bunch of child nodes of the document )) –> cxml:dom document Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on must be the document on which they were created. At the end of the form, the complete document is returned.
This sets the doctype to be xhtml transitional.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-document-to-file FILENAME &body CHILLINS

Creates a document block with-document upon which to add the chillins (southern for children). When the document is complete, it is written out to the specified file.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-frameset-document &body CHILLINS

(with-xhtml-document ( a bunch of child nodes of the document )) –> cxml:dom document Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on must be the document on which they were created. At the end of the form, the complete document is returned.
This sets the doctype to be xhtml transitional.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-snippet (&optional STREAM SINK) &body BODY

builds a little piece of xhtml-dom and renders that to a string / stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

6.1.3 Functions

Function: ?processing-instruction TARGET DATA

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: ?xml-stylesheet HREF &optional TYPE

adds an xml-stylesheet processing instruction to the cxml:dom document bound to the special variable *document*

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: add-children ELEM &rest KIDS &aux LIST? DOC ELEM-LIST

adds some kids to an element and return that element alias for append-nodes

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: add-css-class-helper &rest NEW-CLASSES

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: append-nodes TO-LOCATION &rest CHILLINS

appends a bunch of dom-nodes (chillins) to the location specified alias of add-children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: cdata DATA

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: create-complete-element DOCUMENT NAMESPACE TAGNAME ATTRIBUTES CHILDREN &optional NAMESPACE-PREFIX-MAP

Creates an xml element out of all the necessary components.
If the tagname does not contain a prefix, then one is added based on the namespace-prefix map.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: document-to-string DOC

Return a string representation of a document.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: dom-comment TEXT

Insert a dom comment into the current *document*

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: inner-html STRING &optional TAG NAMESPACE-URI DTD REMOVE-WHITESPACE?

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: insert-children ELEM IDX &rest KIDS

insert a bunch of dom-nodes (kids) to the location specified alias for insert-nodes

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: insert-html-string STRING &key TAG NAMESPACE-URI DTD REMOVE-WHITESPACE?

Parses a string containing a well formed html snippet
into dom nodes inside of a newly created node.

(Based loosely around the idea of setting the javascript innerHTML property)

Will wrap the input in a tag (which is neccessary from CXMLs perspective) can validate the html against a DTD if one is passed, can use *xhtml1-transitional-extid* for example.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: insert-nodes TO-LOCATION INDEX &rest CHILLINS

insert a bunch of dom-nodes (chillins) to the location specified alias of insert-children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: join-text TEXT &key DELIMITER

Like joins trees of lists strings and dom nodes into a single string possibly with a delimiter ignores nil and empty string

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: make-output-sink STREAM &key CANONICAL INDENTATION CHAR-P

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: make-scoped-dom-builder NODE

Returns a new scoped dom builder, scoped to the passed in node. Nodes built with this builder will be added to the passed in node

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: push-new-attribute ELEM ATTRIBUTE VALUE

if the attribute is not on the element then put it there with the specified value, returns the elem and whether or not the attribute was set

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: push-new-attributes ELEM &rest ATTRIBUTE-P-LIST

for each attribute in the plist push-new into the attributes list of the elem, returns the elem

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: remove-attributes ELEM &rest ATTRIBUTES

removes an attribute and passes the elem through, returns the elem

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: script-block FN LIST-OF-URLS

given a list of urls, will build a list of script nodes pointing to the appropriate urls. Pass in #’xul:script or #’xhtml:script as the first argument

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: set-attributes ELEM &rest ATTRIBUTE-P-LIST

set-attribute for each attribute specified in the plist, returns the elem

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: stylesheet-block LIST &optional TYPE

given a list of urls, will build a list of ?xml-stylesheet nodes pointing to the appropriate urls

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: write-doc-to-file DOC FILENAME

Binary write-out a document. will create/overwrite any existing file named the same.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-document DOCUMENT &optional OUT-STREAM

Write the document to the designated out-stream, or *standard-ouput* by default.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

6.1.4 Generic functions

Generic Function: add-css-class ELEMENT NEW-CLASS

Adds a new css class to the element and returns the element

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: add-css-class (EL element) NEW-CLASS

Generic Function: add-css-classes COMP &rest CLASSES

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: add-css-classes COMP &rest CLASSES

Generic Function: css-classes O

Returns a list of css classes (space separated names in the ’class’ attribute)

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: css-classes O

Generic Function: dom-walk HANDLER VALUE &key INCLUDE-XMLNS-ATTRIBUTES INCLUDE-DOCTYPE INCLUDE-DEFAULT-VALUES RECODE &allow-other-keys

An in order traversal of a subset of the dom, that calls the appropriate sax events

Package

net.acceleration.buildnode

Source

dom-walker.lisp (file)

Methods

Method: dom-walk HANDLER (N entity-reference) &key &allow-other-keys

Method: dom-walk HANDLER (N processing-instruction) &key &allow-other-keys

Method: dom-walk HANDLER (N comment) &key &allow-other-keys

Method: dom-walk HANDLER (N text) &key &allow-other-keys &aux PN PARENT

Method: dom-walk HANDLER (N cdata-section) &key &allow-other-keys

Method: dom-walk HANDLER (N element) &key INCLUDE-XMLNS-ATTRIBUTES INCLUDE-DOCTYPE INCLUDE-DEFAULT-VALUES &allow-other-keys

Method: dom-walk HANDLER (DOCUMENT document) &key INCLUDE-XMLNS-ATTRIBUTES INCLUDE-DOCTYPE INCLUDE-DEFAULT-VALUES RECODE

Generic Function: get-attribute ELEM ATTRIBUTE

Gets the value of an attribute on an element if the attribute does not exist return nil

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: get-attribute ELEM ATTRIBUTE

Generic Function: remove-all-children EL

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: remove-all-children (IT element)

Generic Function: remove-attribute ELEM ATTRIBUTE

removes an attribute and passes the elem through, returns the elem If the attribute does not exist, simply skip it

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: remove-attribute ELEM ATTRIBUTE

Generic Function: remove-css-class EL NEW-CLASS

Removes a css class from the elements and returns the element

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: remove-css-class (EL element) NEW-CLASS

Generic Function: remove-css-classes COMP &rest CLASSES

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: remove-css-classes COMP &rest CLASSES

Generic Function: set-attribute ELEM ATTRIBUTE VALUE

Sets an attribute and passes the elem through, returns the elem. If value is nil, removes the attribute

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: set-attribute ELEM ATTRIBUTE VALUE

Generic Function: text-of-dom-snippet EL &optional SPLICE STREAM

get all of the textnodes of a dom:element and return that string with splice between each character

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: text-of-dom-snippet EL &optional SPLICE STREAM

6.1.5 Classes

Class: scoped-dom-builder ()

A dom builder that builds inside of another dom-node

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Direct superclasses

dom-builder (class)

Direct methods

• unescaped (method)
• end-document (method)
• start-document (method)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *snippet-output-stream*

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *tags-indentation-hints*

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Special Variable: *xhtml1-transitional-extid*

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: +common-white-space-trimbag+

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

6.2.2 Macros

Macro: %with-snippet (TYPE &optional STREAM SINK) &body BODY

helper to define with-html-snippet and with-xhtml-snippet

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: buffer-xml-output (&optional STREAM SINK) &body BODY

buffers out sax:events to a sting

xml parameters like <param:foo param:type="string"><div>bar</div></param:foo> are requested to be strings (presumably for string processing)

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: clause-for-in-dom-1 &key (FOR NODE) (IN-DOM TREE) GENERATE

A driver that will walk over every node in a set of dom trees

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: clause-for-in-dom-children-3 &key (FOR KID) (IN-DOM-CHILDREN NODES) GENERATE

iterates over the children of a dom node as per flatten-children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: clause-for-in-dom-parents-2 &key (FOR PARENT) (IN-DOM-PARENTS NODE) GENERATE

A driver that will return each parent node up from a starting node until we get to a null parent

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: eval-always &body BODY

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: trim-and-nullify! &rest PLACES

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

6.2.3 Functions

Function: %buffer-xml-output STREAM SINK BODY-FN

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: %enstream STREAM CONTENT-FN

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: %merge-conts &rest CONTS

Takes many continuations and makes a single continuation that iterates through each of the arguments in turn

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: %walk-dom-cont TREE

calls this on a dom tree (or tree list) and you get back
a node and a continuation function.

repeated calls to the continuation each return the next node and the next walker continuation

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: attribute-uri ATTRIBUTE

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: calc-complete-tagname NAMESPACE BASE-TAG NAMESPACE-PREFIX-MAP

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: compute-attributes ELEMENT XMLNSP DEFAULTP

Package

net.acceleration.buildnode

Source

dom-walker.lisp (file)

Function: depth-first-nodes TREE

get a list of the nodes in a depth first traversal of the dom trees

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: do-def-tag-node PACKAGE NAME NAMESPACE DOCSTRING &optional FN-NAME

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: document-of EL

Returns the document of a given node (or the document if passed in)

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: flatten-children KIDS &optional DOC

Handles flattening nested lists and vectors of nodes into a single flat list of children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: get-namespace-from-prefix PREFIX &optional NAMESPACE-PREFIX-MAP

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: get-prefix NAMESPACE &optional NAMESPACE-PREFIX-MAP

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: html5-capable-character-output-sink STREAM &key CANONICAL INDENTATION ENCODING

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: make-script-block-fn FN-SCRIPT JS

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: make-script-fn FN-SCRIPT URL

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: prepare-attribute-name ATTRIBUTE

Prepares an attribute name for output to html by coercing to strings

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: prepare-attribute-value VALUE

prepares a value for html out put by coercing to a string

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: trim-and-nullify S

trims the whitespace from a string returning nil
if trimming produces an empty string or the string ’nil’

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: trim-whitespace S

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-document-to-character-stream DOCUMENT CHAR-STREAM

writes a cxml:dom document to a character stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-document-to-octet-stream DOCUMENT OCTET-STREAM

writes a cxml:dom document to a character stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-normalized-document-to-sink DOCUMENT STREAM-SINK

writes a cxml:dom document to the given stream-sink,
passing the document through a namespace normalizer first, and possibly a html-compatibility-sink if *html-compatibility-mode* is set

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: xmls-to-dom-snippet SXML &key NAMESPACE

Given a snippet of xmls, return a new dom snippet of that content

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

6.2.4 Generic functions

Generic Function: html-output? DOC

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods

Method: html-output? DOC

6.2.5 Classes

Class: html-whitespace-remover ()

a stream filter to remove nodes that are entirely whitespace

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Direct superclasses

sax-proxy (class)

Direct methods

characters (method)

Class: html5-capable-character-output-sink ()

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Direct superclasses

sink (class)

Direct methods

start-document (method)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types