API Docs for SAX and DOM                 AbstractDOMParser.hpp Go to the documentation of this file. /* * The Apache Software License, Version 1.1 * * Copyright (c) 2002, 2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 2001, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * <http://www.apache.org/>. */ /* * $Id: AbstractDOMParser.hpp,v 1.26 2003/12/01 23:23:26 neilg Exp $ * */ #if !defined(ABSTRACTDOMPARSER_HPP) #define ABSTRACTDOMPARSER_HPP #include <xercesc/dom/DOMDocument.hpp> #include <xercesc/framework/XMLDocumentHandler.hpp> #include <xercesc/framework/XMLErrorReporter.hpp> #include <xercesc/framework/XMLEntityHandler.hpp> #include <xercesc/util/SecurityManager.hpp> #include <xercesc/util/ValueStackOf.hpp> #include <xercesc/validators/DTD/DocTypeHandler.hpp> #include <xercesc/dom/DOMDocumentType.hpp> #include <xercesc/validators/DTD/DTDElementDecl.hpp> #include <xercesc/framework/XMLBufferMgr.hpp> XERCES_CPP_NAMESPACE_BEGIN class XMLPScanToken; class XMLScanner; class XMLValidator; class DOMDocumentImpl; class DOMDocumentTypeImpl; class DOMElement; class GrammarResolver; class XMLGrammarPool; class PSVIHandler; class AbstractDOMParser : public XMemory , public XMLDocumentHandler , public XMLErrorReporter , public XMLEntityHandler , public DocTypeHandler { public : // ----------------------------------------------------------------------- // Class types // ----------------------------------------------------------------------- enum ValSchemes { Val_Never , Val_Always , Val_Auto }; // ----------------------------------------------------------------------- // Constructors and Detructor // ----------------------------------------------------------------------- virtual ~AbstractDOMParser(); // ----------------------------------------------------------------------- // Utility methods // ----------------------------------------------------------------------- void reset(); DOMDocument* adoptDocument(); // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- DOMDocument* getDocument(); const XMLValidator& getValidator() const; ValSchemes getValidationScheme() const; bool getDoSchema() const; bool getValidationSchemaFullChecking() const; int getErrorCount() const; bool getDoNamespaces() const; bool getExitOnFirstFatalError() const; bool getValidationConstraintFatal() const; bool getCreateEntityReferenceNodes()const; bool getIncludeIgnorableWhitespace() const; XMLCh* getExternalSchemaLocation() const; XMLCh* getExternalNoNamespaceSchemaLocation() const; SecurityManager* getSecurityManager() const; bool getLoadExternalDTD() const; bool getCreateCommentNodes()const; bool getCalculateSrcOfs() const; bool getStandardUriConformant() const; PSVIHandler* getPSVIHandler(); const PSVIHandler* getPSVIHandler() const; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- void setDoNamespaces(const bool newState); void setExitOnFirstFatalError(const bool newState); void setValidationConstraintFatal(const bool newState); void setCreateEntityReferenceNodes(const bool create); void setIncludeIgnorableWhitespace(const bool include); void setValidationScheme(const ValSchemes newScheme); void setDoSchema(const bool newState); void setValidationSchemaFullChecking(const bool schemaFullChecking); 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 setCreateCommentNodes(const bool create); void setCalculateSrcOfs(const bool newState); void setStandardUriConformant(const bool newState); void useScanner(const XMLCh* const scannerName); void useImplementation(const XMLCh* const implementationFeatures); virtual void setPSVIHandler(PSVIHandler* const handler); // ----------------------------------------------------------------------- // Parsing methods // ----------------------------------------------------------------------- void parse(const InputSource& source); void parse(const XMLCh* const systemId); void parse(const char* const systemId); 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); // ----------------------------------------------------------------------- // 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 actualEncStr ); virtual void elementTypeInfo ( const XMLCh* const typeName , const XMLCh* const typeURI ); // ----------------------------------------------------------------------- // Implementation of the deprecated DocTypeHandler interface. // ----------------------------------------------------------------------- virtual void attDef ( const DTDElementDecl& elemDecl , const DTDAttDef& attDef , const bool ignoring ); 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); bool getExpandEntityReferences() const; void setExpandEntityReferences(const bool expand); protected : // ----------------------------------------------------------------------- // Protected Constructor Methods // ----------------------------------------------------------------------- AbstractDOMParser ( XMLValidator* const valToAdopt = 0 , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager , XMLGrammarPool* const gramPool = 0 ); // ----------------------------------------------------------------------- // Protected getter methods // ----------------------------------------------------------------------- DOMNode* getCurrentNode(); XMLScanner* getScanner() const; GrammarResolver* getGrammarResolver() const; bool getParseInProgress() const; MemoryManager* getMemoryManager() const; // ----------------------------------------------------------------------- // Protected setter methods // ----------------------------------------------------------------------- void setCurrentNode(DOMNode* toSet); void setDocument(DOMDocument* toSet); void setParseInProgress(const bool toSet); // ----------------------------------------------------------------------- // Protected Helper methods // ----------------------------------------------------------------------- virtual DOMElement* createElementNSNode(const XMLCh *fNamespaceURI, const XMLCh *qualifiedName); void resetPool(); bool isDocumentAdopted() const; private : // ----------------------------------------------------------------------- // Initialize/Cleanup methods // ----------------------------------------------------------------------- void initialize(); void cleanUp(); protected: // ----------------------------------------------------------------------- // Protected data members // // fCurrentNode // fCurrentParent // Used to track the current node during nested element events. Since // the tree must be built from a set of disjoint callbacks, we need // these to keep up with where we currently are. // // fCurrentEntity // Used to track the current entity decl. If a text decl is seen later on, // it is used to update the encoding and version information. // // fDocument // The root document object, filled with the document contents. // // fCreateEntityReferenceNodes // Indicates whether entity reference nodes should be created. // // fIncludeIgnorableWhitespace // Indicates whether ignorable whiltespace should be added to // the DOM tree for validating parsers. // // fScanner // The scanner used for this parser. This is created during the // constructor. // // fImplementationFeatures // The implementation features that we use to get an implementation // for use in creating the DOMDocument used during parse. If this is // null then the default DOMImplementation is used // // fNodeStack // Used to track previous parent nodes during nested element events. // // fParseInProgress // Used to prevent multiple entrance to the parser while its doing // a parse. // // fWithinElement // A flag to indicate that the parser is within at least one level // of element processing. // // fDocumentType // Used to store and update the documentType variable information // in fDocument // // fDocumentVector // Store all the previous fDocument(s) (thus not the current fDocument) // created in this parser. It is destroyed when the parser is destructed. // // fCreateCommentNodes // Indicates whether comment nodes should be created. // // fDocumentAdoptedByUser // The DOMDocument ownership has been transferred to application // If set to true, the parser does not own the document anymore // and thus will not release its memory. // // fInternalSubset // Buffer for storing the internal subset information. // Once complete (after DOCTYPE is finished scanning), send // it to DocumentType Node // // fGrammarPool // The grammar pool passed from external application (through derivatives). // which could be 0, not owned. // // ----------------------------------------------------------------------- bool fCreateEntityReferenceNodes; bool fIncludeIgnorableWhitespace; bool fWithinElement; bool fParseInProgress; bool fCreateCommentNodes; bool fDocumentAdoptedByUser; XMLScanner* fScanner; XMLCh* fImplementationFeatures; DOMNode* fCurrentParent; DOMNode* fCurrentNode; DOMEntity* fCurrentEntity; DOMDocumentImpl* fDocument; ValueStackOf<DOMNode*>* fNodeStack; DOMDocumentTypeImpl* fDocumentType; RefVectorOf<DOMDocumentImpl>* fDocumentVector; GrammarResolver* fGrammarResolver; XMLStringPool* fURIStringPool; XMLValidator* fValidator; MemoryManager* fMemoryManager; XMLGrammarPool* fGrammarPool; XMLBufferMgr fBufMgr; XMLBuffer& fInternalSubset; PSVIHandler* fPSVIHandler; }; // --------------------------------------------------------------------------- // AbstractDOMParser: Getter methods // --------------------------------------------------------------------------- inline bool AbstractDOMParser::getExpandEntityReferences() const { return !fCreateEntityReferenceNodes; } inline bool AbstractDOMParser::getCreateEntityReferenceNodes() const { return fCreateEntityReferenceNodes; } inline bool AbstractDOMParser::getIncludeIgnorableWhitespace() const { return fIncludeIgnorableWhitespace; } inline bool AbstractDOMParser::getParseInProgress() const { return fParseInProgress; } inline XMLScanner* AbstractDOMParser::getScanner() const { return fScanner; } inline GrammarResolver* AbstractDOMParser::getGrammarResolver() const { return fGrammarResolver; } inline bool AbstractDOMParser::getCreateCommentNodes() const { return fCreateCommentNodes; } inline PSVIHandler* AbstractDOMParser::getPSVIHandler() { return fPSVIHandler; } inline const PSVIHandler* AbstractDOMParser::getPSVIHandler() const { return fPSVIHandler; } // --------------------------------------------------------------------------- // AbstractDOMParser: Setter methods // --------------------------------------------------------------------------- inline void AbstractDOMParser::setExpandEntityReferences(const bool expand) { fCreateEntityReferenceNodes = !expand; } inline void AbstractDOMParser::setCreateEntityReferenceNodes(const bool create) { fCreateEntityReferenceNodes = create; } inline void AbstractDOMParser::setIncludeIgnorableWhitespace(const bool include) { fIncludeIgnorableWhitespace = include; } inline void AbstractDOMParser::setCreateCommentNodes(const bool create) { fCreateCommentNodes = create; } inline void AbstractDOMParser::useImplementation(const XMLCh* const implementationFeatures) { fMemoryManager->deallocate(fImplementationFeatures); fImplementationFeatures = XMLString::replicate(implementationFeatures, fMemoryManager); } // --------------------------------------------------------------------------- // AbstractDOMParser: Protected getter methods // --------------------------------------------------------------------------- inline DOMNode* AbstractDOMParser::getCurrentNode() { return fCurrentNode; } inline MemoryManager* AbstractDOMParser::getMemoryManager() const { return fMemoryManager; } // --------------------------------------------------------------------------- // AbstractDOMParser: Protected setter methods // --------------------------------------------------------------------------- inline void AbstractDOMParser::setCurrentNode(DOMNode* toSet) { fCurrentNode = toSet; } inline void AbstractDOMParser::setDocument(DOMDocument* toSet) { fDocument = (DOMDocumentImpl *)toSet; } inline void AbstractDOMParser::setParseInProgress(const bool toSet) { fParseInProgress = toSet; } XERCES_CPP_NAMESPACE_END #endif

Copyright © 2003 The Apache Software Foundation. All Rights Reserved.