[Keymap] Xulkal user changes (#6044)

* Xulkal user changes

Xulkal user changes

* Reduce code duplication

* Massive user code refactor

14 files changed, 295 insertions, 83 deletions

diff --git a/users/xulkal/custom_encoder.c b/users/xulkal/custom_encoder.c
new file mode 100644
index 000000000..09f1cda0d
--- /dev/null
+++ b/users/xulkal/custom_encoder.c
@@ -0,0 +1,13 @@
+#include "custom_encoder.h"
+
+#ifdef ENCODER_ENABLE
+const uint16_t PROGMEM encoders[][2] = {
+    { KC_PGUP, KC_PGDN },
+    { KC_DOWN, KC_UP }
+}
+
+void encoder_update_user(uint8_t index, bool clockwise)
+{
+    tap_code16(pgm_read_word(&encoders[index][clockwise]));
+}
+#endif
diff --git a/users/xulkal/custom_encoder.h b/users/xulkal/custom_encoder.h
new file mode 100644
index 000000000..010d4b138
--- /dev/null
+++ b/users/xulkal/custom_encoder.h
@@ -0,0 +1,2 @@
+#pragma once
+#include "quantum.h"
diff --git a/users/xulkal/custom_keycodes.h b/users/xulkal/custom_keycodes.h
new file mode 100644
index 000000000..d4ae0bd47
--- /dev/null
+++ b/users/xulkal/custom_keycodes.h
@@ -0,0 +1,28 @@
+#pragma once
+
+enum custom_keycodes {
+  RGBRST = SAFE_RANGE,
+#ifndef TAP_DANCE_ENABLE
+  TD_MIN,
+  TD_COMM = TD_MIN,
+  TD_BSPC,
+  TD_DEL,
+  TD_DOT,
+  TD_MAX,
+#endif
+  KEYMAP_SAFE_RANGE
+};
+
+#define RIS_ESC  LT(_RAISE, KC_ESC)
+#define RIS_CAPS LT(_RAISE, KC_CAPS)
+
+#define QWERTY DF(_QWERTY)
+
+#ifndef GAMELAYER_DISABLE
+#define GAME DF(_GAME)
+#else
+#define GAME KC_TRANSPARENT
+#endif
+
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
diff --git a/users/xulkal/custom_oled.c b/users/xulkal/custom_oled.c
new file mode 100644
index 000000000..77e580b95
--- /dev/null
+++ b/users/xulkal/custom_oled.c
@@ -0,0 +1,96 @@
+#include "custom_oled.h"
+#include "process_records.h"
+
+#include <stdio.h>
+
+#ifdef OLED_DRIVER_ENABLE
+
+static void render_logo(void)
+{
+    static const char PROGMEM sol_logo[] = {
+        0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
+        0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
+        0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,0};
+    oled_write_P(sol_logo, false);
+}
+
+static void render_status(void)
+{
+    // Render to mode icon
+    static const char PROGMEM mode_logo[2][3] = {
+        {0x97,0x98,0},
+        {0xb7,0xb8,0}
+    };
+
+    oled_write_P(mode_logo[0], false);
+
+#if defined(RGB_MATRIX_ENABLE)
+    static char buffer[20] = {0};
+    snprintf(buffer, sizeof(buffer), "    h%3d s%3d v%3d\n", rgb_matrix_config.hue, rgb_matrix_config.sat, rgb_matrix_config.val);
+    oled_write(buffer, false);
+#endif
+
+    oled_write_P(mode_logo[1], false);
+
+#if defined(RGB_MATRIX_ENABLE)
+    snprintf(buffer, sizeof(buffer), "         s%3d m%3d\n", rgb_matrix_config.speed, rgb_matrix_config.mode);
+    oled_write(buffer, false);
+#endif
+
+    // Define layers here, Have not worked out how to have text displayed for each layer. Copy down the number you see and add a case for it below
+    oled_write_P(PSTR("Layer: "), false);
+    switch (biton32(layer_state))
+    {
+        case _QWERTY:
+#ifndef GAMELAYER_DISABLE
+            switch (biton32(default_layer_state))
+            {
+                case _QWERTY:
+                    oled_write_P(PSTR("Default\n"), false);
+                    break;
+                case _GAME:
+                    oled_write_P(PSTR("Game\n"), false);
+                    break;
+                default:
+                    oled_write_P(PSTR("Undefined\n"), false);
+                    break;
+            }
+#else
+            oled_write_P(PSTR("Default\n"), false);
+#endif
+            break;
+        case _LOWER:
+            oled_write_P(PSTR("Lower\n"), false);
+            break;
+        case _RAISE:
+            oled_write_P(PSTR("Raise\n"), false);
+            break;
+#ifdef TRILAYER_ENABLED
+        case _ADJUST:
+            oled_write_P(PSTR("Adjust\n"), false);
+            break;
+#endif
+        default:
+            oled_write_P(PSTR("Undefined\n"), false);
+            break;
+  }
+
+  // Host Keyboard LED Status
+    uint8_t led_usb_state = host_keyboard_leds();
+    oled_write_P(led_usb_state & (1<<USB_LED_NUM_LOCK) ? PSTR("NUMLCK ") : PSTR("       "), false);
+    oled_write_P(led_usb_state & (1<<USB_LED_CAPS_LOCK) ? PSTR("CAPLCK ") : PSTR("       "), false);
+    oled_write_P(led_usb_state & (1<<USB_LED_SCROLL_LOCK) ? PSTR("SCRLCK ") : PSTR("       "), false);
+}
+
+void oled_task_user(void)
+{
+    if (is_keyboard_master())
+        render_status();
+    else
+    {
+        render_logo();
+        oled_scroll_left();
+    }
+}
+
+#endif
diff --git a/users/xulkal/custom_oled.h b/users/xulkal/custom_oled.h
new file mode 100644
index 000000000..010d4b138
--- /dev/null
+++ b/users/xulkal/custom_oled.h
@@ -0,0 +1,2 @@
+#pragma once
+#include "quantum.h"
diff --git a/users/xulkal/custom_tap_dance.c b/users/xulkal/custom_tap_dance.c
new file mode 100644
index 000000000..a1c644efd
--- /dev/null
+++ b/users/xulkal/custom_tap_dance.c
@@ -0,0 +1,61 @@
+#include "custom_tap_dance.h"
+#include "custom_keycodes.h"
+#include "timer_utils.h"
+
+#ifdef TAP_DANCE_ENABLE
+
+//Tap Dance Definitions
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [COMM_QUOT]  = ACTION_TAP_DANCE_DOUBLE(KC_COMM, KC_QUOT),
+  [BACKSPACE] = ACTION_TAP_DANCE_DOUBLE (KC_BSPACE, LCTL(KC_BSPACE)),
+  [DELETE] = ACTION_TAP_DANCE_DOUBLE (KC_DELETE, LCTL(KC_DELETE))
+};
+
+#else
+
+static uint16_t td_keycode;
+static uint16_t td_timer;
+
+const uint16_t PROGMEM td_keymaps[TD_MAX - TD_MIN][2] = {
+    [TD_COMM - TD_MIN]  = { KC_COMM, KC_QUOT },
+    [TD_BSPC - TD_MIN]  = { KC_BSPACE, LCTL(KC_BSPACE) },
+    [TD_DEL - TD_MIN]  = { KC_DELETE, LCTL(KC_DELETE) },
+    [TD_DOT - TD_MIN]  = { KC_DOT, KC_GRAVE }
+};
+
+void run_tap_dance_double(uint8_t i)
+{
+    tap_code16(pgm_read_word(&td_keymaps[td_keycode - TD_MIN][i]));
+    td_keycode = KC_TRANSPARENT;
+    td_timer = timer_read() + TAPPING_TERM;
+}
+
+bool process_tap_dance_double(uint16_t keycode, keyrecord_t *record)
+{
+    if (TD_MIN <= keycode && keycode < TD_MAX)
+    {
+        if (record->event.pressed)
+        {
+            if (td_keycode != keycode || timer_expired(td_timer))
+            {
+                td_keycode = keycode;
+                td_timer = timer_read() + TAPPING_TERM;
+            }
+            else
+                run_tap_dance_double(1);
+        }
+        return false;
+    }
+
+    if (td_keycode != KC_TRANSPARENT)
+        run_tap_dance_double(0);
+    return true;
+}
+
+void matrix_scan_user(void)
+{
+    if (td_keycode != KC_TRANSPARENT && timer_expired(td_timer))
+        run_tap_dance_double(0);
+}
+
+#endif
diff --git a/users/xulkal/custom_tap_dance.h b/users/xulkal/custom_tap_dance.h
new file mode 100644
index 000000000..33398808d
--- /dev/null
+++ b/users/xulkal/custom_tap_dance.h
@@ -0,0 +1,26 @@
+#pragma once
+#include "quantum.h"
+
+#ifdef TAP_DANCE_ENABLE
+
+#include "process_tap_dance.h"
+
+//Tap Dance Declarations
+enum {
+  COMM_QUOT = 0,
+  BACKSPACE,
+  DELETE,
+  DOT
+};
+
+#define TD_COMM TD(COMM_QUOT)
+#define TD_BSPC TD(BACKSPACE)
+#define TD_DEL TD(DELETE)
+#define TD_DOT TD(DOT)
+
+#else
+
+void run_tap_dance_double(uint8_t i);
+bool process_tap_dance_double(uint16_t keycode, keyrecord_t *record);
+
+#endif
diff --git a/users/xulkal/layouts.h b/users/xulkal/layouts.h
index 5180992a8..65dad8c63 100644
--- a/users/xulkal/layouts.h
+++ b/users/xulkal/layouts.h
@@ -15,7 +15,7 @@
   */
 
 #define _________________QWERTY_L1_________________ KC_GESC,  KC_1,     KC_2,     KC_3,     KC_4,     KC_5
-#define _________________QWERTY_L2_________________ TD_TAB,   KC_Q,     KC_W,     KC_E,     KC_R,     KC_T
+#define _________________QWERTY_L2_________________ KC_TAB,   KC_Q,     KC_W,     KC_E,     KC_R,     KC_T
 #define _________________QWERTY_L3_________________ RIS_CAPS, KC_A,     KC_S,     KC_D,     KC_F,     KC_G
 #define _________________QWERTY_L4_________________ KC_LSPO,  KC_Z,     KC_X,     KC_C,     KC_V,     KC_B
 #define _________________QWERTY_L5_________________ KC_LCPO,  KC_LGUI,  LOWER,    RAISE,    KC_LALT,  KC_SPC
@@ -23,7 +23,7 @@
 #define _________________QWERTY_R1_________________           KC_6,    KC_7,      KC_8,     KC_9,     KC_0,     TD_BSPC
 #define _________________QWERTY_R2_________________           KC_Y,    KC_U,      KC_I,     KC_O,     KC_P,     KC_BSLS
 #define _________________QWERTY_R3_________________           KC_H,    KC_J,      KC_K,     KC_L,     KC_SCLN,  KC_ENT
-#define _________________QWERTY_R4_________________           KC_N,    KC_M,      TD_COMM,  KC_DOT,   KC_SLASH, KC_RSPC
+#define _________________QWERTY_R4_________________           KC_N,    KC_M,      TD_COMM,  TD_DOT,   KC_SLASH, KC_RSPC
 #define _________________QWERTY_R5_________________           KC_SPC,  KC_LEFT,   KC_UP,    KC_DOWN,  KC_RIGHT, KC_RCPC
 
 
diff --git a/users/xulkal/process_records.c b/users/xulkal/process_records.c
index 5ba59965f..115623caa 100644
--- a/users/xulkal/process_records.c
+++ b/users/xulkal/process_records.c
@@ -1,56 +1,58 @@
 #include "process_records.h"
-
-#ifdef TAP_DANCE_ENABLE
-//Tap Dance Definitions
-qk_tap_dance_action_t tap_dance_actions[] = {
-  [COMM_QUOT]  = ACTION_TAP_DANCE_DOUBLE(KC_COMM, KC_QUOT),
-  [BACKSPACE] = ACTION_TAP_DANCE_DOUBLE (KC_BSPACE, LCTL(KC_BSPACE)),
-  [TAP_TAB] = ACTION_TAP_DANCE_DOUBLE (KC_TAB, LSFT(KC_TAB)),
-  [CTRL_MINUS] = ACTION_TAP_DANCE_DOUBLE (KC_LCTL, KC_MINS),
-  [CTRL_PLUS] = ACTION_TAP_DANCE_DOUBLE (KC_RCTL, KC_EQL)
-};
-#endif
+#include "custom_keycodes.h"
+#include "timer_utils.h"
 
 #if defined(RGB_MATRIX_ENABLE)
 extern void eeconfig_update_rgb_matrix_default(void);
 #endif
 
 #ifdef TRILAYER_ENABLED
-uint32_t layer_state_set_user(uint32_t state) {
-  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
+uint32_t layer_state_set_user(uint32_t state)
+{
+    return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }
 #endif
 
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  static uint16_t reset_timer;
-  switch (keycode) {
-    case RGBRST:
+bool process_record_user(uint16_t keycode, keyrecord_t *record)
+{
+    static uint16_t reset_timer;
+
+#ifndef TAP_DANCE_ENABLE
+    if (!process_tap_dance_double(keycode, record))
+        return false;
+#endif
+
+    switch (keycode)
+    {
+        case RGBRST:
+            {
 #if defined(RGBLIGHT_ENABLE)
-        if (record->event.pressed) {
-          eeconfig_update_rgblight_default();
-          rgblight_enable();
-        }
+                if (record->event.pressed)
+                {
+                    eeconfig_update_rgblight_default();
+                    rgblight_enable();
+                }
 #elif defined(RGB_MATRIX_ENABLE)
-        if (record->event.pressed) {
-          eeconfig_update_rgb_matrix_default();
-        }
+                if (record->event.pressed)
+                    eeconfig_update_rgb_matrix_default();
 #endif
-      return false;
-    case RESET:
-      if (record->event.pressed) {
-          reset_timer = timer_read();
-      } else {
-          if (timer_elapsed(reset_timer) >= 500) {
-              reset_keyboard();
-          }
-      }
-      return false;
+            }
+            return false;
+        case RESET:
+            {
+                if (record->event.pressed)
+                    reset_timer = timer_read() + 500;
+                else if (timer_expired(reset_timer))
+                    reset_keyboard();
+            }
+            return false;
   }
 
   return process_record_keymap(keycode, record);
 }
 
 __attribute__ ((weak))
-bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
-  return true;
+bool process_record_keymap(uint16_t keycode, keyrecord_t *record)
+{
+    return true;
 }
diff --git a/users/xulkal/process_records.h b/users/xulkal/process_records.h
index 8a195df5c..701ef7e74 100644
--- a/users/xulkal/process_records.h
+++ b/users/xulkal/process_records.h
@@ -1,44 +1,6 @@
 #pragma once
 #include "quantum.h"
-
-#define RIS_ESC  LT(_RAISE, KC_ESC)
-#define RIS_CAPS LT(_RAISE, KC_CAPS)
-
-#define QWERTY DF(_QWERTY)
-
-#ifndef GAMELAYER_DISABLE
-#define GAME DF(_GAME)
-#else
-#define GAME KC_TRANSPARENT
-#endif
-
-#define LOWER MO(_LOWER)
-#define RAISE MO(_RAISE)
-
-#ifdef TAP_DANCE_ENABLE
-#include "process_tap_dance.h"
-
-//Tap Dance Declarations
-enum {
-  COMM_QUOT = 0,
-  BACKSPACE,
-  TAP_TAB,
-  CTRL_MINUS,
-  CTRL_PLUS
-};
-
-#define TD_COMM TD(COMM_QUOT)
-#define TD_BSPC TD(BACKSPACE)
-#define TD_TAB TD(TAP_TAB)
-#define TD_LCTL TD(CTRL_MINUS)
-#define TD_RCTL TD(CTRL_PLUS)
-#else
-#define TD_COMM KC_COMM
-#define TD_BSPC KC_BSPACE
-#define TD_TAB KC_TAB
-#define TD_LCTL KC_LCTL
-#define TD_RCTL KC_RCTL
-#endif
+#include "custom_tap_dance.h"
 
 enum layer_number {
     _QWERTY = 0,
@@ -52,8 +14,4 @@ enum layer_number {
 #endif
 };
 
-enum custom_keycodes {
-  RGBRST = SAFE_RANGE
-};
-
 bool process_record_keymap(uint16_t keycode, keyrecord_t *record);
diff --git a/users/xulkal/rules.mk b/users/xulkal/rules.mk
index 6758f52f5..50dc75d61 100644
--- a/users/xulkal/rules.mk
+++ b/users/xulkal/rules.mk
@@ -1,10 +1,13 @@
 SRC += xulkal.c \
-       process_records.c
+    process_records.c \
+    custom_tap_dance.c \
+    custom_encoder.c \
+    custom_oled.c \
+    timer_utils.c
 
 # Some usual defaults
 MOUSEKEY_ENABLE         = no    # Mouse keys (+4700)
 EXTRAKEY_ENABLE         = yes   # Audio control and System control (+450)
-TAP_DANCE_ENABLE        = yes   # Enable the tap dance feature. (+1100)
 
 ifneq ($(strip $(DISABLE_LTO)), yes)
   EXTRAFLAGS += -flto
diff --git a/users/xulkal/timer_utils.c b/users/xulkal/timer_utils.c
new file mode 100644
index 000000000..5f5d9a1eb
--- /dev/null
+++ b/users/xulkal/timer_utils.c
@@ -0,0 +1,12 @@
+#include "timer_utils.h"
+
+bool timer_expired(uint16_t last)
+{
+    return timer_read() - last < 0x8000;
+}
+
+bool timer_expired32(uint32_t last)
+{
+    return timer_read32() - last < 0x80000000;
+}
+
diff --git a/users/xulkal/timer_utils.h b/users/xulkal/timer_utils.h
new file mode 100644
index 000000000..7e2a0b74d
--- /dev/null
+++ b/users/xulkal/timer_utils.h
@@ -0,0 +1,6 @@
+#pragma once
+#include "timer.h"
+#include <stdbool.h>
+
+bool timer_expired(uint16_t last);
+bool timer_expired32(uint32_t last);
diff --git a/users/xulkal/xulkal.h b/users/xulkal/xulkal.h
index ae7359923..9bc83b7de 100644
--- a/users/xulkal/xulkal.h
+++ b/users/xulkal/xulkal.h
@@ -2,3 +2,6 @@
 
 #include "process_records.h"
 #include "layouts.h"
+#include "timer_utils.h"
+#include "custom_keycodes.h"
+#include "custom_tap_dance.h"