[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
#ifdef SWAP_HANDS_ENABLE
    QK_SWAP_HANDS         = 0x5B00,
    QK_SWAP_HANDS_MAX     = 0x5BFF,
#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 LCMD(kc) LGUI(kc)
#define LWIN(kc) LGUI(kc)
#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 RCMD(kc) RGUI(kc)
#define RWIN(kc) RGUI(kc)

#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 CMD_T(kc) GUI_T(kc)
#define WIN_T(kc) GUI_T(kc)
#define LGUI_T(kc) MT(MOD_LGUI, kc)
#define LCMD_T(kc) LGUI_T(kc)
#define LWIN_T(kc) LGUI_T(kc)
#define RGUI_T(kc) MT(MOD_RGUI, kc)
#define RCMD_T(kc) RGUI_T(kc)
#define RWIN_T(kc) RGUI_T(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

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