/* Copyright 2012,2013 Jun Wako This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ #ifndef ACTION_H #define ACTION_H #include "keyboard.h" #include "keycode.h" #include "action_macro.h" /* Struct to record event and tap count */ typedef union { struct { bool interrupted :1; bool reserved2 :1; bool reserved1 :1; bool reserved0 :1; uint8_t count :4; }; } tap_t; typedef struct { keyevent_t event; tap_t tap; } keyrecord_t; /* Action struct. * * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15). * AVR looks like a little endian in avr-gcc. * * NOTE: not portable across compiler/endianness? * Byte order and bit order of 0x1234: * Big endian: 15 ... 8 7 ... 210 * | 0x12 | 0x34 | * 0001 0010 0011 0100 * Little endian: 012 ... 7 8 ... 15 * | 0x34 | 0x12 | * 0010 1100 0100 1000 */ typedef union { uint16_t code; struct action_kind { uint16_t param :12; uint8_t id :4; } kind; struct action_key { uint8_t code :8; uint8_t mods :4; uint8_t kind :4; } key; struct action_layer { uint8_t code :8; uint8_t val :4; uint8_t kind :4; } layer; struct action_usage { uint16_t code :10; uint8_t page :2; uint8_t kind :4; } usage; struct action_command { uint8_t id :8; uint8_t opt :4; uint8_t kind :4; } command; struct action_function { uint8_t id :8; uint8_t opt :4; uint8_t kind :4; } func; } action_t; /* Execute action per keyevent */ void action_exec(keyevent_t event); /* action for key */ action_t action_for_key(uint8_t layer, key_t key); /* macro */ const prog_macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt); /* user defined special function */ void action_function(keyrecord_t *record, uint8_t id, uint8_t opt); /* * Utilities for actions. */ void register_code(uint8_t code); void unregister_code(uint8_t code); void add_mods(uint8_t mods); void del_mods(uint8_t mods); void set_mods(uint8_t mods); void clear_keyboard(void); void clear_keyboard_but_mods(void); bool sending_anykey(void); void layer_switch(uint8_t new_layer); bool is_tap_key(key_t key); bool waiting_buffer_has_anykey_pressed(void); /* * Action codes * ============ * 16bit code: action_kind(4bit) + action_parameter(12bit) * * Keyboard Keys(00XX) * ------------------- * ACT_LMODS(0000): * 0000|0000|000000|00 No action * 0000|0000|000000|01 Transparent * 0000|0000| keycode Key * 0000|mods|000000|00 Left mods * 0000|mods| keycode Key & Left mods * * ACT_RMODS(0001): * 0001|0000|000000|00 No action(not used) * 0001|0000|000000|01 Transparent(not used) * 0001|0000| keycode Key(no used) * 0001|mods|000000|00 Right mods * 0001|mods| keycode Key & Right mods * * ACT_LMODS_TAP(0010): * 0010|mods|000000|00 Left mods OneShot * 0010|mods|000000|01 (reserved) * 0010|mods|000000|10 (reserved) * 0010|mods|000000|11 (reserved) * 0010|mods| keycode Left mods + tap Key * * ACT_RMODS_TAP(0011): * 0011|mods|000000|00 Right mods OneShot * 0011|mods|000000|01 (reserved) * 0011|mods|000000|10 (reserved) * 0011|mods|000000|11 (reserved) * 0011|mods| keycode Right mods + tap Key * * * Other keys(01XX) * -------------------- * This action handles other usages than keyboard. * ACT_USAGE(0100): * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01) * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C) * 0100|10| usage(10) (reserved) * 0100|11| usage(10) (reserved) * * ACT_MOUSEKEY(0110): * 0101|XXXX| keycode Mouse key * * * Layer Actions(10XX) * ------------------- * ACT_KEYMAP: * 1000|--xx|0000 0000 Clear keyamp and overlay * 1000|LLLL|0000 00xx Reset default layer and clear keymap and overlay * 1000|LLLL| keycode Invert with tap key * 1000|LLLL|1111 0000 Invert with tap toggle * 1000|LLLL|1111 00xx Invert[^= 1<>4 | (mods)) & 0x0F) /* * Key */ #define ACTION_KEY(key) ACTION(ACT_LMODS, key) /* Mods & key */ #define ACTION_LMODS(mods) ACTION(ACT_LMODS, MODS4(mods)<<8 | 0x00) #define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, MODS4(mods)<<8 | (key)) #define ACTION_RMODS(mods) ACTION(ACT_RMODS, MODS4(mods)<<8 | 0x00) #define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, MODS4(mods)<<8 | (key)) #define ACTION_LMOD(mod) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | 0x00) #define ACTION_LMOD_KEY(mod, key) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_RMOD(mod) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | 0x00) #define ACTION_RMOD_KEY(mod, key) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | (key)) /* Tap key */ enum mods_codes { MODS_ONESHOT = 0x00, }; #define ACTION_LMODS_TAP_KEY(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key)) #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT) #define ACTION_RMODS_TAP_KEY(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key)) #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT) #define ACTION_LMOD_TAP_KEY(mod, key) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_LMOD_ONESHOT(mod) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT) #define ACTION_RMOD_TAP_KEY(mod, key) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT) /* HID Usage */ enum usage_pages { PAGE_SYSTEM, PAGE_CONSUMER }; #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id)) #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id)) /* Mousekey */ #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key) /* Layer Actions: * Invert layer ^= (1<