Merge branch 'master' of https://github.com/davidcole1340/ext-php-rs into feat-integration-tests

Author: TorstenDittmann

.cargo/config

@@ -0,0 +1,8 @@
+[target.'cfg(not(target_os = "windows"))']
+rustflags = ["-C", "link-arg=-Wl,-undefined,dynamic_lookup"]
+
+[target.x86_64-pc-windows-msvc]
+linker = "rust-lld"
+
+[target.i686-pc-windows-msvc]
+linker = "rust-lld"

.cargo/config.toml

@@ -8,105 +8,82 @@ on:
 jobs:
   build:
     name: Build and Test
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os:
-          - ubuntu-latest
-          - macos-latest
-        rust-toolchain:
-          - stable
-          - nightly
-        php:
-          - '8.0'
-          - '8.1'
-        llvm:
-          - '11.0'
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        php: ['8.0', '8.1']
+        rust: [stable, nightly]
+        phpts: [ts, nts]
+        exclude:
+          # ext-php-rs requires nightly Rust when on Windows.
+          - os: windows-latest
+            rust: stable
+          # setup-php doesn't support thread safe PHP on Linux and macOS.
+          - os: macos-latest
+            phpts: ts
+          - os: ubuntu-latest
+            phpts: ts
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
+        env:
+          phpts: ${{ matrix.phpts }}
       - name: Setup Rust
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: ${{ matrix.rust-toolchain }}
+          toolchain: ${{ matrix.rust }}
           override: true
+          components: rustfmt, clippy
       - name: Setup LLVM & Clang
+        if: "!contains(matrix.os, 'windows')"
+        id: clang
         uses: KyleMayes/install-llvm-action@v1
         with:
-          version: ${{ matrix.llvm }}
-          directory: ${{ runner.temp }}/llvm-${{ matrix.llvm }}
-      - name: Install mdbook
-        uses: peaceiris/actions-mdbook@v1
-        with:
-          mdbook-version: latest
+          version: '13.0'
+          directory: ${{ runner.temp }}/llvm
+      - name: Configure Clang
+        if: "!contains(matrix.os, 'windows')"
+        run: |
+          echo "LIBCLANG_PATH=${{ runner.temp }}/llvm/lib" >> $GITHUB_ENV
+          echo "LLVM_VERSION=${{ steps.clang.outputs.version }}" >> $GITHUB_ENV
+      - name: Configure Clang (macOS only)
+        if: "contains(matrix.os, 'macos')"
+        run: echo "SDKROOT=$(xcrun --show-sdk-path)" >> $GITHUB_ENV
       - name: Build
         env:
-          LIBCLANG_PATH: ${{ runner.temp }}/llvm-${{ matrix.llvm }}/lib
           EXT_PHP_RS_TEST:
         run: cargo build --release --all-features --all
-      - name: Test guide examples
-        env:
-          CARGO_PKG_NAME: mdbook-tests
-          CARGO_PKG_VERSION: 0.1.0
-        run: |
-          mdbook test guide -L target/release/deps
       - name: Test inline examples
         uses: actions-rs/cargo@v1
-        env:
-          LIBCLANG_PATH: ${{ runner.temp }}/llvm-${{ matrix.llvm }}/lib
         with:
           command: test
-          args: --release --all
-  build-zts:
-    name: Build with ZTS
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Build
-        uses: ./.github/actions/zts
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        llvm:
-          - '11.0'
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Setup Rust
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-          components: rustfmt, clippy
-      - name: Setup LLVM & Clang
-        uses: KyleMayes/install-llvm-action@v1
-        with:
-          version: ${{ matrix.llvm }}
-          directory: ${{ runner.temp }}/llvm-${{ matrix.llvm }}
+          args: --release --all --all-features
       - name: Run rustfmt
         uses: actions-rs/cargo@v1
-        env:
-          LIBCLANG_PATH: ${{ runner.temp }}/llvm-${{ matrix.llvm }}/lib
         with:
           command: fmt
           args: --all -- --check
       - name: Run clippy
         uses: actions-rs/cargo@v1
-        env:
-          LIBCLANG_PATH: ${{ runner.temp }}/llvm-${{ matrix.llvm }}/lib
         with:
           command: clippy
           args: --all -- -D warnings
       - name: Build with docs stub
+        if: "contains(matrix.os, 'ubuntu') && matrix.php == '8.1'"
         env:
           DOCS_RS:
         run:
           cargo clean && cargo build
+  build-zts:
+    name: Build with ZTS
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Build
+        uses: ./.github/actions/zts

.github/workflows/build.yml

@@ -5,7 +5,7 @@ repository = "https://github.com/davidcole1340/ext-php-rs"
 homepage = "https://github.com/davidcole1340/ext-php-rs"
 license = "MIT OR Apache-2.0"
 keywords = ["php", "ffi", "zend"]
-version = "0.7.3"
+version = "0.7.4"
 authors = ["David Cole <[email protected]>"]
 edition = "2018"
 categories = ["api-bindings"]
@@ -17,12 +17,22 @@ parking_lot = "0.11.2"
 cfg-if = "1.0"
 once_cell = "1.8.0"
 anyhow = { version = "1", optional = true }
-ext-php-rs-derive = { version = "=0.7.3", path = "./crates/macros" }
+ext-php-rs-derive = { version = "=0.7.4", path = "./crates/macros" }
+
+[dev-dependencies]
+skeptic = "0.13"
 
 [build-dependencies]
-bindgen = { version = "0.59" }
-regex = "1"
+anyhow = "1"
+# bindgen = { version = "0.59" }
+bindgen = { git = "https://github.com/rust-lang/rust-bindgen", branch = "master" }
 cc = "1.0"
+skeptic = "0.13"
+
+[target.'cfg(windows)'.build-dependencies]
+ureq = { version = "2.4", features = ["native-tls", "gzip"], default-features = false }
+native-tls = "0.2"
+zip = "0.5"
 
 [features]
 closure = []

Cargo.toml

@@ -1,15 +1,24 @@
 # ext-php-rs
 
-[<img align="right" src="https://discord.com/api/guilds/115233111977099271/widget.png?style=banner2">](https://discord.gg/dphp)
+[![Crates.io](https://img.shields.io/crates/v/ext-php-rs)](https://lib.rs/ext-php-rs)
+[![docs.rs](https://img.shields.io/docsrs/ext-php-rs/latest)](https://docs.rs/ext-php-rs)
+[![Guide Workflow Status](https://img.shields.io/github/workflow/status/davidcole1340/ext-php-rs/Deploy%20documentation?label=guide)](https://davidcole1340.github.io/ext-php-rs)
+![CI Workflow Status](https://img.shields.io/github/workflow/status/davidcole1340/ext-php-rs/Build%20and%20Lint)
+[![Discord](https://img.shields.io/discord/115233111977099271)](https://discord.gg/dphp)
 
 Bindings and abstractions for the Zend API to build PHP extensions natively in
 Rust.
 
+- Documentation: <https://docs.rs/ext-php-rs>
+- Guide: <https://davidcole1340.github.io/ext-php-rs>
+
 ## Example
 
 Export a simple function `function hello_world(string $name): string` to PHP:
 
 ```rust
+#![cfg_attr(windows, feature(abi_vectorcall))]
+
 use ext_php_rs::prelude::*;
 
 /// Gives you a nice greeting!
@@ -104,16 +113,37 @@ best resource at the moment. This can be viewed at [docs.rs].
 
 ## Requirements
 
-- PHP 8.0 or later
-  - No support is planned for lower versions.
-- Linux or Darwin-based OS
-- Rust - no idea which version
-- Clang 3.9 or greater
-
-See the following links for the dependency crate requirements:
-
-- [`cc`](https://github.com/alexcrichton/cc-rs#compile-time-requirements)
-- [`bindgen`](https://rust-lang.github.io/rust-bindgen/requirements.html)
+- Linux, macOS or Windows-based operating system.
+- PHP 8.0 or later.
+  - No support is planned for earlier versions of PHP.
+- Rust.
+  - Currently, we maintain no guarantee of a MSRV, however lib.rs suggests Rust
+    1.57 at the time of writing.
+- Clang 5.0 or later.
+
+### Windows Requirements
+
+- Extensions can only be compiled for PHP installations sourced from
+  <https://windows.php.net>. Support is planned for other installations
+  eventually.
+- Rust nightly is required for Windows. This is due to the [vectorcall] calling
+  convention being used by some PHP functions on Windows, which is only
+  available as a nightly unstable feature in Rust.
+- It is suggested to use the `rust-lld` linker to link your extension. The MSVC
+  linker (`link.exe`) is supported however you may run into issues if the linker
+  version is not supported by your PHP installation. You can use the `rust-lld`
+  linker by creating a `.cargo\config.toml` file with the following content:
+  ```toml
+  # Replace target triple if you have a different architecture than x86_64
+  [target.x86_64-pc-windows-msvc]
+  linker = "rust-lld"
+  ```
+- The `cc` crate requires `cl.exe` to be present on your system. This is usually
+  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.
+
+[vectorcall]: https://docs.microsoft.com/en-us/cpp/cpp/vectorcall?view=msvc-170
 
 ## Cargo Features
 
@@ -126,16 +156,13 @@ All features are disabled by default.
 
 ## Usage
 
-This project only works for PHP >= 8.0 (for now). Due to the fact that the PHP
-extension system relies heavily on C macros (which cannot be exported to Rust
-easily), structs have to be hard coded in.
-
 Check out one of the example projects:
 
 - [anonaddy-sequoia](https://gitlab.com/willbrowning/anonaddy-sequoia) - Sequoia
   encryption PHP extension.
-- [opus-php](https://github.com/davidcole1340/opus-php) -
-  Audio encoder for the Opus codec in PHP.
+- [opus-php](https://github.com/davidcole1340/opus-php) - Audio encoder for the
+  Opus codec in PHP.
+- [tomlrs-php](https://github.com/jphenow/tomlrs-php) - TOML data format parser.
 
 ## Contributions
 

README.md

@@ -23,12 +23,12 @@ bind! {
     _zend_new_array,
     _zval_struct__bindgen_ty_1,
     _zval_struct__bindgen_ty_2,
-    ext_php_rs_executor_globals,
-    ext_php_rs_php_build_id,
-    ext_php_rs_zend_object_alloc,
-    ext_php_rs_zend_object_release,
-    ext_php_rs_zend_string_init,
-    ext_php_rs_zend_string_release,
+    // ext_php_rs_executor_globals,
+    // ext_php_rs_php_build_id,
+    // ext_php_rs_zend_object_alloc,
+    // ext_php_rs_zend_object_release,
+    // ext_php_rs_zend_string_init,
+    // ext_php_rs_zend_string_release,
     object_properties_init,
     php_info_print_table_end,
     php_info_print_table_header,
@@ -165,8 +165,8 @@ bind! {
     ZEND_DEBUG,
     ZEND_HAS_STATIC_IN_METHODS,
     ZEND_ISEMPTY,
-    ZEND_MM_ALIGNMENT,
-    ZEND_MM_ALIGNMENT_MASK,
+    // ZEND_MM_ALIGNMENT,
+    // ZEND_MM_ALIGNMENT_MASK,
     ZEND_MODULE_API_NO,
     ZEND_PROPERTY_EXISTS,
     ZEND_PROPERTY_ISSET,
@@ -189,8 +189,13 @@ bind! {
     zend_standard_class_def,
     zend_class_serialize_deny,
     zend_class_unserialize_deny,
+    zend_executor_globals,
     zend_objects_store_del,
     gc_possible_root,
     ZEND_ACC_NOT_SERIALIZABLE,
-    executor_globals
+    executor_globals,
+    php_printf,
+    __zend_malloc,
+    tsrm_get_ls_cache,
+    executor_globals_offset
 }