2020 February 29 Breaking Changes Update (#8064)
[jackhill/qmk/firmware.git] / keyboards / planck / keymaps / luke / keymap.c
CommitLineData
77e54e34
LS
1/*
2 * A keyboard layout for the gridded planck.
ade22f8e 3 *
77e54e34 4 * Copyright (C) 2017 Luke Silva
ade22f8e 5 *
77e54e34
LS
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
ade22f8e 10 *
77e54e34
LS
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
ade22f8e 15 *
77e54e34
LS
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 *
20 * ,-----------------------------------------------------------------------------------.
21 * | | | | | | | | | | | | |
22 * |------+------+------+------+------+------+------+------+------+------+------+------|
23 * | | | | | | | | | | | | |
24 * |------+------+------+------+------+------+------+------+------+------+------+------|
25 * | | | | | | | | | | | | |
26 * |------+------+------+------+------+------+------+------+------+------+------+------|
27 * | | | | | | | | | | | | |
28 * `-----------------------------------------------------------------------------------'
29 *
30 * This layout uses colemak by default, and is designed for programming, with easy access to symbols
31 * through either double purpose modifiers or colemak style rolling for commonly used symbol clusters
32 * Eg: compare colemak 'this' to '(){\n}' on the symbol layer.
33 *
ade22f8e 34 * The layout also supports a range of multilingual characters, covering those
77e54e34
LS
35 * needed for French, German, Swedish and likely some other European Languages.
36 * In the future full support for Colemak's multilingual deadkeys may be introduced.
37 *
38 * The multilingual characters are inputted through QMK's unicode engine, using
39 * the Linux input method by default, however this can be changed at runtime.
40 *
41 */
42
43
26eef35f 44#include QMK_KEYBOARD_H
77e54e34 45
77e54e34
LS
46// Layers
47#define _COLEMAK 0
48#define _QWERTY 1
49#define _SYM 2
50#define _NUM 3
51#define _GR 4
52#define _GR_S 5
53#define _ADJ 6
54#define _NAV 7
55#define _PLOVER 8
56
57// Macro ID numbers
58#define M_ALT_HASH 1
59#define M_GR_DASH 2
ade22f8e
JH
60#define M_SYM_LPRN 3
61#define M_NAV_UNDS 4
62#define M_NUM_RPRN 5
63#define M_CTRL_DLR 6
77e54e34
LS
64#define M_LCBR_ENT 7
65#define M_PLOVER 8
66#define M_EXT_PLV 9
67#define M_WINDOWS 10
68#define M_LINUX 11
69#define M_OSX 12
70#define M_FUNCTION 13
71#define M_THEN 14
72#define M_CATCH 15
73
74// Macro keys
ade22f8e 75#define ALT_HASH MACROTAP(M_ALT_HASH) // tap for #, hold for Alt
77e54e34
LS
76#define GR_DASH MACROTAP(M_GR_DASH) // tap for -, hold for GR layer a-class-name
77#define SYM_LPRN MACROTAP(M_SYM_LPRN) // tap for (, hold for symbols layer if()
78#define NAV_UNDS MACROTAP(M_NAV_UNDS) // tap for _, hold for navigation layer snake_case_variable
79#define NUM_RPRN MACROTAP(M_NUM_RPRN) // tap for ), hold for numbers layer else if()
80#define CTRL_DLR MACROTAP(M_CTRL_DLR) // tap for $, hold for ctrl $php_is_really_weird
81#define LCBR_ENT M(M_LCBR_ENT) // {\n easier code formatting
82#define PLOVER M(M_PLOVER) // PHROPB (plover) or ERFVIK(qwerty) starts plover
83#define EXT_PLV M(M_EXT_PLV) // PHRO*F (plover) or ERFVYU(qwerty) stops plover
84#define WINDOWS M(M_WINDOWS) // Sets Unicode handler to windows
85#define LINUX M(M_LINUX) // Sets Unicode handler to linux
86#define OSX M(M_OSX) // Sets Unicode handler to OSX
87#define FUNCTION M(M_FUNCTION)
88#define THEN M(M_THEN)
89#define CATCH M(M_CATCH)
90
91
92// Renames of QMK keys... (would have otherwise been a macro)
93#define QWERTY DF(_QWERTY)
94#define COLEMAK DF(_COLEMAK)
95
96
97
98
99
100const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
101
102/* Colemak
103 * ,-----------------------------------------------------------------------------------.
104 * | Tab | Q | W | F | P | G | J | L | U | Y | ;: | Bksp |
105 * |------+------+------+------+------+------+------+------+------+------+------+------|
106 * | Bksp | A | R | S | T | D | H | N | E | I | O | '" |
107 * |------+------+------+------+------+------+------+------+------+------+------+------`---.
108 * |Shift=| Z | X | C | V | B | K | M | ,< | .> | /? |Shift/Ent |
109 * |------+------+------+------+------+------+------+------+------+------+------+----------|
110 * |CtCaps|GUIF4 | Alt# | Gr- | Sym( | Nav_ |Space | Num) |Ctrl$ | F11 | F12 |Nav toggle|
111 * `---------------------------------------------------------------------------------------'
112 */
113
26eef35f
JY
114[_COLEMAK] = LAYOUT_planck_grid(
115 KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC,
116 KC_BSPC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT,
117 SFT_T(KC_EQL), KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_T(KC_ENT) ,
118 CTL_T(KC_CAPS), KC_LGUI, ALT_HASH, GR_DASH, SYM_LPRN, NAV_UNDS, KC_SPC, NUM_RPRN, CTRL_DLR, KC_F11, KC_F12, TG(_NAV)
119),
77e54e34
LS
120
121
ade22f8e 122
77e54e34
LS
123/* QWERTY
124 * ,-----------------------------------------------------------------------------------.
125 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
126 * |------+------+------+------+------+------+------+------+------+------+------+------|
127 * | Bksp | A | S | D | F | G | H | J | K | L | ;: | '" |
128 * |------+------+------+------+------+------+------+------+------+------+------+------`---.
129 * |Shift=| Z | X | C | V | B | N | M | ,< | .> | /? |Shift/Ent |
130 * |------+------+------+------+------+------+------+------+------+------+------+----------|
131 * |CtCaps|GUIF4 | Alt# | Gr- | Sym( | Nav_ |Space | Num) |Ctrl$ | F11 | F12 |Nav toggle|
132 * `---------------------------------------------------------------------------------------'
133 */
134
26eef35f
JY
135[_QWERTY] = LAYOUT_planck_grid(
136 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
137 KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
138 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_T(KC_ENT) ,
139 CTL_T(KC_CAPS), KC_LGUI, KC_LALT, GR_DASH, SYM_LPRN,KC_SPC, KC_SPC, NUM_RPRN, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT
140),
77e54e34
LS
141
142
143/* Symbols
144 * ,-----------------------------------------------------------------------------------.
145 * | Tab | ` | @ | / | * | ^ | % | : | + | - | Del | Bksp |
146 * |------+------+------+------+------+------+------+------+------+------+------+------|
147 * | | [ | ; | } | ( | " | ' | ) | {\n | ! | ] | \ |
148 * |------+------+------+------+------+------+------+------+------+------+------+------|
149 * |Shift | . | { | < | > | ~ | X2 | = | & | | | ? |Enter |
150 * |------+------+------+------+------+------+------+------+------+------+------+------|
151 * | | | | | Sym | _ |Space | NUM | X2 | | | |
152 * `-----------------------------------------------------------------------------------'
153 */
ade22f8e 154
26eef35f
JY
155[_SYM] = LAYOUT_planck_grid(
156 KC_TAB, KC_GRV, KC_AT, KC_SLSH, KC_ASTR, KC_CIRC, KC_PERC, KC_COLN, KC_PLUS, KC_MINS, KC_DEL, KC_BSPC,
157 FUNCTION,KC_LBRC, KC_SCLN, KC_RCBR, KC_LPRN, KC_DQT, KC_QUOT, KC_RPRN, LCBR_ENT,KC_EXLM, KC_RBRC, KC_BSLS,
158 KC_LSFT, KC_DOT, KC_LCBR, KC_LABK, KC_RABK, KC_TILD, _______, KC_EQL, KC_AMPR, KC_PIPE, KC_QUES, KC_ENT ,
159 THEN, CATCH, XXXXXXX, XXXXXXX, _______, _______, _______, _______, _______, XXXXXXX, XXXXXXX, _______
160),
77e54e34
LS
161
162
163/* Numbers
164 * ,-----------------------------------------------------------------------------------.
165 * | Tab | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
166 * |------+------+------+------+------+------+------+------+------+------+------+------|
167 * | Bksp | x | D | E | F | + | - | 4 | 5 | 6 | 0 |Enter |
168 * |------+------+------+------+------+------+------+------+------+------+------+------|
169 * |Shift | ( | A | B | C | * | / | 1 | 2 | 3 | ) |Enter |
170 * |------+------+------+------+------+------+------+------+------+------+------+------|
171 * | | | | GR | SYM | _ |Space | NUM | 0 | . | f | |
172 * `-----------------------------------------------------------------------------------'
173 */
ade22f8e 174
26eef35f
JY
175[_NUM] = LAYOUT_planck_grid(
176 KC_TAB, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
177 KC_BSPC, KC_X, S(KC_D), S(KC_E), S(KC_F), KC_PLUS, KC_MINS, KC_4, KC_5, KC_6, KC_0, KC_ENT ,
178 KC_LSFT, KC_LPRN, S(KC_A), S(KC_B), S(KC_C), KC_ASTR, KC_SLSH, KC_1, KC_2, KC_3, KC_RPRN, KC_ENT ,
179 _______, _______, _______, _______, _______, _______, _______, _______, KC_0, KC_DOT, KC_F, _______
180),
77e54e34
LS
181
182
183/* Gr layer / international keys
184 * ,-----------------------------------------------------------------------------------.
185 * | | ä | å | | ¢£ | €¥ | | ë | ê | ü | ù | |
186 * |------+------+------+------+------+------+------+------+------+------+------+------|
187 * | | â | à | ß | | | | è | é | ï | ö | |
188 * |------+------+------+------+------+------+------+------+------+------+------+------|
189 * | | æ | ô | ç | œ | | | û | « | » | î | |
190 * |------+------+------+------+------+------+------+------+------+------+------+------|
191 * | | | | | | | | | | | | |
192 * `-----------------------------------------------------------------------------------'
193 */
ade22f8e 194
26eef35f
JY
195[_GR] = LAYOUT_planck_grid(
196 _______, UC(0xE4),UC(0xE5), _______,UC(0xA2), UC(0x20AC),_______,UC(0xEB),UC(0xEA),UC(0xFC),UC(0xF9), _______,
197 _______, UC(0xE2),UC(0xE0),UC(0xDF), _______, _______, _______,UC(0xE8),UC(0xE9),UC(0xEF),UC(0xF6), _______,
198 MO(_GR_S),UC(0xE6),UC(0xF4),UC(0xE7),UC(0x153),_______, _______,UC(0xFB),UC(0xAB),UC(0xBB),UC(0xEE), MO(_GR_S),
199 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
200),
77e54e34
LS
201
202// Shifted layer of the above
26eef35f
JY
203[_GR_S] = LAYOUT_planck_grid(
204 _______, UC(0xC4),UC(0xC5), _______, UC(0xA3), UC(0xA5),_______, UC(0xCB),UC(0xCA),UC(0xDC),UC(0xD9),_______,
205 _______, UC(0xC2),UC(0xC0), UC(0xDF),_______, _______, _______, UC(0xC8),UC(0xC9),UC(0xCF),UC(0xD6),_______,
206 MO(_GR_S),UC(0xC6),UC(0xD4), UC(0xC7),UC(0x152),_______, _______, UC(0xDB),UC(0xAB),UC(0xBB),UC(0xCE),MO(_GR_S),
207 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
208),
77e54e34
LS
209
210
211/* Adjust Layer (Gr + Num)
212 * ,-----------------------------------------------------------------------------------.
213 * | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 |
214 * |------+-------------+------+------+------+------+------+------+------+------+------|
215 * | | |Prntscr| ESC |VOLUP | PLAY | PREV |QWERTY|COLEMAK|PLOVER| | |
216 * |------+-------------+------+------+------+------+------+------+------+------+------|
217 * | | |BACKLIT| INS |VOLDWN| MUTE | NEXT | WIND |LINUX | OSX | | |
218 * |------+-------------+------+------+------+------+------+------+------+------+------|
219 * | | | | | | | | | | | | |
220 * `-----------------------------------------------------------------------------------'
221 */
ade22f8e 222
26eef35f
JY
223[_ADJ] = LAYOUT_planck_grid(
224 KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12 ,
225 XXXXXXX, XXXXXXX, KC_PSCR, KC_ESC, KC_VOLU, KC_MPLY, KC_MPRV, QWERTY, COLEMAK, PLOVER, XXXXXXX, XXXXXXX,
226 XXXXXXX, XXXXXXX, BL_STEP, KC_INS, KC_VOLD, KC_MUTE, KC_MNXT, WINDOWS, LINUX, OSX, XXXXXXX, XXXXXXX,
227 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
228),
77e54e34
LS
229
230
231/* Navigation
232 * ,-----------------------------------------------------------------------------------.
233 * | | | BTN3 | BTN2 | BTN1 | | ACL0 | HOME | PGDN | PGUP | END | Bksp |
234 * |------+------+------+------+------+------+------+------+------+------+------+------|
235 * | |MSLEFT| MSDN | MSUP |MSRGHT| | ACL1 | LEFT | DOWN | UP | RGHT |Enter |
236 * |------+------+------+------+------+------+------+------+------+------+------+------|
237 * | |WHLEFT| WHDN | WHUP |WHRGHT| | ACL2 |C-LEFT|C-PGDN|C-PGUP|C-RGHT|Enter |
238 * |------+------+------+------+------+------+------+------+------+------+------+------|
239 * | | | | | | _ |Space | ACL0 | ACL1 | ACL2 | |TGLNAV|
240 * `-----------------------------------------------------------------------------------'
241 */
ade22f8e 242
26eef35f
JY
243[_NAV] = LAYOUT_planck_grid(
244 XXXXXXX, XXXXXXX, KC_BTN3, KC_BTN2, KC_BTN1, XXXXXXX, KC_ACL0, KC_HOME, KC_PGDN, KC_PGUP, KC_END, KC_BSPC,
245 XXXXXXX, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, XXXXXXX, KC_ACL1, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT,KC_ENT ,
246 XXXXXXX, KC_WH_L, KC_WH_D, KC_WH_U, KC_WH_R, XXXXXXX, KC_ACL2, LCTL(KC_LEFT), LCTL(KC_PGDN), LCTL(KC_PGUP), LCTL(KC_RIGHT), KC_ENT ,
247 _______, _______, _______, _______, _______, _______, _______, KC_ACL0, KC_ACL1, KC_ACL2, _______, _______
248),
77e54e34
LS
249
250/* Plover Layer
251 * ,-----------------------------------------------------------------------------------.
252 * | | S | T | P | H | * | * | F | P | L | T | D |
253 * |------+------+------+------+------+------+------+------+------+------+------+------|
254 * |TogOut| S | K | W | R | * | * | R | B | G | S | Z |
255 * |------+------+------+------+------+------+------+------+------+------+------+------|
256 * | # | # | # | # | # | # | # | # | # | # | # | # |
257 * |------+------+------+------+------+------+------+------+------+------+------+------|
258 * | Exit | | | # | A | O | E | U | | | | |
259 * `-----------------------------------------------------------------------------------'
260 */
261
26eef35f
JY
262[_PLOVER] = LAYOUT_planck_grid(
263 XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC,
264 XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
265 KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 ,
266 EXT_PLV, XXXXXXX, XXXXXXX, KC_1, KC_C, KC_V, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
267)
77e54e34
LS
268
269
270};
271
77e54e34
LS
272void matrix_init_user(){
273 set_unicode_input_mode(UC_LNX);
274}
275
276
277const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
278{
279 switch(id) {
280 case M_ALT_HASH:
281 return MACRO_TAP_SHFT_KEY_HOLD_MOD(record, 3, LALT);
282 case M_GR_DASH:
283 {
284 const macro_t* macro = MACRO_TAP_HOLD_LAYER(record, MACRO(T(MINS)), _GR);
285 update_tri_layer(_NUM, _GR, _ADJ);
286 return macro;
287 }
288 case M_SYM_LPRN:
289 return MACRO_TAP_SHFT_KEY_HOLD_LAYER(record, 9, _SYM);
290 case M_NAV_UNDS:
291 return MACRO_TAP_SHFT_KEY_HOLD_LAYER(record, MINS, _NAV);
292 case M_NUM_RPRN:
293 {
294 const macro_t* macro = MACRO_TAP_SHFT_KEY_HOLD_LAYER(record, 0, _NUM);
295 update_tri_layer(_NUM, _GR, _ADJ);
296 return macro;
297 }
298 case M_CTRL_DLR:
299 return MACRO_TAP_SHFT_KEY_HOLD_MOD(record, 4, LCTL);
300 case M_LCBR_ENT:
301 return MACRODOWN(I(10), D(LSFT), T(LBRC), U(LSFT), T(ENT), END);
302 case M_PLOVER:
303 if (record->event.pressed) {
304 layer_and(0);
305 layer_on(_PLOVER);
306 default_layer_set(_PLOVER);
ade22f8e 307
77e54e34
LS
308 // Starts plover
309 return MACRO(I(10), D(E), D(R), D(F), D(V), D(I), D(K), U(E), U(R), U(F), U(V), U(I), U(K), END);
310 }
ade22f8e 311 break;
77e54e34
LS
312 case M_EXT_PLV:
313 if (!record->event.pressed) {
314 layer_off(_PLOVER);
315 default_layer_set(_COLEMAK);
ade22f8e 316
77e54e34
LS
317 //Pauses plover
318 return MACRO(I(10), D(E), D(R), D(F), D(V), D(Y), D(U), U(E), U(R), U(F), U(V), U(Y), U(U), END);
319 }
320 break;
321 case M_WINDOWS:
322 set_unicode_input_mode(UC_WIN);
323 break;
324 case M_LINUX:
325 set_unicode_input_mode(UC_LNX);
326 break;
327 case M_OSX:
328 set_unicode_input_mode(UC_OSX);
329 break;
330 case M_FUNCTION:
331 if (record->event.pressed) {
332 SEND_STRING("function");
333 }
334 break;
335 case M_THEN:
336 if (record->event.pressed) {
337 SEND_STRING("then");
338 }
339 break;
340 case M_CATCH:
341 if (record->event.pressed) {
342 SEND_STRING("catch");
343 }
344 break;
345 }
346 return MACRO_NONE;
347};