SAX2XMLReader.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: SAX2XMLReader.hpp 984018 2010-08-10 14:12:43Z amassari $
 */

#if !defined(XERCESC_INCLUDE_GUARD_SAX2XMLREADER_HPP)
#define XERCESC_INCLUDE_GUARD_SAX2XMLREADER_HPP

#include <xercesc/util/XercesDefs.hpp>
#include <xercesc/util/XMLUniDefs.hpp>
#include <xercesc/framework/XMLValidator.hpp>
#include <xercesc/framework/XMLPScanToken.hpp>
#include <xercesc/validators/common/Grammar.hpp>

XERCES_CPP_NAMESPACE_BEGIN

class ContentHandler ;
class DTDHandler;
class EntityResolver;
class ErrorHandler;
class InputSource;
class LexicalHandler;
class DeclHandler;
class XMLDocumentHandler;

class SAX2_EXPORT SAX2XMLReader
{
public:
    // -----------------------------------------------------------------------
    //  Class types
    // -----------------------------------------------------------------------

    enum ValSchemes
    {
        Val_Never
        , Val_Always
        , Val_Auto
    };


    // -----------------------------------------------------------------------
    //  Constructors and Destructor
    // -----------------------------------------------------------------------
    SAX2XMLReader()
    {
    }
    virtual ~SAX2XMLReader()
    {
    }

    //-----------------------------------------------------------------------
    // The XMLReader interface
    //-----------------------------------------------------------------------

    virtual ContentHandler* getContentHandler() const = 0 ;

    virtual DTDHandler* getDTDHandler() const = 0;

    virtual EntityResolver* getEntityResolver() const = 0 ;

    virtual ErrorHandler* getErrorHandler() const = 0 ;

    virtual bool getFeature(const XMLCh* const name) const = 0;

    virtual void* getProperty(const XMLCh* const name) const = 0 ;

    virtual void setContentHandler(ContentHandler* const handler) = 0;

    virtual void setDTDHandler(DTDHandler* const handler) = 0;

    virtual void setEntityResolver(EntityResolver* const resolver) = 0;

    virtual void setErrorHandler(ErrorHandler* const handler) = 0;

    virtual void setFeature(const XMLCh* const name, const bool value) = 0;

    virtual void setProperty(const XMLCh* const name, void* value) = 0 ;

    virtual void parse
    (
        const   InputSource&    source
    ) = 0;

    virtual void parse
    (
        const   XMLCh* const    systemId
    ) = 0;

    virtual void parse
    (
        const   char* const     systemId
    ) = 0;


    // -----------------------------------------------------------------------
    //  SAX 2.0-ext
    // -----------------------------------------------------------------------
    virtual DeclHandler* getDeclarationHandler() const = 0 ;

    virtual LexicalHandler* getLexicalHandler() const = 0 ;

    virtual void setDeclarationHandler(DeclHandler* const handler) = 0;

    virtual void setLexicalHandler(LexicalHandler* const handler) = 0;


    // -----------------------------------------------------------------------
    //  Getter Methods
    // -----------------------------------------------------------------------
    virtual XMLValidator* getValidator() const = 0;

    virtual XMLSize_t getErrorCount() const = 0 ;

    virtual bool getExitOnFirstFatalError() const = 0;

    virtual bool getValidationConstraintFatal() const = 0;

    virtual Grammar* getGrammar(const XMLCh* const nameSpaceKey) = 0;

    virtual Grammar* getRootGrammar() = 0;

    virtual const XMLCh* getURIText(unsigned int uriId) const = 0;

    virtual XMLFilePos getSrcOffset() const = 0;


    // -----------------------------------------------------------------------
    //  Setter Methods
    // -----------------------------------------------------------------------
    virtual void setValidator(XMLValidator* valueToAdopt) = 0;

    virtual void setExitOnFirstFatalError(const bool newState) = 0;

    virtual void setValidationConstraintFatal(const bool newState) = 0;


    // -----------------------------------------------------------------------
    //  Progressive scan methods
    // -----------------------------------------------------------------------


    virtual bool parseFirst
    (
        const   XMLCh* const    systemId
        ,       XMLPScanToken&  toFill
    ) = 0;

    virtual bool parseFirst
    (
        const   char* const     systemId
        ,       XMLPScanToken&  toFill
    ) = 0;

    virtual bool parseFirst
    (
        const   InputSource&    source
        ,       XMLPScanToken&  toFill
    ) = 0;

    virtual bool parseNext(XMLPScanToken& token) = 0;

    virtual void parseReset(XMLPScanToken& token) = 0;


    // -----------------------------------------------------------------------
    //  Grammar preparsing interface
    // -----------------------------------------------------------------------

    virtual Grammar* loadGrammar(const InputSource& source,
                                 const Grammar::GrammarType grammarType,
                                 const bool toCache = false) = 0;

    virtual Grammar* loadGrammar(const XMLCh* const systemId,
                                 const Grammar::GrammarType grammarType,
                                 const bool toCache = false) = 0;

    virtual Grammar* loadGrammar(const char* const systemId,
                                 const Grammar::GrammarType grammarType,
                                 const bool toCache = false) = 0;

    virtual void resetCachedGrammarPool() = 0;

    virtual void setInputBufferSize(const XMLSize_t bufferSize);



    // -----------------------------------------------------------------------
    //  Advanced document handler list maintenance methods
    // -----------------------------------------------------------------------

    virtual void installAdvDocHandler(XMLDocumentHandler* const toInstall) = 0;

    virtual bool removeAdvDocHandler(XMLDocumentHandler* const toRemove) = 0;

private :
    /* The copy constructor, you cannot call this directly */
    SAX2XMLReader(const SAX2XMLReader&);

    /* The assignment operator, you cannot call this directly */
    SAX2XMLReader& operator=(const SAX2XMLReader&);

};

inline void SAX2XMLReader::setInputBufferSize(const XMLSize_t /*bufferSize*/)
{
}

XERCES_CPP_NAMESPACE_END

#endif