This is the xml-mop Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 18:19:03 2021 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 xml-mop system |
Red Daly
MIT License
xml-mop allows representing parts of XML documents as CLOS objects
0.0.1
xml-mop.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The xml-mop/src module |
xml-mop (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The xml-mop.asd file | ||
• The xml-mop/src/package.lisp file | ||
• The xml-mop/src/xml-model.lisp file | ||
• The xml-mop/src/parsing.lisp file |
Next: The xml-mop/src/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
xml-mop.asd
xml-mop (system)
Next: The xml-mop/src/xml-model․lisp file, Previous: The xml-mop․asd file, Up: Lisp files [Contents][Index]
src (module)
src/package.lisp
Next: The xml-mop/src/parsing․lisp file, Previous: The xml-mop/src/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
src (module)
src/xml-model.lisp
Previous: The xml-mop/src/xml-model․lisp file, Up: Lisp files [Contents][Index]
xml-model.lisp (file)
src (module)
src/parsing.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The org.iodb.xml-mop-system package | ||
• The org.iodb.xml-mop package |
Next: The org․iodb․xml-mop package, Previous: Packages, Up: Packages [Contents][Index]
xml-mop.asd
Previous: The org․iodb․xml-mop-system package, Up: Packages [Contents][Index]
xml-mop allows representing parts of XML documents as CLOS objects
package.lisp (file)
xml-mop
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 functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported classes |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
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.
parsing.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Returns the value that child-element takes when assigned to parent-slot on parent-element
parsing.lisp (file)
By default do not do anything special, just return the element-value of the child element
automatically generated reader method
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
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.
parsing.lisp (file)
In general, the value of an element is itself.
Called when the element has finished loading in the xml stream.
parsing.lisp (file)
Called when the element has started to load in the xml stream. After attribs have been assigned.
parsing.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
Raised when an element is encountered with no matching xml-mop class.
parsing.lisp (file)
error (condition)
:element-name
(quote nil)
condition-element-name (generic function)
(setf condition-element-name) (generic function)
:parent-element
(quote nil)
condition-parent-element (generic function)
(setf condition-parent-element) (generic function)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
xml-model.lisp (file)
standard-object (class)
:text
element-text (generic function)
(setf element-text) (generic function)
:tag
element-tag-string (generic function)
(setf element-tag-string) (generic function)
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.
xml-model.lisp (file)
xml-treenode-class (class)
:tags
element-class-tag-descriptors (generic function)
(setf element-class-tag-descriptors) (generic function)
:auto
t
element-class-auto (generic function)
(setf element-class-auto) (generic function)
:reduces-to
element-class-reduces-to (generic function)
(setf element-class-reduces-to) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal functions | ||
• Internal generic functions | ||
• Internal conditions | ||
• Internal classes |
Next: Internal generic functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Called when the end of an element is encountered and we are in the process of churning out objects.
parsing.lisp (file)
Called when an element is encountered and we are in the process of churning out objects.
parsing.lisp (file)
Called when text is encountered and we are in the process of churning out objects.
parsing.lisp (file)
This is where we interact with s-xml.
parsing.lisp (file)
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.
parsing.lisp (file)
xml-model.lisp (file)
parsing.lisp (file)
Returns multiple values:
1. element stack
2. allowed-root-element-classes
3. root elements
4. slot
parsing.lisp (file)
parsing.lisp (file)
xml-model.lisp (file)
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
parsing.lisp (file)
xml-model.lisp (file)
xml-model.lisp (file)
Takes either a list of descriptor-definitions or a single descriptor definition.
xml-model.lisp (file)
Does not allow multiple descriptor definitions as is the case for a node descriptor.
xml-model.lisp (file)
Next: Internal conditions, Previous: Internal functions, Up: Internal definitions [Contents][Index]
parsing.lisp (file)
parsing.lisp (file)
parsing.lisp (file)
parsing.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
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.
parsing.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
If this is true, then this is the description used to
output an XML version of this descriptor.
xml-model.lisp (file)
alternative node descriptors for this subelement.
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
xml-model.lisp (file)
(setf element-slot-attributes) (generic function)
automatically generated reader method
element-slot-attributes (generic function)
automatically generated writer method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
xml-model.lisp (file)
(setf element-slot-subelements) (generic function)
automatically generated reader method
element-slot-subelements (generic function)
automatically generated writer method
xml-model.lisp (file)
automatically generated reader method
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
parsing.lisp (file)
Finds the element class underneath parent-element that corresponds to the tag string.
parsing.lisp (file)
parsing.lisp (file)
Finds a slot in an element class that matches the tag-name given
parsing.lisp (file)
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.
parsing.lisp (file)
xml-model.lisp (file)
automatically generated writer method
xml-model.lisp (file)
For looking up member elements by tag name.
xml-model.lisp (file)
For looking up member elements by tag name.
xml-model.lisp (file)
For looking up elements by calling a test function.
xml-model.lisp (file)
Adds the child element with the given tag name and attribs to the parent elem.
parsing.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
parsing.lisp (file)
condition (condition)
Previous: Internal conditions, Up: Internal definitions [Contents][Index]
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.
xml-model.lisp (file)
standard-direct-slot-definition (class)
:subelement
element-slot-subelement (generic function)
(setf element-slot-subelement) (generic function)
:attribute
element-slot-attribute (generic function)
(setf element-slot-attribute) (generic function)
xml-model.lisp (file)
standard-effective-slot-definition (class)
:subelements
element-slot-subelements (generic function)
(setf element-slot-subelements) (generic function)
:attributes
element-slot-attributes (generic function)
(setf element-slot-attributes) (generic function)
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.
xml-model.lisp (file)
standard-object (class)
:matcher, :string
descriptor-matcher (generic function)
:case-sensitive
descriptor-case-sensitive (generic function)
:element-type
descriptor-element-type (generic function)
:multiple
descriptor-multiple (generic function)
If this is true, then this is the description used to
output an XML version of this descriptor.
:primary
descriptor-primary-description (generic function)
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.
xml-model.lisp (file)
standard-object (class)
For looking up member elements by tag name.
:case-sensitive-table
(make-hash-table :test (function equal))
parser-case-sensitive-table (generic function)
For looking up member elements by tag name.
:cased-sensitive-table
(make-hash-table :test (function equalp))
parser-case-insensitive-table (generic function)
For looking up elements by calling a test function.
:lambda-table
parser-lambda-table (generic function)
Describes a subelement associated with a slot on an element class.
xml-model.lisp (file)
standard-object (class)
:element-type
descriptor-element-type (generic function)
:multiple
descriptor-multiple (generic function)
alternative node descriptors for this subelement.
:aliases
descriptor-tag-aliases (generic function)
xml-model.lisp (file)
standard-class (class)
element-class (class)
:allowed-elements
node-class-allowed-elements (generic function)
(setf node-class-allowed-elements) (generic function)
:parser
(make-instance (quote org.iodb.xml-mop::standard-parser))
element-class-parser (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 X |
---|
Jump to: | F L M X |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A C D E F G M N O P R |
---|
Jump to: | (
A C D E F G M N O P R |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | A C E L M P R S T |
---|
Jump to: | A C E L M P R S T |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C E N O P S X |
---|
Jump to: | C E N O P S X |
---|