mirror of
https://github.com/gnustep/libs-base.git
synced 2025-05-30 16:30:41 +00:00
Added pre-alpha NSXMLPzarser compatibility layer.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@20238 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald
parent
95954a9914
commit
8e9075305e
8 changed files with 1068 additions and 0 deletions
368
Headers/Foundation/NSXMLParser.h
Normal file
368
Headers/Foundation/NSXMLParser.h
Normal file
|
|
@ -0,0 +1,368 @@
|
|||
/** Interface for NSXMLParser for GNUStep
|
||||
Copyright (C) 2004 Free Software Foundation, Inc.
|
||||
|
||||
Written by: Richard Frith-Macdonald <rfm@gnu.org>
|
||||
Date: May 2004
|
||||
|
||||
This file is part of the GNUstep Base Library.
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Library General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Library General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Library General Public
|
||||
License along with this library; if not, write to the Free
|
||||
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
|
||||
|
||||
AutogsdocSource: NSXMLParser.m
|
||||
*/
|
||||
|
||||
#ifndef __NSXMLParser_h_GNUSTEP_BASE_INCLUDE
|
||||
#define __NSXMLParser_h_GNUSTEP_BASE_INCLUDE
|
||||
|
||||
#ifndef STRICT_OPENSTEP
|
||||
|
||||
#include <Foundation/NSObject.h>
|
||||
|
||||
@class NSData, NSDictionary, NSError, NSString, NSURL;
|
||||
|
||||
/**
|
||||
* Domain for errors
|
||||
*/
|
||||
GS_EXPORT NSString* const NSXMLParserErrorDomain;
|
||||
|
||||
/**
|
||||
* This class is a PRE-ALPHA implementation. You should be prepared to
|
||||
* track down and fix bugs and prefereably contribute fixes back.<br />
|
||||
* If you don't want to do that, use the [GSXMLParser] class instead ...
|
||||
* This NSXMLParser class is implemented as a wrapper round some of the
|
||||
* functionality of the more powerful GSXML APis, and is intended as a
|
||||
* MacOSX compatibility feature.
|
||||
* <p>
|
||||
* This class implements an event driven parser handling the parsing
|
||||
* process by sending messages to a delegate when certain parts of the
|
||||
* XML document being parsed are encountered.
|
||||
* </p>
|
||||
* <p>
|
||||
* To use the class, you create and initialise an instance with a particular
|
||||
* XML document, set the delegate of the instance, and send a -parse message
|
||||
* to it. The delegate must then make use of the information it receives
|
||||
* in the messages it gets from the parser.
|
||||
* </p>
|
||||
* <p>
|
||||
* The [NSObject(NSXMLParserDelegateEventAdditions)] informal protocol
|
||||
* documents the methods which the delegate object may implement in order
|
||||
* to handle the parsing process.
|
||||
* </p>
|
||||
*/
|
||||
@interface NSXMLParser : NSObject
|
||||
{
|
||||
@private
|
||||
void *_parser; // GSXMLParser
|
||||
void *_handler; // SAXHandler
|
||||
}
|
||||
|
||||
/**
|
||||
* Terminates the current parse operation and sends an error to the
|
||||
* delegate of the parser.
|
||||
*/
|
||||
- (void) abortParsing;
|
||||
|
||||
/**
|
||||
* Returns the delegate previously set using -setDelegate: or nil if
|
||||
* no delegate is set.
|
||||
*/
|
||||
- (id) delegate;
|
||||
|
||||
/**
|
||||
* Convenience method fetching data from anURL.<br />
|
||||
*/
|
||||
- (id) initWithContentsOfURL: (NSURL*)anURL;
|
||||
|
||||
/** <init />
|
||||
* Initialises the parser with the specified xml data.
|
||||
*/
|
||||
- (id) initWithData: (NSData*)data;
|
||||
|
||||
/**
|
||||
* Parses the supplied data and returns YES on succdess, NO otherwise.
|
||||
*/
|
||||
- (BOOL) parse;
|
||||
|
||||
/**
|
||||
* Returns the last error produced by parsing (if any).
|
||||
*/
|
||||
- (NSError*) parserError;
|
||||
|
||||
/**
|
||||
* Sets the parser delegate (which is not retained).
|
||||
*/
|
||||
- (void) setDelegate: (id)delegate;
|
||||
|
||||
/**
|
||||
* Set flag to determine whether the namespaceURI and the qualified name
|
||||
* of an element is provided in the
|
||||
* [NSObject-parser:didStartElement:namespaceURI:qualifiedName:attributes:]
|
||||
* and [NSObject-parser:didEndElement:namespaceURI:qualifiedName:] methods.
|
||||
*/
|
||||
- (void) setShouldProcessNamespaces: (BOOL)aFlag;
|
||||
|
||||
/**
|
||||
* Sets a flag to specify whether the parser should call the
|
||||
* [NSObject-parser:didStartMappingPrefix:toURI:] and
|
||||
* [NSObject-parser:didEndMappingPrefix:] delegate methods.
|
||||
*/
|
||||
- (void) setShouldReportNamespacePrefixes: (BOOL)aFlag;
|
||||
|
||||
/**
|
||||
* Sets flag to determine if declarations of external entities are
|
||||
* reported using
|
||||
* [NSObject-parser:foundExternalEntityDeclarationWithName:publicID:systemID:]
|
||||
*/
|
||||
- (void) setShouldResolveExternalEntities: (BOOL)aFlag;
|
||||
|
||||
/**
|
||||
* Returns the value set by -setShouldProcessNamespaces:
|
||||
*/
|
||||
- (BOOL) shouldProcessNamespaces;
|
||||
|
||||
/**
|
||||
* Returns the value set by -setShouldReportNamespacePrefixes:
|
||||
*/
|
||||
- (BOOL) shouldReportNamespacePrefixes;
|
||||
|
||||
/**
|
||||
* Returns the value set by -setShouldResolveExternalEntities:
|
||||
*/
|
||||
- (BOOL) shouldResolveExternalEntities;
|
||||
|
||||
@end
|
||||
|
||||
@interface NSXMLParser (NSXMLParserLocatorAdditions)
|
||||
/**
|
||||
* Returns the current column number of the document being parsed.
|
||||
*/
|
||||
- (int) columnNumber;
|
||||
|
||||
/**
|
||||
* Returns the current line number of the document being parsed.
|
||||
*/
|
||||
- (int) lineNumber;
|
||||
|
||||
/**
|
||||
* Returns the public identifier of the external entity in the
|
||||
* document being parsed.
|
||||
*/
|
||||
- (NSString*) publicID;
|
||||
|
||||
/**
|
||||
* Returns the system identifier of the external entity in the
|
||||
* document being parsed.
|
||||
*/
|
||||
- (NSString*) systemID;
|
||||
@end
|
||||
|
||||
/**
|
||||
* Methods implemented by a delegate in order to make use of the parser.<br />
|
||||
* This is an informal protocol.
|
||||
*/
|
||||
@interface NSObject (NSXMLParserDelegateEventAdditions)
|
||||
|
||||
- (NSData*) parser: (NSXMLParser*)aParser
|
||||
resolveExternalEntityName: (NSString*)aName
|
||||
systemID: (NSString*)aSystemID;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
didEndElement: (NSString*)anElementName
|
||||
namespaceURI: (NSString*)aNamespaceURI
|
||||
qualifiedName: (NSString*)aQualifierName;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
didEndMappingPrefix: (NSString*)aPrefix;
|
||||
|
||||
/**
|
||||
* Called when the start of an element is encountered in the document,
|
||||
* this provides the name of the element, a dictionary containing the
|
||||
* attributes (if any) and (where namespaces are used) the namespace
|
||||
* information for the element.
|
||||
*/
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
didStartElement: (NSString*)anElementName
|
||||
namespaceURI: (NSString*)aNamespaceURI
|
||||
qualifiedName: (NSString*)aQualifierName
|
||||
attributes: (NSDictionary*)anAttributeDict;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
didStartMappingPrefix: (NSString*)aPrefix
|
||||
toURI: (NSString*)aNamespaceURI;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundAttributeDeclarationWithName: (NSString*)anAttributeName
|
||||
forElement: (NSString*)anElementName
|
||||
type: (NSString*)aType
|
||||
defaultValue: (NSString*)aDefaultValue;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundCDATA: (NSData*)aBlock;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundCharacters: (NSString*)aString;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundComment: (NSString*)aComment;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundElementDeclarationWithName: (NSString*)anElementName
|
||||
model: (NSString*)aModel;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundExternalEntityDeclarationWithName: (NSString*)aName
|
||||
publicID: (NSString*)aPublicID
|
||||
systemID: (NSString*)aSystemID;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundIgnorableWhitespace: (NSString*)aWhitespaceString;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundInternalEntityDeclarationWithName: (NSString*)aName
|
||||
value: (NSString*)aValue;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundNotationDeclarationWithName: (NSString*)aName
|
||||
publicID: (NSString*)aPublicID
|
||||
systemID: (NSString*)aSystemID;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundProcessingInstructionWithTarget: (NSString*)aTarget
|
||||
data: (NSString*)aData;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
foundUnparsedEntityDeclarationWithName: (NSString*)aName
|
||||
publicID: (NSString*)aPublicID
|
||||
systemID: (NSString*)aSystemID
|
||||
notationName: (NSString*)aNotationName;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
parseErrorOccurred: (NSError*)anError;
|
||||
|
||||
- (void) parser: (NSXMLParser*)aParser
|
||||
validationErrorOccurred: (NSError*)anError;
|
||||
|
||||
/**
|
||||
* Called when parsing ends.
|
||||
*/
|
||||
- (void) parserDidEndDocument: (NSXMLParser*)aParser;
|
||||
|
||||
/**
|
||||
* Called when parsing begins.
|
||||
*/
|
||||
- (void) parserDidStartDocument: (NSXMLParser*)aParser;
|
||||
@end
|
||||
|
||||
/*
|
||||
* Provide the same error codes as MacOS-X, even if we don't use them all.
|
||||
*/
|
||||
typedef enum {
|
||||
NSXMLParserInternalError = 1,
|
||||
NSXMLParserOutOfMemoryError = 2,
|
||||
NSXMLParserDocumentStartError = 3,
|
||||
NSXMLParserEmptyDocumentError = 4,
|
||||
NSXMLParserPrematureDocumentEndError = 5,
|
||||
NSXMLParserInvalidHexCharacterRefError = 6,
|
||||
NSXMLParserInvalidDecimalCharacterRefError = 7,
|
||||
NSXMLParserInvalidCharacterRefError = 8,
|
||||
NSXMLParserInvalidCharacterError = 9,
|
||||
NSXMLParserCharacterRefAtEOFError = 10,
|
||||
NSXMLParserCharacterRefInPrologError = 11,
|
||||
NSXMLParserCharacterRefInEpilogError = 12,
|
||||
NSXMLParserCharacterRefInDTDError = 13,
|
||||
NSXMLParserEntityRefAtEOFError = 14,
|
||||
NSXMLParserEntityRefInPrologError = 15,
|
||||
NSXMLParserEntityRefInEpilogError = 16,
|
||||
NSXMLParserEntityRefInDTDError = 17,
|
||||
NSXMLParserParsedEntityRefAtEOFError = 18,
|
||||
NSXMLParserParsedEntityRefInPrologError = 19,
|
||||
NSXMLParserParsedEntityRefInEpilogError = 20,
|
||||
NSXMLParserParsedEntityRefInInternalSubsetError = 21,
|
||||
NSXMLParserEntityReferenceWithoutNameError = 22,
|
||||
NSXMLParserEntityReferenceMissingSemiError = 23,
|
||||
NSXMLParserParsedEntityRefNoNameError = 24,
|
||||
NSXMLParserParsedEntityRefMissingSemiError = 25,
|
||||
NSXMLParserUndeclaredEntityError = 26,
|
||||
NSXMLParserUnparsedEntityError = 28,
|
||||
NSXMLParserEntityIsExternalError = 29,
|
||||
NSXMLParserEntityIsParameterError = 30,
|
||||
NSXMLParserUnknownEncodingError = 31,
|
||||
NSXMLParserEncodingNotSupportedError = 32,
|
||||
NSXMLParserStringNotStartedError = 33,
|
||||
NSXMLParserStringNotClosedError = 34,
|
||||
NSXMLParserNamespaceDeclarationError = 35,
|
||||
NSXMLParserEntityNotStartedError = 36,
|
||||
NSXMLParserEntityNotFinishedError = 37,
|
||||
NSXMLParserLessThanSymbolInAttributeError = 38,
|
||||
NSXMLParserAttributeNotStartedError = 39,
|
||||
NSXMLParserAttributeNotFinishedError = 40,
|
||||
NSXMLParserAttributeHasNoValueError = 41,
|
||||
NSXMLParserAttributeRedefinedError = 42,
|
||||
NSXMLParserLiteralNotStartedError = 43,
|
||||
NSXMLParserLiteralNotFinishedError = 44,
|
||||
NSXMLParserCommentNotFinishedError = 45,
|
||||
NSXMLParserProcessingInstructionNotStartedError = 46,
|
||||
NSXMLParserProcessingInstructionNotFinishedError = 47,
|
||||
NSXMLParserNotationNotStartedError = 48,
|
||||
NSXMLParserNotationNotFinishedError = 49,
|
||||
NSXMLParserAttributeListNotStartedError = 50,
|
||||
NSXMLParserAttributeListNotFinishedError = 51,
|
||||
NSXMLParserMixedContentDeclNotStartedError = 52,
|
||||
NSXMLParserMixedContentDeclNotFinishedError = 53,
|
||||
NSXMLParserElementContentDeclNotStartedError = 54,
|
||||
NSXMLParserElementContentDeclNotFinishedError = 55,
|
||||
NSXMLParserXMLDeclNotStartedError = 56,
|
||||
NSXMLParserXMLDeclNotFinishedError = 57,
|
||||
NSXMLParserConditionalSectionNotStartedError = 58,
|
||||
NSXMLParserConditionalSectionNotFinishedError = 59,
|
||||
NSXMLParserExternalSubsetNotFinishedError = 60,
|
||||
NSXMLParserDOCTYPEDeclNotFinishedError = 61,
|
||||
NSXMLParserMisplacedCDATAEndStringError = 62,
|
||||
NSXMLParserCDATANotFinishedError = 63,
|
||||
NSXMLParserMisplacedXMLDeclarationError = 64,
|
||||
NSXMLParserSpaceRequiredError = 65,
|
||||
NSXMLParserSeparatorRequiredError = 66,
|
||||
NSXMLParserNMTOKENRequiredError = 67,
|
||||
NSXMLParserNAMERequiredError = 68,
|
||||
NSXMLParserPCDATARequiredError = 69,
|
||||
NSXMLParserURIRequiredError = 70,
|
||||
NSXMLParserPublicIdentifierRequiredError = 71,
|
||||
NSXMLParserLTRequiredError = 72,
|
||||
NSXMLParserGTRequiredError = 73,
|
||||
NSXMLParserLTSlashRequiredError = 74,
|
||||
NSXMLParserEqualExpectedError = 75,
|
||||
NSXMLParserTagNameMismatchError = 76,
|
||||
NSXMLParserUnfinishedTagError = 77,
|
||||
NSXMLParserStandaloneValueError = 78,
|
||||
NSXMLParserInvalidEncodingNameError = 79,
|
||||
NSXMLParserCommentContainsDoubleHyphenError = 80,
|
||||
NSXMLParserInvalidEncodingError = 81,
|
||||
NSXMLParserExternalStandaloneEntityError = 82,
|
||||
NSXMLParserInvalidConditionalSectionError = 83,
|
||||
NSXMLParserEntityValueRequiredError = 84,
|
||||
NSXMLParserNotWellBalancedError = 85,
|
||||
NSXMLParserExtraContentError = 86,
|
||||
NSXMLParserInvalidCharacterInEntityError = 87,
|
||||
NSXMLParserParsedEntityRefInInternalError = 88,
|
||||
NSXMLParserEntityRefLoopError = 89,
|
||||
NSXMLParserEntityBoundaryError = 90,
|
||||
NSXMLParserInvalidURIError = 91,
|
||||
NSXMLParserURIFragmentError = 92,
|
||||
NSXMLParserNoDTDError = 94,
|
||||
NSXMLParserDelegateAbortedParseError = 512
|
||||
} NSXMLParserError;
|
||||
|
||||
#endif /* STRICT_OPENSTEP */
|
||||
#endif /* __NSXMLParser_h_GNUSTEP_BASE_INCLUDE*/
|
||||
Loading…
Add table
Add a link
Reference in a new issue