SDL_Keymod: Removed SDL_KMOD_RESERVED.

Fixes #9481.
libsdl-org · Apr 17, 2024 · 0931609 · 0931609
1 parent b1e4770
commit 0931609
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 9 deletions.
diff --git a/build-scripts/SDL_migration.cocci b/build-scripts/SDL_migration.cocci
@@ -1549,10 +1549,6 @@ typedef SDL_GameControllerButton, SDL_GamepadButton;
 + SDL_KMOD_RCTRL
 @@
 @@
-- KMOD_RESERVED
-+ SDL_KMOD_RESERVED
-@@
-@@
 - KMOD_RGUI
 + SDL_KMOD_RGUI
 @@

diff --git a/docs/README-migration.md b/docs/README-migration.md
@@ -877,6 +877,10 @@ The following functions have been removed:
 
 The SDL_KeyCode enum values have been changed to defines to more clearly reflect that they are a subset of the possible values of an SDL_Keycode.
 
+The following symbols have been removed:
+
+* KMOD_RESERVED - No replacement. A bit named "RESERVED" probably shouldn't be used in an app, but if you need it, this was equivalent to KMOD_SCROLL (0x8000) in SDL2.
+
 The following symbols have been renamed:
 * KMOD_ALT => SDL_KMOD_ALT
 * KMOD_CAPS => SDL_KMOD_CAPS
@@ -891,7 +895,6 @@ The following symbols have been renamed:
 * KMOD_NUM => SDL_KMOD_NUM
 * KMOD_RALT => SDL_KMOD_RALT
 * KMOD_RCTRL => SDL_KMOD_RCTRL
-* KMOD_RESERVED => SDL_KMOD_RESERVED
 * KMOD_RGUI => SDL_KMOD_RGUI
 * KMOD_RSHIFT => SDL_KMOD_RSHIFT
 * KMOD_SCROLL => SDL_KMOD_SCROLL

diff --git a/include/SDL3/SDL_keycode.h b/include/SDL3/SDL_keycode.h
@@ -324,8 +324,6 @@ typedef enum SDL_Keymod
     SDL_KMOD_SHIFT = SDL_KMOD_LSHIFT | SDL_KMOD_RSHIFT, /**< Any Shift key is down. */
     SDL_KMOD_ALT = SDL_KMOD_LALT | SDL_KMOD_RALT,       /**< Any Alt key is down. */
     SDL_KMOD_GUI = SDL_KMOD_LGUI | SDL_KMOD_RGUI,       /**< Any GUI key is down. */
-
-    SDL_KMOD_RESERVED = SDL_KMOD_SCROLL /* This is for source-level compatibility with SDL 2.0.0. */
 } SDL_Keymod;
 
 #endif /* SDL_keycode_h_ */
diff --git a/include/SDL3/SDL_oldnames.h b/include/SDL3/SDL_oldnames.h
@@ -354,7 +354,6 @@
 #define KMOD_NUM SDL_KMOD_NUM
 #define KMOD_RALT SDL_KMOD_RALT
 #define KMOD_RCTRL SDL_KMOD_RCTRL
-#define KMOD_RESERVED SDL_KMOD_RESERVED
 #define KMOD_RGUI SDL_KMOD_RGUI
 #define KMOD_RSHIFT SDL_KMOD_RSHIFT
 #define KMOD_SCROLL SDL_KMOD_SCROLL
@@ -862,7 +861,6 @@
 #define KMOD_NUM KMOD_NUM_renamed_SDL_KMOD_NUM
 #define KMOD_RALT KMOD_RALT_renamed_SDL_KMOD_RALT
 #define KMOD_RCTRL KMOD_RCTRL_renamed_SDL_KMOD_RCTRL
-#define KMOD_RESERVED KMOD_RESERVED_renamed_SDL_KMOD_RESERVED
 #define KMOD_RGUI KMOD_RGUI_renamed_SDL_KMOD_RGUI
 #define KMOD_RSHIFT KMOD_RSHIFT_renamed_SDL_KMOD_RSHIFT
 #define KMOD_SCROLL KMOD_SCROLL_renamed_SDL_KMOD_SCROLL