API Docs for SAX and DOM                 DOMParser.hpp Go to the documentation of this file. /* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2001 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) 1999, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * <http://www.apache.org/>. */ /* * $Id: DOMParser.hpp,v 1.27 2001/07/27 20:24:21 tng Exp $ * */ #if !defined(DOMPARSER_HPP) #define DOMPARSER_HPP #include <dom/DOM_Document.hpp> #include <framework/XMLDocumentHandler.hpp> #include <framework/XMLErrorReporter.hpp> #include <framework/XMLEntityHandler.hpp> #include <util/ValueStackOf.hpp> #include <validators/DTD/DocTypeHandler.hpp> #include <dom/DOM_DocumentType.hpp> #include <validators/DTD/DTDElementDecl.hpp> class EntityResolver; class ErrorHandler; class XMLPScanToken; class XMLScanner; class XMLValidator; class DOMParser : public XMLDocumentHandler , public XMLErrorReporter , public XMLEntityHandler , public DocTypeHandler { public : // ----------------------------------------------------------------------- // Class types // ----------------------------------------------------------------------- enum ValSchemes { Val_Never , Val_Always , Val_Auto }; // ----------------------------------------------------------------------- // Constructors and Detructor // ----------------------------------------------------------------------- DOMParser(XMLValidator* const valToAdopt = 0); ~DOMParser(); void reset(); // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- DOM_Document getDocument(); ErrorHandler* getErrorHandler(); const ErrorHandler* getErrorHandler() const; EntityResolver* getEntityResolver(); const EntityResolver* getEntityResolver() const; const XMLScanner& getScanner() const; const XMLValidator& getValidator() const; ValSchemes getValidationScheme() const; bool getDoSchema() const; int getErrorCount() const; bool getDoNamespaces() const; bool getExitOnFirstFatalError() const; bool getValidationConstraintFatal() const; bool getExpandEntityReferences() const; bool getCreateEntityReferenceNodes()const; bool getIncludeIgnorableWhitespace() const; bool getToCreateXMLDeclTypeNode() const; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- void setErrorHandler(ErrorHandler* const handler); void setEntityResolver(EntityResolver* const handler); void setDoNamespaces(const bool newState); void setExitOnFirstFatalError(const bool newState); void setValidationConstraintFatal(const bool newState); void setExpandEntityReferences(const bool expand); void setCreateEntityReferenceNodes(const bool create); void setIncludeIgnorableWhitespace(const bool include); void setValidationScheme(const ValSchemes newScheme); void setDoSchema(const bool newState); void setToCreateXMLDeclTypeNode(const bool create); // ----------------------------------------------------------------------- // Parsing methods // ----------------------------------------------------------------------- void parse(const InputSource& source, const bool reuseGrammar = false); void parse(const XMLCh* const systemId, const bool reuseGrammar = false); void parse(const char* const systemId, const bool reuseGrammar = false); bool parseFirst ( const XMLCh* const systemId , XMLPScanToken& toFill , const bool reuseGrammar = false ); bool parseFirst ( const char* const systemId , XMLPScanToken& toFill , const bool reuseGrammar = false ); bool parseFirst ( const InputSource& source , XMLPScanToken& toFill , const bool reuseGrammar = false ); bool parseNext(XMLPScanToken& token); void parseReset(XMLPScanToken& token); // ----------------------------------------------------------------------- // 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 unsigned int lineNum , const unsigned int 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 ); virtual void startInputSource(const InputSource& inputSource); // ----------------------------------------------------------------------- // 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 ); 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 ); bool getDoValidation() const; void setDoValidation(const bool newState); 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 ); 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 ); protected : // ----------------------------------------------------------------------- // Protected getter methods // ----------------------------------------------------------------------- DOM_Node getCurrentNode(); // ----------------------------------------------------------------------- // Protected setter methods // ----------------------------------------------------------------------- void setCurrentNode(DOM_Node toSet); void setDocument(DOM_Document toSet); private : // ----------------------------------------------------------------------- // Private 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. // // fDocument // The root document object, filled with the document contents. // // fEntityResolver // The installed SAX entity resolver, if any. Null if none. // // fErrorHandler // The installed SAX error handler, if any. Null if none. // // fCreateEntityReferenceNode // Indicates whether entity reference nodes should be created. // // fIncludeIgnorableWhitespace // Indicates whether ignorable whiltespace should be added to // the DOM tree for validating parsers. // // 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. // // fScanner // The scanner used for this parser. This is created during the // constructor. // // 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 // // fToCreateXMLDecTypeNode // A flag to create a DOM_XMLDecl node in the ODM tree if it exists // This is an extension to xerces implementation // // ----------------------------------------------------------------------- DOM_Node fCurrentParent; DOM_Node fCurrentNode; DOM_Document fDocument; EntityResolver* fEntityResolver; ErrorHandler* fErrorHandler; bool fCreateEntityReferenceNodes; bool fIncludeIgnorableWhitespace; ValueStackOf<DOM_Node>* fNodeStack; bool fParseInProgress; XMLScanner* fScanner; bool fWithinElement; DocumentTypeImpl* fDocumentType; bool fToCreateXMLDeclTypeNode; }; // --------------------------------------------------------------------------- // DOMParser: Handlers for the XMLEntityHandler interface // --------------------------------------------------------------------------- inline void DOMParser::endInputSource(const InputSource&) { // The DOM entity resolver doesn't handle this } inline bool DOMParser::expandSystemId(const XMLCh* const, XMLBuffer&) { // The DOM entity resolver doesn't handle this return false; } inline void DOMParser::resetEntities() { // Nothing to do on this one } inline void DOMParser::startInputSource(const InputSource&) { // The DOM entity resolver doesn't handle this } // --------------------------------------------------------------------------- // DOMParser: Getter methods // --------------------------------------------------------------------------- inline DOM_Document DOMParser::getDocument() { return fDocument; } inline ErrorHandler* DOMParser::getErrorHandler() { return fErrorHandler; } inline const ErrorHandler* DOMParser::getErrorHandler() const { return fErrorHandler; } inline EntityResolver* DOMParser::getEntityResolver() { return fEntityResolver; } inline const EntityResolver* DOMParser::getEntityResolver() const { return fEntityResolver; } inline bool DOMParser::getExpandEntityReferences() const { return fCreateEntityReferenceNodes; } inline bool DOMParser::getCreateEntityReferenceNodes() const { return fCreateEntityReferenceNodes; } inline bool DOMParser::getIncludeIgnorableWhitespace() const { return fIncludeIgnorableWhitespace; } inline const XMLScanner& DOMParser::getScanner() const { return *fScanner; } inline bool DOMParser::getToCreateXMLDeclTypeNode() const { return fToCreateXMLDeclTypeNode; } // --------------------------------------------------------------------------- // DOMParser: Setter methods // --------------------------------------------------------------------------- inline void DOMParser::setExpandEntityReferences(const bool expand) { fCreateEntityReferenceNodes = expand; } inline void DOMParser::setCreateEntityReferenceNodes(const bool create) { fCreateEntityReferenceNodes = create; } inline void DOMParser::setIncludeIgnorableWhitespace(const bool include) { fIncludeIgnorableWhitespace = include; } inline void DOMParser::setToCreateXMLDeclTypeNode(const bool create) { fToCreateXMLDeclTypeNode = create; } // --------------------------------------------------------------------------- // DOMParser: Protected getter methods // --------------------------------------------------------------------------- inline DOM_Node DOMParser::getCurrentNode() { return fCurrentNode; } // --------------------------------------------------------------------------- // DOMParser: Protected setter methods // --------------------------------------------------------------------------- inline void DOMParser::setCurrentNode(DOM_Node toSet) { fCurrentNode = toSet; } inline void DOMParser::setDocument(DOM_Document toSet) { fDocument = toSet; } #endif

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