Refactor iOS text input activation to better work with hardware keyboards #11406
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -80,8 +80,6 @@ @implementation SDL_uikitviewcontroller | |
|
|
||
| #ifdef SDL_IPHONE_KEYBOARD | ||
| SDLUITextField *textField; | ||
| BOOL hidingKeyboard; | ||
| BOOL rotatingOrientation; | ||
| NSString *committedText; | ||
|
|
@@ -98,8 +96,6 @@ - (instancetype)initWithSDLWindow:(SDL_Window *)_window | |
|
|
||
| #ifdef SDL_IPHONE_KEYBOARD | ||
| [self initKeyboard]; | ||
| hidingKeyboard = NO; | ||
| rotatingOrientation = NO; | ||
| #endif | ||
|
|
@@ -266,7 +262,7 @@ - (BOOL)prefersPointerLocked | |
|
|
||
| @synthesize textInputRect; | ||
| @synthesize keyboardHeight; | ||
| @synthesize textFieldFocused; | ||
|
|
||
| // Set ourselves up as a UITextFieldDelegate | ||
| - (void)initKeyboard | ||
|
|
@@ -279,18 +275,14 @@ - (void)initKeyboard | |
| committedText = textField.text; | ||
|
|
||
| textField.hidden = YES; | ||
| textFieldFocused = NO; | ||
|
|
||
| NSNotificationCenter *center = [NSNotificationCenter defaultCenter]; | ||
| #ifndef SDL_PLATFORM_TVOS | ||
| [center addObserver:self | ||
| selector:@selector(keyboardWillShow:) | ||
| name:UIKeyboardWillShowNotification | ||
| object:nil]; | ||
| [center addObserver:self | ||
| selector:@selector(keyboardWillHide:) | ||
| name:UIKeyboardWillHideNotification | ||
|
|
@@ -345,8 +337,10 @@ - (void)setView:(UIView *)view | |
|
|
||
| [view addSubview:textField]; | ||
|
|
||
| if (textFieldFocused) { | ||
| /* startTextInput has been called before the text field was added to the view, | ||
| * call it again for the text field to actually become first responder. */ | ||
| [self startTextInput]; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -369,9 +363,6 @@ - (void)deinitKeyboard | |
| [center removeObserver:self | ||
| name:UIKeyboardWillShowNotification | ||
| object:nil]; | ||
| [center removeObserver:self | ||
| name:UIKeyboardWillHideNotification | ||
| object:nil]; | ||
|
|
@@ -384,7 +375,7 @@ - (void)deinitKeyboard | |
| object:nil]; | ||
| } | ||
|
|
||
| - (void)setTextFieldProperties:(SDL_PropertiesID) props | ||
| { | ||
| textField.secureTextEntry = NO; | ||
|
|
||
|
|
@@ -479,45 +470,53 @@ - (void)setKeyboardProperties:(SDL_PropertiesID) props | |
| } else { | ||
| textField.enablesReturnKeyAutomatically = NO; | ||
| } | ||
|
|
||
| if (!textField.window) { | ||
| /* textField has not been added to the view yet, | ||
| we don't have to do anything. */ | ||
| return; | ||
| } | ||
|
|
||
| // the text field needs to be re-added to the view in order to update correctly. | ||
| UIView *superview = textField.superview; | ||
| [textField removeFromSuperview]; | ||
| [superview addSubview:textField]; | ||
|
|
||
| if (SDL_TextInputActive(window)) { | ||
| [textField becomeFirstResponder]; | ||
| } | ||
| } | ||
|
|
||
| /* requests the SDL text field to become focused and accept text input. | ||
| * also shows the onscreen virtual keyboard if no hardware keyboard is attached. */ | ||
| - (bool)startTextInput | ||
| { | ||
| textFieldFocused = YES; | ||
| if (!textField.window) { | ||
| /* textField has not been added to the view yet, | ||
| * we will try again when that happens. */ | ||
| return true; | ||
| } | ||
|
|
||
| return [textField becomeFirstResponder]; | ||
| } | ||
|
|
||
| /* requests the SDL text field to lose focus and stop accepting text input. | ||
| * also hides the onscreen virtual keyboard if no hardware keyboard is attached. */ | ||
| - (bool)stopTextInput | ||
| { | ||
| textFieldFocused = NO; | ||
| if (!textField.window) { | ||
| /* textField has not been added to the view yet, | ||
| * we will try again when that happens. */ | ||
| return true; | ||
| } | ||
|
|
||
| return [textField resignFirstResponder]; | ||
| } | ||
|
|
||
| - (void)keyboardWillShow:(NSNotification *)notification | ||
| { | ||
| #ifndef SDL_PLATFORM_TVOS | ||
| CGRect kbrect = [[notification userInfo][UIKeyboardFrameEndUserInfoKey] CGRectValue]; | ||
|
|
||
|
|
@@ -528,28 +527,29 @@ - (void)keyboardWillShow:(NSNotification *)notification | |
| [self setKeyboardHeight:(int)kbrect.size.height]; | ||
| #endif | ||
|
|
||
| /* A keyboard hide transition has been interrupted with a show (keyboardWillHide has been called but keyboardDidHide didn't). | ||
| * since text input was stopped by the hide, we have to start it again. */ | ||
| if (hidingKeyboard) { | ||
| SDL_StartTextInput(window); | ||
| hidingKeyboard = NO; | ||
| } | ||
| } | ||
|
|
||
| - (void)keyboardWillHide:(NSNotification *)notification | ||
| { | ||
| hidingKeyboard = YES; | ||
| [self setKeyboardHeight:0]; | ||
|
|
||
| /* When the user dismisses the software keyboard by the "hide" button in the bottom right corner, | ||
| * we want to reflect that on SDL_TextInputActive by calling SDL_StopTextInput...on certain conditions */ | ||
| if (SDL_TextInputActive(window) | ||
| /* keyboardWillHide gets called when a hardware keyboard is attached, | ||
| * keep text input state active if hiding while there is a hardware keyboard. | ||
| * if the hardware keyboard gets detached, the software keyboard will appear anyway. */ | ||
| && !SDL_HasKeyboard() | ||
| /* When the device changes orientation, a sequence of hide and show transitions are triggered. | ||
| * keep text input state active in this case. */ | ||
| && !rotatingOrientation) { | ||
| SDL_StopTextInput(window); | ||
| } | ||
|
Comment on lines
+543
to
554
There was a problem hiding this comment. Upon further testing, having this also breaks password manager integrations (when setting RPReplay_Final1730711349.MP4Notice how pressing the "Passwords" button in the keyboard hides the keyboard, which triggers the SDL application to stop text input. This is problematic because when the user selects their password from the keychain, the input is ignored since text input is not active. I think it would be a better option to keep text input state completely manual rather than tied to the state of the keyboard, and do away with all these conditionals that are set in place here. @slouken thoughts? do other platforms (aka Android) stop text input when the user hides the keyboard? There was a problem hiding this comment. Yes, the expectation is that text input state is tied to the visibility of the on-screen keyboard, if there is no hardware keyboard attached. There was a problem hiding this comment. Since this is SDL 3.0, we can revisit that assumption, but that's the way it is currently. Bringing up the on-screen keyboard on Android, for example, will enable text input so it can be used to input text into the application. There was a problem hiding this comment. With the situation above, there is no possible way to enter the selected password without breaking that assumption, unless SDL can somehow bypass the "text input active" check when sending text events and do that on Assuming that each application that starts text input has a path for stopping text input, it would be much easier to keep text input state manual and detached from the visibility of the on-screen keyboard, to allow integration with password managers etc. |
||
| } | ||
|
|
@@ -632,7 +632,6 @@ - (void)updateKeyboard | |
|
|
||
| - (void)setKeyboardHeight:(int)height | ||
| { | ||
| keyboardHeight = height; | ||
| [self updateKeyboard]; | ||
| } | ||
|
|
@@ -653,7 +652,7 @@ - (BOOL)textField:(UITextField *)_textField shouldChangeCharactersInRange:(NSRan | |
| - (BOOL)textFieldShouldReturn:(UITextField *)_textField | ||
| { | ||
| SDL_SendKeyboardKeyAutoRelease(0, SDL_SCANCODE_RETURN); | ||
| if (textFieldFocused && | ||
| SDL_GetHintBoolean(SDL_HINT_RETURN_KEY_HIDES_IME, false)) { | ||
| SDL_StopTextInput(window); | ||
| } | ||
|
|
@@ -684,20 +683,27 @@ bool UIKit_HasScreenKeyboardSupport(SDL_VideoDevice *_this) | |
| return true; | ||
| } | ||
|
|
||
| bool UIKit_StartTextInput(SDL_VideoDevice *_this, SDL_Window *window, SDL_PropertiesID props) | ||
| { | ||
| @autoreleasepool { | ||
| SDL_uikitviewcontroller *vc = GetWindowViewController(window); | ||
| return [vc startTextInput]; | ||
| } | ||
| } | ||
|
|
||
| bool UIKit_StopTextInput(SDL_VideoDevice *_this, SDL_Window *window) | ||
| { | ||
| @autoreleasepool { | ||
| SDL_uikitviewcontroller *vc = GetWindowViewController(window); | ||
| return [vc stopTextInput]; | ||
| } | ||
| } | ||
|
|
||
| void UIKit_SetTextInputProperties(SDL_VideoDevice *_this, SDL_Window *window, SDL_PropertiesID props) | ||
| { | ||
| @autoreleasepool { | ||
| SDL_uikitviewcontroller *vc = GetWindowViewController(window); | ||
| [vc setTextFieldProperties:props]; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -706,7 +712,7 @@ bool UIKit_IsScreenKeyboardShown(SDL_VideoDevice *_this, SDL_Window *window) | |
| @autoreleasepool { | ||
| SDL_uikitviewcontroller *vc = GetWindowViewController(window); | ||
| if (vc != nil) { | ||
| return vc.textFieldFocused; | ||
| } | ||
| return false; | ||
| } | ||
|
|
@@ -719,7 +725,7 @@ bool UIKit_UpdateTextInputArea(SDL_VideoDevice *_this, SDL_Window *window) | |
| if (vc != nil) { | ||
| vc.textInputRect = window->text_input_rect; | ||
|
|
||
| if (vc.textFieldFocused) { | ||
| [vc updateKeyboard]; | ||
| } | ||
| } | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can technically be split to a separate PR but I figured I could include it in this PR since I'm touching the entire file anyway.