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 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
//! Macros for interacting with PHP, mainly when the function takes variadic
//! arguments. Unforutunately, this is the best way to handle these.
//! Note that most of these will introduce unsafe into your code base.
/// Starts the PHP extension information table displayed when running
/// `phpinfo();` Must be run *before* rows are inserted into the table.
#[macro_export]
macro_rules! info_table_start {
() => {
unsafe { $crate::ffi::php_info_print_table_start() };
};
}
/// Ends the PHP extension information table. Must be run *after* all rows have
/// been inserted into the table.
#[macro_export]
macro_rules! info_table_end {
() => {
unsafe { $crate::ffi::php_info_print_table_end() }
};
}
/// Sets the header for the PHP extension information table. Takes as many
/// string arguments as required.
#[macro_export]
macro_rules! info_table_header {
($($element:expr),*) => {$crate::_info_table_row!(php_info_print_table_header, $($element),*)};
}
/// Adds a row to the PHP extension information table. Takes as many string
/// arguments as required.
#[macro_export]
macro_rules! info_table_row {
($($element:expr),*) => {$crate::_info_table_row!(php_info_print_table_row, $($element),*)};
}
/// INTERNAL: Calls a variadic C function with the number of parameters, then
/// following with the parameters.
#[doc(hidden)]
#[macro_export]
macro_rules! _info_table_row {
($fn: ident, $($element: expr),*) => {
unsafe {
$crate::ffi::$fn($crate::_info_table_row!(@COUNT; $($element),*) as i32, $(::std::ffi::CString::new($element).unwrap().as_ptr()),*);
}
};
(@COUNT; $($element: expr),*) => {
<[()]>::len(&[$($crate::_info_table_row![@SUBST; $element]),*])
};
(@SUBST; $_: expr) => { () };
}
/// Attempts to call a given PHP callable.
///
/// # Parameters
///
/// * `$fn` - The 'function' to call. Can be an [`Arg`] or a [`Zval`].
/// * ...`$param` - The parameters to pass to the function. Must be able to be
/// converted into a [`Zval`].
///
/// [`Arg`]: crate::args::Arg
/// [`Zval`]: crate::types::Zval
#[macro_export]
macro_rules! call_user_func {
($fn: expr) => {
$fn.try_call(vec![])
};
($fn: expr, $($param: expr),*) => {
$fn.try_call(vec![$(&$param),*])
};
}
/// Parses a given list of arguments using the [`ArgParser`] class.
///
/// # Examples
///
/// This example parses all of the arguments. If one is invalid, execution of
/// the function will stop at the `parse_args!` macro invocation. The user is
/// notified via PHP's argument parsing system.
///
/// In this case, all of the arguments are required.
///
/// ```
/// # #[macro_use] extern crate ext_php_rs;
/// use ext_php_rs::{
/// parse_args,
/// args::Arg,
/// flags::DataType,
/// zend::ExecuteData,
/// types::Zval,
/// };
///
/// pub extern "C" fn example_fn(execute_data: &mut ExecuteData, _: &mut Zval) {
/// let mut x = Arg::new("x", DataType::Long);
/// let mut y = Arg::new("y", DataType::Long);
/// let mut z = Arg::new("z", DataType::Long);
///
/// parse_args!(execute_data, x, y, z);
/// }
/// ```
///
/// This example is similar to the one above, apart from the fact that the `z`
/// argument is not required. Note the semicolon separating the first two
/// arguments from the second.
///
/// ```
/// use ext_php_rs::{
/// parse_args,
/// args::Arg,
/// flags::DataType,
/// zend::ExecuteData,
/// types::Zval,
/// };
///
/// pub extern "C" fn example_fn(execute_data: &mut ExecuteData, _: &mut Zval) {
/// let mut x = Arg::new("x", DataType::Long);
/// let mut y = Arg::new("y", DataType::Long);
/// let mut z = Arg::new("z", DataType::Long);
///
/// parse_args!(execute_data, x, y; z);
/// }
/// ```
///
/// [`ArgParser`]: crate::args::ArgParser
#[macro_export]
macro_rules! parse_args {
($ed: expr, $($arg: expr),*) => {{
let parser = $ed.parser()
$(.arg(&mut $arg))*
.parse();
if parser.is_err() {
return;
}
}};
($ed: expr, $($arg: expr),* ; $($opt: expr),*) => {{
let parser = $ed.parser()
$(.arg(&mut $arg))*
.not_required()
$(.arg(&mut $opt))*
.parse();
if parser.is_err() {
return;
}
}};
}
/// Throws an exception and returns from the current function.
///
/// Wraps the [`throw`] function by inserting a `return` statement after
/// throwing the exception.
///
/// [`throw`]: crate::exception::throw
///
/// # Examples
///
/// ```
/// use ext_php_rs::{
/// throw,
/// zend::{ce, ClassEntry, ExecuteData},
/// types::Zval,
/// };
///
/// pub extern "C" fn example_fn(execute_data: &mut ExecuteData, _: &mut Zval) {
/// let something_wrong = true;
/// if something_wrong {
/// throw!(ce::exception(), "Something is wrong!");
/// }
///
/// assert!(false); // This will not run.
/// }
/// ```
#[macro_export]
macro_rules! throw {
($ex: expr, $reason: expr) => {
$crate::exception::throw($ex, $reason);
return;
};
}
/// Implements a set of traits required to convert types that implement
/// [`RegisteredClass`] to and from [`ZendObject`]s and [`Zval`]s. Generally,
/// this macro should not be called directly, as it is called on any type that
/// uses the [`php_class`] macro.
///
/// The following traits are implemented:
///
/// * `FromZendObject for &'a T`
/// * `FromZendObjectMut for &'a mut T`
/// * `FromZval for &'a T`
/// * `FromZvalMut for &'a mut T`
/// * `IntoZendObject for T`
/// * `IntoZval for T`
///
/// These implementations are required while we wait on the stabilisation of
/// specialisation.
///
/// # Examples
///
/// ```
/// # use ext_php_rs::{convert::{IntoZval, FromZval}, types::{Zval, ZendObject}, class::{RegisteredClass}};
/// use ext_php_rs::class_derives;
///
/// struct Test {
/// a: i32,
/// b: i64
/// }
///
/// impl RegisteredClass for Test {
/// const CLASS_NAME: &'static str = "Test";
///
/// const CONSTRUCTOR: Option<ext_php_rs::class::ConstructorMeta<Self>> = None;
///
/// fn get_metadata() -> &'static ext_php_rs::class::ClassMetadata<Self> {
/// todo!()
/// }
///
/// fn get_properties<'a>(
/// ) -> std::collections::HashMap<&'static str, ext_php_rs::props::Property<'a, Self>>
/// {
/// todo!()
/// }
/// }
///
/// class_derives!(Test);
///
/// fn into_zval_test() -> Zval {
/// let x = Test { a: 5, b: 10 };
/// x.into_zval(false).unwrap()
/// }
///
/// fn from_zval_test<'a>(zv: &'a Zval) -> &'a Test {
/// <&Test>::from_zval(zv).unwrap()
/// }
/// ```
///
/// [`RegisteredClass`]: crate::class::RegisteredClass
/// [`ZendObject`]: crate::types::ZendObject
/// [`Zval`]: crate::types::Zval
/// [`php_class`]: crate::php_class
#[macro_export]
macro_rules! class_derives {
($type: ty) => {
impl<'a> $crate::convert::FromZendObject<'a> for &'a $type {
#[inline]
fn from_zend_object(obj: &'a $crate::types::ZendObject) -> $crate::error::Result<Self> {
let obj = $crate::types::ZendClassObject::<$type>::from_zend_obj(obj)
.ok_or($crate::error::Error::InvalidScope)?;
Ok(&**obj)
}
}
impl<'a> $crate::convert::FromZendObjectMut<'a> for &'a mut $type {
#[inline]
fn from_zend_object_mut(
obj: &'a mut $crate::types::ZendObject,
) -> $crate::error::Result<Self> {
let obj = $crate::types::ZendClassObject::<$type>::from_zend_obj_mut(obj)
.ok_or($crate::error::Error::InvalidScope)?;
Ok(&mut **obj)
}
}
impl<'a> $crate::convert::FromZval<'a> for &'a $type {
const TYPE: $crate::flags::DataType = $crate::flags::DataType::Object(Some(
<$type as $crate::class::RegisteredClass>::CLASS_NAME,
));
#[inline]
fn from_zval(zval: &'a $crate::types::Zval) -> ::std::option::Option<Self> {
<Self as $crate::convert::FromZendObject>::from_zend_object(zval.object()?).ok()
}
}
impl<'a> $crate::convert::FromZvalMut<'a> for &'a mut $type {
const TYPE: $crate::flags::DataType = $crate::flags::DataType::Object(Some(
<$type as $crate::class::RegisteredClass>::CLASS_NAME,
));
#[inline]
fn from_zval_mut(zval: &'a mut $crate::types::Zval) -> ::std::option::Option<Self> {
<Self as $crate::convert::FromZendObjectMut>::from_zend_object_mut(
zval.object_mut()?,
)
.ok()
}
}
impl $crate::convert::IntoZendObject for $type {
#[inline]
fn into_zend_object(
self,
) -> $crate::error::Result<$crate::boxed::ZBox<$crate::types::ZendObject>> {
Ok($crate::types::ZendClassObject::new(self).into())
}
}
impl $crate::convert::IntoZval for $type {
const TYPE: $crate::flags::DataType = $crate::flags::DataType::Object(Some(
<$type as $crate::class::RegisteredClass>::CLASS_NAME,
));
#[inline]
fn set_zval(
self,
zv: &mut $crate::types::Zval,
persistent: bool,
) -> $crate::error::Result<()> {
use $crate::convert::IntoZendObject;
self.into_zend_object()?.set_zval(zv, persistent)
}
}
};
}
/// Derives `From<T> for Zval` and `IntoZval` for a given type.
macro_rules! into_zval {
($type: ty, $fn: ident, $dt: ident) => {
impl From<$type> for $crate::types::Zval {
fn from(val: $type) -> Self {
let mut zv = Self::new();
zv.$fn(val);
zv
}
}
impl $crate::convert::IntoZval for $type {
const TYPE: $crate::flags::DataType = $crate::flags::DataType::$dt;
fn set_zval(self, zv: &mut $crate::types::Zval, _: bool) -> $crate::error::Result<()> {
zv.$fn(self);
Ok(())
}
}
};
}
/// Derives `TryFrom<Zval> for T` and `FromZval for T` on a given type.
macro_rules! try_from_zval {
($type: ty, $fn: ident, $dt: ident) => {
impl $crate::convert::FromZval<'_> for $type {
const TYPE: $crate::flags::DataType = $crate::flags::DataType::$dt;
fn from_zval(zval: &$crate::types::Zval) -> ::std::option::Option<Self> {
use ::std::convert::TryInto;
zval.$fn().and_then(|val| val.try_into().ok())
}
}
impl ::std::convert::TryFrom<$crate::types::Zval> for $type {
type Error = $crate::error::Error;
fn try_from(value: $crate::types::Zval) -> $crate::error::Result<Self> {
<Self as $crate::convert::FromZval>::from_zval(&value)
.ok_or($crate::error::Error::ZvalConversion(value.get_type()))
}
}
};
}
/// Prints to the PHP standard output, without a newline.
///
/// Acts exactly the same as the built-in [`print`] macro.
///
/// # Panics
///
/// Panics if the generated string could not be converted to a `CString` due to
/// `NUL` characters.
#[macro_export]
macro_rules! php_print {
($arg: tt) => {{
$crate::zend::printf($arg).expect("Failed to print to PHP stdout");
}};
($($arg: tt) *) => {{
let args = format!($($arg)*);
$crate::zend::printf(args.as_str()).expect("Failed to print to PHP stdout");
}};
}
/// Prints to the PHP standard output, with a newline.
///
/// The newline is only a newline character regardless of platform (no carriage
/// return).
///
/// Acts exactly the same as the built-in [`println`] macro.
///
/// # Panics
///
/// Panics if the generated string could not be converted to a `CString` due to
/// `NUL` characters.
#[macro_export]
macro_rules! php_println {
() => {
$crate::php_print!("\n");
};
($fmt: tt) => {
$crate::php_print!(concat!($fmt, "\n"));
};
($fmt: tt, $($arg: tt) *) => {
$crate::php_print!(concat!($fmt, "\n"), $($arg)*);
};
}
pub(crate) use into_zval;
pub(crate) use try_from_zval;