wxlist.h
上传用户:liguizhu
上传日期:2015-11-01
资源大小:2422k
文件大小:19k
源码类别:

P2P编程

开发平台:

Visual C++

  1. //------------------------------------------------------------------------------
  2. // File: WXList.h
  3. //
  4. // Desc: DirectShow base classes - defines a non-MFC generic template list
  5. //       class.
  6. //
  7. // Copyright (c) Microsoft Corporation.  All rights reserved.
  8. //------------------------------------------------------------------------------
  9. /* A generic list of pointers to objects.
  10.    No storage management or copying is done on the objects pointed to.
  11.    Objectives: avoid using MFC libraries in ndm kernel mode and
  12.    provide a really useful list type.
  13.    The class is thread safe in that separate threads may add and
  14.    delete items in the list concurrently although the application
  15.    must ensure that constructor and destructor access is suitably
  16.    synchronised. An application can cause deadlock with operations
  17.    which use two lists by simultaneously calling
  18.    list1->Operation(list2) and list2->Operation(list1).  So don't!
  19.    The names must not conflict with MFC classes as an application
  20.    may use both.
  21.    */
  22. #ifndef __WXLIST__
  23. #define __WXLIST__
  24.    /* A POSITION represents (in some fashion that's opaque) a cursor
  25.       on the list that can be set to identify any element.  NULL is
  26.       a valid value and several operations regard NULL as the position
  27.       "one step off the end of the list".  (In an n element list there
  28.       are n+1 places to insert and NULL is that "n+1-th" value).
  29.       The POSITION of an element in the list is only invalidated if
  30.       that element is deleted.  Move operations may mean that what
  31.       was a valid POSITION in one list is now a valid POSITION in
  32.       a different list.
  33.       Some operations which at first sight are illegal are allowed as
  34.       harmless no-ops.  For instance RemoveHead is legal on an empty
  35.       list and it returns NULL.  This allows an atomic way to test if
  36.       there is an element there, and if so, get it.  The two operations
  37.       AddTail and RemoveHead thus implement a MONITOR (See Hoare's paper).
  38.       Single element operations return POSITIONs, non-NULL means it worked.
  39.       whole list operations return a BOOL.  TRUE means it all worked.
  40.       This definition is the same as the POSITION type for MFCs, so we must
  41.       avoid defining it twice.
  42.    */
  43. #ifndef __AFX_H__
  44. struct __POSITION { int unused; };
  45. typedef __POSITION* POSITION;
  46. #endif
  47. const int DEFAULTCACHE = 10;    /* Default node object cache size */
  48. /* A class representing one node in a list.
  49.    Each node knows a pointer to it's adjacent nodes and also a pointer
  50.    to the object that it looks after.
  51.    All of these pointers can be retrieved or set through member functions.
  52. */
  53. class CBaseList 
  54. #ifdef DEBUG
  55.     : public CBaseObject
  56. #endif
  57. {
  58.     /* Making these classes inherit from CBaseObject does nothing
  59.        functionally but it allows us to check there are no memory
  60.        leaks in debug builds. 
  61.     */
  62. public:
  63. #ifdef DEBUG
  64.     class CNode : public CBaseObject {
  65. #else
  66.     class CNode {
  67. #endif
  68.         CNode *m_pPrev;         /* Previous node in the list */
  69.         CNode *m_pNext;         /* Next node in the list */
  70.         void *m_pObject;      /* Pointer to the object */
  71.     public:
  72.         /* Constructor - initialise the object's pointers */
  73.         CNode()
  74. #ifdef DEBUG
  75.             : CBaseObject(NAME("List node"))
  76. #endif
  77.         {
  78.         };
  79.         /* Return the previous node before this one */
  80.         CNode *Prev() const { return m_pPrev; };
  81.         /* Return the next node after this one */
  82.         CNode *Next() const { return m_pNext; };
  83.         /* Set the previous node before this one */
  84.         void SetPrev(CNode *p) { m_pPrev = p; };
  85.         /* Set the next node after this one */
  86.         void SetNext(CNode *p) { m_pNext = p; };
  87.         /* Get the pointer to the object for this node */
  88.         void *GetData() const { return m_pObject; };
  89.         /* Set the pointer to the object for this node */
  90.         void SetData(void *p) { m_pObject = p; };
  91.     };
  92.     class CNodeCache
  93.     {
  94.     public:
  95.         CNodeCache(INT iCacheSize) : m_iCacheSize(iCacheSize),
  96.                                      m_pHead(NULL),
  97.                                      m_iUsed(0)
  98.                                      {};
  99.         ~CNodeCache() {
  100.             CNode *pNode = m_pHead;
  101.             while (pNode) {
  102.                 CNode *pCurrent = pNode;
  103.                 pNode = pNode->Next();
  104.                 delete pCurrent;
  105.             }
  106.         };
  107.         void AddToCache(CNode *pNode)
  108.         {
  109.             if (m_iUsed < m_iCacheSize) {
  110.                 pNode->SetNext(m_pHead);
  111.                 m_pHead = pNode;
  112.                 m_iUsed++;
  113.             } else {
  114.                 delete pNode;
  115.             }
  116.         };
  117.         CNode *RemoveFromCache()
  118.         {
  119.             CNode *pNode = m_pHead;
  120.             if (pNode != NULL) {
  121.                 m_pHead = pNode->Next();
  122.                 m_iUsed--;
  123.                 ASSERT(m_iUsed >= 0);
  124.             } else {
  125.                 ASSERT(m_iUsed == 0);
  126.             }
  127.             return pNode;
  128.         };
  129.     private:
  130.         INT m_iCacheSize;
  131.         INT m_iUsed;
  132.         CNode *m_pHead;
  133.     };
  134. protected:
  135.     CNode* m_pFirst;    /* Pointer to first node in the list */
  136.     CNode* m_pLast;     /* Pointer to the last node in the list */
  137.     LONG m_Count;       /* Number of nodes currently in the list */
  138. private:
  139.     CNodeCache m_Cache; /* Cache of unused node pointers */
  140. private:
  141.     /* These override the default copy constructor and assignment
  142.        operator for all list classes. They are in the private class
  143.        declaration section so that anybody trying to pass a list
  144.        object by value will generate a compile time error of
  145.        "cannot access the private member function". If these were
  146.        not here then the compiler will create default constructors
  147.        and assignment operators which when executed first take a
  148.        copy of all member variables and then during destruction
  149.        delete them all. This must not be done for any heap
  150.        allocated data.
  151.     */
  152.     CBaseList(const CBaseList &refList);
  153.     CBaseList &operator=(const CBaseList &refList);
  154. public:
  155.     CBaseList(TCHAR *pName,
  156.               INT iItems);
  157.     CBaseList(TCHAR *pName);
  158. #ifdef UNICODE
  159.     CBaseList(CHAR *pName,
  160.               INT iItems);
  161.     CBaseList(CHAR *pName);
  162. #endif
  163.     ~CBaseList();
  164.     /* Remove all the nodes from *this i.e. make the list empty */
  165.     void RemoveAll();
  166.     /* Return a cursor which identifies the first element of *this */
  167.     POSITION GetHeadPositionI() const;
  168.     /* Return a cursor which identifies the last element of *this */
  169.     POSITION GetTailPositionI() const;
  170.     /* Return the number of objects in *this */
  171.     int GetCountI() const;
  172. protected:
  173.     /* Return the pointer to the object at rp,
  174.        Update rp to the next node in *this
  175.        but make it NULL if it was at the end of *this.
  176.        This is a wart retained for backwards compatibility.
  177.        GetPrev is not implemented.
  178.        Use Next, Prev and Get separately.
  179.     */
  180.     void *GetNextI(POSITION& rp) const;
  181.     /* Return a pointer to the object at p
  182.        Asking for the object at NULL will return NULL harmlessly.
  183.     */
  184.     void *GetI(POSITION p) const;
  185. public:
  186.     /* return the next / prev position in *this
  187.        return NULL when going past the end/start.
  188.        Next(NULL) is same as GetHeadPosition()
  189.        Prev(NULL) is same as GetTailPosition()
  190.        An n element list therefore behaves like a n+1 element
  191.        cycle with NULL at the start/end.
  192.        !!WARNING!! - This handling of NULL is DIFFERENT from GetNext.
  193.        Some reasons are:
  194.        1. For a list of n items there are n+1 positions to insert
  195.           These are conveniently encoded as the n POSITIONs and NULL.
  196.        2. If you are keeping a list sorted (fairly common) and you
  197.           search forward for an element to insert before and don't
  198.           find it you finish up with NULL as the element before which
  199.           to insert.  You then want that NULL to be a valid POSITION
  200.           so that you can insert before it and you want that insertion
  201.           point to mean the (n+1)-th one that doesn't have a POSITION.
  202.           (symmetrically if you are working backwards through the list).
  203.        3. It simplifies the algebra which the methods generate.
  204.           e.g. AddBefore(p,x) is identical to AddAfter(Prev(p),x)
  205.           in ALL cases.  All the other arguments probably are reflections
  206.           of the algebraic point.
  207.     */
  208.     POSITION Next(POSITION pos) const
  209.     {
  210.         if (pos == NULL) {
  211.             return (POSITION) m_pFirst;
  212.         }
  213.         CNode *pn = (CNode *) pos;
  214.         return (POSITION) pn->Next();
  215.     } //Next
  216.     // See Next
  217.     POSITION Prev(POSITION pos) const
  218.     {
  219.         if (pos == NULL) {
  220.             return (POSITION) m_pLast;
  221.         }
  222.         CNode *pn = (CNode *) pos;
  223.         return (POSITION) pn->Prev();
  224.     } //Prev
  225.     /* Return the first position in *this which holds the given
  226.        pointer.  Return NULL if the pointer was not not found.
  227.     */
  228. protected:
  229.     POSITION FindI( void * pObj) const;
  230.     /* Remove the first node in *this (deletes the pointer to its
  231.        object from the list, does not free the object itself).
  232.        Return the pointer to its object.
  233.        If *this was already empty it will harmlessly return NULL.
  234.     */
  235.     void *RemoveHeadI();
  236.     /* Remove the last node in *this (deletes the pointer to its
  237.        object from the list, does not free the object itself).
  238.        Return the pointer to its object.
  239.        If *this was already empty it will harmlessly return NULL.
  240.     */
  241.     void *RemoveTailI();
  242.     /* Remove the node identified by p from the list (deletes the pointer
  243.        to its object from the list, does not free the object itself).
  244.        Asking to Remove the object at NULL will harmlessly return NULL.
  245.        Return the pointer to the object removed.
  246.     */
  247.     void *RemoveI(POSITION p);
  248.     /* Add single object *pObj to become a new last element of the list.
  249.        Return the new tail position, NULL if it fails.
  250.        If you are adding a COM objects, you might want AddRef it first.
  251.        Other existing POSITIONs in *this are still valid
  252.     */
  253.     POSITION AddTailI(void * pObj);
  254. public:
  255.     /* Add all the elements in *pList to the tail of *this.
  256.        This duplicates all the nodes in *pList (i.e. duplicates
  257.        all its pointers to objects).  It does not duplicate the objects.
  258.        If you are adding a list of pointers to a COM object into the list
  259.        it's a good idea to AddRef them all  it when you AddTail it.
  260.        Return TRUE if it all worked, FALSE if it didn't.
  261.        If it fails some elements may have been added.
  262.        Existing POSITIONs in *this are still valid
  263.        If you actually want to MOVE the elements, use MoveToTail instead.
  264.     */
  265.     BOOL AddTail(CBaseList *pList);
  266.     /* Mirror images of AddHead: */
  267.     /* Add single object to become a new first element of the list.
  268.        Return the new head position, NULL if it fails.
  269.        Existing POSITIONs in *this are still valid
  270.     */
  271. protected:
  272.     POSITION AddHeadI(void * pObj);
  273. public:
  274.     /* Add all the elements in *pList to the head of *this.
  275.        Same warnings apply as for AddTail.
  276.        Return TRUE if it all worked, FALSE if it didn't.
  277.        If it fails some of the objects may have been added.
  278.        If you actually want to MOVE the elements, use MoveToHead instead.
  279.     */
  280.     BOOL AddHead(CBaseList *pList);
  281.     /* Add the object *pObj to *this after position p in *this.
  282.        AddAfter(NULL,x) adds x to the start - equivalent to AddHead
  283.        Return the position of the object added, NULL if it failed.
  284.        Existing POSITIONs in *this are undisturbed, including p.
  285.     */
  286. protected:
  287.     POSITION AddAfterI(POSITION p, void * pObj);
  288. public:
  289.     /* Add the list *pList to *this after position p in *this
  290.        AddAfter(NULL,x) adds x to the start - equivalent to AddHead
  291.        Return TRUE if it all worked, FALSE if it didn't.
  292.        If it fails, some of the objects may be added
  293.        Existing POSITIONs in *this are undisturbed, including p.
  294.     */
  295.     BOOL AddAfter(POSITION p, CBaseList *pList);
  296.     /* Mirror images:
  297.        Add the object *pObj to this-List after position p in *this.
  298.        AddBefore(NULL,x) adds x to the end - equivalent to AddTail
  299.        Return the position of the new object, NULL if it fails
  300.        Existing POSITIONs in *this are undisturbed, including p.
  301.     */
  302.     protected:
  303.     POSITION AddBeforeI(POSITION p, void * pObj);
  304.     public:
  305.     /* Add the list *pList to *this before position p in *this
  306.        AddAfter(NULL,x) adds x to the start - equivalent to AddHead
  307.        Return TRUE if it all worked, FALSE if it didn't.
  308.        If it fails, some of the objects may be added
  309.        Existing POSITIONs in *this are undisturbed, including p.
  310.     */
  311.     BOOL AddBefore(POSITION p, CBaseList *pList);
  312.     /* Note that AddAfter(p,x) is equivalent to AddBefore(Next(p),x)
  313.        even in cases where p is NULL or Next(p) is NULL.
  314.        Similarly for mirror images etc.
  315.        This may make it easier to argue about programs.
  316.     */
  317.     /* The following operations do not copy any elements.
  318.        They move existing blocks of elements around by switching pointers.
  319.        They are fairly efficient for long lists as for short lists.
  320.        (Alas, the Count slows things down).
  321.        They split the list into two parts.
  322.        One part remains as the original list, the other part
  323.        is appended to the second list.  There are eight possible
  324.        variations:
  325.        Split the list {after/before} a given element
  326.        keep the {head/tail} portion in the original list
  327.        append the rest to the {head/tail} of the new list.
  328.        Since After is strictly equivalent to Before Next
  329.        we are not in serious need of the Before/After variants.
  330.        That leaves only four.
  331.        If you are processing a list left to right and dumping
  332.        the bits that you have processed into another list as
  333.        you go, the Tail/Tail variant gives the most natural result.
  334.        If you are processing in reverse order, Head/Head is best.
  335.        By using NULL positions and empty lists judiciously either
  336.        of the other two can be built up in two operations.
  337.        The definition of NULL (see Next/Prev etc) means that
  338.        degenerate cases include
  339.           "move all elements to new list"
  340.           "Split a list into two lists"
  341.           "Concatenate two lists"
  342.           (and quite a few no-ops)
  343.        !!WARNING!! The type checking won't buy you much if you get list
  344.        positions muddled up - e.g. use a POSITION that's in a different
  345.        list and see what a mess you get!
  346.     */
  347.     /* Split *this after position p in *this
  348.        Retain as *this the tail portion of the original *this
  349.        Add the head portion to the tail end of *pList
  350.        Return TRUE if it all worked, FALSE if it didn't.
  351.        e.g.
  352.           foo->MoveToTail(foo->GetHeadPosition(), bar);
  353.               moves one element from the head of foo to the tail of bar
  354.           foo->MoveToTail(NULL, bar);
  355.               is a no-op, returns NULL
  356.           foo->MoveToTail(foo->GetTailPosition, bar);
  357.               concatenates foo onto the end of bar and empties foo.
  358.        A better, except excessively long name might be
  359.            MoveElementsFromHeadThroughPositionToOtherTail
  360.     */
  361.     BOOL MoveToTail(POSITION pos, CBaseList *pList);
  362.     /* Mirror image:
  363.        Split *this before position p in *this.
  364.        Retain in *this the head portion of the original *this
  365.        Add the tail portion to the start (i.e. head) of *pList
  366.        e.g.
  367.           foo->MoveToHead(foo->GetTailPosition(), bar);
  368.               moves one element from the tail of foo to the head of bar
  369.           foo->MoveToHead(NULL, bar);
  370.               is a no-op, returns NULL
  371.           foo->MoveToHead(foo->GetHeadPosition, bar);
  372.               concatenates foo onto the start of bar and empties foo.
  373.     */
  374.     BOOL MoveToHead(POSITION pos, CBaseList *pList);
  375.     /* Reverse the order of the [pointers to] objects in *this
  376.     */
  377.     void Reverse();
  378.     /* set cursor to the position of each element of list in turn  */
  379.     #define TRAVERSELIST(list, cursor)               
  380.     for ( cursor = (list).GetHeadPosition()           
  381.         ; cursor!=NULL                               
  382.         ; cursor = (list).Next(cursor)                
  383.         )
  384.     /* set cursor to the position of each element of list in turn
  385.        in reverse order
  386.     */
  387.     #define REVERSETRAVERSELIST(list, cursor)        
  388.     for ( cursor = (list).GetTailPosition()           
  389.         ; cursor!=NULL                               
  390.         ; cursor = (list).Prev(cursor)                
  391.         )
  392. }; // end of class declaration
  393. template<class OBJECT> class CGenericList : public CBaseList
  394. {
  395. public:
  396.     CGenericList(TCHAR *pName,
  397.                  INT iItems,
  398.                  BOOL bLock = TRUE,
  399.                  BOOL bAlert = FALSE) :
  400.                      CBaseList(pName, iItems) {
  401.         UNREFERENCED_PARAMETER(bAlert);
  402.         UNREFERENCED_PARAMETER(bLock);
  403.     };
  404.     CGenericList(TCHAR *pName) :
  405.                      CBaseList(pName) {
  406.     };
  407.     POSITION GetHeadPosition() const { return (POSITION)m_pFirst; }
  408.     POSITION GetTailPosition() const { return (POSITION)m_pLast; }
  409.     int GetCount() const { return m_Count; }
  410.     OBJECT *GetNext(POSITION& rp) const { return (OBJECT *) GetNextI(rp); }
  411.     OBJECT *Get(POSITION p) const { return (OBJECT *) GetI(p); }
  412.     OBJECT *GetHead() const  { return Get(GetHeadPosition()); }
  413.     OBJECT *RemoveHead() { return (OBJECT *) RemoveHeadI(); }
  414.     OBJECT *RemoveTail() { return (OBJECT *) RemoveTailI(); }
  415.     OBJECT *Remove(POSITION p) { return (OBJECT *) RemoveI(p); }
  416.     POSITION AddBefore(POSITION p, OBJECT * pObj) { return AddBeforeI(p, pObj); }
  417.     POSITION AddAfter(POSITION p, OBJECT * pObj)  { return AddAfterI(p, pObj); }
  418.     POSITION AddHead(OBJECT * pObj) { return AddHeadI(pObj); }
  419.     POSITION AddTail(OBJECT * pObj)  { return AddTailI(pObj); }
  420.     BOOL AddTail(CGenericList<OBJECT> *pList)
  421.             { return CBaseList::AddTail((CBaseList *) pList); }
  422.     BOOL AddHead(CGenericList<OBJECT> *pList)
  423.             { return CBaseList::AddHead((CBaseList *) pList); }
  424.     BOOL AddAfter(POSITION p, CGenericList<OBJECT> *pList)
  425.             { return CBaseList::AddAfter(p, (CBaseList *) pList); };
  426.     BOOL AddBefore(POSITION p, CGenericList<OBJECT> *pList)
  427.             { return CBaseList::AddBefore(p, (CBaseList *) pList); };
  428.     POSITION Find( OBJECT * pObj) const { return FindI(pObj); }
  429. }; // end of class declaration
  430. /* These define the standard list types */
  431. typedef CGenericList<CBaseObject> CBaseObjectList;
  432. typedef CGenericList<IUnknown> CBaseInterfaceList;
  433. #endif /* __WXLIST__ */