feat(embed): remove embed as feature, detect it with php info

Author: joelwurtz

.github/workflows/build.yml

@@ -90,9 +90,6 @@ jobs:
           # ext-php-rs requires nightly Rust when on Windows.
           - os: windows-latest
             rust: stable
-          # setup-php doesn't support thread safe PHP on macOS with embed
-          - os: macos-latest
-            phpts: ts
           - os: macos-latest
             clang: "17"
           - os: ubuntu-latest

Cargo.toml

@@ -38,7 +38,6 @@ zip = "2.2"
 
 [features]
 closure = []
-embed = []
 
 [workspace]
 members = [

build.rs

@@ -35,6 +35,9 @@ pub trait PHPProvider<'a>: Sized {
     /// Retrieve a list of absolute include paths.
     fn get_includes(&self) -> Result<Vec<PathBuf>>;
 
+    /// Retrieve a list of compiled sapis
+    fn get_sapis(&self) -> Result<Vec<String>>;
+
     /// Retrieve a list of macro definitions to pass to the compiler.
     fn get_defines(&self) -> Result<Vec<(&'static str, &'static str)>>;
 
@@ -47,7 +50,7 @@ pub trait PHPProvider<'a>: Sized {
     }
 
     /// Prints any extra link arguments.
-    fn print_extra_link_args(&self) -> Result<()> {
+    fn print_extra_link_args(&self, _has_embed: bool) -> Result<()> {
         Ok(())
     }
 }
@@ -167,7 +170,6 @@ fn build_wrapper(defines: &[(&str, &str)], includes: &[PathBuf]) -> Result<()> {
     Ok(())
 }
 
-#[cfg(feature = "embed")]
 /// Builds the embed library.
 fn build_embed(defines: &[(&str, &str)], includes: &[PathBuf]) -> Result<()> {
     let mut build = cc::Build::new();
@@ -186,12 +188,11 @@ fn build_embed(defines: &[(&str, &str)], includes: &[PathBuf]) -> Result<()> {
 fn generate_bindings(
     defines: &[(&str, &str)],
     includes: &[PathBuf],
-    #[allow(unused)] info: &PHPInfo,
+    has_embed: bool,
 ) -> Result<String> {
     let mut bindgen = bindgen::Builder::default();
 
-    #[cfg(feature = "embed")]
-    if !info.thread_safety()? || info.zend_version()? >= PHP_81_API_VER {
+    if has_embed {
         bindgen = bindgen.header("src/embed/embed.h");
     }
 
@@ -256,7 +257,7 @@ fn check_php_version(info: &PHPInfo) -> Result<()> {
     // should get both the `php81` and `php82` flags.
 
     println!(
-        "cargo::rustc-check-cfg=cfg(php80, php81, php82, php83, php84, php_zts, php_debug, docs)"
+        "cargo::rustc-check-cfg=cfg(php80, php81, php82, php83, php84, php_zts, php_debug, php_embed, docs)"
     );
     println!("cargo:rustc-cfg=php80");
 
@@ -319,18 +320,21 @@ fn main() -> Result<()> {
     let info = PHPInfo::get(&php)?;
     let provider = Provider::new(&info)?;
 
+    let sapis = provider.get_sapis()?;
     let includes = provider.get_includes()?;
     let defines = provider.get_defines()?;
+    let has_embed = sapis.contains(&"embed".to_string());
 
     check_php_version(&info)?;
     build_wrapper(&defines, &includes)?;
 
-    #[cfg(feature = "embed")]
-    if !info.thread_safety()? || info.zend_version()? >= PHP_81_API_VER {
+    if has_embed {
+        println!("cargo:rustc-cfg=php_embed");
+
         build_embed(&defines, &includes)?;
     }
 
-    let bindings = generate_bindings(&defines, &includes, &info)?;
+    let bindings = generate_bindings(&defines, &includes, has_embed)?;
 
     let out_file =
         File::create(&out_path).context("Failed to open output bindings file for writing")?;
@@ -343,7 +347,7 @@ fn main() -> Result<()> {
     if info.thread_safety()? {
         println!("cargo:rustc-cfg=php_zts");
     }
-    provider.print_extra_link_args()?;
+    provider.print_extra_link_args(has_embed)?;
 
     // Generate guide tests
     let test_md = skeptic::markdown_files_of_directory("guide");

src/builders/mod.rs

@@ -4,11 +4,11 @@
 mod class;
 mod function;
 mod module;
-#[cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#[cfg(php_embed)]
 mod sapi;
 
 pub use class::ClassBuilder;
 pub use function::FunctionBuilder;
 pub use module::{ModuleBuilder, ModuleStartup};
-#[cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#[cfg(php_embed)]
 pub use sapi::SapiBuilder;

src/lib.rs

@@ -25,7 +25,7 @@ pub mod class;
 pub mod closure;
 pub mod constant;
 pub mod describe;
-#[cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#[cfg(php_embed)]
 pub mod embed;
 #[doc(hidden)]
 pub mod internal;

src/types/iterator.rs

@@ -183,7 +183,7 @@ impl<'a> FromZvalMut<'a> for &'a mut ZendIterator {
 }
 
 #[cfg(test)]
-#[cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#[cfg(php_embed)]
 mod tests {
     use crate::embed::Embed;
 

src/types/string.rs

@@ -456,7 +456,7 @@ impl<'a> FromZval<'a> for &'a str {
 }
 
 #[cfg(test)]
-#[cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#[cfg(php_embed)]
 mod tests {
     use crate::embed::Embed;
 

src/zend/mod.rs

@@ -34,7 +34,7 @@ pub use ini_entry_def::IniEntryDef;
 pub use linked_list::ZendLinkedList;
 pub use module::ModuleEntry;
 pub use streams::*;
-#[cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#[cfg(php_embed)]
 pub(crate) use try_catch::panic_wrapper;
 pub use try_catch::{bailout, try_catch, try_catch_first};
 

src/zend/try_catch.rs

@@ -102,7 +102,7 @@ pub unsafe fn bailout() -> ! {
     ext_php_rs_zend_bailout();
 }
 
-#[cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#[cfg(php_embed)]
 #[cfg(test)]
 mod tests {
     use crate::embed::Embed;

tests/module.rs

@@ -1,5 +1,5 @@
 #![cfg_attr(windows, feature(abi_vectorcall))]
-#![cfg(all(feature = "embed", any(php81, not(php_zts))))]
+#![cfg(php_embed)]
 
 extern crate ext_php_rs;