common/action_oneshot.h

   1 /*
   2 Copyright 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_ONESHOT_H
  18 #define ACTION_ONESHOT_H
  19
  20 #include <stdint.h>
  21 #include <stdbool.h>
  22
  23 #ifdef NO_ACTION_TAPPING
  24     #define NO_ACTION_ONESHOT
  25 #endif
  26
  27 #ifndef NO_ACTION_ONESHOT
  28 /* Oneshot modifier
  29  *
  30  * Problem: Want to capitalize like 'The' but the result tends to be 'THe'.
  31  * Solution: Oneshot modifier have its effect on only one key coming next.
  32  *           Tap Shift, then type 't', 'h' and 'e'. Not need to hold Shift key.
  33  *
  34  *  Hold:       works as normal modifier.
  35  *  Tap:        one shot modifier.
  36  *  2 Tap:      cancel one shot modifier.
  37  *  5-Tap:      toggles enable/disable oneshot feature.
  38  */
  39 typedef struct {
  40     uint8_t mods;
  41     bool    disabled;
  42 }   oneshot_state_t;
  43
  44
  45 oneshot_state_t oneshot_state;
  46
  47 void oneshot_start(uint8_t mods);
  48 void oneshot_cancel(void);
  49 void oneshot_toggle(void);
  50 #endif
  51
  52 #endif