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 <[email protected]>

Author: Norbytus

allowed_bindings.rs

@@ -118,6 +118,7 @@ bind! {
     zend_register_double_constant,
     zend_register_ini_entries,
     zend_register_internal_enum,
+    zend_register_internal_interface,
     zend_ini_entry_def,
     zend_register_internal_class_ex,
     zend_register_long_constant,

crates/macros/src/class.rs

@@ -1,7 +1,7 @@
 use darling::util::Flag;
 use darling::{FromAttributes, FromMeta, ToTokens};
 use proc_macro2::TokenStream;
-use quote::quote;
+use quote::{TokenStreamExt, quote};
 use syn::{Attribute, Expr, Fields, ItemStruct};
 
 use crate::helpers::get_docs;
@@ -28,8 +28,17 @@ pub struct StructAttributes {
 
 #[derive(FromMeta, Debug)]
 pub struct ClassEntryAttribute {
-    ce: syn::Expr,
-    stub: String,
+    pub ce: syn::Expr,
+    pub stub: String,
+}
+
+impl ToTokens for ClassEntryAttribute {
+    fn to_tokens(&self, tokens: &mut TokenStream) {
+        let ce = &self.ce;
+        let stub = &self.stub;
+        let token = quote! { (#ce, #stub) };
+        tokens.append_all(token);
+    }
 }
 
 pub fn parser(mut input: ItemStruct) -> Result<TokenStream> {
@@ -151,10 +160,8 @@ fn generate_registered_class_impl(
     };
 
     let extends = if let Some(extends) = extends {
-        let ce = &extends.ce;
-        let stub = &extends.stub;
         quote! {
-            Some((#ce, #stub))
+            Some(#extends)
         }
     } else {
         quote! { None }

crates/macros/src/function.rs

@@ -131,6 +131,40 @@ impl<'a> Function<'a> {
         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;

crates/macros/src/helpers.rs

@@ -24,3 +24,13 @@ pub fn get_docs(attrs: &[Attribute]) -> Result<Vec<String>> {
         })
         .collect::<Result<Vec<_>>>()
 }
+
+pub trait CleanPhpAttr {
+    fn clean_php(&mut self);
+}
+
+impl CleanPhpAttr for Vec<Attribute> {
+    fn clean_php(&mut self) {
+        self.retain(|attr| !attr.path().is_ident("php"));
+    }
+}

crates/macros/src/impl_.rs

@@ -125,7 +125,7 @@ struct ParsedImpl<'a> {
 }
 
 #[derive(Debug, Eq, Hash, PartialEq)]
-enum MethodModifier {
+pub enum MethodModifier {
     Abstract,
     Static,
 }
@@ -141,7 +141,7 @@ impl quote::ToTokens for MethodModifier {
 }
 
 #[derive(Debug)]
-struct FnBuilder {
+pub struct FnBuilder {
     /// Tokens which represent the `FunctionBuilder` for this function.
     pub builder: TokenStream,
     /// The visibility of this method.
@@ -151,13 +151,13 @@ struct FnBuilder {
 }
 
 #[derive(Debug)]
-struct Constant<'a> {
+pub struct Constant<'a> {
     /// Name of the constant in PHP land.
-    name: String,
+    pub name: String,
     /// Identifier of the constant in Rust land.
-    ident: &'a syn::Ident,
+    pub ident: &'a syn::Ident,
     /// Documentation for the constant.
-    docs: Vec<String>,
+    pub docs: Vec<String>,
 }
 
 impl<'a> ParsedImpl<'a> {