AbstractDOMParser.hpp

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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$
 */
 
#if !defined(XERCESC_INCLUDE_GUARD_ABSTRACTDOMPARSER_HPP)
#define XERCESC_INCLUDE_GUARD_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>
#include <xercesc/framework/psvi/PSVIHandler.hpp>
 
XERCES_CPP_NAMESPACE_BEGIN
 
class XMLPScanToken;
class XMLScanner;
class XMLValidator;
class DOMDocumentImpl;
class DOMDocumentTypeImpl;
class DOMEntityImpl;
class DOMElement;
class GrammarResolver;
class XMLGrammarPool;
class PSVIHandler;
 
class PARSERS_EXPORT AbstractDOMParser :
 
    public XMemory
    , public XMLDocumentHandler
    , public XMLErrorReporter
    , public XMLEntityHandler
    , public DocTypeHandler
    , public PSVIHandler
{
public :
    // -----------------------------------------------------------------------
    //  Class types
    // -----------------------------------------------------------------------
 
    enum ValSchemes
    {
        Val_Never
        , Val_Always
        , Val_Auto
    };
 
 
 
    // -----------------------------------------------------------------------
    //  Constructors and Destructor
    // -----------------------------------------------------------------------
 
    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;
 
    bool getIdentityConstraintChecking() const;
 
    XMLSize_t 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;
 
    const XMLSize_t& getLowWaterMark() const;
 
    bool getDisallowDoctype() const;
 
    bool getLoadExternalDTD() const;
 
    bool getLoadSchema() const;
 
    bool  getCreateCommentNodes()const;
 
    bool getCalculateSrcOfs() const;
 
    bool getStandardUriConformant() const;
 
    PSVIHandler* getPSVIHandler();
 
    const PSVIHandler* getPSVIHandler() const;
 
    bool getCreateSchemaInfo() const;
 
    bool getDoXInclude() const;
 
    bool getGenerateSyntheticAnnotations() const;
 
    bool getValidateAnnotations() const;
 
    bool getIgnoreAnnotations() const;
 
    bool getDisableDefaultEntityResolution() const;
 
    bool getSkipDTDValidation() const;
 
    bool getHandleMultipleImports() const;
 
 
    // -----------------------------------------------------------------------
    //  Setter methods
    // -----------------------------------------------------------------------
 
    void setGenerateSyntheticAnnotations(const bool newValue);
 
    void setValidateAnnotations(const bool newValue);
 
    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 setIdentityConstraintChecking(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 setLowWaterMark(XMLSize_t lwm);
 
    void setDisallowDoctype(const bool newState);
 
    void setLoadExternalDTD(const bool newState);
 
    void setLoadSchema(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);
 
    void  setCreateSchemaInfo(const bool newState);
 
    void  setDoXInclude(const bool newState);
 
    void setIgnoreAnnotations(const bool newValue);
 
    void setDisableDefaultEntityResolution(const bool newValue);
 
    void setSkipDTDValidation(const bool newValue);
 
    void setHandleMultipleImports(const bool newValue);
 
 
    // -----------------------------------------------------------------------
    //  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 PSVIHandler interface.
    // -----------------------------------------------------------------------
 
 
    virtual void handleElementPSVI
    (
        const   XMLCh* const            localName
        , const XMLCh* const            uri
        ,       PSVIElement *           elementInfo
    );
 
    virtual void handlePartialElementPSVI
    (
        const   XMLCh* const            localName
        , const XMLCh* const            uri
        ,       PSVIElement *           elementInfo
    );
    virtual void handleAttributesPSVI
    (
        const   XMLCh* const            localName
        , const XMLCh* const            uri
        ,       PSVIAttributeList *     psviAttributes
    );
 
    // -----------------------------------------------------------------------
    //  Implementation of the XMLDocumentHandler interface.
    // -----------------------------------------------------------------------
 
 
    virtual void docCharacters
    (
        const   XMLCh* const    chars
        , const XMLSize_t       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 XMLSize_t       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 XMLSize_t               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
    );
 
 
 
    // -----------------------------------------------------------------------
    //  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 XMLSize_t       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:
    // DOM node creation hooks. Override them if you are using your own
    // DOM node types.
    //
    virtual DOMCDATASection* createCDATASection (const XMLCh*, XMLSize_t);
    virtual DOMText* createText (const XMLCh*, XMLSize_t);
 
    virtual DOMElement* createElement (const XMLCh* name);
    virtual DOMElement* createElementNS (const XMLCh* namespaceURI,
                                         const XMLCh* elemPrefix,
                                         const XMLCh* localName,
                                         const XMLCh* qName);
 
    virtual DOMAttr* createAttr (const XMLCh* name);
    virtual DOMAttr* createAttrNS (const XMLCh* namespaceURI,
                                   const XMLCh* elemPrefix,
                                   const XMLCh* localName,
                                   const XMLCh* qName);
 
 
 
 
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
    // -----------------------------------------------------------------------
    void resetPool();
 
    bool isDocumentAdopted() const;
 
 
 
private :
    // -----------------------------------------------------------------------
    //  Initialize/Cleanup methods
    // -----------------------------------------------------------------------
    void initialize();
    void cleanUp();
    void resetInProgress();
 
    // -----------------------------------------------------------------------
    //  Unimplemented constructors and operators
    // -----------------------------------------------------------------------
    AbstractDOMParser(const AbstractDOMParser&);
    AbstractDOMParser& operator=(const AbstractDOMParser&);
 
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 whitespace 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
    //
    //  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.
    //
    //  fCreateSchemaInfo
    //      Indicates whether element and attributes will have schema info associated
    //
    //   fDoXinclude
    //      A bool used to request that XInlcude processing occur on the
    //      Document the parser parses.
    // -----------------------------------------------------------------------
    bool                          fCreateEntityReferenceNodes;
    bool                          fIncludeIgnorableWhitespace;
    bool                          fWithinElement;
    bool                          fParseInProgress;
    bool                          fCreateCommentNodes;
    bool                          fDocumentAdoptedByUser;
    bool                          fCreateSchemaInfo;
    bool                          fDoXInclude;
    XMLScanner*                   fScanner;
    XMLCh*                        fImplementationFeatures;
    DOMNode*                      fCurrentParent;
    DOMNode*                      fCurrentNode;
    DOMEntityImpl*                fCurrentEntity;
    DOMDocumentImpl*              fDocument;
    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::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;
}
 
inline bool AbstractDOMParser::getCreateSchemaInfo() const
{
    return fCreateSchemaInfo;
}
 
inline bool AbstractDOMParser::getDoXInclude() const
{
    return fDoXInclude;
}
// ---------------------------------------------------------------------------
//  AbstractDOMParser: Setter methods
// ---------------------------------------------------------------------------
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);
}
 
inline void AbstractDOMParser::setDoXInclude(const bool newState)
{
    fDoXInclude = newState;
}
 
// ---------------------------------------------------------------------------
//  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::setParseInProgress(const bool toSet)
{
    fParseInProgress = toSet;
}
 
XERCES_CPP_NAMESPACE_END
 
#endif