aboutsummaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorNick Brassel <[email protected]>2023-08-29 21:24:43 +1000
committerNick Brassel <[email protected]>2023-08-29 21:24:43 +1000
commit31a91add168c956655ace8ec4cf9750db1e2cfc6 (patch)
tree12cea9b5f8e769f9611a31cbaede9537edad71cc /tests
parentf07490bc092e365ba03dc685b3fc30ad0bf0b752 (diff)
parentedaf8a87ef3164f8986b0a8eb171d4879b45414c (diff)
downloadqmk_firmware-31a91add168c956655ace8ec4cf9750db1e2cfc6.tar.gz
qmk_firmware-31a91add168c956655ace8ec4cf9750db1e2cfc6.zip
Merge branch 'develop'0.22.0
Diffstat (limited to 'tests')
-rw-r--r--tests/audio/config.h18
-rw-r--r--tests/audio/test.mk16
-rw-r--r--tests/audio/test_audio.cpp118
-rw-r--r--tests/caps_word/caps_word_unicodemap/test_caps_word_unicodemap.cpp4
-rw-r--r--tests/tap_dance/examples.c24
-rw-r--r--tests/tap_dance/examples.h2
-rw-r--r--tests/tap_dance/test_examples.cpp116
-rw-r--r--tests/tap_hold_configurations/retro_tapping/config.h5
-rw-r--r--tests/tap_hold_configurations/retro_tapping/test_neutralization.cpp201
-rw-r--r--tests/test_common/test_driver.cpp9
-rw-r--r--tests/unicode/config.h8
-rw-r--r--tests/unicode/test.mk5
-rw-r--r--tests/unicode/test_unicode.cpp86
-rw-r--r--tests/unicode/unicode_basic/config.h8
-rw-r--r--tests/unicode/unicode_basic/test.mk5
-rw-r--r--tests/unicode/unicode_basic/test_unicode_basic.cpp26
-rw-r--r--tests/unicode/unicode_map/config.h8
-rw-r--r--tests/unicode/unicode_map/test.mk5
-rw-r--r--tests/unicode/unicode_map/test_unicode_map.cpp54
-rw-r--r--tests/unicode/unicode_ucis/config.h8
-rw-r--r--tests/unicode/unicode_ucis/test.mk5
-rw-r--r--tests/unicode/unicode_ucis/test_unicode_ucis.cpp221
22 files changed, 946 insertions, 6 deletions
diff --git a/tests/audio/config.h b/tests/audio/config.h
new file mode 100644
index 0000000000..d0c4ddadbd
--- /dev/null
+++ b/tests/audio/config.h
@@ -0,0 +1,18 @@
+// Copyright 2023 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"
diff --git a/tests/audio/test.mk b/tests/audio/test.mk
new file mode 100644
index 0000000000..a2c71d9587
--- /dev/null
+++ b/tests/audio/test.mk
@@ -0,0 +1,16 @@
+# Copyright 2023 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/>.
+
+AUDIO_ENABLE = yes
diff --git a/tests/audio/test_audio.cpp b/tests/audio/test_audio.cpp
new file mode 100644
index 0000000000..ef34748b06
--- /dev/null
+++ b/tests/audio/test_audio.cpp
@@ -0,0 +1,118 @@
+// Copyright 2023 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/>.
+
+#include <cmath>
+#include <random>
+
+#include "gtest/gtest.h"
+#include "keyboard_report_util.hpp"
+#include "test_common.hpp"
+
+namespace {
+
+class AudioTest : public TestFixture {
+ public:
+ uint16_t infer_tempo() {
+ return audio_ms_to_duration(1875) / 2;
+ }
+};
+
+TEST_F(AudioTest, OnOffToggle) {
+ audio_on();
+ EXPECT_TRUE(audio_is_on());
+
+ audio_off();
+ EXPECT_FALSE(audio_is_on());
+
+ audio_toggle();
+ EXPECT_TRUE(audio_is_on());
+
+ audio_toggle();
+ EXPECT_FALSE(audio_is_on());
+}
+
+TEST_F(AudioTest, ChangeTempo) {
+ for (int tempo = 50; tempo <= 250; tempo += 50) {
+ audio_set_tempo(tempo);
+ EXPECT_EQ(infer_tempo(), tempo);
+ }
+
+ audio_set_tempo(10);
+ audio_increase_tempo(25);
+ EXPECT_EQ(infer_tempo(), 35);
+
+ audio_decrease_tempo(4);
+ EXPECT_EQ(infer_tempo(), 31);
+
+ audio_increase_tempo(250);
+ EXPECT_EQ(infer_tempo(), 255);
+
+ audio_set_tempo(9);
+ EXPECT_EQ(infer_tempo(), 10);
+
+ audio_decrease_tempo(100);
+ EXPECT_EQ(infer_tempo(), 10);
+}
+
+TEST_F(AudioTest, BpmConversion) {
+ const int tol = 1;
+
+ audio_set_tempo(120);
+ // At 120 bpm, there are 2 beats per second, and a whole note is 500 ms.
+ EXPECT_NEAR(audio_duration_to_ms(64 /* whole note */), 500, tol);
+ EXPECT_NEAR(audio_ms_to_duration(500), 64, tol);
+ EXPECT_EQ(audio_duration_to_ms(0), 0);
+ EXPECT_EQ(audio_ms_to_duration(0), 0);
+
+ audio_set_tempo(10);
+ // At 10 bpm, UINT16_MAX ms corresponds to 699/64 beats and is the longest
+ // duration that can be converted without overflow.
+ EXPECT_NEAR(audio_ms_to_duration(UINT16_MAX), 699, tol);
+ EXPECT_NEAR(audio_duration_to_ms(699), 65531, tol);
+
+ audio_set_tempo(255);
+ // At 255 bpm, UINT16_MAX ms corresponds to 17825/64 beats and is the longest
+ // duration that can be converted without overflow.
+ EXPECT_NEAR(audio_ms_to_duration(UINT16_MAX), 17825, tol);
+ EXPECT_NEAR(audio_duration_to_ms(17825), 65533, tol);
+
+ std::mt19937 rng(0 /*seed*/);
+ std::uniform_int_distribution<int> dist_tempo(10, 255);
+ std::uniform_int_distribution<int> dist_ms(0, UINT16_MAX);
+
+ // Test bpm <-> ms conversions for random tempos and durations.
+ for (int trial = 0; trial < 50; ++trial) {
+ const int tempo = dist_tempo(rng);
+ const int duration_ms = dist_ms(rng);
+ SCOPED_TRACE("tempo " + testing::PrintToString(tempo) + ", duration " + testing::PrintToString(duration_ms) + " ms");
+
+ audio_set_tempo(tempo);
+ int duration_bpm = std::round((64.0f / (60.0f * 1000.0f)) * duration_ms * tempo);
+ ASSERT_NEAR(audio_ms_to_duration(duration_ms), duration_bpm, tol);
+
+ int roundtrip_ms = std::round((60.0f * 1000.0f / 64.0f) * duration_bpm / tempo);
+ // Because of round-off error, duration_ms and roundtrip_ms may differ by
+ // about (60 * 1000 / 64) / tempo.
+ int roundtrip_tol = tol * (60.0f * 1000.0f / 64.0f) / tempo;
+ ASSERT_NEAR(roundtrip_ms, duration_ms, roundtrip_tol);
+
+ // Only test converting back to ms if the result would be in uint16_t range.
+ if (roundtrip_ms <= UINT16_MAX) {
+ ASSERT_NEAR(audio_duration_to_ms(duration_bpm), roundtrip_ms, tol);
+ }
+ }
+}
+
+} // namespace
diff --git a/tests/caps_word/caps_word_unicodemap/test_caps_word_unicodemap.cpp b/tests/caps_word/caps_word_unicodemap/test_caps_word_unicodemap.cpp
index 01cdfd6408..21e5493526 100644
--- a/tests/caps_word/caps_word_unicodemap/test_caps_word_unicodemap.cpp
+++ b/tests/caps_word/caps_word_unicodemap/test_caps_word_unicodemap.cpp
@@ -39,8 +39,8 @@ const uint32_t unicode_map[] PROGMEM = {
[DELTA_UPPERCASE] = 0x0394,
};
-#define U_DASH XP(ENDASH, EMDASH)
-#define U_DELTA XP(DELTA_LOWERCASE, DELTA_UPPERCASE)
+#define U_DASH UP(ENDASH, EMDASH)
+#define U_DELTA UP(DELTA_LOWERCASE, DELTA_UPPERCASE)
bool caps_word_press_user(uint16_t keycode) {
switch (keycode) {
diff --git a/tests/tap_dance/examples.c b/tests/tap_dance/examples.c
index af74388209..13086bbb4b 100644
--- a/tests/tap_dance/examples.c
+++ b/tests/tap_dance/examples.c
@@ -187,13 +187,35 @@ void x_reset(tap_dance_state_t *state, void *user_data) {
xtap_state.state = TD_NONE;
}
+static void release_press(tap_dance_state_t *state, void *user_data) {
+ tap_code16(KC_P);
+}
+
+static void release_unpress(tap_dance_state_t *state, void *user_data) {
+ tap_code16(KC_U);
+}
+
+static void release_unpress_mark_finished(tap_dance_state_t *state, void *user_data) {
+ tap_code16(KC_U);
+ state->finished = true;
+}
+
+static void release_finished(tap_dance_state_t *state, void *user_data) {
+ tap_code16(KC_F);
+}
+
+static void release_reset(tap_dance_state_t *state, void *user_data) {
+ tap_code16(KC_R);
+}
tap_dance_action_t tap_dance_actions[] = {
[TD_ESC_CAPS] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS),
[CT_EGG] = ACTION_TAP_DANCE_FN(dance_egg),
[CT_FLSH] = ACTION_TAP_DANCE_FN_ADVANCED(dance_flsh_each, dance_flsh_finished, dance_flsh_reset),
[CT_CLN] = ACTION_TAP_DANCE_TAP_HOLD(KC_COLN, KC_SCLN),
- [X_CTL] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, x_finished, x_reset)
+ [X_CTL] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, x_finished, x_reset),
+ [TD_RELEASE] = ACTION_TAP_DANCE_FN_ADVANCED_WITH_RELEASE(release_press, release_unpress, release_finished, release_reset),
+ [TD_RELEASE_AND_FINISH] = ACTION_TAP_DANCE_FN_ADVANCED_WITH_RELEASE(release_press, release_unpress_mark_finished, release_finished, release_reset),
};
// clang-format on
diff --git a/tests/tap_dance/examples.h b/tests/tap_dance/examples.h
index 2622af6b2f..6118188dd1 100644
--- a/tests/tap_dance/examples.h
+++ b/tests/tap_dance/examples.h
@@ -26,6 +26,8 @@ enum {
CT_FLSH,
CT_CLN,
X_CTL,
+ TD_RELEASE,
+ TD_RELEASE_AND_FINISH,
};
#ifdef __cplusplus
diff --git a/tests/tap_dance/test_examples.cpp b/tests/tap_dance/test_examples.cpp
index 6dabc45513..7858dab92b 100644
--- a/tests/tap_dance/test_examples.cpp
+++ b/tests/tap_dance/test_examples.cpp
@@ -316,3 +316,119 @@ TEST_F(TapDance, QuadFunction) {
EXPECT_EMPTY_REPORT(driver);
run_one_scan_loop();
}
+
+TEST_F(TapDance, DanceFnAdvancedWithRelease) {
+ TestDriver driver;
+ InSequence s;
+ auto key_rls = KeymapKey(0, 1, 0, TD(TD_RELEASE));
+
+ set_keymap({key_rls});
+
+ /* Single press and unpress */
+ key_rls.press();
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ key_rls.release();
+ EXPECT_REPORT(driver, (KC_U));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ EXPECT_REPORT(driver, (KC_F));
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_R));
+ EXPECT_EMPTY_REPORT(driver);
+ idle_for(TAPPING_TERM);
+ run_one_scan_loop();
+
+ /* Double press and unpress */
+ key_rls.press();
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ key_rls.release();
+ EXPECT_REPORT(driver, (KC_U));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ key_rls.press();
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ key_rls.release();
+ EXPECT_REPORT(driver, (KC_U));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ EXPECT_REPORT(driver, (KC_F));
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_R));
+ EXPECT_EMPTY_REPORT(driver);
+ idle_for(TAPPING_TERM);
+ run_one_scan_loop();
+
+ /* Unpress after tapping term has elapsed (key is registered as held) */
+ key_rls.press();
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ EXPECT_REPORT(driver, (KC_F));
+ EXPECT_EMPTY_REPORT(driver);
+ idle_for(TAPPING_TERM);
+ run_one_scan_loop();
+
+ key_rls.release();
+ EXPECT_REPORT(driver, (KC_U));
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_R));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+}
+
+TEST_F(TapDance, DanceFnAdvancedWithReleaseAndFinish) {
+ TestDriver driver;
+ InSequence s;
+ auto key_rls = KeymapKey(0, 1, 0, TD(TD_RELEASE_AND_FINISH));
+
+ set_keymap({key_rls});
+
+ /* Single press and unpress */
+ key_rls.press();
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ key_rls.release();
+ EXPECT_REPORT(driver, (KC_U));
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_R));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ // Verify the finished and/or reset functions aren't called
+ // after the tapping term elapses
+ idle_for(TAPPING_TERM);
+ run_one_scan_loop();
+
+ /* Unpress after tapping term has elapsed (key is registered as held) */
+ key_rls.press();
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+
+ EXPECT_REPORT(driver, (KC_F));
+ EXPECT_EMPTY_REPORT(driver);
+ idle_for(TAPPING_TERM);
+ run_one_scan_loop();
+
+ key_rls.release();
+ EXPECT_REPORT(driver, (KC_U));
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_R));
+ EXPECT_EMPTY_REPORT(driver);
+ run_one_scan_loop();
+}
diff --git a/tests/tap_hold_configurations/retro_tapping/config.h b/tests/tap_hold_configurations/retro_tapping/config.h
index 4b38f2644b..cc9f162477 100644
--- a/tests/tap_hold_configurations/retro_tapping/config.h
+++ b/tests/tap_hold_configurations/retro_tapping/config.h
@@ -18,4 +18,7 @@
#include "test_common.h"
-#define RETRO_TAPPING \ No newline at end of file
+#define RETRO_TAPPING
+#define DUMMY_MOD_NEUTRALIZER_KEYCODE KC_RIGHT_CTRL
+#define MODS_TO_NEUTRALIZE \
+ { MOD_BIT(KC_LEFT_GUI) }
diff --git a/tests/tap_hold_configurations/retro_tapping/test_neutralization.cpp b/tests/tap_hold_configurations/retro_tapping/test_neutralization.cpp
new file mode 100644
index 0000000000..10d675a3b1
--- /dev/null
+++ b/tests/tap_hold_configurations/retro_tapping/test_neutralization.cpp
@@ -0,0 +1,201 @@
+/* Copyright 2023 Vladislav Kucheriavykh
+ *
+ * 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 3 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 RetroTapNeutralization : public TestFixture {};
+
+TEST_F(RetroTapNeutralization, neutralize_retro_tapped_left_gui_mod_tap) {
+ TestDriver driver;
+ InSequence s;
+ auto mod_tap_hold_key = KeymapKey(0, 7, 0, LGUI_T(KC_P));
+
+ set_keymap({mod_tap_hold_key});
+
+ EXPECT_NO_REPORT(driver);
+ mod_tap_hold_key.press();
+ idle_for(TAPPING_TERM);
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_REPORT(driver, (KC_LGUI));
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_REPORT(driver, (DUMMY_MOD_NEUTRALIZER_KEYCODE, KC_LGUI));
+ EXPECT_REPORT(driver, (KC_LGUI));
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ mod_tap_hold_key.release();
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(RetroTapNeutralization, do_not_neutralize_retro_tapped_left_shift_mod_tap) {
+ TestDriver driver;
+ InSequence s;
+ auto mod_tap_hold_key = KeymapKey(0, 7, 0, LSFT_T(KC_P));
+
+ set_keymap({mod_tap_hold_key});
+
+ EXPECT_NO_REPORT(driver);
+ mod_tap_hold_key.press();
+ idle_for(TAPPING_TERM);
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ mod_tap_hold_key.release();
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(RetroTapNeutralization, do_not_neutralize_retro_tapped_right_gui_mod_tap) {
+ TestDriver driver;
+ InSequence s;
+ auto mod_tap_hold_key = KeymapKey(0, 7, 0, RGUI_T(KC_P));
+
+ set_keymap({mod_tap_hold_key});
+
+ EXPECT_NO_REPORT(driver);
+ mod_tap_hold_key.press();
+ idle_for(TAPPING_TERM);
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_REPORT(driver, (KC_RGUI));
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ mod_tap_hold_key.release();
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(RetroTapNeutralization, do_not_neutralize_retro_tapped_left_gui_shift_mod_tap) {
+ TestDriver driver;
+ InSequence s;
+ auto mod_tap_hold_key = KeymapKey(0, 7, 0, MT(MOD_LGUI | MOD_LSFT, KC_P));
+
+ set_keymap({mod_tap_hold_key});
+
+ EXPECT_NO_REPORT(driver);
+ mod_tap_hold_key.press();
+ idle_for(TAPPING_TERM);
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_REPORT(driver, (KC_LSFT, KC_LGUI));
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+
+ EXPECT_EMPTY_REPORT(driver);
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ mod_tap_hold_key.release();
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(RetroTapNeutralization, do_not_neutralize_roll_of_regular_and_mod_tap_keys) {
+ TestDriver driver;
+ InSequence s;
+ auto mod_tap_hold_key = KeymapKey(0, 1, 0, LGUI_T(KC_P));
+ auto regular_key = KeymapKey(0, 2, 0, KC_A);
+
+ set_keymap({mod_tap_hold_key, regular_key});
+
+ /* Press mod-tap-hold key. */
+ EXPECT_NO_REPORT(driver);
+ mod_tap_hold_key.press();
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+
+ /* Press regular key. */
+ EXPECT_NO_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);
+
+ /* Release mod-tap-hold key. */
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_REPORT(driver, (KC_P, KC_A));
+ EXPECT_REPORT(driver, (KC_P));
+ EXPECT_EMPTY_REPORT(driver);
+ mod_tap_hold_key.release();
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+
+ /* Idle for tapping term of mod tap hold key. */
+ idle_for(TAPPING_TERM - 3);
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(RetroTapNeutralization, do_not_neutralize_tap_regular_key_while_mod_tap_is_held) {
+ TestDriver driver;
+ InSequence s;
+ auto mod_tap_hold_key = KeymapKey(0, 1, 0, LGUI_T(KC_P));
+ auto regular_key = KeymapKey(0, 2, 0, KC_A);
+
+ set_keymap({mod_tap_hold_key, regular_key});
+
+ /* Press and hold mod-tap key. */
+ EXPECT_REPORT(driver, (KC_LEFT_GUI));
+ mod_tap_hold_key.press();
+ idle_for(TAPPING_TERM + 1);
+ VERIFY_AND_CLEAR(driver);
+
+ /* Press regular key. */
+ EXPECT_REPORT(driver, (KC_A, KC_LEFT_GUI));
+ regular_key.press();
+ run_one_scan_loop();
+ VERIFY_AND_CLEAR(driver);
+
+ /* Release regular key. */
+ EXPECT_REPORT(driver, (KC_LEFT_GUI));
+ regular_key.release();
+ run_one_scan_loop();
+ 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);
+
+ /* Idle for tapping term of mod tap hold key. */
+ idle_for(TAPPING_TERM - 3);
+ VERIFY_AND_CLEAR(driver);
+}
diff --git a/tests/test_common/test_driver.cpp b/tests/test_common/test_driver.cpp
index f1c52cb7b6..0495da8205 100644
--- a/tests/test_common/test_driver.cpp
+++ b/tests/test_common/test_driver.cpp
@@ -60,7 +60,10 @@ void TestDriver::send_extra(report_extra_t* report) {
namespace internal {
void expect_unicode_code_point(TestDriver& driver, uint32_t code_point) {
testing::InSequence seq;
- EXPECT_REPORT(driver, (KC_LCTL, KC_LSFT, KC_U));
+ EXPECT_REPORT(driver, (KC_LEFT_CTRL, KC_LEFT_SHIFT));
+ EXPECT_REPORT(driver, (KC_LEFT_CTRL, KC_LEFT_SHIFT, KC_U));
+ EXPECT_REPORT(driver, (KC_LEFT_CTRL, KC_LEFT_SHIFT));
+ EXPECT_EMPTY_REPORT(driver);
bool print_zero = false;
for (int i = 7; i >= 0; --i) {
@@ -71,10 +74,12 @@ void expect_unicode_code_point(TestDriver& driver, uint32_t code_point) {
const uint8_t digit = (code_point >> (i * 4)) & 0xf;
if (digit || print_zero) {
EXPECT_REPORT(driver, (hex_digit_to_keycode(digit)));
+ EXPECT_EMPTY_REPORT(driver);
print_zero = true;
}
}
- EXPECT_REPORT(driver, (KC_SPC));
+ EXPECT_REPORT(driver, (KC_SPACE));
+ EXPECT_EMPTY_REPORT(driver);
}
} // namespace internal
diff --git a/tests/unicode/config.h b/tests/unicode/config.h
new file mode 100644
index 0000000000..16f95f7f8d
--- /dev/null
+++ b/tests/unicode/config.h
@@ -0,0 +1,8 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "test_common.h"
+
+#define UNICODE_SELECTED_MODES UNICODE_MODE_LINUX, UNICODE_MODE_MACOS
diff --git a/tests/unicode/test.mk b/tests/unicode/test.mk
new file mode 100644
index 0000000000..1afc79be55
--- /dev/null
+++ b/tests/unicode/test.mk
@@ -0,0 +1,5 @@
+# --------------------------------------------------------------------------------
+# Keep this file, even if it is empty, as a marker that this folder contains tests
+# --------------------------------------------------------------------------------
+
+UNICODE_COMMON = yes
diff --git a/tests/unicode/test_unicode.cpp b/tests/unicode/test_unicode.cpp
new file mode 100644
index 0000000000..a8500e3ba1
--- /dev/null
+++ b/tests/unicode/test_unicode.cpp
@@ -0,0 +1,86 @@
+// 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 Unicode : public TestFixture {};
+
+TEST_F(Unicode, sends_bmp_unicode_sequence) {
+ TestDriver driver;
+
+ set_unicode_input_mode(UNICODE_MODE_LINUX);
+
+ EXPECT_UNICODE(driver, 0x03A8); // Ψ
+ register_unicode(0x03A8);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(Unicode, sends_smp_unicode_sequence) {
+ TestDriver driver;
+
+ set_unicode_input_mode(UNICODE_MODE_LINUX);
+
+ EXPECT_UNICODE(driver, 0x1F9D9); // 🧙
+ register_unicode(0x1F9D9);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(Unicode, sends_surrogate_pair_for_macos) {
+ TestDriver driver;
+
+ set_unicode_input_mode(UNICODE_MODE_MACOS);
+
+ // EXPECT_UNICODE() assumes Linux input mode
+ {
+ testing::InSequence s;
+
+ // Alt+D83EDDD9 🧙
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_D, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_8, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_3, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_E, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_D, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_D, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_D, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_9, KC_LEFT_ALT));
+ EXPECT_REPORT(driver, (KC_LEFT_ALT));
+ EXPECT_EMPTY_REPORT(driver);
+ }
+
+ register_unicode(0x1F9D9);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(Unicode, sends_unicode_string) {
+ TestDriver driver;
+
+ set_unicode_input_mode(UNICODE_MODE_LINUX);
+
+ {
+ testing::InSequence s;
+
+ EXPECT_UNICODE(driver, 0xFF31);
+ EXPECT_UNICODE(driver, 0xFF2D);
+ EXPECT_UNICODE(driver, 0xFF2B);
+ EXPECT_UNICODE(driver, 0xFF01);
+ }
+ send_unicode_string("QMK!");
+
+ VERIFY_AND_CLEAR(driver);
+}
diff --git a/tests/unicode/unicode_basic/config.h b/tests/unicode/unicode_basic/config.h
new file mode 100644
index 0000000000..16f95f7f8d
--- /dev/null
+++ b/tests/unicode/unicode_basic/config.h
@@ -0,0 +1,8 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "test_common.h"
+
+#define UNICODE_SELECTED_MODES UNICODE_MODE_LINUX, UNICODE_MODE_MACOS
diff --git a/tests/unicode/unicode_basic/test.mk b/tests/unicode/unicode_basic/test.mk
new file mode 100644
index 0000000000..f53051dce6
--- /dev/null
+++ b/tests/unicode/unicode_basic/test.mk
@@ -0,0 +1,5 @@
+# --------------------------------------------------------------------------------
+# Keep this file, even if it is empty, as a marker that this folder contains tests
+# --------------------------------------------------------------------------------
+
+UNICODE_ENABLE = yes
diff --git a/tests/unicode/unicode_basic/test_unicode_basic.cpp b/tests/unicode/unicode_basic/test_unicode_basic.cpp
new file mode 100644
index 0000000000..598b57277f
--- /dev/null
+++ b/tests/unicode/unicode_basic/test_unicode_basic.cpp
@@ -0,0 +1,26 @@
+// 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 UnicodeBasic : public TestFixture {};
+
+TEST_F(UnicodeBasic, sends_unicode_sequence) {
+ TestDriver driver;
+
+ set_unicode_input_mode(UNICODE_MODE_LINUX);
+
+ auto key_uc = KeymapKey(0, 0, 0, UC(0x03A8)); // Ψ
+
+ set_keymap({key_uc});
+
+ EXPECT_UNICODE(driver, 0x03A8);
+ tap_key(key_uc);
+
+ VERIFY_AND_CLEAR(driver);
+}
diff --git a/tests/unicode/unicode_map/config.h b/tests/unicode/unicode_map/config.h
new file mode 100644
index 0000000000..0d86922f0d
--- /dev/null
+++ b/tests/unicode/unicode_map/config.h
@@ -0,0 +1,8 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "test_common.h"
+
+#define UNICODE_SELECTED_MODES UNICODE_MODE_LINUX
diff --git a/tests/unicode/unicode_map/test.mk b/tests/unicode/unicode_map/test.mk
new file mode 100644
index 0000000000..e6d0034799
--- /dev/null
+++ b/tests/unicode/unicode_map/test.mk
@@ -0,0 +1,5 @@
+# --------------------------------------------------------------------------------
+# Keep this file, even if it is empty, as a marker that this folder contains tests
+# --------------------------------------------------------------------------------
+
+UNICODEMAP_ENABLE = yes
diff --git a/tests/unicode/unicode_map/test_unicode_map.cpp b/tests/unicode/unicode_map/test_unicode_map.cpp
new file mode 100644
index 0000000000..cacd8f3c75
--- /dev/null
+++ b/tests/unicode/unicode_map/test_unicode_map.cpp
@@ -0,0 +1,54 @@
+// 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::_;
+
+const uint32_t PROGMEM unicode_map[] = {
+ 0x03A8, // Ψ
+ 0x2318 // ⌘
+};
+
+class UnicodeMap : public TestFixture {};
+
+TEST_F(UnicodeMap, sends_unicodemap_code_point_from_keycode) {
+ TestDriver driver;
+
+ auto key_um = KeymapKey(0, 0, 0, UM(0));
+
+ set_keymap({key_um});
+
+ EXPECT_UNICODE(driver, 0x03A8);
+ tap_key(key_um);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(UnicodeMap, sends_unicodemap_pair_from_keycode) {
+ TestDriver driver;
+
+ auto key_shift = KeymapKey(0, 0, 0, KC_LEFT_SHIFT);
+ auto key_up = KeymapKey(0, 1, 0, UP(0, 1));
+
+ set_keymap({key_shift, key_up});
+
+ EXPECT_UNICODE(driver, 0x03A8);
+ tap_key(key_up);
+
+ EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
+ key_shift.press();
+ run_one_scan_loop();
+
+ EXPECT_UNICODE(driver, 0x2318);
+ tap_key(key_up);
+
+ EXPECT_NO_REPORT(driver);
+ key_shift.release();
+ run_one_scan_loop();
+
+ VERIFY_AND_CLEAR(driver);
+}
diff --git a/tests/unicode/unicode_ucis/config.h b/tests/unicode/unicode_ucis/config.h
new file mode 100644
index 0000000000..0d86922f0d
--- /dev/null
+++ b/tests/unicode/unicode_ucis/config.h
@@ -0,0 +1,8 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "test_common.h"
+
+#define UNICODE_SELECTED_MODES UNICODE_MODE_LINUX
diff --git a/tests/unicode/unicode_ucis/test.mk b/tests/unicode/unicode_ucis/test.mk
new file mode 100644
index 0000000000..d7ac651758
--- /dev/null
+++ b/tests/unicode/unicode_ucis/test.mk
@@ -0,0 +1,5 @@
+# --------------------------------------------------------------------------------
+# Keep this file, even if it is empty, as a marker that this folder contains tests
+# --------------------------------------------------------------------------------
+
+UCIS_ENABLE = yes
diff --git a/tests/unicode/unicode_ucis/test_unicode_ucis.cpp b/tests/unicode/unicode_ucis/test_unicode_ucis.cpp
new file mode 100644
index 0000000000..acc6329f85
--- /dev/null
+++ b/tests/unicode/unicode_ucis/test_unicode_ucis.cpp
@@ -0,0 +1,221 @@
+// 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::_;
+
+// clang-format off
+const ucis_symbol_t ucis_symbol_table[] = UCIS_TABLE(
+ UCIS_SYM("qmk", 0x03A8) // Ψ
+);
+// clang-format on
+
+class UnicodeUCIS : public TestFixture {};
+
+TEST_F(UnicodeUCIS, matches_sequence) {
+ TestDriver driver;
+
+ auto key_q = KeymapKey(0, 0, 0, KC_Q);
+ auto key_m = KeymapKey(0, 1, 0, KC_M);
+ auto key_k = KeymapKey(0, 2, 0, KC_K);
+ auto key_enter = KeymapKey(0, 3, 0, KC_ENTER);
+
+ set_keymap({key_q, key_m, key_k, key_enter});
+
+ EXPECT_UNICODE(driver, 0x2328); // ⌨
+ ucis_start();
+
+ EXPECT_EQ(ucis_active(), true);
+ EXPECT_EQ(ucis_count(), 0);
+
+ EXPECT_REPORT(driver, (KC_Q));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_q);
+ EXPECT_EQ(ucis_count(), 1);
+
+ EXPECT_REPORT(driver, (KC_M));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_m);
+ EXPECT_EQ(ucis_count(), 2);
+
+ EXPECT_REPORT(driver, (KC_K));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_k);
+ EXPECT_EQ(ucis_count(), 3);
+
+ EXPECT_REPORT(driver, (KC_BACKSPACE)).Times(4);
+ EXPECT_EMPTY_REPORT(driver).Times(4);
+ EXPECT_UNICODE(driver, 0x03A8);
+ tap_key(key_enter);
+
+ EXPECT_EQ(ucis_active(), false);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(UnicodeUCIS, cancels_sequence) {
+ TestDriver driver;
+
+ auto key_q = KeymapKey(0, 0, 0, KC_Q);
+ auto key_m = KeymapKey(0, 1, 0, KC_M);
+ auto key_k = KeymapKey(0, 2, 0, KC_K);
+ auto key_escape = KeymapKey(0, 3, 0, KC_ESCAPE);
+
+ set_keymap({key_q, key_m, key_k, key_escape});
+
+ EXPECT_UNICODE(driver, 0x2328); // ⌨
+ ucis_start();
+
+ EXPECT_EQ(ucis_active(), true);
+ EXPECT_EQ(ucis_count(), 0);
+
+ EXPECT_REPORT(driver, (KC_Q));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_q);
+ EXPECT_EQ(ucis_count(), 1);
+
+ EXPECT_REPORT(driver, (KC_M));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_m);
+ EXPECT_EQ(ucis_count(), 2);
+
+ EXPECT_REPORT(driver, (KC_K));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_k);
+ EXPECT_EQ(ucis_count(), 3);
+
+ EXPECT_NO_REPORT(driver);
+ tap_key(key_escape);
+
+ EXPECT_EQ(ucis_active(), false);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(UnicodeUCIS, matches_sequence_with_corrected_typo) {
+ TestDriver driver;
+
+ auto key_q = KeymapKey(0, 0, 0, KC_Q);
+ auto key_m = KeymapKey(0, 1, 0, KC_M);
+ auto key_j = KeymapKey(0, 2, 0, KC_J);
+ auto key_k = KeymapKey(0, 3, 0, KC_K);
+ auto key_backspace = KeymapKey(0, 4, 0, KC_BACKSPACE);
+ auto key_enter = KeymapKey(0, 5, 0, KC_ENTER);
+
+ set_keymap({key_q, key_m, key_j, key_k, key_backspace, key_enter});
+
+ EXPECT_UNICODE(driver, 0x2328); // ⌨
+ ucis_start();
+
+ EXPECT_EQ(ucis_active(), true);
+ EXPECT_EQ(ucis_count(), 0);
+
+ EXPECT_REPORT(driver, (KC_Q));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_q);
+ EXPECT_EQ(ucis_count(), 1);
+
+ EXPECT_REPORT(driver, (KC_M));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_m);
+ EXPECT_EQ(ucis_count(), 2);
+
+ EXPECT_REPORT(driver, (KC_J));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_j);
+ EXPECT_EQ(ucis_count(), 3);
+
+ EXPECT_REPORT(driver, (KC_BACKSPACE));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_backspace);
+ EXPECT_EQ(ucis_count(), 2);
+
+ EXPECT_REPORT(driver, (KC_K));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_k);
+ EXPECT_EQ(ucis_count(), 3);
+
+ EXPECT_REPORT(driver, (KC_BACKSPACE)).Times(4);
+ EXPECT_EMPTY_REPORT(driver).Times(4);
+ EXPECT_UNICODE(driver, 0x03A8);
+ tap_key(key_enter);
+
+ EXPECT_EQ(ucis_active(), false);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(UnicodeUCIS, does_not_match_longer_sequence) {
+ TestDriver driver;
+
+ auto key_q = KeymapKey(0, 0, 0, KC_Q);
+ auto key_m = KeymapKey(0, 1, 0, KC_M);
+ auto key_k = KeymapKey(0, 2, 0, KC_K);
+ auto key_enter = KeymapKey(0, 3, 0, KC_ENTER);
+
+ set_keymap({key_q, key_m, key_k, key_enter});
+
+ EXPECT_UNICODE(driver, 0x2328); // ⌨
+ ucis_start();
+
+ EXPECT_EQ(ucis_active(), true);
+ EXPECT_EQ(ucis_count(), 0);
+
+ EXPECT_REPORT(driver, (KC_Q));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_q);
+ EXPECT_EQ(ucis_count(), 1);
+
+ EXPECT_REPORT(driver, (KC_M));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_m);
+ EXPECT_EQ(ucis_count(), 2);
+
+ EXPECT_REPORT(driver, (KC_K));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_k);
+ EXPECT_EQ(ucis_count(), 3);
+
+ EXPECT_REPORT(driver, (KC_K));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_k);
+ EXPECT_EQ(ucis_count(), 4);
+
+ EXPECT_NO_REPORT(driver);
+ tap_key(key_enter);
+
+ EXPECT_EQ(ucis_active(), false);
+
+ VERIFY_AND_CLEAR(driver);
+}
+
+TEST_F(UnicodeUCIS, does_not_match_shorter_sequence) {
+ TestDriver driver;
+
+ auto key_q = KeymapKey(0, 0, 0, KC_Q);
+ auto key_enter = KeymapKey(0, 1, 0, KC_ENTER);
+
+ set_keymap({key_q, key_enter});
+
+ EXPECT_UNICODE(driver, 0x2328); // ⌨
+ ucis_start();
+
+ EXPECT_EQ(ucis_active(), true);
+ EXPECT_EQ(ucis_count(), 0);
+
+ EXPECT_REPORT(driver, (KC_Q));
+ EXPECT_EMPTY_REPORT(driver);
+ tap_key(key_q);
+ EXPECT_EQ(ucis_count(), 1);
+
+ EXPECT_NO_REPORT(driver);
+ tap_key(key_enter);
+
+ EXPECT_EQ(ucis_active(), false);
+
+ VERIFY_AND_CLEAR(driver);
+}