xref: /PHP-8.4/Zend/zend_stack.h (revision 6335264c)
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_STACK_H
21 #define ZEND_STACK_H
22 
23 #include "zend_portability.h"
24 
25 typedef struct _zend_stack {
26 	int size, top, max;
27 	void *elements;
28 } zend_stack;
29 
30 
31 #define STACK_BLOCK_SIZE 16
32 
33 typedef enum {
34 	ZEND_STACK_APPLY_TOPDOWN,
35 	ZEND_STACK_APPLY_BOTTOMUP,
36 } zend_stack_apply_direction;
37 
38 BEGIN_EXTERN_C()
39 ZEND_API void zend_stack_init(zend_stack *stack, int size);
40 ZEND_API int zend_stack_push(zend_stack *stack, const void *element);
41 ZEND_API void *zend_stack_top(const zend_stack *stack);
42 ZEND_API void zend_stack_del_top(zend_stack *stack);
43 ZEND_API int zend_stack_int_top(const zend_stack *stack);
44 ZEND_API bool zend_stack_is_empty(const zend_stack *stack);
45 ZEND_API void zend_stack_destroy(zend_stack *stack);
46 ZEND_API void *zend_stack_base(const zend_stack *stack);
47 ZEND_API int zend_stack_count(const zend_stack *stack);
48 ZEND_API void zend_stack_apply(zend_stack *stack, int type, int (*apply_function)(void *element));
49 ZEND_API void zend_stack_apply_with_argument(zend_stack *stack, zend_stack_apply_direction type, int (*apply_function)(void *element, void *arg), void *arg);
50 ZEND_API void zend_stack_clean(zend_stack *stack, void (*func)(void *), bool free_elements);
51 END_EXTERN_C()
52 
53 #endif /* ZEND_STACK_H */
54