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 /* translates key to keycode */
  27 uint8_t keymap_key_to_keycode(uint8_t layer, key_t key);
  28
  29 /* translates Fn keycode to action */
  30 action_t keymap_fn_to_action(uint8_t keycode);
  31
  32
  33
  34 #ifdef USE_LEGACY_KEYMAP
  35 /*
  36  * Legacy keymap
  37  *      Consider using new keymap API above instead.
  38  */
  39 /* keycode of key */
  40 __attribute__ ((deprecated))
  41 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col);
  42
  43 /* layer to move during press Fn key */
  44 __attribute__ ((deprecated))
  45 uint8_t keymap_fn_layer(uint8_t fn_bits);
  46
  47 /* keycode to send when release Fn key without using */
  48 __attribute__ ((deprecated))
  49 uint8_t keymap_fn_keycode(uint8_t fn_bits);
  50 #endif
  51
  52 #endif