common/action.h

   1 /*
   2 Copyright 2012,2013 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 #ifndef ACTION_H
  18 #define ACTION_H
  19
  20 #include <stdint.h>
  21 #include <stdbool.h>
  22 #include "keyboard.h"
  23 #include "keycode.h"
  24 #include "action_code.h"
  25 #include "action_macro.h"
  26
  27
  28 /* Key event container for recording */
  29 typedef struct {
  30     keyevent_t  event;
  31 #ifndef NO_ACTION_TAPPING
  32     /* tapping count and state */
  33     struct {
  34         bool    interrupted :1;
  35         bool    reserved2   :1;
  36         bool    reserved1   :1;
  37         bool    reserved0   :1;
  38         uint8_t count       :4;
  39     } tap;
  40 #endif
  41 } keyrecord_t;
  42
  43
  44 /* Execute action per keyevent */
  45 void action_exec(keyevent_t event);
  46
  47 /* action for key */
  48 action_t action_for_key(uint8_t layer, key_t key);
  49
  50 /* macro */
  51 const prog_macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt);
  52
  53 /* user defined special function */
  54 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt);
  55
  56 /* Utilities for actions.  */
  57 void process_action(keyrecord_t *record);
  58 void register_code(uint8_t code);
  59 void unregister_code(uint8_t code);
  60 void add_mods(uint8_t mods);
  61 void del_mods(uint8_t mods);
  62 void set_mods(uint8_t mods);
  63 void clear_keyboard(void);
  64 void clear_keyboard_but_mods(void);
  65 bool sending_anykey(void);
  66 void layer_switch(uint8_t new_layer);
  67 bool is_tap_key(key_t key);
  68
  69 /* debug */
  70 void debug_event(keyevent_t event);
  71 void debug_record(keyrecord_t record);
  72 void debug_action(action_t action);
  73
  74 #endif  /* ACTION_H */