Changes in kernel/generic/include/adt/list.h [7856d09:1023758] in mainline

File:

• kernel/generic/include/adt/list.h (modified) (6 diffs)

kernel/generic/include/adt/list.h

@@ -52 +52 @@
 } list_t;
 
+
+extern bool list_member(const link_t *, const list_t *);
+extern void list_splice(list_t *, link_t *);
+extern unsigned long list_count(const list_t *);
+
+
 /** Declare and initialize statically allocated list.
  *
@@ -70 +76 @@
 #define list_foreach(list, member, itype, iterator) \
         for (itype *iterator = NULL; iterator == NULL; iterator = (itype *) 1) \
-            for (link_t *_link = (list).head.next; \
-            iterator = list_get_instance(_link, itype, member), \
-            _link != &(list).head; _link = _link->next)
+                for (link_t *_link = (list).head.next; \
+                    iterator = list_get_instance(_link, itype, member), \
+                    _link != &(list).head; _link = _link->next)
 
 #define list_foreach_rev(list, member, itype, iterator) \
         for (itype *iterator = NULL; iterator == NULL; iterator = (itype *) 1) \
-            for (link_t *_link = (list).head.prev; \
-            iterator = list_get_instance(_link, itype, member), \
-            _link != &(list).head; _link = _link->prev)
-
+                for (link_t *_link = (list).head.prev; \
+                    iterator = list_get_instance(_link, itype, member), \
+                    _link != &(list).head; _link = _link->prev)
+
+/** Unlike list_foreach(), allows removing items while traversing a list.
+ * 
+ * @code
+ * list_t mylist;
+ * typedef struct item {
+ *     int value;
+ *     link_t item_link;
+ * } item_t;
+ * 
+ * //..
+ * 
+ * // Print each list element's value and remove the element from the list.
+ * list_foreach_safe(mylist, cur_link, next_link) {
+ *     item_t *cur_item = list_get_instance(cur_link, item_t, item_link);
+ *     printf("%d\n", cur_item->value);
+ *     list_remove(cur_link);
+ * }
+ * @endcode
+ * 
+ * @param list List to traverse.
+ * @param iterator Iterator to the current element of the list.
+ *             The item this iterator points may be safely removed
+ *             from the list.
+ * @param next_iter Iterator to the next element of the list.
+ */
+#define list_foreach_safe(list, iterator, next_iter) \
+        for (link_t *iterator = (list).head.next, \
+            *next_iter = iterator->next; \
+            iterator != &(list).head; \
+            iterator = next_iter, next_iter = iterator->next)
+
+        
 #define assert_link_not_used(link) \
         ASSERT(!link_used(link))
@@ -182 +220 @@
  *
  */
-NO_TRACE static inline int list_empty(const list_t *list)
+NO_TRACE static inline bool list_empty(const list_t *list)
 {
         return (list->head.next == &list->head);
@@ -291 +329 @@
 }
 
+/** Concatenate two lists
+ *
+ * Concatenate lists @a list1 and @a list2, producing a single
+ * list @a list1 containing items from both (in @a list1, @a list2
+ * order) and empty list @a list2.
+ *
+ * @param list1         First list and concatenated output
+ * @param list2         Second list and empty output.
+ *
+ */
+NO_TRACE static inline void list_concat(list_t *list1, list_t *list2)
+{
+        list_splice(list2, list1->head.prev);
+}
+
 /** Get n-th item in a list.
  *
@@ -300 +353 @@
  *
  */
-static inline link_t *list_nth(list_t *list, unsigned int n)
-{
-        unsigned int cnt = 0;
+static inline link_t *list_nth(list_t *list, unsigned long n)
+{
+        unsigned long cnt = 0;
         link_t *link;
         
@@ -340 +393 @@
 }
 
-extern int list_member(const link_t *, const list_t *);
-extern void list_concat(list_t *, list_t *);
-extern unsigned int list_count(const list_t *);
-
 #endif