xref: /PHP-8.3/Zend/zend_llist.h (revision bf1cfc07)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 2.00 of the Zend license,     |
8    | that is bundled with this package in the file LICENSE, and is        |
9    | available through the world-wide-web at the following url:           |
10    | http://www.zend.com/license/2_00.txt.                                |
11    | If you did not receive a copy of the Zend license and are unable to  |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@zend.com so we can mail you a copy immediately.              |
14    +----------------------------------------------------------------------+
15    | Authors: Andi Gutmans <andi@php.net>                                 |
16    |          Zeev Suraski <zeev@php.net>                                 |
17    +----------------------------------------------------------------------+
18 */
19 
20 #ifndef ZEND_LLIST_H
21 #define ZEND_LLIST_H
22 
23 typedef struct _zend_llist_element {
24 	struct _zend_llist_element *next;
25 	struct _zend_llist_element *prev;
26 	char data[1]; /* Needs to always be last in the struct */
27 } zend_llist_element;
28 
29 typedef void (*llist_dtor_func_t)(void *);
30 typedef int (*llist_compare_func_t)(const zend_llist_element **, const zend_llist_element **);
31 typedef void (*llist_apply_with_args_func_t)(void *data, int num_args, va_list args);
32 typedef void (*llist_apply_with_arg_func_t)(void *data, void *arg);
33 typedef void (*llist_apply_func_t)(void *);
34 
35 typedef struct _zend_llist {
36 	zend_llist_element *head;
37 	zend_llist_element *tail;
38 	size_t count;
39 	size_t size;
40 	llist_dtor_func_t dtor;
41 	unsigned char persistent;
42 	zend_llist_element *traverse_ptr;
43 } zend_llist;
44 
45 typedef zend_llist_element* zend_llist_position;
46 
47 BEGIN_EXTERN_C()
48 ZEND_API void zend_llist_init(zend_llist *l, size_t size, llist_dtor_func_t dtor, unsigned char persistent);
49 ZEND_API void zend_llist_add_element(zend_llist *l, const void *element);
50 ZEND_API void zend_llist_prepend_element(zend_llist *l, const void *element);
51 ZEND_API void zend_llist_del_element(zend_llist *l, void *element, int (*compare)(void *element1, void *element2));
52 ZEND_API void zend_llist_destroy(zend_llist *l);
53 ZEND_API void zend_llist_clean(zend_llist *l);
54 ZEND_API void zend_llist_remove_tail(zend_llist *l);
55 ZEND_API void zend_llist_copy(zend_llist *dst, zend_llist *src);
56 ZEND_API void zend_llist_apply(zend_llist *l, llist_apply_func_t func);
57 ZEND_API void zend_llist_apply_with_del(zend_llist *l, int (*func)(void *data));
58 ZEND_API void zend_llist_apply_with_argument(zend_llist *l, llist_apply_with_arg_func_t func, void *arg);
59 ZEND_API void zend_llist_apply_with_arguments(zend_llist *l, llist_apply_with_args_func_t func, int num_args, ...);
60 ZEND_API size_t zend_llist_count(zend_llist *l);
61 ZEND_API void zend_llist_sort(zend_llist *l, llist_compare_func_t comp_func);
62 
63 /* traversal */
64 ZEND_API void *zend_llist_get_first_ex(zend_llist *l, zend_llist_position *pos);
65 ZEND_API void *zend_llist_get_last_ex(zend_llist *l, zend_llist_position *pos);
66 ZEND_API void *zend_llist_get_next_ex(zend_llist *l, zend_llist_position *pos);
67 ZEND_API void *zend_llist_get_prev_ex(zend_llist *l, zend_llist_position *pos);
68 
zend_llist_get_first(zend_llist * l)69 static zend_always_inline void *zend_llist_get_first(zend_llist *l)
70 {
71 	return zend_llist_get_first_ex(l, NULL);
72 }
73 
zend_llist_get_last(zend_llist * l)74 static zend_always_inline void *zend_llist_get_last(zend_llist *l)
75 {
76 	return zend_llist_get_last_ex(l, NULL);
77 }
78 
zend_llist_get_next(zend_llist * l)79 static zend_always_inline void *zend_llist_get_next(zend_llist *l)
80 {
81 	return zend_llist_get_next_ex(l, NULL);
82 }
83 
zend_llist_get_prev(zend_llist * l)84 static zend_always_inline void *zend_llist_get_prev(zend_llist *l)
85 {
86 	return zend_llist_get_prev_ex(l, NULL);
87 }
88 
89 END_EXTERN_C()
90 
91 #endif /* ZEND_LLIST_H */
92