chxmapptrtoptr.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:11k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: chxmapptrtoptr.h,v 1.6.32.3 2004/07/09 01:45:51 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef _CHXMAPPTRTOPTR_H_
  50. #define _CHXMAPPTRTOPTR_H_
  51. // Notes...
  52. //
  53. // Since we aren't using templates, we get to copy the same basic code all
  54. // over the place.  So, if you change something in this class, chances are
  55. // that the other CHXMap*To* classes may need the change as well.
  56. // XXXSAB: Need to better abstract out the common code...
  57. //
  58. // This implementation has a few dynamically resized vectors - their
  59. // "chunk sizes" (number of elements added to size when a new element
  60. // addition requires a reallocation) can be adjusted via the following
  61. // accessors.
  62. //
  63. //    m_items - This is the vector of actual key/value pairs (along with a
  64. //        boolean "free" flag) where the data for the map is stored.  It's
  65. //        chunk size is controlled via the optional argument to the map
  66. //        ctor.  And the default value for that is controlled by the
  67. //        static SetDefaultChunkSize() method.
  68. //
  69. //    m_buckets - This is the vector of hash buckets.  Each hash bucket is
  70. //        a vector of int indices into the m_items vector.  The number of
  71. //        buckets doesn't change over time and is controlled via the
  72. //        InitHashTable() method (which has the effect of resetting the
  73. //        map) and it defaults to z_defaultNumBuckets (101 at the moment).
  74. //        The chunk size of the individual hash buckets is set by the
  75. //        SetBucketChunkSize() method and the default for that is set by
  76. //        the SetDefaultBucketChunkSize() method.
  77. //
  78. #include "hxtypes.h"
  79. #include "carray.h"
  80. #include "hxstring.h"
  81. #include "hxmaputils.h"
  82. #include "chxmapbuckets.h"
  83. class CHXMapPtrToPtr
  84. {
  85. public:
  86.     typedef void* key_type;
  87.     typedef void* key_arg_type;
  88.     typedef void* key_ref_type;
  89.     inline static key_type key_nil() { return NULL; }
  90.     typedef void* value_type;
  91.     typedef void* value_arg_type;
  92.     typedef void*& value_ref_type;
  93.     typedef void* value_const_ref_type;
  94.     inline static value_ref_type val_nil() { static const value_type p = 0; return (value_ref_type)p; }
  95.     struct Item
  96.     {
  97.         Item (key_arg_type key_ = key_nil(),
  98.               value_arg_type val_ = val_nil(),
  99.               bool bFree_ = true) :
  100.             key(key_), val(val_), bFree(bFree_)
  101.         {}
  102.         key_type key;
  103.         value_type val;
  104.         bool  bFree;
  105.     };
  106.     DECLARE_ITEMVEC(ItemVec_t,Item,Item(),0,0);
  107.     class Iterator
  108.     {
  109.     public:
  110.         typedef key_type iter_key_type;
  111.         friend class CHXMapPtrToPtr;
  112.         // NOTE: (item == -1) is used to mean "set to end of pItems".
  113.         Iterator(ItemVec_t* pItems = NULL,
  114.                  int item = -1);
  115.         // NOTE: Values of 'next' copied into iterator...since this
  116.         //       iterator is caching key/value and doesn't return a
  117.         //       value_type&, it can't be used to modify the values in the
  118.         //       map.
  119.         Iterator& operator++();
  120.         Iterator  operator++(int); // XXXSAB: tested?
  121.         BOOL operator==(const Iterator&) const;
  122.         BOOL operator!=(const Iterator&) const;
  123.         value_type operator*(); // returns the 'value'
  124.         iter_key_type get_key  ();   // returns the 'key'
  125.     private:
  126.         void GotoValid();
  127.         ItemVec_t*      m_pItems;
  128.         int             m_item;
  129.         // cached key/value
  130.         iter_key_type   m_key;
  131.         value_type      m_val;
  132.     };
  133. private:
  134. #if defined(HELIX_CONFIG_NOSTATICS)
  135.     static const ULONG32 z_defaultNumBuckets;
  136.     static const ULONG32 z_defaultChunkSize;
  137.     static const ULONG32 z_defaultBucketChunkSize;
  138. #else
  139.     static ULONG32 z_defaultNumBuckets;
  140.     static ULONG32 z_defaultChunkSize;
  141.     static ULONG32 z_defaultBucketChunkSize;
  142. #endif
  143.     
  144. public:
  145.     // Construction
  146.     // NOTE: Chunk size is the number of key/value pairs to grow by each
  147.     //       time one of the hash buckets needs to be grown.
  148.     CHXMapPtrToPtr(int chunkSize = z_defaultChunkSize);
  149.     ~CHXMapPtrToPtr();
  150.     // Attributes
  151.     inline int GetCount() const;
  152.     inline BOOL IsEmpty() const;
  153.     BOOL Lookup(key_arg_type key, value_arg_type& value) const;
  154.     POSITION Lookup(key_arg_type key) const;
  155.     // XXXSAB: I added GetKeyAt() and GetAt() since there was previously
  156.     //         no easy way to get those data without advancing the
  157.     //         POSITION.
  158.     key_ref_type GetKeyAt(POSITION pos) const;
  159.     value_const_ref_type GetAt(POSITION pos) const;
  160.     value_ref_type GetAt(POSITION pos);
  161.     // Lookup & add if not there
  162.     value_ref_type operator[](key_arg_type key);
  163.     // add a new (key, value) pair
  164.     POSITION SetAt(key_arg_type key, value_arg_type value);
  165.     // remove existing (key, ?) pair
  166.     POSITION Remove(key_arg_type key);
  167.     BOOL RemoveKey(key_arg_type key);
  168.     void RemoveAll();
  169.     // Iteration
  170.     POSITION GetStartPosition() const;
  171.     void GetNextAssoc (POSITION& pos, key_arg_type& key, value_arg_type& value) const;
  172.     Iterator Begin();
  173.     Iterator End();
  174.     Iterator Erase(Iterator it);
  175.     // XXXSAB: Added Find() command to parallel STL style method
  176.     Iterator Find(key_arg_type key);
  177.     // Returns the number of hash buckets
  178.     inline ULONG32 GetHashTableSize() const;
  179.     // This will reset the internal storage so that any the map will be
  180.     // empty when this returns.
  181.     HX_RESULT InitHashTable(ULONG32 numBuckets = z_defaultNumBuckets,
  182.                        BOOL bAlloc = TRUE);
  183.     typedef ULONG32 (*HashFunc_t) (key_arg_type key);
  184.     static ULONG32 DefaultHashFunc (key_arg_type key);
  185.     inline HashFunc_t SetHashFunc (HashFunc_t hf = DefaultHashFunc); // XXXSAB: tested???
  186.     // Overrideables: special non-virtual (XXXSAB: Huh?)
  187.     inline ULONG32 HashKey(key_arg_type key) const;
  188.     inline static void SetDefaultNumBuckets (ULONG32 numBuckets);
  189.     inline static void SetDefaultChunkSize (ULONG32 chunkSize);
  190.     inline static void SetDefaultBucketChunkSize (ULONG32 chunkSize);
  191.     inline void SetBucketChunkSize (ULONG32 chunkSize);
  192.     // In _DEBUG mode, this does a bunch of DPRINTF's...
  193.     void Dump() const;
  194. private:
  195.     inline BOOL Lookup(key_arg_type key, int& retItem) const;
  196.     BOOL LookupInBucket(ULONG32 bucket, key_arg_type key, int& retItem) const;
  197.     Item* LookupItem(ULONG32 bucket, key_arg_type key);
  198.     inline const Item* LookupItem(ULONG32 bucket, key_arg_type key) const
  199.     {
  200.         return ((CHXMapPtrToPtr*)this)->LookupItem(bucket, key);
  201.     }
  202.     // Internal function - key already verified not to exist
  203.     BOOL AddToBucket(ULONG32 bucket, key_arg_type key, value_arg_type value, int& retItem);
  204.     inline POSITION Item2Pos(int item) const;
  205.     inline int Pos2Item(POSITION pos) const;
  206. private:
  207.     HashFunc_t          m_hf;
  208.     ItemVec_t           m_items;
  209.     HlxMap::IntVec_t    m_free;
  210.     CHlxMapBuckets      m_buckets;
  211.     ULONG32             m_numBuckets;
  212.     ULONG32             m_chunkSize;
  213.     ULONG32             m_bucketChunkSize;
  214.     // Members specific to the type of key and/or value goes below here.
  215.     void ConstructTypeSpecifics();
  216.     inline BOOL IsKeyMatch (key_arg_type k1, key_arg_type k2) const
  217.     {
  218.         return (k1 == k2) ? TRUE : FALSE;
  219.     }
  220. };
  221. int CHXMapPtrToPtr::GetCount() const
  222. {
  223.     return m_items.size() - m_free.size();
  224. }
  225. BOOL CHXMapPtrToPtr::IsEmpty() const
  226. {
  227.     return GetCount() == 0;
  228. }
  229. ULONG32 CHXMapPtrToPtr::GetHashTableSize() const
  230. {
  231.     return m_numBuckets;
  232. }
  233. CHXMapPtrToPtr::HashFunc_t CHXMapPtrToPtr::SetHashFunc (
  234.     CHXMapPtrToPtr::HashFunc_t hf)
  235. {
  236.     HashFunc_t old = m_hf;
  237.     m_hf = hf;
  238.     return old;
  239. }
  240. ULONG32 CHXMapPtrToPtr::HashKey (key_arg_type key) const
  241. {
  242.     if (m_hf) return m_hf(key);
  243.     return DefaultHashFunc(key);
  244. }
  245. void CHXMapPtrToPtr::SetDefaultNumBuckets (ULONG32 numBuckets)
  246. {
  247. #if !defined(HELIX_CONFIG_NOSTATICS)
  248.     z_defaultNumBuckets = numBuckets;
  249. #endif
  250. }
  251. void CHXMapPtrToPtr::SetDefaultChunkSize (ULONG32 chunkSize)
  252. {
  253. #if !defined(HELIX_CONFIG_NOSTATICS)
  254.     z_defaultChunkSize = chunkSize;
  255. #endif
  256. }
  257. void CHXMapPtrToPtr::SetDefaultBucketChunkSize (ULONG32 chunkSize)
  258. {
  259. #if !defined(HELIX_CONFIG_NOSTATICS)
  260.     z_defaultBucketChunkSize = chunkSize;
  261. #endif
  262. }
  263. void CHXMapPtrToPtr::SetBucketChunkSize (ULONG32 chunkSize)
  264. {
  265.     m_bucketChunkSize = chunkSize;
  266. }
  267. #endif // _CHXMAPPTRTOPTR_H_