Upgrade to use SDL3 version of libtcod

Author: HexDecimal

.github/workflows/python-package.yml

@@ -44,10 +44,11 @@ jobs:
   sdist:
     runs-on: ubuntu-latest
     steps:
-      - name: APT update
-        run: sudo apt-get update
-      - name: Install APT dependencies
-        run: sudo apt-get install libsdl2-dev
+      - uses: libsdl-org/setup-sdl@6574e20ac65ce362cd12f9c26b3a5e4d3cd31dee
+        with:
+          install-linux-dependencies: true
+          build-type: "Debug"
+          version: "3.2.14"
       - uses: actions/checkout@v4
         with:
           fetch-depth: ${{ env.git-depth }}
@@ -71,7 +72,7 @@ jobs:
     strategy:
       matrix:
         os: ["windows-latest", "macos-latest"]
-        sdl-version: ["2.0.14", "2.0.16", "2.30.0"]
+        sdl-version: ["3.2.10"]
       fail-fast: true
     steps:
       - uses: actions/checkout@v4
@@ -90,7 +91,7 @@ jobs:
           SDL_VERSION: ${{ matrix.sdl-version }}
 
   build:
-    needs: [ruff, mypy]
+    needs: [ruff, mypy, sdist]
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -122,7 +123,13 @@ jobs:
         if: runner.os == 'Linux'
         run: |
           sudo apt-get update
-          sudo apt-get install libsdl2-dev xvfb
+          sudo apt-get install xvfb
+      - uses: libsdl-org/setup-sdl@6574e20ac65ce362cd12f9c26b3a5e4d3cd31dee
+        if: runner.os == 'Linux'
+        with:
+          install-linux-dependencies: true
+          build-type: "Release"
+          version: "3.2.14"
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
@@ -157,13 +164,15 @@ jobs:
           compression-level: 0
 
   test-docs:
-    needs: [ruff, mypy]
+    needs: [ruff, mypy, sdist]
     runs-on: ubuntu-latest
     steps:
-      - name: Install APT dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install libsdl2-dev
+      - uses: libsdl-org/setup-sdl@6574e20ac65ce362cd12f9c26b3a5e4d3cd31dee
+        if: runner.os == 'Linux'
+        with:
+          install-linux-dependencies: true
+          build-type: "Debug"
+          version: "3.2.14"
       - uses: actions/checkout@v4
         with:
           fetch-depth: ${{ env.git-depth }}
@@ -182,7 +191,7 @@ jobs:
         run: python -m sphinx -T -E -W --keep-going . _build/html
 
   tox:
-    needs: [ruff]
+    needs: [ruff, sdist]
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -200,17 +209,18 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip tox
-      - name: Install APT dependencies
+      - uses: libsdl-org/setup-sdl@6574e20ac65ce362cd12f9c26b3a5e4d3cd31dee
         if: runner.os == 'Linux'
-        run: |
-          sudo apt-get update
-          sudo apt-get install libsdl2-dev
+        with:
+          install-linux-dependencies: true
+          build-type: "Debug"
+          version: "3.2.14"
       - name: Run tox
         run: |
           tox -vv
 
   linux-wheels:
-    needs: [ruff, mypy]
+    needs: [ruff, mypy, sdist]
     runs-on: ${{ matrix.arch == 'aarch64' && 'ubuntu-24.04-arm' || 'ubuntu-latest'}}
     strategy:
       matrix:
@@ -248,7 +258,7 @@ jobs:
           CIBW_BEFORE_ALL_LINUX: >
             yum install -y epel-release &&
             yum-config-manager --enable epel &&
-            yum install -y SDL2-devel
+            yum install -y SDL3-devel
           CIBW_BEFORE_TEST: pip install numpy
           CIBW_TEST_COMMAND: python -c "import tcod.context"
           # Skip test on emulated architectures
@@ -267,7 +277,7 @@ jobs:
           compression-level: 0
 
   build-macos:
-    needs: [ruff, mypy]
+    needs: [ruff, mypy, sdist]
     runs-on: "macos-14"
     strategy:
       fail-fast: true
@@ -287,7 +297,7 @@ jobs:
       - name: Install Python dependencies
         run: pip install -r requirements.txt
       - name: Prepare package
-        # Downloads SDL2 for the later step.
+        # Downloads SDL for the later step.
         run: python build_sdl.py
       - name: Build wheels
         uses: pypa/cibuildwheel@v2.23.3

.gitignore

@@ -69,10 +69,10 @@ Release/
 tcod/_*.c
 tcod/_*.pyd
 .benchmarks
-dependencies/SDL2*
+dependencies/SDL*
 tcod/x86
 tcod/x64
-tcod/SDL2.framework
+tcod/SDL?.framework
 deb_dist/
 *.tar.gz
 tcod/version.py

.readthedocs.yaml

@@ -5,11 +5,11 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
     python: "3.11"
   apt_packages:
-    - libsdl2-dev
+    - libsdl3-dev
 
 submodules:
   include: all

README.rst

@@ -48,7 +48,7 @@ For the most part it's just::
 ==============
 * Python 3.10+
 * Windows, Linux, or MacOS X 10.9+.
-* On Linux, requires libsdl2 (2.0.10+).
+* On Linux, requires libsdl3 (3.2.0+).
 
 ===========
  Changelog

build_libtcod.py

@@ -208,11 +208,11 @@ def walk_sources(directory: str) -> Iterator[str]:
 for include in includes:
     try:
         ffi.cdef(include.header)
-    except Exception:
+    except Exception:  # noqa: PERF203
         # Print the source, for debugging.
         print(f"Error with: {include.path}")
         for i, line in enumerate(include.header.split("\n"), 1):
-            print("%03i %s" % (i, line))
+            print(f"{i:03i} {line}")
         raise
 ffi.cdef(
     """
@@ -221,7 +221,10 @@ def walk_sources(directory: str) -> Iterator[str]:
 )
 ffi.set_source(
     module_name,
-    "#include <tcod/cffi.h>\n#include <SDL.h>",
+    """\
+#include <tcod/cffi.h>
+#define SDL_oldnames_h_
+#include <SDL3/SDL.h>""",
     include_dirs=include_dirs,
     library_dirs=library_dirs,
     sources=sources,