tmk_core/common/keymap.c

   1 /*
   2 Copyright 2013 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17 #include "keymap.h"
  18 #include "report.h"
  19 #include "keycode.h"
  20 #include "action_layer.h"
  21 #include "action.h"
  22 #include "action_macro.h"
  23 #include "wait.h"
  24 #include "debug.h"
  25 #include "bootloader.h"
  26
  27
  28 static action_t keycode_to_action(uint8_t keycode);
  29
  30
  31 /* converts key to action */
  32 action_t action_for_key(uint8_t layer, keypos_t key)
  33 {
  34     uint8_t keycode = keymap_key_to_keycode(layer, key);
  35     switch (keycode) {
  36         case KC_FN0 ... KC_FN31:
  37             return keymap_fn_to_action(keycode);
  38 #ifdef BOOTMAGIC_ENABLE
  39         case KC_CAPSLOCK:
  40         case KC_LOCKING_CAPS:
  41             if (keymap_config.swap_control_capslock || keymap_config.capslock_to_control) {
  42                 return keycode_to_action(KC_LCTL);
  43             }
  44             return keycode_to_action(keycode);
  45         case KC_LCTL:
  46             if (keymap_config.swap_control_capslock) {
  47                 return keycode_to_action(KC_CAPSLOCK);
  48             }
  49             return keycode_to_action(KC_LCTL);
  50         case KC_LALT:
  51             if (keymap_config.swap_lalt_lgui) {
  52                 if (keymap_config.no_gui) {
  53                     return keycode_to_action(ACTION_NO);
  54                 }
  55                 return keycode_to_action(KC_LGUI);
  56             }
  57             return keycode_to_action(KC_LALT);
  58         case KC_LGUI:
  59             if (keymap_config.swap_lalt_lgui) {
  60                 return keycode_to_action(KC_LALT);
  61             }
  62             if (keymap_config.no_gui) {
  63                 return keycode_to_action(ACTION_NO);
  64             }
  65             return keycode_to_action(KC_LGUI);
  66         case KC_RALT:
  67             if (keymap_config.swap_ralt_rgui) {
  68                 if (keymap_config.no_gui) {
  69                     return keycode_to_action(ACTION_NO);
  70                 }
  71                 return keycode_to_action(KC_RGUI);
  72             }
  73             return keycode_to_action(KC_RALT);
  74         case KC_RGUI:
  75             if (keymap_config.swap_ralt_rgui) {
  76                 return keycode_to_action(KC_RALT);
  77             }
  78             if (keymap_config.no_gui) {
  79                 return keycode_to_action(ACTION_NO);
  80             }
  81             return keycode_to_action(KC_RGUI);
  82         case KC_GRAVE:
  83             if (keymap_config.swap_grave_esc) {
  84                 return keycode_to_action(KC_ESC);
  85             }
  86             return keycode_to_action(KC_GRAVE);
  87         case KC_ESC:
  88             if (keymap_config.swap_grave_esc) {
  89                 return keycode_to_action(KC_GRAVE);
  90             }
  91             return keycode_to_action(KC_ESC);
  92         case KC_BSLASH:
  93             if (keymap_config.swap_backslash_backspace) {
  94                 return keycode_to_action(KC_BSPACE);
  95             }
  96             return keycode_to_action(KC_BSLASH);
  97         case KC_BSPACE:
  98             if (keymap_config.swap_backslash_backspace) {
  99                 return keycode_to_action(KC_BSLASH);
 100             }
 101             return keycode_to_action(KC_BSPACE);
 102 #endif
 103         default:
 104             return keycode_to_action(keycode);
 105     }
 106 }
 107
 108
 109 /* Macro */
 110 __attribute__ ((weak))
 111 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 112 {
 113     (void)record;
 114     (void)id;
 115     (void)opt;
 116     return MACRO_NONE;
 117 }
 118
 119 /* Function */
 120 __attribute__ ((weak))
 121 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
 122 {
 123     (void)record;
 124     (void)id;
 125     (void)opt;
 126 }
 127
 128
 129
 130 /* translates keycode to action */
 131 static action_t keycode_to_action(uint8_t keycode)
 132 {
 133     action_t action;
 134     switch (keycode) {
 135         case KC_A ... KC_EXSEL:
 136         case KC_LCTRL ... KC_RGUI:
 137             action.code = ACTION_KEY(keycode);
 138             break;
 139         case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
 140             action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(keycode));
 141             break;
 142         case KC_AUDIO_MUTE ... KC_MEDIA_REWIND:
 143             action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(keycode));
 144             break;
 145         case KC_MS_UP ... KC_MS_ACCEL2:
 146             action.code = ACTION_MOUSEKEY(keycode);
 147             break;
 148         case KC_TRNS:
 149             action.code = ACTION_TRANSPARENT;
 150             break;
 151         case KC_BOOTLOADER:
 152             clear_keyboard();
 153             wait_ms(50);
 154             bootloader_jump(); // not return
 155             break;
 156         default:
 157             action.code = ACTION_NO;
 158             break;
 159     }
 160     return action;
 161 }
 162
 163
 164
 165 #ifdef USE_LEGACY_KEYMAP
 166 /*
 167  * Legacy keymap support
 168  *      Consider using new keymap API instead.
 169  */
 170 __attribute__ ((weak))
 171 uint8_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
 172 {
 173     return keymap_get_keycode(layer, key.row, key.col);
 174 }
 175
 176
 177 /* Legacy keymap support */
 178 __attribute__ ((weak))
 179 action_t keymap_fn_to_action(uint8_t keycode)
 180 {
 181     action_t action = { .code = ACTION_NO };
 182     switch (keycode) {
 183         case KC_FN0 ... KC_FN31:
 184             {
 185                 uint8_t layer = keymap_fn_layer(FN_INDEX(keycode));
 186                 uint8_t key = keymap_fn_keycode(FN_INDEX(keycode));
 187                 if (key) {
 188                     action.code = ACTION_LAYER_TAP_KEY(layer, key);
 189                 } else {
 190                     action.code = ACTION_LAYER_MOMENTARY(layer);
 191                 }
 192             }
 193             return action;
 194         default:
 195             return action;
 196     }
 197 }
 198 #endif