c++20: Update minimum swig to 4.1.0 for c++20 compatibility

Author: ptheywood

.github/workflows/CMake.yml

@@ -119,16 +119,17 @@ jobs:
           sudo apt-get install -y libglew-dev libfontconfig1-dev libsdl2-dev libdevil-dev libfreetype-dev
         fi
 
-    - name: Install Swig >= 4.0.2
+    - name: Install Swig >= 4.1.0
       run: |
-        # Install additional apt-based dependencies required to build swig 4.0.2
-        sudo apt-get install -y bison
+        # Install additional apt-based dependencies required to build swig 4.1.0.
+        # swig >= 4.1 requires pcre2-config from libpcre2-dev
+        sudo apt-get install -y bison automake libpcre2-dev
         # Create a local directory to build swig in.
         mkdir -p swig-from-source && cd swig-from-source
         # Install SWIG building from source dependencies
-        wget https://github.com/swig/swig/archive/refs/tags/v4.0.2.tar.gz
-        tar -zxf v4.0.2.tar.gz
-        cd swig-4.0.2/
+        wget https://github.com/swig/swig/archive/refs/tags/v4.1.0.tar.gz
+        tar -zxf v4.1.0.tar.gz
+        cd swig-4.1.0/
         ./autogen.sh
         ./configure
         make

.github/workflows/Draft-Release.yml

@@ -126,16 +126,17 @@ jobs:
           sudo apt-get install -y libglew-dev libfontconfig1-dev libsdl2-dev libdevil-dev libfreetype-dev
         fi
 
-    - name: Install Swig >= 4.0.2
+    - name: Install Swig >= 4.1.0
       run: |
-        # Install additional apt-based dependencies required to build swig 4.0.2. 4.0.2 requires pcre-config from pcre3-dev. swig >= 4.1 requires pcre2-config from libpcre2-dev
-        sudo apt-get install -y bison automake libpcre3-dev libpcre2-dev
+        # Install additional apt-based dependencies required to build swig 4.1.0.
+        # swig >= 4.1 requires pcre2-config from libpcre2-dev
+        sudo apt-get install -y bison automake libpcre2-dev
         # Create a local directory to build swig in.
         mkdir -p swig-from-source && cd swig-from-source
         # Install SWIG building from source dependencies
-        wget https://github.com/swig/swig/archive/refs/tags/v4.0.2.tar.gz
-        tar -zxf v4.0.2.tar.gz
-        cd swig-4.0.2/
+        wget https://github.com/swig/swig/archive/refs/tags/v4.1.0.tar.gz
+        tar -zxf v4.1.0.tar.gz
+        cd swig-4.1.0/
         ./autogen.sh
         ./configure
         make
@@ -413,6 +414,12 @@ jobs:
         make
         make install
 
+    - name: Install Swig >= 4.1.0 dependencies (EL 8)
+      run: |
+        # Install additional apt-based dependencies required to build swig 4.1.0.
+        # swig >= 4.1 requires pcre2-config, bison and automake
+        sudo apt-get install -y pcre2-devel bison automake
+
     - name: Install setuptools and wheel
       run: |
         python${{env.PYTHON}} -m pip install setuptools wheel
@@ -440,8 +447,8 @@ jobs:
         -DGLEW_USE_STATIC_LIBS="${{ env.USE_STATIC_GLEW }}"
         -DOpenGL_GL_PREFERENCE:STRING=LEGACY
         -DFLAMEGPU_BUILD_PYTHON_PATCHELF="ON"
-        -DFLAMEGPU_SWIG_MINIMUM="4.0.2"
-        -DFLAMEGPU_SWIG_DOWNLOAD="4.0.2"
+        -DFLAMEGPU_SWIG_MINIMUM="4.1.0"
+        -DFLAMEGPU_SWIG_DOWNLOAD="4.1.0"
         -DFLAMEGPU_SWIG_EXACT="ON"
 
     - name: Build python wheel
@@ -575,8 +582,8 @@ jobs:
         -DPython3_EXECUTABLE="$(which python)"
         -DFLAMEGPU_VISUALISATION="${{ env.VISUALISATION }}"
         -DFLAMEGPU_ENABLE_NVTX="ON"
-        -DFLAMEGPU_SWIG_MINIMUM="4.0.2"
-        -DFLAMEGPU_SWIG_DOWNLOAD="4.0.2"
+        -DFLAMEGPU_SWIG_MINIMUM="4.1.0"
+        -DFLAMEGPU_SWIG_DOWNLOAD="4.1.0"
         -DFLAMEGPU_SWIG_EXACT="ON"
 
     - name: Build python wheel

.github/workflows/MPI.yml

@@ -184,16 +184,17 @@ jobs:
           sudo apt-get install -y libglew-dev libfontconfig1-dev libsdl2-dev libdevil-dev libfreetype-dev
         fi
 
-    - name: Install Swig >= 4.0.2
+    - name: Install Swig >= 4.1.0
       run: |
-        # Install additional apt-based dependencies required to build swig 4.0.2
-        sudo apt-get install -y bison
+        # Install additional apt-based dependencies required to build swig 4.1.0.
+        # swig >= 4.1 requires pcre2-config from libpcre2-dev
+        sudo apt-get install -y bison automake libpcre2-dev
         # Create a local directory to build swig in.
         mkdir -p swig-from-source && cd swig-from-source
         # Install SWIG building from source dependencies
-        wget https://github.com/swig/swig/archive/refs/tags/v4.0.2.tar.gz
-        tar -zxf v4.0.2.tar.gz
-        cd swig-4.0.2/
+        wget https://github.com/swig/swig/archive/refs/tags/v4.1.0.tar.gz
+        tar -zxf v4.1.0.tar.gz
+        cd swig-4.1.0/
         ./autogen.sh
         ./configure
         make

.github/workflows/Manylinux_2_28.yml

@@ -134,18 +134,19 @@ jobs:
         make
         make install
 
+    - name: Install Swig >= 4.1.0 dependencies (EL 8)
+      run: |
+        # Install additional apt-based dependencies required to build swig 4.1.0.
+        # swig >= 4.1 requires pcre2-config, bison and automake
+        sudo apt-get install -y pcre2-devel bison automake
+
     - name: Install setuptools and wheel
       run: |
         python${{env.PYTHON}} -m pip install setuptools wheel
 
     - name: Add custom problem matchers for annotations
       run: echo "::add-matcher::.github/problem-matchers.json"
 
-    - name: Install setuptools and wheel
-      if: ${{ env.PYTHON >= 3.12 }}
-      run: |
-        python${{env.PYTHON}} -m pip install setuptools wheel
-
     # This patches a bug where ManyLinux doesn't generate buildnumber as git dir is owned by diff user
     - name: Enable git safe-directory
       run: git config --global --add safe.directory $GITHUB_WORKSPACE
@@ -166,8 +167,8 @@ jobs:
         -DGLEW_USE_STATIC_LIBS="${{ env.USE_STATIC_GLEW }}"
         -DOpenGL_GL_PREFERENCE:STRING=LEGACY
         -DFLAMEGPU_BUILD_PYTHON_PATCHELF="ON"
-        -DFLAMEGPU_SWIG_MINIMUM="4.0.2"
-        -DFLAMEGPU_SWIG_DOWNLOAD="4.0.2"
+        -DFLAMEGPU_SWIG_MINIMUM="4.1.0"
+        -DFLAMEGPU_SWIG_DOWNLOAD="4.1.0"
         -DFLAMEGPU_SWIG_EXACT="ON"
 
     - name: Build python wheel

.github/workflows/Ubuntu.yml

@@ -140,16 +140,17 @@ jobs:
           sudo apt-get install -y libglew-dev libfontconfig1-dev libsdl2-dev libdevil-dev libfreetype-dev
         fi
 
-    - name: Install Swig >= 4.0.2
+    - name: Install Swig >= 4.1.0
       run: |
-        # Install additional apt-based dependencies required to build swig 4.0.2. 4.0.2 requires pcre-config from pcre3-dev. swig >= 4.1 requires pcre2-config from libpcre2-dev
-        sudo apt-get install -y bison automake libpcre3-dev libpcre2-dev
+        # Install additional apt-based dependencies required to build swig 4.1.0.
+        # swig >= 4.1 requires pcre2-config from libpcre2-dev
+        sudo apt-get install -y bison automake libpcre2-dev
         # Create a local directory to build swig in.
         mkdir -p swig-from-source && cd swig-from-source
         # Install SWIG building from source dependencies
-        wget https://github.com/swig/swig/archive/refs/tags/v4.0.2.tar.gz
-        tar -zxf v4.0.2.tar.gz
-        cd swig-4.0.2/
+        wget https://github.com/swig/swig/archive/refs/tags/v4.1.0.tar.gz
+        tar -zxf v4.1.0.tar.gz
+        cd swig-4.1.0/
         ./autogen.sh
         ./configure
         make

README.md

@@ -75,8 +75,9 @@ Optionally:
 + [Doxygen](http://www.doxygen.nl/) to build the documentation
 + [Python](https://www.python.org/) `>= 3.8` for python integration
   + With `setuptools`, `wheel`, `build` and optionally `venv` python packages installed
-+ [swig](http://www.swig.org/) `>= 4.0.2` for python integration
-  + Swig `4.x` will be automatically downloaded by CMake if not provided (if possible).
++ [swig](http://www.swig.org/) `>= 4.1.0` for python integration (with c++20 support)
+  + Swig >= `4.1.0` will be automatically downloaded by CMake if not provided (if possible).
+  + Swig `4.2.0` is problematic
 + MPI (e.g. [MPICH](https://www.mpich.org/), [OpenMPI](https://www.open-mpi.org/)) for distributed ensemble support
   + MPI 3.0+ tested, older MPIs may work but not tested.
 + [FLAMEGPU2-visualiser](https://github.com/FLAMEGPU/FLAMEGPU2-visualiser) dependencies
@@ -186,8 +187,8 @@ cmake --build . --target all
 | `FLAMEGPU_TELEMETRY_SUPPRESS_NOTICE` | `ON`/`OFF`                  | Suppress notice encouraging telemetry to be enabled, which is emitted once per binary execution if telemetry is disabled. Defaults to `OFF`, or the value of a system environment variable of the same name. |
 | `FLAMEGPU_TELEMETRY_TEST_MODE`       | `ON`/`OFF`                  | Submit telemetry values to the test mode of TelemetryDeck. Intended for use during development of FLAMEGPU rather than use. Defaults to `OFF`, or the value of a system environment variable of the same name.|
 | `FLAMEGPU_ENABLE_LINT_FLAMEGPU`      | `ON`/`OFF`                  | Enable/Disable creation of the `lint_flamegpu` target. Default `ON` if this repository is the root CMAKE_SOURCE_DIR, otherwise `OFF` |
-| `FLAMEGPU_SWIG_MINIMUM`              | `4.0.2` | The minimum version of SWIG required. |
-| `FLAMEGPU_SWIG_DOWNLOAD`             | `4.0.2` | The version of SWIG to download if the required version is not found. |
+| `FLAMEGPU_SWIG_MINIMUM`              | `4.1.0` | The minimum version of SWIG required. |
+| `FLAMEGPU_SWIG_DOWNLOAD`             | `4.3.0` | The version of SWIG to download if the required version is not found. |
 | `FLAMEGPU_SWIG_EXACT`                | `ON`/`OFF` | Require the exact version of SWIG specified in `FLAMEGPU_SWIG_MINIMUM`. This enables downgrading swig. Default `OFF` |
 
 <!-- Additional options which users can find if they need them.

swig/CMakeLists.txt

@@ -36,13 +36,13 @@ unset(PYTHON3_EXACT_VERSION_ARG)
 message(STATUS "Python found at " ${Python3_EXECUTABLE})
 
 # Define the minimum and download versions of SWIG which FLAME GPU supports/ requires as cache variables so they may be overridden by users/CI workflows.
-# Swig >= 4 is required for C++17
+# Swig >= 4.1.0 is required for C++20
 # Swig 4.2.0 is very broken for FLAME GPU 2
 # Swig 4.2.1 does not allow != / == comparisons against None
 # Swig 4.3.0 is potentially required for Python 3.13 support 
-set(FLAMEGPU_SWIG_MINIMUM 4.0.2 CACHE STRING "Minimum version of SWIG to search for via CMake find_package")
+set(FLAMEGPU_SWIG_MINIMUM 4.1.0 CACHE STRING "Minimum version of SWIG to search for via CMake find_package")
 mark_as_advanced(FLAMEGPU_SWIG_MINIMUM)
-set(FLAMEGPU_SWIG_DOWNLOAD 4.0.2 CACHE STRING "Version of SWIG to download if the minimum required SWIG is not found")
+set(FLAMEGPU_SWIG_DOWNLOAD 4.1.0 CACHE STRING "Version of SWIG to download if the minimum required SWIG is not found")
 mark_as_advanced(FLAMEGPU_SWIG_DOWNLOAD)
 # Use an option to control if minimum or exact swig should be found.
 option(FLAMEGPU_SWIG_EXACT "Require the exact version of SWIG specified in FLAMEGPU_SWIG_MINIMUM. This enables downgrading swig." OFF)