API Docs for SAX and DOM   SAXParser.hpp Go to the documentation of this file. /* * Copyright 1999-2004 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* * $Id: SAXParser.hpp 191671 2005-06-21 15:48:06Z cargilld $ */ #if !defined(SAXPARSER_HPP) #define SAXPARSER_HPP #include <xercesc/sax/Parser.hpp> #include <xercesc/internal/VecAttrListImpl.hpp> #include <xercesc/framework/XMLDocumentHandler.hpp> #include <xercesc/framework/XMLElementDecl.hpp> #include <xercesc/framework/XMLEntityHandler.hpp> #include <xercesc/framework/XMLErrorReporter.hpp> #include <xercesc/framework/XMLBuffer.hpp> #include <xercesc/util/SecurityManager.hpp> #include <xercesc/validators/DTD/DocTypeHandler.hpp> XERCES_CPP_NAMESPACE_BEGIN class DocumentHandler; class EntityResolver; class XMLPScanToken; class XMLScanner; class XMLValidator; class Grammar; class GrammarResolver; class XMLGrammarPool; class XMLEntityResolver; class XMLResourceIdentifier; class PSVIHandler; class SAXParser : public XMemory , public Parser , public XMLDocumentHandler , public XMLErrorReporter , public XMLEntityHandler , public DocTypeHandler { public : // ----------------------------------------------------------------------- // Class types // ----------------------------------------------------------------------- enum ValSchemes { Val_Never , Val_Always , Val_Auto }; // ----------------------------------------------------------------------- // Constructors and Destructor // ----------------------------------------------------------------------- SAXParser ( XMLValidator* const valToAdopt = 0 , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager , XMLGrammarPool* const gramPool = 0 ); ~SAXParser(); // ----------------------------------------------------------------------- // Getter Methods // ----------------------------------------------------------------------- DocumentHandler* getDocumentHandler(); const DocumentHandler* getDocumentHandler() const; EntityResolver* getEntityResolver(); const EntityResolver* getEntityResolver() const; XMLEntityResolver* getXMLEntityResolver(); const XMLEntityResolver* getXMLEntityResolver() const; ErrorHandler* getErrorHandler(); const ErrorHandler* getErrorHandler() const; PSVIHandler* getPSVIHandler(); const PSVIHandler* getPSVIHandler() const; const XMLValidator& getValidator() const; ValSchemes getValidationScheme() const; bool getDoSchema() const; bool getValidationSchemaFullChecking() const; bool getIdentityConstraintChecking() const; int getErrorCount() const; bool getDoNamespaces() const; bool getExitOnFirstFatalError() const; bool getValidationConstraintFatal() const; XMLCh* getExternalSchemaLocation() const; XMLCh* getExternalNoNamespaceSchemaLocation() const; SecurityManager* getSecurityManager() const; bool getLoadExternalDTD() const; bool isCachingGrammarFromParse() const; bool isUsingCachedGrammarInParse() const; bool getCalculateSrcOfs() const; bool getStandardUriConformant() const; Grammar* getGrammar(const XMLCh* const nameSpaceKey); Grammar* getRootGrammar(); const XMLCh* getURIText(unsigned int uriId) const; unsigned int getSrcOffset() const; bool getGenerateSyntheticAnnotations() const; bool getValidateAnnotations() const; bool getIgnoreCachedDTD() const; bool getIgnoreAnnotations() const; bool getDisableDefaultEntityResolution() const; bool getSkipDTDValidation() const; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- void setGenerateSyntheticAnnotations(const bool newValue); void setValidateAnnotations(const bool newValue); void setDoNamespaces(const bool newState); void setValidationScheme(const ValSchemes newScheme); void setDoSchema(const bool newState); void setValidationSchemaFullChecking(const bool schemaFullChecking); void setIdentityConstraintChecking(const bool identityConstraintChecking); void setExitOnFirstFatalError(const bool newState); void setValidationConstraintFatal(const bool newState); void setExternalSchemaLocation(const XMLCh* const schemaLocation); void setExternalSchemaLocation(const char* const schemaLocation); void setExternalNoNamespaceSchemaLocation(const XMLCh* const noNamespaceSchemaLocation); void setExternalNoNamespaceSchemaLocation(const char* const noNamespaceSchemaLocation); void setSecurityManager(SecurityManager* const securityManager); void setLoadExternalDTD(const bool newState); void cacheGrammarFromParse(const bool newState); void useCachedGrammarInParse(const bool newState); void setCalculateSrcOfs(const bool newState); void setStandardUriConformant(const bool newState); void useScanner(const XMLCh* const scannerName); void setInputBufferSize(const size_t bufferSize); void setIgnoreCachedDTD(const bool newValue); void setIgnoreAnnotations(const bool newValue); void setDisableDefaultEntityResolution(const bool newValue); void setSkipDTDValidation(const bool newValue); // ----------------------------------------------------------------------- // Advanced document handler list maintenance methods // ----------------------------------------------------------------------- void installAdvDocHandler(XMLDocumentHandler* const toInstall); bool removeAdvDocHandler(XMLDocumentHandler* const toRemove); // ----------------------------------------------------------------------- // Progressive scan methods // ----------------------------------------------------------------------- bool parseFirst ( const XMLCh* const systemId , XMLPScanToken& toFill ); bool parseFirst ( const char* const systemId , XMLPScanToken& toFill ); bool parseFirst ( const InputSource& source , XMLPScanToken& toFill ); bool parseNext(XMLPScanToken& token); void parseReset(XMLPScanToken& token); // ----------------------------------------------------------------------- // Grammar preparsing interface // ----------------------------------------------------------------------- Grammar* loadGrammar(const InputSource& source, const short grammarType, const bool toCache = false); Grammar* loadGrammar(const XMLCh* const systemId, const short grammarType, const bool toCache = false); Grammar* loadGrammar(const char* const systemId, const short grammarType, const bool toCache = false); void resetCachedGrammarPool(); // ----------------------------------------------------------------------- // Implementation of the SAX Parser interface // ----------------------------------------------------------------------- virtual void parse(const InputSource& source); virtual void parse(const XMLCh* const systemId); virtual void parse(const char* const systemId); virtual void setDocumentHandler(DocumentHandler* const handler); virtual void setDTDHandler(DTDHandler* const handler); virtual void setErrorHandler(ErrorHandler* const handler); virtual void setPSVIHandler(PSVIHandler* const handler); virtual void setEntityResolver(EntityResolver* const resolver); virtual void setXMLEntityResolver(XMLEntityResolver* const resolver); // ----------------------------------------------------------------------- // Implementation of the XMLDocumentHandler interface // ----------------------------------------------------------------------- virtual void docCharacters ( const XMLCh* const chars , const unsigned int length , const bool cdataSection ); virtual void docComment ( const XMLCh* const comment ); virtual void docPI ( const XMLCh* const target , const XMLCh* const data ); virtual void endDocument(); virtual void endElement ( const XMLElementDecl& elemDecl , const unsigned int urlId , const bool isRoot , const XMLCh* const elemPrefix ); virtual void endEntityReference ( const XMLEntityDecl& entDecl ); virtual void ignorableWhitespace ( const XMLCh* const chars , const unsigned int length , const bool cdataSection ); virtual void resetDocument(); virtual void startDocument(); virtual void startElement ( const XMLElementDecl& elemDecl , const unsigned int urlId , const XMLCh* const elemPrefix , const RefVectorOf<XMLAttr>& attrList , const unsigned int attrCount , const bool isEmpty , const bool isRoot ); virtual void startEntityReference ( const XMLEntityDecl& entDecl ); virtual void XMLDecl ( const XMLCh* const versionStr , const XMLCh* const encodingStr , const XMLCh* const standaloneStr , const XMLCh* const actualEncodingStr ); // ----------------------------------------------------------------------- // Implementation of the XMLErrorReporter interface // ----------------------------------------------------------------------- virtual void error ( const unsigned int errCode , const XMLCh* const msgDomain , const XMLErrorReporter::ErrTypes errType , const XMLCh* const errorText , const XMLCh* const systemId , const XMLCh* const publicId , const XMLSSize_t lineNum , const XMLSSize_t colNum ); virtual void resetErrors(); // ----------------------------------------------------------------------- // Implementation of the XMLEntityHandler interface // ----------------------------------------------------------------------- virtual void endInputSource(const InputSource& inputSource); virtual bool expandSystemId ( const XMLCh* const systemId , XMLBuffer& toFill ); virtual void resetEntities(); virtual InputSource* resolveEntity ( const XMLCh* const publicId , const XMLCh* const systemId , const XMLCh* const baseURI = 0 ); virtual InputSource* resolveEntity ( XMLResourceIdentifier* resourceIdentifier ); virtual void startInputSource(const InputSource& inputSource); // ----------------------------------------------------------------------- // Implementation of the Deprecated DocTypeHandler Interface // ----------------------------------------------------------------------- virtual void attDef ( const DTDElementDecl& elemDecl , const DTDAttDef& attDef , const bool ignore ); virtual void doctypeComment ( const XMLCh* const comment ); virtual void doctypeDecl ( const DTDElementDecl& elemDecl , const XMLCh* const publicId , const XMLCh* const systemId , const bool hasIntSubset , const bool hasExtSubset = false ); virtual void doctypePI ( const XMLCh* const target , const XMLCh* const data ); virtual void doctypeWhitespace ( const XMLCh* const chars , const unsigned int length ); virtual void elementDecl ( const DTDElementDecl& decl , const bool isIgnored ); virtual void endAttList ( const DTDElementDecl& elemDecl ); virtual void endIntSubset(); virtual void endExtSubset(); virtual void entityDecl ( const DTDEntityDecl& entityDecl , const bool isPEDecl , const bool isIgnored ); virtual void resetDocType(); virtual void notationDecl ( const XMLNotationDecl& notDecl , const bool isIgnored ); virtual void startAttList ( const DTDElementDecl& elemDecl ); virtual void startIntSubset(); virtual void startExtSubset(); virtual void TextDecl ( const XMLCh* const versionStr , const XMLCh* const encodingStr ); // ----------------------------------------------------------------------- // Deprecated Methods // ----------------------------------------------------------------------- bool getDoValidation() const; void setDoValidation(const bool newState); protected : // ----------------------------------------------------------------------- // Protected Methods // ----------------------------------------------------------------------- const XMLScanner& getScanner() const; GrammarResolver* getGrammarResolver() const; private: // ----------------------------------------------------------------------- // Unimplemented constructors and operators // ----------------------------------------------------------------------- SAXParser(const SAXParser&); SAXParser& operator=(const SAXParser&); // ----------------------------------------------------------------------- // Initialize/Cleanup methods // ----------------------------------------------------------------------- void initialize(); void cleanUp(); void resetInProgress(); // ----------------------------------------------------------------------- // Private data members // // fAttrList // A temporary implementation of the basic SAX attribute list // interface. We use this one over and over on each startElement // event to allow SAX-like access to the element attributes. // // fDocHandler // The installed SAX doc handler, if any. Null if none. // // fDTDHandler // The installed SAX DTD handler, if any. Null if none. // // fElemDepth // This is used to track the element nesting depth, so that we can // know when we are inside content. This is so we can ignore char // data outside of content. // // fEntityResolver // The installed SAX entity handler, if any. Null if none. // // fErrorHandler // The installed SAX error handler, if any. Null if none. // // fPSVIHandler // The installed PSVI handler, if any. Null if none. // // fAdvDHCount // fAdvDHList // fAdvDHListSize // This is an array of pointers to XMLDocumentHandlers, which is // how we see installed advanced document handlers. There will // usually not be very many at all, so a simple array is used // instead of a collection, for performance. It will grow if needed, // but that is unlikely. // // The count is how many handlers are currently installed. The size // is how big the array itself is (for expansion purposes.) When // count == size, is time to expand. // // fParseInProgress // This flag is set once a parse starts. It is used to prevent // multiple entrance or reentrance of the parser. // // fScanner // The scanner being used by this parser. It is created internally // during construction. // // fGrammarPool // The grammar pool passed from external application (through derivatives). // which could be 0, not owned. // // ----------------------------------------------------------------------- bool fParseInProgress; unsigned int fElemDepth; unsigned int fAdvDHCount; unsigned int fAdvDHListSize; VecAttrListImpl fAttrList; DocumentHandler* fDocHandler; DTDHandler* fDTDHandler; EntityResolver* fEntityResolver; XMLEntityResolver* fXMLEntityResolver; ErrorHandler* fErrorHandler; PSVIHandler* fPSVIHandler; XMLDocumentHandler** fAdvDHList; XMLScanner* fScanner; GrammarResolver* fGrammarResolver; XMLStringPool* fURIStringPool; XMLValidator* fValidator; MemoryManager* fMemoryManager; XMLGrammarPool* fGrammarPool; XMLBuffer fElemQNameBuf; }; // --------------------------------------------------------------------------- // SAXParser: Getter methods // --------------------------------------------------------------------------- inline DocumentHandler* SAXParser::getDocumentHandler() { return fDocHandler; } inline const DocumentHandler* SAXParser::getDocumentHandler() const { return fDocHandler; } inline EntityResolver* SAXParser::getEntityResolver() { return fEntityResolver; } inline XMLEntityResolver* SAXParser::getXMLEntityResolver() { return fXMLEntityResolver; } inline const XMLEntityResolver* SAXParser::getXMLEntityResolver() const { return fXMLEntityResolver; } inline const EntityResolver* SAXParser::getEntityResolver() const { return fEntityResolver; } inline ErrorHandler* SAXParser::getErrorHandler() { return fErrorHandler; } inline const ErrorHandler* SAXParser::getErrorHandler() const { return fErrorHandler; } inline PSVIHandler* SAXParser::getPSVIHandler() { return fPSVIHandler; } inline const PSVIHandler* SAXParser::getPSVIHandler() const { return fPSVIHandler; } inline const XMLScanner& SAXParser::getScanner() const { return *fScanner; } inline GrammarResolver* SAXParser::getGrammarResolver() const { return fGrammarResolver; } XERCES_CPP_NAMESPACE_END #endif

Copyright © 1994-2004 The Apache Software Foundation. All Rights Reserved.