qmk/tests/basic/test_tapping.cpp

/* Copyright 2017 Fred Sundvik
 *
 * 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/>.
 */

#include "keyboard_report_util.hpp"
#include "keycode.h"
#include "test_common.hpp"
#include "action_tapping.h"
#include "test_keymap_key.hpp"

using testing::_;
using testing::InSequence;

class Tapping : public TestFixture {};

TEST_F(Tapping, TapA_SHFT_T_KeyReportsKey) {
    TestDriver driver;
    InSequence s;
    auto       key_shift_hold_p_tap = KeymapKey(0, 7, 0, SFT_T(KC_P));

    set_keymap({key_shift_hold_p_tap});

    // Tapping keys does nothing on press
    key_shift_hold_p_tap.press();
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();

    // First we get the key press
    key_shift_hold_p_tap.release();
    EXPECT_REPORT(driver, (KC_P));

    // Then the release
    EXPECT_EMPTY_REPORT(driver);
    run_one_scan_loop();
}

TEST_F(Tapping, HoldA_SHFT_T_KeyReportsShift) {
    TestDriver driver;
    InSequence s;
    auto       mod_tap_hold_key = KeymapKey(0, 7, 0, SFT_T(KC_P));

    set_keymap({mod_tap_hold_key});

    mod_tap_hold_key.press();

    // Tapping keys does nothing on press
    EXPECT_NO_REPORT(driver);
    idle_for(TAPPING_TERM);

    EXPECT_REPORT(driver, (KC_LSFT));
    run_one_scan_loop();

    EXPECT_EMPTY_REPORT(driver);
    mod_tap_hold_key.release();
    run_one_scan_loop();
}

TEST_F(Tapping, ANewTapWithinTappingTermIsBuggy) {
    // See issue #1478 for more information
    TestDriver driver;
    InSequence s;
    auto       key_shift_hold_p_tap = KeymapKey(0, 7, 0, SFT_T(KC_P));

    set_keymap({key_shift_hold_p_tap});

    // Tapping keys does nothing on press
    key_shift_hold_p_tap.press();
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();
    key_shift_hold_p_tap.release();

    // First we get the key press
    EXPECT_REPORT(driver, (KC_P));
    // Then the release
    EXPECT_EMPTY_REPORT(driver);
    run_one_scan_loop();

    // This sends KC_P, even if it should do nothing
    key_shift_hold_p_tap.press();
    // This test should not succed if everything works correctly
    EXPECT_REPORT(driver, (KC_P));
    run_one_scan_loop();

    key_shift_hold_p_tap.release();
    EXPECT_EMPTY_REPORT(driver);
    idle_for(TAPPING_TERM + 1);

    // On the other hand, nothing is sent if we are outside the tapping term
    key_shift_hold_p_tap.press();
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();
    key_shift_hold_p_tap.release();

    // First we get the key press
    EXPECT_REPORT(driver, (KC_P));
    // Then the release
    EXPECT_EMPTY_REPORT(driver);
    idle_for(TAPPING_TERM + 1);

    // Now we are geting into strange territory, as the hold registers too early here
    // But the stranges part is:
    // If TAPPING_TERM + 1 above is changed to TAPPING_TERM or TAPPING_TERM + 2 it doesn't
    key_shift_hold_p_tap.press();
    // Shouldn't be called here really
    EXPECT_REPORT(driver, (KC_LEFT_SHIFT)).Times(1);
    idle_for(TAPPING_TERM);

    EXPECT_EMPTY_REPORT(driver);
    key_shift_hold_p_tap.release();
    run_one_scan_loop();
}

TEST_F(Tapping, TapA_CTL_T_KeyWhileReleasingShift) {
    TestDriver driver;
    InSequence s;
    auto       shift_key        = KeymapKey(0, 7, 0, KC_LSFT);
    auto       mod_tap_hold_key = KeymapKey(0, 8, 0, CTL_T(KC_P));

    set_keymap({shift_key, mod_tap_hold_key});

    shift_key.press();
    // Shift is reported
    EXPECT_REPORT(driver, (KC_LSFT));
    run_one_scan_loop();
    VERIFY_AND_CLEAR(driver);

    mod_tap_hold_key.press();
    // Tapping keys does nothing on press
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();

    shift_key.release();
    // Releasing shift is delayed while tapping is in progress
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();
    VERIFY_AND_CLEAR(driver);

    mod_tap_hold_key.release();
    // Releasing mod-tap key reports the tap and releases shift
    EXPECT_REPORT(driver, (KC_LSFT, KC_P));
    EXPECT_REPORT(driver, (KC_P));
    EXPECT_EMPTY_REPORT(driver);
    run_one_scan_loop();
    VERIFY_AND_CLEAR(driver);
}

TEST_F(Tapping, TapA_CTL_T_KeyWhileReleasingLayer) {
    TestDriver driver;
    InSequence s;
    auto       layer_key         = KeymapKey(0, 7, 0, MO(1));
    auto       trans_key         = KeymapKey(1, 7, 0, KC_TRNS);
    auto       mod_tap_hold_key0 = KeymapKey(0, 8, 0, CTL_T(KC_P));
    auto       mod_tap_hold_key1 = KeymapKey(1, 8, 0, CTL_T(KC_Q));

    set_keymap({layer_key, trans_key, mod_tap_hold_key0, mod_tap_hold_key1});

    layer_key.press();
    // Pressing the layer key does nothing
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();

    mod_tap_hold_key1.press();
    // Tapping layer 1 mod-tap key does nothing on press
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();

    layer_key.release();
    // Releasing layer is delayed while tapping is in progress
    EXPECT_NO_REPORT(driver);
    run_one_scan_loop();
    VERIFY_AND_CLEAR(driver);

    mod_tap_hold_key1.release();
    // Releasing mod-tap key reports the tap of the layer 1 key
    // If delayed layer release is broken, this reports the layer 0 key
    EXPECT_REPORT(driver, (KC_Q));
    EXPECT_EMPTY_REPORT(driver);
    run_one_scan_loop();
    VERIFY_AND_CLEAR(driver);
}