Add controller events.

Author: HexDecimal

examples/eventget.py

@@ -5,7 +5,7 @@
 # https://creativecommons.org/publicdomain/zero/1.0/
 """An demonstration of event handling using the tcod.event module.
 """
-from typing import List
+from typing import List, Set
 
 import tcod
 import tcod.sdl.joystick
@@ -19,7 +19,9 @@ def main() -> None:
 
     event_log: List[str] = []
     motion_desc = ""
-    joysticks = tcod.sdl.joystick.get_joysticks()
+    tcod.sdl.joystick.init()
+    controllers: Set[tcod.sdl.joystick.GameController] = set()
+    joysticks: Set[tcod.sdl.joystick.Joystick] = set()
 
     with tcod.context.new(width=WIDTH, height=HEIGHT) as context:
         console = context.new_console()
@@ -42,9 +44,19 @@ def main() -> None:
                     raise SystemExit()
                 if isinstance(event, tcod.event.WindowResized) and event.type == "WINDOWRESIZED":
                     console = context.new_console()
+                if isinstance(event, tcod.event.ControllerDevice):
+                    if event.type == "CONTROLLERDEVICEADDED":
+                        controllers.add(event.controller)
+                    elif event.type == "CONTROLLERDEVICEREMOVED":
+                        controllers.remove(event.controller)
+                if isinstance(event, tcod.event.JoystickDevice):
+                    if event.type == "JOYDEVICEADDED":
+                        joysticks.add(event.joystick)
+                    elif event.type == "JOYDEVICEREMOVED":
+                        joysticks.remove(event.joystick)
                 if isinstance(event, tcod.event.MouseMotion):
                     motion_desc = str(event)
-                else:
+                else:  # Log all events other than MouseMotion.
                     event_log.append(str(event))
 
 

tcod/event.py

@@ -90,6 +90,7 @@
 from typing_extensions import Final, Literal
 
 import tcod.event_constants
+import tcod.sdl.joystick
 from tcod.event_constants import *  # noqa: F4
 from tcod.event_constants import KMOD_ALT, KMOD_CTRL, KMOD_GUI, KMOD_SHIFT
 from tcod.loader import ffi, lib
@@ -791,6 +792,12 @@ def __init__(self, type: str, which: int):
         self.which = which
         """The ID of the joystick this event is for."""
 
+    @property
+    def joystick(self) -> tcod.sdl.joystick.Joystick:
+        if self.type == "JOYDEVICEADDED":
+            return tcod.sdl.joystick.Joystick._open(self.which)
+        return tcod.sdl.joystick.Joystick._from_instance_id(self.which)
+
     def __repr__(self) -> str:
         return f"tcod.event.{self.__class__.__name__}" f"(type={self.type!r}, which={self.which})"
 
@@ -952,17 +959,16 @@ class JoystickDevice(JoystickEvent):
 
     Example::
 
-        joysticks: dict[int, tcod.sdl.joystick.Joystick] = {}
+        joysticks: set[tcod.sdl.joystick.Joystick] = {}
         for event in tcod.event.get():
             match event:
-                case tcod.event.JoystickDevice(type="JOYDEVICEADDED", which=device_id):
-                    new_joystick = tcod.sdl.joystick.Joystick(device_id)
-                    joysticks[new_joystick.id] = new_joystick
-                case tcod.event.JoystickDevice(type="JOYDEVICEREMOVED", which=which):
-                    del joysticks[which]
+                case tcod.event.JoystickDevice(type="JOYDEVICEADDED", joystick=new_joystick):
+                    joysticks.add(new_joystick)
+                case tcod.event.JoystickDevice(type="JOYDEVICEREMOVED", joystick=joystick):
+                    joysticks.remove(joystick)
     """
 
-    type = Final[Literal["JOYDEVICEADDED", "JOYDEVICEREMOVED"]]  # type: ignore[assignment,misc]
+    type: Final[Literal["JOYDEVICEADDED", "JOYDEVICEREMOVED"]]  # type: ignore[misc]
 
     which: int
     """When type="JOYDEVICEADDED" this is the device ID.
@@ -975,6 +981,126 @@ def from_sdl_event(cls, sdl_event: Any) -> JoystickDevice:
         return cls(type, sdl_event.jdevice.which)
 
 
+class ControllerEvent(Event):
+    """Base class for controller events.
+
+    .. versionadded:: Unreleased
+    """
+
+    def __init__(self, type: str, which: int):
+        super().__init__(type)
+        self.which = which
+        """The ID of the joystick this event is for."""
+
+    @property
+    def controller(self) -> tcod.sdl.joystick.GameController:
+        """The :any:`GameController: for this event."""
+        if self.type == "CONTROLLERDEVICEADDED":
+            return tcod.sdl.joystick.GameController._open(self.which)
+        return tcod.sdl.joystick.GameController._from_instance_id(self.which)
+
+    def __repr__(self) -> str:
+        return f"tcod.event.{self.__class__.__name__}" f"(type={self.type!r}, which={self.which})"
+
+    def __str__(self) -> str:
+        prefix = super().__str__().strip("<>")
+        return f"<{prefix}, which={self.which}>"
+
+
+class ControllerAxis(ControllerEvent):
+    """When a controller axis is moved.
+
+    .. versionadded:: Unreleased
+    """
+
+    type: Final[Literal["CONTROLLERAXISMOTION"]]  # type: ignore[misc]
+
+    def __init__(self, type: str, which: int, axis: tcod.sdl.joystick.ControllerAxis, value: int):
+        super().__init__(type, which)
+        self.axis = axis
+        """Which axis is being moved.  One of :any:`ControllerAxis`."""
+        self.value = value
+        """The new value of this events axis.
+
+        This will be -32768 to 32767 for all axes except for triggers which are 0 to 32767 instead."""
+
+    @classmethod
+    def from_sdl_event(cls, sdl_event: Any) -> ControllerAxis:
+        return cls(
+            "CONTROLLERAXISMOTION",
+            sdl_event.caxis.which,
+            tcod.sdl.joystick.ControllerAxis(sdl_event.caxis.axis),
+            sdl_event.caxis.value,
+        )
+
+    def __repr__(self) -> str:
+        return (
+            f"tcod.event.{self.__class__.__name__}"
+            f"(type={self.type!r}, which={self.which}, axis={self.axis}, value={self.value})"
+        )
+
+    def __str__(self) -> str:
+        prefix = super().__str__().strip("<>")
+        return f"<{prefix}, axis={self.axis}, value={self.value}>"
+
+
+class ControllerButton(ControllerEvent):
+    """When a controller button is pressed or released.
+
+    .. versionadded:: Unreleased
+    """
+
+    type: Final[Literal["CONTROLLERBUTTONDOWN", "CONTROLLERBUTTONUP"]]  # type: ignore[misc]
+
+    def __init__(self, type: str, which: int, button: tcod.sdl.joystick.ControllerButton, pressed: bool):
+        super().__init__(type, which)
+        self.button = button
+        """The button for this event.  One of :any:`ControllerButton`."""
+        self.pressed = pressed
+        """True if the button was pressed, False if it was released."""
+
+    @classmethod
+    def from_sdl_event(cls, sdl_event: Any) -> ControllerButton:
+        type = {
+            lib.SDL_CONTROLLERBUTTONDOWN: "CONTROLLERBUTTONDOWN",
+            lib.SDL_CONTROLLERBUTTONUP: "CONTROLLERBUTTONUP",
+        }[sdl_event.type]
+        return cls(
+            type,
+            sdl_event.cbutton.which,
+            tcod.sdl.joystick.ControllerButton(sdl_event.cbutton.button),
+            sdl_event.cbutton.state == lib.SDL_PRESSED,
+        )
+
+    def __repr__(self) -> str:
+        return (
+            f"tcod.event.{self.__class__.__name__}"
+            f"(type={self.type!r}, which={self.which}, button={self.button}, pressed={self.pressed})"
+        )
+
+    def __str__(self) -> str:
+        prefix = super().__str__().strip("<>")
+        return f"<{prefix}, button={self.button}, pressed={self.pressed}>"
+
+
+class ControllerDevice(ControllerEvent):
+    """When a controller is added, removed, or remapped.
+
+    .. versionadded:: Unreleased
+    """
+
+    type: Final[Literal["CONTROLLERDEVICEADDED", "CONTROLLERDEVICEREMOVED", "CONTROLLERDEVICEREMAPPED"]]  # type: ignore[misc]
+
+    @classmethod
+    def from_sdl_event(cls, sdl_event: Any) -> ControllerDevice:
+        type = {
+            lib.SDL_CONTROLLERDEVICEADDED: "CONTROLLERDEVICEADDED",
+            lib.SDL_CONTROLLERDEVICEREMOVED: "CONTROLLERDEVICEREMOVED",
+            lib.SDL_CONTROLLERDEVICEREMAPPED: "CONTROLLERDEVICEREMAPPED",
+        }[sdl_event.type]
+        return cls(type, sdl_event.cdevice.which)
+
+
 class Undefined(Event):
     """This class is a place holder for SDL events without their own tcod.event
     class.
@@ -1012,6 +1138,12 @@ def __str__(self) -> str:
     lib.SDL_JOYBUTTONUP: JoystickButton,
     lib.SDL_JOYDEVICEADDED: JoystickDevice,
     lib.SDL_JOYDEVICEREMOVED: JoystickDevice,
+    lib.SDL_CONTROLLERAXISMOTION: ControllerAxis,
+    lib.SDL_CONTROLLERBUTTONDOWN: ControllerButton,
+    lib.SDL_CONTROLLERBUTTONUP: ControllerButton,
+    lib.SDL_CONTROLLERDEVICEADDED: ControllerDevice,
+    lib.SDL_CONTROLLERDEVICEREMOVED: ControllerDevice,
+    lib.SDL_CONTROLLERDEVICEREMAPPED: ControllerDevice,
 }
 
 

tcod/sdl/joystick.py

@@ -148,6 +148,10 @@ def _open(cls, device_index: int) -> Joystick:
         p = _check_p(ffi.gc(lib.SDL_JoystickOpen(device_index), lib.SDL_JoystickClose))
         return cls(p)
 
+    @classmethod
+    def _from_instance_id(cls, instance_id: int) -> Joystick:
+        return cls(_check_p(ffi.gc(lib.SDL_JoystickFromInstanceID(instance_id), lib.SDL_JoystickClose)))
+
     def __eq__(self, other: object) -> bool:
         if isinstance(other, GameController):
             return self == other.joystick.id
@@ -199,6 +203,10 @@ def __init__(self, sdl_controller_p: Any):
     def _open(cls, joystick_index: int) -> GameController:
         return cls(_check_p(ffi.gc(lib.SDL_GameControllerOpen(joystick_index), lib.SDL_GameControllerClose)))
 
+    @classmethod
+    def _from_instance_id(cls, instance_id: int) -> GameController:
+        return cls(_check_p(ffi.gc(lib.SDL_GameControllerFromInstanceID(instance_id), lib.SDL_GameControllerClose)))
+
     def get_button(self, button: ControllerButton) -> bool:
         """Return True if `button` is currently held."""
         return bool(lib.SDL_GameControllerGetButton(self.sdl_controller_p, button))
@@ -347,9 +355,14 @@ def _touchpad(self) -> bool:
         return bool(lib.SDL_GameControllerGetButton(self.sdl_controller_p, lib.SDL_CONTROLLER_BUTTON_TOUCHPAD))
 
 
+def init() -> None:
+    """Initialize SDL's joystick and game controller subsystems."""
+    tcod.sdl.sys.init(tcod.sdl.sys.Subsystem.JOYSTICK | tcod.sdl.sys.Subsystem.GAMECONTROLLER)
+
+
 def _get_number() -> int:
     """Return the number of attached joysticks."""
-    tcod.sdl.sys.init(tcod.sdl.sys.Subsystem.JOYSTICK)
+    init()
     return _check(lib.SDL_NumJoysticks())