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

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: hxslist.h,v 1.5.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 HXLIST_H_
  50. #define HXLIST_H_
  51. #include "hxcom.h"
  52. #include "hxstring.h"
  53. #include "hxassert.h"
  54. typedef void* LISTPOSITION;
  55. //
  56. // CHXSimpleList
  57. //
  58. class CHXSimpleList {
  59. public:
  60.     CHXSimpleList();
  61.     
  62.     virtual ~CHXSimpleList();
  63. // TRUE if list is internally consistent
  64.     virtual BOOL IsPtrListValid();
  65.     
  66. // return number of elements in list
  67.     int GetCount() const;
  68. // return TRUE if number of elements == 0
  69.     BOOL IsEmpty() const;
  70. // poke at first element
  71.     void*& GetHead();
  72. // peek at first element
  73.     void* GetHead() const;
  74. // poke at last element
  75.     void*& GetTail();
  76. // peek at last element
  77.     void* GetTail() const;
  78. // remove first element
  79.     void* RemoveHead();
  80. // remove last element
  81.     void* RemoveTail();
  82. // insert value before first element
  83.     LISTPOSITION AddHead(void* value);
  84. // insert value after last element
  85.     LISTPOSITION AddTail(void* value);
  86. // insert list before first element
  87.     void AddHead(CHXSimpleList* pList);
  88. // insert list after last element
  89.     void AddTail(CHXSimpleList* pTail);
  90. // clear all elements from the list
  91.     virtual void RemoveAll();
  92. // get LISTPOSITION at start of list
  93.     LISTPOSITION GetHeadPosition() const;
  94. // get LISTPOSITION at end of list
  95.     LISTPOSITION GetTailPosition() const;
  96. // return value at current position and incr
  97.     void*& GetNext(LISTPOSITION& pos);
  98. // return value at current position and incr
  99.     void* GetNext(LISTPOSITION& pos) const;
  100. // return value at current position and decr
  101.     void*& GetPrev(LISTPOSITION& pos);
  102. // return value at current position and decr
  103.     void* GetPrev(LISTPOSITION& pos) const;
  104. // incr and return value at current position 
  105.     void*& GetAtNext(LISTPOSITION& pos);
  106. // incr and return value at current position
  107.     void* GetAtNext(LISTPOSITION& pos) const;
  108. // decr and return value at current position
  109.     void*& GetAtPrev(LISTPOSITION& pos);
  110. // decr and return value at current position
  111.     void* GetAtPrev(LISTPOSITION& pos) const;
  112. // get value at LISTPOSITION
  113.     void*& GetAt(LISTPOSITION pos);
  114. // get value at LISTPOSITION
  115.     void* GetAt(LISTPOSITION pos) const;
  116. // set value at LISTPOSITION
  117.     void SetAt(LISTPOSITION pos, void* value);
  118. // remove value at LISTPOSITION
  119.     virtual LISTPOSITION RemoveAt(LISTPOSITION pos);
  120.     
  121. // insert before LISTPOSITION
  122.     virtual LISTPOSITION InsertBefore(LISTPOSITION pos, void* value);
  123. // insert after LISTPOSITION
  124.     virtual LISTPOSITION InsertAfter(LISTPOSITION pos, void* value);
  125.     
  126. // search for value in list
  127.     virtual LISTPOSITION Find(void* value, LISTPOSITION start=NULL);
  128. // get the LISTPOSITION for element at index
  129.     LISTPOSITION FindIndex(int index) const;
  130.     typedef BOOL (*ConditionFunc)(void* pUser, void* pData);
  131.     LISTPOSITION ForEach(LISTPOSITION start, LISTPOSITION end, void* pUser,
  132.  ConditionFunc func);
  133.     class Iterator {
  134. friend class CHXSimpleList;
  135.     public:
  136. Iterator();
  137. // increment
  138. Iterator& operator++();
  139. // comparison
  140. BOOL operator==(const Iterator& iter) const;
  141. // comparison
  142. BOOL operator!=(const Iterator& iter) const;
  143. // get value
  144. void* operator*();
  145.     private:
  146. Iterator(CHXSimpleList* pList, LISTPOSITION pos);
  147. CHXSimpleList* m_pList;
  148. LISTPOSITION m_pos;
  149.     };
  150. // return iterator pointing to start of list
  151.     Iterator Begin();
  152. // return iterator pointing to end of list
  153.     Iterator End();
  154.     struct CNode {
  155. CNode* m_prev;
  156. CNode* m_next;
  157. void* m_value;
  158. CNode() : m_prev(NULL), m_next(NULL), m_value(NULL) {}
  159. CNode(void* value) : m_prev(NULL), m_next(NULL), m_value(value) {}
  160. void* GetValue() const { return m_value; }
  161. void*& GetValue() { return m_value; }
  162. void SetValue(void* value) { m_value = value; }
  163. CNode* GetPrev() const { return m_prev; }
  164. CNode* GetNext() const { return m_next; }
  165. void SetPrev(CNode* pPrev) { m_prev = pPrev; }
  166. void SetNext(CNode* pNext) { m_next = pNext; }
  167.     };
  168.     // If _DEBUG, Dump() will do a bunch of printf()'s...
  169.     virtual void Dump(const char* label = "Dump: ") const;
  170. protected:
  171.     CNode* CreateNode(void* value);
  172.     typedef BOOL (*ConditionNodeFunc)(void* pUser, const CNode* pNode);
  173.     LISTPOSITION ForEach(LISTPOSITION start, LISTPOSITION end, void* pUser,
  174.  ConditionNodeFunc func) const;
  175.     // Remove an item from the list without doing deallocations of
  176.     // contained data.
  177.     CNode* RemoveNode(CNode* pNode);
  178. private:
  179. // number of elements in the list
  180.     int m_nelems;
  181. // pointer to head node
  182.     CNode* m_pHead;
  183. // pointer to tail node
  184.     CNode* m_pTail;
  185.     inline static const void* const& _nil()
  186. {
  187.     static const void* const m_nil = NULL;
  188.     return (const void*&)m_nil;
  189. }
  190. };
  191. //
  192. // CHXStringList
  193. //
  194. class CHXString;
  195. class CHXStringList : public CHXSimpleList {
  196. public:
  197.     virtual ~CHXStringList() { RemoveAll(); }
  198.     // find a string in the list
  199.     LISTPOSITION FindString(const char* pString,
  200.     LISTPOSITION start=NULL,
  201.     BOOL caseSensitive=TRUE);
  202.     // find a string that starts with 'pPrefix'
  203.     LISTPOSITION FindPrefixSubstring(const char* pPrefix,
  204.     LISTPOSITION start=NULL,
  205.     BOOL caseSensitive=TRUE);
  206.     // add string at head
  207.     LISTPOSITION AddHeadString(const char* pString);
  208.     // add string at tail
  209.     LISTPOSITION AddTailString(const char* pTail);
  210.     // add string in sorted alpha order.
  211.     // NOTE: The 'caseSensitive' flag defaults to FALSE to maintain
  212.     //       backwards compat with previous incarnations of this class.
  213.     LISTPOSITION AddStringAlphabetic(const char* pString,
  214.                                      BOOL caseSensitive=FALSE);
  215.     // get the next string in the list
  216.     CHXString* GetNext(LISTPOSITION& pos) const;
  217.     // clear all elements from the list
  218.     virtual void RemoveAll();
  219.     // Override so we can delete the contained CHXString*
  220.     virtual LISTPOSITION RemoveAt(LISTPOSITION pos);
  221.     // remove head string and free mem
  222.     void RemoveHeadString();
  223.     // remove tail string and free mem
  224.     void RemoveTailString();
  225.     // If _DEBUG, Dump() will do a bunch of printf()'s...
  226.     virtual void Dump(const char* label = "Dump: ") const;
  227. private:
  228.     CHXSimpleList* m_pStrings;
  229. };
  230. //
  231. // CHXSimpleList inline methods
  232. //    
  233. // return number of elements in list
  234. inline int 
  235. CHXSimpleList::GetCount() const
  236. {
  237.     return m_nelems;
  238. }
  239. // return TRUE if number of elements == 0
  240. inline BOOL 
  241. CHXSimpleList::IsEmpty() const
  242. {
  243.     return m_nelems == 0;
  244. }
  245. // poke at first element
  246. inline void*& 
  247. CHXSimpleList::GetHead()
  248. {
  249.     HX_ASSERT(m_pHead != NULL);
  250.     return m_pHead->GetValue();
  251. }
  252. // peek at first element
  253. inline void* 
  254. CHXSimpleList::GetHead() const
  255. {
  256.     HX_ASSERT(m_pHead != NULL);
  257.     return m_pHead->GetValue();
  258. }
  259. // poke at last element
  260. inline void*& 
  261. CHXSimpleList::GetTail()
  262. {
  263.     HX_ASSERT(m_pTail != NULL);
  264.     return m_pTail->GetValue();
  265. }
  266. // peek at last element
  267. inline void* 
  268. CHXSimpleList::GetTail() const
  269. {
  270.     HX_ASSERT(m_pTail != NULL);
  271.     return m_pTail->GetValue();
  272. }
  273. inline LISTPOSITION
  274. CHXSimpleList::RemoveAt(LISTPOSITION pos)
  275. {
  276.     HX_ASSERT(pos);
  277.     if (! pos) return NULL;
  278.     return (LISTPOSITION)RemoveNode((CNode*)pos);
  279. }
  280. // remove first element
  281. inline void* 
  282. CHXSimpleList::RemoveHead()
  283. {
  284.     HX_ASSERT(m_pHead != NULL);
  285.     void* value = m_pHead->GetValue();
  286.     // Don't call RemoveAt() - that's a virtual method that subclasses
  287.     // might use to deallocate the data contained in this item, but we
  288.     // want to return that data to the caller
  289.     (void)RemoveNode(m_pHead);
  290.     return value;
  291. }
  292. // remove last element
  293. inline void* 
  294. CHXSimpleList::RemoveTail()
  295. {
  296.     HX_ASSERT(m_pTail != NULL);
  297.     void* value = m_pTail->GetValue();
  298.     // Don't call RemoveAt() - that's a virtual method that subclasses
  299.     // might use to deallocate the data contained in this item, but we
  300.     // want to return that data to the caller
  301.     (void)RemoveNode(m_pTail);
  302.     return value;
  303. }
  304. // insert value before first element
  305. inline LISTPOSITION 
  306. CHXSimpleList::AddHead(void* value)
  307. {
  308.     return InsertBefore((LISTPOSITION)m_pHead, value);
  309. }
  310. // insert value after last element
  311. inline LISTPOSITION 
  312. CHXSimpleList::AddTail(void* value)
  313. {
  314.     return InsertAfter((LISTPOSITION)m_pTail, value);
  315. }
  316. // get LISTPOSITION at start of list
  317. inline LISTPOSITION 
  318. CHXSimpleList::GetHeadPosition() const
  319. {
  320.     return (LISTPOSITION)m_pHead;
  321. }
  322. // get LISTPOSITION at end of list
  323. inline LISTPOSITION 
  324. CHXSimpleList::GetTailPosition() const
  325. {
  326.     return (LISTPOSITION)m_pTail;
  327. }
  328. // return iterator pointing to start of list
  329. inline CHXSimpleList::Iterator 
  330. CHXSimpleList::Begin()
  331. {
  332.     return Iterator(this, m_pHead);
  333. }
  334. // return iterator pointing to end of list
  335. inline CHXSimpleList::Iterator 
  336. CHXSimpleList::End()
  337. {
  338.     return Iterator(this, NULL);
  339. }
  340. ///
  341. /// CHXSimpleList::Iterator methods
  342. ///
  343. inline 
  344. CHXSimpleList::Iterator::Iterator()
  345.     : m_pList(0),
  346.       m_pos(NULL)
  347. {
  348. }
  349. inline 
  350. CHXSimpleList::Iterator::Iterator(CHXSimpleList* pList, LISTPOSITION pos)
  351.     : m_pList(pList),
  352.       m_pos(pos)
  353. {
  354. }
  355. // increment
  356. inline CHXSimpleList::Iterator& 
  357. CHXSimpleList::Iterator::operator++()
  358. {
  359.     HX_ASSERT (m_pos);
  360.     (void)m_pList->GetNext(m_pos);
  361.     return *this;
  362. }
  363. // comparison
  364. inline BOOL 
  365. CHXSimpleList::Iterator::operator==(const Iterator& iter) const
  366. {
  367.     return m_pList == iter.m_pList && m_pos == iter.m_pos;
  368. }
  369. // comparison
  370. inline BOOL 
  371. CHXSimpleList::Iterator::operator!=(const Iterator& iter) const
  372. {
  373.     return !operator==(iter);
  374. }
  375. // get value
  376. inline void* 
  377. CHXSimpleList::Iterator::operator*()
  378. {
  379.     HX_ASSERT (m_pList && m_pos);
  380.     return m_pList->GetAt(m_pos);
  381. }
  382. //
  383. // CHXStringList inline methods
  384. //
  385. // add string at head
  386. inline LISTPOSITION 
  387. CHXStringList::AddHeadString(const char* pString)
  388. {
  389.     return AddHead(new CHXString(pString));
  390. }
  391. // add string at tail
  392. inline LISTPOSITION 
  393. CHXStringList::AddTailString(const char* pString)
  394. {
  395.     return AddTail(new CHXString(pString));
  396. }
  397. // get the next string in the list
  398. inline CHXString* 
  399. CHXStringList::GetNext(LISTPOSITION& pos) const
  400. {
  401.     return (CHXString*)CHXSimpleList::GetNext(pos);
  402. }
  403. #endif /* HXLIST_H_ */