From 935833328691240a9ec18e53a2808e8bd5ee15a8 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Sun, 14 Jul 2024 12:30:56 -0700 Subject: [PATCH] Renamed SDL_GetKeyboardInstanceName() and SDL_GetMouseInstanceName() For consistency with other device APIs --- include/SDL3/SDL_keyboard.h | 4 ++-- include/SDL3/SDL_mouse.h | 4 ++-- src/dynapi/SDL_dynapi.sym | 4 ++-- src/dynapi/SDL_dynapi_overrides.h | 4 ++-- src/dynapi/SDL_dynapi_procs.h | 4 ++-- src/events/SDL_keyboard.c | 2 +- src/events/SDL_mouse.c | 4 ++-- test/testhotplug.c | 4 ++-- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/include/SDL3/SDL_keyboard.h b/include/SDL3/SDL_keyboard.h index 67f3cbb7bd..1bdfa1a621 100644 --- a/include/SDL3/SDL_keyboard.h +++ b/include/SDL3/SDL_keyboard.h @@ -80,7 +80,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_HasKeyboard(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_GetKeyboardInstanceName + * \sa SDL_GetKeyboardNameFromID * \sa SDL_HasKeyboard */ extern SDL_DECLSPEC SDL_KeyboardID *SDLCALL SDL_GetKeyboards(int *count); @@ -100,7 +100,7 @@ extern SDL_DECLSPEC SDL_KeyboardID *SDLCALL SDL_GetKeyboards(int *count); * * \sa SDL_GetKeyboards */ -extern SDL_DECLSPEC const char *SDLCALL SDL_GetKeyboardInstanceName(SDL_KeyboardID instance_id); +extern SDL_DECLSPEC const char *SDLCALL SDL_GetKeyboardNameFromID(SDL_KeyboardID instance_id); /** * Query the window which currently has keyboard focus. diff --git a/include/SDL3/SDL_mouse.h b/include/SDL3/SDL_mouse.h index e68211caec..074cdfcb71 100644 --- a/include/SDL3/SDL_mouse.h +++ b/include/SDL3/SDL_mouse.h @@ -142,7 +142,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_HasMouse(void); * * \since This function is available since SDL 3.0.0. * - * \sa SDL_GetMouseInstanceName + * \sa SDL_GetMouseNameFromID * \sa SDL_HasMouse */ extern SDL_DECLSPEC SDL_MouseID *SDLCALL SDL_GetMice(int *count); @@ -162,7 +162,7 @@ extern SDL_DECLSPEC SDL_MouseID *SDLCALL SDL_GetMice(int *count); * * \sa SDL_GetMice */ -extern SDL_DECLSPEC const char *SDLCALL SDL_GetMouseInstanceName(SDL_MouseID instance_id); +extern SDL_DECLSPEC const char *SDLCALL SDL_GetMouseNameFromID(SDL_MouseID instance_id); /** * Get the window which currently has mouse focus. diff --git a/src/dynapi/SDL_dynapi.sym b/src/dynapi/SDL_dynapi.sym index d1533aab05..ed257f0ea0 100644 --- a/src/dynapi/SDL_dynapi.sym +++ b/src/dynapi/SDL_dynapi.sym @@ -327,7 +327,7 @@ SDL3_0.0.0 { SDL_GetKeyFromScancode; SDL_GetKeyName; SDL_GetKeyboardFocus; - SDL_GetKeyboardInstanceName; + SDL_GetKeyboardNameFromID; SDL_GetKeyboardState; SDL_GetKeyboards; SDL_GetLogOutputFunction; @@ -339,7 +339,7 @@ SDL3_0.0.0 { SDL_GetMice; SDL_GetModState; SDL_GetMouseFocus; - SDL_GetMouseInstanceName; + SDL_GetMouseNameFromID; SDL_GetMouseState; SDL_GetNaturalDisplayOrientation; SDL_GetNumAllocations; diff --git a/src/dynapi/SDL_dynapi_overrides.h b/src/dynapi/SDL_dynapi_overrides.h index 03147740fa..21b84b26b6 100644 --- a/src/dynapi/SDL_dynapi_overrides.h +++ b/src/dynapi/SDL_dynapi_overrides.h @@ -352,7 +352,7 @@ #define SDL_GetKeyFromScancode SDL_GetKeyFromScancode_REAL #define SDL_GetKeyName SDL_GetKeyName_REAL #define SDL_GetKeyboardFocus SDL_GetKeyboardFocus_REAL -#define SDL_GetKeyboardInstanceName SDL_GetKeyboardInstanceName_REAL +#define SDL_GetKeyboardNameFromID SDL_GetKeyboardNameFromID_REAL #define SDL_GetKeyboardState SDL_GetKeyboardState_REAL #define SDL_GetKeyboards SDL_GetKeyboards_REAL #define SDL_GetLogOutputFunction SDL_GetLogOutputFunction_REAL @@ -364,7 +364,7 @@ #define SDL_GetMice SDL_GetMice_REAL #define SDL_GetModState SDL_GetModState_REAL #define SDL_GetMouseFocus SDL_GetMouseFocus_REAL -#define SDL_GetMouseInstanceName SDL_GetMouseInstanceName_REAL +#define SDL_GetMouseNameFromID SDL_GetMouseNameFromID_REAL #define SDL_GetMouseState SDL_GetMouseState_REAL #define SDL_GetNaturalDisplayOrientation SDL_GetNaturalDisplayOrientation_REAL #define SDL_GetNumAllocations SDL_GetNumAllocations_REAL diff --git a/src/dynapi/SDL_dynapi_procs.h b/src/dynapi/SDL_dynapi_procs.h index 1575bfde42..917e35ad45 100644 --- a/src/dynapi/SDL_dynapi_procs.h +++ b/src/dynapi/SDL_dynapi_procs.h @@ -372,7 +372,7 @@ SDL_DYNAPI_PROC(SDL_Keycode,SDL_GetKeyFromName,(const char *a),(a),return) SDL_DYNAPI_PROC(SDL_Keycode,SDL_GetKeyFromScancode,(SDL_Scancode a, SDL_Keymod b),(a,b),return) SDL_DYNAPI_PROC(const char*,SDL_GetKeyName,(SDL_Keycode a),(a),return) SDL_DYNAPI_PROC(SDL_Window*,SDL_GetKeyboardFocus,(void),(),return) -SDL_DYNAPI_PROC(const char*,SDL_GetKeyboardInstanceName,(SDL_KeyboardID a),(a),return) +SDL_DYNAPI_PROC(const char*,SDL_GetKeyboardNameFromID,(SDL_KeyboardID a),(a),return) SDL_DYNAPI_PROC(const Uint8*,SDL_GetKeyboardState,(int *a),(a),return) SDL_DYNAPI_PROC(SDL_KeyboardID*,SDL_GetKeyboards,(int *a),(a),return) SDL_DYNAPI_PROC(void,SDL_GetLogOutputFunction,(SDL_LogOutputFunction *a, void **b),(a,b),) @@ -384,7 +384,7 @@ SDL_DYNAPI_PROC(void,SDL_GetMemoryFunctions,(SDL_malloc_func *a, SDL_calloc_func SDL_DYNAPI_PROC(SDL_MouseID*,SDL_GetMice,(int *a),(a),return) SDL_DYNAPI_PROC(SDL_Keymod,SDL_GetModState,(void),(),return) SDL_DYNAPI_PROC(SDL_Window*,SDL_GetMouseFocus,(void),(),return) -SDL_DYNAPI_PROC(const char*,SDL_GetMouseInstanceName,(SDL_MouseID a),(a),return) +SDL_DYNAPI_PROC(const char*,SDL_GetMouseNameFromID,(SDL_MouseID a),(a),return) SDL_DYNAPI_PROC(SDL_MouseButtonFlags,SDL_GetMouseState,(float *a, float *b),(a,b),return) SDL_DYNAPI_PROC(SDL_DisplayOrientation,SDL_GetNaturalDisplayOrientation,(SDL_DisplayID a),(a),return) SDL_DYNAPI_PROC(int,SDL_GetNumAllocations,(void),(),return) diff --git a/src/events/SDL_keyboard.c b/src/events/SDL_keyboard.c index 0b73d154da..e008771ac2 100644 --- a/src/events/SDL_keyboard.c +++ b/src/events/SDL_keyboard.c @@ -201,7 +201,7 @@ SDL_KeyboardID *SDL_GetKeyboards(int *count) return keyboards; } -const char *SDL_GetKeyboardInstanceName(SDL_KeyboardID instance_id) +const char *SDL_GetKeyboardNameFromID(SDL_KeyboardID instance_id) { int keyboard_index = SDL_GetKeyboardIndex(instance_id); if (keyboard_index < 0) { diff --git a/src/events/SDL_mouse.c b/src/events/SDL_mouse.c index d7959f8774..c34ee70c10 100644 --- a/src/events/SDL_mouse.c +++ b/src/events/SDL_mouse.c @@ -312,7 +312,7 @@ void SDL_RemoveMouse(SDL_MouseID mouseID, SDL_bool send_event) return; } - SDL_FreeLater(SDL_mice[mouse_index].name); // SDL_GetMouseInstanceName returns this pointer. + SDL_FreeLater(SDL_mice[mouse_index].name); // SDL_GetMouseNameFromID returns this pointer. if (mouse_index != SDL_mouse_count - 1) { SDL_memcpy(&SDL_mice[mouse_index], &SDL_mice[mouse_index + 1], (SDL_mouse_count - mouse_index - 1) * sizeof(SDL_mice[mouse_index])); @@ -370,7 +370,7 @@ SDL_MouseID *SDL_GetMice(int *count) return mice; } -const char *SDL_GetMouseInstanceName(SDL_MouseID instance_id) +const char *SDL_GetMouseNameFromID(SDL_MouseID instance_id) { int mouse_index = SDL_GetMouseIndex(instance_id); if (mouse_index < 0) { diff --git a/test/testhotplug.c b/test/testhotplug.c index adf15ab683..d28249b198 100644 --- a/test/testhotplug.c +++ b/test/testhotplug.c @@ -103,13 +103,13 @@ int main(int argc, char *argv[]) keepGoing = SDL_FALSE; break; case SDL_EVENT_KEYBOARD_ADDED: - SDL_Log("Keyboard '%s' added : %" SDL_PRIu32 "\n", SDL_GetKeyboardInstanceName(event.kdevice.which), event.kdevice.which); + SDL_Log("Keyboard '%s' added : %" SDL_PRIu32 "\n", SDL_GetKeyboardNameFromID(event.kdevice.which), event.kdevice.which); break; case SDL_EVENT_KEYBOARD_REMOVED: SDL_Log("Keyboard removed: %" SDL_PRIu32 "\n", event.kdevice.which); break; case SDL_EVENT_MOUSE_ADDED: - SDL_Log("Mouse '%s' added : %" SDL_PRIu32 "\n", SDL_GetMouseInstanceName(event.mdevice.which), event.mdevice.which); + SDL_Log("Mouse '%s' added : %" SDL_PRIu32 "\n", SDL_GetMouseNameFromID(event.mdevice.which), event.mdevice.which); break; case SDL_EVENT_MOUSE_REMOVED: SDL_Log("Mouse removed: %" SDL_PRIu32 "\n", event.mdevice.which);