libmetal
list.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of Xilinx nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without
16  * specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /*
32  * @file list.h
33  * @brief List primitives for libmetal.
34  */
35 
36 #ifndef __METAL_LIST__H__
37 #define __METAL_LIST__H__
38 
39 #include <stdlib.h>
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
48 struct metal_list {
49  struct metal_list *next, *prev;
50 };
51 
52 #define METAL_DECLARE_LIST(name) \
53  struct metal_list name = { .next = &name, .prev = &name }
54 
55 static inline void metal_list_init(struct metal_list *list)
56 {
57  list->next = list->prev = list;
58 }
59 
60 static inline void metal_list_add_before(struct metal_list *node,
61  struct metal_list *new_node)
62 {
63  new_node->prev = node->prev;
64  new_node->next = node;
65  new_node->next->prev = new_node;
66  new_node->prev->next = new_node;
67 }
68 
69 static inline void metal_list_add_after(struct metal_list *node,
70  struct metal_list *new_node)
71 {
72  new_node->prev = node;
73  new_node->next = node->next;
74  new_node->next->prev = new_node;
75  new_node->prev->next = new_node;
76 }
77 
78 static inline void metal_list_add_head(struct metal_list *list,
79  struct metal_list *node)
80 {
81  metal_list_add_after(list, node);
82 }
83 
84 static inline void metal_list_add_tail(struct metal_list *list,
85  struct metal_list *node)
86 {
87  metal_list_add_before(list, node);
88 }
89 
90 static inline int metal_list_is_empty(struct metal_list *list)
91 {
92  return list->next == list;
93 }
94 
95 static inline void metal_list_del(struct metal_list *node)
96 {
97  node->next->prev = node->prev;
98  node->prev->next = node->next;
99  node->next = node->prev = node;
100 }
101 
102 static inline struct metal_list *metal_list_first(struct metal_list *list)
103 {
104  return metal_list_is_empty(list) ? NULL : list->next;
105 }
106 
107 #define metal_list_for_each(list, node) \
108  for ((node) = (list)->next; \
109  (node) != (list); \
110  (node) = (node)->next)
111 
113 #ifdef __cplusplus
114 }
115 #endif
116 
117 #endif /* __METAL_LIST__H__ */
struct metal_list * next
Definition: list.h:49
struct metal_list * prev
Definition: list.h:49
static void metal_list_add_before(struct metal_list *node, struct metal_list *new_node)
Definition: list.h:60
Definition: list.h:48
static struct metal_list * metal_list_first(struct metal_list *list)
Definition: list.h:102
static void metal_list_add_tail(struct metal_list *list, struct metal_list *node)
Definition: list.h:84
static void metal_list_init(struct metal_list *list)
Definition: list.h:55
static int metal_list_is_empty(struct metal_list *list)
Definition: list.h:90
static void metal_list_del(struct metal_list *node)
Definition: list.h:95
static void metal_list_add_head(struct metal_list *list, struct metal_list *node)
Definition: list.h:78
static void metal_list_add_after(struct metal_list *node, struct metal_list *new_node)
Definition: list.h:69