[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,
    QK_TAP_DANCE          = 0x5700,
    QK_TAP_DANCE_MAX      = 0x57FF,
    QK_LAYER_TAP_TOGGLE   = 0x5800,
    QK_LAYER_TAP_TOGGLE_MAX = 0x58FF,
    QK_LAYER_MOD          = 0x5900,
    QK_LAYER_MOD_MAX      = 0x59FF,
#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,
#ifdef UNICODE_ENABLE
    QK_UNICODE            = 0x8000,
    QK_UNICODE_MAX        = 0xFFFF,
#endif
#ifdef UNICODEMAP_ENABLE
    QK_UNICODEMAP         = 0x8000,
    QK_UNICODEMAP_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,
    MAGIC_TOGGLE_ALT_GUI,
    GRAVE_ESC,

    // Leader key
#ifdef LEADER_ENABLE
    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,

    // Faux clicky as part of main audio feature
    CLICKY_TOGGLE,
    CLICKY_ENABLE,
    CLICKY_DISABLE,
    CLICKY_UP,
    CLICKY_DOWN,
    CLICKY_RESET,


#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

    MI_BENDD, // Bend down
    MI_BENDU, // Bend up
#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_SPI,
    RGB_SPD,
    RGB_MODE_PLAIN,
    RGB_MODE_BREATHE,
    RGB_MODE_RAINBOW,
    RGB_MODE_SWIRL,
    RGB_MODE_SNAKE,
    RGB_MODE_KNIGHT,
    RGB_MODE_XMAS,
    RGB_MODE_GRADIENT,
    RGB_MODE_RGBTEST,

    //Momentum matching toggle
    VLK_TOG,

    // 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

        EEPROM_RESET,

        UNICODE_MODE_FORWARD,
        UNICODE_MODE_REVERSE,

        UNICODE_MODE_OSX,
        UNICODE_MODE_LNX,
        UNICODE_MODE_WIN,
        UNICODE_MODE_BSD,
        UNICODE_MODE_WINC,

        HPT_ON,
        HPT_OFF,
        HPT_TOG,
        HPT_RST,
        HPT_FBK,
        HPT_BUZ,
        HPT_MODI,
        HPT_MODD,
        HPT_DWLI,
        HPT_DWLD,

        // always leave at the end
        SAFE_RANGE
    };

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

#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))
#define SCMD(kc) SGUI(kc)
#define SWIN(kc) SGUI(kc)
#define LCA(kc)  (QK_LCTL | QK_LALT | (kc))

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

// Aliases
#define C(kc) LCTL(kc)
#define S(kc) LSFT(kc)
#define A(kc) LALT(kc)
#define G(kc) LGUI(kc)

#define F(kc) FUNC(kc)
#define M(kc) (QK_MACRO | (kc))

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

#define KC_GESC GRAVE_ESC

#define EEP_RST EEPROM_RESET

#define CK_TOGG CLICKY_TOGGLE
#define CK_RST CLICKY_RESET
#define CK_UP CLICKY_UP
#define CK_DOWN CLICKY_DOWN
#define CK_ON CLICKY_ENABLE
#define CK_OFF CLICKY_DISABLE

#define RGB_MOD 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
#define RGB_M_T RGB_MODE_RGBTEST

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

#define AG_SWAP MAGIC_SWAP_ALT_GUI
#define AG_NORM MAGIC_UNSWAP_ALT_GUI
#define AG_TOGG MAGIC_TOGGLE_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) (QK_TO | (when << 0x4) | (layer & 0xFF)) */
#define TO(layer) (QK_TO | (ON_PRESS << 0x4) | ((layer) & 0xFF))

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

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

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

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

// L-ayer M-od: Momentary switch layer with modifiers active - 16 layer max, left mods only
#define LM(layer, mod) (QK_LAYER_MOD | (((layer) & 0xF) << 4) | ((mod) & 0xF))

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

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

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

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

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

#define LALT_T(kc) MT(MOD_LALT, kc)
#define RALT_T(kc) MT(MOD_RALT, kc)
#define ALT_T(kc)  LALT_T(kc)
#define ALGR_T(kc) RALT_T(kc)

#define LGUI_T(kc) MT(MOD_LGUI, kc)
#define RGUI_T(kc) MT(MOD_RGUI, kc)
#define LCMD_T(kc) LGUI_T(kc)
#define LWIN_T(kc) LGUI_T(kc)
#define RCMD_T(kc) RGUI_T(kc)
#define RWIN_T(kc) RGUI_T(kc)
#define GUI_T(kc)  LGUI_T(kc)
#define CMD_T(kc)  LCMD_T(kc)
#define WIN_T(kc)  LWIN_T(kc)

#define C_S_T(kc)  MT(MOD_LCTL | MOD_LSFT, kc) // Left 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 GUI, so just Left Control + Shift + Alt
#define LCAG_T(kc) MT(MOD_LCTL | MOD_LALT | MOD_LGUI, kc) // Left Control + Alt + GUI
#define RCAG_T(kc) MT(MOD_RCTL | MOD_RALT | MOD_RGUI, kc) // Right Control + Alt + GUI
#define HYPR_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) // Left Shift + GUI
#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 + Alt
#define ALL_T(kc)  HYPR_T(kc)

// 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
  // Allows Unicode input up to 0x7FFF
  #define UC(c) (QK_UNICODE | (c))
#endif
#ifdef UNICODEMAP_ENABLE
  // Allows Unicode input up to 0x10FFFF, requires unicode_map
  #define X(i) (QK_UNICODEMAP | (i))
#endif

#define UC_MOD  UNICODE_MODE_FORWARD
#define UC_RMOD UNICODE_MODE_REVERSE

#define UC_M_OS UNICODE_MODE_OSX
#define UC_M_LN UNICODE_MODE_LNX
#define UC_M_WI UNICODE_MODE_WIN
#define UC_M_BS UNICODE_MODE_BSD
#define UC_M_WC UNICODE_MODE_WINC

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