reformat the avl library
[olsrd.git] / src / common / list.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.de)
4  * IPv4 performance optimization (c) 2006, sven-ola(gmx.de)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without 
8  * modification, are permitted provided that the following conditions 
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright 
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright 
14  *   notice, this list of conditions and the following disclaimer in 
15  *   the documentation and/or other materials provided with the 
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its 
18  *   contributors may be used to endorse or promote products derived 
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef _LIST_H
43 #define _LIST_H
44
45 #include "stddef.h"
46
47 struct list_node
48 {
49   struct list_node *next;
50   struct list_node *prev;
51   void *data;
52 };
53
54 void list_head_init(struct list_node *);
55 void list_node_init(struct list_node *);
56 int list_node_on_list(struct list_node *);
57 int list_is_empty(struct list_node *);
58
59 void list_add_before(struct list_node *, struct list_node *);
60 void list_add_after(struct list_node *, struct list_node *);
61
62 void list_remove(struct list_node *);
63
64 /*
65  * Macro to define an inline function to map from a list_node offset back to the
66  * base of the datastructure. This saves you from populating the data field.
67  */
68 #define LISTNODE2STRUCT(funcname, structname, listnodename) \
69 static inline structname * funcname (struct list_node *ptr)\
70 {\
71   return( \
72     ptr ? \
73       (structname *) (((olsr_u8_t *) ptr) - offsetof(structname, listnodename)) : \
74       NULL); \
75 }
76
77 #endif /* _LQ_LIST */