Merge branch 'overlays'
[tmk_keyboard.git] / keyboard / hhkb / keymap.c
1 /*
2 Copyright 2011,2012,2013 Jun Wako <wakojun@gmail.com>
3
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18 /*
19 * Keymap for PFU HHKB Pro
20 */
21 #include <stdint.h>
22 #include <stdbool.h>
23 #include <avr/pgmspace.h>
24 #include "keycode.h"
25 #include "action.h"
26 #include "action_macro.h"
27 #include "report.h"
28 #include "host.h"
29 #include "debug.h"
30 #include "keymap.h"
31
32
33 #define KEYMAP( \
34 K31, K30, K00, K10, K11, K20, K21, K40, K41, K60, K61, K70, K71, K50, K51, \
35 K32, K01, K02, K13, K12, K23, K22, K42, K43, K62, K63, K73, K72, K52, \
36 K33, K04, K03, K14, K15, K24, K25, K45, K44, K65, K64, K74, K53, \
37 K34, K05, K06, K07, K16, K17, K26, K46, K66, K76, K75, K55, K54, \
38 K35, K36, K37, K57, K56 \
39 ) \
40 { \
41 { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07 }, \
42 { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17 }, \
43 { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_NO }, \
44 { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_##K35, KC_##K36, KC_##K37 }, \
45 { KC_##K40, KC_##K41, KC_##K42, KC_##K43, KC_##K44, KC_##K45, KC_##K46, KC_NO }, \
46 { KC_##K50, KC_##K51, KC_##K52, KC_##K53, KC_##K54, KC_##K55, KC_##K56, KC_##K57 }, \
47 { KC_##K60, KC_##K61, KC_##K62, KC_##K63, KC_##K64, KC_##K65, KC_##K66, KC_NO }, \
48 { KC_##K70, KC_##K71, KC_##K72, KC_##K73, KC_##K74, KC_##K75, KC_##K76, KC_NO } \
49 }
50
51
52 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
53 /* Layer 0: Default Layer
54 * ,-----------------------------------------------------------.
55 * |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
56 * |-----------------------------------------------------------|
57 * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]|Backs|
58 * |-----------------------------------------------------------|
59 * |Contro| A| S| D| F| G| H| J| K| L|Fn3| '|Fn4 |
60 * |-----------------------------------------------------------|
61 * |Fn5 | Z| X| C| V| B| N| M| ,| .|Fn2|Shift |Fn1|
62 * `-----------------------------------------------------------'
63 * |Gui|Alt | Fn6 |Alt |Fn7|
64 * `-------------------------------------------'
65 */
66 KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \
67 TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSPC, \
68 LCTL,A, S, D, F, G, H, J, K, L, FN3, QUOT,FN4, \
69 FN5,Z, X, C, V, B, N, M, COMM,DOT, FN2, RSFT,FN1, \
70 LGUI,LALT, FN6, RALT,FN7),
71
72 /* Layer 1: HHKB mode (HHKB Fn)
73 * ,-----------------------------------------------------------.
74 * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
75 * |-----------------------------------------------------------|
76 * |Caps | | | | | | | |Psc|Slk|Pus|Up | |Backs|
77 * |-----------------------------------------------------------|
78 * |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
79 * |-----------------------------------------------------------|
80 * |Shift | | | | | | +| -|End|PgD|Dow|Shift | |
81 * `-----------------------------------------------------------'
82 * |Gui|Alt | Space |Alt |Gui|
83 * `-------------------------------------------'
84 */
85 KEYMAP(GRV, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
86 CAPS,NO, NO, NO, NO, NO, NO, NO, PSCR,SLCK,PAUS, UP, NO, BSPC, \
87 LCTL,VOLD,VOLU,MUTE,NO, NO, PAST,PSLS,HOME,PGUP,LEFT,RGHT,ENT, \
88 LSFT,NO, NO, NO, NO, NO, PPLS,PMNS,END, PGDN,DOWN,RSFT,TRNS, \
89 LGUI,LALT, SPC, RALT,RGUI),
90
91 /* Layer 2: Vi mode (Slash)
92 * ,-----------------------------------------------------------.
93 * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
94 * |-----------------------------------------------------------|
95 * |Tab |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd| | | |Backs|
96 * |-----------------------------------------------------------|
97 * |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | |Return |
98 * |-----------------------------------------------------------|
99 * |Shift | | | | | |Hom|PgD|PgUlEnd|Fn0|Shift | |
100 * `-----------------------------------------------------------'
101 * |Gui|Alt | Space |Alt |Gui|
102 * `-------------------------------------------'
103 */
104 KEYMAP(GRV, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
105 TAB, HOME,PGDN,UP, PGUP,END, HOME,PGDN,PGUP,END, NO, NO, NO, BSPC, \
106 LCTL,NO, LEFT,DOWN,RGHT,NO, LEFT,DOWN,UP, RGHT,NO, NO, ENT, \
107 LSFT,NO, NO, NO, NO, NO, HOME,PGDN,PGUP,END, TRNS,RSFT,NO, \
108 LGUI,LALT, SPC, RALT,RGUI),
109
110 /* Layer 3: Mouse mode (Semicolon)
111 * ,-----------------------------------------------------------.
112 * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
113 * |-----------------------------------------------------------|
114 * |Tab | | | | | |MwL|MwD|MwU|MwR| | | |Backs|
115 * |-----------------------------------------------------------|
116 * |Contro| | | | | |McL|McD|McU|McR|Fn0| |Return |
117 * |-----------------------------------------------------------|
118 * |Shift | | | | |Mb3|Mb2|Mb1|Mb4|Mb5| |Shift | |
119 * `-----------------------------------------------------------'
120 * |Gui |Alt | Mb1 |Alt |Fn0|
121 * `--------------------------------------------'
122 * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
123 */
124 KEYMAP(GRV, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
125 TAB, NO, NO, NO, NO, NO, WH_L,WH_D,WH_U,WH_R,NO, NO, NO, BSPC, \
126 LCTL,NO, ACL0,ACL1,ACL2,NO, MS_L,MS_D,MS_U,MS_R,TRNS,QUOT,ENT, \
127 LSFT,NO, NO, NO, NO, BTN3,BTN2,BTN1,BTN4,BTN5,SLSH,RSFT,NO, \
128 LGUI,LALT, BTN1, RALT,TRNS),
129
130 /* Layer 4: Matias half-qwerty keyboard style (Space)
131 * ,-----------------------------------------------------------.
132 * | -| 0| 9| 8| 7| 6| 5| 4| 3| 2| 1| | | |Esc|
133 * |-----------------------------------------------------------|
134 * |Backs| P| O| I| U| Y| T| R| E| W| Q| | |Tab |
135 * |-----------------------------------------------------------|
136 * |Contro| ;| L| K| J| H| G| F| D| S| A|Con|Control |
137 * |-----------------------------------------------------------|
138 * |Shift | /| .| ,| M| N| B| V| C| X| Z|Shift | |
139 * `-----------------------------------------------------------'
140 * |Gui |Alt | Fn0 |Alt |Gui|
141 * `--------------------------------------------'
142 */
143 KEYMAP(MINS,0, 9, 8, 7, 6, 5, 4, 3, 2, 1, NO, NO, NO, ESC, \
144 BSPC,P, O, I, U, Y, T, R, E, W, Q, NO, NO, TAB, \
145 LCTL,SCLN,L, K, J, H, G, F, D, S, A, RCTL,RCTL, \
146 LSFT,SLSH,DOT, COMM,M, N, B, V, C, X, Z, RSFT,NO, \
147 LGUI,LALT, TRNS, RALT,RGUI),
148
149 /* Layer5: another Mouse mode (Space)
150 * ,-----------------------------------------------------------.
151 * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
152 * |-----------------------------------------------------------|
153 * |Tab | | | | | |MwL|MwD|MwU|MwR| | | |Backs|
154 * |-----------------------------------------------------------|
155 * |Contro| | | | | |McL|McD|McU|McR|Fn0| |Return |
156 * |-----------------------------------------------------------|
157 * |Shift | | | | |Mb3|Mb2|Mb1|Mb4|Mb5| |Shift | |
158 * `-----------------------------------------------------------'
159 * |Gui |Alt | Fn0 |Alt |Fn0|
160 * `--------------------------------------------'
161 * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
162 */
163 KEYMAP(ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
164 TAB, NO, NO, NO, NO, NO, WH_L,WH_D,WH_U,WH_R,NO, NO, NO, BSPC, \
165 LCTL,NO, ACL0,ACL1,ACL2,NO, MS_L,MS_D,MS_U,MS_R,NO, NO, ENT, \
166 LSFT,NO, NO, NO, NO, BTN3,BTN2,BTN1,BTN4,BTN5,NO, RSFT,NO, \
167 LGUI,LALT, TRNS, RALT,RGUI),
168 };
169
170
171
172 /* id for user defined functions */
173 enum function_id {
174 LSHIFT_LPAREN,
175 RSHIFT_RPAREN,
176 };
177
178 enum macro_id {
179 LSHIFT_PAREN,
180 RSHIFT_PAREN,
181 HELLO,
182 };
183
184
185 /*
186 * Fn action definition
187 */
188 static const uint16_t PROGMEM fn_actions[] = {
189 [0] = ACTION_DEFAULT_LAYER, // Default layer(not used)
190 // [1] = ACTION_KEYMAP(1), // HHKB layer
191 [1] = ACTION_KEYMAP_TAP_TOGGLE(1), // HHKB layer(toggle with 5 taps)
192 [2] = ACTION_KEYMAP_TAP_KEY(2, KC_SLASH), // Cursor layer with Slash*
193 [3] = ACTION_KEYMAP_TAP_KEY(3, KC_SCLN), // Mousekey layer with Semicolon*
194 [4] = ACTION_RMOD_TAP_KEY(KC_RCTL, KC_ENT), // RControl with tap Enter*
195 [5] = ACTION_LMOD_ONESHOT(KC_LSFT), // Oneshot Shift*
196 // [6] = ACTION_KEYMAP_TAP_KEY(4, KC_SPC), // Half-qwerty layer with Space
197 [6] = ACTION_KEYMAP_TAP_KEY(5, KC_SPC), // Mousekey layer with Space
198 // [7] = ACTION_KEYMAP(3), // Mousekey layer
199 [7] = ACTION_KEYMAP_TOGGLE(3), // Mousekey layer(toggle)
200
201 // [8] = ACTION_LMOD_TAP_KEY(KC_LCTL, KC_BSPC), // LControl with tap Backspace
202 // [9] = ACTION_LMOD_TAP_KEY(KC_LCTL, KC_ESC), // LControl with tap Esc
203 // [11] = ACTION_FUNCTION_TAP(LSHIFT_LPAREN), // Function: LShift with tap '('
204 // [12] = ACTION_FUNCTION_TAP(RSHIFT_RPAREN), // Function: RShift with tap ')'
205 // [13] = ACTION_MACRO_TAP(LSHIFT_PAREN), // Macro: LShift with tap '('
206 // [14] = ACTION_MACRO_TAP(RSHIFT_PAREN), // Macro: RShift with tap ')'
207 // [15] = ACTION_MACRO(HELLO), // Macro: say hello
208 };
209
210
211 /*
212 * Macro definition
213 */
214 const prog_macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
215 {
216 keyevent_t event = record->event;
217 tap_t tap = record->tap;
218
219 switch (id) {
220 case LSHIFT_PAREN:
221 if (tap.count > 0 && !tap.interrupted) {
222 return (event.pressed ?
223 MACRO( MD(LSHIFT), D(9), U(9), MU(LSHIFT), END ) : MACRO_NONE);
224 } else {
225 return (event.pressed ?
226 MACRO( MD(LSHIFT), END ) : MACRO( MU(LSHIFT), END ) );
227 }
228 case RSHIFT_PAREN:
229 if (tap.count > 0 && !tap.interrupted) {
230 return (event.pressed ?
231 MACRO( MD(RSHIFT), D(0), U(0), MU(RSHIFT), END ) : MACRO_NONE);
232 } else {
233 return (event.pressed ?
234 MACRO( MD(RSHIFT), END ) : MACRO( MU(RSHIFT), END ) );
235 }
236 case HELLO:
237 return (event.pressed ?
238 MACRO( I(0), T(H), T(E), T(L), T(L), W(255), T(O), END ) :
239 MACRO_NONE );
240 }
241 return MACRO_NONE;
242 }
243
244
245
246 /*
247 * user defined action function
248 */
249 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
250 {
251 keyevent_t event = record->event;
252 tap_t tap = record->tap;
253
254 switch (id) {
255 case LSHIFT_LPAREN:
256 // LShft + tap '('
257 // NOTE: cant use register_code to avoid conflicting with magic key bind
258 if (event.pressed) {
259 if (tap.count == 0 || tap.interrupted) {
260 add_mods(MOD_BIT(KC_LSHIFT));
261 } else {
262 host_add_mods(MOD_BIT(KC_LSHIFT));
263 host_add_key(KC_9);
264 host_send_keyboard_report();
265 host_del_mods(MOD_BIT(KC_LSHIFT));
266 host_del_key(KC_9);
267 host_send_keyboard_report();
268 }
269 } else {
270 if (tap.count == 0 || tap.interrupted) {
271 del_mods(MOD_BIT(KC_LSHIFT));
272 }
273 }
274 break;
275 case RSHIFT_RPAREN:
276 // RShift + tap ')'
277 if (event.pressed) {
278 if (tap.count == 0 || tap.interrupted) {
279 add_mods(MOD_BIT(KC_RSHIFT));
280 } else {
281 host_add_mods(MOD_BIT(KC_RSHIFT));
282 host_add_key(KC_0);
283 host_send_keyboard_report();
284 host_del_mods(MOD_BIT(KC_RSHIFT));
285 host_del_key(KC_0);
286 host_send_keyboard_report();
287 }
288 } else {
289 if (tap.count == 0 || tap.interrupted) {
290 del_mods(MOD_BIT(KC_RSHIFT));
291 }
292 }
293 break;
294 }
295 }
296
297
298
299 /* translates key to keycode */
300 uint8_t keymap_key_to_keycode(uint8_t layer, key_t key)
301 {
302 return pgm_read_byte(&keymaps[(layer)][(key.row)][(key.col)]);
303 }
304
305 /* translates Fn index to action */
306 action_t keymap_fn_to_action(uint8_t keycode)
307 {
308 action_t action;
309 if (FN_INDEX(keycode) < sizeof(fn_actions) / sizeof(fn_actions[0])) {
310 action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]);
311 } else {
312 action.code = ACTION_NO;
313 }
314 return action;
315 }
Imprint / Impressum