Ensure all parameters have names in header files.

[tinc] / src / list.h

diff --git a/src/list.h b/src/list.h
index 0437bd9..3806495 100644 (file)
--- a/src/list.h
+++ b/src/list.h
@@ -1,3 +1,6 @@
+#ifndef TINC_LIST_H
+#define TINC_LIST_H
+
 /*
     list.h -- header file for list.c
     Copyright (C) 2000-2005 Ivo Timmermans
@@ -18,9 +21,6 @@
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef __TINC_LIST_H__
-#define __TINC_LIST_H__
-
 typedef struct list_node_t {
        struct list_node_t *prev;
        struct list_node_t *next;
@@ -30,8 +30,8 @@ typedef struct list_node_t {
        void *data;
 } list_node_t;
 
-typedef void (*list_action_t)(const void *);
-typedef void (*list_action_node_t)(const list_node_t *);
+typedef void (*list_action_t)(const void *data);
+typedef void (*list_action_node_t)(const list_node_t *node);
 
 typedef struct list_t {
        list_node_t *head;
@@ -45,40 +45,46 @@ typedef struct list_t {
 
 /* (De)constructors */
 
-extern list_t *list_alloc(list_action_t) __attribute__ ((__malloc__));
-extern void list_free(list_t *);
+extern list_t *list_alloc(list_action_t delete) __attribute__((__malloc__));
+extern void list_free(list_t *list);
 extern list_node_t *list_alloc_node(void);
-extern void list_free_node(list_t *, list_node_t *);
+extern void list_free_node(list_t *list, list_node_t *node);
 
 /* Insertion and deletion */
 
-extern list_node_t *list_insert_head(list_t *, void *);
-extern list_node_t *list_insert_tail(list_t *, void *);
-extern list_node_t *list_insert_after(list_t *, list_node_t *, void *);
-extern list_node_t *list_insert_before(list_t *, list_node_t *, void *);
+extern list_node_t *list_insert_head(list_t *list, void *data);
+extern list_node_t *list_insert_tail(list_t *list, void *data);
+extern list_node_t *list_insert_after(list_t *list, list_node_t *node, void *data);
+extern list_node_t *list_insert_before(list_t *list, list_node_t *node, void *data);
 
-extern void list_delete(list_t *, const void *);
+extern void list_delete(list_t *list, const void *data);
 
-extern void list_unlink_node(list_t *, list_node_t *);
-extern void list_delete_node(list_t *, list_node_t *);
+extern void list_unlink_node(list_t *list, list_node_t *node);
+extern void list_delete_node(list_t *list, list_node_t *node);
 
-extern void list_delete_head(list_t *);
-extern void list_delete_tail(list_t *);
+extern void list_delete_head(list_t *list);
+extern void list_delete_tail(list_t *list);
 
 /* Head/tail lookup */
 
-extern void *list_get_head(list_t *);
-extern void *list_get_tail(list_t *);
+extern void *list_get_head(list_t *list);
+extern void *list_get_tail(list_t *list);
 
 /* Fast list deletion */
 
-extern void list_delete_list(list_t *);
+extern void list_delete_list(list_t *list);
 
 /* Traversing */
 
-extern void list_foreach(list_t *, list_action_t);
-extern void list_foreach_node(list_t *, list_action_node_t);
+extern void list_foreach(list_t *list, list_action_t action);
+extern void list_foreach_node(list_t *list, list_action_node_t action);
+
+/*
+   Iterates over a list.
 
+   CAUTION: while this construct supports deleting the current item,
+   it does *not* support deleting *other* nodes while iterating on the list.
+ */
 #define list_each(type, item, list) (type *item = (type *)1; item; item = NULL) for(list_node_t *node = (list)->head, *next; item = node ? node->data : NULL, next = node ? node->next : NULL, node; node = next)
 
-#endif /* __TINC_LIST_H__ */
+#endif