[jackhill/qmk/firmware.git] / quantum / quantum_keycodes.h

/* 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/>.
 */
#ifndef QUANTUM_KEYCODES_H
#define QUANTUM_KEYCODES_H

#ifndef MIDI_ENABLE_STRICT
#define MIDI_ENABLE_STRICT 0
#endif

#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
#ifndef MIDI_TONE_KEYCODE_OCTAVES
#define MIDI_TONE_KEYCODE_OCTAVES 3
#endif
#endif

// Fillers to make layering more clear
#define _______ KC_TRNS
#define XXXXXXX KC_NO

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,
#ifndef DISABLE_CHORDING
    QK_CHORDING           = 0x5600,
    QK_CHORDING_MAX       = 0x56FF,
#endif
    QK_TAP_DANCE          = 0x5700,
    QK_TAP_DANCE_MAX      = 0x57FF,
    QK_LAYER_TAP_TOGGLE   = 0x5800,
    QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
#ifdef STENO_ENABLE
    QK_STENO              = 0x5A00,
    QK_STENO_BOLT         = 0x5A30,
    QK_STENO_GEMINI       = 0x5A31,
    QK_STENO_MAX          = 0x5A3F,
#endif
    QK_MOD_TAP            = 0x6000,
    QK_MOD_TAP_MAX        = 0x7FFF,
#if defined(UNICODEMAP_ENABLE) && defined(UNICODE_ENABLE)
    #error "Cannot enable both UNICODEMAP && UNICODE"
#endif
#ifdef UNICODE_ENABLE
    QK_UNICODE            = 0x8000,
    QK_UNICODE_MAX        = 0xFFFF,
#endif
#ifdef UNICODEMAP_ENABLE
    QK_UNICODE_MAP        = 0x8000,
    QK_UNICODE_MAP_MAX    = 0x83FF,
#endif

    // Loose keycodes - to be used directly

    RESET = 0x5C00,
    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,
    GRAVE_ESC,

    // Leader key
#ifndef DISABLE_LEADER
    KC_LEAD,
#endif

    // Auto Shift setup
    KC_ASUP,
    KC_ASDN,
    KC_ASRP,
    KC_ASTG,
    KC_ASON,
    KC_ASOFF,

    // Audio on/off/toggle
    AU_ON,
    AU_OFF,
    AU_TOG,

#ifdef FAUXCLICKY_ENABLE
    // Faux clicky
    FC_ON,
    FC_OFF,
    FC_TOG,
#endif

    // Music mode on/off/toggle
    MU_ON,
    MU_OFF,
    MU_TOG,

    // Music mode cycle
    MU_MOD,

    // Music voice iterate
    MUV_IN,
    MUV_DE,

    // Midi
#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
    MI_ON,
    MI_OFF,
    MI_TOG,
#endif

#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_ADVANCED))
    MIDI_TONE_MIN,

#if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 0
    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,
#endif

#if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 1
    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,
#endif

#if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 2
    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,
#endif

#if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 3
    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

#if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 4
    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

#if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
    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

#if !MIDI_ENABLE_STRICT || MIDI_TONE_KEYCODE_OCTAVES > 5
    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
    MIDI_TONE_MAX = MI_B_2,
#elif MIDI_TONE_KEYCODE_OCTAVES > 1
    MIDI_TONE_MAX = MI_B_1,
#elif MIDI_TONE_KEYCODE_OCTAVES > 0
    MIDI_TONE_MAX = MI_B,
#endif

    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

    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

    MIDI_VELOCITY_MIN,
    MI_VEL_1 = MIDI_VELOCITY_MIN,
    MI_VEL_2,
    MI_VEL_3,
    MI_VEL_4,
    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

    MI_ALLOFF, // all notes off

    MI_SUS, // sustain
    MI_PORT, // portamento
    MI_SOST, // sostenuto
    MI_SOFT, // soft pedal
    MI_LEG,  // legato

    MI_MOD, // modulation
    MI_MODSD, // decrease modulation speed
    MI_MODSU, // increase modulation speed
#endif // MIDI_ADVANCED

    // Backlight functionality
    BL_ON,
    BL_OFF,
    BL_DEC,
    BL_INC,
    BL_TOGG,
    BL_STEP,
    BL_BRTG,

    // RGB functionality
    RGB_TOG,
    RGB_MODE_FORWARD,
    RGB_MODE_REVERSE,
    RGB_HUI,
    RGB_HUD,
    RGB_SAI,
    RGB_SAD,
    RGB_VAI,
    RGB_VAD,
    RGB_MODE_PLAIN,
    RGB_MODE_BREATHE,
    RGB_MODE_RAINBOW,
    RGB_MODE_SWIRL,
    RGB_MODE_SNAKE,
    RGB_MODE_KNIGHT,
    RGB_MODE_XMAS,
    RGB_MODE_GRADIENT,

    // Left shift, open paren
    KC_LSPO,

    // Right shift, close paren
    KC_RSPC,

    // Shift, Enter
    KC_SFTENT,

    // Printing
    PRINT_ON,
    PRINT_OFF,

    // output selection
    OUT_AUTO,
    OUT_USB,
#ifdef BLUETOOTH_ENABLE
    OUT_BT,
#endif

#ifdef KEY_LOCK_ENABLE
    KC_LOCK,
#endif

#ifdef TERMINAL_ENABLE
    TERM_ON,
    TERM_OFF,
#endif

    // always leave at the end
    SAFE_RANGE
};

// Ability to use mods in layouts
#define LCTL(kc) (kc | QK_LCTL)
#define LSFT(kc) (kc | QK_LSFT)
#define LALT(kc) (kc | QK_LALT)
#define LGUI(kc) (kc | QK_LGUI)
#define RCTL(kc) (kc | QK_RCTL)
#define RSFT(kc) (kc | QK_RSFT)
#define RALT(kc) (kc | QK_RALT)
#define RGUI(kc) (kc | QK_RGUI)

#define HYPR(kc) (kc | QK_LCTL | QK_LSFT | QK_LALT | QK_LGUI)
#define MEH(kc)  (kc | QK_LCTL | QK_LSFT | QK_LALT)
#define LCAG(kc) (kc | QK_LCTL | QK_LALT | QK_LGUI)
#define ALTG(kc) (kc | QK_RCTL | QK_RALT)
#define SGUI(kc) (kc | QK_LGUI | QK_LSFT)
#define SCMD(kc) SGUI(kc)
#define SWIN(kc) SGUI(kc)
#define LCA(kc) (kc | QK_LCTL | QK_LALT)

#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
#define FUNC(kc) (kc | QK_FUNCTION)

// Aliases
#define S(kc) LSFT(kc)
#define F(kc) FUNC(kc)

#define M(kc) (kc | QK_MACRO)

#define MACROTAP(kc) (kc | QK_MACRO | FUNC_TAP<<8)
#define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)

#define KC_GESC GRAVE_ESC

#define RGB_MOD RGB_MODE_FORWARD
#define RGB_SMOD RGB_MODE_FORWARD
#define RGB_RMOD RGB_MODE_REVERSE

#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

// L-ayer, T-ap - 256 keycode max, 16 layer max
#define LT(layer, kc) (kc | QK_LAYER_TAP | ((layer & 0xF) << 8))

#define AG_SWAP MAGIC_SWAP_ALT_GUI
#define AG_NORM MAGIC_UNSWAP_ALT_GUI

// 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.
/* #define TO(layer, when) (layer | QK_TO | (when << 0x4)) */
#define TO(layer) (layer | QK_TO | (ON_PRESS << 0x4))

// Momentary switch layer - 256 layer max
#define MO(layer) (layer | QK_MOMENTARY)

// Set default layer - 256 layer max
#define DF(layer) (layer | QK_DEF_LAYER)

// Toggle to layer - 256 layer max
#define TG(layer) (layer | QK_TOGGLE_LAYER)

// One-shot layer - 256 layer max
#define OSL(layer) (layer | QK_ONE_SHOT_LAYER)

// One-shot mod
#define OSM(mod) ((mod) | QK_ONE_SHOT_MOD)

// Layer tap-toggle
#define TT(layer) (layer | QK_LAYER_TAP_TOGGLE)

// M-od, T-ap - 256 keycode max
#define MT(mod, kc) (kc | QK_MOD_TAP | (((mod) & 0x1F) << 8))

#define CTL_T(kc) MT(MOD_LCTL, kc)
#define LCTL_T(kc) MT(MOD_LCTL, kc)
#define RCTL_T(kc) MT(MOD_RCTL, kc)

#define SFT_T(kc) MT(MOD_LSFT, kc)
#define LSFT_T(kc) MT(MOD_LSFT, kc)
#define RSFT_T(kc) MT(MOD_RSFT, kc)

#define ALT_T(kc) MT(MOD_LALT, kc)
#define LALT_T(kc) MT(MOD_LALT, kc)
#define RALT_T(kc) MT(MOD_RALT, kc)
#define ALGR_T(kc) MT(MOD_RALT, kc) // dual-function AltGR

#define GUI_T(kc) MT(MOD_LGUI, kc)
#define LGUI_T(kc) MT(MOD_LGUI, kc)
#define RGUI_T(kc) MT(MOD_RGUI, kc)

#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)
#define SCMD_T(kc) SGUI_T(kc)
#define SWIN_T(kc) SGUI_T(kc)
#define LCA_T(kc) MT((MOD_LCTL | MOD_LALT), kc) // Left control and left alt

// 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)
    #define UNICODE(n) (n | QK_UNICODE)
    #define UC(n) UNICODE(n)
#endif

#ifdef UNICODEMAP_ENABLE
    #define X(n) (n | QK_UNICODE_MAP)
#endif

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