ENH: migrate geos-sys to bindgen and prebuilt GEOS bindings

.github/workflows/CI.yml

@@ -1,13 +1,19 @@
+name: CI
+
 on:
   push:
     branches: [master]
   pull_request:
+  workflow_dispatch:
 
-name: CI
+# cancel running jobs on new commit to PR
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
 jobs:
   rustfmt:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
@@ -20,7 +26,7 @@ jobs:
       - run: cd sys && cargo fmt -- --check
 
   clippy:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
@@ -29,104 +35,145 @@ jobs:
           toolchain: nightly
           override: true
           components: clippy
+
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y libgeos-dev
       - run: cargo clippy -- -D warnings
       - run: cd sys && cargo clippy -- -D warnings
 
   check_static:
     name: Check static feature
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     env:
       LD_LIBRARY_PATH: /usr/local/lib
+
     steps:
       - uses: actions/checkout@v2
         with:
-          submodules: 'true'
+          submodules: "true"
+
       - name: Install toolchain
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           override: true
-      - name: Install dependencies
-        run: |
-          sudo apt update
-          sudo apt install valgrind
-          sudo apt remove libgeos-dev -y
-      - name: Install geos
-        # First we install the 3.8 version of libgeos and then checkout the 3.8.1 version
-        run: |
-          git clone https://github.com/libgeos/geos
-          cd geos
-          git checkout 24650422b3982f17cc493fe92a70228f2ad624b4
-          ./autogen.sh
-          ./configure
-          make
-          sudo make install
-          sudo ldconfig
+
       - name: Build static geos crate
         run: cargo build --features static
 
   check:
-    name: Check ${{ matrix.toolchain }} / ${{ matrix.triple.target }}
-    runs-on: ubuntu-latest
+    name: Check ${{ matrix.toolchain }} / ${{ matrix.geos }} - ${{ matrix.triple.target }}
+    runs-on: ubuntu-20.04
     env:
       LD_LIBRARY_PATH: /usr/local/lib
+      GEOS_LIB_DIR: "/usr/lib/x86_64-linux-gnu"
+      GEOS_VERSION: ${{ matrix.geos }}
+
     strategy:
       fail-fast: false
       matrix:
         toolchain:
           - stable
           - nightly
+        geos: ["3.6.5", "3.7.5", "3.8.3", "3.9.3", "3.10.3", "3.11.0"]
+        include:
+          - geos: "3.7.5"
+            version_feature: "v3_7_0"
+          - geos: "3.8.3"
+            version_feature: "v3_8_0"
+          - geos: "3.9.3"
+            version_feature: "v3_9_0"
+          - geos: "3.10.3"
+            version_feature: "v3_10_0"
+          - geos: "3.11.0"
+            version_feature: "v3_11_0"
     steps:
       - uses: actions/checkout@v2
+        with:
+          submodules: "true"
+
       - name: Install toolchain
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: ${{ matrix.toolchain }}
           override: true
+
       - name: Install dependencies
         run: |
           sudo apt update
-          sudo apt install valgrind
-          sudo apt remove libgeos-dev -y
-      - name: Install geos
-        # First we install the 3.8 version of libgeos and then checkout the 3.8.1 version
+          sudo apt install build-essential ccache ninja-build pkg-config valgrind
+          sudo /usr/sbin/update-ccache-symlinks
+
+      - name: Prepare ccache
+        run: ccache --clear --set-config cache_dir=~/.ccache
+
+      - name: Cache ccache
+        uses: actions/cache@v2
+        env:
+          cache-name: ccache-v1
+        with:
+          path: ~/.ccache
+          key: ${{ env.cache-name }}-${{ matrix.os }}-${{ github.job }}-${{ github.ref }}-${{ github.sha }}-${{ github.head_ref }}
+          restore-keys: |
+            ${{ env.cache-name }}-${{ matrix.os }}-${{ github.job }}-${{ github.ref }}-${{ github.sha }}
+            ${{ env.cache-name }}-${{ matrix.os }}-${{ github.job }}-${{ github.ref }}
+            ${{ env.cache-name }}-${{ matrix.os }}-${{ github.job }}
+
+      - name: Clear ccache statistics
+        run: |
+          ccache --zero-stats --set-config cache_dir=~/.ccache
+          ccache --max-size=2G --set-config cache_dir=~/.ccache
+          ccache --show-stats --set-config cache_dir=~/.ccache
+
+      - name: Install GEOS
         run: |
-          git clone https://github.com/libgeos/geos
-          cd geos
-          git checkout 24650422b3982f17cc493fe92a70228f2ad624b4
-          ./autogen.sh
-          ./configure
-          make
-          sudo make install
-          sudo ldconfig
+          cd sys/geos-src/source
+          git fetch --unshallow --tags origin
+          git checkout "tags/${{ matrix.geos }}"
+          mkdir build
+          cd build
+          cmake -G Ninja -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_BUILD_TYPE=Release ..
+          sudo ninja install
+
       - name: Build geos crate
         run: |
           cargo build
-          cargo build --features v3_8_0
-          cargo build --features v3_7_0
-          cargo build --features v3_6_0
+          cargo build --features 'geo,json'
+
+      - name: Build geos crate for GEOS version > 3.6
+        if: ${{ matrix.version_feature }}
+        run: |
+          cargo build --features ${{ matrix.version_feature }}
+          cargo build --features '${{ matrix.version_feature }},geo,json'
+
       - name: Run geos tests
         run: |
-          cargo test --features v3_8_0
-          cargo test --features v3_7_0
-          cargo test --features v3_6_0
-          cargo test --features geo
-          cargo test --features json
-          cargo test --features 'v3_8_0,geo,json'
           cargo test
+          cargo test --features 'geo,json'
+
+      - name: Run geos tests for GEOS version > 3.6
+        if: ${{ matrix.version_feature }}
+        run: |
+          cargo test --features ${{ matrix.version_feature }}
+          cargo test --features '${{ matrix.version_feature }},geo,json'
+
       - name: Check doc generation
         run: |
           cargo doc --features dox
           cargo doc
+
       - name: Run examples
         run: |
           cargo run --example verbose_example
           cargo run --example prepared_geom
           cargo run --features geo --example prepared_geom
           cargo run --example from_geo
           cargo run --features geo --example from_geo
+
       - name: Check memory leaks
         # run valgrind to check that there are no memoryleaks
         # Note: cargo seems to randomly name the executable, so we use find to find all the tests

.gitignore

@@ -3,6 +3,7 @@
 /target/
 sys/target/
 sys/geos-src/target/
+geos-sys-bind/target/
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here http://doc.crates.io/guide.html#cargotoml-vs-cargolock

Cargo.toml

@@ -17,13 +17,17 @@ readme = "README.md"
 edition = "2021"
 
 [features]
-json = ["geojson"]
+dox = ["geo-types", "wkt", "json"]
 geo = ["geo-types", "wkt"]
-v3_6_0 = ["geos-sys/v3_6_0"]
+json = ["geojson"]
+static = ["geos-sys/static"]
+
+v3_6_0 = []
 v3_7_0 = ["geos-sys/v3_7_0", "v3_6_0"]
 v3_8_0 = ["geos-sys/v3_8_0", "v3_7_0"]
-dox = ["geo-types", "wkt", "json"]
-static = ["geos-sys/static"]
+v3_9_0 = ["geos-sys/v3_9_0", "v3_8_0"]
+v3_10_0 = ["geos-sys/v3_10_0", "v3_9_0"]
+v3_11_0 = ["geos-sys/v3_11_0", "v3_10_0"]
 
 [dependencies]
 libc = "0.2"

geos-sys-bind/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "geos-sys-bind"
+version = "0.1.0"
+edition = "2021"
+
+description = "Generate GEOS C API bindings"
+
+[dependencies]
+bindgen = "0.60.1"
+clap = { version = "3.2.6", features = ["derive"] }
+pkg-config = "0.3.25"
+regex = "1.5"
+semver = "1.0"

geos-sys-bind/README.md

@@ -0,0 +1,56 @@
+# geos-sys-bin
+
+This create builds low level [GEOS](https://libgeos.org/) C API bindings for use
+in `geos-sys`.
+
+## Creating bindings
+
+[bindgen](https://docs.rs/bindgen/latest/bindgen/) is used to automatically
+create bindings from the GEOS C API.
+
+You need to have the GEOS version for which you want to generate bindings
+installed on your system. At minimum, you need to have the `geos_c.h` header
+file for that version available (this is created by the GEOS build process).
+
+This crate will attempt to automatically detect your installation of GEOS:
+
+-   `pkg-config` is used to automatically detect GEOS >= 3.9
+-   `geos-config` is used to automatically detect GEOS < 3.9
+
+## Adding a new GEOS version
+
+### 1. Generate new bindings
+
+By default, the bindings are generated against your installed version of GEOS:
+
+```bash
+cargo run
+```
+
+You can also use the `-h` / `--header` command line flag to specify the location
+of the GEOS header file:
+
+```bash
+cargo run -- --header <path_to_geos_c.h>
+```
+
+This will produce a new binding in
+`geos-sys/prebuilt-bindings/geos_<major>.<minor>.rs` based on the major and minor
+version of your system-installed GEOS.
+
+Review the contents of this file to determine if there are new bindings that
+will be problematic to integrate in Rust, such as data types that vary by
+architecture. Common data types are provided using `libc`. You can compare to
+bindings from a previous version of GEOS for reference.
+
+### 2. Add feature entry for new version
+
+Add a new feature entry for this GEOS version with the pattern
+`"v<major>_<minor>_0"` to `Cargo.toml` in the root of this repository and
+`sys/Cargo.toml`. The feature for each newer version of GEOS depends on the
+previous version.
+
+### 3. Update included version of GEOS
+
+* update the GEOS submodule to the latest available GEOS version
+* update `BUNDLED_GEOS_VERSION` in `sys/build.rs` to match this version