Resolve window event regressions

HexDecimal · HexDecimal · commit 4822c2bbbaeb · 2025-08-06T15:21:01.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,9 +6,15 @@ This project adheres to [Semantic Versioning](https://semver.org/) since version
 
 ## [Unreleased]
 
+### Changed
+
+- Checking "WindowSizeChanged" was not valid since SDL 3 and was also not valid in previous examples.
+  You must no longer check the type of the `WindowResized` event.
+
 ### Fixed
 
 - Corrected some inconsistent angle brackets in the `__str__` of Event subclasses. #165
+- Fix regression with window events causing them to be `Unknown` and uncheckable.
 
 ## [19.3.1] - 2025-08-02
 
diff --git a/docs/tcod/getting-started.rst b/docs/tcod/getting-started.rst
@@ -114,7 +114,7 @@ clearing the console every frame and replacing it only on resizing the window.
                     match event:
                         case tcod.event.Quit():
                             raise SystemExit
-                        case tcod.event.WindowResized(type="WindowSizeChanged"):
+                        case tcod.event.WindowResized(width=width, height=height):  # Size in pixels
                             pass  # The next call to context.new_console may return a different size.
 
 
diff --git a/examples/eventget.py b/examples/eventget.py
@@ -42,7 +42,7 @@ def main() -> None:
                 print(repr(event))
                 if isinstance(event, tcod.event.Quit):
                     raise SystemExit
-                if isinstance(event, tcod.event.WindowResized) and event.type == "WindowSizeChanged":
+                if isinstance(event, tcod.event.WindowResized) and event.type == "WindowResized":
                     console = context.new_console()
                 if isinstance(event, tcod.event.ControllerDevice):
                     if event.type == "CONTROLLERDEVICEADDED":
diff --git a/examples/ttf.py b/examples/ttf.py
@@ -84,7 +84,7 @@ def main() -> None:
             for event in tcod.event.wait():
                 if isinstance(event, tcod.event.Quit):
                     raise SystemExit
-                if isinstance(event, tcod.event.WindowResized) and event.type == "WindowSizeChanged":
+                if isinstance(event, tcod.event.WindowResized):
                     # Resize the Tileset to match the new screen size.
                     context.change_tileset(
                         load_ttf(
diff --git a/tcod/event.py b/tcod/event.py
@@ -83,6 +83,7 @@
 from __future__ import annotations
 
 import enum
+import functools
 import warnings
 from collections.abc import Callable, Iterator, Mapping
 from typing import TYPE_CHECKING, Any, Final, Generic, Literal, NamedTuple, TypeVar
@@ -698,7 +699,6 @@ class WindowEvent(Event):
             "WindowExposed",
             "WindowMoved",
             "WindowResized",
-            "WindowSizeChanged",
             "WindowMinimized",
             "WindowMaximized",
             "WindowRestored",
@@ -715,13 +715,13 @@ class WindowEvent(Event):
 
     @classmethod
     def from_sdl_event(cls, sdl_event: Any) -> WindowEvent | Undefined:
-        if sdl_event.window.event not in cls.__WINDOW_TYPES:
+        if sdl_event.type not in cls._WINDOW_TYPES:
             return Undefined.from_sdl_event(sdl_event)
-        event_type: Final = cls.__WINDOW_TYPES[sdl_event.window.event]
+        event_type: Final = cls._WINDOW_TYPES[sdl_event.type]
         self: WindowEvent
-        if sdl_event.window.event == lib.SDL_EVENT_WINDOW_MOVED:
+        if sdl_event.type == lib.SDL_EVENT_WINDOW_MOVED:
             self = WindowMoved(sdl_event.window.data1, sdl_event.window.data2)
-        elif sdl_event.window.event in (
+        elif sdl_event.type in (
             lib.SDL_EVENT_WINDOW_RESIZED,
             lib.SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED,
         ):
@@ -734,7 +734,7 @@ def from_sdl_event(cls, sdl_event: Any) -> WindowEvent | Undefined:
     def __repr__(self) -> str:
         return f"tcod.event.{self.__class__.__name__}(type={self.type!r})"
 
-    __WINDOW_TYPES: Final = {
+    _WINDOW_TYPES: Final = {
         lib.SDL_EVENT_WINDOW_SHOWN: "WindowShown",
         lib.SDL_EVENT_WINDOW_HIDDEN: "WindowHidden",
         lib.SDL_EVENT_WINDOW_EXPOSED: "WindowExposed",
@@ -785,10 +785,13 @@ class WindowResized(WindowEvent):
     Attributes:
         width (int): The current width of the window.
         height (int): The current height of the window.
+
+    .. versionchanged:: Unreleased
+        Removed "WindowSizeChanged" type.
     """
 
-    type: Final[Literal["WindowResized", "WindowSizeChanged"]]  # type: ignore[misc]
-    """WindowResized" or "WindowSizeChanged"""
+    type: Final[Literal["WindowResized"]]  # type: ignore[misc]
+    """Always "WindowResized"."""
 
     def __init__(self, type: str, width: int, height: int) -> None:
         super().__init__(type)
@@ -1130,6 +1133,15 @@ def from_sdl_event(cls, sdl_event: Any) -> ControllerDevice:
         return cls(type, sdl_event.cdevice.which)
 
 
+@functools.cache
+def _find_event_name(index: int, /) -> str:
+    """Return the SDL event name for this index."""
+    for attr in dir(lib):
+        if attr.startswith("SDL_EVENT_") and getattr(lib, attr) == index:
+            return attr
+    return "???"
+
+
 class Undefined(Event):
     """This class is a place holder for SDL events without their own tcod.event class."""
 
@@ -1144,9 +1156,12 @@ def from_sdl_event(cls, sdl_event: Any) -> Undefined:
 
     def __str__(self) -> str:
         if self.sdl_event:
-            return "<Undefined sdl_event.type=%i>" % self.sdl_event.type
+            return f"<Undefined sdl_event.type={self.sdl_event.type} {_find_event_name(self.sdl_event.type)}>"
         return "<Undefined>"
 
+    def __repr__(self) -> str:
+        return self.__str__()
+
 
 _SDL_TO_CLASS_TABLE: dict[int, type[Event]] = {
     lib.SDL_EVENT_QUIT: Quit,
@@ -1157,7 +1172,6 @@ def __str__(self) -> str:
     lib.SDL_EVENT_MOUSE_BUTTON_UP: MouseButtonUp,
     lib.SDL_EVENT_MOUSE_WHEEL: MouseWheel,
     lib.SDL_EVENT_TEXT_INPUT: TextInput,
-    # lib.SDL_EVENT_WINDOW_EVENT: WindowEvent,
     lib.SDL_EVENT_JOYSTICK_AXIS_MOTION: JoystickAxis,
     lib.SDL_EVENT_JOYSTICK_BALL_MOTION: JoystickBall,
     lib.SDL_EVENT_JOYSTICK_HAT_MOTION: JoystickHat,
@@ -1176,9 +1190,11 @@ def __str__(self) -> str:
 
 def _parse_event(sdl_event: Any) -> Event:
     """Convert a C SDL_Event* type into a tcod Event sub-class."""
-    if sdl_event.type not in _SDL_TO_CLASS_TABLE:
-        return Undefined.from_sdl_event(sdl_event)
-    return _SDL_TO_CLASS_TABLE[sdl_event.type].from_sdl_event(sdl_event)
+    if sdl_event.type in _SDL_TO_CLASS_TABLE:
+        return _SDL_TO_CLASS_TABLE[sdl_event.type].from_sdl_event(sdl_event)
+    if sdl_event.type in WindowEvent._WINDOW_TYPES:
+        return WindowEvent.from_sdl_event(sdl_event)
+    return Undefined.from_sdl_event(sdl_event)
 
 
 def get() -> Iterator[Any]:
@@ -1198,10 +1214,7 @@ def get() -> Iterator[Any]:
         return
     sdl_event = ffi.new("SDL_Event*")
     while lib.SDL_PollEvent(sdl_event):
-        if sdl_event.type in _SDL_TO_CLASS_TABLE:
-            yield _SDL_TO_CLASS_TABLE[sdl_event.type].from_sdl_event(sdl_event)
-        else:
-            yield Undefined.from_sdl_event(sdl_event)
+        yield _parse_event(sdl_event)
 
 
 def wait(timeout: float | None = None) -> Iterator[Any]:
@@ -1425,9 +1438,6 @@ def ev_windowmoved(self, event: tcod.event.WindowMoved, /) -> T | None:
     def ev_windowresized(self, event: tcod.event.WindowResized, /) -> T | None:
         """Called when the window is resized."""
 
-    def ev_windowsizechanged(self, event: tcod.event.WindowResized, /) -> T | None:
-        """Called when the system or user changes the size of the window."""
-
     def ev_windowminimized(self, event: tcod.event.WindowEvent, /) -> T | None:
         """Called when the window is minimized."""
 
