keyboards/planck/keymaps/cbbrowne/keymap.c

   1 #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
   2 #include "planck.h"
   3 #ifdef BACKLIGHT_ENABLE
   4 #include "backlight.h"
   5 #endif
   6 #include "config.h"
   7 #include "quantum.h"
   8 #include "version.h"
   9
  10 /* Each layer is given a name to aid in readability, which is then
  11    used in the keymap matrix below.  The underscores do not denote
  12    anything - you can have a layer called STUFF or any other name.
  13
  14    Layer names don't all need to be of the same length, obviously, and
  15    you could also skip them entirely and just use numbers, though that
  16    means needing to manage the numbers.
  17
  18    It is preferable to keep the symbols short so that a line worth of
  19    key mappings fits compactly onto a line of code. */
  20
  21 /* This was originally based on planck/keymaps/default/default.c, and
  22    then cbbrowne has revised things */
  23
  24 /* Things I did not like about the default mapping
  25
  26    - I found control too hard to get to.  I use it more than Tab, so
  27      switched it there.
  28    - Having dash on [lower-j] is a bit nonintuitive, but may be OK
  29    - I'll bet I should switch ESC/TAB
  30    - I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
  31      and shift ESC off the first column so KC_LCTL and KC_LALT can
  32      be on the first column.
  33    - I needed to swap ' and ENTER
  34
  35    - All of the above are done :-)
  36
  37    - Dropped out support for Dvorak and friends.  They aren't
  38      improvements to me
  39 */
  40
  41
  42 /* Some interesting things implemented
  43
  44    - There is a macro that writes out "cbbrowne" just to show that I
  45      could
  46    - There is a (somewhat cruddy) linear congruential random number
  47      generator.
  48      - I seed it somewhat with clock info to make it look more random
  49    - There are two macros that use the random number generators
  50      - one, M_RANDDIGIT, generates a random digit based on state
  51        of the random number generator
  52      - the other, M_RANDLETTER, generates a random letter based on state
  53        of the random number generator
  54      - in both, note the use of register_code()/unregister_code()
  55        to indicate the desired key
  56    - I do indeed want a sweet number pad!
  57 */
  58
  59 /* Other things to do...
  60
  61    - Need to think about what zsh and readline actions I use lots
  62    - Ought to ensure that Control-Alt-Delete is convenient enough
  63    - How about Alt-F1 thru Alt-F8?  Not yet...
  64    - What's the keystroke to get from X to console these days?
  65    - A layer for doing console switching would not be a bad idea
  66
  67    - I'm messing with jeremy-dev's keymap that shifts everything
  68      outwards.  Gotta figure out how to make it sensible...
  69 */
  70
  71 enum layers {
  72   _QWERTY = 0,  /* Qwerty mapping */
  73   _LOWER, /* Lower layer, where top line has symbols !@#$%^&*() */
  74   _RAISE, /* Raised layer, where top line has digits 1234567890 */
  75   _KEYPAD, /* Key pad */
  76   _ADJUST, /* Special Adjust layer coming via tri-placement */
  77
  78 };
  79
  80 enum my_keycodes {
  81   MY_ABVE = SAFE_RANGE,
  82   MY_BELW,
  83   MY_TERM,
  84   MY_DEQL, // /=
  85   MY_MEQL, // *=
  86   MY_SEQL, // -=
  87   MY_PEQL, // +=
  88   MY_NEQL, // !=
  89   MY_LTGT, // <>
  90   MY_DPIP, // ||
  91   MY_DAMP, // &&
  92 };
  93
  94 enum macro_id {
  95   M_LED = 0,
  96   M_USERNAME,
  97   M_RANDDIGIT,
  98   M_RANDLETTER,
  99   M_VERSION,
 100   MACRO_UPPER,
 101   MACRO_LOWER,
 102 };
 103
 104 #define M_LOWER M(MACRO_LOWER)
 105 #define M_UPPER M(MACRO_UPPER)
 106 #define ROT_LED M(M_LED)   /* Rotate LED */
 107 #define QWERTY DF(_QWERTY)   /* Switch to QWERTY layout */
 108 #define KEYPAD DF(_KEYPAD)   /* Switch to keypad */
 109 #define USERNAME M(M_USERNAME) /* shortcut for username */
 110 #define RANDDIG M(M_RANDDIGIT)
 111 #define RANDALP M(M_RANDLETTER)
 112 #define CTLENTER MT(MOD_RCTL, KC_ENT)
 113 #define SHIFTQUOTE MT(MOD_RSFT, KC_QUOT)
 114 #define ALTRIGHT MT(MOD_LALT, KC_RGHT)
 115 #define MVERSION M(M_VERSION)
 116 #define ALTSLASH LALT(KC_SLSH)
 117
 118
 119 /* Note that Planck has dimensions 4 rows x 12 columns */
 120
 121 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 122 [_QWERTY] = { /* Qwerty */
 123   {KC_ESC,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
 124   {KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, CTLENTER},
 125   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, SHIFTQUOTE },
 126   {KC_TAB,  KC_LALT, ROT_LED, KC_LGUI, M_LOWER, KC_SPC,  KC_SPC,  M_UPPER, KC_LEFT, KC_DOWN, KC_UP,   ALTRIGHT}
 127   /* Note that KC_SPC is recorded TWICE, so that either matrix position can activate it */
 128 },
 129 [_RAISE] = { /* RAISE */
 130   {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC},
 131   {_______, KC_4,    KC_5,    KC_6,    _______, _______, _______,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
 132   {_______, KC_7,    KC_8,    KC_9,    _______, _______, _______,  QWERTY,  KEYPAD,  KEYPAD,  ALTSLASH,_______},
 133   {_______, KC_0, _______, _______, _______, _______, _______, _______, KC_PGDN, KC_HOME, KC_END,  KC_PGUP}
 134 },
 135 [_LOWER] = { /* LOWER */
 136   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
 137   {_______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
 138   {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  QWERTY,  KEYPAD,  KEYPAD, ALTSLASH,   _______},
 139   {_______, KEYPAD, _______, _______, _______, _______, _______, _______, KC_PGDN, KC_HOME,  KC_END, KC_PGUP}
 140     },
 141 [_KEYPAD] = { /* Key Pad */
 142   {KC_ESC,  USERNAME,    MVERSION,   KC_F10,   KC_F11,  KC_F12,   KC_PGUP, KC_KP_ENTER, KC_7, KC_8, KC_9, KC_BSPC},
 143   {KC_LCTL, RANDDIG,   KC_F5,   KC_F6,    KC_F7,   KC_F8,    KC_PGDN, KC_KP_MINUS, KC_4, KC_5, KC_6, KC_PIPE},
 144   {KC_LSFT, RANDALP,   KC_F1,   KC_F2,    KC_F3,   KC_F4,    KC_DEL,  KC_KP_PLUS,  KC_1, KC_2,  KC_3, KC_ENTER},
 145   {KC_TAB,  KC_LALT, ROT_LED, KC_LGUI,  M_LOWER,  KC_SPC,    KC_SPC,  QWERTY,   KC_LEFT, KC_DOWN, KC_UP,  KC_RIGHT}
 146 },
 147
 148 [_ADJUST] = { /* Adjustments - gonna shift the wild tools in here */
 149   {ROT_LED,USERNAME,MVERSION, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
 150   {_______, RANDDIG, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ },
 151   {_______, RANDALP, _______, _______, _______,   RESET,   RESET, _______, _______, _______, _______, _______ },
 152   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ }
 153 }
 154 };
 155
 156 /* This bit of logic seeds a wee linear congruential random number generator */
 157 /* lots of prime numbers everywhere... */
 158 static uint16_t random_value = 157;
 159
 160 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 161 {
 162   uint8_t clockbyte=0;
 163   clockbyte = TCNT1 % 256;
 164   uint8_t rval;
 165   // MACRODOWN only works in this function
 166   switch(id) {
 167   case M_LED:
 168     if (record->event.pressed) {
 169       register_code(KC_RSFT);
 170 #ifdef BACKLIGHT_ENABLE
 171       backlight_step();
 172 #endif
 173     } else {
 174       unregister_code(KC_RSFT);
 175     }
 176     break;
 177   case M_USERNAME:
 178     if (record->event.pressed) {
 179       SEND_STRING("cbbrowne");
 180     }
 181     break;
 182   case M_VERSION:
 183     if (record->event.pressed) {
 184       SEND_STRING(QMK_KEYBOARD "/" QMK_KEYMAP "@" QMK_VERSION "@" QMK_BUILDDATE);
 185     }
 186     break;
 187   case M_RANDDIGIT:
 188     /* Generate, based on random number generator, a keystroke for
 189        a numeric digit chosen at random */
 190     random_value = ((random_value + randadd) * randmul) % randmod;
 191     if (record->event.pressed) {
 192       /* Here, we mix the LCRNG with low bits from one of the system
 193          clocks via XOR in the theory that this may be more random
 194          than either separately */
 195       rval = (random_value ^ clockbyte) % 10;
 196       /* Note that KC_1 thru KC_0 are a contiguous range */
 197       register_code (KC_1 + rval);
 198       unregister_code (KC_1 + rval);
 199     }
 200     break;
 201   case M_RANDLETTER:
 202     /* Generate, based on random number generator, a keystroke for
 203        a letter chosen at random */
 204     /* Here, we mix the LCRNG with low bits from one of the system
 205        clocks via XOR in the theory that this may be more random
 206        than either separately */
 207     random_value = ((random_value + randadd) * randmul) % randmod;
 208     if (record->event.pressed) {
 209       rval = (random_value ^ clockbyte) % 26;
 210       register_code (KC_A + rval);
 211       unregister_code (KC_A + rval);
 212     }
 213     break;
 214   case MACRO_UPPER:
 215     if (record->event.pressed)
 216       {
 217         layer_on(_RAISE);
 218 #ifdef BACKLIGHT_BREATHING
 219         breathing_period_set(2);
 220         breathing_pulse();
 221 #endif
 222         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 223       }
 224     else
 225       {
 226         layer_off(_RAISE);
 227         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 228       }
 229     break;
 230   case MACRO_LOWER:
 231     if (record->event.pressed)
 232       {
 233         layer_on(_LOWER);
 234 #ifdef BACKLIGHT_BREATHING
 235         breathing_period_set(2);
 236         breathing_pulse();
 237 #endif
 238         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 239       }
 240     else
 241       {
 242         layer_off(_LOWER);
 243         update_tri_layer(_LOWER, _RAISE, _ADJUST);
 244       }
 245     break;
 246
 247   }
 248   return MACRO_NONE;
 249 };
 250
 251 void press_key(uint16_t key) {
 252   register_code(key);
 253   unregister_code(key);
 254 }
 255
 256 void press_two_keys(uint16_t key1, uint16_t key2) {
 257   register_code(key1);
 258   register_code(key2);
 259   unregister_code(key2);
 260   unregister_code(key1);
 261 }
 262
 263 void press_three_keys(uint16_t key1, uint16_t key2, uint16_t key3) {
 264   register_code(key1);
 265   register_code(key2);
 266   register_code(key3);
 267   unregister_code(key3);
 268   unregister_code(key2);
 269   unregister_code(key1);
 270 }
 271
 272 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 273   switch (keycode) {
 274     case MY_BELW:
 275       if (record->event.pressed) {
 276         press_two_keys(KC_LGUI, KC_RGHT);
 277         press_key(KC_ENT);
 278       }
 279
 280       return false;
 281
 282     case MY_ABVE:
 283       if (record->event.pressed) {
 284         press_two_keys(KC_LGUI, KC_LEFT);
 285         press_key(KC_ENT);
 286         press_key(KC_UP);
 287       }
 288
 289       return false;
 290
 291     case MY_TERM:
 292       if (record->event.pressed) {
 293         press_three_keys(KC_LGUI, KC_LSFT, KC_ENT);
 294       }
 295
 296       return false;
 297
 298     case MY_DEQL: // /=
 299       if (record->event.pressed) {
 300         press_key(KC_SLSH);
 301         press_key(KC_EQL);
 302       }
 303
 304       return false;
 305
 306     case MY_MEQL: // *=
 307       if (record->event.pressed) {
 308         press_two_keys(KC_LSFT, KC_ASTR);
 309         press_key(KC_EQL);
 310       }
 311
 312       return false;
 313
 314     case MY_SEQL: // -=
 315       if (record->event.pressed) {
 316         press_key(KC_MINS);
 317         press_key(KC_EQL);
 318       }
 319
 320       return false;
 321
 322     case MY_PEQL: // +=
 323       if (record->event.pressed) {
 324         press_two_keys(KC_LSFT, KC_PLUS);
 325         press_key(KC_EQL);
 326       }
 327
 328       return false;
 329
 330     case MY_NEQL: // !=
 331       if (record->event.pressed) {
 332         press_two_keys(KC_LSFT, KC_EXLM);
 333         press_key(KC_EQL);
 334       }
 335
 336       return false;
 337
 338     case MY_LTGT: // <>
 339       if (record->event.pressed) {
 340         press_two_keys(KC_LSFT, KC_LABK);
 341         press_two_keys(KC_LSFT, KC_RABK);
 342       }
 343
 344       return false;
 345
 346     case MY_DPIP: // ||
 347       if (record->event.pressed) {
 348         press_two_keys(KC_LSFT, KC_PIPE);
 349         press_two_keys(KC_LSFT, KC_PIPE);
 350       }
 351
 352       return false;
 353
 354     case MY_DAMP: // &&
 355       if (record->event.pressed) {
 356         press_two_keys(KC_LSFT, KC_AMPR);
 357         press_two_keys(KC_LSFT, KC_AMPR);
 358       }
 359
 360       return false;
 361   }
 362
 363   return true;
 364 }
 365