users/pvinis/pvinis.h

   1 #pragma once
   2
   3 #include "quantum.h"
   4
   5
   6 // my own keycodes
   7 enum userspace_custom_keycodes {
   8   PV_ = SAFE_RANGE,
   9
  10   PV_VRSN, // prints firmware version
  11   PV_MAKE, // prints the make command of the keyboard
  12   PV_FLSH, // resets keyboard
  13   PV_KTMR, // play katamari music
  14
  15   PV_SAFE_RANGE, // used for extra keycodes in the individual keymaps
  16 };
  17
  18 enum tap_dance_indexes {
  19   // tap dance
  20   TD_FLSH, // flash keyboard (as if the physical flash key was pressed)
  21 };
  22
  23 #define ALLM(kc) LCAG(kc)           // easier name for left ctrl-alt-gui
  24 #define PV_ESCC  CTL_T(KC_ESC)      // esc on tap, ctrl on hold
  25 #define PV_LOCK  LCTL(LSFT(KC_PWR)) // lock computer
  26 #define TD_3FLS  TD(TD_FLSH)        // tap dance 3 times for flash
  27
  28
  29 // layers
  30 enum {
  31   LR_BASE = 0, // used for basic keys like the surrounding ctrl, cmd, etc
  32
  33   LR_QWERTY,
  34   LR_CARPALX,
  35
  36   LR_SYMBOL, // symbol input (!, @, #, etc)
  37   LR_SYSCTL, // system control (music, volume, keyboard flash, etc)
  38   LR_KBCTL,  // keyboard control (version, make, flash, etc)
  39 };
  40
  41
  42 // layer switchers
  43 #define BASE    TO(LR_BASE)
  44 #define QWERTY  TO(LR_QWERTY)
  45 #define CARPALX TO(LR_CARPALX)
  46
  47 #define SYMBOL  MO(LR_SYMBOL)
  48 #define SYSCTL  MO(LR_SYSCTL)
  49 #define KBCTL   MO(LR_KBCTL)
  50
  51
  52 // layout parts for easy reuse between keyboard keymaps
  53
  54 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  55 // |  1  |  2  |  3  |  4  |  5  |   |  6  |  7  |  8  |  9  |  0  |
  56 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  57 #define ________________NUMBERS_L__________________  KC_1, KC_2, KC_3, KC_4, KC_5
  58 #define ________________NUMBERS_R__________________  KC_6, KC_7, KC_8, KC_9, KC_0
  59
  60 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  61 // | F1  | F2  | F3  | F4  | F5  |   | F6  | F7  | F8  | F9  | F10 |
  62 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  63 #define ______________________F_L__________________  KC_F1, KC_F2, KC_F3, KC_F4, KC_F5
  64 #define ______________________F_R__________________  KC_F6, KC_F7, KC_F8, KC_F9, KC_F10
  65
  66 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  67 // |  Q  |  W  |  E  |  R  |  T  |   |  Y  |  U  |  I  |  O  |  P  |
  68 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
  69 // |  A  |  S  |  D  |  F  |  G  |   |  H  |  J  |  K  |  L  |  ;  |
  70 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
  71 // |  Z  |  X  |  C  |  V  |  B  |   |  N  |  M  |  ,  |  .  |  /  |
  72 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  73 #define _________________QWERTY_L1_________________  KC_Q   , KC_W   , KC_E   , KC_R   , KC_T
  74 #define _________________QWERTY_L2_________________  KC_A   , KC_S   , KC_D   , KC_F   , KC_G
  75 #define _________________QWERTY_L3_________________  KC_Z   , KC_X   , KC_C   , KC_V   , KC_B
  76
  77 #define _________________QWERTY_R1_________________  KC_Y   , KC_U   , KC_I   , KC_O   , KC_P
  78 #define _________________QWERTY_R2_________________  KC_H   , KC_J   , KC_K   , KC_L   , KC_SCLN
  79 #define _________________QWERTY_R3_________________  KC_N   , KC_M   , KC_COMM, KC_DOT , KC_SLSH
  80
  81 #define _____________MOD_QWERTY_L2_________________  CTL_T(KC_A), SFT_T(KC_S), GUI_T(KC_D), ALT_T(KC_F), KC_G
  82 #define _____________MOD_QWERTY_R2_________________  KC_H       , ALT_T(KC_J), GUI_T(KC_K), SFT_T(KC_L), CTL_T(KC_SCLN)
  83
  84 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  85 // |  Q  |  G  |  M  |  L  |  W  |   |  Y  |  F  |  I  |  O  |  P  |
  86 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
  87 // |  D  |  S  |  T  |  N  |  R  |   |  I  |  A  |  K  |  L  |  ;  |
  88 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
  89 // |  Z  |  X  |  C  |  V  |  J  |   |  K  |  P  |  ,  |  .  |  /  |
  90 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
  91 #define ________________CARPALX_L1_________________  KC_Q   , KC_G   , KC_M   , KC_L   , KC_W
  92 #define ________________CARPALX_L2_________________  KC_D   , KC_S   , KC_T   , KC_N   , KC_R
  93 #define ________________CARPALX_L3_________________  KC_Z   , KC_X   , KC_C   , KC_V   , KC_J
  94
  95 #define ________________CARPALX_R1_________________  KC_Y   , KC_F   , KC_U   , KC_B   , KC_SCLN
  96 #define ________________CARPALX_R2_________________  KC_I   , KC_A   , KC_E   , KC_O   , KC_H
  97 #define ________________CARPALX_R3_________________  KC_K   , KC_P   , KC_COMM, KC_DOT , KC_SLSH
  98
  99 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
 100 // |  !  |  @  |  {  |  }  |  _  |   |  \  |     |  `  |     |     |
 101 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
 102 // |  #  |  $  |  (  |  )  |  -  |   |  =  |  &  |  '  |  "  |  |  |
 103 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
 104 // |  %  |  ^  |  [  |  ]  |  +  |   |  *  |  ~  |  <  |  >  |  /  |
 105 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
 106 #define _________________SYMBOL_L1_________________  KC_EXLM, KC_AT  , KC_LCBR, KC_RCBR, KC_UNDS
 107 #define _________________SYMBOL_L2_________________  KC_HASH, KC_DLR , KC_LPRN, KC_RPRN, KC_MINS
 108 #define _________________SYMBOL_L3_________________  KC_PERC, KC_CIRC, KC_LBRC, KC_RBRC, KC_PLUS
 109
 110 #define _________________SYMBOL_R1_________________  KC_BSLS, _______, KC_GRV , _______, _______
 111 #define _________________SYMBOL_R2_________________  KC_EQL , KC_AMPR, KC_QUOT, KC_DQUO, KC_PIPE
 112 #define _________________SYMBOL_R3_________________  KC_ASTR, KC_TILD, KC_LABK, KC_RABK, KC_SLSH
 113
 114 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
 115 // |     |     |     |     |     |   |MUTE |HOME |  ^  | END |     |
 116 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
 117 // |     |     |     |     |     |   |VOLUP|  <  |  v  |  >  |     |
 118 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
 119 // |     |     |     |     |     |   |VOLDN|MPREV|MPLAY|MNEXT|     |
 120 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
 121 #define _________________SYSCTL_L1_________________
 122 #define _________________SYSCTL_L2_________________
 123 #define _________________SYSCTL_L3_________________
 124
 125 //                                                    vol v                                                 ctl v
 126 #define _________________SYSCTL_R1_________________  KC_MUTE , KC_HOME , KC_UP   , KC_END                 , PV_LOCK
 127 #define _________________SYSCTL_R2_________________  KC_VOLU , KC_LEFT , KC_DOWN , KC_RGHT /* < arrows */ , KC_SLEP
 128 #define _________________SYSCTL_R3_________________  KC_VOLD , KC_MPRV , KC_MPLY , KC_MNXT /* < music */  , KC_PWR
 129
 130 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
 131 // |XXXXX|XXXXX|XXXXX|XXXXX|XXXXX|   |XXXXX|XXXXX|XXXXX|XXXXX|XXXXX|
 132 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
 133 // |XXXXX|XXXXX|XXXXX|XXXXX|XXXXX|   |XXXXX|VERSN|MAKE |FLASH|XXXXX|
 134 // ,-----+-----+-----x-----x-----,   ,-----x-----x-----+-----+-----,
 135 // |XXXXX|XXXXX|XXXXX|XXXXX|XXXXX|   |XXXXX|XXXXX|XXXXX|XXXXX|XXXXX|
 136 // ,-----+-----+-----+-----+-----,   ,-----+-----+-----+-----+-----,
 137 #define __________________KBCTL_L1_________________  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
 138 #define __________________KBCTL_L2_________________  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
 139 #define __________________KBCTL_L3_________________  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
 140
 141 #define __________________KBCTL_R1_________________  XXXXXXX, XXXXXXX, XXXXXXX, PV_KTMR, XXXXXXX
 142 #define __________________KBCTL_R2_________________  XXXXXXX, PV_VRSN, PV_MAKE, PV_FLSH, XXXXXXX
 143 #define __________________KBCTL_R3_________________  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
 144
 145 // we need wrappers in order for these definitions, because they need to be expanded before being used as arguments to the LAYOUT_xxx macro
 146 #define LAYOUT_ergodox_pretty_wrapper(...)  LAYOUT_ergodox_pretty(__VA_ARGS__)
 147 #define LAYOUT_wrapper(...)                 LAYOUT(__VA_ARGS__)
 148
 149
 150 // extra stuff that might be needed
 151 void keyboard_post_init_user_local(void);
 152 uint32_t layer_state_set_user_local(uint32_t state);