1/* x-list.h -- simple list type
2 *
3 * Copyright (c) 2002-2012 Apple Inc. All rights reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation files
7 * (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 * NONINFRINGEMENT.  IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT
20 * HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 * DEALINGS IN THE SOFTWARE.
24 *
25 * Except as contained in this notice, the name(s) of the above
26 * copyright holders shall not be used in advertising or otherwise to
27 * promote the sale, use or other dealings in this Software without
28 * prior written authorization.
29 */
30
31#ifndef X_LIST_H
32#define X_LIST_H 1
33
34/* This is just a cons. */
35
36typedef struct x_list_struct x_list;
37
38struct x_list_struct {
39    void *data;
40    x_list *next;
41};
42
43#ifndef X_PFX
44#define X_PFX(x) x_ ## x
45#endif
46
47#ifndef X_EXTERN
48#define X_EXTERN __private_extern__
49#endif
50
51X_EXTERN void X_PFX(list_free_1) (x_list * node);
52X_EXTERN x_list *X_PFX(list_prepend) (x_list * lst, void *data);
53
54X_EXTERN x_list *X_PFX(list_append) (x_list * lst, void *data);
55X_EXTERN x_list *X_PFX(list_remove) (x_list * lst, void *data);
56X_EXTERN void X_PFX(list_free) (x_list * lst);
57X_EXTERN x_list *X_PFX(list_pop) (x_list * lst, void **data_ret);
58
59X_EXTERN x_list *X_PFX(list_copy) (x_list * lst);
60X_EXTERN x_list *X_PFX(list_reverse) (x_list * lst);
61X_EXTERN x_list *X_PFX(list_find) (x_list * lst, void *data);
62X_EXTERN x_list *X_PFX(list_nth) (x_list * lst, int n);
63X_EXTERN x_list *X_PFX(list_filter) (x_list * src,
64                                     int (*pred)(void *item, void *data),
65                                     void *data);
66X_EXTERN x_list *X_PFX(list_map) (x_list * src,
67                                  void *(*fun)(void *item, void *data),
68                                  void *data);
69
70X_EXTERN unsigned int X_PFX(list_length) (x_list * lst);
71X_EXTERN void X_PFX(list_foreach) (x_list * lst, void (*fun)
72                                   (void *data, void *user_data),
73                                   void *user_data);
74
75X_EXTERN x_list *X_PFX(list_sort) (x_list * lst,
76                                   int (*less)(const void *, const void *));
77
78#endif /* X_LIST_H */
79