From 5f1f370463d818a5283a17001ad832073efc45a4 Mon Sep 17 00:00:00 2001
From: Ryan <fauxpark@gmail.com>
Date: Mon, 16 Mar 2020 07:41:34 +1100
Subject: [PATCH] Update Belgian keymap and sendstring LUT (#8349)

---
 quantum/keymap_extras/keymap_belgian.h     | 235 +++++++++++++--------
 quantum/keymap_extras/sendstring_belgian.h |  26 +--
 2 files changed, 162 insertions(+), 99 deletions(-)

diff --git a/quantum/keymap_extras/keymap_belgian.h b/quantum/keymap_extras/keymap_belgian.h
index 55a0d892c5..a6912afef5 100644
--- a/quantum/keymap_extras/keymap_belgian.h
+++ b/quantum/keymap_extras/keymap_belgian.h
@@ -13,96 +13,159 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#ifndef KEYMAP_BELGIAN_H
-#define KEYMAP_BELGIAN_H
+
+#pragma once
 
 #include "keymap.h"
 
-// Normal characters
-// Line 1
-#define BE_SUP2 KC_GRV
-#define BE_AMP KC_1
-#define BE_EACU KC_2
-#define BE_QUOT KC_3
-#define BE_APOS KC_4
-#define BE_LPRN KC_5
-#define BE_PARA KC_6
-#define BE_EGRV KC_7
-#define BE_EXLM KC_8
-#define BE_CCED KC_9
-#define BE_AGRV KC_0
-#define BE_RPRN KC_MINS
-#define BE_MINS KC_EQL
+// clang-format off
 
-// Line 2
-#define BE_A KC_Q
-#define BE_Z KC_W
-#define BE_CIRC KC_LBRC
-#define BE_DLR KC_RBRC
+/*
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+ * │ ² │ & │ é │ " │ ' │ ( │ § │ è │ ! │ ç │ à │ ) │ - │       │
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+ * │     │ A │ Z │ E │ R │ T │ Y │ U │ I │ O │ P │ ^ │ $ │     │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐    │
+ * │      │ Q │ S │ D │ F │ G │ H │ J │ K │ L │ M │ ù │ µ │    │
+ * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
+ * │    │ < │ W │ X │ C │ V │ B │ N │ , │ ; │ : │ = │          │
+ * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
+ * │    │    │    │                        │    │    │    │    │
+ * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
+ */
+// Row 1
+#define BE_SUP2 KC_GRV  // ²
+#define BE_AMPR KC_1    // &
+#define BE_EACU KC_2    // é
+#define BE_DQUO KC_3    // "
+#define BE_QUOT KC_4    // '
+#define BE_LPRN KC_5    // (
+#define BE_SECT KC_6    // §
+#define BE_EGRV KC_7    // è
+#define BE_EXLM KC_8    // !
+#define BE_CCED KC_9    // ç
+#define BE_AGRV KC_0    // à
+#define BE_RPRN KC_MINS // )
+#define BE_MINS KC_EQL  // -
+// Row 2
+#define BE_A    KC_Q    // A
+#define BE_Z    KC_W    // Z
+#define BE_E    KC_E    // E
+#define BE_R    KC_R    // R
+#define BE_T    KC_T    // T
+#define BE_Y    KC_Y    // Y
+#define BE_U    KC_U    // U
+#define BE_I    KC_I    // I
+#define BE_O    KC_O    // O
+#define BE_P    KC_P    // P
+#define BE_DCIR KC_LBRC // ^ (dead)
+#define BE_DLR  KC_RBRC // $
+// Row 3
+#define BE_Q    KC_A    // Q
+#define BE_S    KC_S    // S
+#define BE_D    KC_D    // D
+#define BE_F    KC_F    // F
+#define BE_G    KC_G    // G
+#define BE_H    KC_H    // H
+#define BE_J    KC_K    // J
+#define BE_K    KC_K    // K
+#define BE_L    KC_L    // L
+#define BE_M    KC_SCLN // M
+#define BE_UGRV KC_QUOT // ù
+#define BE_MICR KC_NUHS // µ
+// Row 4
+#define BE_LABK KC_NUBS // <
+#define BE_W    KC_Z    // W
+#define BE_X    KC_X    // X
+#define BE_C    KC_C    // C
+#define BE_V    KC_V    // V
+#define BE_B    KC_B    // B
+#define BE_N    KC_N    // N
+#define BE_COMM KC_M    // ,
+#define BE_SCLN KC_COMM // ;
+#define BE_COLN KC_DOT  // :
+#define BE_EQL  KC_SLSH // =
 
-// Line 3
-#define BE_Q KC_A
-#define BE_M KC_SCLN
-#define BE_UGRV KC_QUOT
-#define BE_MU KC_NUHS
+/* Shifted symbols
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+ * │ ³ │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ ° │ _ │       │
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+ * │     │   │   │   │   │   │   │   │   │   │   │ ¨ │ * │     │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐    │
+ * │      │   │   │   │   │   │   │   │   │   │   │ % │ £ │    │
+ * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
+ * │    │ > │   │   │   │   │   │   │ ? │ . │ / │ + │          │
+ * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
+ * │    │    │    │                        │    │    │    │    │
+ * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
+ */
+// Row 1
+#define BE_SUP3 S(BE_SUP2) // ³
+#define BE_1    S(BE_AMPR) // 1
+#define BE_2    S(BE_EACU) // 2
+#define BE_3    S(BE_DQUO) // 3
+#define BE_4    S(BE_QUOT) // 4
+#define BE_5    S(BE_LPRN) // 5
+#define BE_6    S(BE_SECT) // 6
+#define BE_7    S(BE_EGRV) // 7
+#define BE_8    S(BE_EXLM) // 8
+#define BE_9    S(BE_CCED) // 9
+#define BE_0    S(BE_AGRV) // 0
+#define BE_RNGA S(BE_RPRN) // °
+#define BE_UNDS S(BE_MINS) // _
+// Row 2
+#define BE_DIAE S(BE_DCIR) // ¨ (dead)
+#define BE_ASTR S(BE_DLR)  // *
+// Row 3
+#define BE_PERC S(BE_UGRV) // %
+#define BE_PND  S(BE_MICR) // £
+// Row 4
+#define BE_RABK S(BE_LABK) // >
+#define BE_QUES S(BE_COMM) // ?
+#define BE_DOT  S(BE_SCLN) // .
+#define BE_SLSH S(BE_COLN) // /
+#define BE_PLUS S(BE_EQL)  // +
 
-// Line 4
-#define BE_LESS KC_NUBS
-#define BE_W KC_Z
-#define BE_COMM KC_M
-#define BE_SCLN KC_COMM
-#define BE_COLN KC_DOT
-#define BE_EQL KC_SLSH
+/* AltGr symbols
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+ * │   │ | │ @ │ # │   │   │ ^ │   │   │ { │ } │   │   │       │
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+ * │     │   │   │ € │   │   │   │   │   │   │   │ [ │ ] │     │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐    │
+ * │      │   │   │   │   │   │   │   │   │   │   │ ´ │ ` │    │
+ * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
+ * │    │ \ │   │   │   │   │   │   │   │   │   │ ~ │          │
+ * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
+ * │    │    │    │                        │    │    │    │    │
+ * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
+ */
+// Row 1
+#define BE_PIPE ALGR(BE_AMPR) // |
+#define BE_AT   ALGR(BE_EACU) // @
+#define BE_HASH ALGR(BE_DQUO) // #
+#define BE_CIRC ALGR(BE_SECT) // ^
+#define BE_LCBR ALGR(BE_CCED) // {
+#define BE_RCBR ALGR(BE_AGRV) // }
+// Row 2
+#define BE_EURO ALGR(BE_E)    // €
+#define BE_LBRC ALGR(BE_DCIR) // [
+#define BE_RBRC ALGR(BE_DLR)  // ]
+// Row 3
+#define BE_ACUT ALGR(BE_UGRV) // ´ (dead)
+#define BE_GRV  ALGR(BE_MICR) // ` (dead)
+// Row 4
+#define BE_BSLS ALGR(BE_LABK) // (backslash)
+#define BE_TILD ALGR(BE_EQL)  // ~
 
-// Shifted characters
-// Line 1
-#define BE_SUP3 KC_TILD
-#define BE_1 LSFT(KC_1)
-#define BE_2 LSFT(KC_2)
-#define BE_3 LSFT(KC_3)
-#define BE_4 LSFT(KC_4)
-#define BE_5 LSFT(KC_5)
-#define BE_6 LSFT(KC_6)
-#define BE_7 LSFT(KC_7)
-#define BE_8 LSFT(KC_8)
-#define BE_9 LSFT(KC_9)
-#define BE_0 LSFT(KC_0)
-#define BE_OVRR KC_UNDS
-#define BE_UNDS KC_PLUS
-
-// Line 2
-#define BE_UMLT LSFT(BE_CIRC)
-#define BE_PND LSFT(BE_DLR)
-
-// Line 3
-#define BE_PERC LSFT(BE_UGRV)
-
-// Line 4
-#define BE_GRTR LSFT(BE_LESS)
-#define BE_QUES LSFT(BE_COMM)
-#define BE_DOT LSFT(BE_SCLN)
-#define BE_SLSH LSFT(BE_COLN)
-#define BE_PLUS LSFT(BE_EQL)
-
-// Alt Gr-ed characters
-// Line 1
-#define BE_PIPE ALGR(KC_1)
-#define BE_AT ALGR(KC_2)
-#define BE_HASH ALGR(KC_3)
-#define BE_LCBR ALGR(KC_9)
-#define BE_RCBR ALGR(KC_0)
-
-// Line 2
-#define BE_EURO ALGR(KC_E)
-#define BE_LSBR ALGR(BE_CIRC)
-#define BE_RSBR ALGR(BE_DLR)
-
-// Line 3
-#define BE_ACUT ALGR(BE_UGRV)
-#define BE_GRV ALGR(BE_MU)
-
-// Line 4
-#define BE_BSLS ALGR(BE_LESS)
-#define BE_TILT ALGR(BE_EQL)
-
-#endif
+// DEPRECATED
+#define BE_AMP  BE_AMPR
+#define BE_APOS BE_QUOT
+#define BE_PARA BE_SECT
+#define BE_MU   BE_MICR
+#define BE_LESS BE_LABK
+#define BE_OVRR BE_RNGA
+#define BE_UMLT BE_DIAE
+#define BE_GRTR BE_RABK
+#define BE_LSBR BE_LBRC
+#define BE_RSBR BE_RBRC
+#define BE_TILT BE_TILD
diff --git a/quantum/keymap_extras/sendstring_belgian.h b/quantum/keymap_extras/sendstring_belgian.h
index ef5a2f049d..5e9a079a95 100644
--- a/quantum/keymap_extras/sendstring_belgian.h
+++ b/quantum/keymap_extras/sendstring_belgian.h
@@ -40,7 +40,7 @@ const uint8_t ascii_to_shift_lut[16] PROGMEM = {
     KCLUT_ENTRY(0, 0, 0, 0, 0, 0, 0, 0),
     KCLUT_ENTRY(0, 0, 0, 0, 0, 0, 0, 0),
     KCLUT_ENTRY(0, 0, 0, 0, 0, 0, 0, 0),
-    KCLUT_ENTRY(0, 0, 0, 0, 0, 0, 0, 0),
+    KCLUT_ENTRY(0, 0, 0, 0, 0, 0, 0, 0)
 };
 
 const uint8_t ascii_to_altgr_lut[16] PROGMEM = {
@@ -60,7 +60,7 @@ const uint8_t ascii_to_altgr_lut[16] PROGMEM = {
     KCLUT_ENTRY(1, 0, 0, 0, 0, 0, 0, 0),
     KCLUT_ENTRY(0, 0, 0, 0, 0, 0, 0, 0),
     KCLUT_ENTRY(0, 0, 0, 0, 0, 0, 0, 0),
-    KCLUT_ENTRY(0, 0, 0, 1, 1, 1, 1, 0),
+    KCLUT_ENTRY(0, 0, 0, 1, 1, 1, 1, 0)
 };
 
 const uint8_t ascii_to_keycode_lut[128] PROGMEM = {
@@ -74,27 +74,27 @@ const uint8_t ascii_to_keycode_lut[128] PROGMEM = {
     XXXXXXX, XXXXXXX, XXXXXXX, KC_ESC,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
 
     //       !        "        #        $        %        &        '
-    KC_SPC,  BE_EXLM, BE_QUOT, BE_QUOT, BE_DLR,  BE_UGRV, BE_AMP,  BE_APOS,
+    KC_SPC,  BE_EXLM, BE_DQUO, BE_DQUO, BE_DLR,  BE_UGRV, BE_AMPR, BE_QUOT,
     // (     )        *        +        ,        -        .        /
     BE_LPRN, BE_RPRN, BE_DLR,  BE_EQL,  BE_COMM, BE_MINS, BE_SCLN, BE_COLN,
     // 0     1        2        3        4        5        6        7
-    BE_AGRV, BE_AMP,  BE_EACU, BE_QUOT, BE_APOS, BE_LPRN, BE_PARA, BE_EGRV,
+    BE_AGRV, BE_AMPR, BE_EACU, BE_DQUO, BE_QUOT, BE_LPRN, BE_SECT, BE_EGRV,
     // 8     9        :        ;        <        =        >        ?
-    BE_EXLM, BE_CCED, BE_COLN, BE_SCLN, BE_LESS, BE_EQL,  BE_LESS, BE_COMM,
+    BE_EXLM, BE_CCED, BE_COLN, BE_SCLN, BE_LABK, BE_EQL,  BE_LABK, BE_COMM,
     // @     A        B        C        D        E        F        G
-    BE_EACU, BE_A,    KC_B,    KC_C,    KC_D,    KC_E,    KC_F,    KC_G,
+    BE_EACU, BE_A,    BE_B,    BE_C,    BE_D,    BE_E,    BE_F,    BE_G,
     // H     I        J        K        L        M        N        O
-    KC_H,    KC_I,    KC_J,    KC_K,    KC_L,    BE_M,    KC_N,    KC_O,
+    BE_H,    BE_I,    BE_J,    BE_K,    BE_L,    BE_M,    BE_N,    BE_O,
     // P     Q        R        S        T        U        V        W
-    KC_P,    BE_Q,    KC_R,    KC_S,    KC_T,    KC_U,    KC_V,    BE_W,
+    BE_P,    BE_Q,    BE_R,    BE_S,    BE_T,    BE_U,    BE_V,    BE_W,
     // X     Y        Z        [        \        ]        ^        _
-    KC_X,    KC_Y,    BE_Z,    BE_CIRC, BE_LESS, BE_DLR,  BE_PARA, BE_MINS,
+    BE_X,    BE_Y,    BE_Z,    BE_CIRC, BE_LABK, BE_DLR,  BE_SECT, BE_MINS,
     // `     a        b        c        d        e        f        g
-    BE_MU,   BE_A,    KC_B,    KC_C,    KC_D,    KC_E,    KC_F,    KC_G,
+    BE_MICR, BE_A,    BE_B,    BE_C,    BE_D,    BE_E,    BE_F,    BE_G,
     // h     i        j        k        l        m        n        o
-    KC_H,    KC_I,    KC_J,    KC_K,    KC_L,    BE_M,    KC_N,    KC_O,
+    BE_H,    BE_I,    BE_J,    BE_K,    BE_L,    BE_M,    BE_N,    BE_O,
     // p     q        r        s        t        u        v        w
-    KC_P,    BE_Q,    KC_R,    KC_S,    KC_T,    KC_U,    KC_V,    BE_W,
+    BE_P,    BE_Q,    BE_R,    BE_S,    BE_T,    BE_U,    BE_V,    BE_W,
     // x     y        z        {        |        }        ~        DEL
-    KC_X,    KC_Y,    BE_Z,    BE_CCED, BE_AMP,  BE_AGRV, BE_EQL,  KC_DEL
+    BE_X,    BE_Y,    BE_Z,    BE_CCED, BE_AMPR, BE_AGRV, BE_EQL,  KC_DEL
 };