quantum_keycodes.h 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  1. #ifndef QUANTUM_KEYCODES_H
  2. #define QUANTUM_KEYCODES_H
  3. enum quantum_keycodes {
  4. // Ranges used in shortucuts - not to be used directly
  5. QK_TMK = 0x0000,
  6. QK_TMK_MAX = 0x00FF,
  7. QK_MODS = 0x0100,
  8. QK_LCTL = 0x0100,
  9. QK_LSFT = 0x0200,
  10. QK_LALT = 0x0400,
  11. QK_LGUI = 0x0800,
  12. QK_RMODS_MIN = 0x1000,
  13. QK_RCTL = 0x1100,
  14. QK_RSFT = 0x1200,
  15. QK_RALT = 0x1400,
  16. QK_RGUI = 0x1800,
  17. QK_MODS_MAX = 0x1FFF,
  18. QK_FUNCTION = 0x2000,
  19. QK_FUNCTION_MAX = 0x2FFF,
  20. QK_MACRO = 0x3000,
  21. QK_MACRO_MAX = 0x3FFF,
  22. QK_LAYER_TAP = 0x4000,
  23. QK_LAYER_TAP_MAX = 0x4FFF,
  24. QK_TO = 0x5000,
  25. QK_TO_MAX = 0x50FF,
  26. QK_MOMENTARY = 0x5100,
  27. QK_MOMENTARY_MAX = 0x51FF,
  28. QK_DEF_LAYER = 0x5200,
  29. QK_DEF_LAYER_MAX = 0x52FF,
  30. QK_TOGGLE_LAYER = 0x5300,
  31. QK_TOGGLE_LAYER_MAX = 0x53FF,
  32. QK_ONE_SHOT_LAYER = 0x5400,
  33. QK_ONE_SHOT_LAYER_MAX = 0x54FF,
  34. QK_ONE_SHOT_MOD = 0x5500,
  35. QK_ONE_SHOT_MOD_MAX = 0x55FF,
  36. #ifndef DISABLE_CHORDING
  37. QK_CHORDING = 0x5600,
  38. QK_CHORDING_MAX = 0x56FF,
  39. #endif
  40. QK_TAP_DANCE = 0x5700,
  41. QK_TAP_DANCE_MAX = 0x57FF,
  42. QK_LAYER_TAP_TOGGLE = 0x5800,
  43. QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
  44. QK_MOD_TAP = 0x6000,
  45. QK_MOD_TAP_MAX = 0x7FFF,
  46. #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
  47. #error "Cannot enable both UNICODEMAP && UNICODE"
  48. #endif
  49. #ifdef UNICODE_ENABLE
  50. QK_UNICODE = 0x8000,
  51. QK_UNICODE_MAX = 0xFFFF,
  52. #endif
  53. #ifdef UNICODEMAP_ENABLE
  54. QK_UNICODE_MAP = 0x8000,
  55. QK_UNICODE_MAP_MAX = 0x83FF,
  56. #endif
  57. // Loose keycodes - to be used directly
  58. RESET = 0x5C00,
  59. DEBUG,
  60. MAGIC_SWAP_CONTROL_CAPSLOCK,
  61. MAGIC_CAPSLOCK_TO_CONTROL,
  62. MAGIC_SWAP_LALT_LGUI,
  63. MAGIC_SWAP_RALT_RGUI,
  64. MAGIC_NO_GUI,
  65. MAGIC_SWAP_GRAVE_ESC,
  66. MAGIC_SWAP_BACKSLASH_BACKSPACE,
  67. MAGIC_HOST_NKRO,
  68. MAGIC_SWAP_ALT_GUI,
  69. MAGIC_UNSWAP_CONTROL_CAPSLOCK,
  70. MAGIC_UNCAPSLOCK_TO_CONTROL,
  71. MAGIC_UNSWAP_LALT_LGUI,
  72. MAGIC_UNSWAP_RALT_RGUI,
  73. MAGIC_UNNO_GUI,
  74. MAGIC_UNSWAP_GRAVE_ESC,
  75. MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
  76. MAGIC_UNHOST_NKRO,
  77. MAGIC_UNSWAP_ALT_GUI,
  78. MAGIC_TOGGLE_NKRO,
  79. // Leader key
  80. #ifndef DISABLE_LEADER
  81. KC_LEAD,
  82. #endif
  83. // Audio on/off/toggle
  84. AU_ON,
  85. AU_OFF,
  86. AU_TOG,
  87. #ifdef FAUXCLICKY_ENABLE
  88. // Faux clicky
  89. FC_ON,
  90. FC_OFF,
  91. FC_TOG,
  92. #endif
  93. // Music mode on/off/toggle
  94. MU_ON,
  95. MU_OFF,
  96. MU_TOG,
  97. // Music voice iterate
  98. MUV_IN,
  99. MUV_DE,
  100. // Midi mode on/off
  101. MIDI_ON,
  102. MIDI_OFF,
  103. // Backlight functionality
  104. BL_0,
  105. BL_1,
  106. BL_2,
  107. BL_3,
  108. BL_4,
  109. BL_5,
  110. BL_6,
  111. BL_7,
  112. BL_8,
  113. BL_9,
  114. BL_10,
  115. BL_11,
  116. BL_12,
  117. BL_13,
  118. BL_14,
  119. BL_15,
  120. BL_DEC,
  121. BL_INC,
  122. BL_TOGG,
  123. BL_STEP,
  124. // RGB functionality
  125. RGB_TOG,
  126. RGB_MOD,
  127. RGB_HUI,
  128. RGB_HUD,
  129. RGB_SAI,
  130. RGB_SAD,
  131. RGB_VAI,
  132. RGB_VAD,
  133. // Left shift, open paren
  134. KC_LSPO,
  135. // Right shift, close paren
  136. KC_RSPC,
  137. // Printing
  138. PRINT_ON,
  139. PRINT_OFF,
  140. // output selection
  141. OUT_AUTO,
  142. OUT_USB,
  143. #ifdef BLUETOOTH_ENABLE
  144. OUT_BT,
  145. #endif
  146. // always leave at the end
  147. SAFE_RANGE
  148. };
  149. // Ability to use mods in layouts
  150. #define LCTL(kc) (kc | QK_LCTL)
  151. #define LSFT(kc) (kc | QK_LSFT)
  152. #define LALT(kc) (kc | QK_LALT)
  153. #define LGUI(kc) (kc | QK_LGUI)
  154. #define RCTL(kc) (kc | QK_RCTL)
  155. #define RSFT(kc) (kc | QK_RSFT)
  156. #define RALT(kc) (kc | QK_RALT)
  157. #define RGUI(kc) (kc | QK_RGUI)
  158. #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
  159. #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
  160. #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
  161. #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
  162. #define SCMD(kc) (kc | QK_LGUI | QK_LSFT)
  163. #define SWIN(kc) SCMD(kc)
  164. #define LCA(kc) (kc | QK_LCTL | QK_LALT)
  165. #define MOD_HYPR 0xf
  166. #define MOD_MEH 0x7
  167. // Aliases for shifted symbols
  168. // Each key has a 4-letter code, and some have longer aliases too.
  169. // While the long aliases are descriptive, the 4-letter codes
  170. // make for nicer grid layouts (everything lines up), and are
  171. // the preferred style for Quantum.
  172. #define KC_TILD LSFT(KC_GRV) // ~
  173. #define KC_TILDE KC_TILD
  174. #define KC_EXLM LSFT(KC_1) // !
  175. #define KC_EXCLAIM KC_EXLM
  176. #define KC_AT LSFT(KC_2) // @
  177. #define KC_HASH LSFT(KC_3) // #
  178. #define KC_DLR LSFT(KC_4) // $
  179. #define KC_DOLLAR KC_DLR
  180. #define KC_PERC LSFT(KC_5) // %
  181. #define KC_PERCENT KC_PERC
  182. #define KC_CIRC LSFT(KC_6) // ^
  183. #define KC_CIRCUMFLEX KC_CIRC
  184. #define KC_AMPR LSFT(KC_7) // &
  185. #define KC_AMPERSAND KC_AMPR
  186. #define KC_ASTR LSFT(KC_8) // *
  187. #define KC_ASTERISK KC_ASTR
  188. #define KC_LPRN LSFT(KC_9) // (
  189. #define KC_LEFT_PAREN KC_LPRN
  190. #define KC_RPRN LSFT(KC_0) // )
  191. #define KC_RIGHT_PAREN KC_RPRN
  192. #define KC_UNDS LSFT(KC_MINS) // _
  193. #define KC_UNDERSCORE KC_UNDS
  194. #define KC_PLUS LSFT(KC_EQL) // +
  195. #define KC_LCBR LSFT(KC_LBRC) // {
  196. #define KC_LEFT_CURLY_BRACE KC_LCBR
  197. #define KC_RCBR LSFT(KC_RBRC) // }
  198. #define KC_RIGHT_CURLY_BRACE KC_RCBR
  199. #define KC_LABK LSFT(KC_COMM) // <
  200. #define KC_LEFT_ANGLE_BRACKET KC_LABK
  201. #define KC_RABK LSFT(KC_DOT) // >
  202. #define KC_RIGHT_ANGLE_BRACKET KC_RABK
  203. #define KC_COLN LSFT(KC_SCLN) // :
  204. #define KC_COLON KC_COLN
  205. #define KC_PIPE LSFT(KC_BSLS) // |
  206. #define KC_LT LSFT(KC_COMM) // <
  207. #define KC_GT LSFT(KC_DOT) // >
  208. #define KC_QUES LSFT(KC_SLSH) // ?
  209. #define KC_QUESTION KC_QUES
  210. #define KC_DQT LSFT(KC_QUOT) // "
  211. #define KC_DOUBLE_QUOTE KC_DQT
  212. #define KC_DQUO KC_DQT
  213. #define KC_DELT KC_DELETE // Del key (four letter code)
  214. // Alias for function layers than expand past FN31
  215. #define FUNC(kc) (kc | QK_FUNCTION)
  216. // Aliases
  217. #define S(kc) LSFT(kc)
  218. #define F(kc) FUNC(kc)
  219. #define M(kc) (kc | QK_MACRO)
  220. #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
  221. #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
  222. // L-ayer, T-ap - 256 keycode max, 16 layer max
  223. #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
  224. #define AG_SWAP MAGIC_SWAP_ALT_GUI
  225. #define AG_NORM MAGIC_UNSWAP_ALT_GUI
  226. #define BL_ON BL_9
  227. #define BL_OFF BL_0
  228. #define MI_ON MIDI_ON
  229. #define MI_OFF MIDI_OFF
  230. // GOTO layer - 16 layers max
  231. // when:
  232. // ON_PRESS = 1
  233. // ON_RELEASE = 2
  234. // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
  235. // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
  236. // keycode modeled after the old version, kept below for this.
  237. /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
  238. #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
  239. // Momentary switch layer - 256 layer max
  240. #define MO(layer) (layer | QK_MOMENTARY)
  241. // Set default layer - 256 layer max
  242. #define DF(layer) (layer | QK_DEF_LAYER)
  243. // Toggle to layer - 256 layer max
  244. #define TG(layer) (layer | QK_TOGGLE_LAYER)
  245. // One-shot layer - 256 layer max
  246. #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
  247. // One-shot mod
  248. #define OSM(mod) (mod | QK_ONE_SHOT_MOD)
  249. // Layer tap-toggle
  250. #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
  251. // M-od, T-ap - 256 keycode max
  252. #define MT(mod, kc) (kc | QK_MOD_TAP | ((mod & 0x1F) << 8))
  253. #define CTL_T(kc) MT(MOD_LCTL, kc)
  254. #define LCTL_T(kc) MT(MOD_LCTL, kc)
  255. #define RCTL_T(kc) MT(MOD_RCTL, kc)
  256. #define SFT_T(kc) MT(MOD_LSFT, kc)
  257. #define LSFT_T(kc) MT(MOD_LSFT, kc)
  258. #define RSFT_T(kc) MT(MOD_RSFT, kc)
  259. #define ALT_T(kc) MT(MOD_LALT, kc)
  260. #define LALT_T(kc) MT(MOD_LALT, kc)
  261. #define RALT_T(kc) MT(MOD_RALT, kc)
  262. #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
  263. #define GUI_T(kc) MT(MOD_LGUI, kc)
  264. #define LGUI_T(kc) MT(MOD_LGUI, kc)
  265. #define RGUI_T(kc) MT(MOD_RGUI, kc)
  266. #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
  267. #define MEH_T(kc) MT((MOD_LCTL | MOD_LSFT | MOD_LALT), kc) // Meh is a less hyper version of the Hyper key -- doesn't include Win or Cmd, so just alt+shift+ctrl
  268. #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
  269. #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
  270. #define ALL_T(kc) MT((MOD_LCTL | MOD_LSFT | MOD_LALT | MOD_LGUI), kc) // see http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/
  271. #define SCMD_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
  272. #define SWIN_T(kc) SCMD_T(kc)
  273. #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
  274. // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
  275. #define KC_HYPR HYPR(KC_NO)
  276. #define KC_MEH MEH(KC_NO)
  277. #ifdef UNICODE_ENABLE
  278. // For sending unicode codes.
  279. // You may not send codes over 7FFF -- this supports most of UTF8.
  280. // To have a key that sends out Œ, go UC(0x0152)
  281. #define UNICODE(n) (n | QK_UNICODE)
  282. #define UC(n) UNICODE(n)
  283. #endif
  284. #ifdef UNICODEMAP_ENABLE
  285. #define X(n) (n | QK_UNICODE_MAP)
  286. #endif
  287. #endif // QUANTUM_KEYCODES_H