src: Refactor the logic about key (#210)

* src: Refactor the logic about key

Signed-off-by: Ce Gao <ce.gao@outlook.com>

* reference: Add keyPressed1

Signed-off-by: Ce Gao <ce.gao@outlook.com>

* reference: Add keyPressedVar

Signed-off-by: Ce Gao <ce.gao@outlook.com>

* reference: Add keyReleased

Signed-off-by: Ce Gao <ce.gao@outlook.com>

* reference: Add keyTyped

Signed-off-by: Ce Gao <ce.gao@outlook.com>

Author: gaocegege

examples/reference/key/key1/key1.rpde

@@ -0,0 +1,12 @@
+# Click on the window to give it focus, and press the 'B' key.
+
+draw <- function() {
+    if (keyPressedVar == TRUE) {
+        if (key == "b" || key == "B") {
+            fill(0)
+        }
+    } else {
+        fill(255)
+    }
+    rect(25, 25, 50, 50)
+}

examples/reference/keyCode/keyCode1/keyCode1.rpde

@@ -0,0 +1,19 @@
+fillVal <- 126
+
+draw <- function() {
+    fill(fillVal)
+    rect(25, 25, 50, 50)
+}
+
+keyPressed <- function() {
+    # See https://github.com/gaocegege/Processing.R/issues/209
+    if (key == CODED) {
+        if (keyCode == UP) {
+            fillVal = 255
+        } else if (keyCode == DOWN) {
+            fillVal = 0
+        }
+    } else {
+        fillVal = 126
+    }
+}

examples/reference/keyPressed/keyPressed1/keyPressed1.rpde

@@ -0,0 +1,16 @@
+# Click on the image to give it focus, and then press any key.
+
+value <- 0
+
+draw <- function() {
+    fill(value)
+    rect(25, 25, 50, 50)
+}
+
+keyPressed <- function() {
+    if (value == 0) {
+        value = 255
+    } else {
+        value = 0
+    }
+}

examples/reference/keyPressedVar/.property.yml

@@ -0,0 +1,11 @@
+category: Input
+subcategory: Keyboard
+description: "
+The Boolean system variable <b>keyPressed</b> is <b>TRUE</b> if any key is pressed and <b>FALSE</b> if no keys are pressed.
+"
+syntax: ""
+related:
+  - key
+  - keyCode
+  - keyPressed
+  - keyReleased

examples/reference/keyPressedVar/keyPressedVar1/keyPressedVar1.rpde

@@ -0,0 +1,13 @@
+# Click on the image to give it focus, and then press any key.
+
+# Note: The rectangle in this example may flicker as the operating system may
+# register a long key press as a repetition of key presses.
+
+draw <- function() {
+    if (keyPressedVar == TRUE) {
+        fill(0)
+    } else {
+        fill(255)
+    }
+    rect(25, 25, 50, 50)
+}

examples/reference/keyPressed_var/.property.yml

@@ -0,0 +1,16 @@
+# Click on the image to give it focus, and then press any key.
+
+value <- 0
+
+draw <- function() {
+    fill(value)
+    rect(25, 25, 50, 50)
+}
+
+keyReleased <- function() {
+    if (value == 0) {
+        value = 255
+    } else {
+        value = 0
+    }
+}

examples/reference/keyReleased/keyReleased1/keyReleased1.rpde

@@ -0,0 +1,22 @@
+# Run this program to learn how each of these functions relate to the others.
+
+draw <- function() {
+}  # Empty draw() needed to keep the program running
+
+keyPressed <- function() {
+    print("keyPressed")
+    print(keyCode)
+    print(key)
+}
+
+keyTyped <- function() {
+    print("keyTyped")
+    print(keyCode)
+    print(key)
+}
+
+keyReleased <- function() {
+    print("keyReleased")
+    print(keyCode)
+    print(key)
+}

examples/reference/keyTyped/keyTyped1/keyTyped1.rpde

@@ -26,6 +26,7 @@
 import processing.core.PApplet;
 import processing.core.PConstants;
 import processing.core.PSurface;
+import processing.event.KeyEvent;
 import processing.event.MouseEvent;
 import processing.javafx.PSurfaceFX;
 import processing.opengl.PSurfaceJOGL;
@@ -370,16 +371,17 @@ private boolean isMixMode() {
    */
   protected void wrapProcessingVariables() {
     log("Wrap Processing built-in variables into R top context.");
-    // TODO: Find some ways to push constants into R.
-    wrapMouseVariables();
+
+    this.wrapMouseVariables();
+    this.wrapKeyVariables();
+
     this.renjinEngine.put("width", width);
     this.renjinEngine.put("height", height);
     this.renjinEngine.put("displayWidth", displayWidth);
     this.renjinEngine.put("displayHeight", displayHeight);
     this.renjinEngine.put("focused", focused);
     this.renjinEngine.put("pixelWidth", pixelWidth);
     this.renjinEngine.put("pixelHeight", pixelHeight);
-    // this.renjinEngine.put("keyPressed", keyPressed);
   }
 
   @Override
@@ -454,6 +456,12 @@ private void applyFunction(String name) {
     }
   }
 
+  @Override
+  protected void handleKeyEvent(KeyEvent event) {
+    super.handleKeyEvent(event);
+    wrapKeyVariables();
+  }
+
   @Override
   public void keyPressed() {
     wrapKeyVariables();
@@ -472,19 +480,8 @@ public void keyTyped() {
     applyFunction(Constant.KEYTYPED_NAME);
   }
 
-  private char lastKey = Character.MIN_VALUE;
-
   protected void wrapKeyVariables() {
-    if (lastKey != key) {
-      lastKey = key;
-      /*
-       * If key is "CODED", i.e., an arrow key or other non-printable, pass that value through
-       * as-is. If it's printable, convert it to a unicode string, so that the user can compare key
-       * == 'x' instead of key == ord('x').
-       */
-      final char pyKey = key == CODED ? parseChar(Integer.valueOf(key)) : parseChar(key);
-      this.renjinEngine.put("key", pyKey);
-    }
+    this.renjinEngine.put("key", String.valueOf(key));
     this.renjinEngine.put("keyCode", keyCode);
     this.renjinEngine.put("keyPressedVar", keyPressed);
   }