Continue SDL3 port

All type issues resolved except for audio and event systems

Author: HexDecimal

.vscode/settings.json

@@ -319,6 +319,7 @@
         "OPENGL",
         "opensearch",
         "OPER",
+        "OVERSCAN",
         "packbits",
         "PAGEDOWN",
         "pagerefs",

CHANGELOG.md

@@ -10,12 +10,19 @@ This project adheres to [Semantic Versioning](https://semver.org/) since version
 
 - Switched to SDL3.
   This will cause several breaking changes such as the names of keyboard constants and other SDL enums.
+- `tcod.sdl.video.Window.grab` has been split into `.mouse_grab` and `.keyboard_grab` attributes.
+- `tcod.event.KeySym` single letter symbols are now all uppercase.
+- Relative mouse mode is set via `tcod.sdl.video.Window.relative_mouse_mode` instead of `tcod.sdl.mouse.set_relative_mode`.
+- `tcod.sdl.render.new_renderer`: Removed `software` and `target_textures` parameters, `vsync` takes `int`, `driver` takes `str` instead of `int`.
+- SDL renderer logical
+- `tcod.sdl.render.Renderer`: `integer_scaling` and `logical_size` are now set with `set_logical_presentation` method.
 
 ### Removed
 
 - Support dropped for Python 3.8 and 3.9.
 - Removed `Joystick.get_current_power` due to SDL3 changes.
 - `WindowFlags.FULLSCREEN_DESKTOP` is now just `WindowFlags.FULLSCREEN`
+- `tcod.sdl.render.Renderer.integer_scaling` removed.
 
 ### Fixed
 

build_libtcod.py

@@ -3,11 +3,13 @@
 
 from __future__ import annotations
 
+import ast
 import contextlib
 import glob
 import os
 import platform
 import re
+import subprocess
 import sys
 from collections.abc import Iterable, Iterator
 from pathlib import Path
@@ -208,7 +210,7 @@ def walk_sources(directory: str) -> Iterator[str]:
     extra_link_args.extend(GCC_CFLAGS[tdl_build])
 
 ffi = FFI()
-sdl_cdef = build_sdl.get_cdef()
+sdl_cdef, sdl_strings = build_sdl.get_cdef()
 ffi.cdef(sdl_cdef)
 for include in includes:
     try:
@@ -415,6 +417,13 @@ def write_library_constants() -> None:
 
     Path("tcod/event.py").write_text(event_py, encoding="utf-8")
 
+    with Path("tcod/sdl/constants.py").open("w", encoding="utf-8") as f:
+        f.write('"""SDL private constants."""\n\n')
+        for name, value in sdl_strings.items():
+            f.write(f"{name} = {ast.literal_eval(value)!r}\n")
+
+    subprocess.run(["ruff", "format", "--silent", Path("tcod/sdl/constants.py")], check=True)  # noqa: S603, S607
+
 
 def _fix_reserved_name(name: str) -> str:
     """Add underscores to reserved Python keywords."""
@@ -440,6 +449,8 @@ def _type_from_names(names: list[str]) -> str:
         return "bool"
     if names[-1] in ("size_t", "int", "ptrdiff_t"):
         return "int"
+    if names[-1] in ("float", "double"):
+        return "float"
     return "Any"
 
 
@@ -570,6 +581,8 @@ def write_hints() -> None:
 """
         + cdef
     )
+    for match in re.finditer(r"SDL_PIXELFORMAT_\w+", cdef):
+        function_collector.variables.add(f"{match.group()}: int")
     cdef = re.sub(r"(typedef enum SDL_PixelFormat).*(SDL_PixelFormat;)", r"\1 \2", cdef, flags=re.DOTALL)
     cdef = cdef.replace("padding[...]", "padding[]")
     cdef = cdef.replace("...;} SDL_TouchFingerEvent;", "} SDL_TouchFingerEvent;")
@@ -606,6 +619,8 @@ def write_hints() -> None:
     )
     cdef = re.sub(r"""extern "Python" \{(.*?)\}""", r"\1", cdef, flags=re.DOTALL)
     function_collector.visit(c.parse(cdef))
+    function_collector.variables.add("TCOD_ctx: Any")
+    function_collector.variables.add("TCOD_COMPILEDVERSION: Final[int]")
 
     # Write PYI file
     out_functions = """\n\n    @staticmethod\n""".join(sorted(function_collector.functions))
@@ -628,6 +643,7 @@ class _lib:
 ffi: Any
 """
     Path("tcod/_libtcod.pyi").write_text(pyi)
+    subprocess.run(["ruff", "format", "--silent", Path("tcod/_libtcod.pyi")], check=True)  # noqa: S603, S607
 
 
 if __name__ == "__main__":

build_sdl.py

@@ -246,7 +246,7 @@ def on_directive_handle(
 """
 
 
-def get_cdef() -> str:
+def get_cdef() -> tuple[str, dict[str, str]]:
     """Return the parsed code of SDL for CFFI."""
     with TemporaryDirectory() as temp_dir:
         # Add a false SDL_oldnames.h to prevent old symbols from being collected
@@ -286,7 +286,7 @@ def get_cdef() -> str:
     )
     for name in FLEXIBLE_STRUCTS:
         sdl_cdef = sdl_cdef.replace(f"}} {name};", f"...;}} {name};")
-    return sdl_cdef + EXTRA_CDEF
+    return sdl_cdef + EXTRA_CDEF, parser.known_string_defines
 
 
 include_dirs: list[str] = []

examples/samples_tcod.py

@@ -33,7 +33,6 @@
 import tcod.sdl.render
 import tcod.tileset
 from tcod import libtcodpy
-from tcod.sdl.video import WindowFlags
 
 if TYPE_CHECKING:
     from numpy.typing import NDArray
@@ -101,8 +100,8 @@ def ev_keydown(self, event: tcod.event.KeyDown) -> None:
         elif event.sym == tcod.event.KeySym.RETURN and event.mod & tcod.event.Modifier.ALT:
             sdl_window = context.sdl_window
             if sdl_window:
-                sdl_window.fullscreen = False if sdl_window.fullscreen else WindowFlags.FULLSCREEN_DESKTOP
-        elif event.sym in (tcod.event.KeySym.PRINTSCREEN, tcod.event.KeySym.p):
+                sdl_window.fullscreen = not sdl_window.fullscreen
+        elif event.sym in (tcod.event.KeySym.PRINTSCREEN, tcod.event.KeySym.P):
             print("screenshot")
             if event.mod & tcod.event.Modifier.ALT:
                 libtcodpy.console_save_apf(root_console, "samples.apf")
@@ -469,27 +468,27 @@ def ev_keydown(self, event: tcod.event.KeyDown) -> None:
         if tcod.event.KeySym.N9 >= event.sym >= tcod.event.KeySym.N1:
             self.func = event.sym - tcod.event.KeySym.N1
             self.noise = self.get_noise()
-        elif event.sym == tcod.event.KeySym.e:
+        elif event.sym == tcod.event.KeySym.E:
             self.hurst += 0.1
             self.noise = self.get_noise()
-        elif event.sym == tcod.event.KeySym.d:
+        elif event.sym == tcod.event.KeySym.D:
             self.hurst -= 0.1
             self.noise = self.get_noise()
-        elif event.sym == tcod.event.KeySym.r:
+        elif event.sym == tcod.event.KeySym.R:
             self.lacunarity += 0.5
             self.noise = self.get_noise()
-        elif event.sym == tcod.event.KeySym.f:
+        elif event.sym == tcod.event.KeySym.F:
             self.lacunarity -= 0.5
             self.noise = self.get_noise()
-        elif event.sym == tcod.event.KeySym.t:
+        elif event.sym == tcod.event.KeySym.T:
             self.octaves += 0.5
             self.noise.octaves = self.octaves
-        elif event.sym == tcod.event.KeySym.g:
+        elif event.sym == tcod.event.KeySym.G:
             self.octaves -= 0.5
             self.noise.octaves = self.octaves
-        elif event.sym == tcod.event.KeySym.y:
+        elif event.sym == tcod.event.KeySym.Y:
             self.zoom += 0.2
-        elif event.sym == tcod.event.KeySym.h:
+        elif event.sym == tcod.event.KeySym.H:
             self.zoom -= 0.2
         else:
             super().ev_keydown(event)
@@ -648,10 +647,10 @@ def on_draw(self) -> None:
 
     def ev_keydown(self, event: tcod.event.KeyDown) -> None:
         MOVE_KEYS = {  # noqa: N806
-            tcod.event.KeySym.i: (0, -1),
-            tcod.event.KeySym.j: (-1, 0),
-            tcod.event.KeySym.k: (0, 1),
-            tcod.event.KeySym.l: (1, 0),
+            tcod.event.KeySym.I: (0, -1),
+            tcod.event.KeySym.J: (-1, 0),
+            tcod.event.KeySym.K: (0, 1),
+            tcod.event.KeySym.L: (1, 0),
         }
         FOV_SELECT_KEYS = {  # noqa: N806
             tcod.event.KeySym.MINUS: -1,
@@ -664,9 +663,9 @@ def ev_keydown(self, event: tcod.event.KeyDown) -> None:
             if self.walkable[self.player_x + x, self.player_y + y]:
                 self.player_x += x
                 self.player_y += y
-        elif event.sym == tcod.event.KeySym.t:
+        elif event.sym == tcod.event.KeySym.T:
             self.torch = not self.torch
-        elif event.sym == tcod.event.KeySym.w:
+        elif event.sym == tcod.event.KeySym.W:
             self.light_walls = not self.light_walls
         elif event.sym in FOV_SELECT_KEYS:
             self.algo_num += FOV_SELECT_KEYS[event.sym]
@@ -740,13 +739,13 @@ def on_draw(self) -> None:
 
     def ev_keydown(self, event: tcod.event.KeyDown) -> None:
         """Handle movement and UI."""
-        if event.sym == tcod.event.KeySym.i and self.dest_y > 0:  # destination move north
+        if event.sym == tcod.event.KeySym.I and self.dest_y > 0:  # destination move north
             self.dest_y -= 1
-        elif event.sym == tcod.event.KeySym.k and self.dest_y < SAMPLE_SCREEN_HEIGHT - 1:  # destination move south
+        elif event.sym == tcod.event.KeySym.K and self.dest_y < SAMPLE_SCREEN_HEIGHT - 1:  # destination move south
             self.dest_y += 1
-        elif event.sym == tcod.event.KeySym.j and self.dest_x > 0:  # destination move west
+        elif event.sym == tcod.event.KeySym.J and self.dest_x > 0:  # destination move west
             self.dest_x -= 1
-        elif event.sym == tcod.event.KeySym.l and self.dest_x < SAMPLE_SCREEN_WIDTH - 1:  # destination move east
+        elif event.sym == tcod.event.KeySym.L and self.dest_x < SAMPLE_SCREEN_WIDTH - 1:  # destination move east
             self.dest_x += 1
         elif event.sym == tcod.event.KeySym.TAB:
             self.using_astar = not self.using_astar
@@ -1334,9 +1333,9 @@ def init_context(renderer: int) -> None:
     )
     if context.sdl_renderer:  # If this context supports SDL rendering.
         # Start by setting the logical size so that window resizing doesn't break anything.
-        context.sdl_renderer.logical_size = (
-            tileset.tile_width * root_console.width,
-            tileset.tile_height * root_console.height,
+        context.sdl_renderer.set_logical_presentation(
+            resolution=(tileset.tile_width * root_console.width, tileset.tile_height * root_console.height),
+            mode=tcod.sdl.render.LogicalPresentation.STRETCH,
         )
         assert context.sdl_atlas
         # Generate the console renderer and minimap.

examples/sdl-hello-world.py

@@ -31,7 +31,7 @@ def main() -> None:
     """Show hello world until the window is closed."""
     # Open an SDL window and renderer.
     window = tcod.sdl.video.new_window(720, 480, flags=tcod.sdl.video.WindowFlags.RESIZABLE)
-    renderer = tcod.sdl.render.new_renderer(window, target_textures=True)
+    renderer = tcod.sdl.render.new_renderer(window)
     # Render the text once, then reuse the texture.
     hello_world = render_text(renderer, "Hello World")
     hello_world.color_mod = (64, 255, 64)  # Set the color when copied.