DocumentImpl.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:13k
源码类别:

词法分析

开发平台:

Visual C++

  1. #ifndef DocumentImpl_HEADER_GUARD_
  2. #define DocumentImpl_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 1999, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Id: DocumentImpl.hpp,v 1.7 2003/05/22 02:26:50 knoaman Exp $
  60.  */
  61. //
  62. //  This file is part of the internal implementation of the C++ XML DOM.
  63. //  It should NOT be included or used directly by application programs.
  64. //
  65. //  Applications should include the file <xercesc/dom/deprecated/DOM.hpp> for the entire
  66. //  DOM API, or DOM_*.hpp for individual DOM classes, where the class
  67. //  name is substituded for the *.
  68. //
  69. #include <xercesc/util/XercesDefs.hpp>
  70. #include "ParentNode.hpp"
  71. #include "DOM_Node.hpp"
  72. #include "DOM_Element.hpp"
  73. #include "xercesc/util/RefVectorOf.hpp"
  74. #include "xercesc/util/RefHashTableOf.hpp"
  75. #include "XMLDeclImpl.hpp"
  76. XERCES_CPP_NAMESPACE_BEGIN
  77. class DocumentTypeImpl;
  78. class ElementImpl;
  79. class AttrImpl;
  80. class CDATASectionImpl;
  81. class CommentImpl;
  82. class DeepNodeListImpl;
  83. class DocumentFragmentImpl;
  84. class DocumentTypeImpl;
  85. class DStringPool;
  86. class EntityImpl;
  87. class EntityReferenceImpl;
  88. class NotationImpl;
  89. class ProcessingInstructionImpl;
  90. class TextImpl;
  91. class NodeIteratorImpl;
  92. class TreeWalkerImpl;
  93. class DOM_NodeFilter;
  94. class NodeFilterImpl;
  95. class DOM_DOMImplementation;
  96. class DOMString;
  97. class NodeIDMap;
  98. class RangeImpl;
  99. typedef RefVectorOf<NodeIteratorImpl> NodeIterators;
  100. typedef RefVectorOf<TreeWalkerImpl> TreeWalkers;
  101. typedef RefVectorOf<RangeImpl> RangeImpls;
  102. class CDOM_EXPORT DocumentImpl: public ParentNode {
  103. private:
  104.     // -----------------------------------------------------------------------
  105.     //  Private data types
  106.     // -----------------------------------------------------------------------
  107.     void setDocumentType(DocumentTypeImpl *doctype);
  108.     DocumentTypeImpl            *docType;
  109.     ElementImpl                 *docElement;
  110.     DStringPool                 *namePool;
  111.     NodeIDMap                   *fNodeIDMap;      // for use by GetElementsById().
  112.     NodeIterators               *iterators;
  113.     TreeWalkers                 *treeWalkers;
  114. RefHashTableOf<void> *userData;
  115.     RangeImpls                  *ranges;
  116.     /**
  117.      * Number of alterations made to this document since its creation.
  118.      * Serves as a "dirty bit" so that live objects such as NodeList can
  119.      * recognize when an alteration has been made and discard its cached
  120.      * state information.
  121.      * <p>
  122.      * Any method that alters the tree structure MUST cause or be
  123.      * accompanied by a call to changed(), to inform it that any outstanding
  124.      * NodeLists may have to be updated.
  125.      * <p>
  126.      * (Required because NodeList is simultaneously "live" and integer-
  127.      * indexed -- a bad decision in the DOM's design.)
  128.      * <p>
  129.      * Note that changes which do not affect the tree's structure -- changing
  130.      * the node's name, for example -- do _not_ have to call changed().
  131.      * <p>
  132.      * Alternative implementation would be to use a cryptographic
  133.      * Digest value rather than a count. This would have the advantage that
  134.      * "harmless" changes (those producing equal() trees) would not force
  135.      * NodeList to resynchronize. Disadvantage is that it's slightly more prone
  136.      * to "false negatives", though that's the difference between "wildly
  137.      * unlikely" and "absurdly unlikely". IF we start maintaining digests,
  138.      * we should consider taking advantage of them.
  139.      *
  140.      * Note: This used to be done a node basis, so that we knew what
  141.      * subtree changed. But since only DeepNodeList really use this today,
  142.      * the gain appears to be really small compared to the cost of having
  143.      * an int on every (parent) node plus having to walk up the tree all the
  144.      * way to the root to mark the branch as changed everytime a node is
  145.      * changed.
  146.      * So we now have a single counter global to the document. It means that
  147.      * some objects may flush their cache more often than necessary, but this
  148.      * makes nodes smaller and only the document needs to be marked as changed.
  149.      */
  150.     int fChanges;
  151.     /** Bypass error checking. */
  152.     bool errorChecking;
  153.     MemoryManager               *fMemoryManager;
  154.     friend class NodeIteratorImpl;
  155.     friend class TreeWalkerImpl;
  156.     friend class RangeImpl;
  157.     friend class DOMParser;
  158. public:
  159.     DocumentImpl(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
  160.     DocumentImpl(const DOMString &namespaceURI,     //DOM Level 2
  161.              const DOMString &qualifiedName,
  162.                  DocumentTypeImpl *doctype,
  163.                  MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
  164.     virtual ~DocumentImpl();
  165.     virtual bool isDocumentImpl();   // RTTI replacement function
  166.     virtual NodeImpl            *cloneNode(bool deep);
  167.     virtual DOMString getNodeName();
  168.     virtual short getNodeType();
  169.     virtual DocumentImpl * getOwnerDocument();
  170.     virtual AttrImpl            *createAttribute(const DOMString &name);
  171.     virtual CDATASectionImpl    *createCDATASection(const DOMString &data);
  172.     virtual CommentImpl         *createComment(const DOMString &data);
  173.     virtual DocumentFragmentImpl *createDocumentFragment();
  174.     virtual DocumentTypeImpl    *createDocumentType(const DOMString &name);
  175.     virtual DocumentTypeImpl    *createDocumentType(const DOMString &qName,
  176.                                                     const DOMString &publicId,
  177.                                                     const DOMString &systemId);
  178.     virtual ElementImpl         *createElement(const DOMString & tagName);
  179.     virtual ElementImpl         *createElement(const XMLCh *tagName);
  180.     virtual EntityImpl          *createEntity(const DOMString & name);
  181.     virtual EntityReferenceImpl *createEntityReference(const DOMString & name);
  182.     virtual NotationImpl        *createNotation(const DOMString & name);
  183.     virtual ProcessingInstructionImpl *createProcessingInstruction(const DOMString & target, const DOMString & data);
  184.     virtual TextImpl            *createTextNode(const DOMString & data);
  185.     virtual DocumentTypeImpl    *getDoctype();
  186.     virtual ElementImpl         *getDocumentElement();
  187.     virtual DeepNodeListImpl    *getElementsByTagName(const DOMString & tagname);
  188.     virtual NodeImpl            *insertBefore(NodeImpl *newChild, NodeImpl *refChild);
  189.     bool                        isXMLName(const DOMString & s);
  190.     virtual void                referenced();
  191.     virtual NodeImpl            *removeChild(NodeImpl *oldChild);
  192.     virtual void                unreferenced();
  193.     static  NodeIteratorImpl*   createNodeIterator(DOM_Node root, unsigned long whatToShow, DOM_NodeFilter* filter, bool entityReferenceExpansion,
  194.                                                    MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
  195.     static  TreeWalkerImpl*     createTreeWalker(DOM_Node root, unsigned long whatToShow, DOM_NodeFilter* filter, bool entityReferenceExpansion,
  196.                                                  MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
  197.     virtual XMLDeclImpl*        createXMLDecl(const DOMString& version, const DOMString& encoding, const DOMString& standalone);
  198.     virtual void* getUserData();
  199.     virtual void setUserData(void* value);
  200.     virtual RangeImpl*          createRange();
  201.     virtual RangeImpls*         getRanges();  //non-standard api
  202.     virtual void                removeRange(RangeImpl* range); //non-standard api
  203. // helper functions to prevent storing userdata pointers on every node.
  204.     virtual void setUserData(NodeImpl* n, void* data);
  205.     virtual void* getUserData(NodeImpl* n);
  206.     //Introduced in DOM Level 2
  207.     virtual NodeImpl            *importNode(NodeImpl *source, bool deep);
  208.     virtual ElementImpl         *createElementNS(const DOMString &namespaceURI,
  209.                                              const DOMString &qualifiedName);
  210.     virtual AttrImpl            *createAttributeNS(const DOMString &namespaceURI,
  211.                                              const DOMString &qualifiedName);
  212.     virtual DeepNodeListImpl    *getElementsByTagNameNS(const DOMString &namespaceURI,
  213.                                               const DOMString &localName);
  214.     virtual ElementImpl         *getElementById(const DOMString &elementId);
  215.     //Return the index > 0 of ':' in the given qualified name qName="prefix:localName".
  216.     //Return 0 if there is no ':', or -1 if qName is malformed such as ":abcd".
  217.     static  int                 indexofQualifiedName(const DOMString & qName);
  218.     static  bool                isKidOK(NodeImpl *parent, NodeImpl *child);
  219.     inline NodeIDMap *          getNodeIDMap() {return fNodeIDMap;};
  220.     virtual void changed();
  221.     virtual int changes();
  222.     /**
  223.      * Sets whether the DOM implementation performs error checking
  224.      * upon operations. Turning off error checking only affects
  225.      * the following DOM checks:
  226.      * <ul>
  227.      * <li>Checking strings to make sure that all characters are
  228.      *     legal XML characters
  229.      * <li>Hierarchy checking such as allowed children, checks for
  230.      *     cycles, etc.
  231.      * </ul>
  232.      * <p>
  233.      * Turning off error checking does <em>not</em> turn off the
  234.      * following checks:
  235.      * <ul>
  236.      * <li>Read only checks
  237.      * <li>Checks related to DOM events
  238.      * </ul>
  239.      */
  240.     inline void setErrorChecking(bool check) {
  241.         errorChecking = check;
  242.     }
  243.     /**
  244.      * Returns true if the DOM implementation performs error checking.
  245.      */
  246.     inline bool getErrorChecking() {
  247.         return errorChecking;
  248.     }
  249.     inline MemoryManager* getMemoryManager() const {
  250.         return fMemoryManager;
  251.     }
  252.     // -----------------------------------------------------------------------
  253.     //  Notification that lazy data has been deleted
  254.     // -----------------------------------------------------------------------
  255. static void reinitDocumentImpl();
  256. };
  257. XERCES_CPP_NAMESPACE_END
  258. #endif