1/* adlist.h - A generic doubly linked list implementation
2 *
3 * Copyright (c) 2006-2012, Salvatore Sanfilippo <antirez at gmail dot com>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * * Neither the name of Redis 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 OWNER 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#ifndef __ADLIST_H__
32#define __ADLIST_H__
33
34/* Node, List, and Iterator are the only data structures used currently. */
35
36typedef struct listNode {
37 struct listNode *prev;
38 struct listNode *next;
39 void *value;
40} listNode;
41
42typedef struct listIter {
43 listNode *next;
44 int direction;
45} listIter;
46
47typedef struct list {
48 listNode *head;
49 listNode *tail;
50 void *(*dup)(void *ptr);
51 void (*free)(void *ptr);
52 int (*match)(void *ptr, void *key);
53 unsigned long len;
54} list;
55
56/* Functions implemented as macros */
57#define listLength(l) ((l)->len)
58#define listFirst(l) ((l)->head)
59#define listLast(l) ((l)->tail)
60#define listPrevNode(n) ((n)->prev)
61#define listNextNode(n) ((n)->next)
62#define listNodeValue(n) ((n)->value)
63
64#define listSetDupMethod(l,m) ((l)->dup = (m))
65#define listSetFreeMethod(l,m) ((l)->free = (m))
66#define listSetMatchMethod(l,m) ((l)->match = (m))
67
68#define listGetDupMethod(l) ((l)->dup)
69#define listGetFreeMethod(l) ((l)->free)
70#define listGetMatchMethod(l) ((l)->match)
71
72/* Prototypes */
73list *listCreate(void);
74void listRelease(list *list);
75void listEmpty(list *list);
76list *listAddNodeHead(list *list, void *value);
77list *listAddNodeTail(list *list, void *value);
78list *listInsertNode(list *list, listNode *old_node, void *value, int after);
79void listDelNode(list *list, listNode *node);
80listIter *listGetIterator(list *list, int direction);
81listNode *listNext(listIter *iter);
82void listReleaseIterator(listIter *iter);
83list *listDup(list *orig);
84listNode *listSearchKey(list *list, void *key);
85listNode *listIndex(list *list, long index);
86void listRewind(list *list, listIter *li);
87void listRewindTail(list *list, listIter *li);
88void listRotateTailToHead(list *list);
89void listRotateHeadToTail(list *list);
90void listJoin(list *l, list *o);
91
92/* Directions for iterators */
93#define AL_START_HEAD 0
94#define AL_START_TAIL 1
95
96#endif /* __ADLIST_H__ */
97