Changeset 454 for trunk/psLib/src/sysUtils/psDList.h

Timestamp:

Apr 19, 2004, 11:01:12 AM (22 years ago)

Author:

desonia

Message:

from IP3

File:

• trunk/psLib/src/sysUtils/psDList.h (modified) (1 diff)

trunk/psLib/src/sysUtils/psDList.h

@@ -1 @@
-//
-// C++ Interface: psDList
-//
-// Description:
-//
-//
-// Author: Robert DeSonia <robert.desonia@mhpcc.hpc.mil>, (C) 2004
-//
-// Copyright: See COPYING file that comes with this distribution
-//
-//
+#if !defined(PS_DLIST_H)
+#define PS_DLIST_H
+
+/** \file psDlist.h
+ *  \brief Support for doubly linked lists
+ *  \ingroup DataGroup
+ */
+
+/** Doubly-linked list element */
+typedef struct psDlistElem
+{
+    struct psDlistElem *prev;  ///< previous link in list
+    struct psDlistElem *next;  ///< next link in list
+    void *data;    ///< real data item
+}
+psDlistElem;
+
+/** Doubly-linked list */
+typedef struct
+{
+    int n;    ///< number of elements on list
+    psDlistElem *head;   ///< first element on list (may be NULL)
+    psDlistElem *tail;   ///< last element on list (may be NULL)
+    psDlistElem *iter;   ///< iteration cursor
+}
+psDlist;
+
+/** Special values of index into list */
+enum {
+    PS_DLIST_HEAD = 0,   ///< at head
+    PS_DLIST_TAIL = -1,   ///< at tail
+    PS_DLIST_UNKNOWN = -2,  ///< unknown position
+    PS_DLIST_PREV = -3,   ///< previous element
+    PS_DLIST_NEXT = -4   ///< next element
+};
+
+/** Functions **************************************************************/
+/** \addtogroup DataGroup General Data Container Utilities
+ *  \{
+ */
+
+/** Constructor */
+psDlist *psDlistAlloc(void *data) ///< initial data item; may be NULL
+;
+
+/** Destructor */
+void psDlistFree(psDlist *list,  ///< list to destroy
+                 void (*elemFree)(void *)) ///< destructor for data on list
+;
+
+/**** List maintainence functions ****/
+
+/** Add to list */
+psDlist *psDlistAdd(psDlist *list, ///< list to add to (may be NULL)
+                    void *data,  ///< data item to add
+                    int where)  ///< index, PS_DLIST_HEAD, or PS_DLIST_TAIL
+;
+
+/** Append to a list */
+psDlist *psDlistAppend(psDlist *list, ///< list to append to (may be NULL)
+                       void *data) ///< data item to add
+;
+
+/** Remove from a list */
+void *psDlistRemove(psDlist *list, ///< list to remove element from
+                    void *data,  ///< data item to remove
+                    int which)  ///< index of item, or PS_DLIST_UNKNOWN, PS_DLIST_NEXT, PS_DLIST_PREV
+;
+
+/** Retrieve from a list */
+void *psDlistGet(const psDlist *list, ///< list to retrieve element from
+                 int which)  ///< index of item, or PS_DLIST_NEXT, PS_DLIST_PREV, PS_DLIST_UNKNOWN
+;
+
+/** Set the iterator */
+void psDlistSetIterator(psDlist *list, ///< list to retrieve element from
+                        int where) ///< index, PS_DLIST_HEAD, or PS_DLIST_TAIL
+;
+
+/** Get next element relative to iter */
+void *psDlistGetNext(psDlist *list) ///< list to retrieve element from
+;
+
+/** Get prev element relative to iter */
+void *psDlistGetPrev(psDlist *list) ///< list to retrieve element from
+;
+
+/** Convert doubly-linked list to an array */
+psVoidPtrArray *psDlistToArray(psDlist *dlist) ///< List to convert
+;
+
+/** Convert array to a doubly-linked list */
+psDlist *psArrayToDlist(psVoidPtrArray *arr) ///< Array to convert
+;
+
+/* \} */ // End of DataGroup Functions
+
+#endif