Skip to main content

rsphp_build_tools/
int_types.rs

1use bindgen::callbacks::{IntKind, ParseCallbacks};
2
3/// Callbacks to specify what type of integer should be used for various
4/// C `#define`d constants.
5#[derive(Clone, Copy, Debug, Default)]
6#[non_exhaustive]
7pub struct ExplicitIntTypesCallbacks;
8
9impl ExplicitIntTypesCallbacks {
10    /// Create a new callbacks instance to int macro types.
11    #[must_use]
12    pub fn new() -> Self {
13        ExplicitIntTypesCallbacks
14    }
15}
16
17impl ParseCallbacks for ExplicitIntTypesCallbacks {
18    #[expect(clippy::too_many_lines, reason = "Lots of cases to match")]
19    fn int_macro(&self, name: &str, _value: i64) -> Option<IntKind> {
20        // Force some int kinds
21        #[expect(clippy::match_same_arms, reason = "Group related constants")]
22        match name {
23            // Build metadata
24            "ZEND_DEBUG" | "USING_ZTS" => Some(IntKind::U8),
25            // Type information
26            "IS_UNDEF" | "IS_NULL" | "IS_FALSE" | "IS_TRUE" | "IS_LONG" | "IS_DOUBLE"
27            | "IS_STRING" | "IS_ARRAY" | "IS_OBJECT" | "IS_RESOURCE" | "IS_REFERENCE"
28            | "IS_CONSTANT_AST" | "IS_CALLABLE" | "IS_ITERABLE" | "IS_VOID" | "IS_STATIC"
29            | "IS_MIXED" | "IS_NEVER" | "IS_INDIRECT" | "IS_PTR" | "IS_ALIAS_PTR" | "_IS_ERROR"
30            | "_IS_BOOL" | "_IS_NUMBER" => Some(IntKind::U8),
31            // INI flags
32            "ZEND_INI_USER" | "ZEND_INI_PERDIR" | "ZEND_INI_SYSTEM" | "ZEND_INI_ALL"
33            | "PHP_INI_USER" | "PHP_INI_PERDIR" | "PHP_INI_SYSTEM" | "PHP_INI_ALL" => {
34                Some(IntKind::U8)
35            }
36            // Module loading types
37            "MODULE_PERSISTENT" | "MODULE_TEMPORARY" => Some(IntKind::U8),
38            // Class types
39            // In PHP 8.6 this becomes a dedicated enum type with u8 backing,
40            // until then these are stored in a char field
41            "ZEND_INTERNAL_CLASS" | "ZEND_USER_CLASS" => Some(IntKind::I8),
42            // Function types
43            // In PHP 8.6 this becomes a dedicated enum type with u8 backing,
44            // until then these are stored in a u8 field
45            "ZEND_INTERNAL_FUNCTION" | "ZEND_USER_FUNCTION" => Some(IntKind::U8),
46            // Module dependency types are stored in an unsigned char field
47            "MODULE_DEP_REQUIRED" | "MODULE_DEP_CONFLICTS" | "MODULE_DEP_OPTIONAL" => {
48                Some(IntKind::UChar)
49            }
50            // Kinds passed to object handlers for has_set_exists
51            "ZEND_PROPERTY_ISSET" | "ZEND_PROPERTY_NOT_EMPTY" | "ZEND_PROPERTY_EXISTS" => {
52                Some(IntKind::Int)
53            }
54            // Parameter parsing api
55            "ZEND_PARSE_PARAMS_QUIET" => Some(IntKind::Int),
56            // Opcodes that are stored in u8 fields
57            "ZEND_NOP"
58            | "ZEND_ADD"
59            | "ZEND_SUB"
60            | "ZEND_MUL"
61            | "ZEND_DIV"
62            | "ZEND_MOD"
63            | "ZEND_SL"
64            | "ZEND_SR"
65            | "ZEND_CONCAT"
66            | "ZEND_BW_OR"
67            | "ZEND_BW_AND"
68            | "ZEND_BW_XOR"
69            | "ZEND_POW"
70            | "ZEND_BW_NOT"
71            | "ZEND_BOOL_NOT"
72            | "ZEND_BOOL_XOR"
73            | "ZEND_IS_IDENTICAL"
74            | "ZEND_IS_NOT_IDENTICAL"
75            | "ZEND_IS_EQUAL"
76            | "ZEND_IS_NOT_EQUAL"
77            | "ZEND_IS_SMALLER"
78            | "ZEND_IS_SMALLER_OR_EQUAL"
79            | "ZEND_ASSIGN"
80            | "ZEND_ASSIGN_DIM"
81            | "ZEND_ASSIGN_OBJ"
82            | "ZEND_ASSIGN_STATIC_PROP"
83            | "ZEND_ASSIGN_OP"
84            | "ZEND_ASSIGN_DIM_OP"
85            | "ZEND_ASSIGN_OBJ_OP"
86            | "ZEND_ASSIGN_STATIC_PROP_OP"
87            | "ZEND_ASSIGN_REF"
88            | "ZEND_QM_ASSIGN"
89            | "ZEND_ASSIGN_OBJ_REF"
90            | "ZEND_ASSIGN_STATIC_PROP_REF"
91            | "ZEND_PRE_INC"
92            | "ZEND_PRE_DEC"
93            | "ZEND_POST_INC"
94            | "ZEND_POST_DEC"
95            | "ZEND_PRE_INC_STATIC_PROP"
96            | "ZEND_PRE_DEC_STATIC_PROP"
97            | "ZEND_POST_INC_STATIC_PROP"
98            | "ZEND_POST_DEC_STATIC_PROP"
99            | "ZEND_JMP"
100            | "ZEND_JMPZ"
101            | "ZEND_JMPNZ"
102            | "ZEND_JMPZ_EX"
103            | "ZEND_JMPNZ_EX"
104            | "ZEND_CASE"
105            | "ZEND_CHECK_VAR"
106            | "ZEND_SEND_VAR_NO_REF_EX"
107            | "ZEND_CAST"
108            | "ZEND_BOOL"
109            | "ZEND_FAST_CONCAT"
110            | "ZEND_ROPE_INIT"
111            | "ZEND_ROPE_ADD"
112            | "ZEND_ROPE_END"
113            | "ZEND_BEGIN_SILENCE"
114            | "ZEND_END_SILENCE"
115            | "ZEND_INIT_FCALL_BY_NAME"
116            | "ZEND_DO_FCALL"
117            | "ZEND_INIT_FCALL"
118            | "ZEND_RETURN"
119            | "ZEND_RECV"
120            | "ZEND_RECV_INIT"
121            | "ZEND_SEND_VAL"
122            | "ZEND_SEND_VAR_EX"
123            | "ZEND_SEND_REF"
124            | "ZEND_NEW"
125            | "ZEND_INIT_NS_FCALL_BY_NAME"
126            | "ZEND_FREE"
127            | "ZEND_INIT_ARRAY"
128            | "ZEND_ADD_ARRAY_ELEMENT"
129            | "ZEND_INCLUDE_OR_EVAL"
130            | "ZEND_UNSET_VAR"
131            | "ZEND_UNSET_DIM"
132            | "ZEND_UNSET_OBJ"
133            | "ZEND_FE_RESET_R"
134            | "ZEND_FE_FETCH_R"
135            | "ZEND_FETCH_R"
136            | "ZEND_FETCH_DIM_R"
137            | "ZEND_FETCH_OBJ_R"
138            | "ZEND_FETCH_W"
139            | "ZEND_FETCH_DIM_W"
140            | "ZEND_FETCH_OBJ_W"
141            | "ZEND_FETCH_RW"
142            | "ZEND_FETCH_DIM_RW"
143            | "ZEND_FETCH_OBJ_RW"
144            | "ZEND_FETCH_IS"
145            | "ZEND_FETCH_DIM_IS"
146            | "ZEND_FETCH_OBJ_IS"
147            | "ZEND_FETCH_FUNC_ARG"
148            | "ZEND_FETCH_DIM_FUNC_ARG"
149            | "ZEND_FETCH_OBJ_FUNC_ARG"
150            | "ZEND_FETCH_UNSET"
151            | "ZEND_FETCH_DIM_UNSET"
152            | "ZEND_FETCH_OBJ_UNSET"
153            | "ZEND_FETCH_LIST_R"
154            | "ZEND_FETCH_CONSTANT"
155            | "ZEND_CHECK_FUNC_ARG"
156            | "ZEND_EXT_STMT"
157            | "ZEND_EXT_FCALL_BEGIN"
158            | "ZEND_EXT_FCALL_END"
159            | "ZEND_EXT_NOP"
160            | "ZEND_TICKS"
161            | "ZEND_SEND_VAR_NO_REF"
162            | "ZEND_CATCH"
163            | "ZEND_THROW"
164            | "ZEND_FETCH_CLASS"
165            | "ZEND_CLONE"
166            | "ZEND_RETURN_BY_REF"
167            | "ZEND_INIT_METHOD_CALL"
168            | "ZEND_INIT_STATIC_METHOD_CALL"
169            | "ZEND_ISSET_ISEMPTY_VAR"
170            | "ZEND_ISSET_ISEMPTY_DIM_OBJ"
171            | "ZEND_SEND_VAL_EX"
172            | "ZEND_SEND_VAR"
173            | "ZEND_INIT_USER_CALL"
174            | "ZEND_SEND_ARRAY"
175            | "ZEND_SEND_USER"
176            | "ZEND_STRLEN"
177            | "ZEND_DEFINED"
178            | "ZEND_TYPE_CHECK"
179            | "ZEND_VERIFY_RETURN_TYPE"
180            | "ZEND_FE_RESET_RW"
181            | "ZEND_FE_FETCH_RW"
182            | "ZEND_FE_FREE"
183            | "ZEND_INIT_DYNAMIC_CALL"
184            | "ZEND_DO_ICALL"
185            | "ZEND_DO_UCALL"
186            | "ZEND_DO_FCALL_BY_NAME"
187            | "ZEND_PRE_INC_OBJ"
188            | "ZEND_PRE_DEC_OBJ"
189            | "ZEND_POST_INC_OBJ"
190            | "ZEND_POST_DEC_OBJ"
191            | "ZEND_ECHO"
192            | "ZEND_OP_DATA"
193            | "ZEND_INSTANCEOF"
194            | "ZEND_GENERATOR_CREATE"
195            | "ZEND_MAKE_REF"
196            | "ZEND_DECLARE_FUNCTION"
197            | "ZEND_DECLARE_LAMBDA_FUNCTION"
198            | "ZEND_DECLARE_CONST"
199            | "ZEND_DECLARE_CLASS"
200            | "ZEND_DECLARE_CLASS_DELAYED"
201            | "ZEND_DECLARE_ANON_CLASS"
202            | "ZEND_ADD_ARRAY_UNPACK"
203            | "ZEND_ISSET_ISEMPTY_PROP_OBJ"
204            | "ZEND_HANDLE_EXCEPTION"
205            | "ZEND_USER_OPCODE"
206            | "ZEND_ASSERT_CHECK"
207            | "ZEND_JMP_SET"
208            | "ZEND_UNSET_CV"
209            | "ZEND_ISSET_ISEMPTY_CV"
210            | "ZEND_FETCH_LIST_W"
211            | "ZEND_SEPARATE"
212            | "ZEND_FETCH_CLASS_NAME"
213            | "ZEND_CALL_TRAMPOLINE"
214            | "ZEND_DISCARD_EXCEPTION"
215            | "ZEND_YIELD"
216            | "ZEND_GENERATOR_RETURN"
217            | "ZEND_FAST_CALL"
218            | "ZEND_FAST_RET"
219            | "ZEND_RECV_VARIADIC"
220            | "ZEND_SEND_UNPACK"
221            | "ZEND_YIELD_FROM"
222            | "ZEND_COPY_TMP"
223            | "ZEND_BIND_GLOBAL"
224            | "ZEND_COALESCE"
225            | "ZEND_SPACESHIP"
226            | "ZEND_FUNC_NUM_ARGS"
227            | "ZEND_FUNC_GET_ARGS"
228            | "ZEND_FETCH_STATIC_PROP_R"
229            | "ZEND_FETCH_STATIC_PROP_W"
230            | "ZEND_FETCH_STATIC_PROP_RW"
231            | "ZEND_FETCH_STATIC_PROP_IS"
232            | "ZEND_FETCH_STATIC_PROP_FUNC_ARG"
233            | "ZEND_FETCH_STATIC_PROP_UNSET"
234            | "ZEND_UNSET_STATIC_PROP"
235            | "ZEND_ISSET_ISEMPTY_STATIC_PROP"
236            | "ZEND_FETCH_CLASS_CONSTANT"
237            | "ZEND_BIND_LEXICAL"
238            | "ZEND_BIND_STATIC"
239            | "ZEND_FETCH_THIS"
240            | "ZEND_SEND_FUNC_ARG"
241            | "ZEND_ISSET_ISEMPTY_THIS"
242            | "ZEND_SWITCH_LONG"
243            | "ZEND_SWITCH_STRING"
244            | "ZEND_IN_ARRAY"
245            | "ZEND_COUNT"
246            | "ZEND_GET_CLASS"
247            | "ZEND_GET_CALLED_CLASS"
248            | "ZEND_GET_TYPE"
249            | "ZEND_ARRAY_KEY_EXISTS"
250            | "ZEND_MATCH"
251            | "ZEND_CASE_STRICT"
252            | "ZEND_MATCH_ERROR"
253            | "ZEND_JMP_NULL"
254            | "ZEND_CHECK_UNDEF_ARGS"
255            | "ZEND_FETCH_GLOBALS"
256            | "ZEND_VERIFY_NEVER_TYPE"
257            | "ZEND_CALLABLE_CONVERT"
258            | "ZEND_BIND_INIT_STATIC_OR_JMP"
259            | "ZEND_FRAMELESS_ICALL_0"
260            | "ZEND_FRAMELESS_ICALL_1"
261            | "ZEND_FRAMELESS_ICALL_2"
262            | "ZEND_FRAMELESS_ICALL_3"
263            | "ZEND_JMP_FRAMELESS"
264            | "ZEND_INIT_PARENT_PROPERTY_HOOK_CALL"
265            | "ZEND_DECLARE_ATTRIBUTED_CONST"
266            | "ZEND_VM_LAST_OPCODE" => Some(IntKind::U8),
267            _ => None,
268        }
269    }
270}