Introduce ActionSet subsystem

Author: flibitijibibo

CMakeLists.txt

@@ -353,8 +353,8 @@ endif()
 set(LONGESTOPTIONNAME 0)  # set_option and friends will change this.
 
 set(SDL_SUBSYSTEMS
-    Atomic Audio Video Render Events Joystick Haptic Hidapi Power Threads Timers
-    File Loadso CPUinfo Filesystem Sensor Locale Misc)
+    ActionSet Atomic Audio Video Render Events Joystick Haptic Hidapi Power
+    Threads Timers File Loadso CPUinfo Filesystem Sensor Locale Misc)
 foreach(_SUB ${SDL_SUBSYSTEMS})
   string(TOUPPER ${_SUB} _OPT)
   if (NOT DEFINED SDL_${_OPT}_ENABLED_BY_DEFAULT)
@@ -483,6 +483,7 @@ endif()
 # General source files
 file(GLOB SOURCE_FILES
   ${SDL3_SOURCE_DIR}/src/*.c
+  ${SDL3_SOURCE_DIR}/src/actionset/*.c
   ${SDL3_SOURCE_DIR}/src/atomic/*.c
   ${SDL3_SOURCE_DIR}/src/audio/*.c
   ${SDL3_SOURCE_DIR}/src/core/*.c

include/SDL3/SDL.h

@@ -30,6 +30,7 @@
 #define SDL_h_
 
 #include <SDL3/SDL_stdinc.h>
+#include <SDL3/SDL_actionset.h>
 #include <SDL3/SDL_assert.h>
 #include <SDL3/SDL_atomic.h>
 #include <SDL3/SDL_audio.h>

include/SDL3/SDL_actionset.h

@@ -0,0 +1,47 @@
+/*
+  Simple DirectMedia Layer
+  Copyright (C) 1997-2023 Sam Lantinga <[email protected]>
+
+  This software is provided 'as-is', without any express or implied
+  warranty.  In no event will the authors be held liable for any damages
+  arising from the use of this software.
+
+  Permission is granted to anyone to use this software for any purpose,
+  including commercial applications, and to alter it and redistribute it
+  freely, subject to the following restrictions:
+
+  1. The origin of this software must not be misrepresented; you must not
+     claim that you wrote the original software. If you use this software
+     in a product, an acknowledgment in the product documentation would be
+     appreciated but is not required.
+  2. Altered source versions must be plainly marked as such, and must not be
+     misrepresented as being the original software.
+  3. This notice may not be removed or altered from any source distribution.
+*/
+
+/**
+ *  \file SDL_actionset.h
+ *
+ *  \brief Access to the "action set" interface for the SDL library.
+ */
+
+#ifndef SDL_actionset_h_
+#define SDL_actionset_h_
+
+#include <SDL3/SDL_begin_code.h>
+/* Set up for C function definitions, even when using C++ */
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* TODO: Copy over from Codename GigaBrain */
+
+extern DECLSPEC void SDLCALL SDL_UpdateActionSet(void);
+
+/* Ends C function definitions when using C++ */
+#ifdef __cplusplus
+}
+#endif
+#include <SDL3/SDL_close_code.h>
+
+#endif /* SDL_actionset_h_ */

include/SDL3/SDL_hints.h

@@ -315,6 +315,18 @@ extern "C" {
  */
 #define SDL_HINT_AUTO_UPDATE_SENSORS    "SDL_AUTO_UPDATE_SENSORS"
 
+/**
+ *  \brief  A variable controlling whether SDL updates action set state when getting action events
+ *
+ *  This variable can be set to the following values:
+ *
+ *    "0"     - You'll call SDL_UpdateActionSet() manually
+ *    "1"     - SDL will automatically call SDL_UpdateActionSet() (default)
+ *
+ *  This hint can be toggled on and off at runtime.
+ */
+#define SDL_HINT_AUTO_UPDATE_ACTIONSET    "SDL_AUTO_UPDATE_ACTIONSET"
+
 /**
  *  \brief Prevent SDL from using version 4 of the bitmap header when saving BMPs.
  *

include/SDL3/SDL_init.h

@@ -59,11 +59,13 @@ typedef enum
     SDL_INIT_HAPTIC       = 0x00001000,
     SDL_INIT_GAMEPAD      = 0x00002000,  /**< `SDL_INIT_GAMEPAD` implies `SDL_INIT_JOYSTICK` */
     SDL_INIT_EVENTS       = 0x00004000,
-    SDL_INIT_SENSOR       = 0x00008000
+    SDL_INIT_SENSOR       = 0x00008000,
+    SDL_INIT_ACTIONSET    = 0x00010000,  /**< `SDL_INIT_ACTIONSET` implies `SDL_INIT_GAMEPAD | SDL_INIT_SENSOR | SDL_INIT_HAPTIC` */
 } SDL_InitFlags;
 #define SDL_INIT_EVERYTHING ( \
                 SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS | \
-                SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMEPAD | SDL_INIT_SENSOR \
+                SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMEPAD | SDL_INIT_SENSOR | \
+                SDL_INIT_ACTIONSET \
             )
 
 /**
@@ -94,6 +96,8 @@ typedef enum
  * - `SDL_INIT_GAMEPAD`: gamepad subsystem; automatically initializes the
  *   joystick subsystem
  * - `SDL_INIT_EVENTS`: events subsystem
+ * - `SDL_INIT_ACTIONSET`: actionset subsystem, automatically initializes the
+ *   gamepad, sensor, haptic, and events subsystems
  * - `SDL_INIT_EVERYTHING`: all of the above subsystems
  *
  * Subsystem initialization is ref-counted, you must call SDL_QuitSubSystem()

src/SDL.c

@@ -45,6 +45,7 @@
 #include "joystick/SDL_gamepad_c.h"
 #include "joystick/SDL_joystick_c.h"
 #include "sensor/SDL_sensor_c.h"
+#include "actionset/SDL_actionset_c.h"
 
 /* Initialization/Cleanup routines */
 #ifndef SDL_TIMERS_DISABLED
@@ -175,6 +176,11 @@ int SDL_InitSubSystem(Uint32 flags)
     SDL_DBus_Init();
 #endif
 
+    if (flags & SDL_INIT_ACTIONSET) {
+        /* action set implies gamepad, sensor, and haptic */
+        flags |= SDL_INIT_GAMEPAD | SDL_INIT_SENSOR | SDL_INIT_HAPTIC;
+    }
+
     if (flags & SDL_INIT_GAMEPAD) {
         /* game controller implies joystick */
         flags |= SDL_INIT_JOYSTICK;
@@ -348,6 +354,24 @@ int SDL_InitSubSystem(Uint32 flags)
 #endif
     }
 
+    if (flags & SDL_INIT_ACTIONSET) {
+#ifndef SDL_ACTIONSET_DISABLED
+        if (SDL_ShouldInitSubsystem(SDL_INIT_ACTIONSET)) {
+            SDL_IncrementSubsystemRefCount(SDL_INIT_ACTIONSET);
+            if (SDL_InitActionSet() < 0) {
+                SDL_DecrementSubsystemRefCount(SDL_INIT_ACTIONSET);
+                goto quit_and_error;
+            }
+        } else {
+            SDL_IncrementSubsystemRefCount(SDL_INIT_ACTIONSET);
+        }
+        flags_initialized |= SDL_INIT_ACTIONSET;
+#else
+        SDL_SetError("SDL not built with actionset support");
+        goto quit_and_error;
+#endif
+    }
+
     (void)flags_initialized; /* make static analysis happy, since this only gets used in error cases. */
 
     return 0;
@@ -365,6 +389,15 @@ int SDL_Init(Uint32 flags)
 void SDL_QuitSubSystem(Uint32 flags)
 {
     /* Shut down requested initialized subsystems */
+#ifndef SDL_ACTIONSET_DISABLED
+    if (flags & SDL_INIT_ACTIONSET) {
+        if (SDL_ShouldQuitSubsystem(SDL_INIT_ACTIONSET)) {
+            SDL_QuitActionSet();
+        }
+        SDL_DecrementSubsystemRefCount(SDL_INIT_ACTIONSET);
+    }
+#endif
+
 #ifndef SDL_SENSOR_DISABLED
     if (flags & SDL_INIT_SENSOR) {
         if (SDL_ShouldQuitSubsystem(SDL_INIT_SENSOR)) {

src/actionset/SDL_actionset.c

@@ -0,0 +1,42 @@
+/*
+  Simple DirectMedia Layer
+  Copyright (C) 1997-2023 Sam Lantinga <[email protected]>
+
+  This software is provided 'as-is', without any express or implied
+  warranty.  In no event will the authors be held liable for any damages
+  arising from the use of this software.
+
+  Permission is granted to anyone to use this software for any purpose,
+  including commercial applications, and to alter it and redistribute it
+  freely, subject to the following restrictions:
+
+  1. The origin of this software must not be misrepresented; you must not
+     claim that you wrote the original software. If you use this software
+     in a product, an acknowledgment in the product documentation would be
+     appreciated but is not required.
+  2. Altered source versions must be plainly marked as such, and must not be
+     misrepresented as being the original software.
+  3. This notice may not be removed or altered from any source distribution.
+*/
+#include "SDL_internal.h"
+#include "SDL_actionset_c.h"
+
+/* TODO: Copy over from Codename GigaBrain */
+
+int SDL_InitActionSet(void)
+{
+    return 0;
+}
+
+void SDL_QuitActionSet(void)
+{
+}
+
+SDL_bool SDL_ActionSetsOpened(void)
+{
+    return SDL_FALSE;
+}
+
+void SDL_UpdateActionSet(void)
+{
+}

src/actionset/SDL_actionset_c.h

@@ -0,0 +1,33 @@
+/*
+  Simple DirectMedia Layer
+  Copyright (C) 1997-2023 Sam Lantinga <[email protected]>
+
+  This software is provided 'as-is', without any express or implied
+  warranty.  In no event will the authors be held liable for any damages
+  arising from the use of this software.
+
+  Permission is granted to anyone to use this software for any purpose,
+  including commercial applications, and to alter it and redistribute it
+  freely, subject to the following restrictions:
+
+  1. The origin of this software must not be misrepresented; you must not
+     claim that you wrote the original software. If you use this software
+     in a product, an acknowledgment in the product documentation would be
+     appreciated but is not required.
+  2. Altered source versions must be plainly marked as such, and must not be
+     misrepresented as being the original software.
+  3. This notice may not be removed or altered from any source distribution.
+*/
+
+#ifndef SDL_actionset_c_h_
+#define SDL_actionset_c_h_
+
+#include "SDL_internal.h"
+
+extern int SDL_InitActionSet(void);
+
+extern void SDL_QuitActionSet(void);
+
+extern SDL_bool SDL_ActionSetsOpened(void);
+
+#endif /* SDL_actionset_c_h_ */

src/events/SDL_events.c

@@ -31,6 +31,9 @@
 #ifndef SDL_SENSOR_DISABLED
 #include "../sensor/SDL_sensor_c.h"
 #endif
+#ifndef SDL_ACTIONSET_DISABLED
+#include "../actionset/SDL_actionset_c.h"
+#endif
 #include "../video/SDL_sysvideo.h"
 #include <SDL3/SDL_syswm.h>
 
@@ -120,6 +123,17 @@ static void SDLCALL SDL_AutoUpdateSensorsChanged(void *userdata, const char *nam
 
 #endif /* !SDL_SENSOR_DISABLED */
 
+#ifndef SDL_ACTIONSET_DISABLED
+
+static SDL_bool SDL_update_actionset = SDL_TRUE;
+
+static void SDLCALL SDL_AutoUpdateActionSetChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
+{
+    SDL_update_actionset = SDL_GetStringBoolean(hint, SDL_TRUE);
+}
+
+#endif /* !SDL_ACTIONSET_DISABLED */
+
 static void SDLCALL SDL_PollSentinelChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
 {
     SDL_SetEventEnabled(SDL_EVENT_POLL_SENTINEL, SDL_GetStringBoolean(hint, SDL_TRUE));
@@ -866,6 +880,13 @@ static void SDL_PumpEventsInternal(SDL_bool push_sentinel)
     }
 #endif
 
+#ifndef SDL_ACTIONSET_DISABLED
+    /* Check for action set changes */
+    if (SDL_update_actionset) {
+        SDL_UpdateActionSet();
+    }
+#endif
+
     SDL_SendPendingSignalEvents(); /* in case we had a signal handler fire, etc. */
 
     if (push_sentinel && SDL_EventEnabled(SDL_EVENT_POLL_SENTINEL)) {
@@ -985,6 +1006,11 @@ static SDL_bool SDL_events_need_polling(void)
                    (SDL_WasInit(SDL_INIT_SENSOR) && SDL_update_sensors && SDL_SensorsOpened());
 #endif
 
+#ifndef SDL_ACTIONSET_DISABLED
+    need_polling = need_polling ||
+                   (SDL_WasInit(SDL_INIT_ACTIONSET) && SDL_update_actionset && SDL_ActionSetsOpened());
+#endif
+
     return need_polling;
 }
 
@@ -1360,6 +1386,9 @@ int SDL_InitEvents(void)
 #endif
 #ifndef SDL_SENSOR_DISABLED
     SDL_AddHintCallback(SDL_HINT_AUTO_UPDATE_SENSORS, SDL_AutoUpdateSensorsChanged, NULL);
+#endif
+#ifndef SDL_ACTIONSET_DISABLED
+    SDL_AddHintCallback(SDL_HINT_AUTO_UPDATE_ACTIONSET, SDL_AutoUpdateActionSetChanged, NULL);
 #endif
     SDL_AddHintCallback(SDL_HINT_EVENT_LOGGING, SDL_EventLoggingChanged, NULL);
     SDL_AddHintCallback(SDL_HINT_POLL_SENTINEL, SDL_PollSentinelChanged, NULL);
@@ -1379,6 +1408,9 @@ void SDL_QuitEvents(void)
     SDL_StopEventLoop();
     SDL_DelHintCallback(SDL_HINT_POLL_SENTINEL, SDL_PollSentinelChanged, NULL);
     SDL_DelHintCallback(SDL_HINT_EVENT_LOGGING, SDL_EventLoggingChanged, NULL);
+#ifndef SDL_ACTIONSET_DISABLED
+    SDL_DelHintCallback(SDL_HINT_AUTO_UPDATE_ACTIONSET, SDL_AutoUpdateActionSetChanged, NULL);
+#endif
 #ifndef SDL_JOYSTICK_DISABLED
     SDL_DelHintCallback(SDL_HINT_AUTO_UPDATE_JOYSTICKS, SDL_AutoUpdateJoysticksChanged, NULL);
 #endif