This is the s-xml Reference Manual, version 3, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:32:29 2018 GMT+0.
• Systems: | The systems documentation | |
• Modules: | The modules documentation | |
• Files: | The files documentation | |
• Packages: | The packages documentation | |
• Definitions: | The symbols documentation | |
• Indexes: | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The s-xml system: |
Sven Van Caekenberghe <svc@mac.com>
Sven Van Caekenberghe <svc@mac.com>
Lisp Lesser General Public License (LLGPL)
Simple Common Lisp XML Parser
S-XML is a Common Lisp implementation of a simple XML parser, with a SAX-like and DOM interface
3
s-xml.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The s-xml/src module: |
s-xml (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files: |
Next: The s-xml/src/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
s-xml.asd
s-xml (system)
Next: The s-xml/src/xml<dot>lisp file, Previous: The s-xml<dot>asd file, Up: Lisp files [Contents][Index]
Next: The s-xml/src/dom<dot>lisp file, Previous: The s-xml/src/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
src (module)
src/xml.lisp
Next: The s-xml/src/lxml-dom<dot>lisp file, Previous: The s-xml/src/xml<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
src/dom.lisp
Next: The s-xml/src/sxml-dom<dot>lisp file, Previous: The s-xml/src/dom<dot>lisp file, Up: Lisp files [Contents][Index]
dom.lisp (file)
src (module)
src/lxml-dom.lisp
Next: The s-xml/src/xml-struct-dom<dot>lisp file, Previous: The s-xml/src/lxml-dom<dot>lisp file, Up: Lisp files [Contents][Index]
dom.lisp (file)
src (module)
src/sxml-dom.lisp
Previous: The s-xml/src/sxml-dom<dot>lisp file, Up: Lisp files [Contents][Index]
dom.lisp (file)
src (module)
src/xml-struct-dom.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The s-xml package: |
A simple XML parser with an efficient, purely functional, event-based interface as well as a DOM interface
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions: | ||
• Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables: | ||
• Exported functions: | ||
• Exported generic functions: | ||
• Exported conditions: | ||
• Exported classes: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Called to compute interned attribute name from a buffer that will be reused
Called to compute an element of an attribute list from a buffer that will be reused
If t, new packages will be created for namespaces, if needed, named by the prefix
If t, export newly interned symbols form their packages
When t, namespaces are ignored like in the old version of S-XML
The local (global default) XML namespace
Ordered list of (prefix . XML-namespace) bindings currently in effect - special variable
If t, each XML identifier must exist as symbol already
Next: Exported generic functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Given possible ’xmlns[:prefix]’ attributes, extend the namespaces bindings
Find a registered XML namespace identified by uri
Get the first child of an xml-element
xml-struct-dom.lisp (file)
Make and return a new xml-element struct
xml-struct-dom.lisp (file)
Make a new xml-element with name and children
xml-struct-dom.lisp (file)
Default parser for the attribute name
Default parser for the attribute value
Parse a character stream as XML and generate a DOM of output-type, defaulting to :lxml
Parse a character file as XML and generate a DOM of output-type, defaulting to :lxml
Parse a string as XML and generate a DOM of output-type, defaulting to :lxml
Print identifier on stream using namespace conventions
Write the characters of string to stream using basic XML conventions
Generate XML output on a character stream (t by default) from a DOM of input-type (:lxml by default), optionally pretty printing (off by default), or adding a header (none by default)
Generate XML output to a string from a DOM of input-type (:lxml by default), optionally pretty printing (off by default)
Register a new or redefine an existing XML namespace defined by uri with prefix and package
Resolve the string identifier in the list of namespace bindings
Split an identifier ’prefix:name’ and return (values prefix name)
Parse and return a toplevel XML element from stream, using parser state
Return the string value of the attribute with name the keyword :key of xml-element if any, return null if not found
xml-struct-dom.lisp (file)
(setf xml-element-attribute) (function)
Set the string value of the attribute with name the keyword :key of xml-element, creating a new attribute if necessary or overwriting an existing one, returning the value
xml-struct-dom.lisp (file)
xml-element-attribute (function)
Return the alist of attribute names and values dotted pairs from an xml-element struct
xml-struct-dom.lisp (file)
(setf xml-element-attributes) (function)
xml-struct-dom.lisp (file)
xml-element-attributes (function)
Return the list of children from an xml-element struct
xml-struct-dom.lisp (file)
(setf xml-element-children) (function)
xml-struct-dom.lisp (file)
xml-element-children (function)
Return the name from an xml-element struct
xml-struct-dom.lisp (file)
(setf xml-element-name) (function)
xml-struct-dom.lisp (file)
xml-element-name (function)
Return T when the argument is an xml-element struct
xml-struct-dom.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Get the entities hashtable of an XML parser state
(setf get-entities) (generic function)
A hashtable mapping XML entity names to their replacement stings
xml.lisp (file)
Set the entities hashtable of an XML parser state
get-entities (generic function)
A hashtable mapping XML entity names to their replacement stings
xml.lisp (file)
Get the finish element hook of an XML parser state
(setf get-finish-element-hook) (generic function)
Called when element ends
xml.lisp (file)
Set the finish element hook of an XML parser state
get-finish-element-hook (generic function)
Called when element ends
xml.lisp (file)
Get the new element hook of an XML parser state
(setf get-new-element-hook) (generic function)
Called when new element starts
xml.lisp (file)
Set the new element hook of an XML parser state
get-new-element-hook (generic function)
Called when new element starts
xml.lisp (file)
The Common Lisp package where this namespace’s symbols are interned
(setf get-package) (generic function)
The Common Lisp package where this namespace’s symbols are interned
xml.lisp (file)
get-package (generic function)
The Common Lisp package where this namespace’s symbols are interned
xml.lisp (file)
The preferred prefix assigned to this namespace
(setf get-prefix) (generic function)
The preferred prefix assigned to this namespace
xml.lisp (file)
get-prefix (generic function)
The preferred prefix assigned to this namespace
xml.lisp (file)
Get the initial user seed of an XML parser state
(setf get-seed) (generic function)
The user seed object
xml.lisp (file)
Set the initial user seed of an XML parser state
Get the text hook of an XML parser state
(setf get-text-hook) (generic function)
Called when text is found
xml.lisp (file)
Set the text hook of an XML parser state
get-text-hook (generic function)
Called when text is found
xml.lisp (file)
The URI used to identify this namespace
(setf get-uri) (generic function)
The URI used to identify this namespace
xml.lisp (file)
Parse a character stream as XML and generate a DOM of output-type
dom.lisp (file)
xml-struct-dom.lisp (file)
sxml-dom.lisp (file)
lxml-dom.lisp (file)
Generate XML output on a character stream from a DOM of input-type, optionally pretty printing using level
dom.lisp (file)
xml-struct-dom.lisp (file)
sxml-dom.lisp (file)
lxml-dom.lisp (file)
Get the error arguments from an XML parser error
Get the message from an XML parser error
Get the stream from an XML parser error
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
Thrown by the XML parser to indicate errorneous input
xml.lisp (file)
error (condition)
:message
xml-parser-error-message (generic function)
:args
xml-parser-error-args (generic function)
:stream
(quote nil)
xml-parser-error-stream (generic function)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
The XML parser state passed along all code making up the parser
xml.lisp (file)
standard-object (class)
A hashtable mapping XML entity names to their replacement stings
:entities
(s-xml::make-standard-entities)
get-entities (generic function)
(setf get-entities) (generic function)
The user seed object
:seed
get-seed (generic function)
(setf get-seed) (generic function)
The main reusable character buffer
(s-xml::make-extendable-string)
get-buffer (generic function)
(setf get-buffer) (generic function)
The secondary, smaller reusable character buffer
(s-xml::make-extendable-string)
get-mini-buffer (generic function)
(setf get-mini-buffer) (generic function)
Called when new element starts
:new-element-hook
(function (lambda (s-xml::name s-xml::attributes s-xml::seed) (declare (ignore s-xml::name s-xml::attributes)) s-xml::seed))
get-new-element-hook (generic function)
(setf get-new-element-hook) (generic function)
Called when element ends
:finish-element-hook
(function (lambda (s-xml::name s-xml::attributes s-xml::parent-seed s-xml::seed) (declare (ignore s-xml::name s-xml::attributes s-xml::parent-seed)) s-xml::seed))
get-finish-element-hook (generic function)
(setf get-finish-element-hook) (generic function)
Called when text is found
:text-hook
(function (lambda (string s-xml::seed) (declare (ignore string)) s-xml::seed))
get-text-hook (generic function)
(setf get-text-hook) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables: | ||
• Internal functions: | ||
• Internal generic functions: | ||
• Internal structures: | ||
• Internal classes: |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
The list of known/defined namespaces
REC-xml-names-19990114 says the prefix xml is bound to the namespace http://www.w3.org/XML/1998/namespace.
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
xml-struct-dom.lisp (file)
Find the XML namespace currently bound to prefix in the namespaces bindings
Is char an XML identifier character ?
lxml-dom.lisp (file)
lxml-dom.lisp (file)
lxml-dom.lisp (file)
Make an extendable string which is a one-dimensional character array which is adjustable and has a fill pointer
A hashtable mapping XML entity names to their replacement strings, filled with the standard set
Register a new namespace for uri and prefix, creating a package if necessary
Read and returns an XML identifier from stream, positioned at the start of the identifier, ending with the first non-identifier character, which is peeked, the identifier is written destructively into identifier which is also returned
Read and return an XML string from stream, delimited by either single or double quotes, the stream is expected to be on the opening delimiter, at the end the closing delimiter is also read, entities are resolved, eof before end of string is an error
Read and collect XML text from stream in string which is destructively modified, the text ends with a ’<’, which is peeked and returned, entities are resolved, eof is considered an error
Read and collect XML whitespace from stream in string which is destructively modified, return first non-whitespace character which was peeked but not read, return #Null on eof
Parse and return an XML element from stream, positioned after the opening ’<’
Parse XML element attributes from stream positioned after the tag identifier, returning the attributes as an assoc list, ending at either a ’>’ or a ’/’ which is peeked and also returned
lxml-dom.lisp (file)
Reads in the CDATA and calls the callback for CDATA if it exists
Read and resolve an XML entity from stream, positioned after the ’&’ entity marker,
accepting &name; &#DEC; and &#xHEX; formats,
destructively modifying string, which is also returned,
destructively modifying entity, incorrect entity formats result in errors
Skip an XML comment in stream, positioned after the opening ’<!–’, consumes the closing ’–>’ sequence, unexpected eof or a malformed closing sequence result in a error
Skip an XML special tag (comments and processing instructions) in stream, positioned after the opening ’<’, unexpected eof is an error
Skip over XML whitespace in stream, return first non-whitespace character which was peeked but not read, return nil on eof
xml-struct-dom.lisp (file)
xml-struct-dom.lisp (file)
xml-struct-dom.lisp (file)
sxml-dom.lisp (file)
sxml-dom.lisp (file)
sxml-dom.lisp (file)
Is char an XML whitespace character ?
xml-struct-dom.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Reset and return the main reusable buffer
xml.lisp (file)
The main reusable character buffer
xml.lisp (file)
Reset and return the reusable mini buffer
xml.lisp (file)
The secondary, smaller reusable character buffer
xml.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
xml-struct-dom.lisp (file)
structure-object (structure)
xml-element-name (function)
(setf xml-element-name) (function)
xml-element-attributes (function)
(setf xml-element-attributes) (function)
xml-element-children (function)
(setf xml-element-children) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
Describes an XML namespace and how it is handled
xml.lisp (file)
standard-object (class)
The URI used to identify this namespace
:uri
get-uri (generic function)
(setf get-uri) (generic function)
The preferred prefix assigned to this namespace
:prefix
get-prefix (generic function)
(setf get-prefix) (generic function)
The Common Lisp package where this namespace’s symbols are interned
:package
get-package (generic function)
(setf get-package) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index: | ||
• Function index: | ||
• Variable index: | ||
• Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L M S |
---|
Jump to: | F L M S |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
C E F G I L M N P R S W X |
---|
Jump to: | (
C E F G I L M N P R S W X |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
A B C E F M N P S T U |
---|
Jump to: | *
A B C E F M N P S T U |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P S X |
---|
Jump to: | C P S X |
---|