IME Composition Truncation + SDL_IsTextInputShown + SDL_ClearComposition (#5398) * Fixes for IME Composition Truncation + Addition of SDL_ClearComposition, SDL_IsTextInputShown * Fixed: Documentation and code style issues raised during code review.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
diff --git a/include/SDL_events.h b/include/SDL_events.h
index 3722a63..7e46907 100644
--- a/include/SDL_events.h
+++ b/include/SDL_events.h
@@ -102,6 +102,7 @@ typedef enum
SDL_KEYMAPCHANGED, /**< Keymap changed due to a system event such as an
input language or keyboard layout change.
*/
+ SDL_TEXTEDITING_EXT, /**< Extended keyboard text editing (composition) */
/* Mouse events */
SDL_MOUSEMOTION = 0x400, /**< Mouse moved */
@@ -243,6 +244,19 @@ typedef struct SDL_TextEditingEvent
Sint32 length; /**< The length of selected editing text */
} SDL_TextEditingEvent;
+/**
+ * \brief Extended keyboard text editing event structure (event.editExt.*) when text would be
+ * truncated if stored in the text buffer SDL_TextEditingEvent
+ */
+typedef struct SDL_TextEditingExtEvent
+{
+ Uint32 type; /**< ::SDL_TEXTEDITING_EXT */
+ Uint32 timestamp; /**< In milliseconds, populated using SDL_GetTicks() */
+ Uint32 windowID; /**< The window with keyboard focus, if any */
+ char* text; /**< The editing text, which should be freed with SDL_free(), and will not be NULL */
+ Sint32 start; /**< The start cursor of selected editing text */
+ Sint32 length; /**< The length of selected editing text */
+} SDL_TextEditingExtEvent;
#define SDL_TEXTINPUTEVENT_TEXT_SIZE (32)
/**
@@ -601,6 +615,7 @@ typedef union SDL_Event
SDL_WindowEvent window; /**< Window event data */
SDL_KeyboardEvent key; /**< Keyboard event data */
SDL_TextEditingEvent edit; /**< Text editing event data */
+ SDL_TextEditingExtEvent editExt; /**< Extended text editing event data */
SDL_TextInputEvent text; /**< Text input event data */
SDL_MouseMotionEvent motion; /**< Mouse motion event data */
SDL_MouseButtonEvent button; /**< Mouse button event data */
diff --git a/include/SDL_hints.h b/include/SDL_hints.h
index 92fbb57..384320e 100644
--- a/include/SDL_hints.h
+++ b/include/SDL_hints.h
@@ -580,6 +580,17 @@ extern "C" {
#define SDL_HINT_IME_SHOW_UI "SDL_IME_SHOW_UI"
/**
+ * \brief A variable to control if extended IME text support is enabled.
+ * If enabled then SDL_TextEditingExtEvent will be issued if the text would be truncated otherwise.
+ * Additionally SDL_TextInputEvent will be dispatched multiple times so that it is not truncated.
+ *
+ * The variable can be set to the following values:
+ * "0" - Legacy behavior. Text can be truncated, no heap allocations. (default)
+ * "1" - Modern behavior.
+ */
+#define SDL_HINT_IME_SUPPORT_EXTENDED_TEXT "SDL_IME_SUPPORT_EXTENDED_TEXT"
+
+/**
* \brief A variable controlling whether the home indicator bar on iPhone X
* should be hidden.
*
diff --git a/include/SDL_keyboard.h b/include/SDL_keyboard.h
index 8682465..5489cb9 100644
--- a/include/SDL_keyboard.h
+++ b/include/SDL_keyboard.h
@@ -269,6 +269,24 @@ extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputActive(void);
extern DECLSPEC void SDLCALL SDL_StopTextInput(void);
/**
+ * Dismiss the composition window/IME without disabling the subsystem.
+ *
+ * \since This function is available since SDL 2.0.22
+ *
+ * \sa SDL_StartTextInput
+ * \sa SDL_StopTextInput
+ */
+extern DECLSPEC void SDLCALL SDL_ClearComposition(void);
+
+/**
+ * Returns if an IME Composite or Candidate window is currently shown.
+ *
+ * \since This function is available since SDL 2.0.22
+ *
+ */
+extern DECLSPEC SDL_bool SDLCALL SDL_IsTextInputShown(void);
+
+/**
* Set the rectangle used to type Unicode text inputs.
*
* Note: If you want use system native IME window, try to set hint
diff --git a/src/dynapi/SDL_dynapi_overrides.h b/src/dynapi/SDL_dynapi_overrides.h
index 2573a04..6e652e4 100644
--- a/src/dynapi/SDL_dynapi_overrides.h
+++ b/src/dynapi/SDL_dynapi_overrides.h
@@ -857,3 +857,5 @@
#define SDL_PremultiplyAlpha SDL_PremultiplyAlpha_REAL
#define SDL_AndroidSendMessage SDL_AndroidSendMessage_REAL
#define SDL_GetTouchName SDL_GetTouchName_REAL
+#define SDL_ClearComposition SDL_ClearComposition_REAL
+#define SDL_IsTextInputShown SDL_IsTextInputShown_REAL
diff --git a/src/dynapi/SDL_dynapi_procs.h b/src/dynapi/SDL_dynapi_procs.h
index b1ea912..6323185 100644
--- a/src/dynapi/SDL_dynapi_procs.h
+++ b/src/dynapi/SDL_dynapi_procs.h
@@ -928,3 +928,5 @@ SDL_DYNAPI_PROC(int,SDL_PremultiplyAlpha,(int a, int b, Uint32 c, const void *d,
SDL_DYNAPI_PROC(int,SDL_AndroidSendMessage,(Uint32 a, int b),(a,b),return)
#endif
SDL_DYNAPI_PROC(const char*,SDL_GetTouchName,(int a),(a),return)
+SDL_DYNAPI_PROC(void,SDL_ClearComposition,(void),(),)
+SDL_DYNAPI_PROC(SDL_bool,SDL_IsTextInputShown,(void),(),return)
diff --git a/src/events/SDL_keyboard.c b/src/events/SDL_keyboard.c
index bc2386b..cd150fa 100644
--- a/src/events/SDL_keyboard.c
+++ b/src/events/SDL_keyboard.c
@@ -894,6 +894,22 @@ SDL_SendEditingText(const char *text, int start, int length)
event.edit.start = start;
event.edit.length = length;
SDL_utf8strlcpy(event.edit.text, text, SDL_arraysize(event.edit.text));
+
+ if (SDL_GetHintBoolean(SDL_HINT_IME_SUPPORT_EXTENDED_TEXT, SDL_FALSE) &&
+ SDL_strlen(text) > SDL_arraysize(event.text.text)) {
+ event.editExt.type = SDL_TEXTEDITING_EXT;
+ event.editExt.windowID = keyboard->focus ? keyboard->focus->id : 0;
+ event.editExt.text = text ? SDL_strdup(text) : NULL;
+ event.editExt.start = start;
+ event.editExt.length = length;
+ } else {
+ event.edit.type = SDL_TEXTEDITING;
+ event.edit.windowID = keyboard->focus ? keyboard->focus->id : 0;
+ event.edit.start = start;
+ event.edit.length = length;
+ SDL_utf8strlcpy(event.edit.text, text, SDL_arraysize(event.edit.text));
+ }
+
posted = (SDL_PushEvent(&event) > 0);
}
return (posted);
diff --git a/src/video/SDL_sysvideo.h b/src/video/SDL_sysvideo.h
index 470c14b..e2a6504 100644
--- a/src/video/SDL_sysvideo.h
+++ b/src/video/SDL_sysvideo.h
@@ -307,6 +307,8 @@ struct SDL_VideoDevice
void (*StartTextInput) (_THIS);
void (*StopTextInput) (_THIS);
void (*SetTextInputRect) (_THIS, SDL_Rect *rect);
+ void (*ClearComposition) (_THIS);
+ SDL_bool (*IsTextInputShown) (_THIS);
/* Screen keyboard */
SDL_bool (*HasScreenKeyboardSupport) (_THIS);
diff --git a/src/video/SDL_video.c b/src/video/SDL_video.c
index 143f117..2648c44 100644
--- a/src/video/SDL_video.c
+++ b/src/video/SDL_video.c
@@ -4135,6 +4135,24 @@ SDL_StartTextInput(void)
}
}
+void
+SDL_ClearComposition(void)
+{
+ if (_this && _this->ClearComposition) {
+ _this->ClearComposition(_this);
+ }
+}
+
+SDL_bool
+SDL_IsTextInputShown(void)
+{
+ if (_this && _this->IsTextInputShown) {
+ return _this->IsTextInputShown(_this);
+ }
+
+ return SDL_FALSE;
+}
+
SDL_bool
SDL_IsTextInputActive(void)
{
diff --git a/src/video/windows/SDL_windowskeyboard.c b/src/video/windows/SDL_windowskeyboard.c
index 6ab440d..d9bd32a 100644
--- a/src/video/windows/SDL_windowskeyboard.c
+++ b/src/video/windows/SDL_windowskeyboard.c
@@ -36,6 +36,8 @@ static void IME_Init(SDL_VideoData *videodata, HWND hwnd);
static void IME_Enable(SDL_VideoData *videodata, HWND hwnd);
static void IME_Disable(SDL_VideoData *videodata, HWND hwnd);
static void IME_Quit(SDL_VideoData *videodata);
+static void IME_ClearComposition(SDL_VideoData *videodata);
+static SDL_bool IME_IsTextInputShown(SDL_VideoData* videodata);
#endif /* !SDL_DISABLE_WINDOWS_IME */
#ifndef MAPVK_VK_TO_VSC
@@ -62,6 +64,8 @@ WIN_InitKeyboard(_THIS)
data->ime_hwnd_main = 0;
data->ime_hwnd_current = 0;
data->ime_himc = 0;
+ data->ime_composition_length = 32 * sizeof(WCHAR);
+ data->ime_composition = (WCHAR*)SDL_malloc(data->ime_composition_length);
data->ime_composition[0] = 0;
data->ime_readingstring[0] = 0;
data->ime_cursor = 0;
@@ -272,6 +276,18 @@ WIN_SetTextInputRect(_THIS, SDL_Rect *rect)
}
}
+void WIN_ClearComposition(_THIS)
+{
+ SDL_VideoData *videodata = (SDL_VideoData *)_this->driverdata;
+ IME_ClearComposition(videodata);
+}
+
+SDL_bool WIN_IsTextInputShown(_THIS)
+{
+ SDL_VideoData* videodata = (SDL_VideoData*)_this->driverdata;
+ return IME_IsTextInputShown(videodata);
+}
+
static SDL_bool
WIN_ShouldShowNativeUI()
{
@@ -742,18 +758,51 @@ IME_ClearComposition(SDL_VideoData *videodata)
SDL_SendEditingText("", 0, 0);
}
+static SDL_bool
+IME_IsTextInputShown(SDL_VideoData* videodata)
+{
+ BOOL result;
+ HIMC himc;
+
+ if (!videodata->ime_initialized || !videodata->ime_available || !videodata->ime_enabled)
+ return SDL_FALSE;
+
+ return videodata->ime_uicontext != 0 ? SDL_TRUE : SDL_FALSE;
+}
+
static void
IME_GetCompositionString(SDL_VideoData *videodata, HIMC himc, DWORD string)
{
- LONG length = ImmGetCompositionStringW(himc, string, videodata->ime_composition, sizeof(videodata->ime_composition) - sizeof(videodata->ime_composition[0]));
+ LONG length;
+ DWORD dwLang = ((DWORD_PTR)videodata->ime_hkl & 0xffff);
+
+ length = ImmGetCompositionStringW(himc, string, NULL, 0);
+ if (length > 0 && videodata->ime_composition_length < length) {
+ if (videodata->ime_composition != NULL)
+ SDL_free(videodata->ime_composition);
+
+ videodata->ime_composition = (WCHAR*)SDL_malloc(length + sizeof(WCHAR));
+ videodata->ime_composition_length = length;
+ }
+
+ length = ImmGetCompositionStringW(
+ himc,
+ string,
+ videodata->ime_composition,
+ videodata->ime_composition_length
+ );
+
if (length < 0)
length = 0;
- length /= sizeof(videodata->ime_composition[0]);
+ length /= sizeof(WCHAR);
videodata->ime_cursor = LOWORD(ImmGetCompositionStringW(himc, GCS_CURSORPOS, 0, 0));
- if (videodata->ime_cursor > 0 &&
- videodata->ime_cursor < SDL_arraysize(videodata->ime_composition) &&
- videodata->ime_composition[videodata->ime_cursor] == 0x3000) {
+ if ((dwLang == LANG_CHT || dwLang == LANG_CHS) &&
+ videodata->ime_cursor > 0 &&
+ videodata->ime_cursor < videodata->ime_composition_length / sizeof(WCHAR) &&
+ (videodata->ime_composition[0] == 0x3000 || videodata->ime_composition[0] == 0x0020)) {
+ // Traditional Chinese IMEs add a placeholder U+3000
+ // Simplified Chinese IMEs seem to add a placholder U+0020 sometimes
int i;
for (i = videodata->ime_cursor + 1; i < length; ++i)
videodata->ime_composition[i - 1] = videodata->ime_composition[i];
@@ -762,6 +811,39 @@ IME_GetCompositionString(SDL_VideoData *videodata, HIMC himc, DWORD string)
}
videodata->ime_composition[length] = 0;
+
+ // Get the correct caret position if we've selected a candidate from the candidate window
+ if (videodata->ime_cursor == 0 && length > 0) {
+ Sint32 start = 0;
+ Sint32 end = 0;
+
+ length = ImmGetCompositionStringW(himc, GCS_COMPATTR, NULL, 0);
+ if (length > 0) {
+ Uint8* attributes = (Uint8*)SDL_malloc(length);
+ ImmGetCompositionString(himc, GCS_COMPATTR, attributes, length);
+
+ for (start = 0; start < length; ++start) {
+ if (attributes[start] == ATTR_TARGET_CONVERTED ||
+ attributes[start] == ATTR_TARGET_NOTCONVERTED)
+ break;
+ }
+
+ for (end = start; end < length; ++end) {
+ if (attributes[end] != ATTR_TARGET_CONVERTED &&
+ attributes[end] != ATTR_TARGET_NOTCONVERTED)
+ break;
+ }
+
+ if (start == length) {
+ start = 0;
+ end = length;
+ }
+
+ SDL_free(attributes);
+ }
+
+ videodata->ime_cursor = end;
+ }
}
static void
@@ -780,22 +862,30 @@ IME_SendInputEvent(SDL_VideoData *videodata)
static void
IME_SendEditingEvent(SDL_VideoData *videodata)
{
- char *s = 0;
- WCHAR buffer[SDL_TEXTEDITINGEVENT_TEXT_SIZE];
- const size_t size = SDL_arraysize(buffer);
- buffer[0] = 0;
+ char *s = NULL;
+ WCHAR *buffer = NULL;
+ size_t size = videodata->ime_composition_length;
if (videodata->ime_readingstring[0]) {
size_t len = SDL_min(SDL_wcslen(videodata->ime_composition), (size_t)videodata->ime_cursor);
+
+ size += sizeof(videodata->ime_readingstring);
+ buffer = (WCHAR*)SDL_malloc(size);
+ buffer[0] = 0;
+
SDL_wcslcpy(buffer, videodata->ime_composition, len + 1);
SDL_wcslcat(buffer, videodata->ime_readingstring, size);
SDL_wcslcat(buffer, &videodata->ime_composition[len], size);
}
else {
+ buffer = (WCHAR*)SDL_malloc(size);
+ buffer[0] = 0;
SDL_wcslcpy(buffer, videodata->ime_composition, size);
}
+
s = WIN_StringToUTF8W(buffer);
SDL_SendEditingText(s, videodata->ime_cursor + (int)SDL_wcslen(videodata->ime_readingstring), 0);
SDL_free(s);
+ SDL_free(buffer);
}
static void
@@ -914,6 +1004,15 @@ IME_HandleMessage(HWND hwnd, UINT msg, WPARAM wParam, LPARAM *lParam, SDL_VideoD
return SDL_FALSE;
switch (msg) {
+ case WM_KEYDOWN:
+ if (wParam == VK_PROCESSKEY)
+ {
+ videodata->ime_uicontext = 1;
+ trap = SDL_TRUE;
+ }
+ else
+ videodata->ime_uicontext = 0;
+ break;
case WM_INPUTLANGCHANGE:
IME_InputLangChanged(videodata);
break;
@@ -922,14 +1021,17 @@ IME_HandleMessage(HWND hwnd, UINT msg, WPARAM wParam, LPARAM *lParam, SDL_VideoD
*lParam = 0;
}
break;
- case WM_IME_STARTCOMPOSITION:
+ case WM_IME_STARTCOMPOSITION:
+ videodata->ime_suppress_endcomposition_event = SDL_FALSE;
trap = SDL_TRUE;
break;
case WM_IME_COMPOSITION:
trap = SDL_TRUE;
himc = ImmGetContext(hwnd);
if (*lParam & GCS_RESULTSTR) {
+ videodata->ime_suppress_endcomposition_event = SDL_TRUE;
IME_GetCompositionString(videodata, himc, GCS_RESULTSTR);
+ SDL_SendEditingText("", 0, 0);
IME_SendInputEvent(videodata);
}
if (*lParam & GCS_COMPSTR) {
@@ -942,10 +1044,13 @@ IME_HandleMessage(HWND hwnd, UINT msg, WPARAM wParam, LPARAM *lParam, SDL_VideoD
ImmReleaseContext(hwnd, himc);
break;
case WM_IME_ENDCOMPOSITION:
+ videodata->ime_uicontext = 0;
videodata->ime_composition[0] = 0;
videodata->ime_readingstring[0] = 0;
videodata->ime_cursor = 0;
- SDL_SendEditingText("", 0, 0);
+ if (videodata->ime_suppress_endcomposition_event == SDL_FALSE)
+ SDL_SendEditingText("", 0, 0);
+ videodata->ime_suppress_endcomposition_event = SDL_FALSE;
break;
case WM_IME_NOTIFY:
switch (wParam) {
@@ -959,10 +1064,12 @@ IME_HandleMessage(HWND hwnd, UINT msg, WPARAM wParam, LPARAM *lParam, SDL_VideoD
break;
trap = SDL_TRUE;
+ videodata->ime_uicontext = 1;
IME_GetCandidateList(hwnd, videodata);
break;
case IMN_CLOSECANDIDATE:
trap = SDL_TRUE;
+ videodata->ime_uicontext = 0;
IME_HideCandidateList(videodata);
break;
case IMN_PRIVATE:
diff --git a/src/video/windows/SDL_windowskeyboard.h b/src/video/windows/SDL_windowskeyboard.h
index 76048e7..97382c7 100644
--- a/src/video/windows/SDL_windowskeyboard.h
+++ b/src/video/windows/SDL_windowskeyboard.h
@@ -32,6 +32,8 @@ extern void WIN_ResetDeadKeys(void);
extern void WIN_StartTextInput(_THIS);
extern void WIN_StopTextInput(_THIS);
extern void WIN_SetTextInputRect(_THIS, SDL_Rect *rect);
+extern void WIN_ClearComposition(_THIS);
+extern SDL_bool WIN_IsTextInputShown(_THIS);
extern SDL_bool IME_HandleMessage(HWND hwnd, UINT msg, WPARAM wParam, LPARAM *lParam, struct SDL_VideoData *videodata);
diff --git a/src/video/windows/SDL_windowsvideo.c b/src/video/windows/SDL_windowsvideo.c
index 3980693..4bd2a98 100644
--- a/src/video/windows/SDL_windowsvideo.c
+++ b/src/video/windows/SDL_windowsvideo.c
@@ -216,6 +216,8 @@ WIN_CreateDevice(int devindex)
device->StartTextInput = WIN_StartTextInput;
device->StopTextInput = WIN_StopTextInput;
device->SetTextInputRect = WIN_SetTextInputRect;
+ device->ClearComposition = WIN_ClearComposition;
+ device->IsTextInputShown = WIN_IsTextInputShown;
device->SetClipboardText = WIN_SetClipboardText;
device->GetClipboardText = WIN_GetClipboardText;
diff --git a/src/video/windows/SDL_windowsvideo.h b/src/video/windows/SDL_windowsvideo.h
index daf68e6..d4208c4 100644
--- a/src/video/windows/SDL_windowsvideo.h
+++ b/src/video/windows/SDL_windowsvideo.h
@@ -151,9 +151,11 @@ typedef struct SDL_VideoData
SDL_bool ime_available;
HWND ime_hwnd_main;
HWND ime_hwnd_current;
+ SDL_bool ime_suppress_endcomposition_event;
HIMC ime_himc;
- WCHAR ime_composition[SDL_TEXTEDITINGEVENT_TEXT_SIZE];
+ WCHAR* ime_composition;
+ int ime_composition_length;
WCHAR ime_readingstring[16];
int ime_cursor;
@@ -189,6 +191,7 @@ typedef struct SDL_VideoData
DWORD ime_convmodesinkcookie;
TSFSink *ime_uielemsink;
TSFSink *ime_ippasink;
+ LONG ime_uicontext;
BYTE pre_hook_key_state[256];
UINT _SDL_WAKEUP;