Fix pressing two keys with the same keycode but different modifiers (#2710)

* Fix extra keyboard report during test_fixture teardown

* Add tests for pressing two keys with only different modifers

* Fix #1708

When two keys that use the same keycode, but different modifiers were
pressed at the same time, the second keypress wasn't registered. This is
fixed by forcing a key release when we detect a new press for the same
keycode.

* Fix the NKRO version of is_key_pressed

* Fix uninitalized loop variable

Co-authored-by: Jack Humbert <jack.humb@gmail.com>

1 files changed, 117 insertions, 1 deletions

diff --git a/tests/basic/test_keypress.cpp b/tests/basic/test_keypress.cpp
index e5247911c..551458a0d 100644
--- a/tests/basic/test_keypress.cpp
+++ b/tests/basic/test_keypress.cpp
@@ -18,6 +18,7 @@
 
 using testing::_;
 using testing::Return;
+using testing::InSequence;
 
 class KeyPress : public TestFixture {};
 
@@ -121,4 +122,119 @@ TEST_F(KeyPress, RightShiftLeftControlAndCharWithTheSameKey) {
     EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL)));
     EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
     keyboard_task();
-}
\ No newline at end of file
+}
+
+TEST_F(KeyPress, PressPlusEqualReleaseBeforePress) {
+  TestDriver driver;
+  InSequence s;
+
+  press_key(1, 1); // KC_PLUS
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(1, 1); // KC_PLUS
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  press_key(0, 1); // KC_EQL
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(0, 1); // KC_EQL
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+}
+
+TEST_F(KeyPress, PressPlusEqualDontReleaseBeforePress) {
+  TestDriver driver;
+  InSequence s;
+
+  press_key(1, 1); // KC_PLUS
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  press_key(0, 1); // KC_EQL
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(1, 1); //KC_PLS
+  // BUG: Should really still return KC_EQL, but this is fine too
+  // It's also called twice for some reason
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(2);
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(0, 1); // KC_EQL
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+}
+
+TEST_F(KeyPress, PressEqualPlusReleaseBeforePress) {
+  TestDriver driver;
+  InSequence s;
+
+  press_key(0, 1); // KC_EQL
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(0, 1); // KQ_EQL
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  press_key(1, 1); // KC_PLUS
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(1, 1); // KC_PLUS
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+}
+
+TEST_F(KeyPress, PressEqualPlusDontReleaseBeforePress) {
+  TestDriver driver;
+  InSequence s;
+
+  press_key(0, 1); // KC_EQL
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  press_key(1, 1); // KC_PLUS
+  // BUG: The sequence is a bit strange, but it works, the end result is that
+  // KC_PLUS is sent
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(0, 1); //KC_EQL
+  // I guess it's fine to still report shift here
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+
+  release_key(1, 1); // KC_PLUS
+  // This report is not needed
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+  EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+  run_one_scan_loop();
+  testing::Mock::VerifyAndClearExpectations(&driver);
+}