Keymap: Bocaj Layout and Userspace Refactor (#4753)

* Bocaj Layout Revamp * Pull in Upstream (#1) * Various tweaks for some Input:Club build processes * change KEYMAP to LAYOUT for all new keyboards made using this script * Add support for rev3 of the Atom47 (#2672) * Added support for rev3 of the Atom47 * Updated Atom47 readme's * Fix redefine error on rev2 and add maartenwut's keymap * Fix redefine error on LEdiodes keymap * Add Nyquist keymap (#2692) * nyquist * danielhklein nyquist setup * shift left controls * remove readme * cleanup before pr * ready for pr * Adds Phantom TKL support (#2696) * Add an info.json to phantom keyboard * Add layouts - KEYMAP_WINKEYLESS - KEYMAP_7BIT - KEYMAP_ISO - KEYMAP_ISO_WINKEYLESS * Add key_counts * Add 2 missing F-Row keys * Add TKC1800 info.json Created an info.json for the tkc1800. * Clueboard 60 info.json - adds - LAYOUT_60_ansi - LAYOUT_60_iso - KEYMAP_AEK - KEYMAP - LAYOUT_60_ansi_split_bs_rshift * Add the Speedo keyboard * Fix KC60 info.json file (#2707) * change KEYMAP to LAYOUT in all the KC60 files * Redo the info.json file * Small fixes to TKC1800 - adjust F-row to use 0.25 spacing - split left shift - add key_count * Fix some Configurator Warnings regarding LAYOUT vs KEYMAP (#2708) * change diverge 3 KC_KEYMAP to LAYOUT * Change KEYMAP to LAYOUT for handwired arrow pad * change M10A to LAYOUT for m10-a * Change KC_KEYMAP to LAYOUT_kc and KEYMAP to LAYOUT for mf68 * change KC_KEYMAP to LAYOUT for nano * Refactor to LAYOUT * refactor to LAYOUT-ansi and LAYOUT_iso for s65 * LAYOUT conversions for lfkkeyboards * missed a few renames * mini1800 for lfkeyobards support of LAYOUT * Improve state/chord handling and clean up namespace Some values that can never, ever, change were held in local variables, rather than in PROGMEM. Fixed. Change "pressed" to a signed int so the test for < 0 makes sense, and to avoid possible weird failure modes in the case where a key release comes in when pressed is already zero. (Shouldn't happen, sure, but computers are weird.) A lot of things in process_steno had external linkage for no particular reason. They've been marked static. Stuff still builds. Distinguish between currently-held keys and keys that have been held, and expose these values through a nicely-named API so other code could, say, check on the current set of steno chording in order to make displays. Also in passing fix up the "state" value having external linkage so it could clash with other people's variable declarations. The API also provides hooks for key processing and steno chord events, so you can monitor those events without having to run in matrix_scan_user and recheck the values directly. Also document these. There is no path through processing a key that doesn't end with a return false, so the nested return foo() are gone and we just return false. * Pull information from config.h and rules.mk (#2711) * Pull information from config.h and rules.mk * Readd the kbd75 maintainer * Remove obsolete info.json entries (#2712) * Clean up some long-standing errors when populating the API (#2715) * More Configurator Warning Fixes (#2716) * mf68_ble did not have the correct .c and .h files * Fix JC65 KEYMAP to LAYOUT * Change KEYMAP to LAYOUT for s60_x * Convert KEYMAP to LAYOUT for lets_split boards * Convert KEYMAP to LAYOUT * more fixes to keymap for iris * convert KEYMAP to LAYOUT for levinson keyboard * change losinggeneration's KEYMAP to LAYOUT * convert KEYMAP to LAYOUT * convert KEYMAP to LAYOUT for nyquist * convert KEYMAP to LAYOUT * convert KEYMAP to LAYOUT for viterbi * convert KEYMAP to LAYOUT * convert KEYMAP and its subsidiries to the LAYOUT standard * convert KEYMAP and its subsidiries to the new LAYOUT standard * Normacos keymap for let's split keyboard (#2691) * Cheers let's split keymap * fixed typo on norman layer of cheers keymap for let's split * fixed right handed mappings for home row * cheers keymap for let's split redefinition * updated Cheers keymap for let's split * cheers keymap for let's split updated with some terminal macros * renamed cheers let's split keymap to a more appropriate normacos * updated normacos keymap doc / removed non functional keys * reset let's split rules to default values * added more spotlight search macros * normalized keymap comments * Moved numpad on lower layer * hhkb jp personal keymap (#2698) * Add JJ40 Cockpit personal keymap (#2713) * Add JJ40 Cockpit keymap * Fix lower layer symbols * Add readme for "major" keyboards to eliminate more QMK Configurator errors (#2718) * add readme to ktype keyboard * add readme to m10a * add readme to mini1800 * add readme to parent directory * Revert "Pull in Upstream (#1)" This reverts commit eeba0ce. * Updates to Bocaj Files - Gave up on Tap Dance for ' -> ' + Added another 'Secret' + Add ' -> ' to the Swap Hands key + Add Swap Hands to the ' -> ' key + Made Hand Swapping a momentary toggle - Removed Auto Shift + Added Layer Toggle to KC_QUOTE for the _TOOLS layer - Disabled Tap Dance * Merge remote-tracking branch 'upstream/master' * Updates to Bocaj Added Game Layers, Removed Unused Macros * Removed 'secrets.h' * Updates to Bocaj Remove 'secrets'. Remove 'sendstring_workman.h' and set related layer back to qwerty due to macro compatibility issues * Total revisioning of keymap and layout structure * Missed readme.md file * Bocaj - Permissive Hold setting enabled * Switching from ErgoDox EZ centric configuration to the layout/user approach * Bocaj - Create Userspace and Ergodox layout * Update settings.json * Pushing local updates * Reverting .vscode/settings.json * Adds pretty_osx and _win wrappers * Utilize Windows and Mac Wrappers * Update layouts/community/ergodox/bocaj/keymap.c * Updates to Bocaj keymap.c - Extended pretty_osx and pretty_win wrappers to allow modification of the bottom rows and thumb clusters. - Fixed already wrapped layouts to align with the change - Wrapped _NUMS and _CLICKY layers with the _osx wrapper because I main with a Mac * Updates to Bocaj Small documentation updates, added KC_MAKE from Drashna's layout, added KC_LOCK back to the diablo layer. * Add LShift to _Adjust layer * Minor changes to bocaj Put wrappers in userspace and added RESET keycode to the Adjust layer * Updates to Bocaj config & keymap; Fixed problem with process_leader.c - Made lots of changes to the bocaj layout and userspace - Pulled in latest upstream/master - Attempted to compile with latest and found an unneccessary `break` in process_leader.c * Bocaj - Updates to Layout and Userspace * Adjust LEADER_TIMEOUT to 350 * Put KC_GRAVE on _ADJUST layer * Eliminate _LOWER layer and associated definitions * Adjusted layer indicating LEDs to match changes * Fixed Diablo leader sequence * Added build info leader sequence * Got rid of obsoleted IGNORE_MOD_TAP_INTERRUPT/PERMISSIVE_HOLD/PREVENT_STUCK_MODIFIERS (may add STRICT_LAYER_RELEASE in the future) * Remove type_traits Not sure what in my VSCode config always brings this one in * refactor stage 1 * Bocaj Refactor Phase II * Made LED_2 brighter if both CTRL & GUI are being held * Enabled unicode because I got it to work in Mac OS * Finalized Build Info leader combination after testing in Mac OS * Not sure why KC_D3_1 was set to ASDF if !TAP_DANCE_ENABLE. So I changed that back * Experienced issues with `EXTRAFLAGS += -flto` using Docker in MacOS. Not sure what it does, but I don't seem to be missing anything * Wrote obligatory readme.md files and mentioned Drashna too many times... I don't think I can actually take credit for much of anything here. * Updates to Bocaj Made LED changes, added LM_DFLT which is similar to the grave macro, enabled retro tapping, working on a unicode idea -- currently fails to build. * Bocaj Refactor Phase 3 Part 2 - Continuation of implementing unicode switching based on default layer - Slight adjustments to _DIABLO and base wrapper because LM_DFLT macro didn't function as I'd hoped * Slight adjustment to KC_MAKE
qmk · Jan 2, 2019 · a7b1b14 · a7b1b14
1 parent 7b5fa4b
commit a7b1b14
Show file tree

Hide file tree

Showing 16 changed files with 896 additions and 405 deletions.
diff --git a/layouts/community/ergodox/bocaj/config.h b/layouts/community/ergodox/bocaj/config.h
@@ -2,5 +2,5 @@
 
 #include QMK_KEYBOARD_CONFIG_H
 
-#undef PRODUCT
-#define PRODUCT   BocajEZ - Frankensteined ErgoDox EZ
+#define LEADER_TIMEOUT 250
+#define LEADER_PER_KEY_TIMING
diff --git a/layouts/community/ergodox/bocaj/keymap.c b/layouts/community/ergodox/bocaj/keymap.c
diff --git a/layouts/community/ergodox/bocaj/readme.md b/layouts/community/ergodox/bocaj/readme.md
@@ -0,0 +1,37 @@
+# Bocaj Layout
+
+While I've put my own spin on most things, much of the credit for these ideas belongs to Drashna and/or the people he derived things from. Please see his [layout](../drashna/) and [userspace](../../../../users/drashna/) for lots of ideas and inspiration.
+
+## Layers Overview
+
+* Default
+  * Workman
+  * Qwerty
+  * Windows Workman (swaps GUI and CTRL buttons)
+* Lower
+  * F1-12 Top Row
+  * Grave / Layer Switch macro at Caps Lock position
+  * Navigation at QWERTY 'ESDF' position
+  * Numpad under right hand
+* Adjust
+  * Volume Control
+  * Mac Lock Macro
+  * Make / Reset/ EEPROM keys
+  * Default Layer changing keys
+  * Diablo Layer
+    * Moved shortcuts within left hands reach
+    * Macros to spam 1-4 every ~1 second
+    * Shift in thumb cluster to prevent pinky fatique
+
+## LEDs Overview
+
+* Used for _LOWER, _ADJUST, and _DIABLO layer indication
+* Used for Ctrl/GUI, Shift, and Alt indication when on a default layer
+
+## Wrappers Overview
+
+While it isn't a novel idea, I feel the need to mention it because it really appeals to me as a person that doesn't like repetitive code.
+
+We've all come to know and love the pretty wrapper for Ergodox because it makes for such a beautiful, self-documenting keymap. In this keymap, we are building ontop of the pretty wrapper to wrap our default layers with our keys that aren't unique to the layer.
+
+Now you can wrap your keymap with `LAYOUT_ergodox_pretty_base_wrapper()` and only feed it the alpha keys, having the top, side, bottom, and thumb clusters automatically filled in. If you make a key to any of the top, side, bottom, or thumb cluster keys, it will propegate to all layers that have this wrapper, or have KC_TRNS keycodes in the same location
diff --git a/layouts/community/ergodox/bocaj/rules.mk b/layouts/community/ergodox/bocaj/rules.mk
@@ -4,3 +4,8 @@ SWAP_HANDS_ENABLE = no
 TAP_DANCE_ENABLE = yes
 EXTRAKEY_ENABLE = no
 KEY_LOCK_ENABLE = yes
+LEADER_ENABLE = yes
+
+UNICODE_ENABLE    = yes
+UNICODEMAP_ENABLE = no
+UCIS_ENABLE = no
diff --git a/users/bocaj/bocaj.c b/users/bocaj/bocaj.c
@@ -1,14 +1,30 @@
+/*
+Copyright 2018 Jacob Jerrell <[email protected]> @JacobJerrell
+
+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 "bocaj.h"
-#include "eeprom.h"
-#include "version.h"
-#include "tap_dances.h"
 
-static uint16_t copy_paste_timer;
 userspace_config_t userspace_config;
+#if (defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE))
+  #define BOCAJ_UNICODE_MODE UC_OSX
+#else
+  // set to 2 for UC_WIN, set to 4 for UC_WINC
+  #define BOCAJ_UNICODE_MODE 2
+#endif
 
-/* *** *** *** ***  *
- * Helper Functions *
- * *** *** *** ***  */
 void tap(uint16_t keycode){ register_code(keycode); unregister_code(keycode); };
 
 // Add reconfigurable functions here, for keymap customization
@@ -36,10 +52,7 @@ bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
 }
 
 __attribute__ ((weak))
-bool process_record_secrets(uint16_t keycode, keyrecord_t *record) {
-  return true;
-}
-
+void matrix_scan_secrets(void) {}
 
 __attribute__ ((weak))
 uint32_t layer_state_set_keymap (uint32_t state) {
@@ -57,7 +70,14 @@ void led_set_keymap(uint8_t usb_led) {}
 // Call user matrix init, set default RGB colors and then
 // call the keymap's init function
 void matrix_init_user(void) {
-  userspace_config.raw = eeprom_read_byte(EECONFIG_USERSPACE);
+  userspace_config.raw = eeconfig_read_user();
+
+  #if (defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE))
+    set_unicode_input_mode(BOCAJ_UNICODE_MODE);
+    get_unicode_input_mode();
+  #endif //UNICODE_ENABLE
+
+
   matrix_init_keymap();
 }
 
@@ -78,6 +98,18 @@ void suspend_wakeup_init_user(void)
   #endif
 }
 
+void eeconfig_init_user(void) {
+  userspace_config.raw = 0;
+  eeconfig_update_user(userspace_config.raw);
+  #if (defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE))
+    set_unicode_input_mode(BOCAJ_UNICODE_MODE);
+    get_unicode_input_mode();
+  #else
+    eeprom_update_byte(EECONFIG_UNICODEMODE, BOCAJ_UNICODE_MODE);
+  #endif
+}
+
+LEADER_EXTERNS();
 // No global matrix scan code, so just run keymap's matrix
 // scan function
 void matrix_scan_user(void) {
@@ -86,92 +118,72 @@ void matrix_scan_user(void) {
     has_ran_yet = true;
     startup_user();
   }
+  LEADER_DICTIONARY() {
+    leading = false;
+    leader_end();
+
+    // Mac Save (Leader -> s)
+    SEQ_ONE_KEY(KC_S) {
+      SEND_STRING(SS_LGUI("s"));
+    }
+
+    // Mac copy line down (Leader -> d, d)
+    SEQ_TWO_KEYS(KC_D, KC_D) {
+      register_code(KC_LSHIFT);
+      register_code(KC_HOME);
+      unregister_code(KC_HOME);
+      unregister_code(KC_LSHIFT);
+      SEND_STRING(SS_LGUI("c"));
+      tap(KC_END);
+      tap(KC_ENTER);
+      SEND_STRING(SS_LGUI("v"));
+    }
+
+    // Mac copy line up (Leader -> u, u)
+    SEQ_TWO_KEYS(KC_U, KC_U) {
+      register_code(KC_LSHIFT);
+      register_code(KC_HOME);
+      unregister_code(KC_HOME);
+      unregister_code(KC_LSHIFT);
+      SEND_STRING(SS_LGUI("c"));
+      tap(KC_UP);
+      tap(KC_END);
+      tap(KC_ENTER);
+      SEND_STRING(SS_LGUI("v"));
+    }
+
+    // Mac VS Debug
+    SEQ_ONE_KEY(KC_D) {
+      tap(KC_F5);
+    }
+
+    // Mac VS Stop Debug
+    SEQ_TWO_KEYS(KC_S, KC_D) {
+      register_code(KC_LSHIFT);
+      tap(KC_F5);
+      unregister_code(KC_LSHIFT);
+    }
+
+    // Start Diablo 3
+    SEQ_ONE_KEY(KC_3) {
+      SEND_STRING(SS_LCTRL(" "));
+      SEND_STRING("Diablo");
+      tap(KC_ENTER);
+    }
+
+    SEQ_ONE_KEY(KC_B) {
+      SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION " ");
+      tap(KC_ENTER);
+      SEND_STRING ("Built at: " QMK_BUILDDATE);
+    }
+#ifndef NO_SECRETS
+    matrix_scan_secrets();
+#endif // !NO_SECRETS
+  }
 
 #ifdef TAP_DANCE_ENABLE  // Run Diablo 3 macro checking code.
   run_diablo_macro_check();
 #endif // TAP_DANCE_ENABLE
 
   matrix_scan_keymap();
 }
-
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  /* uint8_t default_layer = 0;
-  default_layer = eeconfig_read_default_layer(); */
-  switch (keycode) {
-    case JJ_COPY:
-      if (!record->event.pressed) {
-        SEND_STRING(SS_LGUI("c"));
-      }
-      return false;
-      break;
-    case JJ_PSTE:
-      if (!record->event.pressed) {
-        SEND_STRING(SS_LGUI("v"));
-      }
-      return false;
-      break;
-    case JJ_ARRW:
-      if (!record->event.pressed) {
-        SEND_STRING("->");
-      }
-      return false;
-      break; /*
-    case KC_SWRK:
-      if (!record->event.pressed) {
-        set_single_persistent_default_layer(_SWRKMN);
-        layer_move(default_layer);
-        //ergodox_blink_all_leds();
-        //ergodox_blink_all_leds();
-      }
-      return false;
-      break;
-    case KC_HWRK:
-      if (!record->event.pressed) {
-        set_single_persistent_default_layer(_HWRKMN);
-        layer_move(default_layer);
-        //ergodox_blink_all_leds();
-        //ergodox_blink_all_leds();
-      }
-      return false;
-      break;
-    case KC_EPRM:
-      if (!record->event.pressed) {
-        //ergodox_blink_all_leds();
-        eeconfig_init();
-      }
-      return false;
-      break;
-    case MC_LOCK:
-      if (!record->event.pressed) {
-        layer_move(default_layer);
-        SEND_STRING(SS_LCTRL(SS_LGUI("q")));
-      }
-      return false;
-      break; */
-    case KC_DCLR:
-#ifdef TAP_DANCE_ENABLE
-      if (record->event.pressed) {
-        uint8_t dtime;
-        for (dtime = 0; dtime < 4; dtime++) {
-          diablo_key_time[dtime] = diablo_times[0];
-        }
-      }
-#endif // !TAP_DANCE_ENABLE
-      return false;
-      break;
-    case KC_CCCV:
-      if (record->event.pressed) {
-        copy_paste_timer = timer_read();
-      } else {
-        if (timer_elapsed(copy_paste_timer) > TAPPING_TERM) { // Hold, copy
-          SEND_STRING(SS_LGUI("c"));
-        } else {
-          SEND_STRING(SS_LGUI("v"));
-        }
-      }
-      return false;
-      break;
-  }
-  return process_record_keymap(keycode, record);
-}
-