Changeset 18825

Timestamp:

Jul 31, 2008, 1:41:04 PM (18 years ago)

Author:

eugene

Message:

added psListGetAndRemove function

Location:

trunk/psLib/src/types

Files:

• psList.c (modified) (3 diffs)
• psList.h (modified) (2 diffs)

trunk/psLib/src/types/psList.c

@@ -7 +7 @@
  *  @author Joshua Hoblitt, University of Hawaii
  *
- *  @version $Revision: 1.69 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2008-05-05 00:09:04 $
+ *  @version $Revision: 1.70 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2008-07-31 23:41:04 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -437 +437 @@
     PS_ASSERT_LIST_NON_NULL(list, NULL);
 
+    // XXX this should not be an error, right?
     if (list->head == NULL) { // list empty?
         psError(PS_ERR_BAD_PARAMETER_NULL, true,
@@ -453 +454 @@
 
     return iterator->cursor->data;
+}
+
+// simultaneous get and remove (ie, 'pop')
+psPtr psListGetAndRemove (psList *list, long location) {
+
+    PS_ASSERT_LIST_NON_NULL(list, NULL);
+
+    // empty list : 
+    // XXX handle this explicitly since psListGet raises an error in this case
+    if (list->head == NULL) return NULL;
+
+    psPtr *item = psListGet (list, location);
+
+    psListRemove (list, location);
+    return item;
 }
 

trunk/psLib/src/types/psList.h

@@ -5 +5 @@
  *  @author Robert Daniel DeSonia, MHPCC
  *
- *  @version $Revision: 1.46 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-08-09 01:40:08 $
+ *  @version $Revision: 1.47 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2008-07-31 23:41:04 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -208 +208 @@
 );
 
+/** Retrieve an item from a list.
+ *
+ *  @return psPtr       the item corresponding to the location parameter.  If
+ *                      location is invalid (e.g., a numbered index greater
+ *                      than the list size or if the list is empty), a
+ *                      NULL is returned.
+ */
+psPtr psListGetAndRemove (
+    psList *list,                       ///< list from which to get and remove the element
+    long location                       ///< index of item
+);
 
 /** Position the specified iterator to the next item in list.