19374695739

Committed 14 Nov 2025 06:59PM UTC coverage: 35.363% (+4.3%) from 31.098%

Build # 19374695739

Build Type

push

github

Committed by

web-flow

Commit Message

feat(interface): add support for interfaces

* feat: Add interface bindings

* feat: Add interface builders

* feat(macro): Add macro to declare interface from trait

* feat: Add tests

* feat: Add missing things in interface builder

* feat: Add methods, const registration for interface

* feat: Add tests for interface registration

* chore: Add internal function for interface attribute macros

* feat: Add doc for interface macros and add test for expand

* chore: CI things

* feat: Change const registration for interface

* feat: Rewrite attribute parse

* refactor: Change parser function

* fix: Add path to hashmap

* fix: Fix constant registration for interface

* chore: Add test with default value

* chore: Delete unnecessary impl generation

* feat: Define constructor

* feat: Describe interface classes

* feat: Separate interfaces from classes in module

* feat: Add doc about interface in guide

* chore: Delete unused interface.rs

* chore: Clean from duplicated code

* chore: Fix clippy and etc

* chore: Remove expand test

* test(interface): add macro expansion tests

Refs: #533

* feat(interface): add doc comment support

Refs: #533

* docs(interface): update lib docs

Refs: #533

* test(interface): fix expansion test

Refs: #533

* feat(interface): add support for renaming all consts/methods

Refs: #533

* docs(macro): update lib docs

Refs: #533

---------

Co-authored-by: Xenira <1288524+Xenira@users.noreply.github.com>

Coverage Stats

107 of 175 new or added lines in 9 files covered. (61.14%)

3 existing lines in 2 files now uncovered.

1603 of 4533 relevant lines covered (35.36%)

8.53 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

24.86

/crates/macros/src/function.rs

use std::collections::HashMap;

use darling::{FromAttributes, ToTokens};
use proc_macro2::{Ident, Span, TokenStream};
use quote::{format_ident, quote};
use syn::spanned::Spanned as _;
use syn::{Expr, FnArg, GenericArgument, ItemFn, PatType, PathArguments, Type, TypePath};

use crate::helpers::get_docs;
use crate::parsing::{PhpRename, RenameRule, Visibility};
use crate::prelude::*;
use crate::syn_ext::DropLifetimes;

pub fn wrap(input: &syn::Path) -> Result<TokenStream> {
    let Some(func_name) = input.get_ident() else {
        bail!(input => "Pass a PHP function name into `wrap_function!()`.");
    };
    let builder_func = format_ident!("_internal_{func_name}");

    Ok(quote! {{
        (<#builder_func as ::ext_php_rs::internal::function::PhpFunction>::FUNCTION_ENTRY)()
    }})
}

#[derive(FromAttributes, Default, Debug)]
#[darling(default, attributes(php), forward_attrs(doc))]
struct PhpFunctionAttribute {
    #[darling(flatten)]
    rename: PhpRename,
    defaults: HashMap<Ident, Expr>,
    optional: Option<Ident>,
    vis: Option<Visibility>,
    attrs: Vec<syn::Attribute>,
}

pub fn parser(mut input: ItemFn) -> Result<TokenStream> {
    let php_attr = PhpFunctionAttribute::from_attributes(&input.attrs)?;
    input.attrs.retain(|attr| !attr.path().is_ident("php"));

    let args = Args::parse_from_fnargs(input.sig.inputs.iter(), php_attr.defaults)?;
    if let Some(ReceiverArg { span, .. }) = args.receiver {
        bail!(span => "Receiver arguments are invalid on PHP functions. See `#[php_impl]`.");
    }

    let docs = get_docs(&php_attr.attrs)?;

    let func = Function::new(
        &input.sig,
        php_attr
            .rename
            .rename(input.sig.ident.to_string(), RenameRule::Snake),
        args,
        php_attr.optional,
        docs,
    );
    let function_impl = func.php_function_impl();

    Ok(quote! {
        #input
        #function_impl
    })
}

#[derive(Debug)]
pub struct Function<'a> {
    /// Identifier of the Rust function associated with the function.
    pub ident: &'a Ident,
    /// Name of the function in PHP.
    pub name: String,
    /// Function arguments.
    pub args: Args<'a>,
    /// Function outputs.
    pub output: Option<&'a Type>,
    /// The first optional argument of the function.
    pub optional: Option<Ident>,
    /// Doc comments for the function.
    pub docs: Vec<String>,
}

#[derive(Debug)]
pub enum CallType<'a> {
    Function,
    Method {
        class: &'a syn::Path,
        receiver: MethodReceiver,
    },
}

/// Type of receiver on the method.
#[derive(Debug)]
pub enum MethodReceiver {
    /// Static method - has no receiver.
    Static,
    /// Class method, takes `&self` or `&mut self`.
    Class,
    /// Class method, takes `&mut ZendClassObject<Self>`.
    ZendClassObject,
}

impl<'a> Function<'a> {
    /// Parse a function.
    ///
    /// # Parameters
    ///
    /// * `sig` - Function signature.
    /// * `name` - Function name in PHP land.
    /// * `args` - Function arguments.
    /// * `optional` - The ident of the first optional argument.
    pub fn new(
        sig: &'a syn::Signature,
        name: String,
        args: Args<'a>,
        optional: Option<Ident>,
        docs: Vec<String>,
    ) -> Self {
        Self {
            ident: &sig.ident,
            name,
            args,
            output: match &sig.output {
                syn::ReturnType::Default => None,
                syn::ReturnType::Type(_, ty) => Some(&**ty),
            },
            optional,
            docs,
        }
    }

    /// Generates an internal identifier for the function.
    pub fn internal_ident(&self) -> Ident {
        format_ident!("_internal_{}", &self.ident)
    }

    pub fn abstract_function_builder(&self) -> TokenStream {
        let name = &self.name;
        let (required, not_required) = self.args.split_args(self.optional.as_ref());

        // `entry` impl
        let required_args = required
            .iter()
            .map(TypedArg::arg_builder)
            .collect::<Vec<_>>();
        let not_required_args = not_required
            .iter()
            .map(TypedArg::arg_builder)
            .collect::<Vec<_>>();

        let returns = self.build_returns();
        let docs = if self.docs.is_empty() {
            quote! {}
        } else {
            let docs = &self.docs;
            quote! {
                .docs(&[#(#docs),*])
            }
        };

        quote! {
            ::ext_php_rs::builders::FunctionBuilder::new_abstract(#name)
            #(.arg(#required_args))*
            .not_required()
            #(.arg(#not_required_args))*
            #returns
            #docs
        }
    }

    /// Generates the function builder for the function.
    pub fn function_builder(&self, call_type: CallType) -> TokenStream {
        let name = &self.name;
        let (required, not_required) = self.args.split_args(self.optional.as_ref());

        // `handler` impl
        let arg_declarations = self
            .args
            .typed
            .iter()
            .map(TypedArg::arg_declaration)
            .collect::<Vec<_>>();

        // `entry` impl
        let required_args = required
            .iter()
            .map(TypedArg::arg_builder)
            .collect::<Vec<_>>();
        let not_required_args = not_required
            .iter()
            .map(TypedArg::arg_builder)
            .collect::<Vec<_>>();

        let returns = self.build_returns();
        let result = self.build_result(call_type, required, not_required);
        let docs = if self.docs.is_empty() {
            quote! {}
        } else {
            let docs = &self.docs;
            quote! {
                .docs(&[#(#docs),*])
            }
        };

        quote! {
            ::ext_php_rs::builders::FunctionBuilder::new(#name, {
                ::ext_php_rs::zend_fastcall! {
                    extern fn handler(
                        ex: &mut ::ext_php_rs::zend::ExecuteData,
                        retval: &mut ::ext_php_rs::types::Zval,
                    ) {
                        use ::ext_php_rs::convert::IntoZval;

                        #(#arg_declarations)*
                        let result = {
                            #result
                        };

                        if let Err(e) = result.set_zval(retval, false) {
                            let e: ::ext_php_rs::exception::PhpException = e.into();
                            e.throw().expect("Failed to throw PHP exception.");
                        }
                    }
                }
                handler
            })
            #(.arg(#required_args))*
            .not_required()
            #(.arg(#not_required_args))*
            #returns
            #docs
        }
    }

    fn build_returns(&self) -> Option<TokenStream> {
        self.output.cloned().map(|mut output| {
            output.drop_lifetimes();
            quote! {
                .returns(
                    <#output as ::ext_php_rs::convert::IntoZval>::TYPE,
                    false,
                    <#output as ::ext_php_rs::convert::IntoZval>::NULLABLE,
                )
            }
        })
    }

    fn build_result(
        &self,
        call_type: CallType,
        required: &[TypedArg<'_>],
        not_required: &[TypedArg<'_>],
    ) -> TokenStream {
        let ident = self.ident;
        let required_arg_names: Vec<_> = required.iter().map(|arg| arg.name).collect();
        let not_required_arg_names: Vec<_> = not_required.iter().map(|arg| arg.name).collect();

        let variadic_bindings = self.args.typed.iter().filter_map(|arg| {
            if arg.variadic {
                let name = arg.name;
                let variadic_name = format_ident!("__variadic_{}", name);
                let clean_ty = arg.clean_ty();
                Some(quote! {
                    let #variadic_name = #name.variadic_vals::<#clean_ty>();
                })
            } else {
                None
            }
        });

        let arg_accessors = self.args.typed.iter().map(|arg| {
            arg.accessor(|e| {
                quote! {
                    #e.throw().expect("Failed to throw PHP exception.");
                    return;
                }
            })
        });

        match call_type {
            CallType::Function => quote! {
                let parse = ex.parser()
                    #(.arg(&mut #required_arg_names))*
                    .not_required()
                    #(.arg(&mut #not_required_arg_names))*
                    .parse();
                if parse.is_err() {
                    return;
                }
                #(#variadic_bindings)*

                #ident(#({#arg_accessors}),*)
            },
            CallType::Method { class, receiver } => {
                let this = match receiver {
                    MethodReceiver::Static => quote! {
                        let parse = ex.parser();
                    },
                    MethodReceiver::ZendClassObject | MethodReceiver::Class => quote! {
                        let (parse, this) = ex.parser_method::<#class>();
                        let this = match this {
                            Some(this) => this,
                            None => {
                                ::ext_php_rs::exception::PhpException::default("Failed to retrieve reference to `$this`".into())
                                    .throw()
                                    .unwrap();
                                return;
                            }
                        };
                    },
                };
                let call = match receiver {
                    MethodReceiver::Static => {
                        quote! { #class::#ident(#({#arg_accessors}),*) }
                    }
                    MethodReceiver::Class => quote! { this.#ident(#({#arg_accessors}),*) },
                    MethodReceiver::ZendClassObject => {
                        quote! { #class::#ident(this, #({#arg_accessors}),*) }
                    }
                };
                quote! {
                    #this
                    let parse_result = parse
                        #(.arg(&mut #required_arg_names))*
                        .not_required()
                        #(.arg(&mut #not_required_arg_names))*
                        .parse();
                    if parse_result.is_err() {
                        return;
                    }
                    #(#variadic_bindings)*

                    #call
                }
            }
        }
    }

    /// Generates a struct and impl for the `PhpFunction` trait.
    pub fn php_function_impl(&self) -> TokenStream {
        let internal_ident = self.internal_ident();
        let builder = self.function_builder(CallType::Function);

        quote! {
            #[doc(hidden)]
            #[allow(non_camel_case_types)]
            struct #internal_ident;

            impl ::ext_php_rs::internal::function::PhpFunction for #internal_ident {
                const FUNCTION_ENTRY: fn() -> ::ext_php_rs::builders::FunctionBuilder<'static> = {
                    fn entry() -> ::ext_php_rs::builders::FunctionBuilder<'static>
                    {
                        #builder
                    }
                    entry
                };
            }
        }
    }

    /// Returns a constructor metadata object for this function. This doesn't
    /// check if the function is a constructor, however.
    pub fn constructor_meta(
        &self,
        class: &syn::Path,
        visibility: Option<&Visibility>,
    ) -> TokenStream {
        let ident = self.ident;
        let (required, not_required) = self.args.split_args(self.optional.as_ref());
        let required_args = required
            .iter()
            .map(TypedArg::arg_builder)
            .collect::<Vec<_>>();
        let not_required_args = not_required
            .iter()
            .map(TypedArg::arg_builder)
            .collect::<Vec<_>>();

        let required_arg_names: Vec<_> = required.iter().map(|arg| arg.name).collect();
        let not_required_arg_names: Vec<_> = not_required.iter().map(|arg| arg.name).collect();
        let arg_declarations = self
            .args
            .typed
            .iter()
            .map(TypedArg::arg_declaration)
            .collect::<Vec<_>>();
        let variadic_bindings = self.args.typed.iter().filter_map(|arg| {
            if arg.variadic {
                let name = arg.name;
                let variadic_name = format_ident!("__variadic_{}", name);
                let clean_ty = arg.clean_ty();
                Some(quote! {
                    let #variadic_name = #name.variadic_vals::<#clean_ty>();
                })
            } else {
                None
            }
        });
        let arg_accessors = self.args.typed.iter().map(|arg| {
            arg.accessor(
                |e| quote! { return ::ext_php_rs::class::ConstructorResult::Exception(#e); },
            )
        });
        let variadic = self.args.typed.iter().any(|arg| arg.variadic).then(|| {
            quote! {
                .variadic()
            }
        });
        let docs = &self.docs;
        let flags = visibility.option_tokens();

        quote! {
            ::ext_php_rs::class::ConstructorMeta {
                constructor: {
                    fn inner(ex: &mut ::ext_php_rs::zend::ExecuteData) -> ::ext_php_rs::class::ConstructorResult<#class> {
                        #(#arg_declarations)*
                        let parse = ex.parser()
                            #(.arg(&mut #required_arg_names))*
                            .not_required()
                            #(.arg(&mut #not_required_arg_names))*
                            #variadic
                            .parse();
                        if parse.is_err() {
                            return ::ext_php_rs::class::ConstructorResult::ArgError;
                        }
                        #(#variadic_bindings)*
                        #class::#ident(#({#arg_accessors}),*).into()
                    }
                    inner
                },
                build_fn: {
                    fn inner(func: ::ext_php_rs::builders::FunctionBuilder) -> ::ext_php_rs::builders::FunctionBuilder {
                        func
                            .docs(&[#(#docs),*])
                            #(.arg(#required_args))*
                            .not_required()
                            #(.arg(#not_required_args))*
                            #variadic
                    }
                    inner
                },
                flags: #flags
            }
        }
    }
}

#[derive(Debug)]
pub struct ReceiverArg {
    pub _mutable: bool,
    pub span: Span,
}

#[derive(Debug)]
pub struct TypedArg<'a> {
    pub name: &'a Ident,
    pub ty: Type,
    pub nullable: bool,
    pub default: Option<Expr>,
    pub as_ref: bool,
    pub variadic: bool,
}

#[derive(Debug)]
pub struct Args<'a> {
    pub receiver: Option<ReceiverArg>,
    pub typed: Vec<TypedArg<'a>>,
}

impl<'a> Args<'a> {
    pub fn parse_from_fnargs(
        args: impl Iterator<Item = &'a FnArg>,
        mut defaults: HashMap<Ident, Expr>,
    ) -> Result<Self> {
        let mut result = Self {
            receiver: None,
            typed: vec![],
        };
        for arg in args {
            match arg {
                FnArg::Receiver(receiver) => {
                    if receiver.reference.is_none() {
                        bail!(receiver => "PHP objects are heap-allocated and cannot be passed by value. Try using `&self` or `&mut self`.");
                    } else if result.receiver.is_some() {
                        bail!(receiver => "Too many receivers specified.")
                    }
                    result.receiver.replace(ReceiverArg {
                        _mutable: receiver.mutability.is_some(),
                        span: receiver.span(),
                    });
                }
                FnArg::Typed(PatType { pat, ty, .. }) => {
                    let syn::Pat::Ident(syn::PatIdent { ident, .. }) = &**pat else {
                        bail!(pat => "Unsupported argument.");
                    };

                    // If the variable is `&[&Zval]` treat it as the variadic argument.
                    let default = defaults.remove(ident);
                    let nullable = type_is_nullable(ty.as_ref(), default.is_some())?;
                    let (variadic, as_ref, ty) = Self::parse_typed(ty);
                    result.typed.push(TypedArg {
                        name: ident,
                        ty,
                        nullable,
                        default,
                        as_ref,
                        variadic,
                    });
                }
            }
        }
        Ok(result)
    }

    fn parse_typed(ty: &Type) -> (bool, bool, Type) {
        match ty {
            Type::Reference(ref_) => {
                let as_ref = ref_.mutability.is_some();
                match ref_.elem.as_ref() {
                    Type::Slice(slice) => (
                        // TODO: Allow specifying the variadic type.
                        slice.elem.to_token_stream().to_string() == "& Zval",
                        as_ref,
                        ty.clone(),
                    ),
                    _ => (false, as_ref, ty.clone()),
                }
            }
            Type::Path(TypePath { path, .. }) => {
                let mut as_ref = false;

                // For for types that are `Option<&mut T>` to turn them into
                // `Option<&T>`, marking the Arg as as "passed by reference".
                let ty = path
                    .segments
                    .last()
                    .filter(|seg| seg.ident == "Option")
                    .and_then(|seg| {
                        if let PathArguments::AngleBracketed(args) = &seg.arguments {
                            args.args
                                .iter()
                                .find(|arg| matches!(arg, GenericArgument::Type(_)))
                                .and_then(|ga| match ga {
                                    GenericArgument::Type(ty) => Some(match ty {
                                        Type::Reference(r) => {
                                            let mut new_ref = r.clone();
                                            new_ref.mutability = None;
                                            as_ref = true;
                                            Type::Reference(new_ref)
                                        }
                                        _ => ty.clone(),
                                    }),
                                    _ => None,
                                })
                        } else {
                            None
                        }
                    })
                    .unwrap_or_else(|| ty.clone());
                (false, as_ref, ty.clone())
            }
            _ => (false, false, ty.clone()),
        }
    }

    /// Splits the typed arguments into two slices:
    ///
    /// 1. Required arguments.
    /// 2. Non-required arguments.
    ///
    /// # Parameters
    ///
    /// * `optional` - The first optional argument. If [`None`], the optional
    ///   arguments will be from the first nullable argument after the last
    ///   non-nullable argument to the end of the arguments.
    pub fn split_args(&self, optional: Option<&Ident>) -> (&[TypedArg<'a>], &[TypedArg<'a>]) {
        let mut mid = None;
        for (i, arg) in self.typed.iter().enumerate() {
            if let Some(optional) = optional {
                if optional == arg.name {
                    mid.replace(i);
                }
            } else if mid.is_none() && arg.nullable {
                mid.replace(i);
            } else if !arg.nullable {
                mid.take();
            }
        }
        match mid {
            Some(mid) => (&self.typed[..mid], &self.typed[mid..]),
            None => (&self.typed[..], &self.typed[0..0]),
        }
    }
}

impl TypedArg<'_> {
    /// Returns a 'clean type' with the lifetimes removed. This allows the type
    /// to be used outside of the original function context.
    fn clean_ty(&self) -> Type {
        let mut ty = self.ty.clone();
        ty.drop_lifetimes();

        // Variadic arguments are passed as &[&Zval], so we need to extract the
        // inner type.
        if self.variadic {
            let Type::Reference(reference) = &ty else {
                return ty;
            };

            if let Type::Slice(inner) = &*reference.elem {
                return *inner.elem.clone();
            }
        }

        ty
    }

    /// Returns a token stream containing an argument declaration, where the
    /// name of the variable holding the arg is the name of the argument.
    fn arg_declaration(&self) -> TokenStream {
        let name = self.name;
        let val = self.arg_builder();
        quote! {
            let mut #name = #val;
        }
    }

    /// Returns a token stream containing the `Arg` definition to be passed to
    /// `ext-php-rs`.
    fn arg_builder(&self) -> TokenStream {
        let name = self.name.to_string();
        let ty = self.clean_ty();
        let null = if self.nullable {
            Some(quote! { .allow_null() })
        } else {
            None
        };
        let default = self.default.as_ref().map(|val| {
            let val = val.to_token_stream().to_string();
            quote! {
                .default(#val)
            }
        });
        let as_ref = if self.as_ref {
            Some(quote! { .as_ref() })
        } else {
            None
        };
        let variadic = self.variadic.then(|| quote! { .is_variadic() });
        quote! {
            ::ext_php_rs::args::Arg::new(#name, <#ty as ::ext_php_rs::convert::FromZvalMut>::TYPE)
                #null
                #default
                #as_ref
                #variadic
        }
    }

    /// Get the accessor used to access the value of the argument.
    fn accessor(&self, bail_fn: impl Fn(TokenStream) -> TokenStream) -> TokenStream {
        let name = self.name;
        if let Some(default) = &self.default {
            quote! {
                #name.val().unwrap_or(#default.into())
            }
        } else if self.variadic {
            let variadic_name = format_ident!("__variadic_{}", name);
            quote! {
                #variadic_name.as_slice()
            }
        } else if self.nullable {
            // Originally I thought we could just use the below case for `null` options, as
            // `val()` will return `Option<Option<T>>`, however, this isn't the case when
            // the argument isn't given, as the underlying zval is null.
            quote! {
                #name.val()
            }
        } else {
            let bail = bail_fn(quote! {
                ::ext_php_rs::exception::PhpException::default(
                    concat!("Invalid value given for argument `", stringify!(#name), "`.").into()
                )
            });
            quote! {
                match #name.val() {
                    Some(val) => val,
                    None => {
                        #bail;
                    }
                }
            }
        }
    }
}

/// Returns true of the given type is nullable in PHP.
// TODO(david): Eventually move to compile-time constants for this (similar to
// FromZval::NULLABLE).
pub fn type_is_nullable(ty: &Type, has_default: bool) -> Result<bool> {
    Ok(match ty {
        syn::Type::Path(path) => {
            has_default
                || path
                    .path
                    .segments
                    .iter()
                    .next_back()
                    .is_some_and(|seg| seg.ident == "Option")
        }
        syn::Type::Reference(_) => false, /* Reference cannot be nullable unless */
        // wrapped in `Option` (in that case it'd be a Path).
        _ => bail!(ty => "Unsupported argument type."),
    })
}

1	use std::collections::HashMap;
2
3	use darling::{FromAttributes, ToTokens};
4	use proc_macro2::{Ident, Span, TokenStream};
5	use quote::{format_ident, quote};
6	use syn::spanned::Spanned as _;
7	use syn::{Expr, FnArg, GenericArgument, ItemFn, PatType, PathArguments, Type, TypePath};
8
9	use crate::helpers::get_docs;
10	use crate::parsing::{PhpRename, RenameRule, Visibility};
11	use crate::prelude::*;
12	use crate::syn_ext::DropLifetimes;
13
14	pub fn wrap(input: &syn::Path) -> Result<TokenStream> {	×
15	let Some(func_name) = input.get_ident() else {	×
16	bail!(input => "Pass a PHP function name into `wrap_function!()`.");	×
17	};
18	let builder_func = format_ident!("_internal_{func_name}");	×
19
20	Ok(quote! {{	×
21	(<#builder_func as ::ext_php_rs::internal::function::PhpFunction>::FUNCTION_ENTRY)()	×
22	}})
23	}
24
25	#[derive(FromAttributes, Default, Debug)]
26	#[darling(default, attributes(php), forward_attrs(doc))]
27	struct PhpFunctionAttribute {
28	#[darling(flatten)]
29	rename: PhpRename,
30	defaults: HashMap<Ident, Expr>,
31	optional: Option<Ident>,
32	vis: Option<Visibility>,
33	attrs: Vec<syn::Attribute>,
34	}
35
36	pub fn parser(mut input: ItemFn) -> Result<TokenStream> {	×
37	let php_attr = PhpFunctionAttribute::from_attributes(&input.attrs)?;	×
38	input.attrs.retain(\|attr\| !attr.path().is_ident("php"));	×
39
40	let args = Args::parse_from_fnargs(input.sig.inputs.iter(), php_attr.defaults)?;	×
41	if let Some(ReceiverArg { span, .. }) = args.receiver {	×
42	bail!(span => "Receiver arguments are invalid on PHP functions. See `#[php_impl]`.");	×
43	}
44
45	let docs = get_docs(&php_attr.attrs)?;	×
46
47	let func = Function::new(
48	&input.sig,	×
49	php_attr	×
50	.rename	×
51	.rename(input.sig.ident.to_string(), RenameRule::Snake),	×
52	args,	×
53	php_attr.optional,	×
54	docs,	×
55	);
56	let function_impl = func.php_function_impl();	×
57
58	Ok(quote! {	×
59	#input	×
60	#function_impl	×
61	})
62	}
63
64	#[derive(Debug)]
65	pub struct Function<'a> {
66	/// Identifier of the Rust function associated with the function.
67	pub ident: &'a Ident,
68	/// Name of the function in PHP.
69	pub name: String,
70	/// Function arguments.
71	pub args: Args<'a>,
72	/// Function outputs.
73	pub output: Option<&'a Type>,
74	/// The first optional argument of the function.
75	pub optional: Option<Ident>,
76	/// Doc comments for the function.
77	pub docs: Vec<String>,
78	}
79
80	#[derive(Debug)]
81	pub enum CallType<'a> {
82	Function,
83	Method {
84	class: &'a syn::Path,
85	receiver: MethodReceiver,
86	},
87	}
88
89	/// Type of receiver on the method.
90	#[derive(Debug)]
91	pub enum MethodReceiver {
92	/// Static method - has no receiver.
93	Static,
94	/// Class method, takes `&self` or `&mut self`.
95	Class,
96	/// Class method, takes `&mut ZendClassObject<Self>`.
97	ZendClassObject,
98	}
99
100	impl<'a> Function<'a> {
101	/// Parse a function.
102	///
103	/// # Parameters
104	///
105	/// * `sig` - Function signature.
106	/// * `name` - Function name in PHP land.
107	/// * `args` - Function arguments.
108	/// * `optional` - The ident of the first optional argument.
109	pub fn new(	3✔
110	sig: &'a syn::Signature,
111	name: String,
112	args: Args<'a>,
113	optional: Option<Ident>,
114	docs: Vec<String>,
115	) -> Self {
116	Self {
117	ident: &sig.ident,	3✔
118	name,
119	args,
120	output: match &sig.output {	3✔
121	syn::ReturnType::Default => None,
122	syn::ReturnType::Type(_, ty) => Some(&**ty),
123	},
124	optional,
125	docs,
126	}
127	}
128
129	/// Generates an internal identifier for the function.
130	pub fn internal_ident(&self) -> Ident {	×
131	format_ident!("_internal_{}", &self.ident)	×
132	}
133
134	pub fn abstract_function_builder(&self) -> TokenStream {	3✔
135	let name = &self.name;	6✔
136	let (required, not_required) = self.args.split_args(self.optional.as_ref());	15✔
137
138	// `entry` impl
139	let required_args = required	6✔
140	.iter()
141	.map(TypedArg::arg_builder)	3✔
142	.collect::<Vec<_>>();
143	let not_required_args = not_required	6✔
144	.iter()
145	.map(TypedArg::arg_builder)	3✔
146	.collect::<Vec<_>>();
147
148	let returns = self.build_returns();	9✔
149	let docs = if self.docs.is_empty() {	9✔
150	quote! {}	2✔
151	} else {
152	let docs = &self.docs;	2✔
153	quote! {	1✔
NEW 154	.docs(&[#(#docs),*])	×
155	}
156	};
157
158	quote! {	3✔
NEW 159	::ext_php_rs::builders::FunctionBuilder::new_abstract(#name)	×
NEW 160	#(.arg(#required_args))*	×
NEW 161	.not_required()	×
NEW 162	#(.arg(#not_required_args))*	×
NEW 163	#returns	×
NEW 164	#docs	×
165	}
166	}
167
168	/// Generates the function builder for the function.
169	pub fn function_builder(&self, call_type: CallType) -> TokenStream {	×
170	let name = &self.name;	×
171	let (required, not_required) = self.args.split_args(self.optional.as_ref());	×
172
173	// `handler` impl
174	let arg_declarations = self	×
175	.args	×
176	.typed	×
177	.iter()
178	.map(TypedArg::arg_declaration)	×
179	.collect::<Vec<_>>();
180
181	// `entry` impl
182	let required_args = required	×
183	.iter()
184	.map(TypedArg::arg_builder)	×
185	.collect::<Vec<_>>();
186	let not_required_args = not_required	×
187	.iter()
188	.map(TypedArg::arg_builder)	×
189	.collect::<Vec<_>>();
190
191	let returns = self.build_returns();	×
192	let result = self.build_result(call_type, required, not_required);	×
193	let docs = if self.docs.is_empty() {	×
194	quote! {}	×
195	} else {
196	let docs = &self.docs;	×
197	quote! {	×
198	.docs(&[#(#docs),*])	×
199	}
200	};
201
202	quote! {	×
203	::ext_php_rs::builders::FunctionBuilder::new(#name, {	×
204	::ext_php_rs::zend_fastcall! {	×
205	extern fn handler(	×
206	ex: &mut ::ext_php_rs::zend::ExecuteData,	×
207	retval: &mut ::ext_php_rs::types::Zval,	×
208	) {
209	use ::ext_php_rs::convert::IntoZval;	×
210
211	#(#arg_declarations)*	×
212	let result = {	×
213	#result	×
214	};
215
216	if let Err(e) = result.set_zval(retval, false) {	×
217	let e: ::ext_php_rs::exception::PhpException = e.into();	×
218	e.throw().expect("Failed to throw PHP exception.");	×
219	}
220	}
221	}
222	handler	×
223	})
224	#(.arg(#required_args))*	×
225	.not_required()	×
226	#(.arg(#not_required_args))*	×
227	#returns	×
228	#docs	×
229	}
230	}
231
232	fn build_returns(&self) -> Option<TokenStream> {	3✔
233	self.output.cloned().map(\|mut output\| {	12✔
234	output.drop_lifetimes();	6✔
235	quote! {	3✔
236	.returns(	×
237	<#output as ::ext_php_rs::convert::IntoZval>::TYPE,	×
238	false,	×
239	<#output as ::ext_php_rs::convert::IntoZval>::NULLABLE,	×
240	)
241	}
242	})
243	}
244
245	fn build_result(	×
246	&self,
247	call_type: CallType,
248	required: &[TypedArg<'_>],
249	not_required: &[TypedArg<'_>],
250	) -> TokenStream {
251	let ident = self.ident;	×
252	let required_arg_names: Vec<_> = required.iter().map(\|arg\| arg.name).collect();	×
253	let not_required_arg_names: Vec<_> = not_required.iter().map(\|arg\| arg.name).collect();	×
254
255	let variadic_bindings = self.args.typed.iter().filter_map(\|arg\| {	×
256	if arg.variadic {	×
257	let name = arg.name;	×
258	let variadic_name = format_ident!("__variadic_{}", name);	×
259	let clean_ty = arg.clean_ty();	×
260	Some(quote! {	×
261	let #variadic_name = #name.variadic_vals::<#clean_ty>();	×
262	})
263	} else {
264	None	×
265	}
266	});
267
268	let arg_accessors = self.args.typed.iter().map(\|arg\| {	×
269	arg.accessor(\|e\| {	×
270	quote! {	×
271	#e.throw().expect("Failed to throw PHP exception.");	×
272	return;	×
273	}
274	})
275	});
276
277	match call_type {	×
278	CallType::Function => quote! {	×
279	let parse = ex.parser()	×
280	#(.arg(&mut #required_arg_names))*	×
281	.not_required()	×
282	#(.arg(&mut #not_required_arg_names))*	×
283	.parse();	×
284	if parse.is_err() {	×
285	return;	×
286	}
287	#(#variadic_bindings)*	×
288
289	#ident(#({#arg_accessors}),*)	×
290	},
291	CallType::Method { class, receiver } => {	×
292	let this = match receiver {	×
293	MethodReceiver::Static => quote! {	×
294	let parse = ex.parser();	×
295	},
296	MethodReceiver::ZendClassObject \| MethodReceiver::Class => quote! {	×
297	let (parse, this) = ex.parser_method::<#class>();	×
298	let this = match this {	×
299	Some(this) => this,	×
300	None => {	×
301	::ext_php_rs::exception::PhpException::default("Failed to retrieve reference to `$this`".into())	×
302	.throw()	×
303	.unwrap();	×
304	return;	×
305	}
306	};
307	},
308	};
309	let call = match receiver {	×
310	MethodReceiver::Static => {	×
311	quote! { #class::#ident(#({#arg_accessors}),*) }	×
312	}
313	MethodReceiver::Class => quote! { this.#ident(#({#arg_accessors}),*) },	×
314	MethodReceiver::ZendClassObject => {	×
315	quote! { #class::#ident(this, #({#arg_accessors}),*) }	×
316	}
317	};
318	quote! {	×
319	#this	×
320	let parse_result = parse	×
321	#(.arg(&mut #required_arg_names))*	×
322	.not_required()	×
323	#(.arg(&mut #not_required_arg_names))*	×
324	.parse();	×
325	if parse_result.is_err() {	×
326	return;	×
327	}
328	#(#variadic_bindings)*	×
329
330	#call	×
331	}
332	}
333	}
334	}
335
336	/// Generates a struct and impl for the `PhpFunction` trait.
337	pub fn php_function_impl(&self) -> TokenStream {	×
338	let internal_ident = self.internal_ident();	×
339	let builder = self.function_builder(CallType::Function);	×
340
341	quote! {	×
342	#[doc(hidden)]	×
343	#[allow(non_camel_case_types)]	×
344	struct #internal_ident;	×
345
346	impl ::ext_php_rs::internal::function::PhpFunction for #internal_ident {	×
347	const FUNCTION_ENTRY: fn() -> ::ext_php_rs::builders::FunctionBuilder<'static> = {	×
348	fn entry() -> ::ext_php_rs::builders::FunctionBuilder<'static>	×
349	{
350	#builder	×
351	}
352	entry	×
353	};
354	}
355	}
356	}
357
358	/// Returns a constructor metadata object for this function. This doesn't
359	/// check if the function is a constructor, however.
360	pub fn constructor_meta(	×
361	&self,
362	class: &syn::Path,
363	visibility: Option<&Visibility>,
364	) -> TokenStream {
365	let ident = self.ident;	×
366	let (required, not_required) = self.args.split_args(self.optional.as_ref());	×
367	let required_args = required	×
368	.iter()
369	.map(TypedArg::arg_builder)	×
370	.collect::<Vec<_>>();
371	let not_required_args = not_required	×
372	.iter()
373	.map(TypedArg::arg_builder)	×
374	.collect::<Vec<_>>();
375
376	let required_arg_names: Vec<_> = required.iter().map(\|arg\| arg.name).collect();	×
377	let not_required_arg_names: Vec<_> = not_required.iter().map(\|arg\| arg.name).collect();	×
378	let arg_declarations = self	×
379	.args	×
380	.typed	×
381	.iter()
382	.map(TypedArg::arg_declaration)	×
383	.collect::<Vec<_>>();
384	let variadic_bindings = self.args.typed.iter().filter_map(\|arg\| {	×
385	if arg.variadic {	×
386	let name = arg.name;	×
387	let variadic_name = format_ident!("__variadic_{}", name);	×
388	let clean_ty = arg.clean_ty();	×
389	Some(quote! {	×
390	let #variadic_name = #name.variadic_vals::<#clean_ty>();	×
391	})
392	} else {
393	None	×
394	}
395	});
396	let arg_accessors = self.args.typed.iter().map(\|arg\| {	×
397	arg.accessor(	×
398	\|e\| quote! { return ::ext_php_rs::class::ConstructorResult::Exception(#e); },	×
399	)
400	});
401	let variadic = self.args.typed.iter().any(\|arg\| arg.variadic).then(\|\| {	×
402	quote! {	×
403	.variadic()	×
404	}
405	});
406	let docs = &self.docs;	×
407	let flags = visibility.option_tokens();	×
408
409	quote! {	×
410	::ext_php_rs::class::ConstructorMeta {	×
411	constructor: {	×
412	fn inner(ex: &mut ::ext_php_rs::zend::ExecuteData) -> ::ext_php_rs::class::ConstructorResult<#class> {	×
413	#(#arg_declarations)*	×
414	let parse = ex.parser()	×
415	#(.arg(&mut #required_arg_names))*	×
416	.not_required()	×
417	#(.arg(&mut #not_required_arg_names))*	×
418	#variadic	×
419	.parse();	×
420	if parse.is_err() {	×
421	return ::ext_php_rs::class::ConstructorResult::ArgError;	×
422	}
423	#(#variadic_bindings)*	×
424	#class::#ident(#({#arg_accessors}),*).into()	×
425	}
426	inner	×
427	},
428	build_fn: {	×
429	fn inner(func: ::ext_php_rs::builders::FunctionBuilder) -> ::ext_php_rs::builders::FunctionBuilder {	×
430	func	×
431	.docs(&[#(#docs),*])	×
432	#(.arg(#required_args))*	×
433	.not_required()	×
434	#(.arg(#not_required_args))*	×
435	#variadic	×
436	}
437	inner	×
438	},
439	flags: #flags	×
440	}
441	}
442	}
443	}
444
445	#[derive(Debug)]
446	pub struct ReceiverArg {
447	pub _mutable: bool,
448	pub span: Span,
449	}
450
451	#[derive(Debug)]
452	pub struct TypedArg<'a> {
453	pub name: &'a Ident,
454	pub ty: Type,
455	pub nullable: bool,
456	pub default: Option<Expr>,
457	pub as_ref: bool,
458	pub variadic: bool,
459	}
460
461	#[derive(Debug)]
462	pub struct Args<'a> {
463	pub receiver: Option<ReceiverArg>,
464	pub typed: Vec<TypedArg<'a>>,
465	}
466
467	impl<'a> Args<'a> {
468	pub fn parse_from_fnargs(	3✔
469	args: impl Iterator<Item = &'a FnArg>,
470	mut defaults: HashMap<Ident, Expr>,
471	) -> Result<Self> {
472	let mut result = Self {
473	receiver: None,
474	typed: vec![],	3✔
475	};
476	for arg in args {	13✔
477	match arg {	5✔
478	FnArg::Receiver(receiver) => {	3✔
479	if receiver.reference.is_none() {	6✔
480	bail!(receiver => "PHP objects are heap-allocated and cannot be passed by value. Try using `&self` or `&mut self`.");	×
481	} else if result.receiver.is_some() {	6✔
482	bail!(receiver => "Too many receivers specified.")	×
483	}
484	result.receiver.replace(ReceiverArg {	9✔
485	_mutable: receiver.mutability.is_some(),	9✔
486	span: receiver.span(),	3✔
487	});
488	}
489	FnArg::Typed(PatType { pat, ty, .. }) => {	4✔
490	let syn::Pat::Ident(syn::PatIdent { ident, .. }) = &**pat else {	4✔
491	bail!(pat => "Unsupported argument.");	×
492	};
493
494	// If the variable is `&[&Zval]` treat it as the variadic argument.
495	let default = defaults.remove(ident);	8✔
496	let nullable = type_is_nullable(ty.as_ref(), default.is_some())?;	10✔
497	let (variadic, as_ref, ty) = Self::parse_typed(ty);	8✔
498	result.typed.push(TypedArg {	6✔
499	name: ident,	4✔
500	ty,	4✔
501	nullable,	4✔
502	default,	4✔
503	as_ref,	2✔
504	variadic,	2✔
505	});
506	}
507	}
508	}
509	Ok(result)	3✔
510	}
511
512	fn parse_typed(ty: &Type) -> (bool, bool, Type) {	2✔
513	match ty {	2✔
514	Type::Reference(ref_) => {	×
515	let as_ref = ref_.mutability.is_some();	×
516	match ref_.elem.as_ref() {	×
517	Type::Slice(slice) => (	×
518	// TODO: Allow specifying the variadic type.
519	slice.elem.to_token_stream().to_string() == "& Zval",	×
520	as_ref,	×
521	ty.clone(),	×
522	),
523	_ => (false, as_ref, ty.clone()),	×
524	}
525	}
526	Type::Path(TypePath { path, .. }) => {	2✔
527	let mut as_ref = false;	4✔
528
529	// For for types that are `Option<&mut T>` to turn them into
530	// `Option<&T>`, marking the Arg as as "passed by reference".
531	let ty = path	4✔
532	.segments	2✔
533	.last()
534	.filter(\|seg\| seg.ident == "Option")	6✔
535	.and_then(\|seg\| {	2✔
536	if let PathArguments::AngleBracketed(args) = &seg.arguments {	×
537	args.args	×
538	.iter()	×
539	.find(\|arg\| matches!(arg, GenericArgument::Type(_)))	×
540	.and_then(\|ga\| match ga {	×
541	GenericArgument::Type(ty) => Some(match ty {	×
542	Type::Reference(r) => {	×
543	let mut new_ref = r.clone();	×
544	new_ref.mutability = None;	×
545	as_ref = true;	×
546	Type::Reference(new_ref)	×
547	}
548	_ => ty.clone(),	×
549	}),
550	_ => None,	×
551	})
552	} else {
553	None	×
554	}
555	})
556	.unwrap_or_else(\|\| ty.clone());	6✔
557	(false, as_ref, ty.clone())	4✔
558	}
559	_ => (false, false, ty.clone()),	×
560	}
561	}
562
563	/// Splits the typed arguments into two slices:
564	///
565	/// 1. Required arguments.
566	/// 2. Non-required arguments.
567	///
568	/// # Parameters
569	///
570	/// * `optional` - The first optional argument. If [`None`], the optional
571	/// arguments will be from the first nullable argument after the last
572	/// non-nullable argument to the end of the arguments.
573	pub fn split_args(&self, optional: Option<&Ident>) -> (&[TypedArg<'a>], &[TypedArg<'a>]) {	3✔
574	let mut mid = None;	6✔
575	for (i, arg) in self.typed.iter().enumerate() {	10✔
576	if let Some(optional) = optional {	2✔
577	if optional == arg.name {	×
578	mid.replace(i);	×
579	}
580	} else if mid.is_none() && arg.nullable {	6✔
581	mid.replace(i);	×
582	} else if !arg.nullable {	4✔
583	mid.take();	2✔
584	}
585	}
586	match mid {	3✔
587	Some(mid) => (&self.typed[..mid], &self.typed[mid..]),	×
588	None => (&self.typed[..], &self.typed[0..0]),	6✔
589	}
590	}
591	}
592
593	impl TypedArg<'_> {
594	/// Returns a 'clean type' with the lifetimes removed. This allows the type
595	/// to be used outside of the original function context.
596	fn clean_ty(&self) -> Type {	2✔
597	let mut ty = self.ty.clone();	6✔
598	ty.drop_lifetimes();	4✔
599
600	// Variadic arguments are passed as &[&Zval], so we need to extract the
601	// inner type.
602	if self.variadic {	2✔
603	let Type::Reference(reference) = &ty else {	×
604	return ty;	×
605	};
606
607	if let Type::Slice(inner) = &*reference.elem {	×
608	return *inner.elem.clone();	×
609	}
610	}
611
612	ty	2✔
613	}
614
615	/// Returns a token stream containing an argument declaration, where the
616	/// name of the variable holding the arg is the name of the argument.
617	fn arg_declaration(&self) -> TokenStream {	×
618	let name = self.name;	×
619	let val = self.arg_builder();	×
620	quote! {	×
621	let mut #name = #val;
622	}
623	}
624
625	/// Returns a token stream containing the `Arg` definition to be passed to
626	/// `ext-php-rs`.
627	fn arg_builder(&self) -> TokenStream {	2✔
628	let name = self.name.to_string();	6✔
629	let ty = self.clean_ty();	6✔
630	let null = if self.nullable {	4✔
631	Some(quote! { .allow_null() })	×
632	} else {
633	None	2✔
634	};
635	let default = self.default.as_ref().map(\|val\| {	8✔
636	let val = val.to_token_stream().to_string();	×
637	quote! {	×
638	.default(#val)
639	}
640	});
641	let as_ref = if self.as_ref {	4✔
642	Some(quote! { .as_ref() })	×
643	} else {
644	None	2✔
645	};
646	let variadic = self.variadic.then(\|\| quote! { .is_variadic() });	6✔
647	quote! {	2✔
648	::ext_php_rs::args::Arg::new(#name, <#ty as ::ext_php_rs::convert::FromZvalMut>::TYPE)
649	#null
650	#default
651	#as_ref
652	#variadic
653	}
654	}
655
656	/// Get the accessor used to access the value of the argument.
657	fn accessor(&self, bail_fn: impl Fn(TokenStream) -> TokenStream) -> TokenStream {	×
658	let name = self.name;	×
659	if let Some(default) = &self.default {	×
660	quote! {	×
661	#name.val().unwrap_or(#default.into())	×
662	}
663	} else if self.variadic {	×
664	let variadic_name = format_ident!("__variadic_{}", name);	×
665	quote! {	×
666	#variadic_name.as_slice()	×
667	}
668	} else if self.nullable {	×
669	// Originally I thought we could just use the below case for `null` options, as
670	// `val()` will return `Option<Option<T>>`, however, this isn't the case when
671	// the argument isn't given, as the underlying zval is null.
672	quote! {	×
673	#name.val()	×
674	}
675	} else {
676	let bail = bail_fn(quote! {	×
677	::ext_php_rs::exception::PhpException::default(	×
678	concat!("Invalid value given for argument `", stringify!(#name), "`.").into()	×
679	)
680	});
681	quote! {	×
682	match #name.val() {	×
683	Some(val) => val,	×
684	None => {	×
685	#bail;	×
686	}
687	}
688	}
689	}
690	}
691	}
692
693	/// Returns true of the given type is nullable in PHP.
694	// TODO(david): Eventually move to compile-time constants for this (similar to
695	// FromZval::NULLABLE).
696	pub fn type_is_nullable(ty: &Type, has_default: bool) -> Result<bool> {	2✔
697	Ok(match ty {	2✔
698	syn::Type::Path(path) => {	2✔
699	has_default	2✔
700	\|\| path	2✔
701	.path	2✔
702	.segments	2✔
703	.iter()	2✔
704	.next_back()	2✔
705	.is_some_and(\|seg\| seg.ident == "Option")	6✔
706	}
707	syn::Type::Reference(_) => false, /* Reference cannot be nullable unless */	×
708	// wrapped in `Option` (in that case it'd be a Path).
709	_ => bail!(ty => "Unsupported argument type."),	×
710	})
711	}

extphprs / ext-php-rs / 19374695739

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous