1 #ifndef __ALT_LIST_H__
2 #define __ALT_LIST_H__
3
4 /******************************************************************************
5 * *
6 * License Agreement *
7 * *
8 * Copyright (c) 2004 Altera Corporation, San Jose, California, USA. *
9 * All rights reserved. *
10 * *
11 * Permission is hereby granted, free of charge, to any person obtaining a *
12 * copy of this software and associated documentation files (the "Software"), *
13 * to deal in the Software without restriction, including without limitation *
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense, *
15 * and/or sell copies of the Software, and to permit persons to whom the *
16 * Software is furnished to do so, subject to the following conditions: *
17 * *
18 * The above copyright notice and this permission notice shall be included in *
19 * all copies or substantial portions of the Software. *
20 * *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *
27 * DEALINGS IN THE SOFTWARE. *
28 * *
29 * *
30 * Altera does not recommend, suggest or require that this reference design *
31 * file be used in conjunction or combination with any other product. *
32 ******************************************************************************/
33
34 /******************************************************************************
35 * *
36 * THIS IS A LIBRARY READ-ONLY SOURCE FILE. DO NOT EDIT. *
37 * *
38 ******************************************************************************/
39
40 #include "alt_types.h"
41
42 /*
43 * alt_llist.h defines structures and functions for use in manipulating linked
44 * lists. A list is considered to be constructed from a chain of objects of
45 * type alt_llist, with one object being defined to be the head element.
46 *
47 * A list is considered to be empty if it only contains the head element.
48 */
49
50 #ifdef __cplusplus
51 extern "C"
52 {
53 #endif /* __cplusplus */
54
55 /*
56 * alt_llist is the structure used to represent an element within a linked
57 * list.
58 */
59
60 typedef struct alt_llist_s alt_llist;
61
62 struct alt_llist_s {
63 alt_llist* next; /* Pointer to the next element in the list. */
64 alt_llist* previous; /* Pointer to the previous element in the list. */
65 };
66
67 /*
68 * ALT_LLIST_HEAD is a macro that can be used to create the head of a new
69 * linked list. This is named "head". The head element is initialised to
70 * represent an empty list.
71 */
72
73 #define ALT_LLIST_HEAD(head) alt_llist head = {&head, &head}
74
75 /*
76 * ALT_LLIST_ENTRY is a macro used to define an uninitialised linked list
77 * entry. This is used to reserve space in structure initialisation for
78 * structures that inherit form alt_llist.
79 */
80
81 #define ALT_LLIST_ENTRY {0, 0}
82
83 /*
84 * alt_llist_insert() insert adds the linked list entry "entry" as the
85 * first entry in the linked list "list". "list" is the list head element.
86 */
87
alt_llist_insert(alt_llist * list,alt_llist * entry)88 static ALT_INLINE void ALT_ALWAYS_INLINE alt_llist_insert(alt_llist* list,
89 alt_llist* entry)
90 {
91 entry->previous = list;
92 entry->next = list->next;
93
94 list->next->previous = entry;
95 list->next = entry;
96 }
97
98 /*
99 * alt_llist_remove() is called to remove an element from a linked list. The
100 * input argument is the element to remove.
101 */
102
alt_llist_remove(alt_llist * entry)103 static ALT_INLINE void ALT_ALWAYS_INLINE alt_llist_remove(alt_llist* entry)
104 {
105 entry->next->previous = entry->previous;
106 entry->previous->next = entry->next;
107
108 /*
109 * Set the entry to point to itself, so that any further calls to
110 * alt_llist_remove() are harmless.
111 */
112
113 entry->previous = entry;
114 entry->next = entry;
115 }
116
117 #ifdef __cplusplus
118 }
119 #endif
120
121 #endif /* __ALT_LLIST_H__ */
122
