1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//! Contains all the different types that are introduced into PHP.
//! Introduces functions for converting between Zend values and Rust values.
pub mod array;
pub mod binary;
pub mod callable;
#[cfg(any(docs, feature = "closure"))]
#[cfg_attr(docs, doc(cfg(feature = "closure")))]
pub mod closure;
pub mod long;
pub mod object;
pub mod props;
pub mod rc;
pub mod string;
pub mod zval;
use std::{
ffi::{c_void, CString},
ptr,
};
use crate::bindings::{
zend_type, IS_MIXED, MAY_BE_ANY, MAY_BE_BOOL, _IS_BOOL, _ZEND_IS_VARIADIC_BIT,
_ZEND_SEND_MODE_SHIFT, _ZEND_TYPE_NAME_BIT, _ZEND_TYPE_NULLABLE_BIT,
};
use super::enums::DataType;
/// Internal Zend type.
pub type ZendType = zend_type;
impl ZendType {
/// Builds an empty Zend type container.
///
/// # Parameters
///
/// * `pass_by_ref` - Whether the value should be passed by reference.
/// * `is_variadic` - Whether this type represents a variadic argument.
pub fn empty(pass_by_ref: bool, is_variadic: bool) -> Self {
Self {
ptr: ptr::null::<c_void>() as *mut c_void,
type_mask: Self::arg_info_flags(pass_by_ref, is_variadic),
}
}
/// Attempts to create a zend type for a given datatype. Returns an option containing the type.
///
/// Returns [`None`] if the data type was a class object where the class name could not be converted
/// into a C string (i.e. contained NUL-bytes).
///
/// # Parameters
///
/// * `type_` - Data type to create zend type for.
/// * `pass_by_ref` - Whether the type should be passed by reference.
/// * `is_variadic` - Whether the type is for a variadic argument.
/// * `allow_null` - Whether the type should allow null to be passed in place.
pub fn empty_from_type(
type_: DataType,
pass_by_ref: bool,
is_variadic: bool,
allow_null: bool,
) -> Option<Self> {
match type_ {
DataType::Object(Some(class)) => {
Self::empty_from_class_type(class, pass_by_ref, is_variadic, allow_null)
}
type_ => Some(Self::empty_from_primitive_type(
type_,
pass_by_ref,
is_variadic,
allow_null,
)),
}
}
/// Attempts to create a zend type for a class object type. Returns an option containing the type if successful.
///
/// Returns [`None`] if the data type was a class object where the class name could not be converted
/// into a C string (i.e. contained NUL-bytes).
///
/// # Parameters
///
/// * `class_name` - Name of the class parameter.
/// * `pass_by_ref` - Whether the type should be passed by reference.
/// * `is_variadic` - Whether the type is for a variadic argument.
/// * `allow_null` - Whether the type should allow null to be passed in place.
fn empty_from_class_type(
class_name: &str,
pass_by_ref: bool,
is_variadic: bool,
allow_null: bool,
) -> Option<Self> {
Some(Self {
ptr: CString::new(class_name).ok()?.into_raw() as *mut c_void,
type_mask: _ZEND_TYPE_NAME_BIT
| (if allow_null {
_ZEND_TYPE_NULLABLE_BIT
} else {
0
})
| Self::arg_info_flags(pass_by_ref, is_variadic),
})
}
/// Attempts to create a zend type for a primitive PHP type.
///
/// # Parameters
///
/// * `type_` - Data type to create zend type for.
/// * `pass_by_ref` - Whether the type should be passed by reference.
/// * `is_variadic` - Whether the type is for a variadic argument.
/// * `allow_null` - Whether the type should allow null to be passed in place.
///
/// # Panics
///
/// Panics if the given `type_` is for a class object type.
fn empty_from_primitive_type(
type_: DataType,
pass_by_ref: bool,
is_variadic: bool,
allow_null: bool,
) -> Self {
assert!(!matches!(type_, DataType::Object(Some(_))));
Self {
ptr: ptr::null::<c_void>() as *mut c_void,
type_mask: Self::type_init_code(type_, pass_by_ref, is_variadic, allow_null),
}
}
/// Calculates the internal flags of the type.
/// Translation of of the `_ZEND_ARG_INFO_FLAGS` macro from zend_API.h:110.
///
/// # Parameters
///
/// * `pass_by_ref` - Whether the value should be passed by reference.
/// * `is_variadic` - Whether this type represents a variadic argument.
pub(crate) fn arg_info_flags(pass_by_ref: bool, is_variadic: bool) -> u32 {
((pass_by_ref as u32) << _ZEND_SEND_MODE_SHIFT)
| (if is_variadic {
_ZEND_IS_VARIADIC_BIT
} else {
0
})
}
/// Calculates the internal flags of the type.
/// Translation of the `ZEND_TYPE_INIT_CODE` macro from zend_API.h:163.
///
/// # Parameters
///
/// * `type_` - The type to initialize the Zend type with.
/// * `pass_by_ref` - Whether the value should be passed by reference.
/// * `is_variadic` - Whether this type represents a variadic argument.
/// * `allow_null` - Whether the value can be null.
pub(crate) fn type_init_code(
type_: DataType,
pass_by_ref: bool,
is_variadic: bool,
allow_null: bool,
) -> u32 {
let type_ = type_.as_u32();
(if type_ == _IS_BOOL {
MAY_BE_BOOL
} else if type_ == IS_MIXED {
MAY_BE_ANY
} else {
1 << type_
}) | (if allow_null {
_ZEND_TYPE_NULLABLE_BIT
} else {
0
}) | Self::arg_info_flags(pass_by_ref, is_variadic)
}
}