The s-xml Reference Manual

Table of Contents

The s-xml Reference Manual

This is the s-xml Reference Manual, version 3, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:10:22 2020 GMT+0.

1 Systems

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

1.1 s-xml

Maintainer

Sven Van Caekenberghe <svc@mac.com>

Author

Sven Van Caekenberghe <svc@mac.com>

License

Lisp Lesser General Public License (LLGPL)

Description

Simple Common Lisp XML Parser

Long Description

S-XML is a Common Lisp implementation of a simple XML parser, with a SAX-like and DOM interface

Version

3

Source

s-xml.asd (file)

Component

src (module)

2 Modules

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

2.1 s-xml/src

Parent

s-xml (system)

Location

src/

Components

• package.lisp (file)
• xml.lisp (file)
• dom.lisp (file)
• lxml-dom.lisp (file)
• sxml-dom.lisp (file)
• xml-struct-dom.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 s-xml.asd

Location

s-xml.asd

Systems

s-xml (system)

3.1.2 s-xml/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

s-xml

3.1.3 s-xml/src/xml.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/xml.lisp

Exported Definitions

• *attribute-name-parser* (special variable)
• *attribute-value-parser* (special variable)
• *auto-create-namespace-packages* (special variable)
• *auto-export-symbols* (special variable)
• *ignore-namespaces* (special variable)
• *local-namespace* (special variable)
• *namespaces* (special variable)
• *require-existing-symbols* (special variable)
• extend-namespaces (function)
• find-namespace (function)
• get-entities (method)
• (setf get-entities) (method)
• get-finish-element-hook (method)
• (setf get-finish-element-hook) (method)
• get-new-element-hook (method)
• (setf get-new-element-hook) (method)
• get-package (method)
• (setf get-package) (method)
• get-prefix (method)
• (setf get-prefix) (method)
• get-seed (method)
• (setf get-seed) (method)
• get-text-hook (method)
• (setf get-text-hook) (method)
• get-uri (method)
• (setf get-uri) (method)
• parse-attribute-name (function)
• parse-attribute-value (function)
• print-identifier (function)
• print-string-xml (function)
• register-namespace (function)
• resolve-identifier (function)
• split-identifier (function)
• start-parse-xml (function)
• xml-parser-error (condition)
• xml-parser-error-args (method)
• xml-parser-error-message (method)
• xml-parser-error-stream (method)
• xml-parser-state (class)

Internal Definitions

• *known-namespaces* (special variable)
• *xml-namespace* (special variable)
• find-namespace-binding (function)
• get-buffer (method)
• get-buffer (method)
• (setf get-buffer) (method)
• get-mini-buffer (method)
• get-mini-buffer (method)
• (setf get-mini-buffer) (method)
• identifier-char-p (function)
• make-extendable-string (function)
• make-standard-entities (function)
• new-namespace (function)
• parse-identifier (function)
• parse-string (function)
• parse-text (function)
• parse-whitespace (function)
• parse-xml-element (function)
• parse-xml-element-attributes (function)
• parser-error (function)
• read-cdata (function)
• resolve-entity (function)
• skip-comment (function)
• skip-special-tag (function)
• skip-whitespace (function)
• whitespace-char-p (function)
• xml-namespace (class)

3.1.4 s-xml/src/dom.lisp

Dependencies

• package.lisp (file)
• xml.lisp (file)

Parent

src (module)

Location

src/dom.lisp

Exported Definitions

• parse-xml (function)
• parse-xml-dom (generic function)
• parse-xml-file (function)
• parse-xml-string (function)
• print-xml (function)
• print-xml-dom (generic function)
• print-xml-string (function)

Internal Definitions

• print-attribute (function)
• print-closing-tag (function)
• print-solitary-tag (function)
• print-spaces (function)

3.1.5 s-xml/src/lxml-dom.lisp

Dependency

dom.lisp (file)

Parent

src (module)

Location

src/lxml-dom.lisp

Exported Definitions

• parse-xml-dom (method)
• print-xml-dom (method)

Internal Definitions

• lxml-finish-element-hook (function)
• lxml-new-element-hook (function)
• lxml-text-hook (function)
• plist->alist (function)

3.1.6 s-xml/src/sxml-dom.lisp

Dependency

dom.lisp (file)

Parent

src (module)

Location

src/sxml-dom.lisp

Exported Definitions

• parse-xml-dom (method)
• print-xml-dom (method)

Internal Definitions

• sxml-finish-element-hook (function)
• sxml-new-element-hook (function)
• sxml-text-hook (function)

3.1.7 s-xml/src/xml-struct-dom.lisp

Dependency

dom.lisp (file)

Parent

src (module)

Location

src/xml-struct-dom.lisp

Exported Definitions

• first-xml-element-child (function)
• make-xml-element (function)
• new-xml-element (function)
• parse-xml-dom (method)
• print-xml-dom (method)
• xml-element-attribute (function)
• (setf xml-element-attribute) (function)
• xml-element-attributes (function)
• (setf xml-element-attributes) (function)
• xml-element-children (function)
• (setf xml-element-children) (function)
• xml-element-name (function)
• (setf xml-element-name) (function)
• xml-element-p (function)

Internal Definitions

• copy-xml-element (function)
• standard-finish-element-hook (function)
• standard-new-element-hook (function)
• standard-text-hook (function)
• xml-element (structure)
• xml-equal (function)

4 Packages

Packages are listed by definition order.

4.1 s-xml

A simple XML parser with an efficient, purely functional, event-based interface as well as a DOM interface

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *attribute-name-parser* (special variable)
• *attribute-value-parser* (special variable)
• *auto-create-namespace-packages* (special variable)
• *auto-export-symbols* (special variable)
• *ignore-namespaces* (special variable)
• *local-namespace* (special variable)
• *namespaces* (special variable)
• *require-existing-symbols* (special variable)
• extend-namespaces (function)
• find-namespace (function)
• first-xml-element-child (function)
• get-entities (generic function)
• get-entities (method)
• (setf get-entities) (method)
• (setf get-entities) (generic function)
• get-finish-element-hook (generic function)
• get-finish-element-hook (method)
• (setf get-finish-element-hook) (method)
• (setf get-finish-element-hook) (generic function)
• get-new-element-hook (generic function)
• get-new-element-hook (method)
• (setf get-new-element-hook) (method)
• (setf get-new-element-hook) (generic function)
• get-package (generic function)
• get-package (method)
• (setf get-package) (method)
• (setf get-package) (generic function)
• get-prefix (generic function)
• get-prefix (method)
• (setf get-prefix) (method)
• (setf get-prefix) (generic function)
• get-seed (generic function)
• get-seed (method)
• (setf get-seed) (method)
• (setf get-seed) (generic function)
• get-text-hook (generic function)
• get-text-hook (method)
• (setf get-text-hook) (method)
• (setf get-text-hook) (generic function)
• get-uri (generic function)
• get-uri (method)
• (setf get-uri) (method)
• (setf get-uri) (generic function)
• make-xml-element (function)
• new-xml-element (function)
• parse-attribute-name (function)
• parse-attribute-value (function)
• parse-xml (function)
• parse-xml-dom (generic function)
• parse-xml-dom (method)
• parse-xml-dom (method)
• parse-xml-dom (method)
• parse-xml-file (function)
• parse-xml-string (function)
• print-identifier (function)
• print-string-xml (function)
• print-xml (function)
• print-xml-dom (generic function)
• print-xml-dom (method)
• print-xml-dom (method)
• print-xml-dom (method)
• print-xml-string (function)
• register-namespace (function)
• resolve-identifier (function)
• split-identifier (function)
• start-parse-xml (function)
• xml-element-attribute (function)
• (setf xml-element-attribute) (function)
• xml-element-attributes (function)
• (setf xml-element-attributes) (function)
• xml-element-children (function)
• (setf xml-element-children) (function)
• xml-element-name (function)
• (setf xml-element-name) (function)
• xml-element-p (function)
• xml-parser-error (condition)
• xml-parser-error-args (generic function)
• xml-parser-error-args (method)
• xml-parser-error-message (generic function)
• xml-parser-error-message (method)
• xml-parser-error-stream (generic function)
• xml-parser-error-stream (method)
• xml-parser-state (class)

Internal Definitions

• *known-namespaces* (special variable)
• *xml-namespace* (special variable)
• copy-xml-element (function)
• find-namespace-binding (function)
• get-buffer (generic function)
• get-buffer (method)
• get-buffer (method)
• (setf get-buffer) (method)
• (setf get-buffer) (generic function)
• get-mini-buffer (generic function)
• get-mini-buffer (method)
• get-mini-buffer (method)
• (setf get-mini-buffer) (method)
• (setf get-mini-buffer) (generic function)
• identifier-char-p (function)
• lxml-finish-element-hook (function)
• lxml-new-element-hook (function)
• lxml-text-hook (function)
• make-extendable-string (function)
• make-standard-entities (function)
• new-namespace (function)
• parse-identifier (function)
• parse-string (function)
• parse-text (function)
• parse-whitespace (function)
• parse-xml-element (function)
• parse-xml-element-attributes (function)
• parser-error (function)
• plist->alist (function)
• print-attribute (function)
• print-closing-tag (function)
• print-solitary-tag (function)
• print-spaces (function)
• read-cdata (function)
• resolve-entity (function)
• skip-comment (function)
• skip-special-tag (function)
• skip-whitespace (function)
• standard-finish-element-hook (function)
• standard-new-element-hook (function)
• standard-text-hook (function)
• sxml-finish-element-hook (function)
• sxml-new-element-hook (function)
• sxml-text-hook (function)
• whitespace-char-p (function)
• xml-element (structure)
• xml-equal (function)
• xml-namespace (class)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *attribute-name-parser*

Called to compute interned attribute name from a buffer that will be reused

Package

s-xml

Source

xml.lisp (file)

Special Variable: *attribute-value-parser*

Called to compute an element of an attribute list from a buffer that will be reused

Package

s-xml

Source

xml.lisp (file)

Special Variable: *auto-create-namespace-packages*

If t, new packages will be created for namespaces, if needed, named by the prefix

Package

s-xml

Source

xml.lisp (file)

Special Variable: *auto-export-symbols*

If t, export newly interned symbols form their packages

Package

s-xml

Source

xml.lisp (file)

Special Variable: *ignore-namespaces*

When t, namespaces are ignored like in the old version of S-XML

Package

s-xml

Source

xml.lisp (file)

Special Variable: *local-namespace*

The local (global default) XML namespace

Package

s-xml

Source

xml.lisp (file)

Special Variable: *namespaces*

Ordered list of (prefix . XML-namespace) bindings currently in effect - special variable

Package

s-xml

Source

xml.lisp (file)

Special Variable: *require-existing-symbols*

If t, each XML identifier must exist as symbol already

Package

s-xml

Source

xml.lisp (file)

5.1.2 Functions

Function: extend-namespaces ATTRIBUTES NAMESPACES

Given possible ’xmlns[:prefix]’ attributes, extend the namespaces bindings

Package

s-xml

Source

xml.lisp (file)

Function: find-namespace URI

Find a registered XML namespace identified by uri

Package

s-xml

Source

xml.lisp (file)

Function: first-xml-element-child XML-ELEMENT

Get the first child of an xml-element

Package

s-xml

Source

xml-struct-dom.lisp (file)

Function: make-xml-element &key (NAME NAME) (ATTRIBUTES ATTRIBUTES) (CHILDREN CHILDREN)

Make and return a new xml-element struct

Package

s-xml

Source

xml-struct-dom.lisp (file)

Function: new-xml-element NAME &rest CHILDREN

Make a new xml-element with name and children

Package

s-xml

Source

xml-struct-dom.lisp (file)

Function: parse-attribute-name STRING

Default parser for the attribute name

Package

s-xml

Source

xml.lisp (file)

Function: parse-attribute-value NAME STRING

Default parser for the attribute value

Package

s-xml

Source

xml.lisp (file)

Function: parse-xml STREAM &key OUTPUT-TYPE

Parse a character stream as XML and generate a DOM of output-type, defaulting to :lxml

Package

s-xml

Source

dom.lisp (file)

Function: parse-xml-file FILENAME &key OUTPUT-TYPE

Parse a character file as XML and generate a DOM of output-type, defaulting to :lxml

Package

s-xml

Source

dom.lisp (file)

Function: parse-xml-string STRING &key OUTPUT-TYPE

Parse a string as XML and generate a DOM of output-type, defaulting to :lxml

Package

s-xml

Source

dom.lisp (file)

Function: print-identifier IDENTIFIER STREAM &optional AS-ATTRIBUTE

Print identifier on stream using namespace conventions

Package

s-xml

Source

xml.lisp (file)

Function: print-string-xml STRING STREAM &key START END

Write the characters of string to stream using basic XML conventions

Package

s-xml

Source

xml.lisp (file)

Function: print-xml DOM &key STREAM PRETTY INPUT-TYPE HEADER

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)

Package

s-xml

Source

dom.lisp (file)

Function: print-xml-string DOM &key PRETTY INPUT-TYPE

Generate XML output to a string from a DOM of input-type (:lxml by default), optionally pretty printing (off by default)

Package

s-xml

Source

dom.lisp (file)

Function: register-namespace URI PREFIX PACKAGE

Register a new or redefine an existing XML namespace defined by uri with prefix and package

Package

s-xml

Source

xml.lisp (file)

Function: resolve-identifier IDENTIFIER NAMESPACES &optional AS-ATTRIBUTE

Resolve the string identifier in the list of namespace bindings

Package

s-xml

Source

xml.lisp (file)

Function: split-identifier IDENTIFIER

Split an identifier ’prefix:name’ and return (values prefix name)

Package

s-xml

Source

xml.lisp (file)

Function: start-parse-xml STREAM &optional STATE

Parse and return a toplevel XML element from stream, using parser state

Package

s-xml

Source

xml.lisp (file)

Function: xml-element-attribute XML-ELEMENT KEY

Return the string value of the attribute with name the keyword :key of xml-element if any, return null if not found

Package

s-xml

Source

xml-struct-dom.lisp (file)

Writer

(setf xml-element-attribute) (function)

Function: (setf xml-element-attribute) VALUE XML-ELEMENT KEY

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

Package

s-xml

Source

xml-struct-dom.lisp (file)

Reader

xml-element-attribute (function)

Function: xml-element-attributes INSTANCE

Return the alist of attribute names and values dotted pairs from an xml-element struct

Package

s-xml

Source

xml-struct-dom.lisp (file)

Writer

(setf xml-element-attributes) (function)

Function: (setf xml-element-attributes) VALUE INSTANCE

Package

s-xml

Source

xml-struct-dom.lisp (file)

Reader

xml-element-attributes (function)

Function: xml-element-children INSTANCE

Return the list of children from an xml-element struct

Package

s-xml

Source

xml-struct-dom.lisp (file)

Writer

(setf xml-element-children) (function)

Function: (setf xml-element-children) VALUE INSTANCE

Package

s-xml

Source

xml-struct-dom.lisp (file)

Reader

xml-element-children (function)

Function: xml-element-name INSTANCE

Return the name from an xml-element struct

Package

s-xml

Source

xml-struct-dom.lisp (file)

Writer

(setf xml-element-name) (function)

Function: (setf xml-element-name) VALUE INSTANCE

Package

s-xml

Source

xml-struct-dom.lisp (file)

Reader

xml-element-name (function)

Function: xml-element-p OBJECT

Return T when the argument is an xml-element struct

Package

s-xml

Source

xml-struct-dom.lisp (file)

5.1.3 Generic functions

Generic Function: get-entities OBJECT

Get the entities hashtable of an XML parser state

Package

s-xml

Writer

(setf get-entities) (generic function)

Methods

Method: get-entities (XML-PARSER-STATE xml-parser-state)

A hashtable mapping XML entity names to their replacement stings

Source

xml.lisp (file)

Generic Function: (setf get-entities) NEW-VALUE OBJECT

Set the entities hashtable of an XML parser state

Package

s-xml

Reader

get-entities (generic function)

Methods

Method: (setf get-entities) NEW-VALUE (XML-PARSER-STATE xml-parser-state)

A hashtable mapping XML entity names to their replacement stings

Source

xml.lisp (file)

Generic Function: get-finish-element-hook OBJECT

Get the finish element hook of an XML parser state

Package

s-xml

Writer

(setf get-finish-element-hook) (generic function)

Methods

Method: get-finish-element-hook (XML-PARSER-STATE xml-parser-state)

Called when element ends

Source

xml.lisp (file)

Generic Function: (setf get-finish-element-hook) NEW-VALUE OBJECT

Set the finish element hook of an XML parser state

Package

s-xml

Reader

get-finish-element-hook (generic function)

Methods

Method: (setf get-finish-element-hook) NEW-VALUE (XML-PARSER-STATE xml-parser-state)

Called when element ends

Source

xml.lisp (file)

Generic Function: get-new-element-hook OBJECT

Get the new element hook of an XML parser state

Package

s-xml

Writer

(setf get-new-element-hook) (generic function)

Methods

Method: get-new-element-hook (XML-PARSER-STATE xml-parser-state)

Called when new element starts

Source

xml.lisp (file)

Generic Function: (setf get-new-element-hook) NEW-VALUE OBJECT

Set the new element hook of an XML parser state

Package

s-xml

Reader

get-new-element-hook (generic function)

Methods

Method: (setf get-new-element-hook) NEW-VALUE (XML-PARSER-STATE xml-parser-state)

Called when new element starts

Source

xml.lisp (file)

Generic Function: get-package OBJECT

The Common Lisp package where this namespace’s symbols are interned

Package

s-xml

Writer

(setf get-package) (generic function)

Methods

Method: get-package (XML-NAMESPACE xml-namespace)

The Common Lisp package where this namespace’s symbols are interned

Source

xml.lisp (file)

Generic Function: (setf get-package) NEW-VALUE OBJECT

Package

s-xml

Reader

get-package (generic function)

Methods

Method: (setf get-package) NEW-VALUE (XML-NAMESPACE xml-namespace)

The Common Lisp package where this namespace’s symbols are interned

Source

xml.lisp (file)

Generic Function: get-prefix OBJECT

The preferred prefix assigned to this namespace

Package

s-xml

Writer

(setf get-prefix) (generic function)

Methods

Method: get-prefix (XML-NAMESPACE xml-namespace)

The preferred prefix assigned to this namespace

Source

xml.lisp (file)

Generic Function: (setf get-prefix) NEW-VALUE OBJECT

Package

s-xml

Reader

get-prefix (generic function)

Methods

Method: (setf get-prefix) NEW-VALUE (XML-NAMESPACE xml-namespace)

The preferred prefix assigned to this namespace

Source

xml.lisp (file)

Generic Function: get-seed OBJECT

Get the initial user seed of an XML parser state

Package

s-xml

Writer

(setf get-seed) (generic function)

Methods

Method: get-seed (XML-PARSER-STATE xml-parser-state)

The user seed object

Source

xml.lisp (file)

Generic Function: (setf get-seed) NEW-VALUE OBJECT

Set the initial user seed of an XML parser state

Package

s-xml

Reader

get-seed (generic function)

Methods

Method: (setf get-seed) NEW-VALUE (XML-PARSER-STATE xml-parser-state)

The user seed object

Source

xml.lisp (file)

Generic Function: get-text-hook OBJECT

Get the text hook of an XML parser state

Package

s-xml

Writer

(setf get-text-hook) (generic function)

Methods

Method: get-text-hook (XML-PARSER-STATE xml-parser-state)

Called when text is found

Source

xml.lisp (file)

Generic Function: (setf get-text-hook) NEW-VALUE OBJECT

Set the text hook of an XML parser state

Package

s-xml

Reader

get-text-hook (generic function)

Methods

Method: (setf get-text-hook) NEW-VALUE (XML-PARSER-STATE xml-parser-state)

Called when text is found

Source

xml.lisp (file)

Generic Function: get-uri OBJECT

The URI used to identify this namespace

Package

s-xml

Writer

(setf get-uri) (generic function)

Methods

Method: get-uri (XML-NAMESPACE xml-namespace)

The URI used to identify this namespace

Source

xml.lisp (file)

Generic Function: (setf get-uri) NEW-VALUE OBJECT

Package

s-xml

Reader

get-uri (generic function)

Methods

Method: (setf get-uri) NEW-VALUE (XML-NAMESPACE xml-namespace)

The URI used to identify this namespace

Source

xml.lisp (file)

Generic Function: parse-xml-dom STREAM OUTPUT-TYPE

Parse a character stream as XML and generate a DOM of output-type

Package

s-xml

Source

dom.lisp (file)

Methods

Method: parse-xml-dom STREAM (OUTPUT-TYPE (eql xml-struct))

Source

xml-struct-dom.lisp (file)

Method: parse-xml-dom STREAM (OUTPUT-TYPE (eql sxml))

Source

sxml-dom.lisp (file)

Method: parse-xml-dom STREAM (OUTPUT-TYPE (eql lxml))

Source

lxml-dom.lisp (file)

Generic Function: print-xml-dom DOM INPUT-TYPE STREAM PRETTY LEVEL

Generate XML output on a character stream from a DOM of input-type, optionally pretty printing using level

Package

s-xml

Source

dom.lisp (file)

Methods

Method: print-xml-dom XML-ELEMENT (INPUT-TYPE (eql xml-struct)) STREAM PRETTY LEVEL

Source

xml-struct-dom.lisp (file)

Method: print-xml-dom DOM (INPUT-TYPE (eql sxml)) STREAM PRETTY LEVEL

Source

sxml-dom.lisp (file)

Method: print-xml-dom DOM (INPUT-TYPE (eql lxml)) STREAM PRETTY LEVEL

Source

lxml-dom.lisp (file)

Generic Function: xml-parser-error-args CONDITION

Get the error arguments from an XML parser error

Package

s-xml

Methods

Method: xml-parser-error-args (CONDITION xml-parser-error)

Source

xml.lisp (file)

Generic Function: xml-parser-error-message CONDITION

Get the message from an XML parser error

Package

s-xml

Methods

Method: xml-parser-error-message (CONDITION xml-parser-error)

Source

xml.lisp (file)

Generic Function: xml-parser-error-stream CONDITION

Get the stream from an XML parser error

Package

s-xml

Methods

Method: xml-parser-error-stream (CONDITION xml-parser-error)

Source

xml.lisp (file)

5.1.4 Conditions

Condition: xml-parser-error ()

Thrown by the XML parser to indicate errorneous input

Package

s-xml

Source

xml.lisp (file)

Direct superclasses

error (condition)

Direct methods

• xml-parser-error-stream (method)
• xml-parser-error-args (method)
• xml-parser-error-message (method)

Direct slots

Slot: message

Initargs

:message

Readers

xml-parser-error-message (generic function)

Slot: args

Initargs

:args

Readers

xml-parser-error-args (generic function)

Slot: stream

Initargs

:stream

Initform

(quote nil)

Readers

xml-parser-error-stream (generic function)

5.1.5 Classes

Class: xml-parser-state ()

The XML parser state passed along all code making up the parser

Package

s-xml

Source

xml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• get-buffer (method)
• get-mini-buffer (method)
• get-text-hook (method)
• get-text-hook (method)
• get-finish-element-hook (method)
• get-finish-element-hook (method)
• get-new-element-hook (method)
• get-new-element-hook (method)
• get-mini-buffer (method)
• get-mini-buffer (method)
• get-buffer (method)
• get-buffer (method)
• get-seed (method)
• get-seed (method)
• get-entities (method)
• get-entities (method)

Direct slots

Slot: entities

A hashtable mapping XML entity names to their replacement stings

Initargs

:entities

Initform

(s-xml::make-standard-entities)

Readers

get-entities (generic function)

Writers

(setf get-entities) (generic function)

Slot: seed

The user seed object

Initargs

:seed

Readers

get-seed (generic function)

Writers

(setf get-seed) (generic function)

Slot: buffer

The main reusable character buffer

Initform

(s-xml::make-extendable-string)

Readers

get-buffer (generic function)

Writers

(setf get-buffer) (generic function)

Slot: mini-buffer

The secondary, smaller reusable character buffer

Initform

(s-xml::make-extendable-string)

Readers

get-mini-buffer (generic function)

Writers

(setf get-mini-buffer) (generic function)

Slot: new-element-hook

Called when new element starts

Initargs

:new-element-hook

Initform

(function (lambda (s-xml::name s-xml::attributes s-xml::seed) (declare (ignore s-xml::name s-xml::attributes)) s-xml::seed))

Readers

get-new-element-hook (generic function)

Writers

(setf get-new-element-hook) (generic function)

Slot: finish-element-hook

Called when element ends

Initargs

:finish-element-hook

Initform

(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))

Readers

get-finish-element-hook (generic function)

Writers

(setf get-finish-element-hook) (generic function)

Slot: text-hook

Called when text is found

Initargs

:text-hook

Initform

(function (lambda (string s-xml::seed) (declare (ignore string)) s-xml::seed))

Readers

get-text-hook (generic function)

Writers

(setf get-text-hook) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *known-namespaces*

The list of known/defined namespaces

Package

s-xml

Source

xml.lisp (file)

Special Variable: *xml-namespace*

REC-xml-names-19990114 says the prefix xml is bound to the namespace http://www.w3.org/XML/1998/namespace.

Package

s-xml

Source

xml.lisp (file)

5.2.2 Functions

Function: copy-xml-element INSTANCE

Package

s-xml

Source

xml-struct-dom.lisp (file)

Function: find-namespace-binding PREFIX NAMESPACES

Find the XML namespace currently bound to prefix in the namespaces bindings

Package

s-xml

Source

xml.lisp (file)

Function: identifier-char-p CHAR

Is char an XML identifier character ?

Package

s-xml

Source

xml.lisp (file)

Function: lxml-finish-element-hook NAME ATTRIBUTES PARENT-SEED SEED

Package

s-xml

Source

lxml-dom.lisp (file)

Function: lxml-new-element-hook NAME ATTRIBUTES SEED

Package

s-xml

Source

lxml-dom.lisp (file)

Function: lxml-text-hook STRING SEED

Package

s-xml

Source

lxml-dom.lisp (file)

Function: make-extendable-string &optional SIZE

Make an extendable string which is a one-dimensional character array which is adjustable and has a fill pointer

Package

s-xml

Source

xml.lisp (file)

Function: make-standard-entities ()

A hashtable mapping XML entity names to their replacement strings, filled with the standard set

Package

s-xml

Source

xml.lisp (file)

Function: new-namespace URI &optional PREFIX

Register a new namespace for uri and prefix, creating a package if necessary

Package

s-xml

Source

xml.lisp (file)

Function: parse-identifier STREAM IDENTIFIER

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

Package

s-xml

Source

xml.lisp (file)

Function: parse-string STREAM STATE STRING

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

Package

s-xml

Source

xml.lisp (file)

Function: parse-text STREAM STATE EXTENDABLE-STRING

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

Package

s-xml

Source

xml.lisp (file)

Function: parse-whitespace STREAM EXTENDABLE-STRING

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

Package

s-xml

Source

xml.lisp (file)

Function: parse-xml-element STREAM STATE

Parse and return an XML element from stream, positioned after the opening ’<’

Package

s-xml

Source

xml.lisp (file)

Function: parse-xml-element-attributes STREAM STATE

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

Package

s-xml

Source

xml.lisp (file)

Function: parser-error MESSAGE &optional ARGS STREAM

Package

s-xml

Source

xml.lisp (file)

Function: plist->alist PLIST

Package

s-xml

Source

lxml-dom.lisp (file)

Function: print-attribute NAME VALUE STREAM

Package

s-xml

Source

dom.lisp (file)

Function: print-closing-tag TAG STREAM

Package

s-xml

Source

dom.lisp (file)

Function: print-solitary-tag TAG STREAM

Package

s-xml

Source

dom.lisp (file)

Function: print-spaces N STREAM &optional PRECEDING-NEWLINE

Package

s-xml

Source

dom.lisp (file)

Function: read-cdata STREAM STATE STRING

Reads in the CDATA and calls the callback for CDATA if it exists

Package

s-xml

Source

xml.lisp (file)

Function: resolve-entity STREAM EXTENDABLE-STRING ENTITIES ENTITY

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

Package

s-xml

Source

xml.lisp (file)

Function: skip-comment STREAM

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

Package

s-xml

Source

xml.lisp (file)

Function: skip-special-tag STREAM STATE

Skip an XML special tag (comments and processing instructions) in stream, positioned after the opening ’<’, unexpected eof is an error

Package

s-xml

Source

xml.lisp (file)

Function: skip-whitespace STREAM

Skip over XML whitespace in stream, return first non-whitespace character which was peeked but not read, return nil on eof

Package

s-xml

Source

xml.lisp (file)

Function: standard-finish-element-hook NAME ATTRIBUTES PARENT-SEED SEED

Package

s-xml

Source

xml-struct-dom.lisp (file)

Function: standard-new-element-hook NAME ATTRIBUTES SEED

Package

s-xml

Source

xml-struct-dom.lisp (file)

Function: standard-text-hook STRING SEED

Package

s-xml

Source

xml-struct-dom.lisp (file)

Function: sxml-finish-element-hook NAME ATTRIBUTES PARENT-SEED SEED

Package

s-xml

Source

sxml-dom.lisp (file)

Function: sxml-new-element-hook NAME ATTRIBUTES SEED

Package

s-xml

Source

sxml-dom.lisp (file)

Function: sxml-text-hook STRING SEED

Package

s-xml

Source

sxml-dom.lisp (file)

Function: whitespace-char-p CHAR

Is char an XML whitespace character ?

Package

s-xml

Source

xml.lisp (file)

Function: xml-equal XML-1 XML-2

Package

s-xml

Source

xml-struct-dom.lisp (file)

5.2.3 Generic functions

Generic Function: get-buffer OBJECT

Generic Function: (setf get-buffer) NEW-VALUE OBJECT

Package

s-xml

Methods

Method: get-buffer (STATE xml-parser-state) after

Reset and return the main reusable buffer

Source

xml.lisp (file)

Method: get-buffer (XML-PARSER-STATE xml-parser-state)

Method: (setf get-buffer) NEW-VALUE (XML-PARSER-STATE xml-parser-state)

The main reusable character buffer

Source

xml.lisp (file)

Generic Function: get-mini-buffer OBJECT

Generic Function: (setf get-mini-buffer) NEW-VALUE OBJECT

Package

s-xml

Methods

Method: get-mini-buffer (STATE xml-parser-state) after

Reset and return the reusable mini buffer

Source

xml.lisp (file)

Method: get-mini-buffer (XML-PARSER-STATE xml-parser-state)

Method: (setf get-mini-buffer) NEW-VALUE (XML-PARSER-STATE xml-parser-state)

The secondary, smaller reusable character buffer

Source

xml.lisp (file)

5.2.4 Structures

Structure: xml-element ()

Package

s-xml

Source

xml-struct-dom.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

xml-element-name (function)

Writers

(setf xml-element-name) (function)

Slot: attributes

Readers

xml-element-attributes (function)

Writers

(setf xml-element-attributes) (function)

Slot: children

Readers

xml-element-children (function)

Writers

(setf xml-element-children) (function)

5.2.5 Classes

Class: xml-namespace ()

Describes an XML namespace and how it is handled

Package

s-xml

Source

xml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• get-package (method)
• get-package (method)
• get-prefix (method)
• get-prefix (method)
• get-uri (method)
• get-uri (method)

Direct slots

Slot: uri

The URI used to identify this namespace

Initargs

:uri

Readers

get-uri (generic function)

Writers

(setf get-uri) (generic function)

Slot: prefix

The preferred prefix assigned to this namespace

Initargs

:prefix

Readers

get-prefix (generic function)

Writers

(setf get-prefix) (generic function)

Slot: package

The Common Lisp package where this namespace’s symbols are interned

Initargs

:package

Readers

get-package (generic function)

Writers

(setf get-package) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types