The xmls-tools Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The xmls-tools Reference Manual

This is the xmls-tools Reference Manual, version 0.2.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:45:47 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


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

1.1 xmls-tools

Maintainer

Robert Marlow <bobstopper@bobturf.org>

Author

Robert Marlow <bobstopper@bobturf.org>

Version

0.2.0

Dependency

xmls

Source

xmls-tools.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


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

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 xmls-tools.asd

Location

xmls-tools.asd

Systems

xmls-tools (system)

Packages

xmls-tools-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 xmls-tools/package.lisp

Parent

xmls-tools (system)

Location

package.lisp

Packages

xmls-tools


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.3 xmls-tools/utilities.lisp

Dependency

package.lisp (file)

Parent

xmls-tools (system)

Location

utilities.lisp

Exported Definitions
Internal Definitions

spec-enumeration (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.4 xmls-tools/xmls-valid.lisp

Dependency

utilities.lisp (file)

Parent

xmls-tools (system)

Location

xmls-valid.lisp

Exported Definitions

validate-xml (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.5 xmls-tools/parser.lisp

Dependency

xmls-valid.lisp (file)

Parent

xmls-tools (system)

Location

parser.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

2.1.6 xmls-tools/xhtml2text.lisp

Dependency

parser.lisp (file)

Parent

xmls-tools (system)

Location

xhtml2text.lisp

Exported Definitions

xhtml-to-text (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 xmls-tools-system

Source

xmls-tools.asd

Use List

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

3.2 xmls-tools

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


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

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Macros

Macro: def-element-handler ELEMENT-NAME (XML-TREE-NAME &rest ARGS) (XML-PARSER) &body HANDLER-CODE
Package

xmls-tools

Source

parser.lisp (file)

Macro: process-xml TREE &rest ARGS
Package

xmls-tools

Source

parser.lisp (file)

Macro: with-parser XML-PARSER &body BODY
Package

xmls-tools

Source

parser.lisp (file)

Macro: with-state (STATE-KEY STATE-VALUE) &body BODY
Package

xmls-tools

Source

parser.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Functions

Function: find-all-children XML-TREE CHILD-NAME &key CHILD-NAMESPACE
Package

xmls-tools

Source

utilities.lisp (file)

Function: find-child XML-TREE CHILD-NAME &key SKIP-MATCHES SKIP-CHILDREN CHILD-NAMESPACE
Package

xmls-tools

Source

utilities.lisp (file)

Function: find-subtree XML-TREE PATH-SPEC

Finds the node requested by PATH-SPEC by traversing XML-TREE in the manner specified by PATH-SPEC.
PATH-SPEC is a list of nodes to visit after the root node to reach the final destination listed in the order they are to be visited. Each node is either an XMLS:NODE-NAME or a cons of an XMLS:NODE-NAME and an integer specifying which of a number of possible matches to return (starting from 0)

For example, to find the second c element in the following XMLS tree: ("a" NIL
(("b" . "foo") NIL
(("c" . "foo") NIL "Hello")
(("c" . "foo") NIL "World")))

The following PATH-SPEC could be used:
(("b" . "foo") (("c" . "foo") 1))

Note: FIND-SUBTREE supports FIND-CHILD’s optional namespace, so the following is equally permissible:
("b" ("c" 1))

Package

xmls-tools

Source

utilities.lisp (file)

Function: get-attr-value ATTR-NAME XML
Package

xmls-tools

Source

utilities.lisp (file)

Function: get-pcdata XML-CHILDREN &optional OUT-STRING
Package

xmls-tools

Source

utilities.lisp (file)

Function: make-xml-parser &optional DEFAULT-HANDLER
Package

xmls-tools

Source

parser.lisp (file)

Function: search-children ELEMENT-NAME XML-CHILDREN
Package

xmls-tools

Source

utilities.lisp (file)

Function: validate-xml XML RULES

Accepts an XML tree as generated by xmls and checks it against RULES to determine if the XML is valid for that DTD. Returns two values: T or NIL depending on whether the XML passes as valid, and an error message string in the case of the XML being invalid.

Package

xmls-tools

Source

xmls-valid.lisp (file)

Function: xhtml-to-text XML
Package

xmls-tools

Source

xhtml2text.lisp (file)


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

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Special variables

Special Variable: *xhtml-to-text-parser*
Package

xmls-tools

Source

xhtml2text.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Macros

Macro: compress-whitespace STRING
Package

xmls-tools

Source

parser.lisp (file)

Macro: handle-maybe-text-children TREE OUT-STREAM
Package

xmls-tools

Source

xhtml2text.lisp (file)

Macro: handle-non-text-children TREE OUT-STREAM
Package

xmls-tools

Source

xhtml2text.lisp (file)

Macro: with-indent STREAM &body BODY
Package

xmls-tools

Source

parser.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Functions

Function: %compress-whitespace STRING
Package

xmls-tools

Source

parser.lisp (file)

Function: extract-xml-content-elements CHILD-LIST

Takes CHILD-LIST, a list of objects existing as children for a parent tree, and returns a list of the names of any elements and :PCDATA for any character data.

Package

xmls-tools

Source

xmls-valid.lisp (file)

Function: ignore-element TREE &rest ARGS
Package

xmls-tools

Source

parser.lisp (file)

Function: spec-enumeration SPEC
Package

xmls-tools

Source

utilities.lisp (file)

Function: text-lines STRING
Package

xmls-tools

Source

xhtml2text.lisp (file)

Function: validate-attributes-against-rules ATTRIBS RULES

Takes a list of XML attributes in ATTRIBS and checks against rules to ensure they all belong, have the correct form and no required attributes are missing

Package

xmls-tools

Source

xmls-valid.lisp (file)

Function: validate-children CHILDREN RULES

Validates each subtree given in CHILDREN against RULES

Package

xmls-tools

Source

xmls-valid.lisp (file)

Function: validate-children-against-rules CHILD-SUMMARY-LIST RULES

Checks that all subtree elements in CHILD-SUMMARY-LIST exist as being permissible in RULES - a subset of the global RULES DTD which defines what children are permissible for this child list’s parent element. Also ensures that all elements occur the correct number of times as defined by RULES.

Package

xmls-tools

Source

xmls-valid.lisp (file)

Function: validate-tree XML RULES

Does the actual validation work as defined by validate-xml. Use validate-xml

Package

xmls-tools

Source

xmls-valid.lisp (file)


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

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   X  
Index Entry  Section

F
File, Lisp, xmls-tools.asd: The xmls-tools<dot>asd file
File, Lisp, xmls-tools/package.lisp: The xmls-tools/package<dot>lisp file
File, Lisp, xmls-tools/parser.lisp: The xmls-tools/parser<dot>lisp file
File, Lisp, xmls-tools/utilities.lisp: The xmls-tools/utilities<dot>lisp file
File, Lisp, xmls-tools/xhtml2text.lisp: The xmls-tools/xhtml2text<dot>lisp file
File, Lisp, xmls-tools/xmls-valid.lisp: The xmls-tools/xmls-valid<dot>lisp file

L
Lisp File, xmls-tools.asd: The xmls-tools<dot>asd file
Lisp File, xmls-tools/package.lisp: The xmls-tools/package<dot>lisp file
Lisp File, xmls-tools/parser.lisp: The xmls-tools/parser<dot>lisp file
Lisp File, xmls-tools/utilities.lisp: The xmls-tools/utilities<dot>lisp file
Lisp File, xmls-tools/xhtml2text.lisp: The xmls-tools/xhtml2text<dot>lisp file
Lisp File, xmls-tools/xmls-valid.lisp: The xmls-tools/xmls-valid<dot>lisp file

X
xmls-tools.asd: The xmls-tools<dot>asd file
xmls-tools/package.lisp: The xmls-tools/package<dot>lisp file
xmls-tools/parser.lisp: The xmls-tools/parser<dot>lisp file
xmls-tools/utilities.lisp: The xmls-tools/utilities<dot>lisp file
xmls-tools/xhtml2text.lisp: The xmls-tools/xhtml2text<dot>lisp file
xmls-tools/xmls-valid.lisp: The xmls-tools/xmls-valid<dot>lisp file

Jump to:   F   L   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %  
C   D   E   F   G   H   I   M   P   S   T   V   W   X  
Index Entry  Section

%
%compress-whitespace: Internal functions

C
compress-whitespace: Internal macros

D
def-element-handler: Exported macros

E
extract-xml-content-elements: Internal functions

F
find-all-children: Exported functions
find-child: Exported functions
find-subtree: Exported functions
Function, %compress-whitespace: Internal functions
Function, extract-xml-content-elements: Internal functions
Function, find-all-children: Exported functions
Function, find-child: Exported functions
Function, find-subtree: Exported functions
Function, get-attr-value: Exported functions
Function, get-pcdata: Exported functions
Function, ignore-element: Internal functions
Function, make-xml-parser: Exported functions
Function, search-children: Exported functions
Function, spec-enumeration: Internal functions
Function, text-lines: Internal functions
Function, validate-attributes-against-rules: Internal functions
Function, validate-children: Internal functions
Function, validate-children-against-rules: Internal functions
Function, validate-tree: Internal functions
Function, validate-xml: Exported functions
Function, xhtml-to-text: Exported functions

G
get-attr-value: Exported functions
get-pcdata: Exported functions

H
handle-maybe-text-children: Internal macros
handle-non-text-children: Internal macros

I
ignore-element: Internal functions

M
Macro, compress-whitespace: Internal macros
Macro, def-element-handler: Exported macros
Macro, handle-maybe-text-children: Internal macros
Macro, handle-non-text-children: Internal macros
Macro, process-xml: Exported macros
Macro, with-indent: Internal macros
Macro, with-parser: Exported macros
Macro, with-state: Exported macros
make-xml-parser: Exported functions

P
process-xml: Exported macros

S
search-children: Exported functions
spec-enumeration: Internal functions

T
text-lines: Internal functions

V
validate-attributes-against-rules: Internal functions
validate-children: Internal functions
validate-children-against-rules: Internal functions
validate-tree: Internal functions
validate-xml: Exported functions

W
with-indent: Internal macros
with-parser: Exported macros
with-state: Exported macros

X
xhtml-to-text: Exported functions

Jump to:   %  
C   D   E   F   G   H   I   M   P   S   T   V   W   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*xhtml-to-text-parser*: Internal special variables

S
Special Variable, *xhtml-to-text-parser*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S   X  
Index Entry  Section

P
Package, xmls-tools: The xmls-tools package
Package, xmls-tools-system: The xmls-tools-system package

S
System, xmls-tools: The xmls-tools system

X
xmls-tools: The xmls-tools system
xmls-tools: The xmls-tools package
xmls-tools-system: The xmls-tools-system package

Jump to:   P   S   X