DTDScanner.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:13k
- /*
- * The Apache Software License, Version 1.1
- *
- * Copyright (c) 1999-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) 1999, International
- * Business Machines, Inc., http://www.ibm.com . For more information
- * on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
- /*
- * $Log: DTDScanner.hpp,v $
- * Revision 1.8 2003/05/16 21:43:19 knoaman
- * Memory manager implementation: Modify constructors to pass in the memory manager.
- *
- * Revision 1.7 2003/05/15 18:54:51 knoaman
- * Partial implementation of the configurable memory manager.
- *
- * Revision 1.6 2003/02/05 22:07:09 tng
- * [Bug 3111] Problem with LexicalHandler::startDTD() and LexicalHandler::endDTD().
- *
- * Revision 1.5 2002/12/04 02:47:25 knoaman
- * scanner re-organization.
- *
- * Revision 1.4 2002/11/04 14:50:40 tng
- * C++ Namespace Support.
- *
- * Revision 1.3 2002/07/11 18:39:48 knoaman
- * Access entities through the DTDGrammar instead of the scanner.
- *
- * Revision 1.2 2002/05/30 16:17:19 tng
- * Add feature to optionally ignore external DTD.
- *
- * Revision 1.1.1.1 2002/02/01 22:22:44 peiyongz
- * sane_include
- *
- * Revision 1.4 2001/06/21 14:25:56 knoaman
- * Fix for bug 1946
- *
- * Revision 1.3 2001/05/11 13:27:10 tng
- * Copyright update.
- *
- * Revision 1.2 2001/04/19 18:17:22 tng
- * Schema: SchemaValidator update, and use QName in Content Model
- *
- * Revision 1.1 2001/03/21 21:56:20 tng
- * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
- *
- */
- #if !defined(DTDSCANNER_HPP)
- #define DTDSCANNER_HPP
- #include <xercesc/validators/DTD/DTDGrammar.hpp>
- #include <xercesc/validators/DTD/DTDEntityDecl.hpp>
- XERCES_CPP_NAMESPACE_BEGIN
- class XMLScanner;
- /*
- * Default implementation of an XML DTD scanner.
- */
- class DocTypeHandler;
- class VALIDATORS_EXPORT DTDScanner : public XMemory
- {
- public:
- // -----------------------------------------------------------------------
- // Class specific types
- //
- // EntityExpRes
- // Returned from scanEntityRef() to indicate how the expanded text
- // was treated.
- //
- // IDTypes
- // Type of the ID
- // -----------------------------------------------------------------------
- enum EntityExpRes
- {
- EntityExp_Failed
- , EntityExp_Pushed
- , EntityExp_Returned
- };
- enum IDTypes
- {
- IDType_Public
- , IDType_External
- , IDType_Either
- };
- // -----------------------------------------------------------------------
- // Constructors and Destructor
- // -----------------------------------------------------------------------
- DTDScanner
- (
- DTDGrammar* dtdGrammar
- , DocTypeHandler* const docTypeHandler
- , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
- );
- virtual ~DTDScanner();
- // -----------------------------------------------------------------------
- // Getter methods
- // -----------------------------------------------------------------------
- DocTypeHandler* getDocTypeHandler();
- const DocTypeHandler* getDocTypeHandler() const;
- // -----------------------------------------------------------------------
- // Setter methods
- //
- // setScannerInfo() is called by the scanner to tell the DTDScanner
- // about the stuff it needs to have access to.
- // -----------------------------------------------------------------------
- void setScannerInfo
- (
- XMLScanner* const owningScanner
- , ReaderMgr* const readerMgr
- , XMLBufferMgr* const bufMgr
- );
- void setDocTypeHandler
- (
- DocTypeHandler* const handlerToSet
- );
- void scanExtSubsetDecl(const bool inIncludeSect, const bool isDTD);
- bool scanInternalSubset();
- bool scanId
- (
- XMLBuffer& pubIdToFill
- , XMLBuffer& sysIdToFill
- , const IDTypes whatKind
- );
- private:
- // -----------------------------------------------------------------------
- // Private DTD scanning methods. These are all in XMLValidator2.cpp
- // -----------------------------------------------------------------------
- bool checkForPERef
- (
- const bool spaceRequired
- , const bool inLiteral
- , const bool inMarkup
- , const bool throwEndOfExt = false
- );
- bool expandPERef
- (
- const bool scanExternal
- , const bool inLiteral
- , const bool inMarkup
- , const bool throwEndOfExt = false
- );
- bool getQuotedString(XMLBuffer& toFill);
- XMLAttDef* scanAttDef(DTDElementDecl& elemDecl, XMLBuffer& bufToUse);
- bool scanAttValue
- (
- const XMLCh* const attrName
- , XMLBuffer& toFill
- , const XMLAttDef::AttTypes type
- );
- void scanAttListDecl();
- ContentSpecNode* scanChildren
- (
- const DTDElementDecl& elemDecl
- , XMLBuffer& bufToUse
- );
- bool scanCharRef(XMLCh& toFill, XMLCh& second);
- void scanComment();
- bool scanContentSpec(DTDElementDecl& toFill);
- void scanDefaultDecl(DTDAttDef& toFill);
- void scanElementDecl();
- void scanEntityDecl();
- bool scanEntityDef();
- bool scanEntityLiteral(XMLBuffer& toFill, const bool isPE);
- bool scanEntityDef(DTDEntityDecl& decl, const bool isPEDecl);
- EntityExpRes scanEntityRef(XMLCh& firstCh, XMLCh& secondCh, bool& escaped);
- bool scanEnumeration
- (
- const DTDAttDef& attDef
- , XMLBuffer& toFill
- , const bool notation
- );
- bool scanEq();
- void scanIgnoredSection();
- void scanMarkupDecl(const bool parseTextDecl);
- bool scanMixed(DTDElementDecl& toFill);
- void scanNotationDecl();
- void scanPI();
- bool scanPublicLiteral(XMLBuffer& toFill);
- bool scanSystemLiteral(XMLBuffer& toFill);
- void scanTextDecl();
- bool isReadingExternalEntity();
- // -----------------------------------------------------------------------
- // Private data members
- //
- // fDocTypeHandler
- // This holds the optional doc type handler that can be installed
- // and used to call back for all markup events. It is DTD specific.
- //
- // fDumAttDef
- // fDumElemDecl
- // fDumEntityDecl
- // These are dummy objects into which mark decls are parsed when
- // they are just overrides of previously declared markup decls. In
- // such situations, the first one wins but we need to have somewhere
- // to parse them into. So these are lazily created and used as needed
- // when such markup decls are seen.
- //
- // fInternalSubset
- // This is used to track whether we are in the internal subset or not,
- // in which case we are in the external subset.
- //
- // fNextAttrId
- // Since att defs are per-element, we don't have a validator wide
- // attribute def pool. So we use a simpler data structure in each
- // element decl to store its att defs, and we use this simple counter
- // to apply a unique id to each new attribute.
- //
- // fDTDGrammar
- // The DTD information we scanned like element decl, attribute decl
- // are stored in this Grammar.
- //
- // fBufMgr
- // This is the buffer manager of the scanner. This is provided as a
- // convenience so that the DTDScanner doesn't have to create its own
- // buffer manager during the parse process.
- //
- // fReaderMgr
- // This is a pointer to the reader manager that is being used by the scanner.
- //
- // fScanner
- // The pointer to the scanner to which this DTDScanner belongs
- //
- // fPEntityDeclPool
- // This is a pool of EntityDecl objects, which contains all of the
- // parameter entities that are declared in the DTD subsets.
- //
- // fEmptyNamespaceId
- // The uri for all DTD decls
- //
- // fDocTypeReaderId
- // The original reader in the fReaderMgr - to be compared against the
- // current reader to decide whether we are processing an external/internal
- // declaration
- // -----------------------------------------------------------------------
- MemoryManager* fMemoryManager;
- DocTypeHandler* fDocTypeHandler;
- DTDAttDef* fDumAttDef;
- DTDElementDecl* fDumElemDecl;
- DTDEntityDecl* fDumEntityDecl;
- bool fInternalSubset;
- unsigned int fNextAttrId;
- DTDGrammar* fDTDGrammar;
- XMLBufferMgr* fBufMgr;
- ReaderMgr* fReaderMgr;
- XMLScanner* fScanner;
- NameIdPool<DTDEntityDecl>* fPEntityDeclPool;
- unsigned int fEmptyNamespaceId;
- unsigned int fDocTypeReaderId;
- };
- // ---------------------------------------------------------------------------
- // DTDScanner: Getter methods
- // ---------------------------------------------------------------------------
- inline DocTypeHandler* DTDScanner::getDocTypeHandler()
- {
- return fDocTypeHandler;
- }
- inline const DocTypeHandler* DTDScanner::getDocTypeHandler() const
- {
- return fDocTypeHandler;
- }
- // ---------------------------------------------------------------------------
- // DTDScanner: Setter methods
- // ---------------------------------------------------------------------------
- inline void DTDScanner::setDocTypeHandler(DocTypeHandler* const handlerToSet)
- {
- fDocTypeHandler = handlerToSet;
- }
- // -----------------------------------------------------------------------
- // Helper methods
- // -----------------------------------------------------------------------
- inline bool DTDScanner::isReadingExternalEntity() {
- return (fDocTypeReaderId != fReaderMgr->getCurrentReaderNum());
- }
- XERCES_CPP_NAMESPACE_END
- #endif