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

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 2001, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Id: DOMDeepNodeListPool.hpp,v 1.6 2003/05/22 02:10:51 knoaman Exp $
  58.  */
  59. //
  60. //  This file is part of the internal implementation of the C++ XML DOM.
  61. //  It should NOT be included or used directly by application programs.
  62. //
  63. //  Applications should include the file <xercesc/dom/DOM.hpp> for the entire
  64. //  DOM API, or xercesc/dom/DOM*.hpp for individual DOM classes, where the class
  65. //  name is substituded for the *.
  66. //
  67. #if !defined(DOMDeepNODELISTPOOL_HPP)
  68. #define DOMDeepNODELISTPOOL_HPP
  69. #include <xercesc/util/HashBase.hpp>
  70. #include <xercesc/util/IllegalArgumentException.hpp>
  71. #include <xercesc/util/NoSuchElementException.hpp>
  72. #include <xercesc/util/RuntimeException.hpp>
  73. #include <xercesc/util/XMLExceptMsgs.hpp>
  74. #include <xercesc/util/XMLEnumerator.hpp>
  75. #include <xercesc/util/XMLString.hpp>
  76. #include <xercesc/util/HashXMLCh.hpp>
  77. #include <xercesc/util/HashPtr.hpp>
  78. XERCES_CPP_NAMESPACE_BEGIN
  79. // This hash table is modified from RefHash3KeysIdPool with first key as object ptr (DOMNode),
  80. // second and third keys are both XMLCh* string
  81. template <class TVal> struct DOMDeepNodeListPoolTableBucketElem;
  82. //
  83. //  This should really be a nested class, but some of the compilers we
  84. //  have to support cannot deal with that!
  85. //
  86. template <class TVal>
  87. struct DOMDeepNodeListPoolTableBucketElem : public XMemory
  88. {
  89.     DOMDeepNodeListPoolTableBucketElem
  90.     (
  91.         void* key1
  92.         , XMLCh* key2
  93.         , XMLCh* key3
  94.         , TVal* const value
  95.         , DOMDeepNodeListPoolTableBucketElem<TVal>* next
  96.         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
  97.     ) :
  98.     fData(value)
  99.     , fNext(next)
  100.     , fKey1(key1)
  101.     , fKey2(0)
  102.     , fKey3(0)
  103.     {
  104.         if (key2)
  105.             fKey2 = XMLString::replicate(key2, manager);
  106.         if (key3)
  107.             fKey3 = XMLString::replicate(key3, manager);
  108.     }
  109.     TVal*                                     fData;
  110.     DOMDeepNodeListPoolTableBucketElem<TVal>* fNext;
  111.     void*                                     fKey1;
  112.     XMLCh*                                    fKey2;
  113.     XMLCh*                                    fKey3;
  114. };
  115. template <class TVal> class DOMDeepNodeListPool
  116. {
  117. public:
  118.     // -----------------------------------------------------------------------
  119.     //  Constructors and Destructor
  120.     // -----------------------------------------------------------------------
  121.     // backwards compatability - default hasher is HashXMLCh
  122.     DOMDeepNodeListPool
  123.     (
  124.         const XMLSize_t modulus
  125.       , const XMLSize_t initSize = 128
  126.     );
  127.     // backwards compatability - default hasher is HashXMLCh
  128.     DOMDeepNodeListPool
  129.     (
  130.         const XMLSize_t modulus
  131.       , const bool adoptElems
  132.       , const XMLSize_t initSize = 128
  133.     );
  134.     // if a hash function is passed in, it will be deleted when the hashtable is deleted.
  135.     // use a new instance of the hasher class for each hashtable, otherwise one hashtable
  136.     // may delete the hasher of a different hashtable if both use the same hasher.
  137.     DOMDeepNodeListPool
  138.     (
  139.          const XMLSize_t modulus
  140.        , const bool adoptElems
  141.        , HashBase* hash
  142.        , const XMLSize_t initSize = 128
  143.     );
  144.     ~DOMDeepNodeListPool();
  145.     // -----------------------------------------------------------------------
  146.     //  Element management
  147.     // -----------------------------------------------------------------------
  148.     bool isEmpty() const;
  149.     bool containsKey(const void* const key1, const XMLCh* const key2, const XMLCh* const key3) const;
  150.     void removeAll();
  151.     void cleanup();
  152.     // -----------------------------------------------------------------------
  153.     //  Getters
  154.     // -----------------------------------------------------------------------
  155.     TVal* getByKey(const void* const key1, const XMLCh* const key2, const XMLCh* const key3);
  156.     const TVal* getByKey(const void* const key1, const XMLCh* const key2, const XMLCh* const key3) const;
  157.     TVal* getById(const XMLSize_t elemId);
  158.     const TVal* getById(const XMLSize_t elemId) const;
  159.     // -----------------------------------------------------------------------
  160.     //  Putters
  161.     // -----------------------------------------------------------------------
  162. XMLSize_t put(void* key1, XMLCh* key2, XMLCh* key3, TVal* const valueToAdopt);
  163. private:
  164.     // -----------------------------------------------------------------------
  165.     //  Private methods
  166.     // -----------------------------------------------------------------------
  167.     DOMDeepNodeListPoolTableBucketElem<TVal>* findBucketElem(const void* const key1, const XMLCh* const key2, const XMLCh* const key3, XMLSize_t& hashVal);
  168.     const DOMDeepNodeListPoolTableBucketElem<TVal>* findBucketElem(const void* const key1, const XMLCh* const key2, const XMLCh* const key3, XMLSize_t& hashVal) const;
  169.     void initialize(const XMLSize_t modulus);
  170.     // -----------------------------------------------------------------------
  171.     //  Data members
  172.     //
  173.     //  fAdoptedElems
  174.     //      Indicates whether the values added are adopted or just referenced.
  175.     //      If adopted, then they are deleted when they are removed from the
  176.     //      hash table.
  177.     //
  178.     //  fBucketList
  179.     //      This is the array that contains the heads of all of the list
  180.     //      buckets, one for each possible hash value.
  181.     //
  182.     //  fHashModulus
  183.     //      The modulus used for this hash table, to hash the keys. This is
  184.     //      also the number of elements in the bucket list.
  185.     //
  186.     //  fHash
  187.     //      The hasher for the key1 data type.
  188.     //
  189.     //  fIdPtrs
  190.     //  fIdPtrsCount
  191.     //      This is the array of pointers to the bucket elements in order of
  192.     //      their assigned ids. So taking id N and referencing this array
  193.     //      gives you the element with that id. The count field indicates
  194.     //      the current size of this list. When fIdCounter+1 reaches this
  195.     //      value the list must be expanded.
  196.     //
  197.     //  fIdCounter
  198.     //      This is used to give out unique ids to added elements. It starts
  199.     //      at zero (which means empty), and is bumped up for each newly added
  200.     //      element. So the first element is 1, the next is 2, etc... This
  201.     //      means that this value is set to the top index of the fIdPtrs array.
  202.     // -----------------------------------------------------------------------
  203.     bool                                       fAdoptedElems;
  204.     DOMDeepNodeListPoolTableBucketElem<TVal>** fBucketList;
  205.     XMLSize_t                                  fHashModulus;
  206.     HashBase*                                  fHash;
  207.     TVal**                                     fIdPtrs;
  208.     XMLSize_t                                  fIdPtrsCount;
  209.     XMLSize_t                                  fIdCounter;
  210.     MemoryManager*                             fMemoryManager;
  211. };
  212. XERCES_CPP_NAMESPACE_END
  213. #if !defined(XERCES_TMPLSINC)
  214. #include <xercesc/dom/impl/DOMDeepNodeListPool.c>
  215. #endif
  216. #endif