chxmapguidtoobj.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:10k
源码类别:

Symbian

开发平台:

C/C++

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