2017-03-28 22:20:36 +00:00
/* Copyright 2016-2017 Jack Humbert
*
* 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 2 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/>.
*/
2016-12-29 07:28:48 +00:00
# ifndef QUANTUM_KEYCODES_H
# define QUANTUM_KEYCODES_H
2017-02-26 04:41:13 +00:00
# ifndef MIDI_ENABLE_STRICT
# define MIDI_ENABLE_STRICT 0
# endif
# if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
2017-02-20 01:18:05 +00:00
# ifndef MIDI_TONE_KEYCODE_OCTAVES
# define MIDI_TONE_KEYCODE_OCTAVES 3
# endif
# endif
2017-07-21 03:57:11 +00:00
// Fillers to make layering more clear
# define _______ KC_TRNS
# define XXXXXXX KC_NO
2016-12-29 07:28:48 +00:00
enum quantum_keycodes {
// Ranges used in shortucuts - not to be used directly
QK_TMK = 0x0000 ,
QK_TMK_MAX = 0x00FF ,
QK_MODS = 0x0100 ,
QK_LCTL = 0x0100 ,
QK_LSFT = 0x0200 ,
QK_LALT = 0x0400 ,
QK_LGUI = 0x0800 ,
QK_RMODS_MIN = 0x1000 ,
QK_RCTL = 0x1100 ,
QK_RSFT = 0x1200 ,
QK_RALT = 0x1400 ,
QK_RGUI = 0x1800 ,
QK_MODS_MAX = 0x1FFF ,
QK_FUNCTION = 0x2000 ,
QK_FUNCTION_MAX = 0x2FFF ,
QK_MACRO = 0x3000 ,
QK_MACRO_MAX = 0x3FFF ,
QK_LAYER_TAP = 0x4000 ,
QK_LAYER_TAP_MAX = 0x4FFF ,
QK_TO = 0x5000 ,
QK_TO_MAX = 0x50FF ,
QK_MOMENTARY = 0x5100 ,
QK_MOMENTARY_MAX = 0x51FF ,
QK_DEF_LAYER = 0x5200 ,
QK_DEF_LAYER_MAX = 0x52FF ,
QK_TOGGLE_LAYER = 0x5300 ,
QK_TOGGLE_LAYER_MAX = 0x53FF ,
QK_ONE_SHOT_LAYER = 0x5400 ,
QK_ONE_SHOT_LAYER_MAX = 0x54FF ,
QK_ONE_SHOT_MOD = 0x5500 ,
QK_ONE_SHOT_MOD_MAX = 0x55FF ,
2017-02-09 23:06:59 +00:00
QK_TAP_DANCE = 0x5700 ,
QK_TAP_DANCE_MAX = 0x57FF ,
2017-02-15 16:25:33 +00:00
QK_LAYER_TAP_TOGGLE = 0x5800 ,
QK_LAYER_TAP_TOGGLE_MAX = 0x58FF ,
2018-03-21 02:59:54 +00:00
QK_LAYER_MOD = 0x5900 ,
QK_LAYER_MOD_MAX = 0x59FF ,
2017-07-26 21:41:39 +00:00
# ifdef STENO_ENABLE
2017-07-27 18:59:07 +00:00
QK_STENO = 0x5A00 ,
QK_STENO_BOLT = 0x5A30 ,
QK_STENO_GEMINI = 0x5A31 ,
QK_STENO_MAX = 0x5A3F ,
2018-03-11 23:53:35 +00:00
# endif
# ifdef SWAP_HANDS_ENABLE
QK_SWAP_HANDS = 0x5B00 ,
QK_SWAP_HANDS_MAX = 0x5BFF ,
2017-07-26 21:41:39 +00:00
# endif
2017-02-09 23:06:59 +00:00
QK_MOD_TAP = 0x6000 ,
QK_MOD_TAP_MAX = 0x7FFF ,
2017-02-15 17:39:58 +00:00
# if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
# error "Cannot enable both UNICODEMAP && UNICODE"
# endif
2016-12-29 07:28:48 +00:00
# ifdef UNICODE_ENABLE
QK_UNICODE = 0x8000 ,
QK_UNICODE_MAX = 0xFFFF ,
# endif
2017-02-15 16:25:33 +00:00
# ifdef UNICODEMAP_ENABLE
QK_UNICODE_MAP = 0x8000 ,
QK_UNICODE_MAP_MAX = 0x83FF ,
# endif
2016-12-29 07:28:48 +00:00
// Loose keycodes - to be used directly
2017-02-10 17:36:08 +00:00
RESET = 0x5C00 ,
2016-12-29 07:28:48 +00:00
DEBUG ,
MAGIC_SWAP_CONTROL_CAPSLOCK ,
MAGIC_CAPSLOCK_TO_CONTROL ,
MAGIC_SWAP_LALT_LGUI ,
MAGIC_SWAP_RALT_RGUI ,
MAGIC_NO_GUI ,
MAGIC_SWAP_GRAVE_ESC ,
MAGIC_SWAP_BACKSLASH_BACKSPACE ,
MAGIC_HOST_NKRO ,
MAGIC_SWAP_ALT_GUI ,
MAGIC_UNSWAP_CONTROL_CAPSLOCK ,
MAGIC_UNCAPSLOCK_TO_CONTROL ,
MAGIC_UNSWAP_LALT_LGUI ,
MAGIC_UNSWAP_RALT_RGUI ,
MAGIC_UNNO_GUI ,
MAGIC_UNSWAP_GRAVE_ESC ,
MAGIC_UNSWAP_BACKSLASH_BACKSPACE ,
MAGIC_UNHOST_NKRO ,
MAGIC_UNSWAP_ALT_GUI ,
MAGIC_TOGGLE_NKRO ,
2018-09-17 16:23:43 +00:00
MAGIC_TOGGLE_ALT_GUI ,
2017-06-16 21:56:50 +00:00
GRAVE_ESC ,
2016-12-29 07:28:48 +00:00
// Leader key
2018-09-17 17:48:02 +00:00
# ifdef LEADER_ENABLE
2016-12-29 07:28:48 +00:00
KC_LEAD ,
# endif
2017-09-17 05:33:28 +00:00
// Auto Shift setup
KC_ASUP ,
KC_ASDN ,
KC_ASRP ,
2017-12-19 18:06:22 +00:00
KC_ASTG ,
2017-12-19 18:37:25 +00:00
KC_ASON ,
KC_ASOFF ,
2017-09-17 05:33:28 +00:00
2016-12-29 07:28:48 +00:00
// Audio on/off/toggle
AU_ON ,
AU_OFF ,
AU_TOG ,
2018-04-19 05:47:04 +00:00
// Faux clicky as part of main audio feature
CLICKY_TOGGLE ,
2018-06-01 20:29:52 +00:00
CLICKY_ENABLE ,
CLICKY_DISABLE ,
2018-04-19 05:47:04 +00:00
CLICKY_UP ,
CLICKY_DOWN ,
CLICKY_RESET ,
2018-06-01 20:29:52 +00:00
2017-02-13 07:55:35 +00:00
# ifdef FAUXCLICKY_ENABLE
// Faux clicky
FC_ON ,
FC_OFF ,
FC_TOG ,
# endif
2016-12-29 07:28:48 +00:00
// Music mode on/off/toggle
MU_ON ,
MU_OFF ,
MU_TOG ,
2017-07-22 04:14:26 +00:00
// Music mode cycle
MU_MOD ,
2016-12-29 07:28:48 +00:00
// Music voice iterate
MUV_IN ,
MUV_DE ,
2017-02-17 04:49:02 +00:00
// Midi
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
2017-12-10 15:57:52 +00:00
MI_ON ,
MI_OFF ,
MI_TOG ,
2017-02-25 23:02:43 +00:00
# endif
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
2017-02-17 04:49:02 +00:00
MIDI_TONE_MIN ,
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
2017-02-17 04:49:02 +00:00
MI_C = MIDI_TONE_MIN ,
MI_Cs ,
MI_Db = MI_Cs ,
MI_D ,
MI_Ds ,
MI_Eb = MI_Ds ,
MI_E ,
MI_F ,
MI_Fs ,
MI_Gb = MI_Fs ,
MI_G ,
MI_Gs ,
MI_Ab = MI_Gs ,
MI_A ,
MI_As ,
MI_Bb = MI_As ,
MI_B ,
2017-02-20 01:18:05 +00:00
# endif
2017-02-17 04:49:02 +00:00
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
2017-02-17 04:49:02 +00:00
MI_C_1 ,
MI_Cs_1 ,
MI_Db_1 = MI_Cs_1 ,
MI_D_1 ,
MI_Ds_1 ,
MI_Eb_1 = MI_Ds_1 ,
MI_E_1 ,
MI_F_1 ,
MI_Fs_1 ,
MI_Gb_1 = MI_Fs_1 ,
MI_G_1 ,
MI_Gs_1 ,
MI_Ab_1 = MI_Gs_1 ,
MI_A_1 ,
MI_As_1 ,
MI_Bb_1 = MI_As_1 ,
MI_B_1 ,
2017-02-20 01:18:05 +00:00
# endif
2017-02-17 04:49:02 +00:00
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
2017-02-17 04:49:02 +00:00
MI_C_2 ,
MI_Cs_2 ,
MI_Db_2 = MI_Cs_2 ,
MI_D_2 ,
MI_Ds_2 ,
MI_Eb_2 = MI_Ds_2 ,
MI_E_2 ,
MI_F_2 ,
MI_Fs_2 ,
MI_Gb_2 = MI_Fs_2 ,
MI_G_2 ,
MI_Gs_2 ,
MI_Ab_2 = MI_Gs_2 ,
MI_A_2 ,
MI_As_2 ,
MI_Bb_2 = MI_As_2 ,
MI_B_2 ,
2017-02-20 01:18:05 +00:00
# endif
2017-02-17 04:49:02 +00:00
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
2017-02-20 01:18:05 +00:00
MI_C_3 ,
MI_Cs_3 ,
MI_Db_3 = MI_Cs_3 ,
MI_D_3 ,
MI_Ds_3 ,
MI_Eb_3 = MI_Ds_3 ,
MI_E_3 ,
MI_F_3 ,
MI_Fs_3 ,
MI_Gb_3 = MI_Fs_3 ,
MI_G_3 ,
MI_Gs_3 ,
MI_Ab_3 = MI_Gs_3 ,
MI_A_3 ,
MI_As_3 ,
MI_Bb_3 = MI_As_3 ,
MI_B_3 ,
# endif
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
2017-02-20 01:18:05 +00:00
MI_C_4 ,
MI_Cs_4 ,
MI_Db_4 = MI_Cs_4 ,
MI_D_4 ,
MI_Ds_4 ,
MI_Eb_4 = MI_Ds_4 ,
MI_E_4 ,
MI_F_4 ,
MI_Fs_4 ,
MI_Gb_4 = MI_Fs_4 ,
MI_G_4 ,
MI_Gs_4 ,
MI_Ab_4 = MI_Gs_4 ,
MI_A_4 ,
MI_As_4 ,
MI_Bb_4 = MI_As_4 ,
MI_B_4 ,
# endif
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
2017-02-20 01:18:05 +00:00
MI_C_5 ,
MI_Cs_5 ,
MI_Db_5 = MI_Cs_5 ,
MI_D_5 ,
MI_Ds_5 ,
MI_Eb_5 = MI_Ds_5 ,
MI_E_5 ,
MI_F_5 ,
MI_Fs_5 ,
MI_Gb_5 = MI_Fs_5 ,
MI_G_5 ,
MI_Gs_5 ,
MI_Ab_5 = MI_Gs_5 ,
MI_A_5 ,
MI_As_5 ,
MI_Bb_5 = MI_As_5 ,
MI_B_5 ,
# endif
2017-02-26 04:41:13 +00:00
# if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
2017-02-20 01:18:05 +00:00
MIDI_TONE_MAX = MI_B_5 ,
# elif MIDI_TONE_KEYCODE_OCTAVES > 4
MIDI_TONE_MAX = MI_B_4 ,
# elif MIDI_TONE_KEYCODE_OCTAVES > 3
MIDI_TONE_MAX = MI_B_3 ,
# elif MIDI_TONE_KEYCODE_OCTAVES > 2
2017-02-17 04:49:02 +00:00
MIDI_TONE_MAX = MI_B_2 ,
2017-02-20 01:18:05 +00:00
# elif MIDI_TONE_KEYCODE_OCTAVES > 1
MIDI_TONE_MAX = MI_B_1 ,
# elif MIDI_TONE_KEYCODE_OCTAVES > 0
MIDI_TONE_MAX = MI_B ,
# endif
2017-02-17 04:49:02 +00:00
MIDI_OCTAVE_MIN ,
MI_OCT_N2 = MIDI_OCTAVE_MIN ,
MI_OCT_N1 ,
MI_OCT_0 ,
MI_OCT_1 ,
MI_OCT_2 ,
MI_OCT_3 ,
MI_OCT_4 ,
MI_OCT_5 ,
MI_OCT_6 ,
MI_OCT_7 ,
MIDI_OCTAVE_MAX = MI_OCT_7 ,
MI_OCTD , // octave down
MI_OCTU , // octave up
2017-02-18 14:19:48 +00:00
MIDI_TRANSPOSE_MIN ,
MI_TRNS_N6 = MIDI_TRANSPOSE_MIN ,
MI_TRNS_N5 ,
MI_TRNS_N4 ,
MI_TRNS_N3 ,
MI_TRNS_N2 ,
MI_TRNS_N1 ,
MI_TRNS_0 ,
MI_TRNS_1 ,
MI_TRNS_2 ,
MI_TRNS_3 ,
MI_TRNS_4 ,
MI_TRNS_5 ,
MI_TRNS_6 ,
MIDI_TRANSPOSE_MAX = MI_TRNS_6 ,
MI_TRNSD , // transpose down
MI_TRNSU , // transpose up
2017-02-17 04:49:02 +00:00
MIDI_VELOCITY_MIN ,
MI_VEL_1 = MIDI_VELOCITY_MIN ,
MI_VEL_2 ,
MI_VEL_3 ,
2017-02-18 11:12:13 +00:00
MI_VEL_4 ,
2017-02-17 04:49:02 +00:00
MI_VEL_5 ,
MI_VEL_6 ,
MI_VEL_7 ,
MI_VEL_8 ,
MI_VEL_9 ,
MI_VEL_10 ,
MIDI_VELOCITY_MAX = MI_VEL_10 ,
MI_VELD , // velocity down
MI_VELU , // velocity up
MIDI_CHANNEL_MIN ,
MI_CH1 = MIDI_CHANNEL_MIN ,
MI_CH2 ,
MI_CH3 ,
MI_CH4 ,
MI_CH5 ,
MI_CH6 ,
MI_CH7 ,
MI_CH8 ,
MI_CH9 ,
MI_CH10 ,
MI_CH11 ,
MI_CH12 ,
MI_CH13 ,
MI_CH14 ,
MI_CH15 ,
MI_CH16 ,
MIDI_CHANNEL_MAX = MI_CH16 ,
MI_CHD , // previous channel
MI_CHU , // next channel
2017-02-25 23:02:43 +00:00
MI_ALLOFF , // all notes off
2017-02-18 12:25:17 +00:00
2017-02-17 04:49:02 +00:00
MI_SUS , // sustain
2017-02-18 12:25:17 +00:00
MI_PORT , // portamento
MI_SOST , // sostenuto
2017-02-18 13:32:55 +00:00
MI_SOFT , // soft pedal
2017-02-18 12:25:17 +00:00
MI_LEG , // legato
2017-02-18 13:32:55 +00:00
MI_MOD , // modulation
MI_MODSD , // decrease modulation speed
MI_MODSU , // increase modulation speed
2018-04-19 02:22:08 +00:00
MI_BENDD , // Bend down
MI_BENDU , // Bend up
2017-02-25 23:02:43 +00:00
# endif // MIDI_ADVANCED
2016-12-29 07:28:48 +00:00
// Backlight functionality
2018-01-01 22:47:51 +00:00
BL_ON ,
BL_OFF ,
2016-12-29 07:28:48 +00:00
BL_DEC ,
BL_INC ,
BL_TOGG ,
BL_STEP ,
2018-01-01 22:47:51 +00:00
BL_BRTG ,
2016-12-29 07:28:48 +00:00
// RGB functionality
RGB_TOG ,
2017-12-04 18:36:24 +00:00
RGB_MODE_FORWARD ,
RGB_MODE_REVERSE ,
2016-12-29 07:28:48 +00:00
RGB_HUI ,
RGB_HUD ,
RGB_SAI ,
RGB_SAD ,
RGB_VAI ,
RGB_VAD ,
2018-05-09 03:23:21 +00:00
RGB_SPI ,
RGB_SPD ,
2017-09-06 21:49:19 +00:00
RGB_MODE_PLAIN ,
RGB_MODE_BREATHE ,
RGB_MODE_RAINBOW ,
RGB_MODE_SWIRL ,
RGB_MODE_SNAKE ,
RGB_MODE_KNIGHT ,
RGB_MODE_XMAS ,
RGB_MODE_GRADIENT ,
2018-06-04 15:10:39 +00:00
RGB_MODE_RGBTEST ,
2016-12-29 07:28:48 +00:00
// Left shift, open paren
KC_LSPO ,
// Right shift, close paren
KC_RSPC ,
2017-12-14 05:20:44 +00:00
// Shift, Enter
KC_SFTENT ,
2016-12-29 07:28:48 +00:00
// Printing
PRINT_ON ,
PRINT_OFF ,
2017-02-01 08:35:21 +00:00
// output selection
OUT_AUTO ,
OUT_USB ,
# ifdef BLUETOOTH_ENABLE
OUT_BT ,
# endif
2017-08-06 08:50:20 +00:00
# ifdef KEY_LOCK_ENABLE
KC_LOCK ,
# endif
2017-09-12 04:43:10 +00:00
# ifdef TERMINAL_ENABLE
TERM_ON ,
TERM_OFF ,
# endif
2016-12-29 07:28:48 +00:00
// always leave at the end
SAFE_RANGE
} ;
// Ability to use mods in layouts
2018-08-30 01:05:02 +00:00
# define LCTL(kc) (QK_LCTL | (kc))
# define LSFT(kc) (QK_LSFT | (kc))
# define LALT(kc) (QK_LALT | (kc))
# define LGUI(kc) (QK_LGUI | (kc))
2018-03-15 02:23:33 +00:00
# define LCMD(kc) LGUI(kc)
# define LWIN(kc) LGUI(kc)
2018-08-30 01:05:02 +00:00
# define RCTL(kc) (QK_RCTL | (kc))
# define RSFT(kc) (QK_RSFT | (kc))
# define RALT(kc) (QK_RALT | (kc))
# define RGUI(kc) (QK_RGUI | (kc))
2018-03-15 02:23:33 +00:00
# define RCMD(kc) RGUI(kc)
# define RWIN(kc) RGUI(kc)
2016-12-29 07:28:48 +00:00
2018-08-30 01:05:02 +00:00
# define HYPR(kc) (QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI | (kc))
# define MEH(kc) (QK_LCTL | QK_LSFT | QK_LALT | (kc))
# define LCAG(kc) (QK_LCTL | QK_LALT | QK_LGUI | (kc))
# define SGUI(kc) (QK_LGUI | QK_LSFT | (kc))
2018-03-02 00:15:38 +00:00
# define SCMD(kc) SGUI(kc)
# define SWIN(kc) SGUI(kc)
2018-08-30 01:05:02 +00:00
# define LCA(kc) (QK_LCTL | QK_LALT | (kc))
2016-12-29 07:28:48 +00:00
# define MOD_HYPR 0xf
# define MOD_MEH 0x7
// Aliases for shifted symbols
// Each key has a 4-letter code, and some have longer aliases too.
// While the long aliases are descriptive, the 4-letter codes
// make for nicer grid layouts (everything lines up), and are
// the preferred style for Quantum.
# define KC_TILD LSFT(KC_GRV) // ~
# define KC_TILDE KC_TILD
# define KC_EXLM LSFT(KC_1) // !
# define KC_EXCLAIM KC_EXLM
# define KC_AT LSFT(KC_2) // @
# define KC_HASH LSFT(KC_3) // #
# define KC_DLR LSFT(KC_4) // $
# define KC_DOLLAR KC_DLR
# define KC_PERC LSFT(KC_5) // %
# define KC_PERCENT KC_PERC
# define KC_CIRC LSFT(KC_6) // ^
# define KC_CIRCUMFLEX KC_CIRC
# define KC_AMPR LSFT(KC_7) // &
# define KC_AMPERSAND KC_AMPR
# define KC_ASTR LSFT(KC_8) // *
# define KC_ASTERISK KC_ASTR
# define KC_LPRN LSFT(KC_9) // (
# define KC_LEFT_PAREN KC_LPRN
# define KC_RPRN LSFT(KC_0) // )
# define KC_RIGHT_PAREN KC_RPRN
# define KC_UNDS LSFT(KC_MINS) // _
# define KC_UNDERSCORE KC_UNDS
# define KC_PLUS LSFT(KC_EQL) // +
# define KC_LCBR LSFT(KC_LBRC) // {
# define KC_LEFT_CURLY_BRACE KC_LCBR
# define KC_RCBR LSFT(KC_RBRC) // }
# define KC_RIGHT_CURLY_BRACE KC_RCBR
# define KC_LABK LSFT(KC_COMM) // <
# define KC_LEFT_ANGLE_BRACKET KC_LABK
# define KC_RABK LSFT(KC_DOT) // >
# define KC_RIGHT_ANGLE_BRACKET KC_RABK
# define KC_COLN LSFT(KC_SCLN) // :
# define KC_COLON KC_COLN
# define KC_PIPE LSFT(KC_BSLS) // |
# define KC_LT LSFT(KC_COMM) // <
# define KC_GT LSFT(KC_DOT) // >
# define KC_QUES LSFT(KC_SLSH) // ?
# define KC_QUESTION KC_QUES
# define KC_DQT LSFT(KC_QUOT) // "
# define KC_DOUBLE_QUOTE KC_DQT
# define KC_DQUO KC_DQT
# define KC_DELT KC_DELETE // Del key (four letter code)
// Alias for function layers than expand past FN31
2018-08-30 01:05:02 +00:00
# define FUNC(kc) (QK_FUNCTION | (kc))
2016-12-29 07:28:48 +00:00
// Aliases
# define S(kc) LSFT(kc)
# define F(kc) FUNC(kc)
2018-08-30 01:05:02 +00:00
# define M(kc) (QK_MACRO | (kc))
2016-12-29 07:28:48 +00:00
2018-08-30 01:05:02 +00:00
# define MACROTAP(kc) (QK_MACRO | (FUNC_TAP << 8) | (kc))
2016-12-29 07:28:48 +00:00
# define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
2017-06-16 21:56:50 +00:00
# define KC_GESC GRAVE_ESC
2018-04-19 05:47:04 +00:00
# define CK_TOGG CLICKY_TOGGLE
# define CK_RST CLICKY_RESET
# define CK_UP CLICKY_UP
# define CK_DOWN CLICKY_DOWN
2018-06-01 20:29:52 +00:00
# define CK_ON CLICKY_ENABLE
# define CK_OFF CLICKY_DISABLE
2018-04-19 05:47:04 +00:00
2017-12-04 18:36:24 +00:00
# define RGB_MOD RGB_MODE_FORWARD
# define RGB_SMOD RGB_MODE_FORWARD
# define RGB_RMOD RGB_MODE_REVERSE
2017-09-06 21:49:19 +00:00
# define RGB_M_P RGB_MODE_PLAIN
# define RGB_M_B RGB_MODE_BREATHE
# define RGB_M_R RGB_MODE_RAINBOW
# define RGB_M_SW RGB_MODE_SWIRL
# define RGB_M_SN RGB_MODE_SNAKE
# define RGB_M_K RGB_MODE_KNIGHT
# define RGB_M_X RGB_MODE_XMAS
# define RGB_M_G RGB_MODE_GRADIENT
2018-06-04 15:10:39 +00:00
# define RGB_M_T RGB_MODE_RGBTEST
2017-01-28 07:42:35 +00:00
2016-12-29 07:28:48 +00:00
// L-ayer, T-ap - 256 keycode max, 16 layer max
2018-08-30 01:05:02 +00:00
# define LT(layer, kc) (QK_LAYER_TAP | ((layer & 0xF) << 8) | ((kc) & 0xFF))
2016-12-29 07:28:48 +00:00
# define AG_SWAP MAGIC_SWAP_ALT_GUI
# define AG_NORM MAGIC_UNSWAP_ALT_GUI
2018-09-17 16:23:43 +00:00
# define AG_TOGG MAGIC_TOGGLE_ALT_GUI
2016-12-29 07:28:48 +00:00
// GOTO layer - 16 layers max
// when:
// ON_PRESS = 1
// ON_RELEASE = 2
// Unless you have a good reason not to do so, prefer ON_PRESS (1) as your default.
// In fact, we changed it to assume ON_PRESS for sanity/simplicity. If needed, you can add your own
// keycode modeled after the old version, kept below for this.
2018-08-30 01:05:02 +00:00
/* #define TO(layer, when) (QK_TO | (when << 0x4) | (layer & 0xFF)) */
# define TO(layer) (QK_TO | (ON_PRESS << 0x4) | (layer & 0xFF))
2016-12-29 07:28:48 +00:00
// Momentary switch layer - 256 layer max
2018-08-30 01:05:02 +00:00
# define MO(layer) (QK_MOMENTARY | (layer & 0xFF))
2016-12-29 07:28:48 +00:00
// Set default layer - 256 layer max
2018-08-30 01:05:02 +00:00
# define DF(layer) (QK_DEF_LAYER | (layer & 0xFF))
2016-12-29 07:28:48 +00:00
// Toggle to layer - 256 layer max
2018-08-30 01:05:02 +00:00
# define TG(layer) (QK_TOGGLE_LAYER | (layer & 0xFF))
2016-12-29 07:28:48 +00:00
// One-shot layer - 256 layer max
2018-08-30 01:05:02 +00:00
# define OSL(layer) (QK_ONE_SHOT_LAYER | (layer & 0xFF))
2016-12-29 07:28:48 +00:00
2018-03-21 02:59:54 +00:00
// L-ayer M-od: Momentary switch layer with modifiers active - 16 layer max, left mods only
2018-08-30 01:05:02 +00:00
# define LM(layer, mod) (QK_LAYER_MOD | ((layer & 0xF) << 4) | ((mod) & 0xF))
2018-03-21 02:59:54 +00:00
2016-12-29 07:28:48 +00:00
// One-shot mod
2018-08-30 01:05:02 +00:00
# define OSM(mod) (QK_ONE_SHOT_MOD | ((mod) & 0xFF))
2016-12-29 07:28:48 +00:00
2017-02-15 16:25:33 +00:00
// Layer tap-toggle
2018-08-30 01:05:02 +00:00
# define TT(layer) (QK_LAYER_TAP_TOGGLE | (layer & 0xFF))
2017-02-15 16:25:33 +00:00
2016-12-29 07:28:48 +00:00
// M-od, T-ap - 256 keycode max
2018-08-30 01:05:02 +00:00
# define MT(mod, kc) (QK_MOD_TAP | (((mod) & 0x1F) << 8) | ((kc) & 0xFF))
2017-02-09 23:06:59 +00:00
2016-12-29 07:28:48 +00:00
# define CTL_T(kc) MT(MOD_LCTL, kc)
2017-02-09 23:06:59 +00:00
# define LCTL_T(kc) MT(MOD_LCTL, kc)
# define RCTL_T(kc) MT(MOD_RCTL, kc)
2016-12-29 07:28:48 +00:00
# define SFT_T(kc) MT(MOD_LSFT, kc)
2017-02-09 23:06:59 +00:00
# define LSFT_T(kc) MT(MOD_LSFT, kc)
# define RSFT_T(kc) MT(MOD_RSFT, kc)
2016-12-29 07:28:48 +00:00
# define ALT_T(kc) MT(MOD_LALT, kc)
2017-02-09 23:06:59 +00:00
# define LALT_T(kc) MT(MOD_LALT, kc)
# define RALT_T(kc) MT(MOD_RALT, kc)
2017-02-01 02:31:05 +00:00
# define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR
2017-02-09 23:06:59 +00:00
2016-12-29 07:28:48 +00:00
# define GUI_T(kc) MT(MOD_LGUI, kc)
2018-03-15 02:23:33 +00:00
# define CMD_T(kc) GUI_T(kc)
# define WIN_T(kc) GUI_T(kc)
2017-02-09 23:06:59 +00:00
# define LGUI_T(kc) MT(MOD_LGUI, kc)
2018-03-15 02:23:33 +00:00
# define LCMD_T(kc) LGUI_T(kc)
# define LWIN_T(kc) LGUI_T(kc)
2017-02-09 23:06:59 +00:00
# define RGUI_T(kc) MT(MOD_RGUI, kc)
2018-03-15 02:23:33 +00:00
# define RCMD_T(kc) RGUI_T(kc)
# define RWIN_T(kc) RGUI_T(kc)
2017-02-09 23:06:59 +00:00
2018-08-30 01:05:02 +00:00
# define C_S_T(kc) MT(MOD_LCTL | MOD_LSFT, kc) // Control + Shift e.g. for gnome-terminal
# 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
# define LCAG_T(kc) MT(MOD_LCTL | MOD_LALT | MOD_LGUI, kc) // Left control alt and gui
# define RCAG_T(kc) MT(MOD_RCTL | MOD_RALT | MOD_RGUI, kc) // Right control alt and gui
# 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/
# define SGUI_T(kc) MT(MOD_LGUI | MOD_LSFT, kc)
2018-03-02 00:15:38 +00:00
# define SCMD_T(kc) SGUI_T(kc)
# define SWIN_T(kc) SGUI_T(kc)
2018-08-30 01:05:02 +00:00
# define LCA_T(kc) MT(MOD_LCTL | MOD_LALT, kc) // Left control and left alt
2016-12-29 07:28:48 +00:00
// Dedicated keycode versions for Hyper and Meh, if you want to use them as standalone keys rather than mod-tap
# define KC_HYPR HYPR(KC_NO)
# define KC_MEH MEH(KC_NO)
# ifdef UNICODE_ENABLE
// For sending unicode codes.
// You may not send codes over 7FFF -- this supports most of UTF8.
// To have a key that sends out Œ, go UC(0x0152)
2018-08-30 01:05:02 +00:00
# define UNICODE(n) (QK_UNICODE | (n))
2016-12-29 07:28:48 +00:00
# define UC(n) UNICODE(n)
# endif
# ifdef UNICODEMAP_ENABLE
2018-08-30 01:05:02 +00:00
# define X(n) (QK_UNICODE_MAP | (n))
2016-12-29 07:28:48 +00:00
# endif
2018-03-11 23:53:35 +00:00
# ifdef SWAP_HANDS_ENABLE
2018-08-30 01:05:02 +00:00
# define SH_T(kc) (QK_SWAP_HANDS | (kc))
# define SH_TG (QK_SWAP_HANDS | OP_SH_TOGGLE)
# define SH_TT (QK_SWAP_HANDS | OP_SH_TAP_TOGGLE)
# define SH_MON (QK_SWAP_HANDS | OP_SH_ON_OFF)
# define SH_MOFF (QK_SWAP_HANDS | OP_SH_OFF_ON)
# define SH_ON (QK_SWAP_HANDS | OP_SH_ON)
# define SH_OFF (QK_SWAP_HANDS | OP_SH_OFF)
2018-03-11 23:53:35 +00:00
# endif
2016-12-29 07:28:48 +00:00
# endif // QUANTUM_KEYCODES_H