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 /* layer used currently */
  27 extern uint8_t current_layer;
  28 /* layer to return or start with */
  29 extern uint8_t default_layer;
  30
  31
  32 /* action for key */
  33 // TODO: should use struct key_t?
  34 action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col);
  35
  36 /* user defined special function */
  37 void keymap_call_function(keyrecord_t *record, uint8_t id);
  38
  39
  40 #ifndef NO_LEGACY_KEYMAP_SUPPORT
  41 /* keycode of key */
  42 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col);
  43
  44 /* layer to move during press Fn key */
  45 uint8_t keymap_fn_layer(uint8_t fn_bits);
  46
  47 /* keycode to send when release Fn key without using */
  48 uint8_t keymap_fn_keycode(uint8_t fn_bits);
  49 #endif
  50
  51 #endif