XML-TOOL

Name

XML-TOOL -- class

Description

This class should be subclassed for every domain that needs xml-support. This is the key class of the XML system as it provides the factory for constructing the actual obects and for providing a place to keep the tree.

Class details

(defclass XML-TOOL ()(...))
scopepackage APISPEC-XML
locationapispec/xml.lisp
# variables6
# methods12

Methods

(SETF XML-TOOL.FACTORY)
 ((SETF XML-TOOL.FACTORY) (OBJ XML-TOOL)) [accessor]
Description 

A pointer to an object of type XML-Factory which has been specialised on with produce-xml-object.

XML-TOOL.FACTORY
 (XML-TOOL.FACTORY (OBJ XML-TOOL)) [accessor]
Description 

A pointer to an object of type XML-Factory which has been specialised on with produce-xml-object.

Called By 

PRINT-OBJECT

(SETF XML-TOOL.INDENT)
 ((SETF XML-TOOL.INDENT) (OBJ XML-TOOL)) [accessor]
Description 

is used by the print-as-xml function

XML-TOOL.INDENT
 (XML-TOOL.INDENT (OBJ XML-TOOL)) [accessor]
Description 

is used by the print-as-xml function

(SETF XML-TOOL.STACK)
 ((SETF XML-TOOL.STACK) (OBJ XML-TOOL)) [accessor]
Description 

This stack is used by the parsing functions to keep track of progress in the tree.

XML-TOOL.STACK
 (XML-TOOL.STACK (OBJ XML-TOOL)) [accessor]
Description 

This stack is used by the parsing functions to keep track of progress in the tree.

(SETF XML-TOOL.TOP-OBJECTS)
 ((SETF XML-TOOL.TOP-OBJECTS) (OBJ XML-TOOL)) [accessor]
Description 

The list of the top-objects found in a parse. These objects are usually the root of trees.

XML-TOOL.TOP-OBJECTS
 (XML-TOOL.TOP-OBJECTS (OBJ XML-TOOL)) [accessor]
Description 

The list of the top-objects found in a parse. These objects are usually the root of trees.

Called By 

LINK-CSF-FILES and PARSE-TYPED-XML-FILE

(SETF XML-TOOL.WANT-CONTENT)
 ((SETF XML-TOOL.WANT-CONTENT) (OBJ XML-TOOL)) [accessor]
Description 

initially nil and should be marked non-nil if it expects textual content.

XML-TOOL.WANT-CONTENT
 (XML-TOOL.WANT-CONTENT (OBJ XML-TOOL)) [accessor]
Description 

initially nil and should be marked non-nil if it expects textual content.

(SETF XML-TOOL.WHO-CONTENT)
 ((SETF XML-TOOL.WHO-CONTENT) (OBJ XML-TOOL)) [accessor]
Description 

Can't really remember.. oops! :-)

XML-TOOL.WHO-CONTENT
 (XML-TOOL.WHO-CONTENT (OBJ XML-TOOL)) [accessor]
Description 

Can't really remember.. oops! :-)

Slots

INDENT-LEVEL
slot INDENT-LEVEL is of type FIXNUM
Description 

is used by the print-as-xml function

THE-FACTORY
slot THE-FACTORY is of type T
Description 

A pointer to an object of type XML-Factory which has been specialised on with produce-xml-object.

THE-STACK
slot THE-STACK is of type T
Description 

This stack is used by the parsing functions to keep track of progress in the tree.

TOP-OBJECTS
slot TOP-OBJECTS is of type T
Description 

The list of the top-objects found in a parse. These objects are usually the root of trees.

WANT-CONTENT
slot WANT-CONTENT is of type T
Description 

initially nil and should be marked non-nil if it expects textual content.

WHO-CONTENT
slot WHO-CONTENT is of type T
Description 

Can't really remember.. oops! :-)

Related Methods

APISPEC-XML:PARSE-ELEMENT-CONTENT
 (PARSE-ELEMENT-CONTENT (XTOOL XML-TOOL) CONTENT) [method]
Calls 

ELEMENT-CONTENT, XML-TOOL.STACK and XML-TOOL.WANT-CONTENT

Location 

apispec/xml-base.lisp

APISPEC-XML:PARSE-ELEMENT-END
 (PARSE-ELEMENT-END (XTOOL XML-TOOL) NAME) [method]
Calls 

ELEMENT-END, POP and XML-TOOL.STACK

Location 

apispec/xml-base.lisp

APISPEC-XML:PARSE-ELEMENT-START
 (PARSE-ELEMENT-START (XTOOL XML-TOOL) NAME ATTRS) [method]
Calls 

ELEMENT-START, INIT-ATTRIBUTES, PRODUCE-XML-OBJECT, XML-TOOL.FACTORY, XML-TOOL.STACK and XML-TOOL.TOP-OBJECTS

Location 

apispec/xml-base.lisp

APISPEC-XML:PRINT-OBJECT
 (PRINT-OBJECT (INST XML-TOOL) STREAM) [method]
Calls 

CLASS-NAME, CLASS-OF, FORMAT, INST, PRINT-UNREADABLE-OBJECT and XML-TOOL.FACTORY

Location 

apispec/xml-base.lisp

This documentation was generated 27 Oct 2003 from the original sources by Albert v.0.4.9.