[Keyboard] gBoards GergoPlex (#13027)

* Moved gergoplex to seperate PR

* vendor + cformat

* Update keyboards/gboards/k/gergoplex/matrix.c

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* lifiting keyboards up

* Update readme.md

* Update keyboards/gboards/gergoplex/config.h

Co-authored-by: Drashna Jaelre <drashna@live.com>

* remove English dicts

* cformatted

* Prettify keymap

* Remove via keymaps

Via doesn't support chords/combos, and this makes the keymap on such a
small keyboard quite uncomfortable and incomplete.

* Address QMK pull code review notes

* Cleanup (tabs, excessive comments)

* Fix keymap typos

* Use enum to define layers

* Multiple changes

 - got rid of LAYOUT_kc in favour of LAYOUT_split_3x5_3
 - fixed matrix custom C code to build with updated external dependencies (gcc)
 - fixed used combo docs

    keyboards/gboards/gergoplex/matrix.c:189:9: error: implicit declaration of function 'phex' [-Werror=implicit-function-declaration]
             phex(row);
             ^~~~
    keyboards/gboards/gergoplex/matrix.c:191:9: error: implicit declaration of function 'pbin_reverse16'; did you mean 'print_bin_reverse16'? [-Werror=implicit-function-declaration]
             pbin_reverse16(matrix_get_row(row));

* Remove apparently redundant macros

* Replace direct pin control with IO functions

* config mouse enable and combo delay fix

The default delay is 200:

    #define COMBO_TERM 200
        how long for the Combo keys to be detected. Defaults to TAPPING_TERM if not defined.

    tmk_core/common/action_tapping.h|22| 13:#    define TAPPING_TERM 200

* Remove redundant defines

* Unambiguously refer to the Special layer

* Fix formatting

* gboards/gergoplex set IGNORE_MOD_TAP_INTERRUPT

This solves my issue was with KC_CTL_A working correctly and it was set in @germ's repo
https://github.com/germ/qmk_firmware/blob/39c86e080dc04b68ee08387dcb5144c88cb44855/keyboards/gboards/k/gergoplex/config.h#L49

 https://beta.docs.qmk.fm/using-qmk/software-features/tap_hold#ignore-mod-tap-interrupt

* Name change

See commit 581368596ed

* Wording change

* Update keyboards/gboards/gergoplex/keymaps/default/keymap.c

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Add copyright headers

* Fix debounce type

 | avr-gcc: error: .build/obj_gboards_gergoplex_default/quantum/debounce/eager_pr.o: No such file or directory

* Implement colemak-dhm keymap

Co-authored-by: Germ <jeremythegeek@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Brian Tannous <Brian@BrianTannous.com>

8 files changed, 288 insertions, 0 deletions

diff --git a/keyboards/gboards/gergoplex/keymaps/colemak-dhm/combos.def b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/combos.def
new file mode 100644
index 0000000000..2aac5cb4ff
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/combos.def
@@ -0,0 +1,10 @@
+// List any combo dictionaries you want loaded to your device below!
+
+// User includes
+#include "gergoplex.def"
+
+// QMK wide includes
+#include "combos/colemakdhm-vim-helpers.def"
+
+// Word completion
+// #include "combos/eng-combos.def"
diff --git a/keyboards/gboards/gergoplex/keymaps/colemak-dhm/gergoplex.def b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/gergoplex.def
new file mode 100644
index 0000000000..7ed0122c4b
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/gergoplex.def
@@ -0,0 +1,11 @@
+// Gergoplex colemak-dhm specfic combos
+COMB(osBacksl,    KC_BSLS,          KC_Y, KC_SCLN)
+COMB(mnLess,      KC_LT,            KC_M, KC_N)
+COMB(eiGreat,     KC_GT,            KC_E, KC_I)
+COMB(xcDash,      KC_MINS,          KC_X, KC_C)
+COMB(hcUnds,      KC_UNDS,          KC_H, KC_COMM)
+COMB(khQuot,      KC_QUOT,          KC_K, KC_H)
+COMB(gvClic,      KC_BTN1,          KC_G, KC_V)
+COMB(tdClic,      KC_BTN2,          KC_T, KC_D)
+
+SUBS(pasta,       "I would just like to interject for a moment.",    KC_H, KC_J, KC_K, KC_L)
diff --git a/keyboards/gboards/gergoplex/keymaps/colemak-dhm/keymap.c b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/keymap.c
new file mode 100644
index 0000000000..ec2c17f8bc
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/keymap.c
@@ -0,0 +1,99 @@
+/* Good on you for modifying your layout! if you don't have
+ * time to read the QMK docs, a list of keycodes can be found at
+ * https://github.com/qmk/qmk_firmware/blob/master/docs/keycodes.md
+ */
+
+#include "gergoplex.h"
+#include "g/keymap_combo.h"
+
+enum {
+    _ALPHA,     // default (Colemak DHm)
+    _SPECIAL,   // special characters
+    _NUMBERS    // numbers/function/motion
+};
+
+// alpha hold modifiers
+#define KC_CTL_A  MT(MOD_LCTL, KC_A)     // Tap for A, hold for Control
+#define KC_CTL_O  MT(MOD_RCTL, KC_O)     // Tap for colon, hold for Control
+#define KC_SFT_Z  MT(MOD_LSFT, KC_Z)     // Tap for Z, hold for Shift
+#define KC_SFT_SL MT(MOD_RSFT, KC_SLSH)  // Tap for slash, hold for Shift
+
+// thumb modifiers/toggles
+#define KC_GUI_ESC MT(MOD_LGUI, KC_ESC)  // Tap for Esc, hold for GUI (Meta, Command, Win)
+#define KC_ALT_ENT MT(MOD_LALT, KC_ENT)  // Tap for Enter, hold for Alt (Option)
+#define KC_SPE_SPC LT(_SPECIAL, KC_SPC)  // Tap for Space, hold for Special layer
+#define KC_NUM_SPC LT(_NUMBERS, KC_SPC)  // Tap for Space, hold for Numbers layer
+#define KC_SFT_TAB MT(MOD_RSFT, KC_TAB)  // Tap for Tab, hold for Right Shift
+
+    /* Combomap
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |       |    ESC    |     |     |      |     |    ESC    |     \       |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |       |   BSPC   TAB    |     |      |     <     :     >     |       |
+     * |-------+-----+-----+-RMB-+-LMB-|      |ENTER+-----+-----+-----+-------|
+     * |       |     -   ENTER   |     |      |     '     _     |     |       |
+     * `-------------------------------'      `-------------------------------'
+     *            .-----------------.            .-----------------.
+     *            |     |     |     |            |     |     |     |
+     *            '-----------------'            '-----------------'
+     */
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Keymap 0: Alpha layer / Colemak DHm
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |     Q |  W  |  F  |  P  |  B  |      |  J  |  L  |  U  |  Y  |   ;   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * | CTRL A|  R  |  S  |  T  |  G  |      |  M  |  N  |  E  |  I  |   O   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * | SHFT Z|  X  |  C  |  D  |  V  |      |  K  |  H  |  <  |  >  |SHFT / |
+     * `-------------------------------'      `-------------------------------'
+     *   .------------------------------.    .----------------------.
+     *   | ESC META | ENT ALT | SPC SPE |    | SPC NUM | SHFT | TAB |
+     *   '------------------------------'    '----------------------'
+     */
+    [_ALPHA] = LAYOUT_split_3x5_3(
+         KC_Q,     KC_W,   KC_F,   KC_P,   KC_B,          KC_J,   KC_L,   KC_U,     KC_Y,   KC_SCLN,
+         KC_CTL_A, KC_R,   KC_S,   KC_T,   KC_G,          KC_M,   KC_N,   KC_E,     KC_I,   KC_CTL_O,
+         KC_SFT_Z, KC_X,   KC_C,   KC_D,   KC_V,          KC_K,   KC_H,   KC_COMMA, KC_DOT, KC_SFT_SL,
+             KC_GUI_ESC, KC_ALT_ENT, KC_SPE_SPC,          KC_NUM_SPC, KC_LSFT, KC_SFT_TAB),
+
+    /* Keymap 1: Special characters layer
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |    !  |  @  |  {  |  }  |  |  |      |  `  |  ~  |     |     |   \   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |    #  |  $  |  (  |  )  | RMB |      |  +  |  -  |  /  |  *  |   '   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |    %  |  ^  |  [  |  ]  | LMB |      |  &  |  =  |  ,  |  .  |   -   |
+     * `-------------------------------'      `-------------------------------'
+     *     .-------------------------.          .-----------------.
+     *     | ComboToggle |  ;  |  =  |          |  =  |  ;  | DEL |
+     *     '-------------------------'          '-----------------'
+     */
+    [_SPECIAL] = LAYOUT_split_3x5_3(
+         KC_EXLM, KC_AT,   KC_LCBR, KC_RCBR, KC_PIPE,          KC_GRV,  KC_TILD, KC_TRNS, KC_TRNS, KC_BSLS,
+         KC_HASH, KC_DLR,  KC_LPRN, KC_RPRN, KC_BTN2,          KC_PLUS, KC_MINS, KC_SLSH, KC_ASTR, KC_QUOT,
+         KC_PERC, KC_CIRC, KC_LBRC, KC_RBRC, KC_BTN1,          KC_AMPR, KC_EQL,  KC_COMM, KC_DOT,  KC_MINS,
+                            CMB_TOG, KC_SCLN, KC_EQL,          KC_EQL, KC_SCLN, KC_DEL),
+
+    /* Keymap 2: Numbers/Function/Motion layer
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |   1   |  2  |  3  |  4  |  5  |      |  6  |  7  |  8  |  9  |   0   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |  F1   | F2  | F3  | F4  | F5  |      | LFT | DWN | UP  | RGT | VOLUP |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |  F6   | F7  | F8  | F9  | F10 |      | MLFT| MDWN| MUP | MRGT| VOLDN |
+     * `-------------------------------'      `-------------------------------'
+     *             .-----------------.          .-----------------.
+     *             | F11 | F12 |     |          |     | PLY | SKP |
+     *             '-----------------'          '-----------------'
+     */
+    [_NUMBERS] = LAYOUT_split_3x5_3(
+         KC_1,  KC_2,  KC_3,  KC_4,  KC_5,           KC_6,    KC_7,    KC_8,    KC_9,    KC_0,
+         KC_F1, KC_F2, KC_F3, KC_F4, KC_F5,          KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_VOLU,
+         KC_F6, KC_F7, KC_F8, KC_F9, KC_F10,         KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, KC_VOLD,
+                    KC_F11, KC_F12, KC_TRNS,         KC_TRNS,  KC_MPLY,  KC_MNXT)
+};
diff --git a/keyboards/gboards/gergoplex/keymaps/colemak-dhm/rules.mk b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/rules.mk
new file mode 100644
index 0000000000..e882b8008d
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/colemak-dhm/rules.mk
@@ -0,0 +1,17 @@
+#----------------------------------------------------------------------------
+# make gboards/gergoplex:default:flash
+# Make sure you have dfu-programmer installed!
+#----------------------------------------------------------------------------
+
+#Debug options
+VERBOSE                = no
+DEBUG_MATRIX_SCAN_RATE = no
+DEBUG_MATRIX           = no
+CONSOLE_ENABLE         = no
+
+#Combos!
+VPATH                  +=  keyboards/gboards/
+
+ifeq ($(strip $(DEBUG_MATRIX)), yes)
+    OPT_DEFS += -DDEBUG_MATRIX
+endif
diff --git a/keyboards/gboards/gergoplex/keymaps/default/combos.def b/keyboards/gboards/gergoplex/keymaps/default/combos.def
new file mode 100644
index 0000000000..97ea961e6e
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/default/combos.def
@@ -0,0 +1,11 @@
+// List any combo dictionaries you want loaded to your device below!
+
+// QMK wide includes
+#include "combos/germ-vim-helpers.def"
+#include "combos/germ-mouse-keys.def"
+
+// User includes
+#include "gergoplex.def"
+
+// Word completion
+// #include "combos/eng-combos.def"
diff --git a/keyboards/gboards/gergoplex/keymaps/default/gergoplex.def b/keyboards/gboards/gergoplex/keymaps/default/gergoplex.def
new file mode 100644
index 0000000000..6e50571b5b
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/default/gergoplex.def
@@ -0,0 +1,10 @@
+// Gergoplex specfic combos
+
+COMB(opBacksl,    KC_BSLS,          KC_O, KC_P)
+COMB(hjLess,      KC_LT,            KC_H, KC_J)
+COMB(klGreat,     KC_GT,            KC_K, KC_L)
+COMB(xcDash,      KC_MINS,          KC_X, KC_C)
+COMB(mcUnds,      KC_UNDS,          KC_M, KC_COMM)
+COMB(nmQuot,      KC_QUOT,          KC_N, KC_M)
+
+SUBS(pasta,       "I'd just like to interject for a moment.",       KC_H, KC_J, KC_K, KC_L)
diff --git a/keyboards/gboards/gergoplex/keymaps/default/keymap.c b/keyboards/gboards/gergoplex/keymaps/default/keymap.c
new file mode 100644
index 0000000000..c632751204
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/default/keymap.c
@@ -0,0 +1,113 @@
+/* Copyright 2021 Jane Bernhardt
+  *
+  * 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/>.
+  */
+
+/* Good on you for modifying your layout! if you don't have
+ * time to read the QMK docs, a list of keycodes can be found at
+ * https://github.com/qmk/qmk_firmware/blob/master/docs/keycodes.md
+ */
+
+#include QMK_KEYBOARD_H
+#include "g/keymap_combo.h"
+
+enum {
+    _ALPHA,   // default
+    _SPECIAL, // special characters
+    _NUMBERS  // numbers/function/motion
+};
+
+#define KC_CTL_A  MT(MOD_LCTL, KC_A)     // Tap for A, hold for Control
+#define KC_CTL_CL MT(MOD_LCTL, KC_SCLN)  // Tap for colon, hold for Control
+#define KC_SFT_Z  MT(MOD_RSFT, KC_Z)     // Tap for Z, hold for Shift
+#define KC_SFT_SL MT(MOD_RSFT, KC_SLSH)  // Tap for slash, hold for Shift
+
+#define KC_GUI_ESC MT(MOD_LGUI, KC_ESC)  // Tap for Esc, hold for GUI (Meta, Command, Win)
+#define KC_ALT_ENT MT(MOD_LALT, KC_ENT)  // Tap for Enter, hold for Alt (Option)
+#define KC_SPE_SPC LT(_SPECIAL, KC_SPC)  // Tap for Space, hold for Special layer
+#define KC_NUM_SPC LT(_NUMBERS, KC_SPC)  // Tap for Space, hold for Numbers layer
+#define KC_SFT_TAB MT(MOD_RSFT, KC_TAB)  // Tap for Tab, hold for Right Shift
+
+    /* Combomap
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |       |    ESC    |     |     |      |     |    ESC    |     \       |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |       |   BSPC   TAB    |     |      |     <     :     >     |       |
+     * |-------+-----+-----+-RMB-+-LMB-|      |ENTER+-----+-----+-----+-------|
+     * |       |     -   ENTER   |     |      |     '     _     |     |       |
+     * `-------------------------------'      `-------------------------------'
+     *            .-----------------.            .-----------------.
+     *            |     |     |     |            |     |     |     |
+     *            '-----------------'            '-----------------'
+     */
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Keymap 0: Alpha layer
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |     Q |  W  |  E  |  R  |  T  |      |  Y  |  U  |  I  |  O  |   P   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * | CTRL A|  S  |  D  |  F  |  G  |      |  H  |  J  |  K  |  L  |CTRL ; |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * | SHFT Z|  X  |  C  |  V  |  B  |      |  N  |  M  |  <  |  >  |SHFT / |
+     * `-------------------------------'      `-------------------------------'
+     *   .------------------------------.    .----------------------.
+     *   | ESC META | ENT ALT | SPC SPE |    | SPC NUM | SHFT | TAB |
+     *   '------------------------------'    '----------------------'
+     */
+    [_ALPHA] = LAYOUT_split_3x5_3(
+         KC_Q,     KC_W,   KC_E,   KC_R,   KC_T,          KC_Y,   KC_U,   KC_I,     KC_O,   KC_P,
+         KC_CTL_A, KC_S,   KC_D,   KC_F,   KC_G,          KC_H,   KC_J,   KC_K,     KC_L,   KC_CTL_CL,
+         KC_SFT_Z, KC_X,   KC_C,   KC_V,   KC_B,          KC_N,   KC_M,   KC_COMMA, KC_DOT, KC_SFT_SL,
+             KC_GUI_ESC, KC_ALT_ENT, KC_SPE_SPC,          KC_NUM_SPC, KC_LSFT, KC_SFT_TAB),
+
+    /* Keymap 1: Special characters layer
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |    !  |  @  |  {  |  }  |  |  |      |  `  |  ~  |     |     |   \   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |    #  |  $  |  (  |  )  | RMB |      |  +  |  -  |  /  |  *  |   '   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |    %  |  ^  |  [  |  ]  | LMB |      |  &  |  =  |  ,  |  .  |   -   |
+     * `-------------------------------'      `-------------------------------'
+     *     .-------------------------.          .-----------------.
+     *     | ComboToggle |  ;  |  =  |          |  =  |  ;  | DEL |
+     *     '-------------------------'          '-----------------'
+     */
+    [_SPECIAL] = LAYOUT_split_3x5_3(
+         KC_EXLM, KC_AT,   KC_LCBR, KC_RCBR, KC_PIPE,          KC_GRV,  KC_TILD, KC_TRNS, KC_TRNS, KC_BSLS,
+         KC_HASH, KC_DLR,  KC_LPRN, KC_RPRN, KC_BTN2,          KC_PLUS, KC_MINS, KC_SLSH, KC_ASTR, KC_QUOT,
+         KC_PERC, KC_CIRC, KC_LBRC, KC_RBRC, KC_BTN1,          KC_AMPR, KC_EQL,  KC_COMM, KC_DOT,  KC_MINS,
+                            CMB_TOG, KC_SCLN, KC_EQL,          KC_EQL, KC_SCLN, KC_DEL),
+
+    /* Keymap 2: Numbers/Function/Motion layer
+     *
+     * ,-------------------------------.      ,-------------------------------.
+     * |   1   |  2  |  3  |  4  |  5  |      |  6  |  7  |  8  |  9  |   0   |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |  F1   | F2  | F3  | F4  | F5  |      | LFT | DWN | UP  | RGT | VOLUP |
+     * |-------+-----+-----+-----+-----|      |-----+-----+-----+-----+-------|
+     * |  F6   | F7  | F8  | F9  | F10 |      | MLFT| MDWN| MUP | MRGT| VOLDN |
+     * `-------------------------------'      `-------------------------------'
+     *             .-----------------.          .-----------------.
+     *             | F11 | F12 |     |          |     | PLY | SKP |
+     *             '-----------------'          '-----------------'
+     */
+    [_NUMBERS] = LAYOUT_split_3x5_3(
+         KC_1,  KC_2,  KC_3,  KC_4,  KC_5,           KC_6,    KC_7,    KC_8,    KC_9,    KC_0,
+         KC_F1, KC_F2, KC_F3, KC_F4, KC_F5,          KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_VOLU,
+         KC_F6, KC_F7, KC_F8, KC_F9, KC_F10,         KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, KC_VOLD,
+                    KC_F11, KC_F12, KC_TRNS,         KC_TRNS,  KC_MPLY,  KC_MNXT)
+};
diff --git a/keyboards/gboards/gergoplex/keymaps/default/rules.mk b/keyboards/gboards/gergoplex/keymaps/default/rules.mk
new file mode 100644
index 0000000000..e882b8008d
--- /dev/null
+++ b/keyboards/gboards/gergoplex/keymaps/default/rules.mk
@@ -0,0 +1,17 @@
+#----------------------------------------------------------------------------
+# make gboards/gergoplex:default:flash
+# Make sure you have dfu-programmer installed!
+#----------------------------------------------------------------------------
+
+#Debug options
+VERBOSE                = no
+DEBUG_MATRIX_SCAN_RATE = no
+DEBUG_MATRIX           = no
+CONSOLE_ENABLE         = no
+
+#Combos!
+VPATH                  +=  keyboards/gboards/
+
+ifeq ($(strip $(DEBUG_MATRIX)), yes)
+    OPT_DEFS += -DDEBUG_MATRIX
+endif