Merge branch 'master' into fix/variadic-optional-arguments

Author: yoramdelangen

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        php: ["8.0", "8.1", "8.2", "8.3"]
+        php: ["8.0", "8.1", "8.2", "8.3", "8.4"]
         rust: [stable, nightly]
         clang: ["15", "17"]
         phpts: [ts, nts]

README.md

@@ -22,9 +22,9 @@ Export a simple function `function hello_world(string $name): string` to PHP:
 use ext_php_rs::prelude::*;
 
 /// Gives you a nice greeting!
-/// 
+///
 /// @param string $name Your name.
-/// 
+///
 /// @return string Nice greeting!
 #[php_function]
 pub fn hello_world(name: String) -> String {
@@ -114,8 +114,12 @@ best resource at the moment. This can be viewed at [docs.rs].
 ## Requirements
 
 - Linux, macOS or Windows-based operating system.
-- PHP 8.0 or later.
+- PHP 8.1 or later.
   - No support is planned for earlier versions of PHP.
+  - PHP versions, that no longer receive security updates, will no longer be
+    supported. They might still work, but no guarantees are made.
+  - See <https://www.php.net/supported-versions.php> for information on PHP
+    supported versions and their end of life dates.
 - Rust.
   - Currently, we maintain no guarantee of a MSRV, however lib.rs suggests Rust
     1.57 at the time of writing.
@@ -142,6 +146,10 @@ best resource at the moment. This can be viewed at [docs.rs].
   bundled with Microsoft Visual Studio.
 - `cargo-php`'s stub generation feature does not work on Windows. Rewriting this
   functionality to be cross-platform is on the roadmap.
+- To build the application in `DEBUG` mode on Windows,
+  you must have a `PHP SDK` built with the `DEBUG` option enabled
+  and specify the `PHP_LIB` to the folder containing the lib files. 
+  For example: set `PHP_LIB=C:\php-sdk\php-dev\vc16\x64\php-8.3.13-src\x64\Debug_TS`.
 
 [vectorcall]: https://docs.microsoft.com/en-us/cpp/cpp/vectorcall?view=msvc-170
 

allowed_bindings.rs

@@ -45,8 +45,8 @@ bind! {
     // ext_php_rs_zend_object_release,
     // ext_php_rs_zend_string_init,
     // ext_php_rs_zend_string_release,
-    // ext_php_rs_is_kown_valid_utf8,
-    // ext_php_rs_set_kown_valid_utf8,
+    // ext_php_rs_is_known_valid_utf8,
+    // ext_php_rs_set_known_valid_utf8,
     object_properties_init,
     php_error_docref,
     php_info_print_table_end,

build.rs

@@ -232,9 +232,15 @@ fn check_php_version(info: &PHPInfo) -> Result<()> {
 
     const PHP_84_API_VER: u32 = 20240924;
 
-    println!("cargo::rustc-check-cfg=cfg(php80, php81, php82, php83, php84, php_zts, php_debug, docs)");
+    println!(
+        "cargo::rustc-check-cfg=cfg(php80, php81, php82, php83, php84, php_zts, php_debug, docs)"
+    );
     println!("cargo:rustc-cfg=php80");
 
+    if (MIN_PHP_API_VER..PHP_81_API_VER).contains(&version) {
+        println!("cargo:warning=PHP version 8.0 is EOL and will no longer be supported in a future release. Please upgrade to a supported version of PHP. See https://www.php.net/supported-versions.php for information on version support timelines.");
+    }
+
     if (PHP_81_API_VER..PHP_82_API_VER).contains(&version) {
         println!("cargo:rustc-cfg=php81");
     }

guide/src/macros/function.md

@@ -99,7 +99,7 @@ pub fn greet(name: String, age: Option<i32>, description: Option<String>) -> Str
 ## Variadic Functions
 
 Variadic functions can be implemented by specifying the last argument in the Rust
-function to the type `&[&Zval]`. This is the equivelant of a PHP function using
+function to the type `&[&Zval]`. This is the equivalent of a PHP function using
 the `...$args` syntax.
 
 ```rust,no_run

src/args.rs

@@ -240,7 +240,7 @@ impl<'a, 'b> ArgParser<'a, 'b> {
         let max_num_args = self.args.len();
         let min_num_args = self.min_num_args.unwrap_or(max_num_args);
         let num_args = self.arg_zvals.len();
-        let has_variadic = self.args.last().map_or(false, |arg| arg.variadic);
+        let has_variadic = self.args.last().is_some_and(|arg| arg.variadic);
 
         if num_args < min_num_args || (!has_variadic && num_args > max_num_args) {
             // SAFETY: Exported C function is safe, return value is unused and parameters

src/builders/function.rs

@@ -57,11 +57,11 @@ impl<'a> FunctionBuilder<'a> {
                 }),
                 arg_info: ptr::null(),
                 num_args: 0,
-                flags: 0,
+                flags: 0, // TBD?
                 #[cfg(php84)]
-                frameless_function_infos: ptr::null(),
+                doc_comment: ptr::null(),
                 #[cfg(php84)]
-                doc_comment: "".as_ptr() as *const c_char,
+                frameless_function_infos: ptr::null(),
             },
             args: vec![],
             n_req: None,
@@ -87,9 +87,9 @@ impl<'a> FunctionBuilder<'a> {
                 num_args: 0,
                 flags: MethodFlags::Abstract.bits(),
                 #[cfg(php84)]
-                frameless_function_infos: ptr::null(),
+                doc_comment: ptr::null(),
                 #[cfg(php84)]
-                doc_comment: "".as_ptr() as *const c_char,
+                frameless_function_infos: ptr::null(),
             },
             args: vec![],
             n_req: None,

src/embed/mod.rs

@@ -54,7 +54,7 @@ impl Embed {
     /// # Returns
     ///
     /// * `Ok(())` - The script was executed successfully
-    /// * `Err(EmbedError)` - An error occured during the execution of the
+    /// * `Err(EmbedError)` - An error occurred during the execution of the
     ///   script
     ///
     /// # Example
@@ -154,7 +154,7 @@ impl Embed {
         match unsafe { *Box::from_raw(panic as *mut std::thread::Result<R>) } {
             Ok(r) => r,
             Err(err) => {
-                // we resume the panic here so it can be catched correctly by the test framework
+                // we resume the panic here so it can be caught correctly by the test framework
                 resume_unwind(err);
             }
         }
@@ -168,7 +168,7 @@ impl Embed {
     /// # Returns
     ///
     /// * `Ok(Zval)` - The result of the evaluation
-    /// * `Err(EmbedError)` - An error occured during the evaluation
+    /// * `Err(EmbedError)` - An error occurred during the evaluation
     ///
     /// # Example
     ///

src/macros.rs

@@ -1,5 +1,5 @@
 //! Macros for interacting with PHP, mainly when the function takes variadic
-//! arguments. Unforutunately, this is the best way to handle these.
+//! arguments. Unfortunately, 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

src/types/array.rs

@@ -91,7 +91,7 @@ impl ZendHashTable {
     /// Panics if memory for the hashtable could not be allocated.
     pub fn with_capacity(size: u32) -> ZBox<Self> {
         unsafe {
-            // SAFETY: PHP allocater handles the creation of the array.
+            // SAFETY: PHP allocator handles the creation of the array.
             let ptr = _zend_new_array(size);
 
             // SAFETY: `as_mut()` checks if the pointer is null, and panics if it is not.
@@ -678,13 +678,13 @@ impl<'a> Iterator for Iter<'a> {
     }
 }
 
-impl<'a> ExactSizeIterator for Iter<'a> {
+impl ExactSizeIterator for Iter<'_> {
     fn len(&self) -> usize {
         self.ht.len()
     }
 }
 
-impl<'a> DoubleEndedIterator for Iter<'a> {
+impl DoubleEndedIterator for Iter<'_> {
     fn next_back(&mut self) -> Option<Self::Item> {
         let key_type = unsafe {
             zend_hash_get_current_key_type_ex(
@@ -730,8 +730,8 @@ impl<'a> DoubleEndedIterator for Iter<'a> {
     }
 }
 
-impl<'a, 'b> Iter<'a> {
-    pub fn next_zval(&'b mut self) -> Option<(Zval, &'a Zval)> {
+impl<'a> Iter<'a> {
+    pub fn next_zval(&mut self) -> Option<(Zval, &'a Zval)> {
         let key_type = unsafe {
             zend_hash_get_current_key_type_ex(
                 self.ht as *const ZendHashTable as *mut ZendHashTable,
@@ -805,13 +805,13 @@ impl<'a> Iterator for Values<'a> {
     }
 }
 
-impl<'a> ExactSizeIterator for Values<'a> {
+impl ExactSizeIterator for Values<'_> {
     fn len(&self) -> usize {
         self.0.len()
     }
 }
 
-impl<'a> DoubleEndedIterator for Values<'a> {
+impl DoubleEndedIterator for Values<'_> {
     fn next_back(&mut self) -> Option<Self::Item> {
         self.0.next_back().map(|(_, zval)| zval)
     }
@@ -847,7 +847,7 @@ impl<'a> FromZval<'a> for &'a ZendHashTable {
 }
 
 ///////////////////////////////////////////
-/// HashMap
+// HashMap
 ///////////////////////////////////////////
 
 impl<'a, V> TryFrom<&'a ZendHashTable> for HashMap<String, V>
@@ -916,7 +916,7 @@ where
 }
 
 ///////////////////////////////////////////
-/// Vec
+// Vec
 ///////////////////////////////////////////
 
 impl<'a, T> TryFrom<&'a ZendHashTable> for Vec<T>