Possible solution for #3808 by accumulating concurrent keystrokes

Author: AlexisDrogoul

ummisco.gama.opengl/src/ummisco/gama/opengl/view/NEWTLayeredDisplayMultiListener.java

@@ -1,11 +1,11 @@
 /*******************************************************************************************************
  *
  * NEWTLayeredDisplayMultiListener.java, in ummisco.gama.opengl, is part of the source code of the GAMA modeling and
- * simulation platform (v.1.9.2).
+ * simulation platform (v.2.0.0).
  *
  * (c) 2007-2023 UMI 209 UMMISCO IRD/SU & Partners (IRIT, MIAT, TLU, CTU)
  *
- * Visit https://github.com/gama-platform/gama for license information and contacts.
+ * Visit https://github.com/gama-platform/gama2 for license information and contacts.
  *
  ********************************************************************************************************/
 package ummisco.gama.opengl.view;
@@ -117,10 +117,26 @@ public void keyPressed(final KeyEvent e) {
 
 	@Override
 	public void keyReleased(final KeyEvent e) {
-		// DEBUG.OUT("Key released: " + e);
-		// if (!ok.get()) return;
-		// delegate.keyReleased(e.getKeyChar(),
-		// PlatformHelper.isMac() ? e.isMetaDown() : e.isControlDown() /* ?? GamaKeyBindings.ctrl(e) */);
+		DEBUG.OUT("Key released in Newt listener: " + e);
+		if (!ok.get()) return;
+		if (e.isPrintableKey()) {
+			delegate.keyReleased(e.getKeyChar(),
+					PlatformHelper.isMac() ? e.isMetaDown() : e.isControlDown() /* ?? GamaKeyBindings.ctrl(e) */);
+		} else if (e.getModifiers() == 0
+				|| e.isAutoRepeat() && !e.isAltDown() && !e.isControlDown() && !e.isShiftDown() && !e.isMetaDown()) {
+			delegate.specialKeyReleased(switch (e.getKeyCode()) {
+				case KeyEvent.VK_UP -> IEventLayerListener.ARROW_UP;
+				case KeyEvent.VK_DOWN -> IEventLayerListener.ARROW_DOWN;
+				case KeyEvent.VK_LEFT -> IEventLayerListener.ARROW_LEFT;
+				case KeyEvent.VK_RIGHT -> IEventLayerListener.ARROW_RIGHT;
+				case KeyEvent.VK_PAGE_UP -> IEventLayerListener.KEY_PAGE_UP;
+				case KeyEvent.VK_PAGE_DOWN -> IEventLayerListener.KEY_PAGE_DOWN;
+				case KeyEvent.VK_ESCAPE -> IEventLayerListener.KEY_ESC;
+				case KeyEvent.VK_ENTER -> IEventLayerListener.KEY_RETURN;
+				case KeyEvent.VK_TAB -> IEventLayerListener.KEY_TAB;
+				default -> 0;
+			});
+		}
 	}
 
 	/**

ummisco.gama.ui.experiment/src/ummisco/gama/ui/views/displays/LayeredDisplayMultiListener.java

@@ -1,15 +1,17 @@
 /*******************************************************************************************************
  *
  * LayeredDisplayMultiListener.java, in ummisco.gama.ui.experiment, is part of the source code of the GAMA modeling and
- * simulation platform (v.1.9.2).
+ * simulation platform (v.2.0.0).
  *
  * (c) 2007-2023 UMI 209 UMMISCO IRD/SU & Partners (IRIT, MIAT, TLU, CTU)
  *
- * Visit https://github.com/gama-platform/gama for license information and contacts.
+ * Visit https://github.com/gama-platform/gama2 for license information and contacts.
  *
  ********************************************************************************************************/
 package ummisco.gama.ui.views.displays;
 
+import java.util.HashSet;
+import java.util.Set;
 import java.util.function.Consumer;
 
 import org.eclipse.swt.SWT;
@@ -18,9 +20,9 @@
 import msi.gama.common.interfaces.IDisplaySurface;
 import msi.gama.runtime.GAMA;
 import msi.gama.runtime.PlatformHelper;
+import ummisco.gama.dev.utils.DEBUG;
 import ummisco.gama.ui.utils.WorkbenchHelper;
 import ummisco.gama.ui.views.WorkaroundForIssue1353;
-import ummisco.gama.dev.utils.DEBUG;
 
 /**
  * The listener interface for receiving layeredDisplayMulti events. The class that is interested in processing a
@@ -33,7 +35,7 @@
 public class LayeredDisplayMultiListener {
 
 	static {
-		DEBUG.OFF();
+		DEBUG.ON();
 	}
 
 	/** The view. */
@@ -60,6 +62,12 @@ public class LayeredDisplayMultiListener {
 	/** The key listener. */
 	final Consumer<Character> keyListener;
 
+	/** The pressed characters. */
+	final Set<Character> pressedCharacters = new HashSet<>();
+
+	/** The pressed special characters. */
+	final Set<Integer> pressedSpecialCharacters = new HashSet<>();
+
 	/**
 	 * Instantiates a new layered display multi listener.
 	 *
@@ -93,11 +101,13 @@ public LayeredDisplayMultiListener(final IDisplaySurface surface, final LayeredD
 	 * @param isCommand
 	 */
 	public void keyPressed(final char e, final boolean isCommand) {
+		DEBUG.OUT("Key pressed: " + e);
 		if (isCommand) {
 			keyListener.accept(e);
 			return;
 		}
-		surface.dispatchKeyEvent(e);
+		pressedCharacters.add(e);
+		for (Character c : pressedCharacters) { surface.dispatchKeyEvent(c); }
 		WorkbenchHelper.asyncRun(view.displayOverlay);
 	}
 
@@ -108,7 +118,8 @@ public void keyPressed(final char e, final boolean isCommand) {
 	 *            the key code
 	 */
 	public void specialKeyPressed(final int keyCode) {
-		surface.dispatchSpecialKeyEvent(keyCode);
+		pressedSpecialCharacters.add(keyCode);
+		for (Integer code : pressedSpecialCharacters) { surface.dispatchSpecialKeyEvent(code); }
 		WorkbenchHelper.asyncRun(view.displayOverlay); // ??
 	}
 
@@ -120,7 +131,22 @@ public void specialKeyPressed(final int keyCode) {
 	 * @param command
 	 *            the command
 	 */
-	public void keyReleased(final char e, final boolean command) {}
+	public void keyReleased(final char e, final boolean command) {
+		DEBUG.OUT("Key released: " + e);
+		if (!command) { pressedCharacters.remove(e); }
+	}
+
+	/**
+	 * Special key released.
+	 *
+	 * @param keyCode
+	 *            the key code
+	 */
+	public void specialKeyReleased(final int keyCode) {
+		pressedSpecialCharacters.remove(keyCode);
+		// for (Integer code : pressedSpecialCharacters) { surface.dispatchSpecialKeyEvent(code); }
+		// WorkbenchHelper.asyncRun(view.displayOverlay); // ??
+	}
 
 	/**
 	 * Mouse enter.
@@ -170,6 +196,7 @@ public void mouseExit(final int x, final int y, final boolean modifier, final in
 		setMousePosition(-1, -1);
 		if (button > 0) return;
 		// DEBUG.LOG("Mouse exiting " + e);
+
 		surface.dispatchMouseEvent(SWT.MouseExit, x, y);
 		if (!view.isFullScreen() && WorkaroundForIssue1353.isInstalled()) {
 			// suppressNextEnter = true;
@@ -204,13 +231,13 @@ public void mouseHover(final int x, final int y, final int button) {
 	public void mouseMove(final int x, final int y, final boolean modifier) {
 		WorkbenchHelper.asyncRun(view.displayOverlay);
 		if (modifier) return;
-		//DEBUG.LOG("Mouse moving on " + view.view.getPartName() + " at (" + x + "," + y + ")");
+		// DEBUG.LOG("Mouse moving on " + view.view.getPartName() + " at (" + x + "," + y + ")");
 		if (mouseIsDown) {
 			// Depending on the plateform or display, this case is never called,
 			// because DragDetect events are emitted instead. But on Windows
 			// Java2D displays, it seems that MouseMove events are emitted even
 			// when the mouse button is down.
-			
+
 			// Eventually moves the surface view
 			surface.draggedTo(x, y);
 			// Updates the mouse position. If the surface view is locked, the
@@ -241,7 +268,7 @@ public void mouseMove(final int x, final int y, final boolean modifier) {
 	 *            whetehr ALT, CTRL, CMD, META or other modifiers are used
 	 */
 	public void mouseDown(final int x, final int y, final int button, final boolean modifier) {
-		//DEBUG.LOG("Mouse down at " + x + ", " + y);
+		// DEBUG.LOG("Mouse down at " + x + ", " + y);
 		setMousePosition(x, y);
 		if (inMenu) {
 			inMenu = false;
@@ -269,7 +296,7 @@ public void mouseDown(final int x, final int y, final int button, final boolean
 	 *            whetehr ALT, CTRL, CMD, META or other modifiers are used
 	 */
 	public void mouseUp(final int x, final int y, final int button, final boolean modifier) {
-		//DEBUG.LOG("Mouse up at " + x + ", " + y + " on " + view.getPartName());
+		// DEBUG.LOG("Mouse up at " + x + ", " + y + " on " + view.getPartName());
 		// In case the mouse has moved (for example on a menu)
 		if (!mouseIsDown) return;
 		setMousePosition(x, y);
@@ -300,7 +327,7 @@ public void menuDetected(final int x, final int y) {
 	 * Drag detected.
 	 */
 	public void dragDetected(final int x, final int y) {
-		//DEBUG.LOG("Mouse drag detected on " + view.view.getPartName() + " at (" + x + "," + y + ")");
+		// DEBUG.LOG("Mouse drag detected on " + view.view.getPartName() + " at (" + x + "," + y + ")");
 		surface.draggedTo(x, y);
 		setMousePosition(x, y);
 		surface.dispatchMouseEvent(SWT.DragDetect, x, y);
@@ -314,7 +341,10 @@ public void focusGained() {}
 	/**
 	 * Focus lost.
 	 */
-	public void focusLost() {}
+	public void focusLost() {
+		pressedCharacters.clear();
+		pressedSpecialCharacters.clear();
+	}
 
 	/**
 	 * Sets the mouse position.

ummisco.gama.ui.experiment/src/ummisco/gama/ui/views/displays/SWTLayeredDisplayMultiListener.java

@@ -1,11 +1,11 @@
 /*******************************************************************************************************
  *
  * SWTLayeredDisplayMultiListener.java, in ummisco.gama.ui.experiment, is part of the source code of the GAMA modeling
- * and simulation platform (v.1.9.2).
+ * and simulation platform (v.2.0.0).
  *
  * (c) 2007-2023 UMI 209 UMMISCO IRD/SU & Partners (IRIT, MIAT, TLU, CTU)
  *
- * Visit https://github.com/gama-platform/gama for license information and contacts.
+ * Visit https://github.com/gama-platform/gama2 for license information and contacts.
  *
  ********************************************************************************************************/
 package ummisco.gama.ui.views.displays;
@@ -160,6 +160,36 @@ public void keyPressed(final KeyEvent e) {
 	@Override
 	public void keyReleased(final KeyEvent e) {
 		if (!ok.get()) return;
+		switch (e.keyCode) {
+			case SWT.ARROW_DOWN:
+				delegate.specialKeyReleased(IEventLayerListener.ARROW_DOWN);
+				return;
+			case SWT.ARROW_UP:
+				delegate.specialKeyReleased(IEventLayerListener.ARROW_UP);
+				return;
+			case SWT.ARROW_LEFT:
+				delegate.specialKeyReleased(IEventLayerListener.ARROW_LEFT);
+				return;
+			case SWT.ARROW_RIGHT:
+				delegate.specialKeyReleased(IEventLayerListener.ARROW_RIGHT);
+				return;
+			case SWT.ESC:
+				delegate.specialKeyReleased(IEventLayerListener.KEY_ESC);
+				return;
+			case SWT.TAB:
+				delegate.specialKeyReleased(IEventLayerListener.KEY_TAB);
+				return;
+			case SWT.PAGE_DOWN:
+				delegate.specialKeyReleased(IEventLayerListener.KEY_PAGE_DOWN);
+				return;
+			case SWT.PAGE_UP:
+				delegate.specialKeyReleased(IEventLayerListener.KEY_PAGE_UP);
+				return;
+			case SWT.CR, SWT.KEYPAD_CR:
+				delegate.specialKeyReleased(IEventLayerListener.KEY_RETURN);
+				return;
+
+		}
 		// DEBUG.OUT("Key released " + e);
 		delegate.keyReleased(e.character, GamaKeyBindings.ctrl(e));
 	}
@@ -272,6 +302,11 @@ public java.awt.event.KeyListener getKeyAdapterForAWT() {
 
 			@Override
 			public void keyTyped(final java.awt.event.KeyEvent e) {
+
+			}
+
+			@Override
+			public void keyPressed(final java.awt.event.KeyEvent e) {
 				// Necessary to filter by the time to avoid repetitions
 				if (e.getWhen() == previous) return;
 				previous = e.getWhen();
@@ -295,10 +330,25 @@ public void keyTyped(final java.awt.event.KeyEvent e) {
 			}
 
 			@Override
-			public void keyPressed(final java.awt.event.KeyEvent e) {}
-
-			@Override
-			public void keyReleased(final java.awt.event.KeyEvent e) {}
+			public void keyReleased(final java.awt.event.KeyEvent e) {
+				DEBUG.LOG("Key released by the AWT listener. Code " + e.getKeyCode() + " Action ? " + e.isActionKey());
+				if (!e.isActionKey()) {
+					delegate.keyReleased(e.getKeyChar(), e.isControlDown());
+				} else if (e.getModifiersEx() == 0) {
+					delegate.specialKeyReleased(switch (e.getKeyCode()) {
+						case java.awt.event.KeyEvent.VK_UP, java.awt.event.KeyEvent.VK_KP_UP -> IEventLayerListener.ARROW_UP;
+						case java.awt.event.KeyEvent.VK_DOWN, java.awt.event.KeyEvent.VK_KP_DOWN -> IEventLayerListener.ARROW_DOWN;
+						case java.awt.event.KeyEvent.VK_LEFT, java.awt.event.KeyEvent.VK_KP_LEFT -> IEventLayerListener.ARROW_LEFT;
+						case java.awt.event.KeyEvent.VK_RIGHT, java.awt.event.KeyEvent.VK_KP_RIGHT -> IEventLayerListener.ARROW_RIGHT;
+						case java.awt.event.KeyEvent.VK_PAGE_UP -> IEventLayerListener.KEY_PAGE_UP;
+						case java.awt.event.KeyEvent.VK_PAGE_DOWN -> IEventLayerListener.KEY_PAGE_DOWN;
+						case java.awt.event.KeyEvent.VK_ESCAPE -> IEventLayerListener.KEY_ESC;
+						case java.awt.event.KeyEvent.VK_ENTER -> IEventLayerListener.KEY_RETURN;
+						case java.awt.event.KeyEvent.VK_TAB -> IEventLayerListener.KEY_TAB;
+						default -> 0;
+					});
+				}
+			}
 		};
 	}