/***************************************************************************** * Copyright (c) 2014-2022 OpenRCT2 developers * * For a complete list of all authors, please refer to contributors.md * Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2 * * OpenRCT2 is licensed under the GNU General Public License version 3. *****************************************************************************/ #include "TextComposition.h" #include "UiContext.h" #include "interface/InGameConsole.h" #include #include #include #include #include #include #include #include #ifdef __MACOSX__ // macOS uses COMMAND rather than CTRL for many keyboard shortcuts # define KEYBOARD_PRIMARY_MODIFIER KMOD_GUI #else # define KEYBOARD_PRIMARY_MODIFIER KMOD_CTRL #endif using namespace OpenRCT2; using namespace OpenRCT2::Ui; bool TextComposition::IsActive() { return SDL_IsTextInputActive() && _session.Buffer != nullptr; } TextInputSession* TextComposition::Start(utf8* buffer, size_t bufferSize) { Guard::ArgumentNotNull(buffer); // TODO This doesn't work, and position could be improved to where text entry is SDL_Rect rect = { 10, 10, 100, 100 }; SDL_SetTextInputRect(&rect); SDL_StartTextInput(); _session.Buffer = buffer; _session.BufferSize = bufferSize - 1; _session.Size = strlen(buffer); _session.SelectionStart = _session.Size; _session.SelectionSize = 0; _session.ImeBuffer = _imeBuffer; RecalculateLength(); return &_session; } void TextComposition::Stop() { SDL_StopTextInput(); _session.Buffer = nullptr; _session.ImeBuffer = nullptr; _imeActive = false; } void TextComposition::HandleMessage(const SDL_Event* e) { auto& console = GetInGameConsole(); switch (e->type) { case SDL_TEXTEDITING: // When inputting Korean characters, `edit.length` is always zero String::Set(_imeBuffer, sizeof(_imeBuffer), e->edit.text); _imeStart = e->edit.start; _imeLength = e->edit.length; _imeActive = ((e->edit.length != 0 || String::SizeOf(e->edit.text) != 0) && _imeBuffer[0] != '\0'); break; case SDL_TEXTINPUT: // will receive an `SDL_TEXTINPUT` event when a composition is committed _imeActive = false; _imeBuffer[0] = '\0'; if (_session.Buffer != nullptr) { // HACK ` will close console, so don't input any text if (e->text.text[0] == '`' && console.IsOpen()) { break; } utf8* newText = String::Duplicate(e->text.text); Insert(newText); Memory::Free(newText); console.RefreshCaret(_session.SelectionStart); window_update_textbox(); } break; case SDL_KEYDOWN: { if (_imeActive) { break; } uint16_t modifier = e->key.keysym.mod; SDL_Keycode key = e->key.keysym.sym; SDL_Scancode scancode = e->key.keysym.scancode; if (key == SDLK_KP_ENTER) { // Map Keypad enter to regular enter. key = SDLK_RETURN; scancode = SDL_SCANCODE_RETURN; } GetContext()->GetUiContext()->SetKeysPressed(key, scancode); // Text input if (_session.Buffer == nullptr) { break; } // Clear the input on Backspace (Windows/Linux) or Backspace (macOS) if (key == SDLK_BACKSPACE && (modifier & KEYBOARD_PRIMARY_MODIFIER)) { Clear(); console.RefreshCaret(_session.SelectionStart); window_update_textbox(); } switch (key) { case SDLK_BACKSPACE: // If backspace and we have input text with a cursor position nonzero if (_session.SelectionStart > 0) { size_t endOffset = _session.SelectionStart; CursorLeft(); _session.SelectionSize = endOffset - _session.SelectionStart; Delete(); console.RefreshCaret(_session.SelectionStart); window_update_textbox(); } break; case SDLK_HOME: CursorHome(); console.RefreshCaret(_session.SelectionStart); break; case SDLK_END: CursorEnd(); console.RefreshCaret(_session.SelectionStart); break; case SDLK_DELETE: { size_t startOffset = _session.SelectionStart; CursorRight(); _session.SelectionSize = _session.SelectionStart - startOffset; _session.SelectionStart = startOffset; Delete(); console.RefreshCaret(_session.SelectionStart); window_update_textbox(); break; } case SDLK_RETURN: window_cancel_textbox(); break; case SDLK_LEFT: CursorLeft(); console.RefreshCaret(_session.SelectionStart); break; case SDLK_RIGHT: CursorRight(); console.RefreshCaret(_session.SelectionStart); break; case SDLK_c: if ((modifier & KEYBOARD_PRIMARY_MODIFIER) && _session.Length) { SDL_SetClipboardText(_session.Buffer); context_show_error(STR_COPY_INPUT_TO_CLIPBOARD, STR_NONE, {}); } break; case SDLK_v: if ((modifier & KEYBOARD_PRIMARY_MODIFIER) && SDL_HasClipboardText()) { utf8* text = SDL_GetClipboardText(); Insert(text); SDL_free(text); window_update_textbox(); } break; } } } } void TextComposition::CursorHome() { _session.SelectionStart = 0; } void TextComposition::CursorEnd() { size_t selectionOffset = _session.Size; const utf8* ch = _session.Buffer + _session.SelectionStart; while (!utf8_is_codepoint_start(ch) && selectionOffset > 0) { ch--; selectionOffset--; } _session.SelectionStart = selectionOffset; } void TextComposition::CursorLeft() { size_t selectionOffset = _session.SelectionStart; if (selectionOffset > 0) { const utf8* ch = _session.Buffer + selectionOffset; do { ch--; selectionOffset--; } while (!utf8_is_codepoint_start(ch) && selectionOffset > 0); _session.SelectionStart = selectionOffset; } } void TextComposition::CursorRight() { size_t selectionOffset = _session.SelectionStart; size_t selectionMaxOffset = _session.Size; if (selectionOffset < selectionMaxOffset) { const utf8* ch = _session.Buffer + _session.SelectionStart; do { ch++; selectionOffset++; } while (!utf8_is_codepoint_start(ch) && selectionOffset < selectionMaxOffset); _session.SelectionSize = std::max(0, _session.SelectionSize - (selectionOffset - _session.SelectionStart)); _session.SelectionStart = selectionOffset; } } void TextComposition::Insert(const utf8* text) { const utf8* ch = text; uint32_t codepoint; while ((codepoint = utf8_get_next(ch, &ch)) != 0) { InsertCodepoint(codepoint); } } void TextComposition::InsertCodepoint(codepoint_t codepoint) { size_t codepointLength = utf8_get_codepoint_length(codepoint); size_t remainingSize = _session.BufferSize - _session.Size; if (codepointLength <= remainingSize) { utf8* buffer = _session.Buffer; utf8* insertPtr = buffer + _session.SelectionStart; if (_session.SelectionStart < _session.Size) { // Shift bytes (including null terminator) right to make room for new codepoint utf8* targetShiftPtr = insertPtr + codepointLength; size_t shiftSize = _session.Size - _session.SelectionStart + 1; memmove(targetShiftPtr, insertPtr, shiftSize); } else { // Character is appended onto the end, so set byte after it to null terminator buffer[_session.Size + codepointLength] = 0; } utf8_write_codepoint(insertPtr, codepoint); _session.SelectionStart += codepointLength; _session.Size += codepointLength; _session.Length++; } } void TextComposition::Clear() { utf8* buffer = _session.Buffer; buffer[0] = 0; _session.Size = 0; _session.Length = 0; _session.SelectionStart = 0; _session.SelectionSize = 0; } void TextComposition::Delete() { size_t selectionOffset = _session.SelectionStart; size_t selectionMaxOffset = _session.Size; // Find out how many bytes to delete. const utf8* ch = _session.Buffer + _session.SelectionStart; do { ch++; selectionOffset++; } while (!utf8_is_codepoint_start(ch) && selectionOffset < selectionMaxOffset); utf8* buffer = _session.Buffer; utf8* targetShiftPtr = buffer + _session.SelectionStart; utf8* sourceShiftPtr = targetShiftPtr + _session.SelectionSize; size_t bytesToSkip = selectionOffset - _session.SelectionStart; // std::min() is used to ensure that shiftSize doesn't underflow; it should be between 0 and _session.Size size_t shiftSize = _session.Size - std::min(_session.Size, (_session.SelectionStart - _session.SelectionSize + bytesToSkip)); memmove(targetShiftPtr, sourceShiftPtr, shiftSize); _session.SelectionSize = 0; RecalculateLength(); } void TextComposition::RecalculateLength() { _session.Size = String::SizeOf(_session.Buffer); _session.Length = String::LengthOf(_session.Buffer); }