]> git.gir.st - tmk_keyboard.git/blob - common/keymap.h
Change keymap API
[tmk_keyboard.git] / 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 // TODO: move to action.h?
27 /* layer used currently */
28 extern uint8_t current_layer;
29 /* layer to return or start with */
30 extern uint8_t default_layer;
31
32
33 /* translates key_t to keycode */
34 uint8_t keymap_key_to_keycode(uint8_t layer, key_t key);
35 /* translates keycode to action */
36 action_t keymap_keycode_to_action(uint8_t keycode);
37 /* translates Fn keycode to action */
38 action_t keymap_fn_to_action(uint8_t keycode);
39
40
41 /* action for key */
42 // TODO: should use struct key_t? move to action.h?
43 action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col);
44
45 /* user defined special function */
46 void keymap_call_function(keyrecord_t *record, uint8_t id, uint8_t opt);
47
48
49
50 #ifndef NO_LEGACY_KEYMAP_SUPPORT
51 /* keycode of key */
52 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col);
53
54 /* layer to move during press Fn key */
55 uint8_t keymap_fn_layer(uint8_t fn_bits);
56
57 /* keycode to send when release Fn key without using */
58 uint8_t keymap_fn_keycode(uint8_t fn_bits);
59 #endif
60
61 #endif
Imprint / Impressum