Add the Forwarding option.
[tinc] / lib / list.h
1 /*
2     list.h -- header file for list.c
3     Copyright (C) 2000-2005 Ivo Timmermans
4                   2000-2006 Guus Sliepen <guus@tinc-vpn.org>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License along
17     with this program; if not, write to the Free Software Foundation, Inc.,
18     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #ifndef __TINC_LIST_H__
22 #define __TINC_LIST_H__
23
24 typedef struct list_node_t {
25         struct list_node_t *prev;
26         struct list_node_t *next;
27
28         /* Payload */
29
30         void *data;
31 } list_node_t;
32
33 typedef void (*list_action_t)(const void *);
34 typedef void (*list_action_node_t)(const list_node_t *);
35
36 typedef struct list_t {
37         list_node_t *head;
38         list_node_t *tail;
39         int count;
40
41         /* Callbacks */
42
43         list_action_t delete;
44 } list_t;
45
46 /* (De)constructors */
47
48 extern list_t *list_alloc(list_action_t) __attribute__ ((__malloc__));
49 extern void list_free(list_t *);
50 extern list_node_t *list_alloc_node(void);
51 extern void list_free_node(list_t *, list_node_t *);
52
53 /* Insertion and deletion */
54
55 extern list_node_t *list_insert_head(list_t *, void *);
56 extern list_node_t *list_insert_tail(list_t *, void *);
57
58 extern void list_unlink_node(list_t *, list_node_t *);
59 extern void list_delete_node(list_t *, list_node_t *);
60
61 extern void list_delete_head(list_t *);
62 extern void list_delete_tail(list_t *);
63
64 /* Head/tail lookup */
65
66 extern void *list_get_head(list_t *);
67 extern void *list_get_tail(list_t *);
68
69 /* Fast list deletion */
70
71 extern void list_delete_list(list_t *);
72
73 /* Traversing */
74
75 extern void list_foreach(list_t *, list_action_t);
76 extern void list_foreach_node(list_t *, list_action_node_t);
77
78 #endif                                                  /* __TINC_LIST_H__ */