PipeWire: spa/utils/list.h Source File

PipeWire 0.3.51

list.h
Go to the documentation of this file.
1/* Simple Plugin API
2 *
3 * Copyright © 2018 Wim Taymans
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#ifndef SPA_LIST_H
26#define SPA_LIST_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
42struct spa_list {
43 struct spa_list *next;
44 struct spa_list *prev;
45};
46
47#define SPA_LIST_INIT(list) (struct spa_list){ list, list }
48
49 static inline void spa_list_init(struct spa_list *list)
50{
51 *list = SPA_LIST_INIT(list);
52}
53
54#define spa_list_is_empty(l) ((l)->next == (l))
55
56static inline void spa_list_insert(struct spa_list *list, struct spa_list *elem)
57{
58 elem->prev = list;
59 elem->next = list->next;
60 list->next = elem;
61 elem->next->prev = elem;
62}
63
64static inline void spa_list_insert_list(struct spa_list *list, struct spa_list *other)
65{
66 if (spa_list_is_empty(other))
67 return;
68 other->next->prev = list;
69 other->prev->next = list->next;
70 list->next->prev = other->prev;
71 list->next = other->next;
72}
73
74static inline void spa_list_remove(struct spa_list *elem)
75{
76 elem->prev->next = elem->next;
77 elem->next->prev = elem->prev;
78}
79
80#define spa_list_first(head, type, member) \
81 SPA_CONTAINER_OF((head)->next, type, member)
82
83#define spa_list_last(head, type, member) \
84 SPA_CONTAINER_OF((head)->prev, type, member)
85
86#define spa_list_append(list, item) \
87 spa_list_insert((list)->prev, item)
88
89#define spa_list_prepend(list, item) \
90 spa_list_insert(list, item)
91
92#define spa_list_is_end(pos, head, member) \
93 (&(pos)->member == (head))
94
95#define spa_list_next(pos, member) \
96 SPA_CONTAINER_OF((pos)->member.next, __typeof__(*pos), member)
97
98#define spa_list_prev(pos, member) \
99 SPA_CONTAINER_OF((pos)->member.prev, __typeof__(*pos), member)
100
101#define spa_list_consume(pos, head, member) \
102 for (pos = spa_list_first(head, __typeof__(*pos), member); \
103 !spa_list_is_empty(head); \
104 pos = spa_list_first(head, __typeof__(*pos), member))
105
106#define spa_list_for_each_next(pos, head, curr, member) \
107 for (pos = spa_list_first(curr, __typeof__(*pos), member); \
108 !spa_list_is_end(pos, head, member); \
109 pos = spa_list_next(pos, member))
110
111#define spa_list_for_each_prev(pos, head, curr, member) \
112 for (pos = spa_list_last(curr, __typeof__(*pos), member); \
113 !spa_list_is_end(pos, head, member); \
114 pos = spa_list_prev(pos, member))
115
116#define spa_list_for_each(pos, head, member) \
117 spa_list_for_each_next(pos, head, head, member)
118
119#define spa_list_for_each_reverse(pos, head, member) \
120 spa_list_for_each_prev(pos, head, head, member)
121
122#define spa_list_for_each_safe_next(pos, tmp, head, curr, member) \
123 for (pos = spa_list_first(curr, __typeof__(*pos), member); \
124 tmp = spa_list_next(pos, member), \
125 !spa_list_is_end(pos, head, member); \
126 pos = tmp)
127
128#define spa_list_for_each_safe_prev(pos, tmp, head, curr, member) \
129 for (pos = spa_list_last(curr, __typeof__(*pos), member); \
130 tmp = spa_list_prev(pos, member), \
131 !spa_list_is_end(pos, head, member); \
132 pos = tmp)
133
134#define spa_list_for_each_safe(pos, tmp, head, member) \
135 spa_list_for_each_safe_next(pos, tmp, head, head, member)
136
137#define spa_list_for_each_safe_reverse(pos, tmp, head, member) \
138 spa_list_for_each_safe_prev(pos, tmp, head, head, member)
139
140#define spa_list_cursor_start(cursor, head, member) \
141 spa_list_prepend(head, &(cursor).member)
142
143#define spa_list_for_each_cursor(pos, cursor, head, member) \
144 for(pos = spa_list_first(&(cursor).member, __typeof__(*(pos)), member); \
145 spa_list_remove(&(pos)->member), \
146 spa_list_append(&(cursor).member, &(pos)->member), \
147 !spa_list_is_end(pos, head, member); \
148 pos = spa_list_next(&cursor, member))
149
150#define spa_list_cursor_end(cursor, member) \
151 spa_list_remove(&(cursor).member)
152
157#ifdef __cplusplus
158} /* extern "C" */
159#endif
160
161#endif /* SPA_LIST_H */
spa_list_insert
static void spa_list_insert(struct spa_list *list, struct spa_list *elem)
Definition: list.h:62
spa_list_init
static void spa_list_init(struct spa_list *list)
Definition: list.h:55
spa_list_remove
static void spa_list_remove(struct spa_list *elem)
Definition: list.h:80
spa_list_is_empty
#define spa_list_is_empty(l)
Definition: list.h:60
SPA_LIST_INIT
#define SPA_LIST_INIT(list)
Definition: list.h:53
spa_list_insert_list
static void spa_list_insert_list(struct spa_list *list, struct spa_list *other)
Definition: list.h:70
spa_list
Definition: list.h:47
spa_list::prev
struct spa_list * prev
Definition: list.h:49
spa_list::next
struct spa_list * next
Definition: list.h:48