quantum_keycodes.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676
  1. /* Copyright 2016-2017 Jack Humbert
  2. *
  3. * This program is free software: you can redistribute it and/or modify
  4. * it under the terms of the GNU General Public License as published by
  5. * the Free Software Foundation, either version 2 of the License, or
  6. * (at your option) any later version.
  7. *
  8. * This program is distributed in the hope that it will be useful,
  9. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. * GNU General Public License for more details.
  12. *
  13. * You should have received a copy of the GNU General Public License
  14. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #ifndef QUANTUM_KEYCODES_H
  17. #define QUANTUM_KEYCODES_H
  18. #ifndef MIDI_ENABLE_STRICT
  19. #define MIDI_ENABLE_STRICT 0
  20. #endif
  21. #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
  22. #ifndef MIDI_TONE_KEYCODE_OCTAVES
  23. #define MIDI_TONE_KEYCODE_OCTAVES 3
  24. #endif
  25. #endif
  26. // Fillers to make layering more clear
  27. #define _______ KC_TRNS
  28. #define XXXXXXX KC_NO
  29. enum quantum_keycodes {
  30. // Ranges used in shortucuts - not to be used directly
  31. QK_TMK = 0x0000,
  32. QK_TMK_MAX = 0x00FF,
  33. QK_MODS = 0x0100,
  34. QK_LCTL = 0x0100,
  35. QK_LSFT = 0x0200,
  36. QK_LALT = 0x0400,
  37. QK_LGUI = 0x0800,
  38. QK_RMODS_MIN = 0x1000,
  39. QK_RCTL = 0x1100,
  40. QK_RSFT = 0x1200,
  41. QK_RALT = 0x1400,
  42. QK_RGUI = 0x1800,
  43. QK_MODS_MAX = 0x1FFF,
  44. QK_FUNCTION = 0x2000,
  45. QK_FUNCTION_MAX = 0x2FFF,
  46. QK_MACRO = 0x3000,
  47. QK_MACRO_MAX = 0x3FFF,
  48. QK_LAYER_TAP = 0x4000,
  49. QK_LAYER_TAP_MAX = 0x4FFF,
  50. QK_TO = 0x5000,
  51. QK_TO_MAX = 0x50FF,
  52. QK_MOMENTARY = 0x5100,
  53. QK_MOMENTARY_MAX = 0x51FF,
  54. QK_DEF_LAYER = 0x5200,
  55. QK_DEF_LAYER_MAX = 0x52FF,
  56. QK_TOGGLE_LAYER = 0x5300,
  57. QK_TOGGLE_LAYER_MAX = 0x53FF,
  58. QK_ONE_SHOT_LAYER = 0x5400,
  59. QK_ONE_SHOT_LAYER_MAX = 0x54FF,
  60. QK_ONE_SHOT_MOD = 0x5500,
  61. QK_ONE_SHOT_MOD_MAX = 0x55FF,
  62. #ifndef DISABLE_CHORDING
  63. QK_CHORDING = 0x5600,
  64. QK_CHORDING_MAX = 0x56FF,
  65. #endif
  66. QK_TAP_DANCE = 0x5700,
  67. QK_TAP_DANCE_MAX = 0x57FF,
  68. QK_LAYER_TAP_TOGGLE = 0x5800,
  69. QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
  70. QK_LAYER_MOD = 0x5900,
  71. QK_LAYER_MOD_MAX = 0x59FF,
  72. #ifdef STENO_ENABLE
  73. QK_STENO = 0x5A00,
  74. QK_STENO_BOLT = 0x5A30,
  75. QK_STENO_GEMINI = 0x5A31,
  76. QK_STENO_MAX = 0x5A3F,
  77. #endif
  78. #ifdef SWAP_HANDS_ENABLE
  79. QK_SWAP_HANDS = 0x5B00,
  80. QK_SWAP_HANDS_MAX = 0x5BFF,
  81. #endif
  82. QK_MOD_TAP = 0x6000,
  83. QK_MOD_TAP_MAX = 0x7FFF,
  84. #if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
  85. #error "Cannot enable both UNICODEMAP && UNICODE"
  86. #endif
  87. #ifdef UNICODE_ENABLE
  88. QK_UNICODE = 0x8000,
  89. QK_UNICODE_MAX = 0xFFFF,
  90. #endif
  91. #ifdef UNICODEMAP_ENABLE
  92. QK_UNICODE_MAP = 0x8000,
  93. QK_UNICODE_MAP_MAX = 0x83FF,
  94. #endif
  95. // Loose keycodes - to be used directly
  96. RESET = 0x5C00,
  97. DEBUG,
  98. MAGIC_SWAP_CONTROL_CAPSLOCK,
  99. MAGIC_CAPSLOCK_TO_CONTROL,
  100. MAGIC_SWAP_LALT_LGUI,
  101. MAGIC_SWAP_RALT_RGUI,
  102. MAGIC_NO_GUI,
  103. MAGIC_SWAP_GRAVE_ESC,
  104. MAGIC_SWAP_BACKSLASH_BACKSPACE,
  105. MAGIC_HOST_NKRO,
  106. MAGIC_SWAP_ALT_GUI,
  107. MAGIC_UNSWAP_CONTROL_CAPSLOCK,
  108. MAGIC_UNCAPSLOCK_TO_CONTROL,
  109. MAGIC_UNSWAP_LALT_LGUI,
  110. MAGIC_UNSWAP_RALT_RGUI,
  111. MAGIC_UNNO_GUI,
  112. MAGIC_UNSWAP_GRAVE_ESC,
  113. MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
  114. MAGIC_UNHOST_NKRO,
  115. MAGIC_UNSWAP_ALT_GUI,
  116. MAGIC_TOGGLE_NKRO,
  117. GRAVE_ESC,
  118. // Leader key
  119. #ifndef DISABLE_LEADER
  120. KC_LEAD,
  121. #endif
  122. // Auto Shift setup
  123. KC_ASUP,
  124. KC_ASDN,
  125. KC_ASRP,
  126. KC_ASTG,
  127. KC_ASON,
  128. KC_ASOFF,
  129. // Audio on/off/toggle
  130. AU_ON,
  131. AU_OFF,
  132. AU_TOG,
  133. #ifdef FAUXCLICKY_ENABLE
  134. // Faux clicky
  135. FC_ON,
  136. FC_OFF,
  137. FC_TOG,
  138. #endif
  139. // Music mode on/off/toggle
  140. MU_ON,
  141. MU_OFF,
  142. MU_TOG,
  143. // Music mode cycle
  144. MU_MOD,
  145. // Music voice iterate
  146. MUV_IN,
  147. MUV_DE,
  148. // Midi
  149. #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
  150. MI_ON,
  151. MI_OFF,
  152. MI_TOG,
  153. #endif
  154. #if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
  155. MIDI_TONE_MIN,
  156. #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
  157. MI_C = MIDI_TONE_MIN,
  158. MI_Cs,
  159. MI_Db = MI_Cs,
  160. MI_D,
  161. MI_Ds,
  162. MI_Eb = MI_Ds,
  163. MI_E,
  164. MI_F,
  165. MI_Fs,
  166. MI_Gb = MI_Fs,
  167. MI_G,
  168. MI_Gs,
  169. MI_Ab = MI_Gs,
  170. MI_A,
  171. MI_As,
  172. MI_Bb = MI_As,
  173. MI_B,
  174. #endif
  175. #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
  176. MI_C_1,
  177. MI_Cs_1,
  178. MI_Db_1 = MI_Cs_1,
  179. MI_D_1,
  180. MI_Ds_1,
  181. MI_Eb_1 = MI_Ds_1,
  182. MI_E_1,
  183. MI_F_1,
  184. MI_Fs_1,
  185. MI_Gb_1 = MI_Fs_1,
  186. MI_G_1,
  187. MI_Gs_1,
  188. MI_Ab_1 = MI_Gs_1,
  189. MI_A_1,
  190. MI_As_1,
  191. MI_Bb_1 = MI_As_1,
  192. MI_B_1,
  193. #endif
  194. #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
  195. MI_C_2,
  196. MI_Cs_2,
  197. MI_Db_2 = MI_Cs_2,
  198. MI_D_2,
  199. MI_Ds_2,
  200. MI_Eb_2 = MI_Ds_2,
  201. MI_E_2,
  202. MI_F_2,
  203. MI_Fs_2,
  204. MI_Gb_2 = MI_Fs_2,
  205. MI_G_2,
  206. MI_Gs_2,
  207. MI_Ab_2 = MI_Gs_2,
  208. MI_A_2,
  209. MI_As_2,
  210. MI_Bb_2 = MI_As_2,
  211. MI_B_2,
  212. #endif
  213. #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
  214. MI_C_3,
  215. MI_Cs_3,
  216. MI_Db_3 = MI_Cs_3,
  217. MI_D_3,
  218. MI_Ds_3,
  219. MI_Eb_3 = MI_Ds_3,
  220. MI_E_3,
  221. MI_F_3,
  222. MI_Fs_3,
  223. MI_Gb_3 = MI_Fs_3,
  224. MI_G_3,
  225. MI_Gs_3,
  226. MI_Ab_3 = MI_Gs_3,
  227. MI_A_3,
  228. MI_As_3,
  229. MI_Bb_3 = MI_As_3,
  230. MI_B_3,
  231. #endif
  232. #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
  233. MI_C_4,
  234. MI_Cs_4,
  235. MI_Db_4 = MI_Cs_4,
  236. MI_D_4,
  237. MI_Ds_4,
  238. MI_Eb_4 = MI_Ds_4,
  239. MI_E_4,
  240. MI_F_4,
  241. MI_Fs_4,
  242. MI_Gb_4 = MI_Fs_4,
  243. MI_G_4,
  244. MI_Gs_4,
  245. MI_Ab_4 = MI_Gs_4,
  246. MI_A_4,
  247. MI_As_4,
  248. MI_Bb_4 = MI_As_4,
  249. MI_B_4,
  250. #endif
  251. #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
  252. MI_C_5,
  253. MI_Cs_5,
  254. MI_Db_5 = MI_Cs_5,
  255. MI_D_5,
  256. MI_Ds_5,
  257. MI_Eb_5 = MI_Ds_5,
  258. MI_E_5,
  259. MI_F_5,
  260. MI_Fs_5,
  261. MI_Gb_5 = MI_Fs_5,
  262. MI_G_5,
  263. MI_Gs_5,
  264. MI_Ab_5 = MI_Gs_5,
  265. MI_A_5,
  266. MI_As_5,
  267. MI_Bb_5 = MI_As_5,
  268. MI_B_5,
  269. #endif
  270. #if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
  271. MIDI_TONE_MAX = MI_B_5,
  272. #elif MIDI_TONE_KEYCODE_OCTAVES > 4
  273. MIDI_TONE_MAX = MI_B_4,
  274. #elif MIDI_TONE_KEYCODE_OCTAVES > 3
  275. MIDI_TONE_MAX = MI_B_3,
  276. #elif MIDI_TONE_KEYCODE_OCTAVES > 2
  277. MIDI_TONE_MAX = MI_B_2,
  278. #elif MIDI_TONE_KEYCODE_OCTAVES > 1
  279. MIDI_TONE_MAX = MI_B_1,
  280. #elif MIDI_TONE_KEYCODE_OCTAVES > 0
  281. MIDI_TONE_MAX = MI_B,
  282. #endif
  283. MIDI_OCTAVE_MIN,
  284. MI_OCT_N2 = MIDI_OCTAVE_MIN,
  285. MI_OCT_N1,
  286. MI_OCT_0,
  287. MI_OCT_1,
  288. MI_OCT_2,
  289. MI_OCT_3,
  290. MI_OCT_4,
  291. MI_OCT_5,
  292. MI_OCT_6,
  293. MI_OCT_7,
  294. MIDI_OCTAVE_MAX = MI_OCT_7,
  295. MI_OCTD, // octave down
  296. MI_OCTU, // octave up
  297. MIDI_TRANSPOSE_MIN,
  298. MI_TRNS_N6 = MIDI_TRANSPOSE_MIN,
  299. MI_TRNS_N5,
  300. MI_TRNS_N4,
  301. MI_TRNS_N3,
  302. MI_TRNS_N2,
  303. MI_TRNS_N1,
  304. MI_TRNS_0,
  305. MI_TRNS_1,
  306. MI_TRNS_2,
  307. MI_TRNS_3,
  308. MI_TRNS_4,
  309. MI_TRNS_5,
  310. MI_TRNS_6,
  311. MIDI_TRANSPOSE_MAX = MI_TRNS_6,
  312. MI_TRNSD, // transpose down
  313. MI_TRNSU, // transpose up
  314. MIDI_VELOCITY_MIN,
  315. MI_VEL_1 = MIDI_VELOCITY_MIN,
  316. MI_VEL_2,
  317. MI_VEL_3,
  318. MI_VEL_4,
  319. MI_VEL_5,
  320. MI_VEL_6,
  321. MI_VEL_7,
  322. MI_VEL_8,
  323. MI_VEL_9,
  324. MI_VEL_10,
  325. MIDI_VELOCITY_MAX = MI_VEL_10,
  326. MI_VELD, // velocity down
  327. MI_VELU, // velocity up
  328. MIDI_CHANNEL_MIN,
  329. MI_CH1 = MIDI_CHANNEL_MIN,
  330. MI_CH2,
  331. MI_CH3,
  332. MI_CH4,
  333. MI_CH5,
  334. MI_CH6,
  335. MI_CH7,
  336. MI_CH8,
  337. MI_CH9,
  338. MI_CH10,
  339. MI_CH11,
  340. MI_CH12,
  341. MI_CH13,
  342. MI_CH14,
  343. MI_CH15,
  344. MI_CH16,
  345. MIDI_CHANNEL_MAX = MI_CH16,
  346. MI_CHD, // previous channel
  347. MI_CHU, // next channel
  348. MI_ALLOFF, // all notes off
  349. MI_SUS, // sustain
  350. MI_PORT, // portamento
  351. MI_SOST, // sostenuto
  352. MI_SOFT, // soft pedal
  353. MI_LEG, // legato
  354. MI_MOD, // modulation
  355. MI_MODSD, // decrease modulation speed
  356. MI_MODSU, // increase modulation speed
  357. MI_BENDD, // Bend down
  358. MI_BENDU, // Bend up
  359. #endif // MIDI_ADVANCED
  360. // Backlight functionality
  361. BL_ON,
  362. BL_OFF,
  363. BL_DEC,
  364. BL_INC,
  365. BL_TOGG,
  366. BL_STEP,
  367. BL_BRTG,
  368. // RGB functionality
  369. RGB_TOG,
  370. RGB_MODE_FORWARD,
  371. RGB_MODE_REVERSE,
  372. RGB_HUI,
  373. RGB_HUD,
  374. RGB_SAI,
  375. RGB_SAD,
  376. RGB_VAI,
  377. RGB_VAD,
  378. RGB_MODE_PLAIN,
  379. RGB_MODE_BREATHE,
  380. RGB_MODE_RAINBOW,
  381. RGB_MODE_SWIRL,
  382. RGB_MODE_SNAKE,
  383. RGB_MODE_KNIGHT,
  384. RGB_MODE_XMAS,
  385. RGB_MODE_GRADIENT,
  386. // Left shift, open paren
  387. KC_LSPO,
  388. // Right shift, close paren
  389. KC_RSPC,
  390. // Shift, Enter
  391. KC_SFTENT,
  392. // Printing
  393. PRINT_ON,
  394. PRINT_OFF,
  395. // output selection
  396. OUT_AUTO,
  397. OUT_USB,
  398. #ifdef BLUETOOTH_ENABLE
  399. OUT_BT,
  400. #endif
  401. #ifdef KEY_LOCK_ENABLE
  402. KC_LOCK,
  403. #endif
  404. #ifdef TERMINAL_ENABLE
  405. TERM_ON,
  406. TERM_OFF,
  407. #endif
  408. // always leave at the end
  409. SAFE_RANGE
  410. };
  411. // Ability to use mods in layouts
  412. #define LCTL(kc) (kc | QK_LCTL)
  413. #define LSFT(kc) (kc | QK_LSFT)
  414. #define LALT(kc) (kc | QK_LALT)
  415. #define LGUI(kc) (kc | QK_LGUI)
  416. #define LCMD(kc) LGUI(kc)
  417. #define LWIN(kc) LGUI(kc)
  418. #define RCTL(kc) (kc | QK_RCTL)
  419. #define RSFT(kc) (kc | QK_RSFT)
  420. #define RALT(kc) (kc | QK_RALT)
  421. #define RGUI(kc) (kc | QK_RGUI)
  422. #define RCMD(kc) RGUI(kc)
  423. #define RWIN(kc) RGUI(kc)
  424. #define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
  425. #define MEH(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT)
  426. #define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
  427. #define ALTG(kc) (kc | QK_RCTL | QK_RALT)
  428. #define SGUI(kc) (kc | QK_LGUI | QK_LSFT)
  429. #define SCMD(kc) SGUI(kc)
  430. #define SWIN(kc) SGUI(kc)
  431. #define LCA(kc) (kc | QK_LCTL | QK_LALT)
  432. #define MOD_HYPR 0xf
  433. #define MOD_MEH 0x7
  434. // Aliases for shifted symbols
  435. // Each key has a 4-letter code, and some have longer aliases too.
  436. // While the long aliases are descriptive, the 4-letter codes
  437. // make for nicer grid layouts (everything lines up), and are
  438. // the preferred style for Quantum.
  439. #define KC_TILD LSFT(KC_GRV) // ~
  440. #define KC_TILDE KC_TILD
  441. #define KC_EXLM LSFT(KC_1) // !
  442. #define KC_EXCLAIM KC_EXLM
  443. #define KC_AT LSFT(KC_2) // @
  444. #define KC_HASH LSFT(KC_3) // #
  445. #define KC_DLR LSFT(KC_4) // $
  446. #define KC_DOLLAR KC_DLR
  447. #define KC_PERC LSFT(KC_5) // %
  448. #define KC_PERCENT KC_PERC
  449. #define KC_CIRC LSFT(KC_6) // ^
  450. #define KC_CIRCUMFLEX KC_CIRC
  451. #define KC_AMPR LSFT(KC_7) // &
  452. #define KC_AMPERSAND KC_AMPR
  453. #define KC_ASTR LSFT(KC_8) // *
  454. #define KC_ASTERISK KC_ASTR
  455. #define KC_LPRN LSFT(KC_9) // (
  456. #define KC_LEFT_PAREN KC_LPRN
  457. #define KC_RPRN LSFT(KC_0) // )
  458. #define KC_RIGHT_PAREN KC_RPRN
  459. #define KC_UNDS LSFT(KC_MINS) // _
  460. #define KC_UNDERSCORE KC_UNDS
  461. #define KC_PLUS LSFT(KC_EQL) // +
  462. #define KC_LCBR LSFT(KC_LBRC) // {
  463. #define KC_LEFT_CURLY_BRACE KC_LCBR
  464. #define KC_RCBR LSFT(KC_RBRC) // }
  465. #define KC_RIGHT_CURLY_BRACE KC_RCBR
  466. #define KC_LABK LSFT(KC_COMM) // <
  467. #define KC_LEFT_ANGLE_BRACKET KC_LABK
  468. #define KC_RABK LSFT(KC_DOT) // >
  469. #define KC_RIGHT_ANGLE_BRACKET KC_RABK
  470. #define KC_COLN LSFT(KC_SCLN) // :
  471. #define KC_COLON KC_COLN
  472. #define KC_PIPE LSFT(KC_BSLS) // |
  473. #define KC_LT LSFT(KC_COMM) // <
  474. #define KC_GT LSFT(KC_DOT) // >
  475. #define KC_QUES LSFT(KC_SLSH) // ?
  476. #define KC_QUESTION KC_QUES
  477. #define KC_DQT LSFT(KC_QUOT) // "
  478. #define KC_DOUBLE_QUOTE KC_DQT
  479. #define KC_DQUO KC_DQT
  480. #define KC_DELT KC_DELETE // Del key (four letter code)
  481. // Alias for function layers than expand past FN31
  482. #define FUNC(kc) (kc | QK_FUNCTION)
  483. // Aliases
  484. #define S(kc) LSFT(kc)
  485. #define F(kc) FUNC(kc)
  486. #define M(kc) (kc | QK_MACRO)
  487. #define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
  488. #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
  489. #define KC_GESC GRAVE_ESC
  490. #define RGB_MOD RGB_MODE_FORWARD
  491. #define RGB_SMOD RGB_MODE_FORWARD
  492. #define RGB_RMOD RGB_MODE_REVERSE
  493. #define RGB_M_P RGB_MODE_PLAIN
  494. #define RGB_M_B RGB_MODE_BREATHE
  495. #define RGB_M_R RGB_MODE_RAINBOW
  496. #define RGB_M_SW RGB_MODE_SWIRL
  497. #define RGB_M_SN RGB_MODE_SNAKE
  498. #define RGB_M_K RGB_MODE_KNIGHT
  499. #define RGB_M_X RGB_MODE_XMAS
  500. #define RGB_M_G RGB_MODE_GRADIENT
  501. // L-ayer, T-ap - 256 keycode max, 16 layer max
  502. #define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))
  503. #define AG_SWAP MAGIC_SWAP_ALT_GUI
  504. #define AG_NORM MAGIC_UNSWAP_ALT_GUI
  505. // GOTO layer - 16 layers max
  506. // when:
  507. // ON_PRESS = 1
  508. // ON_RELEASE = 2
  509. // Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
  510. // In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
  511. // keycode modeled after the old version, kept below for this.
  512. /* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
  513. #define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))
  514. // Momentary switch layer - 256 layer max
  515. #define MO(layer) (layer | QK_MOMENTARY)
  516. // Set default layer - 256 layer max
  517. #define DF(layer) (layer | QK_DEF_LAYER)
  518. // Toggle to layer - 256 layer max
  519. #define TG(layer) (layer | QK_TOGGLE_LAYER)
  520. // One-shot layer - 256 layer max
  521. #define OSL(layer) (layer | QK_ONE_SHOT_LAYER)
  522. // L-ayer M-od: Momentary switch layer with modifiers active - 16 layer max, left mods only
  523. #define LM(layer, mod) (QK_LAYER_MOD | (((layer) & 0xF) << 4) | ((mod) & 0xF))
  524. // One-shot mod
  525. #define OSM(mod) ((mod) | QK_ONE_SHOT_MOD)
  526. // Layer tap-toggle
  527. #define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)
  528. // M-od, T-ap - 256 keycode max
  529. #define MT(mod, kc) (kc | QK_MOD_TAP | (((mod) & 0x1F) << 8))
  530. #define CTL_T(kc) MT(MOD_LCTL, kc)
  531. #define LCTL_T(kc) MT(MOD_LCTL, kc)
  532. #define RCTL_T(kc) MT(MOD_RCTL, kc)
  533. #define SFT_T(kc) MT(MOD_LSFT, kc)
  534. #define LSFT_T(kc) MT(MOD_LSFT, kc)
  535. #define RSFT_T(kc) MT(MOD_RSFT, kc)
  536. #define ALT_T(kc) MT(MOD_LALT, kc)
  537. #define LALT_T(kc) MT(MOD_LALT, kc)
  538. #define RALT_T(kc) MT(MOD_RALT, kc)
  539. #define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
  540. #define GUI_T(kc) MT(MOD_LGUI, kc)
  541. #define CMD_T(kc) GUI_T(kc)
  542. #define WIN_T(kc) GUI_T(kc)
  543. #define LGUI_T(kc) MT(MOD_LGUI, kc)
  544. #define LCMD_T(kc) LGUI_T(kc)
  545. #define LWIN_T(kc) LGUI_T(kc)
  546. #define RGUI_T(kc) MT(MOD_RGUI, kc)
  547. #define RCMD_T(kc) RGUI_T(kc)
  548. #define RWIN_T(kc) RGUI_T(kc)
  549. #define C_S_T(kc) MT((MOD_LCTL | MOD_LSFT), kc) // Control + Shift e.g. for gnome-terminal
  550. #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
  551. #define LCAG_T(kc) MT((MOD_LCTL | MOD_LALT | MOD_LGUI), kc) // Left control alt and gui
  552. #define RCAG_T(kc) MT((MOD_RCTL | MOD_RALT | MOD_RGUI), kc) // Right control alt and gui
  553. #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/
  554. #define SGUI_T(kc) MT((MOD_LGUI | MOD_LSFT), kc)
  555. #define SCMD_T(kc) SGUI_T(kc)
  556. #define SWIN_T(kc) SGUI_T(kc)
  557. #define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt
  558. // Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
  559. #define KC_HYPR HYPR(KC_NO)
  560. #define KC_MEH MEH(KC_NO)
  561. #ifdef UNICODE_ENABLE
  562. // For sending unicode codes.
  563. // You may not send codes over 7FFF -- this supports most of UTF8.
  564. // To have a key that sends out Œ, go UC(0x0152)
  565. #define UNICODE(n) (n | QK_UNICODE)
  566. #define UC(n) UNICODE(n)
  567. #endif
  568. #ifdef UNICODEMAP_ENABLE
  569. #define X(n) (n | QK_UNICODE_MAP)
  570. #endif
  571. #ifdef SWAP_HANDS_ENABLE
  572. #define SH_T(key) (QK_SWAP_HANDS | key)
  573. #define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE)
  574. #define SH_TT (QK_SWAP_HANDS | OP_SH_TAP_TOGGLE)
  575. #define SH_MON (QK_SWAP_HANDS | OP_SH_ON_OFF)
  576. #define SH_MOFF (QK_SWAP_HANDS | OP_SH_OFF_ON)
  577. #define SH_ON (QK_SWAP_HANDS | OP_SH_ON)
  578. #define SH_OFF (QK_SWAP_HANDS | OP_SH_OFF)
  579. #endif
  580. #endif // QUANTUM_KEYCODES_H