Refactor module paths (#101)

* Refactor module layout * Fixed documentation tests * Removed skel, moved macro crate * Ignore folders for crate publish * Fix builder for zts * Add `rustfmt.toml`, wrap all comments #96 * Fixed up documentation links, tidied up * Add `Zend` prefix to callable and hashtable * Updated guide types * Updated changelog
davidcole1340 · Oct 10, 2021 · 466c165 · 466c165
1 parent f8b5727
commit 466c165
Show file tree

Hide file tree

Showing 93 changed files with 4,253 additions and 3,514 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## Version 0.6.0
+
+- Reorganized project. [#101]
+  - Changed (almost all) module paths. Too many changes to list them all, check
+    out the docs.
+  - Removed `skel` project.
+
+[#101]: https://github.com/davidcole1340/ext-php-rs/pull/101
+
 ## Version 0.5.3
 
 - Fixed docs.rs PHP bindings file.

diff --git a/Cargo.toml b/Cargo.toml
@@ -9,11 +9,12 @@ version = "0.5.3"
 authors = ["David Cole <[email protected]>"]
 edition = "2018"
 categories = ["api-bindings"]
+exclude = ["/.github", "/.crates", "/guide"]
 
 [dependencies]
 bitflags = "1.2.1"
 parking_lot = "0.11.2"
-ext-php-rs-derive = { version = "=0.5.2", path = "./ext-php-rs-derive" }
+ext-php-rs-derive = { version = "=0.5.2", path = "./crates/macros" }
 
 [build-dependencies]
 bindgen = { version = "0.59" }
@@ -25,8 +26,7 @@ closure = []
 
 [workspace]
 members = [
-    "ext-php-rs-derive",
-    "example/skel"
+    "crates/macros",
 ]
 
 [package.metadata.docs.rs]

diff --git a/README.md b/README.md
@@ -85,8 +85,6 @@ easily), structs have to be hard coded in.
 
 Check out one of the example projects:
 
-- [ext-skel](example/skel) - Testbed for testing the library. Check out previous
-  commits as well to see what else is possible.
 - [anonaddy-sequoia](https://gitlab.com/willbrowning/anonaddy-sequoia) - Sequoia
   encryption PHP extension.
 - [opus-php](https://github.com/davidcole1340/opus-php/tree/rewrite_rs) -

diff --git a/build.rs b/build.rs
@@ -12,8 +12,8 @@ const MAX_PHP_API_VER: u32 = 20200930;
 
 fn main() {
     // rerun if wrapper header is changed
-    println!("cargo:rerun-if-changed=src/wrapper/wrapper.h");
-    println!("cargo:rerun-if-changed=src/wrapper/wrapper.c");
+    println!("cargo:rerun-if-changed=src/wrapper.h");
+    println!("cargo:rerun-if-changed=src/wrapper.c");
 
     let out_path = PathBuf::from(env::var("OUT_DIR").unwrap()).join("bindings.rs");
 
@@ -40,8 +40,8 @@ fn main() {
     }
 
     // Ensure the PHP API version is supported.
-    // We could easily use grep and sed here but eventually we want to support Windows,
-    // so it's easier to just use regex.
+    // We could easily use grep and sed here but eventually we want to support
+    // Windows, so it's easier to just use regex.
     let php_i_cmd = Command::new("php")
         .arg("-i")
         .output()
@@ -71,7 +71,7 @@ fn main() {
 
     // Build `wrapper.c` and link to Rust.
     cc::Build::new()
-        .file("src/wrapper/wrapper.c")
+        .file("src/wrapper.c")
         .includes(
             str::replace(includes.as_ref(), "-I", "")
                 .split(' ')
@@ -80,7 +80,7 @@ fn main() {
         .compile("wrapper");
 
     let mut bindgen = bindgen::Builder::default()
-        .header("src/wrapper/wrapper.h")
+        .header("src/wrapper.h")
         .clang_args(includes.split(' '))
         .parse_callbacks(Box::new(bindgen::CargoCallbacks))
         .rustfmt_bindings(true)
@@ -143,8 +143,9 @@ impl Configure {
     }
 }
 
-/// Array of functions/types used in `ext-php-rs` - used to allowlist when generating
-/// bindings, as we don't want to generate bindings for everything (i.e. stdlib headers).
+/// Array of functions/types used in `ext-php-rs` - used to allowlist when
+/// generating bindings, as we don't want to generate bindings for everything
+/// (i.e. stdlib headers).
 const ALLOWED_BINDINGS: &[&str] = &[
     "HashTable",
     "_Bucket",

diff --git a/crates/macros/.gitignore b/crates/macros/.gitignore
@@ -0,0 +1 @@
+../../.gitignore
diff --git a/ext-php-rs-derive/Cargo.toml → crates/macros/Cargo.toml b/ext-php-rs-derive/Cargo.toml → crates/macros/Cargo.toml
diff --git a/crates/macros/LICENSE_APACHE b/crates/macros/LICENSE_APACHE
@@ -0,0 +1 @@
+../../LICENSE_APACHE
diff --git a/crates/macros/LICENSE_MIT b/crates/macros/LICENSE_MIT
@@ -0,0 +1 @@
+../../LICENSE_MIT
diff --git a/crates/macros/README.md b/crates/macros/README.md
@@ -0,0 +1 @@
+../../README.md
diff --git a/ext-php-rs-derive/src/class.rs → crates/macros/src/class.rs b/ext-php-rs-derive/src/class.rs → crates/macros/src/class.rs
@@ -199,7 +199,7 @@ impl Property {
             PropertyType::Field { field_name } => {
                 let field_name = Ident::new(field_name, Span::call_site());
                 quote! {
-                    (#name, ::ext_php_rs::php::types::props::Property::field(|obj: &mut Self| &mut obj.#field_name)),
+                    (#name, ::ext_php_rs::props::Property::field(|obj: &mut Self| &mut obj.#field_name)),
                 }
             }
             PropertyType::Method { getter, setter } => {
@@ -216,7 +216,7 @@ impl Property {
                     quote! { None }
                 };
                 quote! {
-                    (#name, ::ext_php_rs::php::types::props::Property::method(#getter, #setter)),
+                    (#name, ::ext_php_rs::props::Property::method(#getter, #setter)),
                 }
             }
         }

diff --git a/ext-php-rs-derive/src/constant.rs → crates/macros/src/constant.rs b/ext-php-rs-derive/src/constant.rs → crates/macros/src/constant.rs
@@ -46,6 +46,6 @@ impl Constant {
     //         Visibility::Private => quote! { Private },
     //     };
 
-    //     quote! { ::ext_php_rs::php::flags::ConstantFlags}
+    //     quote! { ::ext_php_rs::flags::ConstantFlags}
     // }
 }
diff --git a/ext-php-rs-derive/src/extern_.rs → crates/macros/src/extern_.rs b/ext-php-rs-derive/src/extern_.rs → crates/macros/src/extern_.rs
@@ -44,7 +44,7 @@ fn parse_function(mut func: ForeignItemFn) -> Result<TokenStream> {
         #(#attrs)* #vis #sig {
             use ::std::convert::TryInto;
 
-            let callable = ::ext_php_rs::php::types::callable::Callable::try_from_name(
+            let callable = ::ext_php_rs::types::ZendCallable::try_from_name(
                 #name
             ).expect(concat!("Unable to find callable function `", #name, "`."));
 

diff --git a/ext-php-rs-derive/src/function.rs → crates/macros/src/function.rs b/ext-php-rs-derive/src/function.rs → crates/macros/src/function.rs
@@ -70,16 +70,16 @@ pub fn parser(args: AttributeArgs, input: ItemFn) -> Result<(TokenStream, Functi
         #input
 
         #[doc(hidden)]
-        pub extern "C" fn #internal_ident(ex: &mut ::ext_php_rs::php::execution_data::ExecutionData, retval: &mut ::ext_php_rs::php::types::zval::Zval) {
-            use ::ext_php_rs::php::types::zval::IntoZval;
+        pub extern "C" fn #internal_ident(ex: &mut ::ext_php_rs::zend::ExecuteData, retval: &mut ::ext_php_rs::types::Zval) {
+            use ::ext_php_rs::convert::IntoZval;
 
             #(#arg_definitions)*
             #arg_parser
 
             let result = #ident(#(#arg_accessors, )*);
 
             if let Err(e) = result.set_zval(retval, false) {
-                let e: ::ext_php_rs::php::exceptions::PhpException = e.into();
+                let e: ::ext_php_rs::exception::PhpException = e.into();
                 e.throw().expect("Failed to throw exception");
             }
         }
@@ -206,7 +206,7 @@ pub fn build_arg_parser<'a>(
                 let this = match this {
                     Some(this) => this,
                     None => {
-                        ::ext_php_rs::php::exceptions::PhpException::default("Failed to retrieve reference to `$this`".into())
+                        ::ext_php_rs::exception::PhpException::default("Failed to retrieve reference to `$this`".into())
                             .throw()
                             .unwrap();
                         return;
@@ -309,7 +309,7 @@ impl Arg {
     pub fn get_type_ident(&self) -> TokenStream {
         let ty: Type = syn::parse_str(&self.ty).unwrap();
         quote! {
-            <#ty as ::ext_php_rs::php::types::zval::FromZval>::TYPE
+            <#ty as ::ext_php_rs::convert::FromZval>::TYPE
         }
     }
 
@@ -318,7 +318,8 @@ impl Arg {
         Ident::new(&self.name, Span::call_site())
     }
 
-    /// Returns a [`TokenStream`] containing the line required to retrieve the value from the argument.
+    /// Returns a [`TokenStream`] containing the line required to retrieve the
+    /// value from the argument.
     pub fn get_accessor(&self, ret: &TokenStream) -> TokenStream {
         let name = &self.name;
         let name_ident = self.get_name_ident();
@@ -338,7 +339,7 @@ impl Arg {
                 match #name_ident.val() {
                     Some(val) => val,
                     None => {
-                        ::ext_php_rs::php::exceptions::PhpException::default(
+                        ::ext_php_rs::exception::PhpException::default(
                             concat!("Invalid value given for argument `", #name, "`.").into()
                         )
                         .throw()
@@ -350,7 +351,8 @@ impl Arg {
         }
     }
 
-    /// Returns a [`TokenStream`] containing the line required to instantiate the argument.
+    /// Returns a [`TokenStream`] containing the line required to instantiate
+    /// the argument.
     pub fn get_arg_definition(&self) -> TokenStream {
         let name = &self.name;
         let ty = self.get_type_ident();
@@ -363,7 +365,7 @@ impl Arg {
         });
 
         quote! {
-            ::ext_php_rs::php::args::Arg::new(#name, #ty) #null #default
+            ::ext_php_rs::args::Arg::new(#name, #ty) #null #default
         }
     }
 }
@@ -397,12 +399,12 @@ impl Function {
 
             // TODO allow reference returns?
             quote! {
-                .returns(<#ty as ::ext_php_rs::php::types::zval::IntoZval>::TYPE, false, #nullable)
+                .returns(<#ty as ::ext_php_rs::convert::IntoZval>::TYPE, false, #nullable)
             }
         });
 
         quote! {
-            ::ext_php_rs::php::function::FunctionBuilder::new(#name, #name_ident)
+            ::ext_php_rs::builders::FunctionBuilder::new(#name, #name_ident)
                 #(#args)*
                 #output
                 .build()

diff --git a/ext-php-rs-derive/src/impl_.rs → crates/macros/src/impl_.rs b/ext-php-rs-derive/src/impl_.rs → crates/macros/src/impl_.rs
diff --git a/ext-php-rs-derive/src/lib.rs → crates/macros/src/lib.rs b/ext-php-rs-derive/src/lib.rs → crates/macros/src/lib.rs
diff --git a/ext-php-rs-derive/src/method.rs → crates/macros/src/method.rs b/ext-php-rs-derive/src/method.rs → crates/macros/src/method.rs
@@ -154,10 +154,10 @@ pub fn parser(input: &mut ImplItemMethod, rename_rule: RenameRule) -> Result<Par
 
             #[doc(hidden)]
             pub fn #internal_ident(
-                ex: &mut ::ext_php_rs::php::execution_data::ExecutionData
-            ) -> ::ext_php_rs::php::types::object::ConstructorResult<Self> {
-                use ::ext_php_rs::php::types::zval::IntoZval;
-                use ::ext_php_rs::php::types::object::ConstructorResult;
+                ex: &mut ::ext_php_rs::zend::ExecuteData
+            ) -> ::ext_php_rs::class::ConstructorResult<Self> {
+                use ::ext_php_rs::convert::IntoZval;
+                use ::ext_php_rs::class::ConstructorResult;
 
                 #(#arg_definitions)*
                 #arg_parser
@@ -171,18 +171,18 @@ pub fn parser(input: &mut ImplItemMethod, rename_rule: RenameRule) -> Result<Par
 
             #[doc(hidden)]
             pub extern "C" fn #internal_ident(
-                ex: &mut ::ext_php_rs::php::execution_data::ExecutionData,
-                retval: &mut ::ext_php_rs::php::types::zval::Zval
+                ex: &mut ::ext_php_rs::zend::ExecuteData,
+                retval: &mut ::ext_php_rs::types::Zval
             ) {
-                use ::ext_php_rs::php::types::zval::IntoZval;
+                use ::ext_php_rs::convert::IntoZval;
 
                 #(#arg_definitions)*
                 #arg_parser
 
                 let result = #this #ident(#(#arg_accessors, )*);
 
                 if let Err(e) = result.set_zval(retval, false) {
-                    let e: ::ext_php_rs::php::exceptions::PhpException = e.into();
+                    let e: ::ext_php_rs::exception::PhpException = e.into();
                     e.throw().expect("Failed to throw exception");
                 }
             }
@@ -313,12 +313,12 @@ impl Method {
 
             // TODO allow reference returns?
             quote! {
-                .returns(<#ty as ::ext_php_rs::php::types::zval::IntoZval>::TYPE, false, #nullable)
+                .returns(<#ty as ::ext_php_rs::convert::IntoZval>::TYPE, false, #nullable)
             }
         });
 
         quote! {
-            ::ext_php_rs::php::function::FunctionBuilder::new(#name, #class_path :: #name_ident)
+            ::ext_php_rs::builders::FunctionBuilder::new(#name, #class_path :: #name_ident)
                 #(#args)*
                 #output
                 .build()
@@ -338,7 +338,7 @@ impl Method {
 
         flags
             .iter()
-            .map(|flag| quote! { ::ext_php_rs::php::flags::MethodFlags::#flag })
+            .map(|flag| quote! { ::ext_php_rs::flags::MethodFlags::#flag })
             .collect::<Punctuated<TokenStream, Token![|]>>()
             .to_token_stream()
     }

diff --git a/ext-php-rs-derive/src/module.rs → crates/macros/src/module.rs b/ext-php-rs-derive/src/module.rs → crates/macros/src/module.rs
@@ -60,12 +60,12 @@ pub fn parser(input: ItemFn) -> Result<TokenStream> {
 
         #[doc(hidden)]
         #[no_mangle]
-        pub extern "C" fn get_module() -> *mut ::ext_php_rs::php::module::ModuleEntry {
+        pub extern "C" fn get_module() -> *mut ::ext_php_rs::zend::ModuleEntry {
             fn internal(#inputs) #output {
                 #(#stmts)*
             }
 
-            let mut builder = ::ext_php_rs::php::module::ModuleBuilder::new(
+            let mut builder = ::ext_php_rs::builders::ModuleBuilder::new(
                 env!("CARGO_PKG_NAME"),
                 env!("CARGO_PKG_VERSION")
             )
@@ -98,10 +98,10 @@ pub fn generate_registered_class_impl(class: &Class) -> Result<TokenStream> {
         let func = Ident::new(&constructor.ident, Span::call_site());
         let args = constructor.get_arg_definitions();
         quote! {
-            Some(::ext_php_rs::php::types::object::ConstructorMeta {
+            Some(::ext_php_rs::class::ConstructorMeta {
                 constructor: Self::#func,
                 build_fn: {
-                    use ext_php_rs::php::function::FunctionBuilder;
+                    use ::ext_php_rs::builders::FunctionBuilder;
                     fn build_fn(func: FunctionBuilder) -> FunctionBuilder {
                         func
                         #(#args)*
@@ -115,19 +115,19 @@ pub fn generate_registered_class_impl(class: &Class) -> Result<TokenStream> {
     };
 
     Ok(quote! {
-        static #meta: ::ext_php_rs::php::types::object::ClassMetadata<#self_ty> = ::ext_php_rs::php::types::object::ClassMetadata::new();
+        static #meta: ::ext_php_rs::class::ClassMetadata<#self_ty> = ::ext_php_rs::class::ClassMetadata::new();
 
-        impl ::ext_php_rs::php::types::object::RegisteredClass for #self_ty {
+        impl ::ext_php_rs::class::RegisteredClass for #self_ty {
             const CLASS_NAME: &'static str = #class_name;
             const CONSTRUCTOR: ::std::option::Option<
-                ::ext_php_rs::php::types::object::ConstructorMeta<Self>
+                ::ext_php_rs::class::ConstructorMeta<Self>
             > = #constructor;
 
-            fn get_metadata() -> &'static ::ext_php_rs::php::types::object::ClassMetadata<Self> {
+            fn get_metadata() -> &'static ::ext_php_rs::class::ClassMetadata<Self> {
                 &#meta
             }
 
-            fn get_properties<'a>() -> ::std::collections::HashMap<&'static str, ::ext_php_rs::php::types::props::Property<'a, Self>> {
+            fn get_properties<'a>() -> ::std::collections::HashMap<&'static str, ::ext_php_rs::props::Property<'a, Self>> {
                 use ::std::iter::FromIterator;
 
                 ::std::collections::HashMap::from_iter([

diff --git a/ext-php-rs-derive/src/startup_function.rs → crates/macros/src/startup_function.rs b/ext-php-rs-derive/src/startup_function.rs → crates/macros/src/startup_function.rs
@@ -21,14 +21,14 @@ pub fn parser(input: ItemFn) -> Result<TokenStream> {
     let func = quote! {
         #[doc(hidden)]
         pub extern "C" fn #ident(ty: i32, module_number: i32) -> i32 {
-            use ::ext_php_rs::php::constants::IntoConst;
-            use ::ext_php_rs::php::flags::PropertyFlags;
+            use ::ext_php_rs::constant::IntoConst;
+            use ::ext_php_rs::flags::PropertyFlags;
 
             fn internal() {
                 #(#stmts)*
             }
 
-            ::ext_php_rs::php::module::ext_php_rs_startup();
+            ::ext_php_rs::internal::ext_php_rs_startup();
 
             #(#classes)*
             #(#constants)*
@@ -116,7 +116,7 @@ fn build_classes(classes: &HashMap<String, Class>) -> Result<Vec<TokenStream>> {
             //     .collect::<Result<Vec<_>>>()?;
 
             Ok(quote! {{
-                let class = ::ext_php_rs::php::class::ClassBuilder::new(#class_name)
+                let class = ::ext_php_rs::builders::ClassBuilder::new(#class_name)
                     #(#methods)*
                     #(#constants)*
                     #(#interfaces)*

diff --git a/ext-php-rs-derive/src/syn_ext.rs → crates/macros/src/syn_ext.rs b/ext-php-rs-derive/src/syn_ext.rs → crates/macros/src/syn_ext.rs