[Keymap] Add jonavin user space / common functions (#13876)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Jonavin <=>

3 files changed, 29 insertions, 176 deletions

diff --git a/keyboards/gmmk/pro/keymaps/jonavin/keymap.c b/keyboards/gmmk/pro/keymaps/jonavin/keymap.c
index 8b3744957..edca78cd1 100644
--- a/keyboards/gmmk/pro/keymaps/jonavin/keymap.c
+++ b/keyboards/gmmk/pro/keymaps/jonavin/keymap.c
@@ -17,36 +17,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #include QMK_KEYBOARD_H
 #include "rgb_matrix_map.h"
-
-#define ARRAYSIZE(arr)  sizeof(arr)/sizeof(arr[0])
-
-enum custom_layers {
-    _BASE,
-    _FN1,
-    _MO2,
-    _MO3,
-};
-
-enum custom_keycodes {
-  KC_00 = SAFE_RANGE,
-  KC_WINLCK,    //Toggles Win key on and off
-  RGB_TOI,   // Timeout idle time up
-  RGB_TOD,   // Timeout idle time down
-};
-
-// Tap Dance Definitions
-enum custom_tapdance {
-  TD_LSFT_CAPSLOCK,
-};
-
-qk_tap_dance_action_t tap_dance_actions[] = {
-  // Tap once for shift, twice for Caps Lock
-  [TD_LSFT_CAPSLOCK] = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS),
-};
-
-#define KC_LSFTCAPS TD(TD_LSFT_CAPSLOCK)
-
-bool _isWinKeyDisabled = false;
+#include "jonavin.h"
 
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
@@ -63,8 +34,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         KC_ESC,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_INS,           KC_MUTE,
         KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,          KC_DEL,
         KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,          KC_PGUP,
-        TT(_MO2), KC_A,   KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,          KC_ENT,           KC_PGDN,
-        KC_LSFTCAPS,      KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT, KC_UP,   KC_END,
+        TT(_LOWER), KC_A, KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,          KC_ENT,           KC_PGDN,
+        KC_LSFTCAPSWIN,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT, KC_UP,   KC_END,
         KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, MO(_FN1),KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
     ),
 
@@ -77,7 +48,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         _______, KC_WINLCK, _______,                            _______,                          _______, _______, _______, RGB_SPD, RGB_RMOD, RGB_SPI
     ),
 
-    [_MO2] = LAYOUT(
+    [_LOWER] = LAYOUT(
         _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
         _______, _______, _______, _______, _______, _______, _______, KC_P7,   KC_P8,   KC_P9,   KC_P0,   KC_PMNS, KC_PPLS, _______,          _______,
         _______, KC_HOME, KC_UP,   KC_END,  KC_PGUP, _______, KC_TAB,  KC_P4,   KC_P5,   KC_P6,   KC_PDOT, _______, _______, _______,          KC_HOME,
@@ -86,7 +57,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         _______, _______, _______,                            KC_BSPC,                            _______, _______, _______, RCTL(KC_LEFT), RCTL(KC_PGDN), RCTL(KC_RIGHT)
     ),
 
-   [_MO3] = LAYOUT(
+   [_RAISE] = LAYOUT(
         _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
         _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
         _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
@@ -98,139 +69,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 };
 
 
-// TIMEOUTS
-#define TIMEOUT_THRESHOLD_DEFAULT   5    // default timeout minutes
-#define TIMEOUT_THRESHOLD_MAX       140  // upper limits (2 hours and 10 minutes -- no rgb indicators above this value)
-static uint16_t timeout_timer = 0;
-static uint16_t timeout_counter = 0;  //in minute intervals
-static uint16_t timeout_threshold = TIMEOUT_THRESHOLD_DEFAULT;
-
-void timeout_reset_timer(void) {
-    timeout_timer = timer_read();
-    timeout_counter = 0;
-};
-
-void timeout_update_threshold(bool increase) {
-    if (increase && timeout_threshold < TIMEOUT_THRESHOLD_MAX) timeout_threshold++;
-    if (!increase && timeout_threshold > 0) timeout_threshold--;
-};
-
-
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-    switch (keycode) {
-    case KC_00:
-        if (record->event.pressed) {
-            // when keycode KC_00 is pressed
-            SEND_STRING("00");
-        } else {
-            // when keycode KC_00 is released
-        }
-        break;
-    case KC_WINLCK:
-        if (record->event.pressed) {
-            _isWinKeyDisabled = !_isWinKeyDisabled; //toggle status
-            if(_isWinKeyDisabled) {
-                process_magic(GUI_OFF, record);
-            } else {
-                process_magic(GUI_ON, record);
-            }
-        } else  unregister_code16(keycode);
-        break;
-    case RGB_TOI:
-        if(record->event.pressed) {
-            timeout_update_threshold(true);
-        } else  unregister_code16(keycode);
-        break;
-    case RGB_TOD:
-        if(record->event.pressed) {
-             timeout_update_threshold(false);  //decrease timeout
-        } else  unregister_code16(keycode);
-        break;
-    default:
-        if (record->event.pressed) { //reset activity timer
-            #ifdef RGB_MATRIX_ENABLE
-                rgb_matrix_enable();
-            #endif
-            timeout_reset_timer();
-        }
-        break;
-    }
-    return true;
-};
-
-void matrix_scan_user(void) {
-    if (timeout_threshold > 0) {
-        if (timer_elapsed(timeout_timer) >= 60000) { // 1 minute tick
-            timeout_counter++;
-            timeout_timer = timer_read();
-        }
-        #ifdef RGB_MATRIX_ENABLE
-            if (timeout_threshold > 0 && timeout_counter >= timeout_threshold) {
-                rgb_matrix_disable_noeeprom();
-            }
-        #endif
-    } // timeout_threshold = 0 will disable timeout
-};
-
-
-#ifdef ENCODER_ENABLE       // Encoder Functionality
-    uint8_t selected_layer = 0;
-
-    bool encoder_update_user(uint8_t index, bool clockwise) {
-        if ( clockwise ) {
-            if (keyboard_report->mods & MOD_BIT(KC_LSFT) ) { // If you are holding L shift, encoder changes layers
-                if(selected_layer  < 3) {
-                    selected_layer ++;
-                    layer_move(selected_layer);
-                }
-            } else if (keyboard_report->mods & MOD_BIT(KC_RSFT) ) { // If you are holding R shift, Page up
-                unregister_mods(MOD_BIT(KC_LSFT));
-                register_code(KC_PGDN);
-                register_mods(MOD_BIT(KC_LSFT));
-            } else if (keyboard_report->mods & MOD_BIT(KC_LCTL)) {  // if holding Left Ctrl, navigate next word
-                    tap_code16(LCTL(KC_RGHT));
-            } else if (keyboard_report->mods & MOD_BIT(KC_LALT)) {  // if holding Left Alt, change media next track
-                tap_code(KC_MEDIA_NEXT_TRACK);
-            } else  {
-                switch (selected_layer) {
-                case _FN1:
-                    timeout_update_threshold(true);
-                    break;
-                default:
-                    tap_code(KC_VOLU);       // Otherwise it just changes volume
-                    break;
-                }
-            }
-        } else {
-            if (keyboard_report->mods & MOD_BIT(KC_LSFT) ) {
-                if (selected_layer  > 0) {
-                    selected_layer --;
-                    layer_move(selected_layer);
-                }
-            } else if (keyboard_report->mods & MOD_BIT(KC_RSFT) ) {
-                unregister_mods(MOD_BIT(KC_LSFT));
-                register_code(KC_PGUP);
-                register_mods(MOD_BIT(KC_LSFT));
-            } else if (keyboard_report->mods & MOD_BIT(KC_LCTL)) {  // if holding Left Ctrl, navigate previous word
-                tap_code16(LCTL(KC_LEFT));
-            } else if (keyboard_report->mods & MOD_BIT(KC_LALT)) {  // if holding Left Alt, change media previous track
-                tap_code(KC_MEDIA_PREV_TRACK);
-            } else {
-                switch (selected_layer) {
-                case _FN1:
-                    timeout_update_threshold(false);
-                    break;
-                default:
-                    tap_code(KC_VOLD);
-                    break;
-                }
-            }
-        }
-
-        return true;
-    }
-#endif
-
 #ifdef RGB_MATRIX_ENABLE
     // Capslock, Scroll lock and Numlock  indicator on Left side lights.
     void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
@@ -247,7 +85,7 @@ void matrix_scan_user(void) {
             rgb_matrix_set_color(LED_L6, RGB_RED);
             rgb_matrix_set_color(LED_L7, RGB_RED);
         }
-        if (_isWinKeyDisabled) {
+        if (keymap_config.no_gui) {
             rgb_matrix_set_color(LED_LWIN, RGB_RED);  //light up Win key when disabled
         }
         switch(get_highest_layer(layer_state)){  // special handling per layer
@@ -258,6 +96,7 @@ void matrix_scan_user(void) {
             rgb_matrix_set_color(LED_FN, RGB_RED); //FN key
 
             // Add RGB Timeout Indicator -- shows 0 to 139 using F row and num row;  larger numbers using 16bit code
+            uint16_t timeout_threshold = get_timeout_threshold();
             if (timeout_threshold <= 10) rgb_matrix_set_color(LED_LIST_FUNCROW[timeout_threshold], RGB_RED);
             else if (timeout_threshold < 140) {
                 rgb_matrix_set_color(LED_LIST_FUNCROW[(timeout_threshold / 10)], RGB_RED);
@@ -268,7 +107,7 @@ void matrix_scan_user(void) {
                 rgb_matrix_set_color(LED_LIST_NUMROW[12], RGB_RED);
             }
             break;
-        case _MO2:
+        case _LOWER:
             for (uint8_t i=0; i<ARRAYSIZE(LED_LIST_NUMPAD); i++) {
                 rgb_matrix_set_color(LED_LIST_NUMPAD[i], RGB_MAGENTA);
             }
@@ -276,7 +115,7 @@ void matrix_scan_user(void) {
             rgb_matrix_set_color(LED_R5, RGB_MAGENTA);
             rgb_matrix_set_color(LED_R6, RGB_MAGENTA);
             break;
-        case _MO3:
+        case _RAISE:
             rgb_matrix_set_color(LED_R6, RGB_GREEN);
             rgb_matrix_set_color(LED_R7, RGB_GREEN);
             rgb_matrix_set_color(LED_R8, RGB_GREEN);
@@ -296,12 +135,8 @@ void matrix_scan_user(void) {
 #endif
 
 
-void keyboard_post_init_user(void) {
-
-    if (IS_HOST_LED_ON(USB_LED_NUM_LOCK)) { // turn on Num lock by defautl so that the numpad layer always has predictable results
-        tap_code(KC_NUMLOCK);
-    }
-    timeout_timer = timer_read(); // set inital time for ide timeout
+void keyboard_post_init_keymap(void) {
+    // keyboard_post_init_user() moved to userspace
     #ifdef RGB_MATRIX_ENABLE
         rgb_matrix_set_color_all(RGB_NAUTILUS); // Default startup colour
     #endif
diff --git a/keyboards/gmmk/pro/keymaps/jonavin/readme.md b/keyboards/gmmk/pro/keymaps/jonavin/readme.md
index f4f3401ab..dceaa1307 100644
--- a/keyboards/gmmk/pro/keymaps/jonavin/readme.md
+++ b/keyboards/gmmk/pro/keymaps/jonavin/readme.md
@@ -29,6 +29,19 @@
     - Win Key light up red when Win Lock mode enabled
     - Layer 2 activation lights up Numpad area
 
+rules.mk OPTIONS - Active features from userspace
+STARTUP_NUMLOCK_ON = yes
+    - turns on NUMLOCK by default
+
+ENCODER_DEFAULTACTIONS_ENABLE = yes
+    - Enabled default encoder funtions
+  
+TD_LSFT_CAPSLOCK_ENABLE = yes
+    - This will enable double tap on Left Shift to toggle CAPSLOCK when using KC_LSFTCAPS
+
+IDLE_TIMEOUT_ENABLE = yes
+    - Enables Timer functionality; for RGB idle timeouts that can be changed dynamically
+
 ## All layers diagram
 Default layer
 ![image](https://user-images.githubusercontent.com/71780717/124177658-82324880-da7e-11eb-9421-b69100131062.png)
diff --git a/keyboards/gmmk/pro/keymaps/jonavin/rules.mk b/keyboards/gmmk/pro/keymaps/jonavin/rules.mk
index f4f3d4939..e17edf614 100644
--- a/keyboards/gmmk/pro/keymaps/jonavin/rules.mk
+++ b/keyboards/gmmk/pro/keymaps/jonavin/rules.mk
@@ -2,3 +2,8 @@ VIA_ENABLE = yes
 MOUSEKEY_ENABLE = no
 TAP_DANCE_ENABLE = yes
 BOOTMAGIC_ENABLE = lite
+
+TD_LSFT_CAPSLOCK_ENABLE = yes
+IDLE_TIMEOUT_ENABLE = yes
+STARTUP_NUMLOCK_ON = yes
+ENCODER_DEFAULTACTIONS_ENABLE = yes