#ifndef CCAN_LIST_H
#define CCAN_LIST_H
#include <stdbool.h>
-#include "container_of/container_of.h"
+#include <ccan/container_of/container_of.h>
/**
* struct list_node - an entry in a doubly-linked list
};
/**
- * list_check - check a list for consistency
+ * list_check - check head of a list for consistency
* @h: the list_head
* @abortstr: the location to print on aborting, or NULL.
*
* Returns the list head if the list is consistent, NULL if not (it
* can never return NULL if @abortstr is set).
*
+ * See also: list_check_node()
+ *
* Example:
* static void dump_parent(struct parent *p)
* {
* struct child *c;
*
- * printf("%s (%u children):\n", p->name, parent->num_children);
+ * printf("%s (%u children):\n", p->name, p->num_children);
* list_check(&p->children, "bad child list");
* list_for_each(&p->children, c, list)
* printf(" -> %s\n", c->name);
* }
*/
-struct list_head *list_check(struct list_head *h, const char *abortstr);
+struct list_head *list_check(const struct list_head *h, const char *abortstr);
+
+/**
+ * list_check_node - check node of a list for consistency
+ * @n: the list_node
+ * @abortstr: the location to print on aborting, or NULL.
+ *
+ * Check consistency of the list node is in (it must be in one).
+ *
+ * See also: list_check()
+ *
+ * Example:
+ * static void dump_child(const struct child *c)
+ * {
+ * list_check_node(&c->list, "bad child list");
+ * printf("%s\n", c->name);
+ * }
+ */
+struct list_node *list_check_node(const struct list_node *n,
+ const char *abortstr);
#ifdef CCAN_LIST_DEBUG
#define debug_list(h) list_check((h), __func__)
#define debug_list(h) (h)
#endif
+/**
+ * LIST_HEAD - define and initalize an empty list_head
+ * @name: the name of the list.
+ *
+ * The LIST_HEAD macro defines a list_head and initializes it to an empty
+ * list. It can be prepended by "static" to define a static list_head.
+ *
+ * Example:
+ * static LIST_HEAD(my_global_list);
+ */
+#define LIST_HEAD(name) \
+ struct list_head name = { { &name.n, &name.n } }
+
/**
* list_head_init - initialize a list_head
* @h: the list_head to set to the empty list
*
* Example:
+ * ...
+ * struct parent *parent = malloc(sizeof(*parent));
+ *
* list_head_init(&parent->children);
* parent->num_children = 0;
*/
h->n.next = h->n.prev = &h->n;
}
-/**
- * LIST_HEAD - define and initalized empty list_head
- * @name: the name of the list.
- *
- * The LIST_HEAD macro defines a list_head and initializes it to an empty
- * list. It can be prepended by "static" to define a static list_head.
- *
- * Example:
- * // Header:
- * extern struct list_head my_list;
- *
- * // C file:
- * LIST_HEAD(my_list);
- */
-#define LIST_HEAD(name) \
- struct list_head name = { { &name.n, &name.n } }
-
/**
* list_add - add an entry at the start of a linked list.
* @h: the list_head to add the node to
*
* The list_node does not need to be initialized; it will be overwritten.
* Example:
+ * struct child *child = malloc(sizeof(*child));
+ *
+ * child->name = "marvin";
* list_add(&parent->children, &child->list);
* parent->num_children++;
*/
* Example:
* assert(list_empty(&parent->children) == (parent->num_children == 0));
*/
-static inline bool list_empty(struct list_head *h)
+static inline bool list_empty(const struct list_head *h)
{
(void)debug_list(h);
return h->n.next == &h->n;
* @member: the list_node member of the type
*
* Example:
- * struct child *c;
* // First list entry is children.next; convert back to child.
- * c = list_entry(parent->children.next, struct child, list);
+ * child = list_entry(parent->children.n.next, struct child, list);
+ *
+ * See Also:
+ * list_top(), list_for_each()
*/
#define list_entry(n, type, member) container_of(n, type, member)
* first = list_top(&parent->children, struct child, list);
*/
#define list_top(h, type, member) \
- list_entry(_list_top(h), type, member)
+ (list_empty(h) ? NULL : list_entry((h)->n.next, type, member))
-static inline struct list_node *_list_top(struct list_head *h)
-{
- (void)debug_list(h);
- if (list_empty(h))
- return NULL;
- return h->n.next;
-}
+/**
+ * list_tail - get the last entry in a list
+ * @h: the list_head
+ * @type: the type of the entry
+ * @member: the list_node member of the type
+ *
+ * If the list is empty, returns NULL.
+ *
+ * Example:
+ * struct child *last;
+ * last = list_tail(&parent->children, struct child, list);
+ */
+#define list_tail(h, type, member) \
+ (list_empty(h) ? NULL : list_entry((h)->n.prev, type, member))
/**
* list_for_each - iterate through a list.
* a for loop, so you can break and continue as normal.
*
* Example:
- * struct child *c;
- * list_for_each(&parent->children, c, list)
- * printf("Name: %s\n", c->name);
+ * list_for_each(&parent->children, child, list)
+ * printf("Name: %s\n", child->name);
*/
#define list_for_each(h, i, member) \
for (i = container_of_var(debug_list(h)->n.next, i, member); \
* @nxt is used to hold the next element, so you can delete @i from the list.
*
* Example:
- * struct child *c, *n;
- * list_for_each_safe(&parent->children, c, n, list) {
- * list_del(&c->list);
+ * struct child *next;
+ * list_for_each_safe(&parent->children, child, next, list) {
+ * list_del(&child->list);
* parent->num_children--;
* }
*/
projects / ccan / blobdiff