IDDocumentImpl.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:12k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. #ifndef IDDocumentImpl_HEADER_GUARD_
  2. #define IDDocumentImpl_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001 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: IDDocumentImpl.hpp,v 1.11 2001/10/03 15:49:01 tng 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 <dom/DOM.hpp> for the entire
  66. //  DOM API, or IDOM_*.hpp for individual DOM classes, where the class
  67. //  name is substituded for the *.
  68. //
  69. #include <string.h>
  70. #include <util/XercesDefs.hpp>
  71. #include "util/RefVectorOf.hpp"
  72. #include "util/RefHashTableOf.hpp"
  73. #include "IDOM_Document.hpp"
  74. #include "IDNodeImpl.hpp"
  75. #include "IDParentNode.hpp"
  76. #include "IDDeepNodeListPool.hpp"
  77. class IDAttrImpl;
  78. class IDCDATASectionImpl;
  79. class IDCommentImpl;
  80. class IDDeepNodeListImpl;
  81. class IDDocumentFragmentImpl;
  82. class IDDocumentTypeImpl;
  83. class IDDStringPool;
  84. class IDElementImpl;
  85. class IDEntityImpl;
  86. class IDEntityReferenceImpl;
  87. class IDNodeImpl;
  88. class IDNotationImpl;
  89. class IDProcessingInstructionImpl;
  90. class IDTextImpl;
  91. class IDNodeIteratorImpl;
  92. class IDTreeWalkerImpl;
  93. class IDOM_NodeFilter;
  94. class IDNodeFilterImpl;
  95. class IDOM_DOMImplementation;
  96. class IDNodeIDMap;
  97. class IDRangeImpl;
  98. class IDParentNode;
  99. class IDStringPool;
  100. typedef RefVectorOf<IDNodeIteratorImpl> NodeIterators;
  101. typedef RefVectorOf<IDTreeWalkerImpl>   TreeWalkers;
  102. typedef RefVectorOf<IDRangeImpl>        Ranges;
  103. class CDOM_EXPORT IDDocumentImpl: public IDOM_Document {
  104. public:
  105.     // -----------------------------------------------------------------------
  106.     //  Private data types
  107.     // -----------------------------------------------------------------------
  108.     IDNodeImpl                  fNode;           // Implements common node functionality.
  109.     IDParentNode                fParent;         // Implements common parent node functionality
  110.     IDOM_DocumentType           *fDocType;
  111.     IDOM_Element                *fDocElement;
  112.     IDStringPool                *fNamePool;
  113.     IDNodeIDMap                 *fNodeIDMap;     // for use by GetElementsById().
  114.     NodeIterators               *fIterators;
  115.     TreeWalkers                 *fTreeWalkers;
  116.     Ranges                      *fRanges;
  117.     RefHashTableOf<void>        *fUserData;
  118.     int                          fChanges;
  119.     bool errorChecking;                          // Bypass error checking.
  120.     // Per-Document heap Variables.
  121.     //   The heap consists of one or more biggish blocks which are
  122.     //   sub-allocated for individual allocations of nodes, strings, etc.
  123.     //   The big blocks form a linked list, allowing them to be located for deletion.
  124.     //
  125.     //   There is no provision for deleting suballocated blocks, other than
  126.     //     deleting the entire heap when the document is deleted.
  127.     //
  128.     //   There is no header on individual sub-allocated blocks.
  129.     //   The header on big blocks consists only of a single back pointer to
  130.     //    the previously allocated big block (our linked list of big blocks)
  131.     //
  132.     //
  133.     //   idom_revisit - this heap should be encapsulated into its own
  134.     //                  class, rather than hanging naked on Document.
  135.     //
  136.     void                        *fCurrentBlock;
  137.     char                        *fFreePtr;
  138.     unsigned int                 fFreeBytesRemaining;
  139.     friend class IDNodeImpl;
  140.     friend class IDNodeIteratorImpl;
  141.     friend class IDTreeWalkerImpl;
  142.     friend class IDRangeImpl;
  143.     friend class IDDOMParser;
  144.     void setDocumentType(IDOM_DocumentType *doctype);
  145. public:
  146.     IDDocumentImpl();
  147.     IDDocumentImpl(const XMLCh      *namespaceURI,      //DOM Level 2
  148.                    const XMLCh      *qualifiedName,
  149.                    IDOM_DocumentType *doctype);
  150.     virtual ~IDDocumentImpl();
  151.     // Add all functions that are pure virutal in IDOM_NODE
  152.     IDOM_NODE_FUNCTIONS;
  153.     virtual IDOM_Attr             *createAttribute(const XMLCh *name);
  154.     virtual IDOM_CDATASection     *createCDATASection(const XMLCh *data);
  155.     virtual IDOM_Comment          *createComment(const XMLCh *data);
  156.     virtual IDOM_DocumentFragment *createDocumentFragment();
  157.     virtual IDOM_DocumentType     *createDocumentType(const XMLCh *name);
  158.     virtual IDOM_DocumentType     *createDocumentType(const XMLCh *qName,
  159.                                                     const XMLCh *publicId,
  160.                                                     const XMLCh *systemId);
  161.     virtual IDOM_Element          *createElement(const XMLCh * tagName);
  162.     virtual IDOM_Element          *createElementNoCheck(const XMLCh *tagName);
  163.     virtual IDOM_Entity           *createEntity(const XMLCh * name);
  164.     virtual IDOM_EntityReference  *createEntityReference(const XMLCh * name);
  165.     virtual IDOM_Notation         *createNotation(const XMLCh * name);
  166.     virtual IDOM_ProcessingInstruction *createProcessingInstruction(const XMLCh * target, const XMLCh * data);
  167.     virtual IDOM_Text             *createTextNode(const XMLCh * data);
  168.     virtual IDOM_DocumentType     *getDoctype() const;
  169.     virtual IDOM_Element          *getDocumentElement() const;
  170.     virtual IDOM_NodeList         *getElementsByTagName(const XMLCh * tagname) const;
  171.     virtual IDOM_DOMImplementation *getImplementation() const;
  172.     static  bool                  isXMLName(const XMLCh * s);
  173.     virtual IDOM_NodeIterator     *createNodeIterator(IDOM_Node *root,
  174.                                                       unsigned long whatToShow,
  175.                                                       IDOM_NodeFilter* filter,
  176.                                                       bool entityReferenceExpansion);
  177.     virtual IDOM_TreeWalker       *createTreeWalker(IDOM_Node *root,
  178.                                                     unsigned long whatToShow,
  179.                                                     IDOM_NodeFilter* filter,
  180.                                                     bool entityReferenceExpansion);
  181.     virtual void*                  getUserData() const;
  182.     virtual void                   setUserData(void* value);
  183.     virtual IDOM_Range            *createRange();
  184.     virtual Ranges*                getRanges() const;  //non-standard api
  185.     virtual void                   removeRange(IDRangeImpl* range); //non-standard api
  186.     // helper functions to prevent storing userdata pointers on every node.
  187.     virtual void  setUserData(IDOM_Node* n, void* data);
  188.     virtual void* getUserData(const IDOM_Node* n) const;
  189.     //
  190.     // Functions to keep track of document mutations, so that node list chached
  191.     //   information can be invalidated.  One global changes counter per document.
  192.     //
  193.     virtual void                 changed();
  194.     virtual int                  changes() const;
  195.     /**
  196.      * Sets whether the DOM implementation performs error checking
  197.      * upon operations. Turning off error checking only affects
  198.      * the following DOM checks:
  199.      * <ul>
  200.      * <li>Checking strings to make sure that all characters are
  201.      *     legal XML characters
  202.      * <li>Hierarchy checking such as allowed children, checks for
  203.      *     cycles, etc.
  204.      * </ul>
  205.      * <p>
  206.      * Turning off error checking does <em>not</em> turn off the
  207.      * following checks:
  208.      * <ul>
  209.      * <li>Read only checks
  210.      * <li>Checks related to DOM events
  211.      * </ul>
  212.      */
  213.     inline void setErrorChecking(bool check) {
  214.         errorChecking = check;
  215.     }
  216.     /**
  217.      * Returns true if the DOM implementation performs error checking.
  218.      */
  219.     inline bool getErrorChecking() {
  220.         return errorChecking;
  221.     }
  222.     //Introduced in DOM Level 2
  223.     virtual IDOM_Node            *importNode(IDOM_Node *source, bool deep);
  224.     virtual IDOM_Element         *createElementNS(const XMLCh *namespaceURI,
  225.                                              const XMLCh *qualifiedName);
  226.     virtual IDOM_Attr            *createAttributeNS(const XMLCh *namespaceURI,
  227.                                              const XMLCh *qualifiedName);
  228.     virtual IDOM_NodeList        *getElementsByTagNameNS(const XMLCh *namespaceURI,
  229.                                               const XMLCh *localName) const;
  230.     virtual IDOM_Element         *getElementById(const XMLCh *elementId) const;
  231.     //Return the index > 0 of ':' in the given qualified name qName="prefix:localName".
  232.     //Return 0 if there is no ':', or -1 if qName is malformed such as ":abcd".
  233.     static  int                 indexofQualifiedName(const XMLCh * qName);
  234.     static  bool                isKidOK(IDOM_Node *parent, IDOM_Node *child);
  235.     inline IDNodeIDMap *          getNodeIDMap() {return fNodeIDMap;};
  236.     //
  237.     // Memory Management Functions.  All memory is allocated by and owned by
  238.     //                               a document, and is not recovered until the
  239.     //                               document itself is deleted.
  240.     //
  241.     void        * allocate(size_t amount);
  242.     XMLCh       * cloneString(const XMLCh *src);
  243.     const XMLCh * getPooledString(const XMLCh *src);
  244.     void          deleteHeap();
  245.     // Factory methods for getting/creating node lists.
  246.     // Because nothing is ever deleted, the implementation caches and recycles
  247.     //  previously used instances of IDDeepNodeList
  248.     //
  249.     IDOM_NodeList *getDeepNodeList(const IDOM_Node *rootNode, const XMLCh *tagName);
  250.     IDOM_NodeList *getDeepNodeList(const IDOM_Node *rootNode, //DOM Level 2
  251.                             const XMLCh *namespaceURI,
  252.                                      const XMLCh *localName);
  253. private:
  254.     IDDeepNodeListPool<IDDeepNodeListImpl> *fNodeListPool;
  255. };
  256. //
  257. //  Operator new.  Global overloaded version, lets any object be allocated on
  258. //                 the heap owned by a document.
  259. //
  260. inline void * operator new(size_t amt, IDOM_Document *doc)
  261. {
  262.     // idom_revist.  Probably should be a checked cast.
  263.     void *p = ((IDDocumentImpl *)doc)->allocate(amt);
  264.     return p;
  265. }
  266. #endif