8301900: TextArea: Committing text with ENTER in an IME window inserts newline

8088172: Mac: On German keyboard, pressing <+><q> inserts two apostrophes instead of one
8089803: [Mac, TextArea] Japanese IME, caret moves to the next line when pressing Return to select a candidate.

Reviewed-by: kcr, angorya

Author: Martin Fox

modules/javafx.graphics/src/main/java/com/sun/glass/ui/View.java

@@ -386,7 +386,7 @@ public static int getMultiClickMaxY() {
 
     protected abstract void _enableInputMethodEvents(long ptr, boolean enable);
     protected void _finishInputMethodComposition(long ptr) {
-        // Action needed only on Windows.
+        // Action needed only on some platforms.
     }
 
     /*

modules/javafx.graphics/src/main/native-glass/mac/GlassView3D.h

@@ -50,7 +50,8 @@
 
     NSAttributedString *nsAttrBuffer;
     BOOL imEnabled;
-    BOOL shouldProcessKeyEvent;
+    BOOL handlingKeyEvent;
+    BOOL didCommitText;
     BOOL isHiDPIAware;
 }
 

modules/javafx.graphics/src/main/native-glass/mac/GlassView3D.m

@@ -247,7 +247,8 @@ - (id)initWithFrame:(NSRect)frame withJview:(jobject)jView withJproperties:(jobj
         [self addTrackingArea: self->_trackingArea];
         self->nsAttrBuffer = [[NSAttributedString alloc] initWithString:@""];
         self->imEnabled = NO;
-        self->shouldProcessKeyEvent = YES;
+        self->handlingKeyEvent = NO;
+        self->didCommitText = NO;
     }
     return self;
 }
@@ -380,12 +381,9 @@ - (void)mouseExited:(NSEvent *)theEvent
 - (void)mouseDown:(NSEvent *)theEvent
 {
     MOUSELOG("mouseDown");
-    // First check if system Input Method Engine needs to handle this event
-    NSInputManager *inputManager = [NSInputManager currentInputManager];
-    if ([inputManager wantsToHandleMouseEvents]) {
-        if ([inputManager handleMouseEvent:theEvent]) {
-            return;
-        }
+    // First check if system Input Context needs to handle this event
+    if ([self.inputContext handleEvent:theEvent]) {
+        return;
     }
     [self->_delegate sendJavaMouseEvent:theEvent];
 }
@@ -476,10 +474,10 @@ - (BOOL)performKeyEquivalent:(NSEvent *)theEvent
     // create extra KeyEvents.
     //
     NSString *chars = [theEvent charactersIgnoringModifiers];
-    if ([theEvent type] == NSKeyDown && [chars length] > 0)
+    if ([theEvent type] == NSEventTypeKeyDown && [chars length] > 0)
     {
         unichar uch = [chars characterAtIndex:0];
-        if ([theEvent modifierFlags] & NSCommandKeyMask &&
+        if ([theEvent modifierFlags] & NSEventModifierFlagCommand &&
             (uch == com_sun_glass_events_KeyEvent_VK_PERIOD ||
              uch == com_sun_glass_events_KeyEvent_VK_EQUALS))
         {
@@ -513,11 +511,25 @@ - (void)keyDown:(NSEvent *)theEvent
 {
     KEYLOG("keyDown");
 
-    if (![[self inputContext] handleEvent:theEvent] || shouldProcessKeyEvent) {
+    handlingKeyEvent = YES;
+    didCommitText = NO;
+    BOOL hadMarkedText = (nsAttrBuffer.length > 0);
+    BOOL inputContextHandledEvent = (imEnabled && [self.inputContext handleEvent:theEvent]);
+    handlingKeyEvent = NO;
+
+    if (didCommitText) {
+        // Exit composition mode
+        didCommitText = NO;
+        nsAttrBuffer = [nsAttrBuffer initWithString: @""];
+    } else if (hadMarkedText) {
+        // Either we still have marked text or the keystroke removed it
+        // (ESC can do that). In either case we don't want to generate a key
+        // event.
+        ;
+    } else if (!inputContextHandledEvent || (nsAttrBuffer.length == 0)) {
         [GlassApplication registerKeyEvent:theEvent];
         [self->_delegate sendJavaKeyEvent:theEvent isDown:YES];
     }
-    shouldProcessKeyEvent = YES;
 }
 
 - (void)keyUp:(NSEvent *)theEvent
@@ -715,8 +727,15 @@ - (GlassViewDelegate*)delegate
 - (void)setInputMethodEnabled:(BOOL)enabled
 {
     IMLOG("setInputMethodEnabled called with arg is %s", (enabled ? "YES" : "NO") );
-    [self unmarkText];
-    self->imEnabled = enabled;
+    if (enabled != imEnabled) {
+        // If enabled is false this has nowhere to go. If enabled is true this
+        // wasn't intended for the newly focused node.
+        if (nsAttrBuffer.length) {
+            nsAttrBuffer = [nsAttrBuffer initWithString:@""];
+        }
+        [self.inputContext discardMarkedText];
+        imEnabled = enabled;
+    }
 }
 
 - (void)finishInputMethodComposition
@@ -739,27 +758,34 @@ - (void)commitString:(NSString*)aString
 - (void)doCommandBySelector:(SEL)aSelector
 {
     IMLOG("doCommandBySelector called ");
-    // In case the IM was stopped with a mouse and the next typed key
-    // is a special command key (backspace, tab, etc.)
-    self->shouldProcessKeyEvent = YES;
+    // According to Apple an NSResponder will send this up the responder chain
+    // but a text input client should not. So we ignore this which avoids an
+    // annoying beep.
 }
 
 - (void) insertText:(id)aString replacementRange:(NSRange)replacementRange
 {
     IMLOG("insertText called with string: %s", [aString UTF8String]);
     if ([self->nsAttrBuffer length] > 0 || [aString length] > 1) {
+        self->didCommitText = YES;
         [self commitString: aString];
-        self->shouldProcessKeyEvent = NO;
-    } else {
-        self->shouldProcessKeyEvent = YES;
     }
-    self->nsAttrBuffer = [self->nsAttrBuffer initWithString:@""];
+
+    // If a user tries to enter an invalid character using a dead key
+    // combination (like, say, a q with a grave accent) insertText will be
+    // called twice on the last keystroke, first with the accent and then
+    // with the letter. We want both inserts to be handled as committed text
+    // so we defer exiting composition mode until the keystroke is processed.
+    // We only defer on keystrokes because sometimes insertText is called
+    // when a mouse event dismisses the IM window.
+    if (!self->handlingKeyEvent) {
+        self->nsAttrBuffer = [self->nsAttrBuffer initWithString:@""];
+    }
 }
 
 - (void) setMarkedText:(id)aString selectedRange:(NSRange)selectionRange replacementRange:(NSRange)replacementRange
 {
     if (!self->imEnabled) {
-        self->shouldProcessKeyEvent = YES;
         return;
     }
     BOOL isAttributedString = [aString isKindOfClass:[NSAttributedString class]];
@@ -769,7 +795,6 @@ - (void) setMarkedText:(id)aString selectedRange:(NSRange)selectionRange replace
     [self->_delegate notifyInputMethod:incomingString attr:1 length:0 cursor:(int)[incomingString length] selectedRange:selectionRange ];
     self->nsAttrBuffer = (attrString == nil ? [self->nsAttrBuffer initWithString:incomingString]
                                             : [self->nsAttrBuffer initWithAttributedString: attrString]);
-    self->shouldProcessKeyEvent = NO;
 }
 
 - (void) unmarkText
@@ -779,7 +804,6 @@ - (void) unmarkText
         [self commitString: nsAttrBuffer.string];
         nsAttrBuffer = [nsAttrBuffer initWithString:@""];
     }
-    self->shouldProcessKeyEvent = YES;
 }
 
 - (BOOL) hasMarkedText