1
0
Fork 0

Refactor Leader key feature (#19632)

Co-authored-by: Drashna Jaelre <drashna@live.com>
This commit is contained in:
Ryan 2023-02-13 03:19:02 +11:00 committed by GitHub
parent d10350cd2c
commit bbf7a20b33
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
77 changed files with 2457 additions and 1968 deletions

6
tests/leader/config.h Normal file
View file

@ -0,0 +1,6 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "test_common.h"

View file

@ -0,0 +1,8 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "test_common.h"
#define LEADER_NO_TIMEOUT

View file

@ -0,0 +1,7 @@
# --------------------------------------------------------------------------------
# Keep this file, even if it is empty, as a marker that this folder contains tests
# --------------------------------------------------------------------------------
LEADER_ENABLE = yes
SRC += ../leader_sequences.c

View file

@ -0,0 +1,48 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include "keyboard_report_util.hpp"
#include "keycode.h"
#include "test_common.hpp"
#include "test_keymap_key.hpp"
using testing::_;
class Leader : public TestFixture {};
TEST_F(Leader, does_not_timeout_until_next_key_pressed) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_a = KeymapKey(0, 1, 0, KC_A);
set_keymap({key_leader, key_a});
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_NO_REPORT(driver);
tap_key(key_leader);
EXPECT_EQ(leader_sequence_active(), true);
idle_for(1000);
EXPECT_EQ(leader_sequence_active(), true);
EXPECT_EQ(leader_sequence_timed_out(), false);
EXPECT_REPORT(driver, (KC_1));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
EXPECT_EQ(leader_sequence_active(), true);
EXPECT_EQ(leader_sequence_timed_out(), false);
idle_for(300);
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_EQ(leader_sequence_timed_out(), true);
EXPECT_REPORT(driver, (KC_A));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
}

View file

@ -0,0 +1,5 @@
#pragma once
#include "test_common.h"
#define LEADER_PER_KEY_TIMING

View file

@ -0,0 +1,7 @@
# --------------------------------------------------------------------------------
# Keep this file, even if it is empty, as a marker that this folder contains tests
# --------------------------------------------------------------------------------
LEADER_ENABLE = yes
SRC += ../leader_sequences.c

View file

@ -0,0 +1,40 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include "keyboard_report_util.hpp"
#include "keycode.h"
#include "test_common.hpp"
#include "test_keymap_key.hpp"
using testing::_;
class Leader : public TestFixture {};
TEST_F(Leader, does_not_timeout_during_sequence) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_a = KeymapKey(0, 1, 0, KC_A);
auto key_b = KeymapKey(0, 2, 0, KC_B);
auto key_c = KeymapKey(0, 3, 0, KC_C);
set_keymap({key_leader, key_a, key_b, key_c});
tap_key(key_leader);
EXPECT_NO_REPORT(driver);
tap_key(key_a);
idle_for(150);
EXPECT_NO_REPORT(driver);
tap_key(key_b);
idle_for(150);
EXPECT_REPORT(driver, (KC_3));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_c);
idle_for(300);
}

View file

@ -0,0 +1,26 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include "quantum.h"
void leader_end_user(void) {
if (leader_sequence_one_key(KC_A)) {
tap_code(KC_1);
}
if (leader_sequence_two_keys(KC_A, KC_B)) {
tap_code(KC_2);
}
if (leader_sequence_three_keys(KC_A, KC_B, KC_C)) {
tap_code(KC_3);
}
if (leader_sequence_four_keys(KC_A, KC_B, KC_C, KC_D)) {
tap_code(KC_4);
}
if (leader_sequence_five_keys(KC_A, KC_B, KC_C, KC_D, KC_E)) {
tap_code(KC_5);
}
}

View file

@ -0,0 +1,8 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "test_common.h"
#define LEADER_KEY_STRICT_KEY_PROCESSING

View file

@ -0,0 +1,7 @@
# --------------------------------------------------------------------------------
# Keep this file, even if it is empty, as a marker that this folder contains tests
# --------------------------------------------------------------------------------
LEADER_ENABLE = yes
SRC += ../leader_sequences.c

View file

@ -0,0 +1,45 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include "keyboard_report_util.hpp"
#include "keycode.h"
#include "test_common.hpp"
#include "test_keymap_key.hpp"
using testing::_;
class Leader : public TestFixture {};
TEST_F(Leader, does_not_extract_mod_tap_keycode) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_mt = KeymapKey(0, 1, 0, LSFT_T(KC_A));
set_keymap({key_leader, key_mt});
tap_key(key_leader);
EXPECT_NO_REPORT(driver);
tap_key(key_mt);
EXPECT_EQ(leader_sequence_one_key(KC_A), false);
EXPECT_EQ(leader_sequence_one_key(LSFT_T(KC_A)), true);
}
TEST_F(Leader, does_not_extract_layer_tap_keycode) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_lt = KeymapKey(0, 1, 0, LT(1, KC_A));
set_keymap({key_leader, key_lt});
tap_key(key_leader);
EXPECT_NO_REPORT(driver);
tap_key(key_lt);
EXPECT_EQ(leader_sequence_one_key(KC_A), false);
EXPECT_EQ(leader_sequence_one_key(LT(1, KC_A)), true);
}

7
tests/leader/test.mk Normal file
View file

@ -0,0 +1,7 @@
# --------------------------------------------------------------------------------
# Keep this file, even if it is empty, as a marker that this folder contains tests
# --------------------------------------------------------------------------------
LEADER_ENABLE = yes
SRC += leader_sequences.c

View file

@ -0,0 +1,224 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later
#include "keyboard_report_util.hpp"
#include "keycode.h"
#include "test_common.hpp"
#include "test_keymap_key.hpp"
using testing::_;
class Leader : public TestFixture {};
TEST_F(Leader, triggers_one_key_sequence) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_a = KeymapKey(0, 1, 0, KC_A);
set_keymap({key_leader, key_a});
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_NO_REPORT(driver);
tap_key(key_leader);
EXPECT_EQ(leader_sequence_active(), true);
EXPECT_REPORT(driver, (KC_1));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
EXPECT_EQ(leader_sequence_timed_out(), false);
idle_for(300);
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_EQ(leader_sequence_timed_out(), true);
EXPECT_REPORT(driver, (KC_A));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
}
TEST_F(Leader, triggers_two_key_sequence) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_a = KeymapKey(0, 1, 0, KC_A);
auto key_b = KeymapKey(0, 2, 0, KC_B);
set_keymap({key_leader, key_a, key_b});
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_NO_REPORT(driver);
tap_key(key_leader);
EXPECT_EQ(leader_sequence_active(), true);
EXPECT_REPORT(driver, (KC_2));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
tap_key(key_b);
EXPECT_EQ(leader_sequence_timed_out(), false);
idle_for(300);
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_EQ(leader_sequence_timed_out(), true);
EXPECT_REPORT(driver, (KC_A));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
}
TEST_F(Leader, triggers_three_key_sequence) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_a = KeymapKey(0, 1, 0, KC_A);
auto key_b = KeymapKey(0, 2, 0, KC_B);
auto key_c = KeymapKey(0, 3, 0, KC_C);
set_keymap({key_leader, key_a, key_b, key_c});
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_NO_REPORT(driver);
tap_key(key_leader);
EXPECT_EQ(leader_sequence_active(), true);
EXPECT_REPORT(driver, (KC_3));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
tap_key(key_b);
tap_key(key_c);
EXPECT_EQ(leader_sequence_timed_out(), false);
idle_for(300);
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_EQ(leader_sequence_timed_out(), true);
EXPECT_REPORT(driver, (KC_A));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
}
TEST_F(Leader, triggers_four_key_sequence) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_a = KeymapKey(0, 1, 0, KC_A);
auto key_b = KeymapKey(0, 2, 0, KC_B);
auto key_c = KeymapKey(0, 3, 0, KC_C);
auto key_d = KeymapKey(0, 4, 0, KC_D);
set_keymap({key_leader, key_a, key_b, key_c, key_d});
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_NO_REPORT(driver);
tap_key(key_leader);
EXPECT_EQ(leader_sequence_active(), true);
EXPECT_REPORT(driver, (KC_4));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
tap_key(key_b);
tap_key(key_c);
tap_key(key_d);
EXPECT_EQ(leader_sequence_timed_out(), false);
idle_for(300);
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_EQ(leader_sequence_timed_out(), true);
EXPECT_REPORT(driver, (KC_A));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
}
TEST_F(Leader, triggers_five_key_sequence) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_a = KeymapKey(0, 1, 0, KC_A);
auto key_b = KeymapKey(0, 2, 0, KC_B);
auto key_c = KeymapKey(0, 3, 0, KC_C);
auto key_d = KeymapKey(0, 4, 0, KC_D);
auto key_e = KeymapKey(0, 5, 0, KC_E);
set_keymap({key_leader, key_a, key_b, key_c, key_d, key_e});
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_NO_REPORT(driver);
tap_key(key_leader);
EXPECT_EQ(leader_sequence_active(), true);
EXPECT_REPORT(driver, (KC_5));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
tap_key(key_b);
tap_key(key_c);
tap_key(key_d);
tap_key(key_e);
EXPECT_EQ(leader_sequence_timed_out(), false);
idle_for(300);
EXPECT_EQ(leader_sequence_active(), false);
EXPECT_EQ(leader_sequence_timed_out(), true);
EXPECT_REPORT(driver, (KC_A));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_a);
}
TEST_F(Leader, extracts_mod_tap_keycode) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_mt = KeymapKey(0, 1, 0, LSFT_T(KC_A));
set_keymap({key_leader, key_mt});
tap_key(key_leader);
EXPECT_REPORT(driver, (KC_1));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_mt);
EXPECT_EQ(leader_sequence_one_key(KC_A), true);
idle_for(300);
}
TEST_F(Leader, extracts_layer_tap_keycode) {
TestDriver driver;
auto key_leader = KeymapKey(0, 0, 0, QK_LEADER);
auto key_lt = KeymapKey(0, 1, 0, LT(1, KC_A));
set_keymap({key_leader, key_lt});
tap_key(key_leader);
EXPECT_REPORT(driver, (KC_1));
EXPECT_EMPTY_REPORT(driver);
tap_key(key_lt);
EXPECT_EQ(leader_sequence_one_key(KC_A), true);
idle_for(300);
}