summaryrefslogtreecommitdiff
path: root/keyboards/keyboardio/atreus/keymaps/slotthe/keymap.c
blob: 6188f14ab97d8ea34b74585738655e39fb4e0297 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
/* © 2023  Tony Zorman <soliditsallgood@mailbox.org> (@slotThe)
 *
 * 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 3 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 QMK_KEYBOARD_H

// NOTE: `M-x occur RET /// RET' gives a good overview.

/// General macros

#define LSPR_SC  LGUI_T(KC_SCLN)
#define LALT_BR  LALT_T(KC_LBRC)
#define LSFT_INS LSFT(KC_INS)
#define OSMSFT   OSM(MOD_LSFT)
#define Z_SFT    LSFT_T(KC_Z)
#define ZE_SFT   LSFT_T(KC_0)
#define SL_SFT   RSFT_T(KC_SLSH)
#define RETSPR   LGUI_T(KC_ENT)

/// Tap dance declarations

// So far, tap dances do different things on
//
//   - a single press,
//   - a double press,
//   - when held,
//
// so expect this many keys as comments.
enum tap_dances {
  ALT_BR,  // [ ] lalt  (also works shifted, which gets us { and } for free)
  CTL_PR,  // ( ) lctl
  SFT_CI,  // ^ ^ lsft  (working around LSFT_T not being able to output shifted keys)
  SFT_EX,  // ! ! lsft  (ditto)
};

#define CTLPAR TD(CTL_PR)
#define ALTBRC TD(ALT_BR)
#define SFTCRC TD(SFT_CI)
#define SFTEXL TD(SFT_EX)

/// Macro declarations

enum custom_keycodes {
  // ->              <-    =<<   >>=   <*>  <*    *>    <$>   <&>   <|>   =>     ::
  RARR = SAFE_RANGE, LARR, LBND, RBND, APP, RAPP, LAPP, FMAP, PAMF, AALT, IMPLS, DCOL,
};

/// Key overrides

const key_override_t **key_overrides = (const key_override_t *[]){
  &ko_make_basic(MOD_MASK_SHIFT, KC_BSPC, KC_DEL), // S-BSP ≡ DEL
  // Emacs got me used to these, so let's convince other programs that
  // we are in fact sending the correct keys.
  &ko_make_basic(MOD_MASK_CTRL, KC_I, KC_TAB),     // C-i ≡ Tab
  &ko_make_basic(MOD_MASK_CTRL, KC_M, KC_ENT),     // C-m ≡ Return
  NULL // Null terminate the array of overrides
};

/// Layers

enum layer_names { _COLEMAK_DH, _LOWER, _RAISE, _ADJUST };

#define LOWER    MO(_LOWER)
#define RAISE    MO(_RAISE)
#define ADJUST   MO(_ADJUST)
#define D_RAISE  LT(_RAISE, KC_DOT)

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  /* Colemak base layer
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-----.
     |  Q  |  W  |  F  |  P  |  B  |           |  J  |  L  |  U  |  Y  | ;+S |
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-----.
     |  A  |  R  |  S  |  T  |  G  |           |  M  |  N  |  E  |  I  |  O  |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
     | S+Z |  X  |  C  |  D  |  V  | ARP | REP |  K  |  H  |  ,  |  .  | S+/ |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
     | ESC | TAB | SPR | L1  | SPC | A[] | BSC | C() | L2  |  -  |  '  | RET |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
  */
  [_COLEMAK_DH] = LAYOUT(
    KC_Q,    KC_W,    KC_F,    KC_P,    KC_B,                      KC_J,    KC_L,    KC_U,    KC_Y,    LSPR_SC,
    KC_A,    KC_R,    KC_S,    KC_T,    KC_G,                      KC_M,    KC_N,    KC_E,    KC_I,    KC_O,
    Z_SFT,   KC_X,    KC_C,    KC_D,    KC_V,    QK_AREP, QK_REP,  KC_K,    KC_H,    KC_COMM, D_RAISE, SL_SFT,
    KC_ESC,  KC_TAB,  KC_LGUI, LOWER,   KC_SPC,  ALTBRC,  KC_BSPC, CTLPAR,  RAISE,   KC_MINS, KC_QUOT, KC_ENT),

  /* Layer 1 (LOWER)
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-------.
     |  &  | *>  | >>= | <&> |     |           |  =  |  +  |  *  |  -  | RET+M |
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-------.
     | ::  | =>  | =<< | <|> |  @  |           | LFT |  UP | DWN | RGT |   \   |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-------.
     | !+S | <*  | <*> | <$> | <-  |     | MEN |  -> |  $  |  #  |  %  |  ^+S  |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-------.
     |     |     |     |     |     |     |     |     | L3  | ALT |     |  S-I  |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-------.
  */
  [_LOWER] = LAYOUT(
    KC_AMPR, RAPP,    RBND,    PAMF,    _______,                   KC_EQL,  KC_PLUS, KC_ASTR, KC_MINS, RETSPR,
    DCOL,    IMPLS,   LBND,    AALT,    KC_AT,                     KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_BSLS,
    SFTEXL,  LAPP,    APP,     FMAP,    LARR,    _______, KC_APP,  RARR,    KC_DLR,  KC_HASH, KC_PERC, SFTCRC,
    _______, _______, _______, _______, _______, _______, _______, _______, ADJUST,  KC_LALT, _______, LSFT_INS),

  /* Layer 2 (RAISE)
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-----.
     |     |  7  |  8  |  9  |     |           |     |  +  |  *  |  -  |     |
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-----.
     |  :  |  4  |  5  |  6  |  =  |           |  &  |  `  |  _  |  '  |  "  |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
     | 0+S |  1  |  2  |  3  |     |     |     |     |  !  |  #  |  %  | ^+S |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
     |     |     |     | L3  |     |     |     |     |     |     |     |     |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
  */
  [_RAISE] = LAYOUT(
    KC_DOT,  KC_7,    KC_8,    KC_9,    _______,                   _______, KC_PLUS, KC_ASTR, KC_MINS, _______,
    KC_COLN, KC_4,    KC_5,    KC_6,    KC_EQL,                    KC_AMPR, KC_GRV,  KC_UNDS, KC_QUOT, KC_DQT,
    ZE_SFT,  KC_1,    KC_2,    KC_3,    _______, _______, _______, _______, KC_EXLM, KC_HASH, KC_PERC, SFTCRC,
    _______, _______, _______, ADJUST,  _______, _______, _______, _______, _______, _______, _______, _______),

  /* Layer 3 (ADJUST)
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-----.
     |     |     |     |     |     |           |     | F7  | F8  | F9  | F10 |
     .-----.-----.-----.-----.-----.           .-----.-----.-----.-----.-----.
     |     |     |     |     |     |           |     | F4  | F5  | F6  | F11 |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
     |     |     |     |     |     |     |     |     | F1  | F2  | F3  | F12 |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
     |     |     |     |     |     |     |     |     |     |     |     |     |
     .-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.-----.
  */
  [_ADJUST] = LAYOUT(
    _______, _______, _______, _______, AC_TOGG,                   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,
    _______, _______, _______, _______, _______,                   _______, KC_F4,   KC_F5,   KC_F6,   KC_F11,
    _______, _______, _______, _______, _______, _______, _______, _______, KC_F1,   KC_F2,   KC_F3,   KC_F12,
    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______)
};

/// Macro definitions

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  switch (keycode) {
  case RARR:
    if (record->event.pressed) SEND_STRING("->");  break;
  case LARR:
    if (record->event.pressed) SEND_STRING("<-");  break;
  case LBND:
    if (record->event.pressed) SEND_STRING("=<<"); break;
  case RBND:
    if (record->event.pressed) SEND_STRING(">>="); break;
  case APP:
    if (record->event.pressed) SEND_STRING("<*>"); break;
  case RAPP:
    if (record->event.pressed) SEND_STRING("*>");  break;
  case LAPP:
    if (record->event.pressed) SEND_STRING("<*");  break;
  case FMAP:
    if (record->event.pressed) SEND_STRING("<$>"); break;
  case PAMF:
    if (record->event.pressed) SEND_STRING("<&>"); break;
  case AALT:
    if (record->event.pressed) SEND_STRING("<|>"); break;
  case IMPLS:
    if (record->event.pressed) SEND_STRING("=>");  break;
  case DCOL:
    if (record->event.pressed) SEND_STRING("::");  break;
  }
  return true;
};

//// Tap dance definitions

// Heavily inspired by:
//
//     https://docs.qmk.fm/?ref=blog.splitkb.com#/feature_tap_dance?id=example-4

typedef enum {
  TD_NONE,
  TD_UNKNOWN,
  TD_SINGLE_TAP,
  TD_SINGLE_HOLD,
  TD_DOUBLE_TAP,
} td_state_t;

typedef struct {
  bool is_press_action;
  td_state_t state;
} td_tap_t;

// Return an integer that corresponds to what kind of tap dance should
// be executed.
//
// Interrupted: If the state of a dance is "interrupted", that means
//  that another key has been hit under the tapping term.
//
// Pressed: Whether or not the key is still being pressed. If this value
//  is true, that means the tapping term has ended, but the key is still
//  being pressed down. This generally means the key is being "held".
td_state_t cur_dance(tap_dance_state_t *state) {
  if (state->count == 1) {
    if (state->pressed)         return TD_SINGLE_HOLD;
    else                        return TD_SINGLE_TAP;
  } else if (state->count == 2) return TD_DOUBLE_TAP;
  else                          return TD_UNKNOWN;
}

//// ALT_BR

static td_tap_t alt_br_state = {
  .is_press_action = true,
  .state = TD_NONE
};

void lalt_br_finished(tap_dance_state_t *state, void *user_data) {
  alt_br_state.state = cur_dance(state);
  switch (alt_br_state.state) {
  case TD_SINGLE_TAP:  register_code(KC_LBRC); break;
  case TD_SINGLE_HOLD: register_code(KC_LALT); break;
  case TD_DOUBLE_TAP:  register_code(KC_RBRC); break;
  default:             break;
  }
}

void lalt_br_reset(tap_dance_state_t *state, void *user_data) {
  switch (alt_br_state.state) {
  case TD_SINGLE_TAP:  unregister_code(KC_LBRC); break;
  case TD_SINGLE_HOLD: unregister_code(KC_LALT); break;
  case TD_DOUBLE_TAP:  unregister_code(KC_RBRC); break;
  default:             break;
  }
  alt_br_state.state = TD_NONE;
}

//// LCTL_PR

static td_tap_t lctl_pr_state = {
  .is_press_action = true,
  .state = TD_NONE
};

void lctl_pr_finished(tap_dance_state_t *state, void *user_data) {
  lctl_pr_state.state = cur_dance(state);
  switch (lctl_pr_state.state) {
  case TD_SINGLE_TAP:  register_code16(KC_LPRN); break;
  case TD_SINGLE_HOLD: register_code(KC_LCTL);   break;
  case TD_DOUBLE_TAP:  register_code16(KC_RPRN); break;
  default:             break;
  }
}

void lctl_pr_reset(tap_dance_state_t *state, void *user_data) {
  switch (lctl_pr_state.state) {
  case TD_SINGLE_TAP:  unregister_code16(KC_LPRN); break;
  case TD_SINGLE_HOLD: unregister_code(KC_LCTL);   break;
  case TD_DOUBLE_TAP:  unregister_code16(KC_RPRN); break;
  default:             break;
  }
  lctl_pr_state.state = TD_NONE;
}

//// SFT_CI

static td_tap_t lsft_ci_state = {
  .is_press_action = true,
  .state = TD_NONE
};

void lsft_ci_finished(tap_dance_state_t *state, void *user_data) {
  lsft_ci_state.state = cur_dance(state);
  switch (lsft_ci_state.state) {
  case TD_SINGLE_TAP:  register_code16(KC_CIRC); break;
  case TD_SINGLE_HOLD: register_code(KC_LSFT);   break;
  default:             break;
  }
}

void lsft_ci_reset(tap_dance_state_t *state, void *user_data) {
  switch (lsft_ci_state.state) {
  case TD_SINGLE_TAP:  unregister_code16(KC_CIRC); break;
  case TD_SINGLE_HOLD: unregister_code(KC_LSFT);   break;
  default:             break;
  }
  lsft_ci_state.state = TD_NONE;
}

//// SFT_EX

static td_tap_t lsft_ex_state = {
  .is_press_action = true,
  .state = TD_NONE
};

void lsft_ex_finished(tap_dance_state_t *state, void *user_data) {
  lsft_ex_state.state = cur_dance(state);
  switch (lsft_ex_state.state) {
  case TD_SINGLE_TAP:  register_code16(KC_EXLM); break;
  case TD_SINGLE_HOLD: register_code(KC_LSFT);   break;
  default:             break;
  }
}

void lsft_ex_reset(tap_dance_state_t *state, void *user_data) {
  switch (lsft_ex_state.state) {
  case TD_SINGLE_TAP:  unregister_code16(KC_EXLM); break;
  case TD_SINGLE_HOLD: unregister_code(KC_LSFT);   break;
  default:             break;
  }
  lsft_ex_state.state = TD_NONE;
}

//// Actually define the tap-dance actions

tap_dance_action_t tap_dance_actions[] = {
  [ALT_BR] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, lalt_br_finished, lalt_br_reset),
  [CTL_PR] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, lctl_pr_finished, lctl_pr_reset),
  [SFT_CI] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, lsft_ci_finished, lsft_ci_reset),
  [SFT_EX] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, lsft_ex_finished, lsft_ex_reset),
};