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

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: chxmapstringtoob.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 _CHXMAPSTRINGTOOB_H_
  50. #define _CHXMAPSTRINGTOOB_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. #include "hlxclib/string.h"     // strcasecmp()
  84. class CHXMapStringToOb
  85. {
  86. public:
  87.     typedef const char* key_type;
  88.     typedef const char* key_arg_type;
  89.     typedef const char* key_ref_type;
  90.     inline static CHXString& key_nil() { return (CHXString&)HXEmptyString; }
  91.     typedef void* value_type;
  92.     typedef void* value_arg_type;
  93.     typedef void*& value_ref_type;
  94.     typedef void* value_const_ref_type;
  95.     inline static value_ref_type val_nil() { static const value_type p = 0; return (value_ref_type)p; }
  96.     struct Item
  97.     {
  98.         Item (key_arg_type key_ = key_nil(),
  99.               value_arg_type val_ = val_nil(),
  100.               bool bFree_ = true) :
  101.             key(key_), val(val_), bFree(bFree_)
  102.         {}
  103.         CHXString  key;
  104.         value_type val;
  105.         bool  bFree;
  106.     };
  107.     DECLARE_ITEMVEC(ItemVec_t,Item,Item(),0,0);
  108.     class Iterator
  109.     {
  110.     public:
  111.         typedef key_type iter_key_type;
  112.         friend class CHXMapStringToOb;
  113.         // NOTE: (item == -1) is used to mean "set to end of pItems".
  114.         Iterator(ItemVec_t* pItems = NULL,
  115.                  int item = -1);
  116.         // NOTE: Values of 'next' copied into iterator...since this
  117.         //       iterator is caching key/value and doesn't return a
  118.         //       value_type&, it can't be used to modify the values in the
  119.         //       map.
  120.         Iterator& operator++();
  121.         Iterator  operator++(int); // XXXSAB: tested?
  122.         BOOL operator==(const Iterator&) const;
  123.         BOOL operator!=(const Iterator&) const;
  124.         value_type operator*(); // returns the 'value'
  125.         iter_key_type get_key  ();   // returns the 'key'
  126.     private:
  127.         void GotoValid();
  128.         ItemVec_t*      m_pItems;
  129.         int             m_item;
  130.         // cached key/value
  131.         CHXString       m_key;
  132.         value_type      m_val;
  133.     };
  134. private:
  135. #if defined(HELIX_CONFIG_NOSTATICS)
  136.     static const ULONG32 z_defaultNumBuckets;
  137.     static const ULONG32 z_defaultChunkSize;
  138.     static const ULONG32 z_defaultBucketChunkSize;
  139. #else
  140.     static ULONG32 z_defaultNumBuckets;
  141.     static ULONG32 z_defaultChunkSize;
  142.     static ULONG32 z_defaultBucketChunkSize;
  143. #endif
  144.     
  145. public:
  146.     // Construction
  147.     // NOTE: Chunk size is the number of key/value pairs to grow by each
  148.     //       time one of the hash buckets needs to be grown.
  149.     CHXMapStringToOb(int chunkSize = z_defaultChunkSize);
  150.     ~CHXMapStringToOb();
  151.     // Attributes
  152.     inline int GetCount() const;
  153.     inline BOOL IsEmpty() const;
  154.     BOOL Lookup(key_arg_type key, value_arg_type& value) const;
  155.     POSITION Lookup(key_arg_type key) const;
  156.     // XXXSAB: I added GetKeyAt() and GetAt() since there was previously
  157.     //         no easy way to get those data without advancing the
  158.     //         POSITION.
  159.     key_ref_type GetKeyAt(POSITION pos) const;
  160.     value_const_ref_type GetAt(POSITION pos) const;
  161.     value_ref_type GetAt(POSITION pos);
  162.     // Lookup & add if not there
  163.     value_ref_type operator[](key_arg_type key);
  164.     // add a new (key, value) pair
  165.     POSITION SetAt(key_arg_type key, value_arg_type value);
  166.     // remove existing (key, ?) pair
  167.     POSITION Remove(key_arg_type key);
  168.     BOOL RemoveKey(key_arg_type key);
  169.     void RemoveAll();
  170.     // Iteration
  171.     POSITION GetStartPosition() const;
  172.     void GetNextAssoc (POSITION& pos, key_arg_type& key, value_arg_type& value) const;
  173.     // CHXString Helper...
  174.     void GetNextAssoc (POSITION& pos, CHXString& key, value_arg_type& value) const
  175.     {
  176.         const char* sz = NULL;
  177.         GetNextAssoc (pos, sz, value);
  178.         if (sz) key = sz;
  179.     }
  180.     Iterator Begin();
  181.     Iterator End();
  182.     Iterator Erase(Iterator it);
  183.     // XXXSAB: Added Find() command to parallel STL style method
  184.     Iterator Find(key_arg_type key);
  185.     // Returns the number of hash buckets
  186.     inline ULONG32 GetHashTableSize() const;
  187.     // This will reset the internal storage so that any the map will be
  188.     // empty when this returns.
  189.     // NOTE: This function always allocates some data - the bAlloc flag is
  190.     //       for compatibility with an old interface and is ignored.
  191.     HX_RESULT InitHashTable(ULONG32 numBuckets = z_defaultNumBuckets,
  192.                        BOOL bAlloc = TRUE);
  193.     // defaults to on. Set this before you add anything! And make sure
  194.     // that if you set a hash function that it's behavior matches the case
  195.     // sensitivity flag.
  196.     void SetCaseSensitive(BOOL bCaseSens) { m_bCaseSens = bCaseSens ? true : false; }
  197.     typedef ULONG32 (*HashFunc_t) (key_arg_type key);
  198.     static ULONG32 DefaultHashFunc (key_arg_type key)
  199.     {
  200.         return HlxMap::StrHashFunc(key, true);
  201.     }
  202.     static ULONG32 DefaultNoCaseHashFunc (key_arg_type key)
  203.     {
  204.         return HlxMap::StrHashFunc(key, false);
  205.     }
  206.     inline HashFunc_t SetHashFunc (HashFunc_t hf = DefaultHashFunc); // XXXSAB: tested???
  207.     // Overrideables: special non-virtual (XXXSAB: Huh?)
  208.     inline ULONG32 HashKey(key_arg_type key) const;
  209.     inline static void SetDefaultNumBuckets (ULONG32 numBuckets);
  210.     inline static void SetDefaultChunkSize (ULONG32 chunkSize);
  211.     inline static void SetDefaultBucketChunkSize (ULONG32 chunkSize);
  212.     inline void SetBucketChunkSize (ULONG32 chunkSize);
  213.     // In _DEBUG mode, this does a bunch of DPRINTF's...
  214.     void Dump() const;
  215. private:
  216.     inline BOOL Lookup(key_arg_type key, int& retItem) const;
  217.     BOOL LookupInBucket(ULONG32 bucket, key_arg_type key, int& retItem) const;
  218.     Item* LookupItem(ULONG32 bucket, key_arg_type key);
  219.     inline const Item* LookupItem(ULONG32 bucket, key_arg_type key) const
  220.     {
  221.         return ((CHXMapStringToOb*)this)->LookupItem(bucket, key);
  222.     }
  223.     // Internal function - key already verified not to exist
  224.     BOOL AddToBucket(ULONG32 bucket, key_arg_type key, value_arg_type value, int& retItem);
  225.     inline POSITION Item2Pos(int item) const;
  226.     inline int Pos2Item(POSITION pos) const;
  227. private:
  228.     HashFunc_t          m_hf;
  229.     ItemVec_t           m_items;
  230.     HlxMap::IntVec_t    m_free;
  231.     CHlxMapBuckets      m_buckets;
  232.     ULONG32             m_numBuckets;
  233.     ULONG32             m_chunkSize;
  234.     ULONG32             m_bucketChunkSize;
  235.     // Members specific to the type of key and/or value goes below here.
  236.     void ConstructTypeSpecifics();
  237.     inline BOOL IsKeyMatch (key_arg_type k1, key_arg_type k2) const
  238.     {
  239.         BOOL bRet;
  240.         if (m_bCaseSens) bRet = (strcmp(k1, k2) == 0);
  241.         else bRet = (strcasecmp(k1, k2) == 0);
  242. #ifdef XXXSAB
  243.         printf ("IsKeyMatch("%s", "%s") -> %sn",
  244.                 k1, k2,
  245.                 bRet ? "true" : "false");
  246. #endif /* XXXSAB */
  247.         return bRet;
  248.     }
  249.     bool                m_bCaseSens;
  250. };
  251. int CHXMapStringToOb::GetCount() const
  252. {
  253.     return m_items.size() - m_free.size();
  254. }
  255. BOOL CHXMapStringToOb::IsEmpty() const
  256. {
  257.     return GetCount() == 0;
  258. }
  259. ULONG32 CHXMapStringToOb::GetHashTableSize() const
  260. {
  261.     return m_numBuckets;
  262. }
  263. CHXMapStringToOb::HashFunc_t CHXMapStringToOb::SetHashFunc (
  264.     CHXMapStringToOb::HashFunc_t hf)
  265. {
  266.     HashFunc_t old = m_hf;
  267.     m_hf = hf;
  268.     return old;
  269. }
  270. ULONG32 CHXMapStringToOb::HashKey (key_arg_type key) const
  271. {
  272.     if (m_hf) return m_hf(key);
  273.     return m_bCaseSens ? DefaultHashFunc(key) : DefaultNoCaseHashFunc(key);
  274. }
  275. void CHXMapStringToOb::SetDefaultNumBuckets (ULONG32 numBuckets)
  276. {
  277. #if !defined(HELIX_CONFIG_NOSTATICS)
  278.     z_defaultNumBuckets = numBuckets;
  279. #endif
  280. }
  281. void CHXMapStringToOb::SetDefaultChunkSize (ULONG32 chunkSize)
  282. {
  283. #if !defined(HELIX_CONFIG_NOSTATICS)
  284.     z_defaultChunkSize = chunkSize;
  285. #endif
  286. }
  287. void CHXMapStringToOb::SetDefaultBucketChunkSize (ULONG32 chunkSize)
  288. {
  289. #if !defined(HELIX_CONFIG_NOSTATICS)
  290.     z_defaultBucketChunkSize = chunkSize;
  291. #endif
  292. }
  293. void CHXMapStringToOb::SetBucketChunkSize (ULONG32 chunkSize)
  294. {
  295.     m_bucketChunkSize = chunkSize;
  296. }
  297. #endif // _CHXMAPSTRINGTOOB_H_