mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-28 19:20:51 +00:00
45388db20c
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@9698 72102866-910b-0410-8b05-ffd578937521
424 lines
12 KiB
HTML
424 lines
12 KiB
HTML
<html><head>
|
|
<title>GSSAXHandler</title>
|
|
</head>
|
|
<body>
|
|
<a href ="GSXMLParser.html">[Previous] </a>
|
|
<a href ="GSXML.html">[Up] </a>
|
|
<h1>GSSAXHandler</h1>
|
|
<h3>Authors </h3>
|
|
<dl>
|
|
<dt>Michael Pakhantsov
|
|
<dd>
|
|
<dt>Richard Frith-Macdonald
|
|
<dd>
|
|
</dl>
|
|
<p>Version: $Revision$</p>
|
|
<p>Date: $Date$</p>
|
|
<h2><a name ="cont-0">GSSAXHandler</a></h2>
|
|
<h2><a name ="GSSAXHandler">GSSAXHandler</a></h2>
|
|
<p><b>Declared in: </b> GSXML.h</p>
|
|
<p><b>Inherits from: </b> NSObject</p>
|
|
<hr>
|
|
|
|
<p>
|
|
XML SAX Handler.</p>
|
|
|
|
<p>
|
|
|
|
GSSAXHandler is a callback-based interface to the XML parser
|
|
that operates in a similar (though not identical) manner to
|
|
SAX.
|
|
</p>
|
|
|
|
<p>
|
|
|
|
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.
|
|
</p>
|
|
|
|
<p>
|
|
|
|
The callback methods in the GSSAXHandler class do nothing - it
|
|
is intended that you subclass GSSAXHandler and override them.
|
|
</p>
|
|
|
|
|
|
<h2>Instance Variables </h2>
|
|
<ul>
|
|
</ul>
|
|
<h2>Methods </h2>
|
|
<ul>
|
|
<li ><a href ="GSSAXHandler.html#method-0">+handler</a>
|
|
<li ><a href ="GSSAXHandler.html#method-8">-attribute:value:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-28">-attributeDecl:name:type:typeDefValue:defaultValue:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-13">-cdataBlock:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-9">-characters:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-12">-comment:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-29">-elementDecl:type:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-4">-endDocument</a>
|
|
<li ><a href ="GSSAXHandler.html#method-7">-endElement</a>
|
|
<li ><a href ="GSSAXHandler.html#method-27">-entityDecl:type:publicId:systemId:content:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-15">-error:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-21">-externalSubset:externalID:systemID:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-16">-fatalError:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-23">-getEntity:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-24">-getParameterEntity:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-14">-globalNamespace:href:prefix:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-19">-hasExternalSubset:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-18">-hasInternalSubset:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-10">-ignoreWhitespace:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-20">-internalSubset:externalID:systemID:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-5">-isStandalone</a>
|
|
<li ><a href ="GSSAXHandler.html#method-1">-lib</a>
|
|
<li ><a href ="GSSAXHandler.html#method-22">-loadEntity:at:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-25">-namespaceDecl:href:prefix:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-26">-notationDecl:systemId:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-2">-parser</a>
|
|
<li ><a href ="GSSAXHandler.html#method-11">-processInstruction:value:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-31">-reference:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-3">-startDocument</a>
|
|
<li ><a href ="GSSAXHandler.html#method-6">-startElement:attributes:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-30">-unparsedEntityDecl:public:system:notationName:</a>
|
|
<li ><a href ="GSSAXHandler.html#method-17">-warning:</a>
|
|
</ul>
|
|
<hr><h2>Class Methods </h2>
|
|
<h3><a name ="method-0">handler</a></h3>
|
|
+ (GSSAXHandler*) <b>handler</b>;<br>
|
|
|
|
<p>
|
|
Create a new SAX handler.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<hr><h2>Instances Methods </h2>
|
|
<h3><a name ="method-1">lib</a></h3>
|
|
- (void*) <b>lib</b>;<br>
|
|
|
|
<p>
|
|
|
|
Return pointer to xmlSAXHandler structure.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-2">parser</a></h3>
|
|
- (GSXMLParser*) <b>parser</b>;<br>
|
|
|
|
<p>
|
|
|
|
Return the parser object with which this handler is
|
|
associated. This may occasionally be useful.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-3">startDocument</a></h3>
|
|
- (void) <b>startDocument</b>;<br>
|
|
|
|
<p>
|
|
|
|
Called when the document start being processed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-4">endDocument</a></h3>
|
|
- (void) <b>endDocument</b>;<br>
|
|
|
|
<p>
|
|
|
|
Called when the document end has been detected.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-5">isStandalone</a></h3>
|
|
- (int) <b>isStandalone</b>;<br>
|
|
|
|
<p>
|
|
Called if the document is standalone.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-6">startElement:attributes:</a></h3>
|
|
- (void) <b>startElement:</b> (NSString*)elementName <b>attributes:</b> (NSMutableDictionary*)elementAttributes;<br>
|
|
|
|
<p>
|
|
Called when an opening tag has been processed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-7">endElement</a></h3>
|
|
- (void) <b>endElement</b> (NSString*)elementName;<br>
|
|
|
|
<p>
|
|
Called when the end of an element has been detected.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-8">attribute:value:</a></h3>
|
|
- (void) <b>attribute:</b> (NSString*)name <b>value:</b> (NSString*)value;<br>
|
|
|
|
<p>
|
|
Handle an attribute that has been read by the parser.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-9">characters:</a></h3>
|
|
- (void) <b>characters:</b> (NSString*)name;<br>
|
|
|
|
<p>
|
|
Receiving some chars from the parser.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-10">ignoreWhitespace:</a></h3>
|
|
- (void) <b>ignoreWhitespace:</b> (NSString*)ch;<br>
|
|
|
|
<p>
|
|
Receiving some ignorable whitespaces from the parser.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-11">processInstruction:value:</a></h3>
|
|
- (void) <b>processInstruction:</b> (NSString*)targetName <b>value:</b> (NSString*)PIData;<br>
|
|
|
|
<p>
|
|
A processing instruction has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-12">comment:</a></h3>
|
|
- (void) <b>comment:</b> (NSString*)value;<br>
|
|
|
|
<p>
|
|
A comment has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-13">cdataBlock:</a></h3>
|
|
- (void) <b>cdataBlock:</b> (NSString*)value;<br>
|
|
|
|
<p>
|
|
Called when a pcdata block has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-14">globalNamespace:href:prefix:</a></h3>
|
|
- (void) <b>globalNamespace:</b> (NSString*)name <b>href:</b> (NSString*)href <b>prefix:</b> (NSString*)prefix;<br>
|
|
|
|
<p>
|
|
An old global namespace has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-15">error:</a></h3>
|
|
- (void) <b>error:</b> (NSString*)message;<br>
|
|
|
|
<p>
|
|
Called when found a error.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-16">fatalError:</a></h3>
|
|
- (void) <b>fatalError:</b> (NSString*)message;<br>
|
|
|
|
<p>
|
|
Called when found a fatal error.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-17">warning:</a></h3>
|
|
- (void) <b>warning:</b> (NSString*)message;<br>
|
|
|
|
<p>
|
|
Called when found a warning.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-18">hasInternalSubset:</a></h3>
|
|
- (int) <b>hasInternalSubset:</b>;<br>
|
|
|
|
<p>
|
|
|
|
Does this document have an internal subset?
|
|
</p>
|
|
|
|
<ul>
|
|
<li >Return 1 for yes
|
|
<li >Return 0 for no
|
|
<li >Return -1 for don't know (let parser decide)
|
|
</ul>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-19">hasExternalSubset:</a></h3>
|
|
- (int) <b>hasExternalSubset:</b>;<br>
|
|
|
|
<p>
|
|
|
|
Does this document have an external subset.
|
|
</p>
|
|
|
|
<ul>
|
|
<li >Return 1 for yes
|
|
<li >Return 0 for no
|
|
<li >Return -1 for don't know (let parser decide)
|
|
</ul>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-20">internalSubset:externalID:systemID:</a></h3>
|
|
- (BOOL) <b>internalSubset:</b> (NSString*)name <b>externalID:</b> (NSString*)externalID <b>systemID:</b> (NSString*)systemID;<br>
|
|
|
|
<p>
|
|
|
|
Callback on internal subset declaration.
|
|
Return YES if handled, NO if you want the parser to handle it.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-21">externalSubset:externalID:systemID:</a></h3>
|
|
- (BOOL) <b>externalSubset:</b> (NSString*)name <b>externalID:</b> (NSString*)externalID <b>systemID:</b> (NSString*)systemID;<br>
|
|
|
|
<p>
|
|
|
|
Callback on external subset declaration.
|
|
Return YES if handled, NO if you want the parser to handle it.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-22">loadEntity:at:</a></h3>
|
|
- (NSString*) <b>loadEntity:</b> (NSString*)publicID <b>at:</b> (NSString*)locationURL;<br>
|
|
|
|
<p>
|
|
|
|
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.
|
|
</p>
|
|
|
|
<p>
|
|
|
|
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.
|
|
</p>
|
|
|
|
<p>
|
|
|
|
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.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-23">getEntity:</a></h3>
|
|
- (void*) <b>getEntity:</b> (NSString*)name;<br>
|
|
|
|
<p>
|
|
Get an entity by name.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-24">getParameterEntity:</a></h3>
|
|
- (void*) <b>getParameterEntity:</b> (NSString*)name;<br>
|
|
|
|
<p>
|
|
Get a parameter entity by name.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-25">namespaceDecl:href:prefix:</a></h3>
|
|
- (void) <b>namespaceDecl:</b> (NSString*)name <b>href:</b> (NSString*)href <b>prefix:</b> (NSString*)prefix;<br>
|
|
|
|
<p>
|
|
A namespace has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-26">notationDecl:systemId:</a></h3>
|
|
- (void) <b>notationDecl:</b> (NSString*)publicId <b>systemId:</b> (NSString*)systemId;<br>
|
|
|
|
<p>
|
|
What to do when a notation declaration has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-27">entityDecl:type:publicId:systemId:content:</a></h3>
|
|
- (void) <b>entityDecl:</b> (NSString*)name <b>type:</b> (int)type <b>publicId:</b> (NSString*)publicId <b>systemId:</b> (NSString*)systemId <b>content:</b> (NSString*)content;<br>
|
|
|
|
<p>
|
|
An entity definition has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-28">attributeDecl:name:type:typeDefValue:defaultValue:</a></h3>
|
|
- (void) <b>attributeDecl:</b> (NSString*)nameElement <b>name:</b> (NSString*)name <b>type:</b> (int)type <b>typeDefValue:</b> (int)defType <b>defaultValue:</b> (NSString*)value;<br>
|
|
|
|
<p>
|
|
An attribute definition has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-29">elementDecl:type:</a></h3>
|
|
- (void) <b>elementDecl:</b> (NSString*)name <b>type:</b> (int)type;<br>
|
|
|
|
<p>
|
|
An element definition has been parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-30">unparsedEntityDecl:public:system:notationName:</a></h3>
|
|
- (void) <b>unparsedEntityDecl:</b> (NSString*)name <b>public:</b> (NSString*)publicId <b>system:</b> (NSString*)systemId <b>notationName:</b> (NSString*)notation;<br>
|
|
|
|
<p>
|
|
What to do when an unparsed entity declaration is parsed.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
<h3><a name ="method-31">reference:</a></h3>
|
|
- (void) <b>reference:</b> (NSString*)name;<br>
|
|
|
|
<p>
|
|
Called when an entity reference is detected.
|
|
</p>
|
|
|
|
|
|
<hr>
|
|
</body>
|
|
|
|
</html>
|