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

词法分析

开发平台:

Visual C++

  1. #ifndef DOMNodeImpl_HEADER_GUARD_
  2. #define DOMNodeImpl_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001-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) 2001, 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: DOMNodeImpl.hpp,v 1.12 2003/04/02 22:30:01 peiyongz 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/DOM.hpp> for the entire
  66. //  DOM API, or xercesc/dom/DOM*.hpp for individual DOM classes, where the class
  67. //  name is substituded for the *.
  68. //
  69. /**
  70.  * A DOMNodeImpl doesn't have any children, and can therefore only be directly
  71.  * inherited by classes of nodes that never have any, such as Text nodes. For
  72.  * other types, such as Element, classes must inherit from ParentNode.
  73.  * <P>
  74.  * All nodes in a single document must originate
  75.  * in that document. (Note that this is much tighter than "must be
  76.  * same implementation") Nodes are all aware of their ownerDocument,
  77.  * and attempts to mismatch will throw WRONG_DOCUMENT_ERR.
  78.  * <P>
  79.  * However, to save memory not all nodes always have a direct reference
  80.  * to their ownerDocument. When a node is owned by another node it relies
  81.  * on its owner to store its ownerDocument. Parent nodes always store it
  82.  * though, so there is never more than one level of indirection.
  83.  * And when a node doesn't have an owner, ownerNode refers to its
  84.  * ownerDocument.
  85.  **/
  86. #include <xercesc/util/XercesDefs.hpp>
  87. #include <xercesc/dom/DOMUserDataHandler.hpp>
  88. XERCES_CPP_NAMESPACE_BEGIN
  89. class DOMNamedNodeMap;
  90. class DOMNodeList;
  91. class DOMNode;
  92. class DOMDocument;
  93. class DOMElement;
  94. class CDOM_EXPORT DOMNodeImpl {
  95. public:
  96.     // data
  97.     DOMNode                *fOwnerNode; // typically the parent but not always!
  98.     unsigned short flags;
  99.     static const unsigned short READONLY;
  100.     static const unsigned short SYNCDATA;
  101.     static const unsigned short SYNCCHILDREN;
  102.     static const unsigned short OWNED;
  103.     static const unsigned short FIRSTCHILD;
  104.     static const unsigned short SPECIFIED;
  105.     static const unsigned short IGNORABLEWS;
  106.     static const unsigned short SETVALUE;
  107.     static const unsigned short ID_ATTR;
  108.     static const unsigned short USERDATA;
  109.     static const unsigned short LEAFNODETYPE;
  110.     static const unsigned short CHILDNODE;
  111.     static const unsigned short TOBERELEASED;
  112. public:
  113.     DOMNodeImpl(DOMNode *ownerDocument);
  114.     DOMNodeImpl(const DOMNodeImpl &other);
  115.     ~DOMNodeImpl();
  116.     DOMNode         * appendChild(DOMNode *newChild);
  117.     DOMNamedNodeMap * getAttributes() const;
  118.     DOMNodeList     * getChildNodes() const;
  119.     DOMNode         * getFirstChild() const;
  120.     DOMNode         * getLastChild() const;
  121.     const XMLCh     * getLocalName() const;
  122.     const XMLCh     * getNamespaceURI() const;
  123.     DOMNode         * getNextSibling() const;
  124.     const XMLCh     * getNodeValue() const;
  125.     DOMDocument     * getOwnerDocument() const;
  126.     DOMNode         * getParentNode() const;
  127.     const XMLCh     * getPrefix() const;
  128.     DOMNode         * getPreviousSibling() const;
  129.     bool              hasChildNodes() const;
  130.     DOMNode         * insertBefore(DOMNode *newChild, DOMNode *refChild);
  131.     void              normalize();
  132.     DOMNode         * removeChild(DOMNode *oldChild);
  133.     DOMNode         * replaceChild(DOMNode *newChild, DOMNode *oldChild);
  134.     void              setNodeValue(const XMLCh *value);
  135.     void              setPrefix(const XMLCh *fPrefix);
  136.     void              setReadOnly(bool readOnly, bool deep);
  137.     bool              isSupported(const XMLCh *feature, const XMLCh *version) const;
  138.     bool              hasAttributes() const;
  139.     // Introduced in DOM Level 3
  140.     void*             setUserData(const XMLCh* key, void* data, DOMUserDataHandler* handler);
  141.     void*             getUserData(const XMLCh* key) const;
  142.     bool              isSameNode(const DOMNode* other) const;
  143.     bool              isEqualNode(const DOMNode* arg) const;
  144.     const XMLCh*      getBaseURI() const ;
  145.     short             compareTreePosition(const DOMNode* other) const;
  146.     const XMLCh*      getTextContent() const ;
  147.     const XMLCh*      getTextContent(XMLCh* pzBuffer, unsigned int& rnBufferLength) const;
  148.     void              setTextContent(const XMLCh* textContent) ;
  149.     const XMLCh*      lookupNamespacePrefix(const XMLCh* namespaceURI, bool useDefault) const ;
  150.     bool              isDefaultNamespace(const XMLCh* namespaceURI) const ;
  151.     const XMLCh*      lookupNamespaceURI(const XMLCh* prefix) const  ;
  152.     DOMNode*          getInterface(const XMLCh* feature) ;
  153.     // Helper functions for DOM Level 3
  154.     void              release();
  155.     void              callUserDataHandlers(DOMUserDataHandler::DOMOperationType operation,
  156.                                            const DOMNode* src,
  157.                                            const DOMNode* dst) const;
  158.     //reverses the bit pattern given by compareTreePosition
  159.     short             reverseTreeOrderBitPattern(short pattern) const;
  160.     //Utility, not part of DOM Level 2 API
  161.     static  bool      isKidOK(DOMNode *parent, DOMNode *child);
  162.     static const XMLCh *mapPrefix(const XMLCh *prefix,
  163.                                const XMLCh *namespaceURI, short nType);
  164.     static const XMLCh *getXmlnsString();
  165.     static const XMLCh *getXmlnsURIString();
  166.     static const XMLCh *getXmlString();
  167.     static const XMLCh *getXmlURIString();
  168. public: // should really be protected - ALH
  169.       DOMNode* getElementAncestor (const DOMNode* currentNode) const;
  170.       const XMLCh* lookupNamespacePrefix(const XMLCh* const namespaceURI, bool useDefaultx, DOMElement *el) const ;
  171.      void setOwnerDocument(DOMDocument *doc);
  172.     /*
  173.      * Flags setters and getters
  174.      */
  175.     inline bool isReadOnly() const {
  176.         return (flags & READONLY) != 0;
  177.     }
  178.     inline void isReadOnly(bool value) {
  179.         flags = (value ? flags | READONLY : flags & ~READONLY);
  180.     }
  181.     inline bool needsSyncData() const {
  182.         return (flags & SYNCDATA) != 0;
  183.     }
  184.     inline void needsSyncData(bool value) {
  185.         flags = (value ? flags | SYNCDATA : flags & ~SYNCDATA);
  186.     }
  187.     inline bool needsSyncChildren() const {
  188.         return (flags & SYNCCHILDREN) != 0;
  189.     }
  190.     inline void needsSyncChildren(bool value) {
  191.         flags = (value ? flags | SYNCCHILDREN : flags & ~SYNCCHILDREN);
  192.     }
  193.     // For Attributes, true if the attr node is attached to an element.
  194.     // For all other node types, true if the node has a parent node.
  195.     inline bool isOwned() const {
  196.         return (flags & OWNED) != 0;
  197.     }
  198.     inline void isOwned(bool value) {
  199.         flags = (value ? flags | OWNED : flags & ~OWNED);
  200.     }
  201.     inline bool isFirstChild() const {
  202.         return (flags & FIRSTCHILD) != 0;
  203.     }
  204.     inline void isFirstChild(bool value) {
  205.         flags = (value ? flags | FIRSTCHILD : flags & ~FIRSTCHILD);
  206.     }
  207.     inline bool isSpecified() const {
  208.         return (flags & SPECIFIED) != 0;
  209.     }
  210.     inline void isSpecified(bool value) {
  211.         flags = (value ? flags | SPECIFIED : flags & ~SPECIFIED);
  212.     }
  213.     inline bool ignorableWhitespace() const {
  214.         return (flags & IGNORABLEWS) != 0;
  215.     }
  216.     inline void ignorableWhitespace(bool value) {
  217.         flags = (value ? flags | IGNORABLEWS : flags & ~IGNORABLEWS);
  218.     }
  219.     inline bool setValue() const {
  220.         return (flags & SETVALUE) != 0;
  221.     }
  222.     inline void setValue(bool value) {
  223.         flags = (value ? flags | SETVALUE : flags & ~SETVALUE);
  224.     }
  225.     inline bool isIdAttr() const {
  226.         return (flags & ID_ATTR) != 0;
  227.     }
  228.     inline void isIdAttr(bool value) {
  229.         flags = (value ? flags | ID_ATTR : flags & ~ID_ATTR);
  230.     }
  231.     inline bool hasUserData() const {
  232.         return (flags & USERDATA) != 0;
  233.     }
  234.     inline void hasUserData(bool value) {
  235.         flags = (value ? flags | USERDATA : flags & ~USERDATA);
  236.     }
  237.     //
  238.     //  LeafNode is set true for node types that can not be ParentNodes (can't have children)
  239.     //    This knowledge is used to allow casting from any unknown node type to the
  240.     //    IDParentImpl or IDChildImpl parts of the node.
  241.     //
  242.     inline bool isLeafNode() const {
  243.         return (flags & LEAFNODETYPE) != 0;
  244.     }
  245.     inline void setIsLeafNode(bool value) {
  246.         flags = (value ? flags | LEAFNODETYPE : flags & ~LEAFNODETYPE);
  247.     }
  248.     //
  249.     // ChildNode is set true for node types that can be children of other nodes, and
  250.     //   therefore include a DOMChildNode data member.  Note that all of the leaf
  251.     //   node types (above flag) are also ChildNodes, but not all ChildNodes are
  252.     //   leaf nodes.
  253.     inline bool isChildNode() const {
  254.         return (flags & CHILDNODE) != 0;
  255.     }
  256.     inline void setIsChildNode(bool value) {
  257.         flags = (value ? flags | CHILDNODE : flags & ~CHILDNODE);
  258.     }
  259.     // True if this node has to be released regardless if it has a owner or not
  260.     // This is true if called from fParent->release()
  261.     inline bool isToBeReleased() const {
  262.         return (flags & TOBERELEASED) != 0;
  263.     }
  264.     inline void isToBeReleased(bool value) {
  265.         flags = (value ? flags | TOBERELEASED : flags & ~TOBERELEASED);
  266.     }
  267. };
  268. // This macro lists all of the pure virtual functions declared in DOMNode that must
  269. //   be implemented by all node types.  Since there is no inheritance of implementation,
  270. //   using this macro in the class declaration of the node types make it easier to
  271. //   accurately get all of the functions declared.
  272. //
  273. #define DOMNODE_FUNCTIONS 
  274.     virtual       DOMNode*         appendChild(DOMNode *newChild) ;
  275.     virtual       DOMNode*         cloneNode(bool deep) const ;
  276.     virtual       DOMNamedNodeMap* getAttributes() const ;
  277.     virtual       DOMNodeList*     getChildNodes() const ;
  278.     virtual       DOMNode*         getFirstChild() const ;
  279.     virtual       DOMNode*         getLastChild() const ;
  280.     virtual const XMLCh*           getLocalName() const ;
  281.     virtual const XMLCh*           getNamespaceURI() const ;
  282.     virtual       DOMNode*         getNextSibling() const ;
  283.     virtual const XMLCh*           getNodeName() const ;
  284.     virtual       short            getNodeType() const ;
  285.     virtual const XMLCh*           getNodeValue() const ;
  286.     virtual       DOMDocument*     getOwnerDocument() const ;
  287.     virtual const XMLCh*           getPrefix() const ;
  288.     virtual       DOMNode*         getParentNode() const ;
  289.     virtual       DOMNode*         getPreviousSibling() const ;
  290.     virtual       bool             hasChildNodes() const ;
  291.     virtual       DOMNode*         insertBefore(DOMNode *newChild, DOMNode *refChild) ;
  292.     virtual       void             normalize() ;
  293.     virtual       DOMNode*         removeChild(DOMNode *oldChild) ;
  294.     virtual       DOMNode*         replaceChild(DOMNode *newChild, DOMNode *oldChild) ;
  295.     virtual       void             setNodeValue(const XMLCh  *nodeValue) ;
  296.     virtual       bool             isSupported(const XMLCh *feature, const XMLCh *version) const ;
  297.     virtual       bool             hasAttributes() const ;
  298.     virtual       void             setPrefix(const XMLCh * prefix) ;
  299.     virtual       void*            setUserData(const XMLCh* key, void* data, DOMUserDataHandler* handler) ;
  300.     virtual       void*            getUserData(const XMLCh* key) const ;
  301.     virtual       bool             isSameNode(const DOMNode* other) const;
  302.     virtual       bool             isEqualNode(const DOMNode* arg) const;
  303.     virtual const XMLCh*           getBaseURI() const ;
  304.     virtual short                  compareTreePosition(const DOMNode* other) const ;
  305.     virtual const XMLCh*           getTextContent() const ;
  306.             const XMLCh*           getTextContent(XMLCh* pzBuffer, unsigned int& rnBufferLength) const;
  307.     virtual void                   setTextContent(const XMLCh* textContent) ;
  308.     virtual const XMLCh*           lookupNamespacePrefix(const XMLCh* namespaceURI, bool useDefault) const  ;
  309.     virtual bool                   isDefaultNamespace(const XMLCh* namespaceURI) const;
  310.     virtual const XMLCh*           lookupNamespaceURI(const XMLCh* prefix) const  ;
  311.     virtual       DOMNode*         getInterface(const XMLCh* feature) ;
  312.     virtual       void             release()
  313. /*
  314.  *  Here are dummy stubs for most of the functions introduced by DOMNode.
  315.  *    Each subclass of DOMNode will have something like this that delegates each
  316.  *    function to the appropriate implementation.
  317.  *    Functions that must be supplied by every node class are omitted.
  318.  *
  319.            DOMNode*         xxx::appendChild(DOMNode *newChild)          {return fParent.appendChild (newChild); };
  320.            DOMNamedNodeMap* xxx::getAttributes() const                   {return fNode.getAttributes (); };
  321.            DOMNodeList*     xxx::getChildNodes() const                   {return fParent.getChildNodes (); };
  322.            DOMNode*         xxx::getFirstChild() const                   {return fParent.getFirstChild (); };
  323.            DOMNode*         xxx::getLastChild() const                    {return fParent.getLastChild (); };
  324.      const XMLCh*           xxx::getLocalName() const                    {return fNode.getLocalName (); };
  325.      const XMLCh*           xxx::getNamespaceURI() const                 {return fNode.getNamespaceURI (); };
  326.            DOMNode*         xxx::getNextSibling() const                  {return fChild.getNextSibling (); };
  327.      const XMLCh*           xxx::getNodeValue() const                    {return fNode.getNodeValue (); };
  328.            DOMDocument*     xxx::getOwnerDocument() const                {return fNode.getOwnerDocument (); };
  329.      const XMLCh*           xxx::getPrefix() const                       {return fNode.getPrefix (); };
  330.            DOMNode*         xxx::getParentNode() const                   {return fChild.getParentNode (this); };
  331.            DOMNode*         xxx::getPreviousSibling() const              {return fChild.getPreviousSibling (this); };
  332.            bool             xxx::hasChildNodes() const                   {return fParent.hasChildNodes (); };
  333.            DOMNode*         xxx::insertBefore(DOMNode *newChild, DOMNode *refChild)
  334.                                                                          {return fParent.insertBefore (newChild, refChild); };
  335.            void             xxx::normalize()                             {fParent.normalize(); };
  336.            DOMNode*         xxx::removeChild(DOMNode *oldChild)          {return fParent.removeChild (oldChild); };
  337.            DOMNode*         xxx::replaceChild(DOMNode *newChild, DOMNode *oldChild)
  338.                                                                          {return fParent.replaceChild (newChild, oldChild); };
  339.            bool             xxx::isSupported(const XMLCh *feature, const XMLCh *version) const
  340.                                                                          {return fNode.isSupported (feature, version); };
  341.            void             xxx::setPrefix(const XMLCh  *prefix)         {fNode.setPrefix(prefix); };
  342.            bool             xxx::hasAttributes() const                   {return fNode.hasAttributes(); };
  343.            bool             xxx::isSameNode(const DOMNode* other) const  {return fNode.isSameNode(other); };
  344.            bool             xxx::isEqualNode(const DOMNode* arg) const   {return fNode.isEqualNode(arg); };
  345.            void*            xxx::setUserData(const XMLCh* key, void* data, DOMUserDataHandler* handler)
  346.                                                                          {return fNode.setUserData(key, data, handler); };
  347.            void*            xxx::getUserData(const XMLCh* key) const     {return fNode.getUserData(key); };
  348.            const XMLCh*     xxx::getBaseURI() const                      {return fNode.getBaseURI(); };
  349.            short            xxx::compareTreePosition(const DOMNode* other) const {return fNode.compareTreePosition(other); };
  350.            const XMLCh*     xxx::getTextContent() const                  {return fNode.getTextContent(); };
  351.            void             xxx::setTextContent(const XMLCh* textContent){fNode.setTextContent(textContent); };
  352.            const XMLCh*     xxx::lookupNamespacePrefix(const XMLCh* namespaceURI, bool useDefault) const {return fNode.lookupNamespacePrefix(namespaceURI, useDefault); };
  353.            bool             xxx::isDefaultNamespace(const XMLCh* namespaceURI) const {return fNode.isDefaultNamespace(namespaceURI); };
  354.            const XMLCh*     xxx::lookupNamespaceURI(const XMLCh* prefix) const {return fNode.lookupNamespaceURI(prefix); };
  355.            DOMNode*         xxx::getInterface(const XMLCh* feature)      {return fNode.getInterface(feature); };
  356. */
  357. XERCES_CPP_NAMESPACE_END
  358. #endif