Procházet zdrojové kódy

Dynamically allocate long text for SDL_EVENT_TEXT_INPUT events

This prevents input text from being split across Unicode combining or modifier characters, and in practice allocations will rarely happen.
Sam Lantinga před 1 rokem
rodič
revize
75ea3a8d32

+ 1 - 1
docs/README-migration.md

@@ -298,7 +298,7 @@ The timestamp_us member of the sensor events has been renamed sensor_timestamp a
 
 You should set the event.common.timestamp field before passing an event to SDL_PushEvent(). If the timestamp is 0 it will be filled in with SDL_GetTicksNS().
 
-You should call SDL_CleanupEvent() after handling SDL_EVENT_DROP_FILE, SDL_EVENT_DROP_TEXT, SDL_EVENT_SYSWM, and SDL_EVENT_TEXT_EDITING. This cleans up the memory associated with those events, and you no longer have to free the data yourself.
+You should call SDL_CleanupEvent() after handling SDL_EVENT_DROP_FILE, SDL_EVENT_DROP_TEXT, SDL_EVENT_SYSWM, SDL_EVENT_TEXT_EDITING, and SDL_EVENT_TEXT_INPUT. This cleans up the memory associated with those events, and you no longer have to free the data yourself.
 
 Mouse events use floating point values for mouse coordinates and relative motion values. You can get sub-pixel motion depending on the platform and display scaling.
 

+ 2 - 1
include/SDL3/SDL_events.h

@@ -284,7 +284,8 @@ typedef struct SDL_TextInputEvent
     Uint32 type;                                /**< ::SDL_EVENT_TEXT_INPUT */
     Uint64 timestamp;                           /**< In nanoseconds, populated using SDL_GetTicksNS() */
     SDL_WindowID windowID;                      /**< The window with keyboard focus, if any */
-    char text[SDL_TEXTINPUTEVENT_TEXT_SIZE];    /**< The input text */
+    char *text;                                 /**< The input text */
+    char short_text[SDL_TEXTEDITINGEVENT_TEXT_SIZE]; /**< Memory space for short input text, use 'text' instead */
 } SDL_TextInputEvent;
 
 /**

+ 9 - 1
src/events/SDL_events.c

@@ -470,11 +470,13 @@ static void SDL_LogEvent(const SDL_Event *event)
 
 static void SDL_CopyEvent(SDL_Event *dst, SDL_Event *src)
 {
-    *dst = *src;
+    SDL_copyp(dst, src);
 
     /* Pointers to internal static data must be updated when copying. */
     if (src->type == SDL_EVENT_TEXT_EDITING && src->edit.text == src->edit.short_text) {
         dst->edit.text = dst->edit.short_text;
+    } else if (src->type == SDL_EVENT_TEXT_INPUT && src->text.text == src->text.short_text) {
+        dst->text.text = dst->text.short_text;
     } else if (src->type == SDL_EVENT_DROP_TEXT && src->drop.data == src->drop.short_data) {
         dst->drop.data = dst->drop.short_data;
     }
@@ -1106,6 +1108,12 @@ void SDL_CleanupEvent(SDL_Event *event)
             event->edit.text = NULL;
         }
         break;
+    case SDL_EVENT_TEXT_INPUT:
+        if (event->text.text && event->text.text != event->text.short_text) {
+            SDL_free(event->text.text);
+            event->text.text = NULL;
+        }
+        break;
     default:
         break;
     }

+ 9 - 9
src/events/SDL_keyboard.c

@@ -1071,19 +1071,19 @@ int SDL_SendKeyboardText(const char *text)
     posted = 0;
     if (SDL_EventEnabled(SDL_EVENT_TEXT_INPUT)) {
         SDL_Event event;
-        size_t pos = 0, advance, length = SDL_strlen(text);
-
         event.type = SDL_EVENT_TEXT_INPUT;
         event.common.timestamp = 0;
         event.text.windowID = keyboard->focus ? keyboard->focus->id : 0;
-        while (pos < length) {
-            advance = SDL_utf8strlcpy(event.text.text, text + pos, SDL_arraysize(event.text.text));
-            if (!advance) {
-                break;
-            }
-            pos += advance;
-            posted |= (SDL_PushEvent(&event) > 0);
+
+        size_t len = SDL_strlen(text);
+        if (len < sizeof(event.text.short_text)) {
+            SDL_memcpy(event.text.short_text, text, len + 1);
+            event.text.text = event.text.short_text;
+        } else {
+            event.text.text = SDL_strdup(text);
         }
+
+        posted = (SDL_PushEvent(&event) > 0);
     }
     return posted;
 }

+ 1 - 0
test/checkkeys.c

@@ -186,6 +186,7 @@ static void loop(void)
         case SDL_EVENT_TEXT_INPUT:
             PrintText("INPUT", event.text.text);
             SDLTest_TextWindowAddText(textwin, "%s", event.text.text);
+            SDL_CleanupEvent(&event);
             break;
         case SDL_EVENT_FINGER_DOWN:
             if (SDL_TextInputActive()) {

+ 1 - 0
test/checkkeysthreads.c

@@ -187,6 +187,7 @@ static void loop(void)
             break;
         case SDL_EVENT_TEXT_INPUT:
             PrintText("INPUT", event.text.text);
+            SDL_CleanupEvent(&event);
             break;
         case SDL_EVENT_MOUSE_BUTTON_DOWN:
             /* Left button quits the app, other buttons toggles text input */

+ 1 - 0
test/testcontroller.c

@@ -1728,6 +1728,7 @@ static void loop(void *arg)
                     AddControllerNameText(event.text.text);
                 }
             }
+            SDL_CleanupEvent(&event);
             break;
         case SDL_EVENT_QUIT:
             done = SDL_TRUE;

+ 1 - 0
test/testime.c

@@ -770,6 +770,7 @@ int main(int argc, char *argv[])
                 /* is committed */
                 markedText[0] = 0;
                 Redraw();
+                SDL_CleanupEvent(&event);
                 break;
 
             case SDL_EVENT_TEXT_EDITING: