[MERGE][Core] Pointing Device Modes (21426)

quantum/process_keycode/process_pointing_mode_records.c

@@ -0,0 +1,108 @@
+/* Copyright 2023 Alabastard (@Alabastard-64)
+ *
+ * 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/>.
+ */
+
+#ifdef POINTING_DEVICE_MODES_ENABLE
+
+#    include "process_pointing_mode_records.h"
+
+/**
+ * @brief Handle pointing mode change keypress: Momentary
+ *
+ * Will set pointing mode id when key is pressed and reset on release
+ *
+ * NOTE: if pointing mode has changed since key down, reset is skipped
+ *
+ * @params mode_id[in] uint8_t
+ * @params pressed[in] bool
+ */
+void pointing_mode_key_momentary(uint8_t mode_id, bool pressed) {
+    if (pressed) {
+        set_pointing_mode_id(mode_id);
+    } else if (get_pointing_mode_id() == mode_id) {
+        // reset mode only if the current mode matches (in case mode has changed before release)
+        pointing_mode_reset();
+    }
+}
+
+/**
+ * @brief Handle pointing mode change keypress: Toggle
+ *
+ * Toggle pointing mode on key release
+ *
+ * @params mode_id[in] uint8_t
+ * @params pressed[in] bool
+ */
+void pointing_mode_key_toggle(uint8_t mode_id, bool pressed) {
+    // only attempt to change mode on key release event (matches layer toggle behaviour)
+    if (!pressed) toggle_pointing_mode_id(mode_id);
+}
+
+/**
+ * @brief Handle keypress to change current device
+ *
+ * Set current device to device on key release
+ *
+ * @params device[in]  uint8_t
+ * @params pressed[in] bool
+ */
+void pointing_mode_key_set_device(uint8_t device, bool pressed) {
+    if (!pressed) set_pointing_mode_device(device);
+}
+
+/**
+ * @brief Core function to process pointing mode key records
+ *
+ * Only handles built in keyrecords and functions
+ *
+ * @params keycode[in] uint16_t
+ * @params record[in] keyrecord_t pointer
+ *
+ * @return should keycode processing continue bool
+ */
+bool process_pointing_mode_records(uint16_t keycode, keyrecord_t* record) {
+    switch (keycode) {
+        // handle built in keycods for bottom 16 pointing modes (0-15)
+        // momentary
+        case QK_POINTING_MODE_MO ... QK_POINTING_MODE_MO_MAX:
+            pointing_mode_key_momentary((keycode - QK_POINTING_MODE_MO) & (QK_POINTING_MODE_MO_MAX - QK_POINTING_MODE_MO), record->event.pressed);
+            return true; // allow further processing
+        // toggle
+        case QK_POINTING_MODE_TG ... QK_POINTING_MODE_TG_MAX:
+            pointing_mode_key_toggle((keycode - QK_POINTING_MODE_TG) & (QK_POINTING_MODE_TG_MAX - QK_POINTING_MODE_TG), record->event.pressed);
+            return true; // allow further processing
+
+#    if (POINTING_MODES_NUM_DEVICES > 1)
+        // utils: Cycle devices
+        case QK_PM_CYCLE_DEVICES:
+            pointing_mode_key_set_device(get_pointing_mode_device() + 1, record->event.pressed);
+            return true;
+        // utils: DEVICE RIGHT
+        case QK_PM_DEVICE_RIGHT:
+            pointing_mode_key_set_device(PM_RIGHT_DEVICE, record->event.pressed);
+            return true;
+        // utils: DEVICE LEFT
+        case QK_PM_DEVICE_LEFT:
+            pointing_mode_key_set_device(PM_RIGHT_DEVICE, record->event.pressed);
+            return true;
+#    endif
+
+        // end
+        default:
+            return true;
+    }
+}
+
+#endif // POINTING_DEVICE_MODES_ENABLE

quantum/process_keycode/process_pointing_mode_records.h

@@ -0,0 +1,28 @@
+/* Copyright 2023 Alabastard (@Alabastard-64)
+ *
+ * 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 "quantum.h"
+#include "pointing_device_modes.h"
+
+/* ----------Handling pointing mode id changes on keypress-------------------------------------------------------- */
+void pointing_mode_key_momentary(uint8_t mode_id, bool pressed); // momentary change of pointing mode while button is held
+void pointing_mode_key_toggle(uint8_t mode_id, bool pressed);    // toggle pointing mode on/off on keypress
+void pointing_mode_key_set_device(uint8_t device, bool pressed); // set current device
+
+/* ----------For builtin keycodes--------------------------------------------------------------------------------- */
+bool process_pointing_mode_records(uint16_t keyrecord, keyrecord_t* record); // handle processing of built in keyrecords (in process_record stack)