tmk_core/common/keymap.h

   1 /*
   2 Copyright 2011 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
  18 #ifndef KEYMAP_H
  19 #define KEYMAP_H
  20
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include "action.h"
  24
  25
  26 #ifdef BOOTMAGIC_ENABLE
  27 /* NOTE: Not portable. Bit field order depends on implementation */
  28 typedef union {
  29     uint8_t raw;
  30     struct {
  31         bool swap_control_capslock:1;
  32         bool capslock_to_control:1;
  33         bool swap_lalt_lgui:1;
  34         bool swap_ralt_rgui:1;
  35         bool no_gui:1;
  36         bool swap_grave_esc:1;
  37         bool swap_backslash_backspace:1;
  38         bool nkro:1;
  39     };
  40 } keymap_config_t;
  41 #endif
  42
  43
  44 /* translates key to keycode */
  45 uint8_t keymap_key_to_keycode(uint8_t layer, keypos_t key);
  46
  47 /* translates Fn keycode to action */
  48 action_t keymap_fn_to_action(uint8_t keycode);
  49
  50
  51
  52 #ifdef USE_LEGACY_KEYMAP
  53 /*
  54  * Legacy keymap
  55  *      Consider using new keymap API above instead.
  56  */
  57 /* keycode of key */
  58 __attribute__ ((deprecated))
  59 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col);
  60
  61 /* layer to move during press Fn key */
  62 __attribute__ ((deprecated))
  63 uint8_t keymap_fn_layer(uint8_t fn_bits);
  64
  65 /* keycode to send when release Fn key without using */
  66 __attribute__ ((deprecated))
  67 uint8_t keymap_fn_keycode(uint8_t fn_bits);
  68 #endif
  69
  70 #endif