GSSAXHandler

Authors

Michael Pakhantsov

Richard Frith-Macdonald

Version: $Revision$

Date: $Date$

GSSAXHandler

GSSAXHandler

Declared in: GSXML.h

Inherits from: NSObject

XML SAX Handler.

GSSAXHandler is a callback-based interface to the XML parser that operates in a similar (though not identical) manner to SAX.

Each GSSAXHandler object is associated with a GSXMLParser object. As parsing progresses, the mathods of the GSSAXHandler are invoked by the parser, so the handler is able to deal with the elements and entities being parsed.

The callback methods in the GSSAXHandler class do nothing - it is intended that you subclass GSSAXHandler and override them.

Instance Variables

Methods

• +handler
• -attribute:value:
• -attributeDecl:name:type:typeDefValue:defaultValue:
• -cdataBlock:
• -characters:
• -comment:
• -elementDecl:type:
• -endDocument
• -endElement
• -entityDecl:type:publicId:systemId:content:
• -error:
• -externalSubset:externalID:systemID:
• -fatalError:
• -getEntity:
• -getParameterEntity:
• -globalNamespace:href:prefix:
• -hasExternalSubset:
• -hasInternalSubset:
• -ignoreWhitespace:
• -internalSubset:externalID:systemID:
• -isStandalone
• -lib
• -loadEntity:at:
• -namespaceDecl:href:prefix:
• -notationDecl:systemId:
• -parser
• -processInstruction:value:
• -reference:
• -startDocument
• -startElement:attributes:
• -unparsedEntityDecl:public:system:notationName:
• -warning:

Class Methods

handler

Create a new SAX handler.

Instances Methods

lib

Return pointer to xmlSAXHandler structure.

parser

Return the parser object with which this handler is associated. This may occasionally be useful.

startDocument

Called when the document start being processed.

endDocument

Called when the document end has been detected.

isStandalone

Called if the document is standalone.

startElement:attributes:

Called when an opening tag has been processed.

endElement

Called when the end of an element has been detected.

attribute:value:

Handle an attribute that has been read by the parser.

characters:

Receiving some chars from the parser.

ignoreWhitespace:

Receiving some ignorable whitespaces from the parser.

processInstruction:value:

A processing instruction has been parsed.

comment:

A comment has been parsed.

cdataBlock:

Called when a pcdata block has been parsed.

globalNamespace:href:prefix:

An old global namespace has been parsed.

error:

Called when found a error.

fatalError:

Called when found a fatal error.

warning:

Called when found a warning.

hasInternalSubset:

Does this document have an internal subset?

• Return 1 for yes
• Return 0 for no
• Return -1 for don't know (let parser decide)

hasExternalSubset:

Does this document have an external subset.

• Return 1 for yes
• Return 0 for no
• Return -1 for don't know (let parser decide)

internalSubset:externalID:systemID:

Callback on internal subset declaration. Return YES if handled, NO if you want the parser to handle it.

externalSubset:externalID:systemID:

Callback on external subset declaration. Return YES if handled, NO if you want the parser to handle it.

loadEntity:at:

This method controls the loading of external entities into the system. If it returns an empty string, the entity is not loaded. If it returns a filename, the entity is loaded from that file. If it returns nil, the default entity loading mechanism is used.

The default entity loading mechanism is to construct a file name from the locationURL, by replacing all path separators with underscores, then attempt to locate that file in the DTDs resource directory of the main bundle, and all the standard system locations.

As a special case, the default loader examines the publicID and if it is a GNUstep DTD, the loader constructs a special name from the ID (by replacing dots with underscores and spaces with hyphens) and looks for a file with that name and a '.dtd' extension in the GNUstep bundles.

getEntity:

Get an entity by name.

getParameterEntity:

Get a parameter entity by name.

namespaceDecl:href:prefix:

A namespace has been parsed.

notationDecl:systemId:

What to do when a notation declaration has been parsed.

entityDecl:type:publicId:systemId:content:

An entity definition has been parsed.

attributeDecl:name:type:typeDefValue:defaultValue:

An attribute definition has been parsed.

elementDecl:type:

An element definition has been parsed.

unparsedEntityDecl:public:system:notationName:

What to do when an unparsed entity declaration is parsed.

reference:

Called when an entity reference is detected.