Opt: Documented opt and its interaction with conf

[libucw.git] / ucw / clists.h

diff --git a/ucw/clists.h b/ucw/clists.h
index 2be40881854318db27e49497643ed69d9ee6c7ba..7148ff1fb3ea0d36b2971f6297ce21c5e807d665 100644 (file)
--- a/ucw/clists.h
+++ b/ucw/clists.h
@@ -1,7 +1,7 @@
 /*
  *     UCW Library -- Circular Linked Lists
  *
- *     (c) 2003--2007 Martin Mares <mj@ucw.cz>
+ *     (c) 2003--2010 Martin Mares <mj@ucw.cz>
  *
  *     This software may be freely distributed and used according to the terms
  *     of the GNU Lesser General Public License.
@@ -18,7 +18,7 @@ typedef struct cnode {
 } cnode;
 
 /**
- * Circilar linked list.
+ * Circular doubly linked list.
  **/
 typedef struct clist {
   struct cnode head;
@@ -151,7 +151,7 @@ static inline void clist_remove(cnode *n)
 }
 
 /**
- * Remove the first node in @l. The list can be empty.
+ * Remove the first node in @l, if it exists. Return the pointer to that node or NULL.
  **/
 static inline void *clist_remove_head(clist *l)
 {
@@ -162,7 +162,7 @@ static inline void *clist_remove_head(clist *l)
 }
 
 /**
- * Remove the last node in @l. The list can be empty.
+ * Remove the last node in @l, if it exists. Return the pointer to that node or NULL.
  **/
 static inline void *clist_remove_tail(clist *l)
 {
@@ -190,7 +190,18 @@ static inline void clist_insert_list_after(clist *what, cnode *after)
 }
 
 /**
- * Compute the number of nodes in @l. Beware linear time complexity.
+ * Move all items from a source list to a destination list. The source list
+ * becomes empty, the original contents of the destination list are destroyed.
+ **/
+static inline void clist_move(clist *to, clist *from)
+{
+  clist_init(to);
+  clist_insert_list_after(from, &to->head);
+  clist_init(from);
+}
+
+/**
+ * Compute the number of nodes in @l. Beware of linear time complexity.
  **/
 static inline uns clist_size(clist *l)
 {
@@ -200,4 +211,50 @@ static inline uns clist_size(clist *l)
   return i;
 }
 
+/**
+ * Remove a node @n and mark it as unlinked by setting the previous and next pointers to NULL.
+ **/
+static inline void clist_unlink(cnode *n)
+{
+  clist_remove(n);
+  n->prev = n->next = NULL;
+}
+
+/**
+ * Remove the first node on @l and mark it as unlinked.
+ * Return the pointer to that node or NULL.
+ **/
+static inline void *clist_unlink_head(clist *l)
+{
+  cnode *n = clist_head(l);
+  if (n)
+    clist_unlink(n);
+  return n;
+}
+
+/**
+ * Remove the last node on @l and mark it as unlinked.
+ * Return the pointer to that node or NULL.
+ **/
+static inline void *clist_unlink_tail(clist *l)
+{
+  cnode *n = clist_tail(l);
+  if (n)
+    clist_unlink(n);
+  return n;
+}
+
+/**
+ * Check if a node is linked a list. Unlinked nodes are recognized by having their
+ * previous and next pointers equal to NULL. Returns 0 or 1.
+ *
+ * Nodes initialized to all zeroes are unlinked, inserting a node anywhere in a list
+ * makes it linked. Normal removal functions like clist_remove() do not mark nodes
+ * as unlinked, you need to call clist_unlink() instead.
+ **/
+static inline int clist_is_linked(cnode *n)
+{
+  return !!n->next;
+}
+
 #endif