Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chaining OSL and MO #23065

Open
wants to merge 14 commits into
base: develop
Choose a base branch
from
+339 −1
Open

Chaining OSL and MO #23065

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3716fcc
Chaining OSL and MO
DavidSannier Feb 12, 2024
6617af1
Fix formatting
DavidSannier Feb 13, 2024
4d4c623
Add OSL chaining unit test
DavidSannier Feb 15, 2024
9003a37
Merge remote-tracking branch 'origin/develop' into chaining_osl_and_mo
DavidSannier Feb 29, 2024
114cc5f
Merge remote-tracking branch 'origin/develop' into chaining_osl_and_mo
DavidSannier Mar 15, 2024
3fdf074
Add OSL with TG test
DavidSannier Mar 17, 2024
13e8ac7
Add OSL with TO test
DavidSannier Mar 17, 2024
bd4256a
Format code
DavidSannier Mar 18, 2024
13b0b8a
Merge remote-tracking branch 'origin/develop' into chaining_osl_and_mo
DavidSannier Apr 10, 2024
b7a1600
Add OSL with DF test
DavidSannier Apr 10, 2024
17588bb
Merge branch 'develop' into chaining_osl_and_mo
DavidSannier Apr 28, 2024
e9b5b12
Add OSL with LT and OSL with ModTapKey (SFT_T) tests
DavidSannier Apr 28, 2024
7d4e5b9
Merge remote-tracking branch 'origin/develop' into chaining_osl_and_mo
DavidSannier Jun 15, 2024
bf7fc44
Merge remote-tracking branch 'origin/develop' into chaining_osl_and_mo
DavidSannier Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions quantum/action.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -817,6 +817,10 @@ void process_action(keyrecord_t *record, action_t action) {
case ACT_LAYER_TAP_EXT:
# endif
led_set(host_keyboard_leds());
# ifndef NO_ACTION_ONESHOT
// don't release the key
do_release_oneshot = false;
# endif
break;
default:
break;
Expand Down
336 changes: 335 additions & 1 deletion tests/basic/test_one_shot_keys.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ TEST_F(OneShot, OSMChainingTwoOSMs) {
tap_key(osm_key1);
VERIFY_AND_CLEAR(driver);

/* Press and relesea OSM2 */
/* Press and release OSM2 */
EXPECT_NO_REPORT(driver);
tap_key(osm_key2);
VERIFY_AND_CLEAR(driver);
Expand Down Expand Up @@ -353,3 +353,337 @@ TEST_F(OneShot, OSLWithOsmAndAdditionalKeypress) {
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);
}

TEST_F(OneShot, OSLWithMoAndAdditionalKeypress) {
drashna marked this conversation as resolved.
Show resolved Hide resolved
TestDriver driver;
InSequence s;
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey mo_key = KeymapKey{1, 1, 0, MO(2)};
KeymapKey regular_key = KeymapKey{2, 1, 1, KC_A};

set_keymap({osl_key, mo_key, regular_key});

/* Press OSL key */
EXPECT_NO_REPORT(driver);
osl_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release OSL key */
EXPECT_NO_REPORT(driver);
osl_key.release();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(1));
VERIFY_AND_CLEAR(driver);

/* Press MO */
EXPECT_NO_REPORT(driver);
mo_key.press();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(2));
VERIFY_AND_CLEAR(driver);

/* Press regular key */
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
regular_key.press();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(2));
VERIFY_AND_CLEAR(driver);

/* Release regular key */
EXPECT_EMPTY_REPORT(driver);
regular_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release MO */
EXPECT_NO_REPORT(driver);
mo_key.release();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(0));
VERIFY_AND_CLEAR(driver);
}

class OneShotLayerParametrizedTestFixture : public ::testing::WithParamInterface<uint16_t>, public OneShot {};

TEST_P(OneShotLayerParametrizedTestFixture, OSLWithActionAndAdditionalKeypress) {
TestDriver driver;
InSequence s;
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey action_key = KeymapKey{1, 1, 0, GetParam()};
KeymapKey regular_key = KeymapKey{2, 1, 1, KC_A};

set_keymap({osl_key, action_key, regular_key});

/* Tap OSL key */
EXPECT_NO_REPORT(driver);
tap_key(osl_key);
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Tag Action key */
EXPECT_NO_REPORT(driver);
tap_key(action_key);
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(2));
VERIFY_AND_CLEAR(driver);

/* Press regular key */
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
regular_key.press();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(2));
VERIFY_AND_CLEAR(driver);

/* Release regular key */
EXPECT_EMPTY_REPORT(driver);
regular_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);
}

INSTANTIATE_TEST_CASE_P(OneShotLayerTests, OneShotLayerParametrizedTestFixture, ::testing::Values(TG(2), TO(2)));

TEST_F(OneShot, OSLWithDFAndAdditionalKeypress) {
TestDriver driver;
InSequence s;
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey df_key = KeymapKey{1, 1, 0, DF(2)};
KeymapKey regular_key = KeymapKey{2, 1, 1, KC_A};

set_keymap({osl_key, df_key, regular_key});

layer_state_t default_layer_state_bak = default_layer_state;

/* Tap OSL key */
EXPECT_NO_REPORT(driver);
tap_key(osl_key);
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(1));
VERIFY_AND_CLEAR(driver);

/* Press DF key */
EXPECT_NO_REPORT(driver);
df_key.press();
run_one_scan_loop();
EXPECT_EQ(default_layer_state, 0b001);

VERIFY_AND_CLEAR(driver);

/* Release DF key */
EXPECT_NO_REPORT(driver);
df_key.release();
run_one_scan_loop();
EXPECT_EQ(default_layer_state, 0b100);
VERIFY_AND_CLEAR(driver);

/* Press regular key */
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
regular_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release regular key */
EXPECT_EMPTY_REPORT(driver);
regular_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

default_layer_state = default_layer_state_bak;
}

TEST_F(OneShot, OSLChainingTwoOSLsAndAdditionalKeypress) {
TestDriver driver;
InSequence s;
KeymapKey osl1_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey osl2_key = KeymapKey{1, 1, 0, OSL(2)};
KeymapKey regular_key = KeymapKey{2, 1, 1, KC_A};

set_keymap({osl1_key, osl2_key, regular_key});

/* Press and release first OSL key */
EXPECT_NO_REPORT(driver);
osl1_key.press();
run_one_scan_loop();
osl1_key.release();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(1));
VERIFY_AND_CLEAR(driver);

/* Press and release second OSL */
EXPECT_NO_REPORT(driver);
osl2_key.press();
run_one_scan_loop();
osl2_key.release();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(2));
VERIFY_AND_CLEAR(driver);

/* Press regular key */
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
EXPECT_EMPTY_REPORT(driver);
regular_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release regular key */
EXPECT_NO_REPORT(driver);
regular_key.release();
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(0));
VERIFY_AND_CLEAR(driver);
}

TEST_F(OneShot, OSLWithShortLT) {
TestDriver driver;
InSequence s;
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey lt_key = KeymapKey(1, 1, 0, LT(2, KC_A));

set_keymap({osl_key, lt_key});

/* Tap OSL key */
EXPECT_NO_REPORT(driver);
tap_key(osl_key);
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(1));
VERIFY_AND_CLEAR(driver);

/* Tap LT key. */
EXPECT_REPORT(driver, (lt_key.report_code)).Times(1);
EXPECT_EMPTY_REPORT(driver);
tap_key(lt_key);
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(0));
VERIFY_AND_CLEAR(driver);
}

TEST_F(OneShot, OSLWithLongLTAndRegularKey) {
TestDriver driver;
InSequence s;
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey lt_key = KeymapKey(1, 1, 0, LT(2, KC_A));
KeymapKey regular_key = KeymapKey(2, 1, 1, KC_B);

set_keymap({osl_key, lt_key, regular_key});

/* Tap OSL key */
EXPECT_NO_REPORT(driver);
tap_key(osl_key);
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(1));
VERIFY_AND_CLEAR(driver);

/* Press LT key. */
EXPECT_NO_REPORT(driver);
lt_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Idle for tapping term of mod tap hold key. */
EXPECT_NO_REPORT(driver);
idle_for(TAPPING_TERM + 1);
VERIFY_AND_CLEAR(driver);
EXPECT_TRUE(layer_state_is(2));

/* Press regular key. */
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
regular_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release regular key. */
EXPECT_EMPTY_REPORT(driver);
regular_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);
}

TEST_F(OneShot, OSLWithShortModTapKeyAndRegularKey) {
TestDriver driver;
InSequence s;
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey mod_tap_hold_key = KeymapKey(1, 1, 0, SFT_T(KC_P));
KeymapKey regular_key = KeymapKey(0, 2, 0, KC_A);

set_keymap({osl_key, mod_tap_hold_key, regular_key});

/* Tap OSL key */
EXPECT_NO_REPORT(driver);
tap_key(osl_key);
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(1));
VERIFY_AND_CLEAR(driver);

/* Press mod-tap-hold key. */
EXPECT_NO_REPORT(driver);
mod_tap_hold_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release mod-tap-hold key. */
EXPECT_REPORT(driver, (KC_P));
EXPECT_EMPTY_REPORT(driver);
mod_tap_hold_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Press regular key. */
EXPECT_REPORT(driver, (regular_key.report_code));
regular_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release regular key. */
EXPECT_EMPTY_REPORT(driver);
regular_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);
}

TEST_F(OneShot, OSLWithLongModTapKeyAndRegularKey) {
TestDriver driver;
InSequence s;
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
KeymapKey mod_tap_hold_key = KeymapKey(1, 1, 0, SFT_T(KC_P));
KeymapKey regular_key = KeymapKey(1, 2, 0, KC_A);

set_keymap({osl_key, mod_tap_hold_key, regular_key});

/* Tap OSL key */
EXPECT_NO_REPORT(driver);
tap_key(osl_key);
run_one_scan_loop();
EXPECT_TRUE(layer_state_is(1));
VERIFY_AND_CLEAR(driver);

/* Press mod-tap-hold key. */
EXPECT_NO_REPORT(driver);
mod_tap_hold_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Idle for tapping term of mod tap hold key. */
EXPECT_REPORT(driver, (KC_LSFT));
idle_for(TAPPING_TERM + 1);
VERIFY_AND_CLEAR(driver);

/* Release mod-tap-hold key. */
EXPECT_EMPTY_REPORT(driver);
mod_tap_hold_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Press regular key. */
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
EXPECT_EMPTY_REPORT(driver);
regular_key.press();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);

/* Release regular key. */
EXPECT_NO_REPORT(driver);
regular_key.release();
run_one_scan_loop();
VERIFY_AND_CLEAR(driver);
}
Loading