From 2f9c77a347b76bebdadd4bec1ac92aa7ab72365f Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Sat, 27 Oct 2012 02:48:43 +0200
Subject: Fix Bug 631 and enhance 601: Handle multiple keys (pressed, released,
 types incl. auto-repeat)

- Using keyCode (bit) maps to isPressed and isAutoRepeat, allowing use of multiple keys

- Enhance unit test TestKeyEventOrderNEWT w/ injecting variations of 2 diff. keys

- Manual tested on X11, Windows and OSX w/ and w/o auto-repeat
---
 .../test/junit/newt/TestKeyEventOrderNEWT.java     |  22 +-
 .../newt/TestKeyPressReleaseUnmaskRepeatNEWT.java  | 222 +++++++++++++++++++++
 .../jogamp/opengl/test/junit/util/NEWTKeyUtil.java |   8 +-
 3 files changed, 248 insertions(+), 4 deletions(-)
 create mode 100644 src/test/com/jogamp/opengl/test/junit/newt/TestKeyPressReleaseUnmaskRepeatNEWT.java

(limited to 'src/test/com/jogamp/opengl')

diff --git a/src/test/com/jogamp/opengl/test/junit/newt/TestKeyEventOrderNEWT.java b/src/test/com/jogamp/opengl/test/junit/newt/TestKeyEventOrderNEWT.java
index e0c3005a2..31d9912d1 100644
--- a/src/test/com/jogamp/opengl/test/junit/newt/TestKeyEventOrderNEWT.java
+++ b/src/test/com/jogamp/opengl/test/junit/newt/TestKeyEventOrderNEWT.java
@@ -141,17 +141,33 @@ public class TestKeyEventOrderNEWT extends UITestCase {
         System.err.println("KEY Event Order Test: "+loops);
         keyAdapter.reset();
         for(int i=0; i<loops; i++) {
+            // 1
             AWTRobotUtil.keyPress(0, robot, true, java.awt.event.KeyEvent.VK_A, 10);
-            robot.waitForIdle();
             AWTRobotUtil.keyPress(0, robot, false, java.awt.event.KeyEvent.VK_A, 100);
             robot.waitForIdle();
+            // 2
+            AWTRobotUtil.keyPress(0, robot, true, java.awt.event.KeyEvent.VK_B, 10);
+            AWTRobotUtil.keyPress(0, robot, false, java.awt.event.KeyEvent.VK_B, 100);
+            robot.waitForIdle();
+            // 3 + 4
+            AWTRobotUtil.keyPress(0, robot, true, java.awt.event.KeyEvent.VK_A, 10);
+            AWTRobotUtil.keyPress(0, robot, true, java.awt.event.KeyEvent.VK_B, 10);
+            AWTRobotUtil.keyPress(0, robot, false, java.awt.event.KeyEvent.VK_A, 10);
+            AWTRobotUtil.keyPress(0, robot, false, java.awt.event.KeyEvent.VK_B, 10);
+            robot.waitForIdle();
+            // 5 + 6
+            AWTRobotUtil.keyPress(0, robot, true, java.awt.event.KeyEvent.VK_A, 10);
+            AWTRobotUtil.keyPress(0, robot, true, java.awt.event.KeyEvent.VK_B, 10);
+            AWTRobotUtil.keyPress(0, robot, false, java.awt.event.KeyEvent.VK_B, 10);
+            AWTRobotUtil.keyPress(0, robot, false, java.awt.event.KeyEvent.VK_A, 10);
+            robot.waitForIdle();            
         }
         robot.delay(250);
         // dumpKeyEvents(keyAdapter.getQueued());
         
         NEWTKeyUtil.validateKeyEventOrder(keyAdapter.getQueued());
         
-        NEWTKeyUtil.validateKeyAdapterStats(keyAdapter, loops, 0);        
+        NEWTKeyUtil.validateKeyAdapterStats(keyAdapter, 6*loops, 0);        
     }
         
     void testImpl(GLWindow glWindow) throws AWTException, InterruptedException, InvocationTargetException {
@@ -182,7 +198,7 @@ public class TestKeyEventOrderNEWT extends UITestCase {
         // 
         // Test the key event order w/o auto-repeat
         //
-        testKeyEventOrder(robot, glWindow1KA, 12);
+        testKeyEventOrder(robot, glWindow1KA, 6);
         
         // Remove listeners to avoid logging during dispose/destroy.
         glWindow.removeKeyListener(glWindow1KA);
diff --git a/src/test/com/jogamp/opengl/test/junit/newt/TestKeyPressReleaseUnmaskRepeatNEWT.java b/src/test/com/jogamp/opengl/test/junit/newt/TestKeyPressReleaseUnmaskRepeatNEWT.java
new file mode 100644
index 000000000..6f3b97f0c
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/newt/TestKeyPressReleaseUnmaskRepeatNEWT.java
@@ -0,0 +1,222 @@
+/**
+ * Copyright 2012 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ * 
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ * 
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+ 
+package com.jogamp.opengl.test.junit.newt;
+
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.AfterClass;
+import org.junit.Assume;
+import org.junit.Before;
+
+import java.awt.AWTException;
+import java.awt.BorderLayout;
+import java.awt.Robot;
+import java.lang.reflect.InvocationTargetException;
+
+import javax.media.opengl.GLCapabilities;
+import javax.media.opengl.GLEventListener;
+import javax.swing.JFrame;
+
+import java.io.IOException;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import com.jogamp.newt.awt.NewtCanvasAWT;
+import com.jogamp.newt.event.InputEvent;
+import com.jogamp.newt.event.KeyEvent;
+import com.jogamp.newt.event.KeyListener;
+import com.jogamp.newt.opengl.GLWindow;
+import com.jogamp.opengl.util.Animator;
+import com.jogamp.opengl.test.junit.jogl.demos.es2.RedSquareES2;
+
+import com.jogamp.opengl.test.junit.util.*;
+
+/**
+ * Testing key press and release events w/o AUTO-REPEAT
+ */
+public class TestKeyPressReleaseUnmaskRepeatNEWT extends UITestCase {
+    static int width, height;
+    static long durationPerTest = 100;
+    static long awtWaitTimeout = 1000;
+
+    static GLCapabilities glCaps;
+
+    @BeforeClass
+    public static void initClass() {
+        width = 640;
+        height = 480;
+        glCaps = new GLCapabilities(null);
+    }
+
+    @AfterClass
+    public static void release() {
+    }
+    
+    @Before
+    public void initTest() {        
+    }
+
+    @After
+    public void releaseTest() {        
+    }
+    
+    @Test
+    public void test01NEWT() throws AWTException, InterruptedException, InvocationTargetException {
+        GLWindow glWindow = GLWindow.create(glCaps);
+        glWindow.setSize(width, height);
+        glWindow.setVisible(true);
+        
+        testImpl(glWindow);
+        
+        glWindow.destroy();
+    }
+        
+    // @Test
+    public void test02NewtCanvasAWT() throws AWTException, InterruptedException, InvocationTargetException {
+        GLWindow glWindow = GLWindow.create(glCaps);
+        
+        // Wrap the window in a canvas.
+        final NewtCanvasAWT newtCanvasAWT = new NewtCanvasAWT(glWindow);
+        
+        // Add the canvas to a frame, and make it all visible.
+        final JFrame frame1 = new JFrame("Swing AWT Parent Frame: "+ glWindow.getTitle());
+        frame1.getContentPane().add(newtCanvasAWT, BorderLayout.CENTER);
+        frame1.setSize(width, height);
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                frame1.setVisible(true);
+            } } );
+        
+        Assert.assertEquals(true,  AWTRobotUtil.waitForVisible(frame1, true));
+        
+        testImpl(glWindow);
+        
+        try {
+            javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+                public void run() {
+                    frame1.setVisible(false);
+                    frame1.dispose();
+                }});
+        } catch( Throwable throwable ) {
+            throwable.printStackTrace();
+            Assume.assumeNoException( throwable );
+        }        
+        glWindow.destroy();
+    }
+    
+    void testImpl(GLWindow glWindow) throws AWTException, InterruptedException, InvocationTargetException {
+        final Robot robot = new Robot();
+        robot.setAutoWaitForIdle(true);
+
+        GLEventListener demo1 = new RedSquareES2();
+        TestListenerCom01AWT.setDemoFields(demo1, glWindow, false);
+        glWindow.addGLEventListener(demo1);
+
+        SimpleKeyPressRelease simpleKeyPressRelease = new SimpleKeyPressRelease();
+        glWindow.addKeyListener(simpleKeyPressRelease);
+
+        Assert.assertEquals(true,  AWTRobotUtil.waitForRealized(glWindow, true));        
+        AWTRobotUtil.clearAWTFocus(robot);
+
+        // Continuous animation ..
+        Animator animator = new Animator(glWindow);
+        animator.start();
+
+        Thread.sleep(durationPerTest); // manual testing
+        
+        AWTRobotUtil.assertRequestFocusAndWait(null, glWindow, glWindow, null, null);  // programmatic
+        // AWTRobotUtil.assertRequestFocusAndWait(robot, glWindow, glWindow, null, null); // by mouse click
+
+        // Remove listeners to avoid logging during dispose/destroy.
+        glWindow.removeKeyListener(simpleKeyPressRelease);
+
+        // Shutdown the test.
+        animator.stop();
+    }
+
+    static int atoi(String a) {
+        int i=0;
+        try {
+            i = Integer.parseInt(a);
+        } catch (Exception ex) { ex.printStackTrace(); }
+        return i;
+    }
+    
+    static class SimpleKeyPressRelease implements KeyListener {
+        int seq;
+
+        SimpleKeyPressRelease() {
+            reset();
+        }
+        
+        public void reset() {
+            seq=0;
+        }
+        
+        @Override
+        public void keyPressed(KeyEvent e) {
+            if( 0 == ( InputEvent.AUTOREPEAT_MASK & e.getModifiers() ) ) {
+                seq++;
+                System.err.println(seq+": "+e);
+            }
+        }
+
+        @Override
+        public void keyReleased(KeyEvent e) {
+            if( 0 == ( InputEvent.AUTOREPEAT_MASK & e.getModifiers() ) ) {
+                seq++;
+                System.err.println(seq+": "+e);
+            }
+        }
+
+        @Override
+        public void keyTyped(KeyEvent e) {
+        }
+        
+    }
+
+    public static void main(String args[]) throws IOException {
+        for(int i=0; i<args.length; i++) {
+            if(args[i].equals("-time")) {
+                durationPerTest = atoi(args[++i]);
+            }
+        }
+        /**
+        BufferedReader stdin = new BufferedReader(new InputStreamReader(System.in));
+        System.err.println("Press enter to continue");
+        System.err.println(stdin.readLine()); 
+        */
+        System.out.println("durationPerTest: "+durationPerTest);
+        String tstname = TestKeyPressReleaseUnmaskRepeatNEWT.class.getName();
+        org.junit.runner.JUnitCore.main(tstname);
+    }
+
+
+}
diff --git a/src/test/com/jogamp/opengl/test/junit/util/NEWTKeyUtil.java b/src/test/com/jogamp/opengl/test/junit/util/NEWTKeyUtil.java
index dfc96edcb..299ea3a6e 100644
--- a/src/test/com/jogamp/opengl/test/junit/util/NEWTKeyUtil.java
+++ b/src/test/com/jogamp/opengl/test/junit/util/NEWTKeyUtil.java
@@ -32,6 +32,7 @@ import java.util.List;
 
 import org.junit.Assert;
 
+import com.jogamp.common.util.IntIntHashMap;
 import com.jogamp.newt.event.KeyEvent;
 
 public class NEWTKeyUtil {
@@ -56,12 +57,17 @@ public class NEWTKeyUtil {
     }
     
     public static void validateKeyEventOrder(List<EventObject> keyEvents) {
-        int eet = KeyEvent.EVENT_KEY_PRESSED;
+        IntIntHashMap keyCode2NextEvent = new IntIntHashMap(); 
         for(int i=0; i<keyEvents.size(); i++) {
             final KeyEvent e = (KeyEvent) keyEvents.get(i);
+            int eet = keyCode2NextEvent.get(e.getKeyCode());
+            if( 0 >= eet ) {
+                eet = KeyEvent.EVENT_KEY_PRESSED;
+            }
             final int et = e.getEventType();
             Assert.assertEquals("Key event not in proper order", eet, et);
             eet = getNextKeyEventType(et);
+            keyCode2NextEvent.put(e.getKeyCode(), eet);
         }        
     }
     
-- 
cgit v1.2.3