This is the plump Reference Manual, version 2.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:18:28 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
plump
An XML / XHTML / HTML parser that aims to be as lenient as possible.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/plump.git)
zlib
2.0.0
array-utils
(system).
documentation-utils
(system).
package.lisp
(file).
entities.lisp
(file).
lexer.lisp
(file).
tag-dispatcher.lisp
(file).
dom.lisp
(file).
parser.lisp
(file).
processing.lisp
(file).
special-tags.lisp
(file).
documentation.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
plump/plump.asd
plump/package.lisp
plump/entities.lisp
plump/lexer.lisp
plump/tag-dispatcher.lisp
plump/dom.lisp
plump/parser.lisp
plump/processing.lisp
plump/special-tags.lisp
plump/documentation.lisp
plump/entities.lisp
package.lisp
(file).
plump
(system).
*entity-map*
(special variable).
allowed-char-p
(function).
decode-entities
(function).
discouraged-char-p
(function).
discouraged-xml-character
(condition).
encode-entities
(function).
faulty-char
(reader method).
faulty-char
(reader method).
(setf faulty-char)
(writer method).
(setf faulty-char)
(writer method).
invalid-xml-character
(condition).
translate-entity
(function).
write-encode-char
(function).
%encode-entities
(function).
*alpha-chars*
(special variable).
plump/lexer.lisp
entities.lisp
(file).
plump
(system).
*index*
(special variable).
*length*
(special variable).
*string*
(special variable).
advance
(function).
advance-n
(function).
consume
(function).
consume-until
(function).
define-matcher
(macro).
make-matcher
(macro).
matcher-and
(function).
matcher-any
(macro).
matcher-character
(function).
matcher-find
(function).
matcher-next
(function).
matcher-not
(function).
matcher-or
(function).
matcher-prev
(function).
matcher-range
(function).
matcher-string
(function).
peek
(function).
unread
(function).
unread-n
(function).
with-lexer-environment
(macro).
*matchers*
(special variable).
plump/tag-dispatcher.lisp
lexer.lisp
(file).
plump
(system).
*all-tag-dispatchers*
(special variable).
*html-tags*
(special variable).
*tag-dispatchers*
(special variable).
*xml-tags*
(special variable).
define-tag-dispatcher
(macro).
define-tag-parser
(macro).
define-tag-printer
(macro).
define-wildcard-dispatcher
(macro).
do-tag-parsers
(macro).
do-tag-printers
(macro).
remove-tag-dispatcher
(function).
(setf tag-dispatcher)
(setf expander).
tag-dispatcher
(function).
tag-dispatcher
(structure).
copy-tag-dispatcher
(function).
make-tag-dispatcher
(function).
tag-dispatcher-name
(reader).
(setf tag-dispatcher-name)
(writer).
tag-dispatcher-p
(function).
tag-dispatcher-parser
(reader).
(setf tag-dispatcher-parser)
(writer).
tag-dispatcher-printer
(reader).
(setf tag-dispatcher-printer)
(writer).
tag-dispatcher-test
(reader).
(setf tag-dispatcher-test)
(writer).
plump/dom.lisp
tag-dispatcher.lisp
(file).
plump
(system).
*stream*
(special variable).
append-child
(function).
attribute
(function).
(setf attribute)
(function).
attributes
(reader method).
attributes
(reader method).
(setf attributes)
(writer method).
(setf attributes)
(writer method).
cdata
(class).
cdata-p
(function).
child-elements
(function).
child-node
(class).
child-node-p
(function).
child-position
(function).
children
(reader method).
(setf children)
(writer method).
clear
(function).
clone-attributes
(function).
clone-children
(function).
clone-node
(generic function).
comment
(class).
comment-p
(function).
doctype
(reader method).
(setf doctype)
(writer method).
doctype
(class).
doctype-p
(function).
element
(class).
element-p
(function).
element-position
(function).
ensure-attribute-map
(function).
ensure-child-array
(function).
family
(function).
family-elements
(function).
first-child
(function).
first-element
(function).
fulltext-element
(class).
fulltext-element-p
(function).
get-attribute
(function).
get-element-by-id
(function).
get-elements-by-tag-name
(function).
has-attribute
(function).
has-child-nodes
(function).
insert-after
(function).
insert-before
(function).
last-child
(function).
last-element
(function).
make-attribute-map
(function).
make-cdata
(function).
make-child-array
(function).
make-comment
(function).
make-doctype
(function).
make-element
(function).
make-fulltext-element
(function).
make-processing-instruction
(function).
make-root
(function).
make-text-node
(function).
make-xml-header
(function).
nesting-node
(class).
nesting-node-p
(function).
next-element
(function).
next-sibling
(function).
node
(class).
node-p
(function).
parent
(reader method).
(setf parent)
(writer method).
prepend-child
(function).
previous-element
(function).
previous-sibling
(function).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
processing-instruction
(class).
processing-instruction-p
(function).
remove-attribute
(function).
remove-child
(function).
render-text
(function).
replace-child
(function).
root
(class).
root-p
(function).
serialize
(function).
serialize-object
(generic function).
set-attribute
(function).
sibling-elements
(function).
siblings
(function).
splice
(function).
strip
(function).
tag-name
(reader method).
tag-name
(reader method).
(setf tag-name)
(writer method).
(setf tag-name)
(writer method).
text
(method).
text
(reader method).
(setf text)
(writer method).
text-node
(class).
text-node-p
(function).
textual-node
(class).
textual-node-p
(function).
traverse
(generic function).
trim
(function).
xml-header
(class).
xml-header-p
(function).
define-predicates
(macro).
make-appending
(macro).
vec-remove-if
(function).
wrs
(macro).
plump/parser.lisp
dom.lisp
(file).
plump
(system).
*root*
(special variable).
parse
(generic function).
read-attribute
(function).
read-attribute-name
(function).
read-attribute-value
(function).
read-attributes
(function).
read-children
(function).
read-name
(function).
read-root
(function).
read-standard-tag
(function).
read-tag
(function).
read-tag-contents
(function).
read-text
(function).
slurp-stream
(function).
*tagstack*
(special variable).
*whitespace*
(special variable).
skip-whitespace
(function).
plump/processing.lisp
parser.lisp
(file).
plump
(system).
define-processing-parser
(macro).
processing-parser
(function).
(setf processing-parser)
(function).
remove-processing-parser
(function).
*processing-parsers*
(special variable).
plump/special-tags.lisp
processing.lisp
(file).
plump
(system).
define-fulltext-element
(macro).
define-self-closing-element
(macro).
ends-with
(function).
read-fulltext-element-content
(function).
starts-with
(function).
plump/documentation.lisp
special-tags.lisp
(file).
plump
(system).
Packages are listed by definition order.
plump-parser
org.shirakumo.plump.parser
common-lisp
.
plump-dom
.
plump-lexer
.
*all-tag-dispatchers*
(special variable).
*html-tags*
(special variable).
*root*
(special variable).
*tag-dispatchers*
(special variable).
*xml-tags*
(special variable).
define-fulltext-element
(macro).
define-processing-parser
(macro).
define-self-closing-element
(macro).
define-tag-dispatcher
(macro).
define-tag-parser
(macro).
define-tag-printer
(macro).
define-wildcard-dispatcher
(macro).
do-tag-parsers
(macro).
do-tag-printers
(macro).
parse
(generic function).
processing-parser
(function).
(setf processing-parser)
(function).
read-attribute
(function).
read-attribute-name
(function).
read-attribute-value
(function).
read-attributes
(function).
read-children
(function).
read-name
(function).
read-root
(function).
read-standard-tag
(function).
read-tag
(function).
read-tag-contents
(function).
read-text
(function).
remove-processing-parser
(function).
remove-tag-dispatcher
(function).
slurp-stream
(function).
(setf tag-dispatcher)
(setf expander).
tag-dispatcher
(function).
tag-dispatcher
(structure).
*processing-parsers*
(special variable).
*tagstack*
(special variable).
*whitespace*
(special variable).
copy-tag-dispatcher
(function).
ends-with
(function).
make-tag-dispatcher
(function).
read-fulltext-element-content
(function).
skip-whitespace
(function).
starts-with
(function).
tag-dispatcher-name
(reader).
(setf tag-dispatcher-name)
(writer).
tag-dispatcher-p
(function).
tag-dispatcher-parser
(reader).
(setf tag-dispatcher-parser)
(writer).
tag-dispatcher-printer
(reader).
(setf tag-dispatcher-printer)
(writer).
tag-dispatcher-test
(reader).
(setf tag-dispatcher-test)
(writer).
plump-lexer
org.shirakumo.plump.lexer
common-lisp
.
*index*
(special variable).
*length*
(special variable).
*string*
(special variable).
advance
(function).
advance-n
(function).
consume
(function).
consume-until
(function).
define-matcher
(macro).
make-matcher
(macro).
matcher-and
(function).
matcher-any
(macro).
matcher-character
(function).
matcher-find
(function).
matcher-next
(function).
matcher-not
(function).
matcher-or
(function).
matcher-prev
(function).
matcher-range
(function).
matcher-string
(function).
peek
(function).
unread
(function).
unread-n
(function).
with-lexer-environment
(macro).
*matchers*
(special variable).
plump-dom
org.shirakumo.plump.dom
array-utils
.
common-lisp
.
*entity-map*
(special variable).
*stream*
(special variable).
allowed-char-p
(function).
append-child
(function).
attribute
(function).
(setf attribute)
(function).
attributes
(generic reader).
(setf attributes)
(generic writer).
cdata
(class).
cdata-p
(function).
child-elements
(function).
child-node
(class).
child-node-p
(function).
child-position
(function).
children
(generic reader).
(setf children)
(generic writer).
clear
(function).
clone-attributes
(function).
clone-children
(function).
clone-node
(generic function).
comment
(class).
comment-p
(function).
decode-entities
(function).
discouraged-char-p
(function).
discouraged-xml-character
(condition).
doctype
(generic reader).
(setf doctype)
(generic writer).
doctype
(class).
doctype-p
(function).
element
(class).
element-p
(function).
element-position
(function).
encode-entities
(function).
ensure-attribute-map
(function).
ensure-child-array
(function).
family
(function).
family-elements
(function).
faulty-char
(generic reader).
(setf faulty-char)
(generic writer).
first-child
(function).
first-element
(function).
fulltext-element
(class).
fulltext-element-p
(function).
get-attribute
(function).
get-element-by-id
(function).
get-elements-by-tag-name
(function).
has-attribute
(function).
has-child-nodes
(function).
insert-after
(function).
insert-before
(function).
invalid-xml-character
(condition).
last-child
(function).
last-element
(function).
make-attribute-map
(function).
make-cdata
(function).
make-child-array
(function).
make-comment
(function).
make-doctype
(function).
make-element
(function).
make-fulltext-element
(function).
make-processing-instruction
(function).
make-root
(function).
make-text-node
(function).
make-xml-header
(function).
nesting-node
(class).
nesting-node-p
(function).
next-element
(function).
next-sibling
(function).
node
(class).
node-p
(function).
parent
(generic reader).
(setf parent)
(generic writer).
prepend-child
(function).
previous-element
(function).
previous-sibling
(function).
processing-instruction
(class).
processing-instruction-p
(function).
remove-attribute
(function).
remove-child
(function).
render-text
(function).
replace-child
(function).
root
(class).
root-p
(function).
serialize
(function).
serialize-object
(generic function).
set-attribute
(function).
sibling-elements
(function).
siblings
(function).
splice
(function).
strip
(function).
tag-name
(generic reader).
(setf tag-name)
(generic writer).
text
(generic function).
(setf text)
(generic writer).
text-node
(class).
text-node-p
(function).
textual-node
(class).
textual-node-p
(function).
translate-entity
(function).
traverse
(generic function).
trim
(function).
write-encode-char
(function).
xml-header
(class).
xml-header-p
(function).
%encode-entities
(function).
*alpha-chars*
(special variable).
define-predicates
(macro).
make-appending
(macro).
vec-remove-if
(function).
wrs
(macro).
plump
org.shirakumo.plump
common-lisp
.
plump-dom
.
plump-lexer
.
plump-parser
.
Definitions are sorted by export status, category, package, and then by lexicographic order.
All defined tag dispatchers
String hash-table containing the entity names and mapping them to their respective characters.
List of HTML tag dispatchers
Set to the current reading index.
Set to the length of the string for bounds checking.
Object containing the current node to set as parent.
The stream to serialize to during SERIALIZE-OBJECT.
Contains the current string to lex.
Active tag dispatcher functions
List of XML tag dispatchers
Defines an element to be read as a full-text element.
This means that it cannot contain any child-nodes and everything up until its closing
tag is used as its text.
Associates NAME as a keyword to the matcher form. You can then use the keyword in further matcher rules.
Defines a new processing-instruction parser.
It is invoked if a processing-instruction (<?) with PROCESS-NAME is encountered.
The lexer will be at the point straight after reading in the PROCESS-NAME.
Expected return value is a string to use as the processing-instructions’ TEXT.
The closing tag (?>) should NOT be consumed by a processing-parser.
Defines an element that does not need to be closed with /> and cannot contain child nodes.
Defines a new tag dispatcher. It is invoked if TEST-FORM passes.
NAME — Name to discern the dispatcher with.
LISTS — Symbols of lists to which the dispatcher should be added.
TAGVAR — Symbol bound to the tag name.
BODY — Body forms describing the test to match the tag.
Defines the parser function for a tag dispatcher.
NAME — The name of the tag dispatcher. If one with this name
cannot be found, an error is signalled.
TAGVAR — Symbol bound to the tag name.
BODY — Body forms describing the tag parsing behaviour.
Defines the printer function for a tag dispatcher.
NAME — The name of the tag dispatcher. If one with this name
cannot be found, an error is signalled.
TAGVAR — Symbol bound to the tag name.
BODY — Body forms describing the printing behaviour. Write to
the stream bound to PLUMP-DOM:*STREAM*.
Iterates over the current *TAG-DISPATCHERS*, binding the TEST and PARSER functions. Returns RESULT-FORM’s evaluated value.
Iterates over the current *TAG-DISPATCHERS*, binding the TEST and PRINTER functions. Returns RESULT-FORM’s evaluated value.
Macro to create a matcher chain.
Shorthand for (or (is a) (is b)..)
Sets up the required lexing environment for the given string.
tag-dispatcher
(function).
Skips a character if possible. Returns the new index or NIL.
Advances by N characters if possible. Returns the new *INDEX*.
Returns T if the character is a permitted XML character.
Appends the given child onto the parent’s child list. Returns the child.
Returns the asked attribute from the element or NIL. If the attribute could not be found, the second return value is set to NIL.
Set an attribute on an element to the given value.
Returns T if the given OBJECT is of type CDATA
Returns a new vector of children of the given node, filtered to elements.
Returns T if the given OBJECT is of type CHILD-NODE
Returns the index of the child within its parent.
Clears all children from the node.
Note that the PARENT of all child elements is set to NIL.
Clone the attribute map.
Note that keys and values are NOT copied/cloned.
Clone the array of children.
If DEEP is non-NIL, each child is cloned as per (CLONE-NODE NODE T).
When copying deeply, you can also pass a NEW-PARENT to set on each child.
Returns T if the given OBJECT is of type COMMENT
Consumes a single character if possible and returns it. Otherwise returns NIL.
Consumes until the provided matcher function returns positively. Returns the substring that was consumed.
Translates all entities in the text into their character counterparts if possible. If an entity does not match, it is left in place unless REMOVE-INVALID is non-NIL.
Returns T if the character is a discouraged XML character.
Returns T if the given OBJECT is of type DOCTYPE
Returns T if the given OBJECT is of type ELEMENT
Returns the index of the child within its parent, counting only elements. This excludes comments, text-nodes and the like.
Encodes the characters < > & " with their XML entity equivalents.
If no STREAM is given, it encodes to a new string.
Ensures that the TABLE is suitable as an attribute-map.
If it is not, the table is copied into a proper attribute-map.
If the ARRAY is suitable as a child-array, it is returned. Otherwise the array’s elements are copied over into a proper child-array.
Returns the direct array of children of the parent of the given child. Note that modifying this array directly modifies that of the parent.
Returns the direct array of children elements of the parent of the given child.
Note that this is a copy of the array, modifying it is safe.
This excludes comments, text-nodes and the like.
Returns the first child within the parent or NIL if the parent is empty.
Returns the first child element within the parent or NIL
if the parent is empty. This excludes comments, text-nodes and the like.
Returns T if the given OBJECT is of type FULLTEXT-ELEMENT
Synonymous to ATTRIBUTE.
Searches the given node and returns the first node at arbitrary depth that matches the given ID attribute.
Searches the given node and returns an unordered list of child nodes at arbitrary depth that match the given tag.
Returns T if the provided attribute exists.
Returns T if the node can contain children and the child array is not empty.
Inserts the new-child after the given element in the parent’s list.
Returns the new child.
Note that this operation is potentially very costly.
See VECTOR-PUSH-EXTEND-POSITION
Inserts the new-child before the given element in the parent’s list.
Returns the new child.
Note that this operation is potentially very costly.
See VECTOR-PUSH-EXTEND-POSITION
Returns the last child within the parent or NIL if the parent is empty.
Returns the last child element within the parent or NIL
if the parent is empty. This excludes comments, text-nodes and the like.
Creates a map to contain attributes.
Creates an XML CDATA section under the parent.
Note that the element is automatically appended to the parent’s child list.
Creates an array to contain child elements
Creates a new comment node under the parent.
Note that the node is automatically appended to the parent’s child list.
Creates a new doctype node under the parent.
Note that the node is automatically appended to the parent’s child list.
Creates a standard DOM element with the given tag name and parent.
Optionally a vector (with fill-pointer) containing children and an
attribute-map (a hash-table with equalp test) can be supplied.
Note that the element is automatically appended to the parent’s child list.
Creates a fulltext element under the parent.
Optionally a text and an attribute-map (a hash-table with equalp test)
can be supplied.
Note that the element is automatically appended to the parent’s child list.
Creates an XML processing instruction under the parent.
Note that the element is automatically appended to the parent’s child list.
Creates a root node with the given children. Children should be a vector with fill-pointer.
Creates a new text node under the parent.
Note that the node is automatically appended to the parent’s child list.
Creates an XML header object under the parent.
Note that the element is automatically appended to the parent’s child list.
Creates a matcher function that returns if all of the sub-expressions return successfully. The last match is returned, if all.
Creates a matcher function that attempts to match the given character.
Creates a matcher function that returns T if the character is found in the given list.
Creates a matcher environment that peeks ahead one farther.
Creates a matcher function that inverts the result of the sub-expression.
Creates a matcher function that returns successfully if any of the sub-expressions return successfully. The first match is returned, if any.
Creates a matcher environment that peeks behind.
Creates a matcher that checks a range according to the next character’s CHAR-CODE.
Creates a matcher function that attempts to match the given string.
Returns T if the given OBJECT is of type NESTING-NODE
Returns the sibling element next to this one or NIL if
it is already last. This excludes comments, text-nodes and the like.
Returns the sibling next to this one or NIL if it is already the last.
Returns T if the given OBJECT is of type NODE
Returns the next character, if any.
Prepends the given child onto the parent’s child list.
Returns the child.
Note that this operation is costly, see VECTOR-PUSH-EXTEND-FRONT
Returns the sibling element before this one or NIL if
it is already the first. This excludes comments, text-nodes and the like.
Returns the sibling before this one or NIL if it is already the first.
Returns T if the given OBJECT is of type PROCESSING-INSTRUCTION
Return the processing-parser function for PROCESS-NAME. SETF-able.
Set the processing-parser function for PROCESS-NAME.
Reads an attribute and returns it as a key value cons.
Reads an attribute name.
Reads an attribute value, either enclosed in quotation marks or until a space or tag end.
Reads as many attributes as possible from a tag and returns them as an attribute map.
Read all children of the current *root* until the closing tag for *root* is encountered.
Reads and returns a tag name.
Creates a root element and reads nodes into it. Optionally uses the specified root to append child nodes to. Returns the root.
Reads an arbitrary tag and returns it. This recurses with READ-CHILDREN.
Attempts to read a tag and dispatches or defaults to READ-STANDARD-TAG. Returns the completed node if one can be read.
Reads and returns all tag contents. E.g. <foo bar baz> => bar baz
Reads and returns a text-node.
Remove the specified attribute if it exists. Returns NIL.
Removes the child from its parent.
Returns the child.
Note that this operation is potentially very costly. See VECTOR-POP-POSITION
Remove the processing-parser for PROCESS-NAME.
Removes the tag-dispatcher of the given name from the list.
"Renders" the text of this element and its children.
In effect the text is gathered from the component and all of
its children, but transforming the text in such a way that:
- All ASCII white space (Space, Tab, CR, LF) is converted into spaces.
- There are no consecutive spaces.
- There are no spaces at the beginning or end.
This is somewhat analogous to how the text will be shown to
the user when rendered by a browser. Hence, render-text.
Replace the old child with a new one. Returns the old child.
Returns T if the given OBJECT is of type ROOT
Serializes NODE to STREAM.
STREAM can be a stream, T for *standard-output* or NIL to serialize to string.
Synonymous to (SETF (ATTRIBUTE ..) ..)
Returns the array of sibling elements of the given child. Note that this is a copy of the array, modifying it is safe. This excludes comments, text-nodes and the like.
Returns the array of siblings of the given child.
Note that this is a copy of the array, modifying it is safe.
Quickly slurps the stream’s contents into an array with fill pointer.
Splices the contents of element into the position of the element in its parent.
Returns the parent.
Note that this operation is potentially very costly.
See ARRAY-SHIFT
Trim all text-nodes within NODE (at any depth) of leading and trailing whitespace. If their TEXT should be an empty string after trimming, remove them.
Accessor to the tag-dispatcher of the given name.
Returns T if the given OBJECT is of type TEXT-NODE
Returns T if the given OBJECT is of type TEXTUAL-NODE
Translates the given entity identifier (a name, #Dec or #xHex) into their respective strings if possible. Otherwise returns NIL.
Trim all text-nodes within NODE (at any depth) of leading and trailing whitespace.
Steps back a single character if possible. Returns the new *INDEX*.
Steps back by N characters if possible. Returns the new *INDEX*.
Write and possibly encode the CHAR to STREAM.
This also properly handles detection of invalid or discouraged XML characters.
The following restarts are available in the case of a faulty character:
ABORT Do not output the faulty character at all.
USE-NEW-CHARACTER Output a replacement character instead.
CONTINUE Continue and output the faulty character anyway.
See INVALID-XML-CHARACTER
See DISCOURAGED-XML-CHARACTER
Returns T if the given OBJECT is of type XML-HEADER
Returns an EQUALP hash-table of the element’s attributes.
xml-header
)) ¶automatically generated reader method
xml-header
)) ¶automatically generated writer method
Returns a vector of child-nodes that are contained within the node.
nesting-node
)) ¶automatically generated reader method
nesting-node
)) ¶automatically generated writer method
Clone the given node, creating a new instance with the same contents.
If DEEP is non-NIL, the following applies:
The text of COMMENT and TEXT-NODEs is copied as per COPY-SEQ.
The children of NESTING-NODEs are copied as per (CLONE-CHILDREN CHILD T)
vector
) &optional deep) ¶hash-table
) &optional deep) ¶nesting-node
) &optional deep) ¶child-node
) &optional deep) ¶textual-node
) &optional deep) ¶xml-header
) &optional deep) ¶processing-instruction
) &optional deep) ¶Returns the doctype node’s actual doctype string.
Returns the faulty char that caused the signal.
discouraged-xml-character
)) ¶invalid-xml-character
)) ¶discouraged-xml-character
)) ¶invalid-xml-character
)) ¶Returns the node’s parent that should contain this element as a child.
child-node
)) ¶automatically generated reader method
child-node
)) ¶automatically generated writer method
Parses the given input into a DOM representation.
By default, methods for STRING, PATHNAME and STREAM are defined.
If supplied, the given root is used to append children to as per READ-ROOT.
Returns the root.
Serialize the given node and print it to *stream*.
fulltext-element
)) ¶xml-header
)) ¶processing-instruction
)) ¶hash-table
)) ¶nesting-node
)) ¶vector
)) ¶Returns the element’s tag name.
processing-instruction
)) ¶automatically generated reader method
processing-instruction
)) ¶automatically generated writer method
Returns the node’s textual content.
nesting-node
)) ¶Compiles all text nodes within the nesting-node into one string.
textual-node
)) ¶automatically generated reader method
textual-node
)) ¶automatically generated writer method
Traverse the NODE and all its children recursively,
calling FUNCTION on the current node if calling TEST on the current node
returns a non-NIL value. It is safe to modify the child array of the
parent of each node passed to FUNCTION.
NODE is returned.
processing-instruction
) stream) ¶xml-header
) stream) ¶Warning signalled when a discouraged XML character is encountered during WRITE-ENCODE-CHAR.
warning
.
:faulty-char
Error signalled when an invalid XML character is encountered during WRITE-ENCODE-CHAR.
error
.
:faulty-char
Encapsulates the processing for a given tag.
See TAG-DISPATCHER-NAME
See TAG-DISPATCHER-TEST
See TAG-DISPATCHER-PARSER
See TAG-DISPATCHER-PRINTER
structure-object
.
symbol
(error "name required")
(function (string) boolean)
(lambda (plump-parser::a) (declare (ignore plump-parser::a)) nil)
(function (string) (or null plump-dom:node))
(lambda (plump-parser::a) (declare (ignore plump-parser::a)) nil)
(function (t) boolean)
(lambda (plump-parser::a) (declare (ignore plump-parser::a)) nil)
XML CDATA section node.
Node class that is a child and thus has a parent.
Comment node that can only contain a single comment string.
Special DOM node for the doctype declaration.
string
(error "doctype declaration required.")
:doctype
Standard DOM element/block including attributes, tag-name, parent and children.
Special DOM element that contains full, un-entitied text like SCRIPT and STYLE.
Node class that can contain child nodes.
Base DOM node class.
XML processing instruction node.
(or null string)
:tag-name
Root DOM node, practically equivalent to a "document".
Text node that can only contain a single text string.
Node class that represents a textual node and thus contains a TEXT field.
XML header element
hash-table
(plump-dom:make-attribute-map)
:attributes
All alphabetic characters and #
Hash table containing matching rules.
List containing all whitespace characters.
Reads the contents of a fulltext element. This slurps everything until the matching closing tag is encountered.
Returns the name of the tag dispatcher.
name
.
Parses the node for the given tag.
The function takes one argument, a string, denoting the tag name. It returns a node, or NIL, if the matching was refused for some reason.
Prints the node for the given tag.
The function takes one argument, a node, the element to print.
It returns the same node, or NIL, if the printing was refused for some reason.
Returns the test function of the tag dispatcher.
The function takes one argument, a string, denoting the tag name. It returns a boolean as to whether the tag name matches.
test
.
Jump to: | %
(
A C D E F G H I L M N P R S T U V W X |
---|
Jump to: | %
(
A C D E F G H I L M N P R S T U V W X |
---|
Jump to: | %
*
F N P S T |
---|
Jump to: | %
*
F N P S T |
---|
Jump to: | C D E F I L N P R S T X |
---|
Jump to: | C D E F I L N P R S T X |
---|