mirrors/JetBrainsRuntime
1
0
Fork 0
mirror of https://github.com/JetBrains/JetBrainsRuntime.git synced 2025-12-06 09:29:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

JBR-5075: macOS: KEY_PRESSED event for "Cmd N" is not emitted if used as a JMenuItem accelerator and apple.laf.useScreenMenuBar=true.

Browse Source 
- Improves the fix of JBR-3544 to allow "Cmd N" and "Ctrl N" to reach AWT if they're actually the ones which were pressed.
- Adds a regression test.

(cherry picked from commit 61a1b70d73)
(cherry picked from commit c3f068760d)
This commit is contained in:
Nikita Provotorov
2022-12-10 06:36:58 +02:00
committed by jbrbot
parent 015f34f2c8
commit ccf4e6eb1a
2 changed files with 395 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/java.desktop/macosx/native/libawt_lwawt/awt/AWTView.m
View File

@@ -366,18 +366,27 @@ extern bool isSystemShortcut_NextWindowInApplication(NSUInteger modifiersMask, N
}
- (BOOL) performKeyEquivalent: (NSEvent *) event {
// if IM is active key events should be ignored
if (![self hasMarkedText] && !fInPressAndHold) {
[self deliverJavaKeyEventHelper: event];
}
const NSUInteger modFlags =
[event modifierFlags] & (NSCommandKeyMask | NSAlternateKeyMask | NSShiftKeyMask | NSControlKeyMask);
// Workaround for JBR-3544
// When tabbing mode is on, macOS sends "Ctrl N" and "Cmd N" when "Ctrl Opt N" and "Cmd Opt N" are pressed
if ([event keyCode] == 45 && ((modFlags == NSControlKeyMask) || (modFlags == NSCommandKeyMask))) {
return NO;
}
// When tabbing mode is on (jdk.allowMacOSTabbedWindows=true) and "Ctrl Opt N" / "Cmd Opt N" is pressed,
// macOS first sends it, and immediately then sends "Ctrl N" / "Cmd N".
// The workaround is to "eat" (by returning TRUE) the "Ctrl Opt N" / "Cmd Opt N",
// so macOS won't send its "fallback" version ("Ctrl N" / "Cmd N").
if ([event keyCode] == kVK_ANSI_N) {
const NSUInteger ctrlOpt = (NSControlKeyMask | NSAlternateKeyMask);
const NSUInteger cmdOpt = (NSCommandKeyMask | NSAlternateKeyMask);
// if IM is active key events should be ignored
if (![self hasMarkedText] && !fInPressAndHold) {
[self deliverJavaKeyEventHelper: event];
if ((modFlags == ctrlOpt) || (modFlags == cmdOpt)) {
[[NSApp mainMenu] performKeyEquivalent: event]; // just in case (as in the workaround for 8020209 below)
return YES;
}
}
// Workaround for 8020209: special case for "Cmd =" and "Cmd ."

379
test/jdk/jb/java/awt/keyboard/CmdNMustTriggerMenuAccelerator5075.java Normal file
View File

@@ -0,0 +1,379 @@
/*
* Copyright 2022 JetBrains s.r.o.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
import javax.swing.*;
import java.awt.*;
import java.awt.event.*;
import java.lang.reflect.InvocationTargetException;
import java.util.Objects;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
/**
* @test
* @summary Regression test for JBR-5075 ensures that pressing Cmd+N / Ctrl+N triggers the bound menu action
* regardless of whether the menu is native (apple.laf.useScreenMenuBar=true) or not
* @author Nikita Provotorov
* @key headful
* @requires (os.family == "mac")
* @run main/othervm/timeout=5 -Dapple.laf.useScreenMenuBar=false CmdNMustTriggerMenuAccelerator5075
* @run main/othervm/timeout=5 -Dapple.laf.useScreenMenuBar=true CmdNMustTriggerMenuAccelerator5075
*/
public class CmdNMustTriggerMenuAccelerator5075 extends JFrame {
public static void main(String[] args) throws Throwable {
System.out.println("Initializing..."); System.out.flush();
// Setup key event listener
Toolkit.getDefaultToolkit().addAWTEventListener(
keyEvent -> awaitableEvents.add(new AwaitableEvent((KeyEvent)keyEvent)),
AWTEvent.KEY_EVENT_MASK
);
final Robot robot = createRobot();
createAndShowGUI();
try {
robot.waitForIdle();
{ // Cmd+N
System.out.println("Done. Pressing Cmd+N..."); System.out.flush();
pressModifierNVia(robot, KeyEvent.VK_META);
System.out.println("Done. Awaiting events..."); System.out.flush();
robot.waitForIdle();
System.out.println("Done. Verifying the events..."); System.out.flush();
ensureGeneratedEventsAreOk(KeyEvent.VK_META, KeyEvent.META_DOWN_MASK, "Cmd");
System.out.println("Ok."); System.out.flush();
}
robot.delay(200); // just in case
{ // Ctrl+N
System.out.println("Pressing Ctrl+N..."); System.out.flush();
pressModifierNVia(robot, KeyEvent.VK_CONTROL);
System.out.println("Done. Awaiting events..."); System.out.flush();
robot.waitForIdle();
System.out.println("Done. Verifying the events..."); System.out.flush();
ensureGeneratedEventsAreOk(KeyEvent.VK_CONTROL, KeyEvent.CTRL_DOWN_MASK, "Ctrl");
System.out.println("Ok."); System.out.flush();
}
} finally {
disposeGUI();
}
}
// GUI
private static volatile CmdNMustTriggerMenuAccelerator5075 mainWindow;
private static volatile JMenuItem cmdNMenuItem;
private static volatile JMenuItem ctrlNMenuItem;
private static volatile FocusListener focusListener;
private CmdNMustTriggerMenuAccelerator5075() {
super("JBR-5075");
}
private static void createAndShowGUI() throws InterruptedException, InvocationTargetException {
SwingUtilities.invokeAndWait(() -> {
mainWindow = new CmdNMustTriggerMenuAccelerator5075();
mainWindow.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
{ // setup the menu
cmdNMenuItem = new JMenuItem("CmdN action");
cmdNMenuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_N, KeyEvent.META_DOWN_MASK, false));
cmdNMenuItem.addActionListener(actionEvent -> {
System.out.println(cmdNMenuItem.getText() + " has been triggered. " + actionEvent);
System.out.flush();
awaitableEvents.add(new AwaitableEvent(actionEvent, cmdNMenuItem));
});
ctrlNMenuItem = new JMenuItem("CtrlN action");
ctrlNMenuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_N, KeyEvent.CTRL_DOWN_MASK, false));
ctrlNMenuItem.addActionListener(actionEvent -> {
System.out.println(ctrlNMenuItem.getText() + " has been triggered. " + actionEvent);
System.out.flush();
awaitableEvents.add(new AwaitableEvent(actionEvent, ctrlNMenuItem));
});
final var myMenu = new JMenu("My JMenu");
myMenu.add(ctrlNMenuItem);
myMenu.add(cmdNMenuItem);
final var myMenuBar = new JMenuBar();
myMenuBar.add(myMenu);
mainWindow.setJMenuBar(myMenuBar);
}
final var myFocusListener = new FocusAdapter() {
@Override
public void focusLost(FocusEvent e) {
final var errorMsg = String.format("FOCUS LOST! %s", e);
System.err.println(errorMsg);
awaitableEvents.add(new AwaitableEvent(new RuntimeException(errorMsg)));
}
};
mainWindow.addFocusListener(myFocusListener);
focusListener = myFocusListener;
mainWindow.pack();
mainWindow.setSize(800, 500);
mainWindow.setLocationRelativeTo(null);
mainWindow.setAlwaysOnTop(true);
mainWindow.setVisible(true);
mainWindow.requestFocus();
});
}
private static void disposeGUI() throws InterruptedException, InvocationTargetException {
final var localFocusListener = focusListener;
if (localFocusListener != null) {
focusListener = null;
}
final var localMainWindow = mainWindow;
if (localMainWindow != null) {
mainWindow = null;
SwingUtilities.invokeAndWait(() -> {
// To avoid false positive errors while the window is disposing
localMainWindow.removeFocusListener(localFocusListener);
localMainWindow.dispose();
});
}
}
// Other utilities
private static Robot createRobot() throws AWTException {
final Robot robot = new Robot();
robot.setAutoWaitForIdle(false);
robot.setAutoDelay(0);
return robot;
}
private static void pressModifierNVia(Robot robot, int modifierVk) {
robot.keyPress(modifierVk);
try {
robot.delay(100);
robot.keyPress(KeyEvent.VK_N);
try {
robot.delay(50);
} finally {
robot.keyRelease(KeyEvent.VK_N);
}
robot.delay(100);
} finally {
robot.keyRelease(modifierVk);
}
}
// Events reporting and handling
/** Either KeyEvent or (ActionEvent, JMenuItem) or Throwable */
private static final class AwaitableEvent {
final KeyEvent keyEvent;
final ActionEvent actionEvent;
final JMenuItem triggeredMenuItem;
final Throwable criticalError;
AwaitableEvent(KeyEvent keyEvent) {
this.keyEvent = Objects.requireNonNull(keyEvent, "keyEvent == null");
this.actionEvent = null;
this.triggeredMenuItem = null;
this.criticalError = null;
}
AwaitableEvent(ActionEvent actionEvent, JMenuItem triggeredMenuItem) {
this.keyEvent = null;
this.actionEvent = Objects.requireNonNull(actionEvent, "actionEvent == null");
this.triggeredMenuItem = Objects.requireNonNull(triggeredMenuItem, "triggeredMenuItem == null");
this.criticalError = null;
}
AwaitableEvent(Throwable criticalError) {
this.keyEvent = null;
this.actionEvent = null;
this.triggeredMenuItem = null;
this.criticalError = Objects.requireNonNull(criticalError, "criticalError == null");
}
@Override
public String toString() {
return (keyEvent == null) ? actionEvent + " ON " + triggeredMenuItem : keyEvent.toString();
}
}
private static final BlockingQueue<AwaitableEvent> awaitableEvents = new LinkedBlockingQueue<>();
private static void ensureGeneratedEventsAreOk(int modifierVk, int modifierMaskEx, String modifierText) {
// Ensures:
// 1. About expected specific key events order:
// 1. The modifier PRESS
// 2. N PRESS
// 3. N RELEASE
// 4. The modifier RELEASE
// 2. That there are no excess key events
// 3. That there was exactly 1 ActionEvent exactly by the corresponding menu item
final var expectedMenuItem = (modifierVk == KeyEvent.VK_META) ? cmdNMenuItem : ctrlNMenuItem;
boolean modifierPressedFound = false;
boolean nPressedFound = false;
boolean nReleasedFound = false;
boolean modifierReleasedFound = false;
int actionEventsCount = 0;
boolean anyErrorOccurred = false;
while (!awaitableEvents.isEmpty()) {
final var event = awaitableEvents.poll();
if (event.criticalError != null) {
throw new RuntimeException("Critical error occurred", event.criticalError);
}
final var keyEvent = event.keyEvent;
if (keyEvent == null) {
// ActionEvent
if (event.triggeredMenuItem != expectedMenuItem) {
anyErrorOccurred = true;
System.err.printf("Error: found ActionEvent for unexpected menu item: %s\n", event);
}
if (++actionEventsCount != 1) {
anyErrorOccurred = true;
System.err.printf(
"Error: expected exactly 1 ActionEvent, but got another one (%dth): %s\n",
actionEventsCount,
event
);
}
continue;
}
if (!modifierPressedFound) { // Firstly, look for Cmd/Ctrl press
if ( (keyEvent.getID() == KeyEvent.KEY_PRESSED) &&
(keyEvent.getKeyCode() == modifierVk) &&
(keyEvent.getModifiersEx() == modifierMaskEx) ) {
modifierPressedFound = true;
} else {
anyErrorOccurred = true;
System.err.printf("Error: expecting '%s' KEY_PRESSED, but got %s\n", modifierText, keyEvent);
}
continue;
} else if (!nPressedFound) { // Secondly, look for N press
if ( (keyEvent.getID() == KeyEvent.KEY_PRESSED) &&
(keyEvent.getKeyCode() == KeyEvent.VK_N) &&
(keyEvent.getModifiersEx() == modifierMaskEx) ) {
nPressedFound = true;
} else {
anyErrorOccurred = true;
System.err.printf("Error: expecting 'N [%s]' KEY_PRESSED, but got %s\n", modifierText, keyEvent);
}
continue;
} else if (!nReleasedFound) { // Third, look for N release
if ( (modifierVk == KeyEvent.VK_CONTROL) &&
(keyEvent.getID() == KeyEvent.KEY_TYPED) &&
(keyEvent.getModifiersEx() == modifierMaskEx) &&
(keyEvent.getKeyChar() == 14) ) {
// Suppressing the Shift Out ASCII character that is generated by Ctrl+N
continue;
}
if ( (keyEvent.getID() == KeyEvent.KEY_RELEASED) &&
(keyEvent.getKeyCode() == KeyEvent.VK_N) &&
(keyEvent.getModifiersEx() == modifierMaskEx) ) {
nReleasedFound = true;
} else {
anyErrorOccurred = true;
System.err.printf("Error: expecting 'N [%s]' KEY_RELEASED, but got %s\n", modifierText, keyEvent);
}
continue;
} else if (!modifierReleasedFound) { // Fourth, look for Cmd/Ctrl release
if ( (keyEvent.getID() == KeyEvent.KEY_RELEASED) &&
(keyEvent.getKeyCode() == modifierVk) ) {
modifierReleasedFound = true;
} else {
anyErrorOccurred = true;
System.err.printf("Error: expecting '%s' KEY_RELEASED, but got %s\n", modifierText, keyEvent);
}
continue;
}
// Finally, any other events are excess
anyErrorOccurred = true;
System.err.printf("Error: excess key event: %s\n", keyEvent);
}
if (!modifierPressedFound) {
anyErrorOccurred = true;
System.err.printf("Error: '%s' KEY_PRESSED hasn't been found\n", modifierText);
}
if (!nPressedFound) {
anyErrorOccurred = true;
System.err.printf("Error: 'N [%s]' KEY_PRESSED hasn't been found\n", modifierText);
}
if (!nReleasedFound) {
anyErrorOccurred = true;
System.err.printf("Error: 'N [%s]' KEY_RELEASED hasn't been found\n", modifierText);
}
if (!modifierReleasedFound) {
anyErrorOccurred = true;
System.err.printf("Error: '%s' KEY_RELEASED hasn't been found\n", modifierText);
}
if (actionEventsCount != 1) {
anyErrorOccurred = true;
System.err.printf("Error: %d ActionEvents have arrived instead of 1\n", actionEventsCount);
}
if (anyErrorOccurred) {
throw new RuntimeException("Test failed");
}
}
}