logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

test_autocorrect.cpp (7783B)

    

  1. // Copyright 2021 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  4. #include "keycode.h"
  5. #include "test_common.hpp"
  7. using ::testing::_;
  8. using ::testing::AnyNumber;
  9. using ::testing::InSequence;
  11. class AutoCorrect : public TestFixture {
  12.    public:
  13.     void SetUp() override {
  14.         autocorrect_enable();
  15.     }
  16.     // Convenience function to tap `key`.
  17.     void TapKey(KeymapKey key) {
  18.         key.press();
  19.         run_one_scan_loop();
  20.         key.release();
  21.         run_one_scan_loop();
  22.     }
  24.     // Taps in order each key in `keys`.
  25.     template <typename... Ts>
  26.     void TapKeys(Ts... keys) {
  27.         for (KeymapKey key : {keys...}) {
  28.             TapKey(key);
  29.         }
  30.     }
  31. };
  33. // Test that verifies enable/disable/toggling works
  34. TEST_F(AutoCorrect, OnOffToggle) {
  35.     TestDriver driver;
  37.     EXPECT_EQ(autocorrect_is_enabled(), true);
  39.     autocorrect_disable();
  40.     EXPECT_EQ(autocorrect_is_enabled(), false);
  41.     autocorrect_disable();
  42.     EXPECT_EQ(autocorrect_is_enabled(), false);
  44.     autocorrect_enable();
  45.     EXPECT_EQ(autocorrect_is_enabled(), true);
  46.     autocorrect_enable();
  47.     EXPECT_EQ(autocorrect_is_enabled(), true);
  49.     autocorrect_toggle();
  50.     EXPECT_EQ(autocorrect_is_enabled(), false);
  51.     autocorrect_toggle();
  52.     EXPECT_EQ(autocorrect_is_enabled(), true);
  54.     VERIFY_AND_CLEAR(driver);
  55. }
  57. // Test that typing "fales" autocorrects to "false"
  58. TEST_F(AutoCorrect, fales_to_false_autocorrection) {
  59.     TestDriver driver;
  60.     auto       key_f = KeymapKey(0, 0, 0, KC_F);
  61.     auto       key_a = KeymapKey(0, 1, 0, KC_A);
  62.     auto       key_l = KeymapKey(0, 2, 0, KC_L);
  63.     auto       key_e = KeymapKey(0, 3, 0, KC_E);
  64.     auto       key_s = KeymapKey(0, 4, 0, KC_S);
  66.     set_keymap({key_f, key_a, key_l, key_e, key_s});
  68.     // Allow any number of empty reports.
  69.     EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber());
  70.     { // Expect the following reports in this order.
  71.         InSequence s;
  72.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_F)));
  73.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A)));
  74.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_L)));
  75.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_E)));
  76.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_BACKSPACE)));
  77.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_S)));
  78.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_E)));
  79.     }
  81.     TapKeys(key_f, key_a, key_l, key_e, key_s);
  83.     VERIFY_AND_CLEAR(driver);
  84. }
  86. // Test that typing "fales" doesn't autocorrect if disabled
  87. TEST_F(AutoCorrect, fales_disabled_autocorrect) {
  88.     TestDriver driver;
  89.     auto       key_f = KeymapKey(0, 0, 0, KC_F);
  90.     auto       key_a = KeymapKey(0, 1, 0, KC_A);
  91.     auto       key_l = KeymapKey(0, 2, 0, KC_L);
  92.     auto       key_e = KeymapKey(0, 3, 0, KC_E);
  93.     auto       key_s = KeymapKey(0, 4, 0, KC_S);
  95.     set_keymap({key_f, key_a, key_l, key_e, key_s});
  97.     // Allow any number of empty reports.
  98.     EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber());
  99.     { // Expect the following reports in this order.
  100.         InSequence s;
  101.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_F)));
  102.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A)));
  103.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_L)));
  104.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_E)));
  105.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_S)));
  106.     }
  108.     autocorrect_disable();
  109.     TapKeys(key_f, key_a, key_l, key_e, key_s);
  110.     autocorrect_enable();
  112.     VERIFY_AND_CLEAR(driver);
  113. }
  115. // Test that typing "falsify" doesn't autocorrect if disabled
  116. TEST_F(AutoCorrect, falsify_should_not_autocorrect) {
  117.     TestDriver driver;
  118.     auto       key_f = KeymapKey(0, 0, 0, KC_F);
  119.     auto       key_a = KeymapKey(0, 1, 0, KC_A);
  120.     auto       key_l = KeymapKey(0, 2, 0, KC_L);
  121.     auto       key_s = KeymapKey(0, 3, 0, KC_S);
  122.     auto       key_i = KeymapKey(0, 4, 0, KC_I);
  123.     auto       key_y = KeymapKey(0, 5, 0, KC_Y);
  125.     set_keymap({key_f, key_a, key_l, key_s, key_i, key_y});
  127.     // Allow any number of empty reports.
  128.     EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber());
  129.     { // Expect the following reports in this order.
  130.         InSequence s;
  131.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_F)));
  132.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A)));
  133.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_L)));
  134.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_S)));
  135.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_I)));
  136.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_F)));
  137.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_Y)));
  138.     }
  140.     TapKeys(key_f, key_a, key_l, key_s, key_i, key_f, key_y);
  142.     VERIFY_AND_CLEAR(driver);
  143. }
  145. // Test that  typing "ture" autocorrect to "true"
  146. TEST_F(AutoCorrect, ture_to_true_autocorrect) {
  147.     TestDriver driver;
  148.     auto       key_t_code = KeymapKey(0, 0, 0, KC_T);
  149.     auto       key_r      = KeymapKey(0, 1, 0, KC_R);
  150.     auto       key_u      = KeymapKey(0, 2, 0, KC_U);
  151.     auto       key_e      = KeymapKey(0, 3, 0, KC_E);
  152.     auto       key_space  = KeymapKey(0, 4, 0, KC_SPACE);
  154.     set_keymap({key_t_code, key_r, key_u, key_e, key_space});
  156.     // Allow any number of empty reports.
  157.     EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber());
  158.     { // Expect the following reports in this order.
  159.         InSequence s;
  160.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_SPACE)));
  161.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_T)));
  162.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_U)));
  163.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_R)));
  164.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_BACKSPACE))).Times(2);
  165.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_R)));
  166.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_U)));
  167.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_E)));
  168.     }
  170.     TapKeys(key_space, key_t_code, key_u, key_r, key_e);
  172.     VERIFY_AND_CLEAR(driver);
  173. }
  175. // Test that  typing "overture" does not autocorrect
  176. TEST_F(AutoCorrect, overture_should_not_autocorrect) {
  177.     TestDriver driver;
  178.     auto       key_t_code = KeymapKey(0, 0, 0, KC_T);
  179.     auto       key_r      = KeymapKey(0, 1, 0, KC_R);
  180.     auto       key_u      = KeymapKey(0, 2, 0, KC_U);
  181.     auto       key_e      = KeymapKey(0, 3, 0, KC_E);
  182.     auto       key_o      = KeymapKey(0, 4, 0, KC_O);
  183.     auto       key_v      = KeymapKey(0, 5, 0, KC_V);
  185.     set_keymap({key_t_code, key_r, key_u, key_e, key_o, key_v});
  187.     // Allow any number of empty reports.
  188.     EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber());
  189.     { // Expect the following reports in this order.
  190.         InSequence s;
  191.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_O)));
  192.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_V)));
  193.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_E)));
  194.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_R)));
  195.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_T)));
  196.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_U)));
  197.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_R)));
  198.         EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_E)));
  199.     }
  201.     TapKeys(key_o, key_v, key_e, key_r, key_t_code, key_u, key_r, key_e);
  203.     VERIFY_AND_CLEAR(driver);
  204. }