tmk_core/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 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* tapping count and state */
  33 typedef struct {
  34     bool    interrupted :1;
  35     bool    reserved2   :1;
  36     bool    reserved1   :1;
  37     bool    reserved0   :1;
  38     uint8_t count       :4;
  39 } tap_t;
  40
  41 /* Key event container for recording */
  42 typedef struct {
  43     keyevent_t  event;
  44 #ifndef NO_ACTION_TAPPING
  45     tap_t tap;
  46 #endif
  47 } keyrecord_t;
  48
  49 /* Execute action per keyevent */
  50 void action_exec(keyevent_t event);
  51
  52 /* action for key */
  53 action_t action_for_key(uint8_t layer, keypos_t key);
  54
  55 /* macro */
  56 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt);
  57
  58 /* user defined special function */
  59 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt);
  60
  61 /* keyboard-specific key event (pre)processing */
  62 bool process_record_quantum(keyrecord_t *record);
  63
  64 /* Utilities for actions.  */
  65 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
  66 extern bool disable_action_cache;
  67 #endif
  68
  69 /* Code for handling one-handed key modifiers. */
  70 #ifdef ONEHAND_ENABLE
  71 extern bool swap_hands;
  72 extern const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS];
  73 #if (MATRIX_COLS <= 8)
  74 typedef  uint8_t    swap_state_row_t;
  75 #elif (MATRIX_COLS <= 16)
  76 typedef  uint16_t   swap_state_row_t;
  77 #elif (MATRIX_COLS <= 32)
  78 typedef  uint32_t   swap_state_row_t;
  79 #else
  80 #error "MATRIX_COLS: invalid value"
  81 #endif
  82
  83 void process_hand_swap(keyevent_t *record);
  84 #endif
  85
  86 void process_record_nocache(keyrecord_t *record);
  87 void process_record(keyrecord_t *record);
  88 void process_action(keyrecord_t *record, action_t action);
  89 void register_code(uint8_t code);
  90 void unregister_code(uint8_t code);
  91 void register_mods(uint8_t mods);
  92 void unregister_mods(uint8_t mods);
  93 //void set_mods(uint8_t mods);
  94 void clear_keyboard(void);
  95 void clear_keyboard_but_mods(void);
  96 void layer_switch(uint8_t new_layer);
  97 bool is_tap_key(keypos_t key);
  98
  99 /* debug */
 100 void debug_event(keyevent_t event);
 101 void debug_record(keyrecord_t record);
 102 void debug_action(action_t action);
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif  /* ACTION_H */