From 40e6656f6e0730663aeea69f295e90ebca0f005b Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sun, 30 Jul 2017 10:48:43 +0200
Subject: [PATCH 1/2] Add helpers to aid in implementing key masking

There are situations when one wants to ignore key events for a while, and mask
them out. These newly introduced functions help do that.

They are in the Hardware plugin, because this is where it is most efficient to
implement the masks: the hardware library knows how many bits it needs, and how
best to represent the masks. We use a 32-bit bitmap here, other keyboards may
use a different size, or an entirely different approach too.

This is one part of the fix to address keyboardio/Kaleidoscope#150.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Hardware-Model01.cpp | 40 +++++++++++++++++++++++++++
 src/Kaleidoscope-Hardware-Model01.h   |  8 ++++++
 2 files changed, 48 insertions(+)

diff --git a/src/Kaleidoscope-Hardware-Model01.cpp b/src/Kaleidoscope-Hardware-Model01.cpp
index 00274a72..1f2e8c7f 100644
--- a/src/Kaleidoscope-Hardware-Model01.cpp
+++ b/src/Kaleidoscope-Hardware-Model01.cpp
@@ -5,6 +5,8 @@
 KeyboardioScanner Model01::leftHand(0);
 KeyboardioScanner Model01::rightHand(3);
 bool Model01::isLEDChanged = true;
+uint32_t Model01::leftHandMask;
+uint32_t Model01::rightHandMask;
 
 static constexpr uint8_t key_led_map[4][16] = {
   {3, 4, 11, 12, 19, 20, 26, 27,     36, 37, 43, 44, 51, 52, 59, 60},
@@ -202,4 +204,42 @@ void Model01::rebootBootloader() {
   // happens before the watchdog reboots us
 }
 
+void Model01::maskKey(byte row, byte col) {
+  if (row >= ROWS || col >= COLS)
+    return;
+
+  if (col >= 8) {
+    rightHandMask |= SCANBIT(row, col - 8);
+  } else {
+    leftHandMask |= SCANBIT(row, col);
+  }
+}
+
+void Model01::unMaskKey(byte row, byte col) {
+  if (row >= ROWS || col >= COLS)
+    return;
+
+  if (col >= 8) {
+    rightHandMask &= ~(SCANBIT(row, col - 8));
+  } else {
+    leftHandMask &= ~(SCANBIT(row, col));
+  }
+}
+
+bool Model01::isKeyMasked(byte row, byte col) {
+  if (row >= ROWS || col >= COLS)
+    return false;
+
+  if (col >= 8) {
+    return rightHandMask & SCANBIT(row, col - 8);
+  } else {
+    return leftHandMask & SCANBIT(row, col);
+  }
+}
+
+void Model01::maskHeldKeys(void) {
+  rightHandMask = rightHandState.all;
+  leftHandMask = leftHandState.all;
+}
+
 HARDWARE_IMPLEMENTATION KeyboardHardware;
diff --git a/src/Kaleidoscope-Hardware-Model01.h b/src/Kaleidoscope-Hardware-Model01.h
index 4f76cbd7..d8c47e22 100644
--- a/src/Kaleidoscope-Hardware-Model01.h
+++ b/src/Kaleidoscope-Hardware-Model01.h
@@ -30,6 +30,11 @@ class Model01 {
 
   boolean ledPowerFault(void);
 
+  void maskKey(byte row, byte col);
+  void unMaskKey(byte row, byte col);
+  bool isKeyMasked(byte row, byte col);
+  void maskHeldKeys(void);
+
   keydata_t leftHandState;
   keydata_t rightHandState;
   keydata_t previousLeftHandState;
@@ -39,6 +44,9 @@ class Model01 {
   static bool isLEDChanged;
   static KeyboardioScanner leftHand;
   static KeyboardioScanner rightHand;
+
+  static uint32_t leftHandMask;
+  static uint32_t rightHandMask;
 };
 
 #define SCANBIT(row,col) ((uint32_t)1 << (row * 8 + (7 - col)))

From 14197de8e658cce23a53d7ca9b8fcc3bd323530b Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Thu, 3 Aug 2017 12:15:37 +0200
Subject: [PATCH 2/2] Add a few words about masking as in-code comments.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Hardware-Model01.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/Kaleidoscope-Hardware-Model01.h b/src/Kaleidoscope-Hardware-Model01.h
index d8c47e22..2e58fd23 100644
--- a/src/Kaleidoscope-Hardware-Model01.h
+++ b/src/Kaleidoscope-Hardware-Model01.h
@@ -30,6 +30,15 @@ class Model01 {
 
   boolean ledPowerFault(void);
 
+  /* Key masking
+   * -----------
+   *
+   * There are situations when one wants to ignore key events for a while, and
+   * mask them out. These functions help do that. In isolation, they do nothing,
+   * plugins and the core firmware is expected to make use of these.
+   *
+   * See `handleKeyswitchEvent` in the Kaleidoscope sources for a use-case.
+   */
   void maskKey(byte row, byte col);
   void unMaskKey(byte row, byte col);
   bool isKeyMasked(byte row, byte col);