[Core] Speculative Hold option for mod-taps: hold mods instantly while unsettled. (#25572)
This commit is contained in:
Pascal Getreuer
@@ -0,0 +1,24 @@
|
||||
/* Copyright 2022 Vladislav Kucheriavykh
|
||||
* Copyright 2025 Google LLC
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "test_common.h"
|
||||
|
||||
#define SPECULATIVE_HOLD
|
||||
#define RETRO_TAPPING
|
||||
#define DUMMY_MOD_NEUTRALIZER_KEYCODE KC_F24
|
||||
@@ -0,0 +1,15 @@
|
||||
# Copyright 2022 Vladislav Kucheriavykh
|
||||
# Copyright 2025 Google LLC
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
@@ -0,0 +1,629 @@
|
||||
// Copyright 2025 Google LLC
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// https://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
#include "keyboard_report_util.hpp"
|
||||
#include "keycode.h"
|
||||
#include "test_common.hpp"
|
||||
#include "action_tapping.h"
|
||||
#include "test_fixture.hpp"
|
||||
#include "test_keymap_key.hpp"
|
||||
|
||||
using testing::_;
|
||||
using testing::InSequence;
|
||||
|
||||
extern "C" bool get_speculative_hold(uint16_t keycode, keyrecord_t *record) {
|
||||
return true;
|
||||
}
|
||||
|
||||
class SpeculativeHoldRetroTappingTest : public TestFixture {};
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, roll_regular_to_lgui_mod) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_key = KeymapKey(0, 1, 0, LGUI_T(KC_P));
|
||||
auto regular_key = KeymapKey(0, 2, 0, KC_B);
|
||||
|
||||
set_keymap({mod_tap_key, regular_key});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_B));
|
||||
regular_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_B, KC_LGUI));
|
||||
mod_tap_key.press();
|
||||
idle_for(TAPPING_TERM + 1);
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
regular_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Neutralizer invoked by Speculative Hold.
|
||||
EXPECT_REPORT(driver, (KC_LGUI, DUMMY_MOD_NEUTRALIZER_KEYCODE));
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_P));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, regular_to_mod_under_tap_term) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_key = KeymapKey(0, 1, 0, LSFT_T(KC_A));
|
||||
auto regular_key = KeymapKey(0, 2, 0, KC_B);
|
||||
|
||||
set_keymap({mod_tap_key, regular_key});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_B));
|
||||
regular_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_B, KC_LSFT));
|
||||
mod_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
regular_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_A));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_under_tap_term_to_regular) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_key = KeymapKey(0, 1, 0, LGUI_T(KC_P));
|
||||
auto regular_key = KeymapKey(0, 2, 0, KC_B);
|
||||
|
||||
set_keymap({mod_tap_key, regular_key});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
mod_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_NO_REPORT(driver);
|
||||
regular_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Neutralizer invoked by Speculative Hold.
|
||||
EXPECT_REPORT(driver, (KC_LGUI, DUMMY_MOD_NEUTRALIZER_KEYCODE));
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_P));
|
||||
EXPECT_REPORT(driver, (KC_B, KC_P));
|
||||
EXPECT_REPORT(driver, (KC_B));
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
regular_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_over_tap_term_to_regular) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_key = KeymapKey(0, 1, 0, LSFT_T(KC_A));
|
||||
auto regular_key = KeymapKey(0, 2, 0, KC_B);
|
||||
|
||||
set_keymap({mod_tap_key, regular_key});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
mod_tap_key.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_B));
|
||||
regular_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_B));
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
regular_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_under_tap_term_to_mod_under_tap_term) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_lgui = KeymapKey(0, 1, 0, LGUI_T(KC_P));
|
||||
auto mod_tap_lsft = KeymapKey(0, 2, 0, LSFT_T(KC_A));
|
||||
|
||||
set_keymap({mod_tap_lgui, mod_tap_lsft});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
mod_tap_lsft.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_LGUI));
|
||||
mod_tap_lgui.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_A));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_lsft.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_P));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_lgui.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_over_tap_term_to_mod_under_tap_term) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_lgui = KeymapKey(0, 1, 0, LGUI_T(KC_P));
|
||||
auto mod_tap_lsft = KeymapKey(0, 2, 0, LSFT_T(KC_A));
|
||||
|
||||
set_keymap({mod_tap_lgui, mod_tap_lsft});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
mod_tap_lsft.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_LGUI));
|
||||
mod_tap_lgui.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_NO_REPORT(driver);
|
||||
mod_tap_lsft.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_P));
|
||||
EXPECT_REPORT(driver, (KC_P));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_lgui.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_under_tap_term_to_mod_over_tap_term) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_lgui = KeymapKey(0, 1, 0, LGUI_T(KC_P));
|
||||
auto mod_tap_lsft = KeymapKey(0, 2, 0, LSFT_T(KC_A));
|
||||
|
||||
set_keymap({mod_tap_lgui, mod_tap_lsft});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
mod_tap_lsft.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_LGUI));
|
||||
mod_tap_lgui.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
mod_tap_lsft.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Neutralizer invoked by Retro Tapping.
|
||||
EXPECT_REPORT(driver, (KC_LGUI, DUMMY_MOD_NEUTRALIZER_KEYCODE));
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
EXPECT_REPORT(driver, (KC_P, KC_LSFT));
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_lgui.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_under_tap_term_to_mod_over_tap_term_offset) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_lgui = KeymapKey(0, 1, 0, LGUI_T(KC_P));
|
||||
auto mod_tap_lsft = KeymapKey(0, 2, 0, LSFT_T(KC_A));
|
||||
|
||||
set_keymap({mod_tap_lgui, mod_tap_lsft});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
mod_tap_lsft.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_LGUI));
|
||||
mod_tap_lgui.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_A));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_lsft.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
// Neutralizer invoked by Retro Tapping.
|
||||
EXPECT_REPORT(driver, (KC_LGUI, DUMMY_MOD_NEUTRALIZER_KEYCODE));
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_P));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
idle_for(TAPPING_TERM);
|
||||
mod_tap_lgui.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_over_tap_term_to_mod_over_tap_term) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_lgui = KeymapKey(0, 1, 0, LGUI_T(KC_P));
|
||||
auto mod_tap_lsft = KeymapKey(0, 2, 0, LSFT_T(KC_A));
|
||||
|
||||
set_keymap({mod_tap_lgui, mod_tap_lsft});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
mod_tap_lsft.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_LGUI));
|
||||
mod_tap_lgui.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
mod_tap_lsft.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Neutralizer invoked by Retro Tapping.
|
||||
EXPECT_REPORT(driver, (KC_LGUI, DUMMY_MOD_NEUTRALIZER_KEYCODE));
|
||||
EXPECT_REPORT(driver, (KC_LGUI));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
EXPECT_REPORT(driver, (KC_P, KC_LSFT));
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_lgui.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mod_to_mod_to_mod) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto mod_tap_lalt = KeymapKey(0, 1, 0, LALT_T(KC_R));
|
||||
auto mod_tap_lsft = KeymapKey(0, 2, 0, SFT_T(KC_A));
|
||||
auto mod_tap_lctl = KeymapKey(0, 3, 0, LCTL_T(KC_C));
|
||||
|
||||
set_keymap({mod_tap_lalt, mod_tap_lsft, mod_tap_lctl});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LALT));
|
||||
mod_tap_lalt.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT, KC_LALT));
|
||||
mod_tap_lsft.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
mod_tap_lalt.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LCTL, KC_LSFT));
|
||||
mod_tap_lctl.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
mod_tap_lsft.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
EXPECT_REPORT(driver, (KC_C, KC_LSFT));
|
||||
EXPECT_REPORT(driver, (KC_LSFT));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_lctl.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
}
|
||||
|
||||
// Test with layer tap and speculative mod tap keys on the same layer, rolling
|
||||
// from LT to MT key:
|
||||
// "LT down, MT down, (wait out tapping term), LT up, MT up."
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, lt_mt_same_layer_roll) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto layer_tap_key = KeymapKey(0, 0, 0, LT(1, KC_A));
|
||||
auto mod_tap_key = KeymapKey(0, 1, 0, LCTL_T(KC_B));
|
||||
auto regular_key = KeymapKey(1, 1, 0, KC_C);
|
||||
|
||||
set_keymap({layer_tap_key, mod_tap_key, regular_key});
|
||||
|
||||
// Press layer tap key.
|
||||
EXPECT_NO_REPORT(driver);
|
||||
layer_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Press mod-tap key, after flow tap term but within tapping term. The
|
||||
// speculative mod activates.
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
mod_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Wait for the layer tap key to settle.
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_C));
|
||||
idle_for(TAPPING_TERM);
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Release keys.
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
layer_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
// All mods are released.
|
||||
EXPECT_EQ(get_mods() | get_speculative_mods(), 0);
|
||||
}
|
||||
|
||||
// Test with layer tap and speculative mod tap keys on the same layer, trying a
|
||||
// nested press:
|
||||
// "LT down, MT down, (wait out tapping term), MT up, LT up."
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, lt_mt_same_layer_nested_press) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto layer_tap_key = KeymapKey(0, 0, 0, LT(1, KC_A));
|
||||
auto mod_tap_key = KeymapKey(0, 1, 0, LCTL_T(KC_B));
|
||||
auto regular_key = KeymapKey(1, 1, 0, KC_C);
|
||||
|
||||
set_keymap({layer_tap_key, mod_tap_key, regular_key});
|
||||
|
||||
EXPECT_NO_REPORT(driver);
|
||||
layer_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
mod_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_C));
|
||||
idle_for(TAPPING_TERM);
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Release keys: MT first, LT second.
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
layer_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
// All mods are released.
|
||||
EXPECT_EQ(get_mods() | get_speculative_mods(), 0);
|
||||
}
|
||||
|
||||
// Test with layer tap and speculative mod tap keys on the same layer, trying a
|
||||
// nested press with the MT first:
|
||||
// "MT down, LT down, (wait out tapping term), LT up, MT up."
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, mt_lt_same_layer_nested_press) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto layer_tap_key = KeymapKey(0, 0, 0, LT(1, KC_A));
|
||||
auto mod_tap_key = KeymapKey(0, 1, 0, LCTL_T(KC_B));
|
||||
auto regular_key = KeymapKey(1, 1, 0, KC_C);
|
||||
|
||||
set_keymap({layer_tap_key, mod_tap_key, regular_key});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
mod_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
|
||||
EXPECT_NO_REPORT(driver);
|
||||
layer_tap_key.press();
|
||||
idle_for(TAPPING_TERM + 1);
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LCTL, KC_A));
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
layer_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
// All mods are released.
|
||||
EXPECT_EQ(get_mods() | get_speculative_mods(), 0);
|
||||
}
|
||||
|
||||
// Test with a speculative mod tap key reached by a layer tap key, rolling from
|
||||
// LT to MT key:
|
||||
// "LT down, MT down, (wait out tapping term), LT up, MT up."
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, lt_mt_different_layer_roll) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto layer_tap_key = KeymapKey(0, 0, 0, LT(1, KC_A));
|
||||
auto regular_key = KeymapKey(0, 1, 0, KC_B);
|
||||
auto placeholder_key = KeymapKey(1, 0, 0, KC_NO);
|
||||
auto mod_tap_key = KeymapKey(1, 1, 0, LCTL_T(KC_C));
|
||||
|
||||
set_keymap({layer_tap_key, regular_key, placeholder_key, mod_tap_key});
|
||||
|
||||
// Press layer tap key.
|
||||
EXPECT_NO_REPORT(driver);
|
||||
layer_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
// Press mod tap key.
|
||||
mod_tap_key.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Release keys.
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
layer_tap_key.release();
|
||||
idle_for(TAPPING_TERM);
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
// All mods are released.
|
||||
EXPECT_EQ(get_mods() | get_speculative_mods(), 0);
|
||||
}
|
||||
|
||||
// Test with a speculative mod tap key reached by a layer tap key, slowly
|
||||
// rolling from LT to MT key:
|
||||
// "LT down, (wait), MT down, (wait), LT up, MT up."
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, lt_mt_different_layer_slow_roll) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto layer_tap_key = KeymapKey(0, 0, 0, LT(1, KC_A));
|
||||
auto regular_key = KeymapKey(0, 1, 0, KC_B);
|
||||
auto placeholder_key = KeymapKey(1, 0, 0, KC_NO);
|
||||
auto mod_tap_key = KeymapKey(1, 1, 0, LCTL_T(KC_C));
|
||||
|
||||
set_keymap({layer_tap_key, regular_key, placeholder_key, mod_tap_key});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
layer_tap_key.press();
|
||||
idle_for(TAPPING_TERM + 1);
|
||||
mod_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_B));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
layer_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
// All mods are released.
|
||||
EXPECT_EQ(get_mods() | get_speculative_mods(), 0);
|
||||
}
|
||||
|
||||
// Test with a speculative mod tap key reached by a layer tap key, trying a
|
||||
// nested press:
|
||||
// "LT down, MT down, (wait out tapping term), MT up, LT up."
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, lt_mt_different_layer_nested_press) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto layer_tap_key = KeymapKey(0, 0, 0, LT(1, KC_A));
|
||||
auto regular_key = KeymapKey(0, 1, 0, KC_B);
|
||||
auto placeholder_key = KeymapKey(1, 0, 0, KC_NO);
|
||||
auto mod_tap_key = KeymapKey(1, 1, 0, LCTL_T(KC_C));
|
||||
|
||||
set_keymap({layer_tap_key, regular_key, placeholder_key, mod_tap_key});
|
||||
|
||||
EXPECT_NO_REPORT(driver);
|
||||
layer_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
mod_tap_key.press();
|
||||
idle_for(TAPPING_TERM);
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
// Release keys.
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
layer_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
// All mods are released.
|
||||
EXPECT_EQ(get_mods() | get_speculative_mods(), 0);
|
||||
}
|
||||
|
||||
// Test with a speculative mod tap key reached by a layer tap key, slowly making
|
||||
// a nested press from LT to MT key:
|
||||
// "LT down, (wait), MT down, MT up, LT up."
|
||||
TEST_F(SpeculativeHoldRetroTappingTest, lt_mt_different_layer_slow_nested_press) {
|
||||
TestDriver driver;
|
||||
InSequence s;
|
||||
auto layer_tap_key = KeymapKey(0, 0, 0, LT(1, KC_A));
|
||||
auto regular_key = KeymapKey(0, 1, 0, KC_B);
|
||||
auto placeholder_key = KeymapKey(1, 0, 0, KC_NO);
|
||||
auto mod_tap_key = KeymapKey(1, 1, 0, LCTL_T(KC_C));
|
||||
|
||||
set_keymap({layer_tap_key, regular_key, placeholder_key, mod_tap_key});
|
||||
|
||||
EXPECT_REPORT(driver, (KC_LCTL));
|
||||
layer_tap_key.press();
|
||||
idle_for(TAPPING_TERM + 1);
|
||||
mod_tap_key.press();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
EXPECT_REPORT(driver, (KC_C));
|
||||
EXPECT_EMPTY_REPORT(driver);
|
||||
mod_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
layer_tap_key.release();
|
||||
run_one_scan_loop();
|
||||
VERIFY_AND_CLEAR(driver);
|
||||
// All mods are released.
|
||||
EXPECT_EQ(get_mods() | get_speculative_mods(), 0);
|
||||
}
|
||||
Reference in New Issue
Block a user