The xml-mop Reference Manual

This is the xml-mop Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 07:09:20 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 xml-mop

xml-mop allows representing parts of XML documents as CLOS objects

Author

Red Daly

License

MIT License

Version

0.0.1

Dependencies
  • s-xml (system).
  • closer-mop (system).
Source

xml-mop.asd.

Child Component

src (module).


2 Modules

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


2.1 xml-mop/src

Source

xml-mop.asd.

Parent Component

xml-mop (system).

Child Components

3 Files

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


3.1 Lisp


3.1.1 xml-mop/xml-mop.asd

Source

xml-mop.asd.

Parent Component

xml-mop (system).

ASDF Systems

xml-mop.

Packages

org.iodb.xml-mop-system.


3.1.2 xml-mop/src/package.lisp

Source

xml-mop.asd.

Parent Component

src (module).

Packages

org.iodb.xml-mop.


3.1.3 xml-mop/src/xml-model.lisp

Dependency

package.lisp (file).

Source

xml-mop.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.4 xml-mop/src/parsing.lisp

Dependency

xml-model.lisp (file).

Source

xml-mop.asd.

Parent Component

src (module).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 org.iodb.xml-mop-system

Source

xml-mop.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 org.iodb.xml-mop

xml-mop allows representing parts of XML documents as CLOS objects

Source

package.lisp.

Nickname

xml-mop

Use List
  • common-lisp.
  • s-xml.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: parse-xml-stream (stream acceptable-root-classes)

This is where we interact with s-xml. Returns a list of the parsed root elements. Usually there is only one unless you are doing something weird.

Package

org.iodb.xml-mop.

Source

parsing.lisp.


5.1.2 Generic functions

Generic Function: child-element-value (child-element parent-element parent-slot)

Returns the value that child-element takes when assigned to parent-slot on parent-element

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: child-element-value (child-element parent-element parent-slot)

By default do not do anything special, just return the element-value of the child element

Generic Reader: element-text (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-text ((element element))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

text.

Generic Writer: (setf element-text) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-text) ((element element))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

text.

Generic Function: element-value (element)

Returns the ’value’ of the element in general. This depends on
the element. For example, if it is a price, then this might return a number in US cents. This function is called on the element by default before it is assigned as the slot-value to a parent element.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: element-value (element)

In general, the value of an element is itself.

Generic Function: on-loaded-from-xml (element)

Called when the element has finished loading in the xml stream.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: on-loaded-from-xml ((element element))
Generic Function: on-start-xml-load (element)

Called when the element has started to load in the xml stream. After attribs have been assigned.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: on-start-xml-load ((element element))

5.1.3 Standalone methods

Method: compute-effective-slot-definition ((class element-class) slot-name direct-slot-definitions)
Package

sb-mop.

Source

xml-model.lisp.

Method: direct-slot-definition-class ((class element-class) &key &allow-other-keys)
Package

sb-mop.

Source

xml-model.lisp.

Method: effective-slot-definition-class ((class element-class) &key &allow-other-keys)
Package

sb-mop.

Source

xml-model.lisp.

Method: initialize-instance :after ((class element-class) &key)
Source

xml-model.lisp.

Method: initialize-instance :around ((class element-class) &rest initargs &key direct-superclasses tags)
Source

xml-model.lisp.

Method: reinitialize-instance :after ((class element-class) &key)
Source

xml-model.lisp.

Method: reinitialize-instance :around ((class element-class) &rest initargs &key direct-superclasses tags)
Source

xml-model.lisp.

Method: validate-superclass ((class element-class) super)
Package

sb-mop.

Source

xml-model.lisp.


5.1.4 Conditions

Condition: encountered-unknown-element

Raised when an element is encountered with no matching xml-mop class.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: element-name
Initform

(quote nil)

Initargs

:element-name

Readers

condition-element-name.

Writers

(setf condition-element-name).

Slot: parent-element
Initform

(quote nil)

Initargs

:parent-element

Readers

condition-parent-element.

Writers

(setf condition-parent-element).


5.1.5 Classes

Class: element
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct methods
Direct slots
Slot: text
Initargs

:text

Readers

element-text.

Writers

(setf element-text).

Slot: tag-string
Initargs

:tag

Readers

element-tag-string.

Writers

(setf element-tag-string).

Class: element-class

A metaclass for XML elements. An additional option that
can be passed to element classes is the :tags option, which accepts a sequence of node-string identifiers.

Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct superclasses

xml-treenode-class.

Direct methods
Direct slots
Slot: tags
Initargs

:tags

Readers

element-class-tag-descriptors.

Writers

(setf element-class-tag-descriptors).

Slot: auto
Initform

t

Initargs

:auto

Readers

element-class-auto.

Writers

(setf element-class-auto).

Slot: reduces-to
Initargs

:reduces-to

Readers

element-class-reduces-to.

Writers

(setf element-class-reduces-to).


5.2 Internals


5.2.1 Ordinary functions

Function: active-handle-finish-element (name attributes parent-seed seed)

Called when the end of an element is encountered and we are in the process of churning out objects.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: active-handle-new-element (name attributes seed)

Called when an element is encountered and we are in the process of churning out objects.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: active-handle-text (string seed)

Called when text is encountered and we are in the process of churning out objects.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: active-parse-stream (stream doc-class)

This is where we interact with s-xml.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: assign-child-element (parent-element new-child-element parent-slot)

Assigns a child element to the given slot of the parent element. This function
takes into account the user’s preferences for child element plurality and type conversion of the element.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: assign-node-tag-descriptors (node-class parsed-tag-descriptors)
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Function: descriptor-matches? (descriptor test-string)
Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: destructure-seed (seed)

Returns multiple values:

1. element stack
2. allowed-root-element-classes 3. root elements
4. slot

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: determine-element-class-matching-tag (allowed-element-class tag-name)
Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: ensure-list (my-list)
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Function: generate-seed (element-stack allowed-root-element-classes root-elements parent-slots)

Generates the seed that is passed along as an XML stream is parsed. This is currently not the greatest system because of how the parse system is set up (event-driven, and does not allow extra consumption).
Currently a seed encodes the following data:
the element classes allowed as root elements
* a list of root elements encountered so far
* the corresponding slots on the element stack
* the element stack as a list
* a list of slots that correspond to elements on the stack, which will be assigned when elements on the stack are popped off

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Function: parse-node-tag-descriptors (tag-descriptors)
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Function: parse-subelement-descriptor-aliases (&key element-type alias multiple)
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Function: resolve-node-descriptor-definition (descriptor-definition)

Takes either a list of descriptor-definitions or a single descriptor definition.

Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Function: resolve-subelement-descriptor-definition (descriptor-definition)

Does not allow multiple descriptor definitions as is the case for a node descriptor.

Package

org.iodb.xml-mop.

Source

xml-model.lisp.


5.2.2 Generic functions

Generic Function: assign-attribute (element name attr-value)
Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: assign-attribute ((element element) name attr-value)
Generic Function: assign-attributes (element attributes)
Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: assign-attributes ((element element) attributes)
Generic Reader: condition-element-name (condition)
Generic Writer: (setf condition-element-name) (condition)
Package

org.iodb.xml-mop.

Methods
Reader Method: condition-element-name ((condition encountered-unknown-element))
Writer Method: (setf condition-element-name) ((condition encountered-unknown-element))
Source

parsing.lisp.

Target Slot

element-name.

Generic Reader: condition-parent-element (condition)
Generic Writer: (setf condition-parent-element) (condition)
Package

org.iodb.xml-mop.

Methods
Reader Method: condition-parent-element ((condition encountered-unknown-element))
Writer Method: (setf condition-parent-element) ((condition encountered-unknown-element))
Source

parsing.lisp.

Target Slot

parent-element.

Generic Reader: descriptor-case-sensitive (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: descriptor-case-sensitive ((named-node-descriptor named-node-descriptor))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

case-sensitive.

Generic Reader: descriptor-element-type (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: descriptor-element-type ((subelement-descriptor subelement-descriptor))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

element-type.

Reader Method: descriptor-element-type ((named-node-descriptor named-node-descriptor))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

element-type.

Generic Reader: descriptor-matcher (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: descriptor-matcher ((named-node-descriptor named-node-descriptor))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

matcher.

Generic Function: descriptor-matches-name? (descriptor test-string)

Determines if the given descriptor matches the test string. Remember, a descriptor is a way to specify nodes in an XML document. The test string is a node name, probably a tag or attribute.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: descriptor-matches-name? ((descriptor named-node-descriptor) test-string)
Generic Reader: descriptor-multiple (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: descriptor-multiple ((subelement-descriptor subelement-descriptor))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

multiple.

Reader Method: descriptor-multiple ((named-node-descriptor named-node-descriptor))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

multiple.

Generic Reader: descriptor-primary-description (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: descriptor-primary-description ((named-node-descriptor named-node-descriptor))

If this is true, then this is the description used to
output an XML version of this descriptor.

Source

xml-model.lisp.

Target Slot

primary-description.

Generic Reader: descriptor-tag-aliases (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: descriptor-tag-aliases ((subelement-descriptor subelement-descriptor))

alternative node descriptors for this subelement.

Source

xml-model.lisp.

Target Slot

aliases.

Generic Reader: element-class-auto (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-class-auto ((element-class element-class))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

auto.

Generic Writer: (setf element-class-auto) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-class-auto) ((element-class element-class))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

auto.

Generic Reader: element-class-parser (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-class-parser ((xml-treenode-class xml-treenode-class))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

parser.

Generic Reader: element-class-reduces-to (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-class-reduces-to ((element-class element-class))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

reduces-to.

Generic Writer: (setf element-class-reduces-to) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-class-reduces-to) ((element-class element-class))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

reduces-to.

Generic Reader: element-class-tag-descriptors (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-class-tag-descriptors ((element-class element-class))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

tags.

Generic Writer: (setf element-class-tag-descriptors) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-class-tag-descriptors) ((element-class element-class))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

tags.

Generic Reader: element-slot-attribute (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-slot-attribute ((element-direct-slot-definition element-direct-slot-definition))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

attribute.

Generic Writer: (setf element-slot-attribute) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-slot-attribute) ((element-direct-slot-definition element-direct-slot-definition))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

attribute.

Generic Reader: element-slot-attributes (slot-definition)
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Methods
Reader Method: element-slot-attributes ((element-effective-slot-definition element-effective-slot-definition))

automatically generated reader method

Target Slot

attributes.

Generic Writer: (setf element-slot-attributes) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-slot-attributes) ((element-effective-slot-definition element-effective-slot-definition))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

attributes.

Generic Reader: element-slot-subelement (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-slot-subelement ((element-direct-slot-definition element-direct-slot-definition))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

subelement.

Generic Writer: (setf element-slot-subelement) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-slot-subelement) ((element-direct-slot-definition element-direct-slot-definition))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

subelement.

Generic Reader: element-slot-subelements (slot-definition)
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Methods
Reader Method: element-slot-subelements ((element-effective-slot-definition element-effective-slot-definition))

automatically generated reader method

Target Slot

subelements.

Generic Writer: (setf element-slot-subelements) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-slot-subelements) ((element-effective-slot-definition element-effective-slot-definition))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

subelements.

Generic Reader: element-tag-string (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: element-tag-string ((element element))

automatically generated reader method

Source

xml-model.lisp.

Target Slot

tag-string.

Generic Writer: (setf element-tag-string) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf element-tag-string) ((element element))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

tag-string.

Generic Function: finalize-after-parse (element)
Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: finalize-after-parse ((element element))
Generic Function: find-allowed-element (parent-element tag-name)

Finds the element class underneath parent-element that corresponds to the tag string.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: find-allowed-element ((parent-element-class xml-treenode-class) tag-name)
Method: find-allowed-element ((parent-element element) tag-name)
Generic Function: find-slot-matching-attribute (element attr-name)
Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: find-slot-matching-attribute ((element element) attr-name)
Generic Function: find-slot-matching-subelement (element tag-name)

Finds a slot in an element class that matches the tag-name given

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: find-slot-matching-subelement ((parent-element-class element-class) tag-name)
Method: find-slot-matching-subelement (non-parent-element-class tag-name)
Generic Function: find-subelement-matching-tag (parent-element tag-name)

Finds the most specific sub-element class of the supplied parent
element (generally an element class) that matches the tag string. This will check the slot definitions of the class for a slot with matching ’subelement’ descriptor, and then check the allowed-subelements field of the class.

Package

org.iodb.xml-mop.

Source

parsing.lisp.

Methods
Method: find-subelement-matching-tag ((parent-element-class element-class) tag-name)
Generic Reader: node-class-allowed-elements (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: node-class-allowed-elements ((node-class xml-treenode-class))
Source

xml-model.lisp.

Target Slot

allowed-elements.

Generic Writer: (setf node-class-allowed-elements) (object)
Package

org.iodb.xml-mop.

Methods
Writer Method: (setf node-class-allowed-elements) ((xml-treenode-class xml-treenode-class))

automatically generated writer method

Source

xml-model.lisp.

Target Slot

allowed-elements.

Generic Reader: parser-case-insensitive-table (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: parser-case-insensitive-table ((standard-parser standard-parser))

For looking up member elements by tag name.

Source

xml-model.lisp.

Target Slot

case-insensitive-table.

Generic Reader: parser-case-sensitive-table (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: parser-case-sensitive-table ((standard-parser standard-parser))

For looking up member elements by tag name.

Source

xml-model.lisp.

Target Slot

case-sensitive-table.

Generic Reader: parser-lambda-table (object)
Package

org.iodb.xml-mop.

Methods
Reader Method: parser-lambda-table ((standard-parser standard-parser))

For looking up elements by calling a test function.

Source

xml-model.lisp.

Target Slot

lambda-table.

Generic Function: process-element (parent-element tag-name attributes)

Adds the child element with the given tag name and attribs to the parent elem.

Package

org.iodb.xml-mop.

Source

parsing.lisp.


5.2.3 Conditions

Condition: encountered-unmatched-attribute
Package

org.iodb.xml-mop.

Source

parsing.lisp.

Direct superclasses

condition.


5.2.4 Classes

Class: element-direct-slot-definition

Direct slots of ELEMENT-CLASS (that is those that are defined in
a defclass form where element-class is the metaclass) have an ATTRIBUTE and SUBELEMENT property. These direct slot definitions are transformed into effective slot definitions in compute-effective-slot-definition.

Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct superclasses

standard-direct-slot-definition.

Direct methods
Direct slots
Slot: subelement
Initargs

:subelement

Readers

element-slot-subelement.

Writers

(setf element-slot-subelement).

Slot: attribute
Initargs

:attribute

Readers

element-slot-attribute.

Writers

(setf element-slot-attribute).

Class: element-effective-slot-definition
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct superclasses

standard-effective-slot-definition.

Direct methods
Direct slots
Slot: subelements
Initargs

:subelements

Readers

element-slot-subelements.

Writers

(setf element-slot-subelements).

Slot: attributes
Initargs

:attributes

Readers

element-slot-attributes.

Writers

(setf element-slot-attributes).

Class: named-node-descriptor

This is the standard way to describe an XML node. A node descriptor helps map
from a cased or uncased string to a handler class or function. Several descriptors may map to a single element.

Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct methods
Direct slots
Slot: matcher
Initargs

:matcher, :string

Readers

descriptor-matcher.

Writers

This slot is read-only.

Slot: case-sensitive
Initargs

:case-sensitive

Readers

descriptor-case-sensitive.

Writers

This slot is read-only.

Slot: element-type
Initargs

:element-type

Readers

descriptor-element-type.

Writers

This slot is read-only.

Slot: multiple
Initargs

:multiple

Readers

descriptor-multiple.

Writers

This slot is read-only.

Slot: primary-description

If this is true, then this is the description used to
output an XML version of this descriptor.

Initargs

:primary

Readers

descriptor-primary-description.

Writers

This slot is read-only.

Class: standard-parser

The parser class keeps track of element or attributes
an XML node can have. Typically, each element class has a parser associated with it that will attempt to look up a node. If that fails, a parser is invoked for the document.

Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct methods
Direct slots
Slot: case-sensitive-table

For looking up member elements by tag name.

Initform

(make-hash-table :test (function equal))

Initargs

:case-sensitive-table

Readers

parser-case-sensitive-table.

Writers

This slot is read-only.

Slot: case-insensitive-table

For looking up member elements by tag name.

Initform

(make-hash-table :test (function equalp))

Initargs

:cased-sensitive-table

Readers

parser-case-insensitive-table.

Writers

This slot is read-only.

Slot: lambda-table

For looking up elements by calling a test function.

Initargs

:lambda-table

Readers

parser-lambda-table.

Writers

This slot is read-only.

Class: subelement-descriptor

Describes a subelement associated with a slot on an element class.

Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct methods
Direct slots
Slot: element-type
Initargs

:element-type

Readers

descriptor-element-type.

Writers

This slot is read-only.

Slot: multiple
Initargs

:multiple

Readers

descriptor-multiple.

Writers

This slot is read-only.

Slot: aliases

alternative node descriptors for this subelement.

Initargs

:aliases

Readers

descriptor-tag-aliases.

Writers

This slot is read-only.

Class: xml-treenode-class
Package

org.iodb.xml-mop.

Source

xml-model.lisp.

Direct superclasses

standard-class.

Direct subclasses

element-class.

Direct methods
Direct slots
Slot: allowed-elements
Initargs

:allowed-elements

Readers

node-class-allowed-elements.

Writers

(setf node-class-allowed-elements).

Slot: parser
Initform

(make-instance (quote org.iodb.xml-mop::standard-parser))

Initargs

:parser

Readers

element-class-parser.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   I   M   N   O   P   R   V  
Index Entry  Section

(
(setf condition-element-name): Private generic functions
(setf condition-element-name): Private generic functions
(setf condition-parent-element): Private generic functions
(setf condition-parent-element): Private generic functions
(setf element-class-auto): Private generic functions
(setf element-class-auto): Private generic functions
(setf element-class-reduces-to): Private generic functions
(setf element-class-reduces-to): Private generic functions
(setf element-class-tag-descriptors): Private generic functions
(setf element-class-tag-descriptors): Private generic functions
(setf element-slot-attribute): Private generic functions
(setf element-slot-attribute): Private generic functions
(setf element-slot-attributes): Private generic functions
(setf element-slot-attributes): Private generic functions
(setf element-slot-subelement): Private generic functions
(setf element-slot-subelement): Private generic functions
(setf element-slot-subelements): Private generic functions
(setf element-slot-subelements): Private generic functions
(setf element-tag-string): Private generic functions
(setf element-tag-string): Private generic functions
(setf element-text): Public generic functions
(setf element-text): Public generic functions
(setf node-class-allowed-elements): Private generic functions
(setf node-class-allowed-elements): Private generic functions

A
active-handle-finish-element: Private ordinary functions
active-handle-new-element: Private ordinary functions
active-handle-text: Private ordinary functions
active-parse-stream: Private ordinary functions
assign-attribute: Private generic functions
assign-attribute: Private generic functions
assign-attributes: Private generic functions
assign-attributes: Private generic functions
assign-child-element: Private ordinary functions
assign-node-tag-descriptors: Private ordinary functions

C
child-element-value: Public generic functions
child-element-value: Public generic functions
compute-effective-slot-definition: Public standalone methods
condition-element-name: Private generic functions
condition-element-name: Private generic functions
condition-parent-element: Private generic functions
condition-parent-element: Private generic functions

D
descriptor-case-sensitive: Private generic functions
descriptor-case-sensitive: Private generic functions
descriptor-element-type: Private generic functions
descriptor-element-type: Private generic functions
descriptor-element-type: Private generic functions
descriptor-matcher: Private generic functions
descriptor-matcher: Private generic functions
descriptor-matches-name?: Private generic functions
descriptor-matches-name?: Private generic functions
descriptor-matches?: Private ordinary functions
descriptor-multiple: Private generic functions
descriptor-multiple: Private generic functions
descriptor-multiple: Private generic functions
descriptor-primary-description: Private generic functions
descriptor-primary-description: Private generic functions
descriptor-tag-aliases: Private generic functions
descriptor-tag-aliases: Private generic functions
destructure-seed: Private ordinary functions
determine-element-class-matching-tag: Private ordinary functions
direct-slot-definition-class: Public standalone methods

E
effective-slot-definition-class: Public standalone methods
element-class-auto: Private generic functions
element-class-auto: Private generic functions
element-class-parser: Private generic functions
element-class-parser: Private generic functions
element-class-reduces-to: Private generic functions
element-class-reduces-to: Private generic functions
element-class-tag-descriptors: Private generic functions
element-class-tag-descriptors: Private generic functions
element-slot-attribute: Private generic functions
element-slot-attribute: Private generic functions
element-slot-attributes: Private generic functions
element-slot-attributes: Private generic functions
element-slot-subelement: Private generic functions
element-slot-subelement: Private generic functions
element-slot-subelements: Private generic functions
element-slot-subelements: Private generic functions
element-tag-string: Private generic functions
element-tag-string: Private generic functions
element-text: Public generic functions
element-text: Public generic functions
element-value: Public generic functions
element-value: Public generic functions
ensure-list: Private ordinary functions

F
finalize-after-parse: Private generic functions
finalize-after-parse: Private generic functions
find-allowed-element: Private generic functions
find-allowed-element: Private generic functions
find-allowed-element: Private generic functions
find-slot-matching-attribute: Private generic functions
find-slot-matching-attribute: Private generic functions
find-slot-matching-subelement: Private generic functions
find-slot-matching-subelement: Private generic functions
find-slot-matching-subelement: Private generic functions
find-subelement-matching-tag: Private generic functions
find-subelement-matching-tag: Private generic functions
Function, active-handle-finish-element: Private ordinary functions
Function, active-handle-new-element: Private ordinary functions
Function, active-handle-text: Private ordinary functions
Function, active-parse-stream: Private ordinary functions
Function, assign-child-element: Private ordinary functions
Function, assign-node-tag-descriptors: Private ordinary functions
Function, descriptor-matches?: Private ordinary functions
Function, destructure-seed: Private ordinary functions
Function, determine-element-class-matching-tag: Private ordinary functions
Function, ensure-list: Private ordinary functions
Function, generate-seed: Private ordinary functions
Function, parse-node-tag-descriptors: Private ordinary functions
Function, parse-subelement-descriptor-aliases: Private ordinary functions
Function, parse-xml-stream: Public ordinary functions
Function, resolve-node-descriptor-definition: Private ordinary functions
Function, resolve-subelement-descriptor-definition: Private ordinary functions

G
generate-seed: Private ordinary functions
Generic Function, (setf condition-element-name): Private generic functions
Generic Function, (setf condition-parent-element): Private generic functions
Generic Function, (setf element-class-auto): Private generic functions
Generic Function, (setf element-class-reduces-to): Private generic functions
Generic Function, (setf element-class-tag-descriptors): Private generic functions
Generic Function, (setf element-slot-attribute): Private generic functions
Generic Function, (setf element-slot-attributes): Private generic functions
Generic Function, (setf element-slot-subelement): Private generic functions
Generic Function, (setf element-slot-subelements): Private generic functions
Generic Function, (setf element-tag-string): Private generic functions
Generic Function, (setf element-text): Public generic functions
Generic Function, (setf node-class-allowed-elements): Private generic functions
Generic Function, assign-attribute: Private generic functions
Generic Function, assign-attributes: Private generic functions
Generic Function, child-element-value: Public generic functions
Generic Function, condition-element-name: Private generic functions
Generic Function, condition-parent-element: Private generic functions
Generic Function, descriptor-case-sensitive: Private generic functions
Generic Function, descriptor-element-type: Private generic functions
Generic Function, descriptor-matcher: Private generic functions
Generic Function, descriptor-matches-name?: Private generic functions
Generic Function, descriptor-multiple: Private generic functions
Generic Function, descriptor-primary-description: Private generic functions
Generic Function, descriptor-tag-aliases: Private generic functions
Generic Function, element-class-auto: Private generic functions
Generic Function, element-class-parser: Private generic functions
Generic Function, element-class-reduces-to: Private generic functions
Generic Function, element-class-tag-descriptors: Private generic functions
Generic Function, element-slot-attribute: Private generic functions
Generic Function, element-slot-attributes: Private generic functions
Generic Function, element-slot-subelement: Private generic functions
Generic Function, element-slot-subelements: Private generic functions
Generic Function, element-tag-string: Private generic functions
Generic Function, element-text: Public generic functions
Generic Function, element-value: Public generic functions
Generic Function, finalize-after-parse: Private generic functions
Generic Function, find-allowed-element: Private generic functions
Generic Function, find-slot-matching-attribute: Private generic functions
Generic Function, find-slot-matching-subelement: Private generic functions
Generic Function, find-subelement-matching-tag: Private generic functions
Generic Function, node-class-allowed-elements: Private generic functions
Generic Function, on-loaded-from-xml: Public generic functions
Generic Function, on-start-xml-load: Public generic functions
Generic Function, parser-case-insensitive-table: Private generic functions
Generic Function, parser-case-sensitive-table: Private generic functions
Generic Function, parser-lambda-table: Private generic functions
Generic Function, process-element: Private generic functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

M
Method, (setf condition-element-name): Private generic functions
Method, (setf condition-parent-element): Private generic functions
Method, (setf element-class-auto): Private generic functions
Method, (setf element-class-reduces-to): Private generic functions
Method, (setf element-class-tag-descriptors): Private generic functions
Method, (setf element-slot-attribute): Private generic functions
Method, (setf element-slot-attributes): Private generic functions
Method, (setf element-slot-subelement): Private generic functions
Method, (setf element-slot-subelements): Private generic functions
Method, (setf element-tag-string): Private generic functions
Method, (setf element-text): Public generic functions
Method, (setf node-class-allowed-elements): Private generic functions
Method, assign-attribute: Private generic functions
Method, assign-attributes: Private generic functions
Method, child-element-value: Public generic functions
Method, compute-effective-slot-definition: Public standalone methods
Method, condition-element-name: Private generic functions
Method, condition-parent-element: Private generic functions
Method, descriptor-case-sensitive: Private generic functions
Method, descriptor-element-type: Private generic functions
Method, descriptor-element-type: Private generic functions
Method, descriptor-matcher: Private generic functions
Method, descriptor-matches-name?: Private generic functions
Method, descriptor-multiple: Private generic functions
Method, descriptor-multiple: Private generic functions
Method, descriptor-primary-description: Private generic functions
Method, descriptor-tag-aliases: Private generic functions
Method, direct-slot-definition-class: Public standalone methods
Method, effective-slot-definition-class: Public standalone methods
Method, element-class-auto: Private generic functions
Method, element-class-parser: Private generic functions
Method, element-class-reduces-to: Private generic functions
Method, element-class-tag-descriptors: Private generic functions
Method, element-slot-attribute: Private generic functions
Method, element-slot-attributes: Private generic functions
Method, element-slot-subelement: Private generic functions
Method, element-slot-subelements: Private generic functions
Method, element-tag-string: Private generic functions
Method, element-text: Public generic functions
Method, element-value: Public generic functions
Method, finalize-after-parse: Private generic functions
Method, find-allowed-element: Private generic functions
Method, find-allowed-element: Private generic functions
Method, find-slot-matching-attribute: Private generic functions
Method, find-slot-matching-subelement: Private generic functions
Method, find-slot-matching-subelement: Private generic functions
Method, find-subelement-matching-tag: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, node-class-allowed-elements: Private generic functions
Method, on-loaded-from-xml: Public generic functions
Method, on-start-xml-load: Public generic functions
Method, parser-case-insensitive-table: Private generic functions
Method, parser-case-sensitive-table: Private generic functions
Method, parser-lambda-table: Private generic functions
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, validate-superclass: Public standalone methods

N
node-class-allowed-elements: Private generic functions
node-class-allowed-elements: Private generic functions

O
on-loaded-from-xml: Public generic functions
on-loaded-from-xml: Public generic functions
on-start-xml-load: Public generic functions
on-start-xml-load: Public generic functions

P
parse-node-tag-descriptors: Private ordinary functions
parse-subelement-descriptor-aliases: Private ordinary functions
parse-xml-stream: Public ordinary functions
parser-case-insensitive-table: Private generic functions
parser-case-insensitive-table: Private generic functions
parser-case-sensitive-table: Private generic functions
parser-case-sensitive-table: Private generic functions
parser-lambda-table: Private generic functions
parser-lambda-table: Private generic functions
process-element: Private generic functions

R
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
resolve-node-descriptor-definition: Private ordinary functions
resolve-subelement-descriptor-definition: Private ordinary functions

V
validate-superclass: Public standalone methods


A.3 Variables

Jump to:   A   C   E   L   M   P   R   S   T  
Index Entry  Section

A
aliases: Private classes
allowed-elements: Private classes
attribute: Private classes
attributes: Private classes
auto: Public classes

C
case-insensitive-table: Private classes
case-sensitive: Private classes
case-sensitive-table: Private classes

E
element-name: Public conditions
element-type: Private classes
element-type: Private classes

L
lambda-table: Private classes

M
matcher: Private classes
multiple: Private classes
multiple: Private classes

P
parent-element: Public conditions
parser: Private classes
primary-description: Private classes

R
reduces-to: Public classes

S
Slot, aliases: Private classes
Slot, allowed-elements: Private classes
Slot, attribute: Private classes
Slot, attributes: Private classes
Slot, auto: Public classes
Slot, case-insensitive-table: Private classes
Slot, case-sensitive: Private classes
Slot, case-sensitive-table: Private classes
Slot, element-name: Public conditions
Slot, element-type: Private classes
Slot, element-type: Private classes
Slot, lambda-table: Private classes
Slot, matcher: Private classes
Slot, multiple: Private classes
Slot, multiple: Private classes
Slot, parent-element: Public conditions
Slot, parser: Private classes
Slot, primary-description: Private classes
Slot, reduces-to: Public classes
Slot, subelement: Private classes
Slot, subelements: Private classes
Slot, tag-string: Public classes
Slot, tags: Public classes
Slot, text: Public classes
subelement: Private classes
subelements: Private classes

T
tag-string: Public classes
tags: Public classes
text: Public classes


A.4 Data types

Jump to:   C   E   F   M   N   O   P   S   X  
Index Entry  Section

C
Class, element: Public classes
Class, element-class: Public classes
Class, element-direct-slot-definition: Private classes
Class, element-effective-slot-definition: Private classes
Class, named-node-descriptor: Private classes
Class, standard-parser: Private classes
Class, subelement-descriptor: Private classes
Class, xml-treenode-class: Private classes
Condition, encountered-unknown-element: Public conditions
Condition, encountered-unmatched-attribute: Private conditions

E
element: Public classes
element-class: Public classes
element-direct-slot-definition: Private classes
element-effective-slot-definition: Private classes
encountered-unknown-element: Public conditions
encountered-unmatched-attribute: Private conditions

F
File, package.lisp: The xml-mop/src/package․lisp file
File, parsing.lisp: The xml-mop/src/parsing․lisp file
File, xml-model.lisp: The xml-mop/src/xml-model․lisp file
File, xml-mop.asd: The xml-mop/xml-mop․asd file

M
Module, src: The xml-mop/src module

N
named-node-descriptor: Private classes

O
org.iodb.xml-mop: The org․iodb․xml-mop package
org.iodb.xml-mop-system: The org․iodb․xml-mop-system package

P
Package, org.iodb.xml-mop: The org․iodb․xml-mop package
Package, org.iodb.xml-mop-system: The org․iodb․xml-mop-system package
package.lisp: The xml-mop/src/package․lisp file
parsing.lisp: The xml-mop/src/parsing․lisp file

S
src: The xml-mop/src module
standard-parser: Private classes
subelement-descriptor: Private classes
System, xml-mop: The xml-mop system

X
xml-model.lisp: The xml-mop/src/xml-model․lisp file
xml-mop: The xml-mop system
xml-mop.asd: The xml-mop/xml-mop․asd file
xml-treenode-class: Private classes