chiark / gitweb /
[PATCH] The following patch fixes some warnings when compiling volume_id
[elogind.git] / libsysfs / sysfs / dlist.h
1 /*
2  * dlist.h
3  *
4  * Copyright (C) 2003 Eric J Bohm
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Lesser General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2.1 of the License, or (at your option) any later version.
10  *
11  *  This library 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 GNU
14  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  */
21 #ifndef _DLIST_H_
22 #define _DLIST_H_
23
24 /* Double linked list header.
25    
26 * navigate your list with DLIST_PREV and DLIST_NEXT.  These are macros
27 * so function call overhead is minimized.
28
29 * Supports perl style push, pop, shift, unshift list semantics.
30
31 * You allocate the data and give dlist the pointer.  If your data is
32 * complex set the dlist->del_func to a an appropriate delete using
33 * dlist_new_with_delete.  Your delete function must match 
34 (void * )(del(void *)
35 *Otherwise dlist will just use free.
36
37 * NOTE: The small amount of pain involved in doing that allows us to
38 * avoid copy in copy out semantics.
39
40 * Dlist uses an internal mark pointer to keep track of where you are
41 * in the list.
42
43 * insert and delete take a directional parameter. Where direction
44 * corresponds to the direction in which you want the list to go.
45 * true direction corresponded to progressing forward in the last
46 * false to regressing in the list.
47 * so a dlist_insert(yourlist,item,1) will insert it after the mark
48 * so a dlist_insert(yourlist,item,0) will insert it before the mark
49 * any insert will move the mark to the new node regardless of the direction.
50
51 * Just use the dlist_(insert|delete)_(before|after) macros if you do not want
52 * to think about it.
53 */
54
55 #include <stddef.h>
56
57 typedef struct dl_node {
58   struct dl_node *prev;
59   struct dl_node *next;
60   void *data;
61 } DL_node;
62
63 typedef struct dlist {
64   DL_node *marker;
65   unsigned long count;
66   size_t data_size;
67   void (*del_func)(void *);
68   DL_node headnode;
69   DL_node *head;
70 } Dlist;
71
72 Dlist *dlist_new(size_t datasize);
73 Dlist *dlist_new_with_delete(size_t datasize,void (*del_func)(void*));
74 void *_dlist_mark_move(Dlist *list,int direction);
75 void *dlist_mark(Dlist *);
76 void dlist_start(Dlist *);
77 void dlist_end(Dlist *);
78 void dlist_move(struct dlist *source, struct dlist *dest, struct dl_node *target,int direction);
79 void *dlist_insert(Dlist *,void *,int) ;
80
81 void *dlist_insert_sorted(struct dlist *list, void *new_elem, int (*sorter)(void *, void *));
82
83 void dlist_delete(Dlist *,int);
84
85 void dlist_push(Dlist *,void *);
86
87 void dlist_unshift(Dlist *,void *);
88 void dlist_unshift_sorted(Dlist *,void *,int (*sorter)(void *, void *));
89
90 void *dlist_pop(Dlist *);
91
92 void *dlist_shift(Dlist *);
93
94 void dlist_destroy(Dlist *);
95
96 int _dlist_merge(struct dlist *listsource, struct dlist *listdest, unsigned int passcount, int (*compare)(void *, void *));
97
98 void *dlist_find_custom(struct dlist *list, void *target, int (*comp)(void *, void *));
99
100 void dlist_sort_custom(struct dlist *list, int (*compare)(void *, void *));
101
102
103 void _dlist_swap(struct dlist *list, struct dl_node *a, struct dl_node *b);
104
105 void dlist_transform(struct dlist *list, void (*node_operation)(void *));
106
107
108 /* 
109  * _dlist_remove is for internal use only
110  * _dlist_mark_move is for internal use only
111  */
112 void *_dlist_remove(struct dlist *,struct dl_node *,int );
113 void *_dlist_insert_dlnode(struct dlist *list,struct dl_node *new_node,int direction);
114
115 #define dlist_prev(A) _dlist_mark_move((A),0)
116 #define dlist_next(A) _dlist_mark_move((A),1)
117
118 #define dlist_insert_before(A,B) dlist_insert((A),(B),0)
119 #define dlist_insert_after(A,B) dlist_insert((A),(B),1)
120
121 #define dlist_delete_before(A) dlist_delete((A),0)
122 #define dlist_delete_after(A) dlist_delete((A),1)
123
124 /**
125  * provide for loop header which iterates the mark from start to end
126  * list: the dlist pointer, use dlist_mark(list) to get iterator
127  */
128 #define dlist_for_each(list) \
129         for(dlist_start(list),dlist_next(list); \
130                 (list)->marker!=(list)->head;dlist_next(list))
131
132 /**
133  * provide for loop header which iterates the mark from end to start
134  * list: the dlist pointer, use dlist_mark(list) to get iterator
135  */
136 #define dlist_for_each_rev(list) \
137         for(dlist_end(list),dlist_prev(list); \
138                 (list)->marker!=(list)->head;dlist_prev(list))
139
140 /**
141  * provide for loop header which iterates through the list without moving mark
142  * list: the dlist_pointer
143  * iterator: dl_node pointer to iterate
144  */
145 #define dlist_for_each_nomark(list,iterator) \
146         for((iterator)=(list)->head->next; (iterator)!=(list)->head; \
147                 (iterator)=(iterator)->next)
148
149 /**
150  * provide for loop header which iterates through the list without moving mark
151  * in reverse
152  * list: the dlist_pointer
153  * iterator: dl_node pointer to iterate
154  */
155 #define dlist_for_each_nomark_rev(list,iterator) \
156         for((iterator)=(list)->head->prev; (iterator)!=(list)->head; \
157                 (iterator)=(iterator)->prev)
158 /**
159  * provide for loop header which iterates through the list providing a
160  * data iterator
161  * list: the dlist pointer
162  * data_iterator: the pointer of type datatype to iterate
163  * datatype:  actual type of the contents in the dl_node->data
164  */
165
166 #define dlist_for_each_data(list,data_iterator,datatype) \
167         for(dlist_start(list), (data_iterator)=(datatype *) dlist_next(list); \
168         (list)->marker!=(list)->head;(data_iterator)=(datatype *) dlist_next(list))
169
170 /**
171  * provide for loop header which iterates through the list providing a
172  * data iterator in reverse
173  * list: the dlist pointer
174  * data_iterator: the pointer of type datatype to iterate
175  * datatype:  actual type of the contents in the dl_node->data
176  */
177 #define dlist_for_each_data_rev(list,data_iterator,datatype) \
178         for(dlist_end(list), (data_iterator)=(datatype *) dlist_prev(list); \
179         (list)->marker!=(list)->head;(data_iterator)=(datatype *) dlist_prev(list))
180
181 /**
182  * provide for loop header which iterates through the list providing a
183  * data iterator without moving the mark
184  * list: the dlist pointer
185  * iterator: the dl_node pointer to iterate
186  * data_iterator: the pointer of type datatype to iterate
187  * datatype:  actual type of the contents in the dl_node->data
188  */
189
190 #define dlist_for_each_data_nomark(list,iterator,data_iterator,datatype) \
191         for((iterator)=(list)->head->next, (data_iterator)=(datatype *) (iterator)->data; \
192         (iterator)!=(list)->head;(iterator)=(iterator)->next,(data_iterator)=(datatype *) (iterator))
193
194 /**
195  * provide for loop header which iterates through the list providing a
196  * data iterator in reverse without moving the mark
197  * list: the dlist pointer
198  * iterator: the dl_node pointer to iterate
199  * data_iterator: the pointer of type datatype to iterate
200  * datatype:  actual type of the contents in the dl_node->data
201  */
202 #define dlist_for_each_data_nomark_rev(list,iterator, data_iterator,datatype) \
203         for((iterator)=(list)->head->prev, (data_iterator)=(datatype *) (iterator)->data; \
204         (iterator)!=(list)->head;(iterator)=(iterator)->prev,(data_iterator)=(datatype *) (iterator))
205
206 #endif /* _DLIST_H_ */