summaryrefslogtreecommitdiff
path: root/users/muppetjones/features/casemodes.c
diff options
context:
space:
mode:
Diffstat (limited to 'users/muppetjones/features/casemodes.c')
-rw-r--r--users/muppetjones/features/casemodes.c247
1 files changed, 247 insertions, 0 deletions
diff --git a/users/muppetjones/features/casemodes.c b/users/muppetjones/features/casemodes.c
new file mode 100644
index 0000000000..da7c5e8fa9
--- /dev/null
+++ b/users/muppetjones/features/casemodes.c
@@ -0,0 +1,247 @@
+/* Copyright 2021 Andrew Rae ajrae.nv@gmail.com @andrewjrae
+ *
+ * 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 "casemodes.h"
+
+/* The caps word concept started with me @iaap on splitkb.com discord.
+ * However it has been implemented and extended by many splitkb.com users:
+ * - @theol0403 made many improvements to initial implementation
+ * - @precondition used caps lock rather than shifting
+ * - @dnaq his own implementation which also used caps lock
+ * - @sevanteri added underscores on spaces
+ * - @metheon extended on @sevanteri's work and added specific modes for
+ * snake_case and SCREAMING_SNAKE_CASE
+ * - @baffalop came up with the idea for xcase, which he implements in his own
+ * repo, however this is implemented by @iaap with support also for one-shot-shift.
+ * - @sevanteri
+ * - fixed xcase waiting mode to allow more modified keys and keys from other layers.
+ * - Added @baffalop's separator defaulting on first keypress, with a
+ * configurable default separator and overrideable function to determine
+ * if the default should be used.
+ */
+
+#ifndef DEFAULT_XCASE_SEPARATOR
+# define DEFAULT_XCASE_SEPARATOR KC_UNDS
+#endif
+
+#define IS_OSM(keycode) (keycode >= QK_ONE_SHOT_MOD && keycode <= QK_ONE_SHOT_MOD_MAX)
+
+// bool to keep track of the caps word state
+static bool caps_word_on = false;
+
+// enum to keep track of the xcase state
+static enum xcase_state xcase_state = XCASE_OFF;
+// the keycode of the xcase delimiter
+static uint16_t xcase_delimiter;
+// the number of keys to the last delimiter
+static int8_t distance_to_last_delim = -1;
+
+// Check whether caps word is on
+bool caps_word_enabled(void) { return caps_word_on; }
+
+// Enable caps word
+void enable_caps_word(void) {
+ caps_word_on = true;
+#ifndef CAPSWORD_USE_SHIFT
+ if (!host_keyboard_led_state().caps_lock) {
+ tap_code(KC_CAPS);
+ }
+#endif
+}
+
+// Disable caps word
+void disable_caps_word(void) {
+ caps_word_on = false;
+#ifndef CAPSWORD_USE_SHIFT
+ if (host_keyboard_led_state().caps_lock) {
+ tap_code(KC_CAPS);
+ }
+#else
+ unregister_mods(MOD_LSFT);
+#endif
+}
+
+// Toggle caps word
+void toggle_caps_word(void) {
+ if (caps_word_on) {
+ disable_caps_word();
+ } else {
+ enable_caps_word();
+ }
+}
+
+// Get xcase state
+enum xcase_state get_xcase_state(void) { return xcase_state; }
+
+// Enable xcase and pickup the next keystroke as the delimiter
+void enable_xcase(void) { xcase_state = XCASE_WAIT; }
+
+// Enable xcase with the specified delimiter
+void enable_xcase_with(uint16_t delimiter) {
+ xcase_state = XCASE_ON;
+ xcase_delimiter = delimiter;
+ distance_to_last_delim = -1;
+}
+
+// Disable xcase
+void disable_xcase(void) { xcase_state = XCASE_OFF; }
+
+// Place the current xcase delimiter
+static void place_delimiter(void) {
+ if (IS_OSM(xcase_delimiter)) {
+ // apparently set_oneshot_mods() is dumb and doesn't deal with handedness for you
+ uint8_t mods = xcase_delimiter & 0x10 ? (xcase_delimiter & 0x0F) << 4 : xcase_delimiter & 0xFF;
+ set_oneshot_mods(mods);
+ } else {
+ tap_code16(xcase_delimiter);
+ }
+}
+
+// Removes a delimiter, used for double tap space exit
+static void remove_delimiter(void) {
+ if (IS_OSM(xcase_delimiter)) {
+ clear_oneshot_mods();
+ } else {
+ tap_code(KC_BSPC);
+ }
+}
+
+// overrideable function to determine whether the case mode should stop
+__attribute__((weak)) bool terminate_case_modes(uint16_t keycode, const keyrecord_t *record) {
+ switch (keycode) {
+ // Keycodes to ignore (don't disable caps word)
+ case KC_A ... KC_Z:
+ case KC_1 ... KC_0:
+ case KC_MINS:
+ case KC_BSPC:
+ // If mod chording disable the mods
+ if (record->event.pressed && (get_mods() != 0)) {
+ return true;
+ }
+ break;
+ case KC_UNDS:
+ // Allow to be pressed with or without a modifier (prob w/ shift)
+ break;
+ default:
+ if (record->event.pressed) {
+ return true;
+ }
+ break;
+ }
+ return false;
+}
+
+/* overrideable function to determine whether to use the default separator on
+ * first keypress when waiting for the separator. */
+__attribute__((weak)) bool use_default_xcase_separator(uint16_t keycode, const keyrecord_t *record) {
+ // for example:
+ /* switch (keycode) { */
+ /* case KC_A ... KC_Z: */
+ /* case KC_1 ... KC_0: */
+ /* return true; */
+ /* } */
+ return false;
+}
+
+bool process_case_modes(uint16_t keycode, const keyrecord_t *record) {
+ if (caps_word_on || xcase_state) {
+ if ((QK_MOD_TAP <= keycode && keycode <= QK_MOD_TAP_MAX) || (QK_LAYER_TAP <= keycode && keycode <= QK_LAYER_TAP_MAX)) {
+ // Earlier return if this has not been considered tapped yet
+ if (record->tap.count == 0) return true;
+ keycode = keycode & 0xFF;
+ }
+
+ if (keycode >= QK_LAYER_TAP && keycode <= QK_ONE_SHOT_LAYER_MAX) {
+ // let special keys and normal modifiers go through
+ return true;
+ }
+
+ if (xcase_state == XCASE_WAIT) {
+ // grab the next input to be the delimiter
+ if (use_default_xcase_separator(keycode, record)) {
+ enable_xcase_with(DEFAULT_XCASE_SEPARATOR);
+ } else if (record->event.pressed) {
+ // factor in mods
+ if (get_mods() & MOD_MASK_SHIFT) {
+ keycode = LSFT(keycode);
+ } else if (get_mods() & MOD_BIT(KC_RALT)) {
+ keycode = RALT(keycode);
+ }
+ enable_xcase_with(keycode);
+ return false;
+ } else {
+ if (IS_OSM(keycode)) {
+ // this catches the OSM release if no other key was pressed
+ set_oneshot_mods(0);
+ enable_xcase_with(keycode);
+ return false;
+ }
+ // let other special keys go through
+ return true;
+ }
+ }
+
+ if (record->event.pressed) {
+ // handle xcase mode
+ if (xcase_state == XCASE_ON) {
+ // place the delimiter if space is tapped
+ if (keycode == KC_SPACE) {
+ if (distance_to_last_delim != 0) {
+ place_delimiter();
+ distance_to_last_delim = 0;
+ return false;
+ }
+ // remove the delimiter and disable modes
+ else {
+ remove_delimiter();
+ disable_xcase();
+ disable_caps_word();
+ return true;
+ }
+ }
+ // decrement distance to delimiter on back space
+ else if (keycode == KC_BSPC) {
+ --distance_to_last_delim;
+ }
+ // don't increment distance to last delim if negative
+ else if (distance_to_last_delim >= 0) {
+ // puts back a one shot delimiter if you we're back to the delimiter pos
+ if (distance_to_last_delim == 0 && (IS_OSM(xcase_delimiter))) {
+ place_delimiter();
+ }
+ ++distance_to_last_delim;
+ }
+
+ } // end XCASE_ON
+
+ // check if the case modes have been terminated
+ if (terminate_case_modes(keycode, record)) {
+ disable_caps_word();
+ disable_xcase();
+ }
+#ifdef CAPSWORD_USE_SHIFT
+ else if (keycode >= KC_A && keycode <= KC_Z) {
+ tap_code16(LSFT(keycode));
+ return false;
+ }
+#endif
+
+ } // end if event.pressed
+
+ return true;
+ }
+ return true;
+}