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 "debug.h"
  24
  25
  26 static action_t keycode_to_action(uint8_t keycode);
  27
  28
  29 /* converts key to action */
  30 action_t action_for_key(uint8_t layer, keypos_t key)
  31 {
  32     uint8_t keycode = keymap_key_to_keycode(layer, key);
  33     switch (keycode) {
  34         case KC_FN0 ... KC_FN31:
  35             return keymap_fn_to_action(keycode);
  36 #ifdef BOOTMAGIC_ENABLE
  37         case KC_CAPSLOCK:
  38         case KC_LOCKING_CAPS:
  39             if (keymap_config.swap_control_capslock || keymap_config.capslock_to_control) {
  40                 return keycode_to_action(KC_LCTL);
  41             }
  42             return keycode_to_action(keycode);
  43         case KC_LCTL:
  44             if (keymap_config.swap_control_capslock) {
  45                 return keycode_to_action(KC_CAPSLOCK);
  46             }
  47             return keycode_to_action(KC_LCTL);
  48         case KC_LALT:
  49             if (keymap_config.swap_lalt_lgui) {
  50                 if (keymap_config.no_gui) {
  51                     return keycode_to_action(ACTION_NO);
  52                 }
  53                 return keycode_to_action(KC_LGUI);
  54             }
  55             return keycode_to_action(KC_LALT);
  56         case KC_LGUI:
  57             if (keymap_config.swap_lalt_lgui) {
  58                 return keycode_to_action(KC_LALT);
  59             }
  60             if (keymap_config.no_gui) {
  61                 return keycode_to_action(ACTION_NO);
  62             }
  63             return keycode_to_action(KC_LGUI);
  64         case KC_RALT:
  65             if (keymap_config.swap_ralt_rgui) {
  66                 if (keymap_config.no_gui) {
  67                     return keycode_to_action(ACTION_NO);
  68                 }
  69                 return keycode_to_action(KC_RGUI);
  70             }
  71             return keycode_to_action(KC_RALT);
  72         case KC_RGUI:
  73             if (keymap_config.swap_ralt_rgui) {
  74                 return keycode_to_action(KC_RALT);
  75             }
  76             if (keymap_config.no_gui) {
  77                 return keycode_to_action(ACTION_NO);
  78             }
  79             return keycode_to_action(KC_RGUI);
  80         case KC_GRAVE:
  81             if (keymap_config.swap_grave_esc) {
  82                 return keycode_to_action(KC_ESC);
  83             }
  84             return keycode_to_action(KC_GRAVE);
  85         case KC_ESC:
  86             if (keymap_config.swap_grave_esc) {
  87                 return keycode_to_action(KC_GRAVE);
  88             }
  89             return keycode_to_action(KC_ESC);
  90         case KC_BSLASH:
  91             if (keymap_config.swap_backslash_backspace) {
  92                 return keycode_to_action(KC_BSPACE);
  93             }
  94             return keycode_to_action(KC_BSLASH);
  95         case KC_BSPACE:
  96             if (keymap_config.swap_backslash_backspace) {
  97                 return keycode_to_action(KC_BSLASH);
  98             }
  99             return keycode_to_action(KC_BSPACE);
 100 #endif
 101         default:
 102             return keycode_to_action(keycode);
 103     }
 104 }
 105
 106
 107 /* Macro */
 108 __attribute__ ((weak))
 109 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 110 {
 111     (void)record;
 112     (void)id;
 113     (void)opt;
 114     return MACRO_NONE;
 115 }
 116
 117 /* Function */
 118 __attribute__ ((weak))
 119 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
 120 {
 121     (void)record;
 122     (void)id;
 123     (void)opt;
 124 }
 125
 126
 127
 128 /* translates keycode to action */
 129 static action_t keycode_to_action(uint8_t keycode)
 130 {
 131     action_t action;
 132     switch (keycode) {
 133         case KC_A ... KC_EXSEL:
 134         case KC_LCTRL ... KC_RGUI:
 135             action.code = ACTION_KEY(keycode);
 136             break;
 137         case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
 138             action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(keycode));
 139             break;
 140         case KC_AUDIO_MUTE ... KC_MEDIA_REWIND:
 141             action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(keycode));
 142             break;
 143         case KC_MS_UP ... KC_MS_ACCEL2:
 144             action.code = ACTION_MOUSEKEY(keycode);
 145             break;
 146         case KC_TRNS:
 147             action.code = ACTION_TRANSPARENT;
 148             break;
 149         default:
 150             action.code = ACTION_NO;
 151             break;
 152     }
 153     return action;
 154 }
 155
 156
 157
 158 #ifdef USE_LEGACY_KEYMAP
 159 /*
 160  * Legacy keymap support
 161  *      Consider using new keymap API instead.
 162  */
 163 __attribute__ ((weak))
 164 uint8_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
 165 {
 166     return keymap_get_keycode(layer, key.row, key.col);
 167 }
 168
 169
 170 /* Legacy keymap support */
 171 __attribute__ ((weak))
 172 action_t keymap_fn_to_action(uint8_t keycode)
 173 {
 174     action_t action = { .code = ACTION_NO };
 175     switch (keycode) {
 176         case KC_FN0 ... KC_FN31:
 177             {
 178                 uint8_t layer = keymap_fn_layer(FN_INDEX(keycode));
 179                 uint8_t key = keymap_fn_keycode(FN_INDEX(keycode));
 180                 if (key) {
 181                     action.code = ACTION_LAYER_TAP_KEY(layer, key);
 182                 } else {
 183                     action.code = ACTION_LAYER_MOMENTARY(layer);
 184                 }
 185             }
 186             return action;
 187         default:
 188             return action;
 189     }
 190 }
 191 #endif