Some more crypto wrapper functions are needed.
[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
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20     $Id$
21 */
22
23 #ifndef __TINC_LIST_H__
24 #define __TINC_LIST_H__
25
26 typedef struct list_node_t {
27         struct list_node_t *prev;
28         struct list_node_t *next;
29
30         /* Payload */
31
32         void *data;
33 } list_node_t;
34
35 typedef void (*list_action_t)(const void *);
36 typedef void (*list_action_node_t)(const list_node_t *);
37
38 typedef struct list_t {
39         list_node_t *head;
40         list_node_t *tail;
41         int count;
42
43         /* Callbacks */
44
45         list_action_t delete;
46 } list_t;
47
48 /* (De)constructors */
49
50 extern list_t *list_alloc(list_action_t) __attribute__ ((__malloc__));
51 extern void list_free(list_t *);
52 extern list_node_t *list_alloc_node(void);
53 extern void list_free_node(list_t *, list_node_t *);
54
55 /* Insertion and deletion */
56
57 extern list_node_t *list_insert_head(list_t *, void *);
58 extern list_node_t *list_insert_tail(list_t *, void *);
59
60 extern void list_unlink_node(list_t *, list_node_t *);
61 extern void list_delete_node(list_t *, list_node_t *);
62
63 extern void list_delete_head(list_t *);
64 extern void list_delete_tail(list_t *);
65
66 /* Head/tail lookup */
67
68 extern void *list_get_head(list_t *);
69 extern void *list_get_tail(list_t *);
70
71 /* Fast list deletion */
72
73 extern void list_delete_list(list_t *);
74
75 /* Traversing */
76
77 extern void list_foreach(list_t *, list_action_t);
78 extern void list_foreach_node(list_t *, list_action_node_t);
79
80 #endif                                                  /* __TINC_LIST_H__ */