You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
85 lines
2.6 KiB
85 lines
2.6 KiB
/* -*- mode: c++ -*-
|
|
* Kaleidoscope-TapDance -- Tap-dance keys
|
|
* Copyright (C) 2016-2021 Keyboard.io, Inc
|
|
*
|
|
* 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, version 3.
|
|
*
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "kaleidoscope/Runtime.h"
|
|
#include "kaleidoscope/LiveKeys.h"
|
|
#include <Kaleidoscope-Ranges.h>
|
|
#include "kaleidoscope/KeyAddr.h"
|
|
#include "kaleidoscope/KeyAddrEventQueue.h"
|
|
#include "kaleidoscope/KeyEventTracker.h"
|
|
|
|
#define TD(n) Key(kaleidoscope::ranges::TD_FIRST + n)
|
|
|
|
#define tapDanceActionKeys(tap_count, tap_dance_action, ...) ({ \
|
|
static const Key __k[] PROGMEM = { __VA_ARGS__ }; \
|
|
TapDance.actionKeys(tap_count, tap_dance_action, \
|
|
sizeof (__k) / sizeof (Key), &__k[0]); \
|
|
})
|
|
|
|
namespace kaleidoscope {
|
|
namespace plugin {
|
|
class TapDance : public kaleidoscope::Plugin {
|
|
public:
|
|
typedef enum {
|
|
Tap,
|
|
Hold,
|
|
Interrupt,
|
|
Timeout,
|
|
Release,
|
|
} ActionType;
|
|
|
|
TapDance(void) {}
|
|
|
|
static uint16_t time_out;
|
|
|
|
void actionKeys(uint8_t tap_count, ActionType tap_dance_action, uint8_t max_keys, const Key tap_keys[]);
|
|
|
|
EventHandlerResult onNameQuery();
|
|
EventHandlerResult onKeyswitchEvent(KeyEvent &event);
|
|
EventHandlerResult afterEachCycle();
|
|
|
|
static constexpr bool isTapDanceKey(Key key) {
|
|
return (key.getRaw() >= ranges::TD_FIRST &&
|
|
key.getRaw() <= ranges::TD_LAST);
|
|
}
|
|
|
|
private:
|
|
// The maximum number of events in the queue at a time.
|
|
static constexpr uint8_t queue_capacity_{8};
|
|
|
|
// The event queue stores a series of press and release events.
|
|
KeyAddrEventQueue<queue_capacity_> event_queue_;
|
|
|
|
static KeyEventTracker event_tracker_;
|
|
|
|
// The number of taps in the current TapDance sequence.
|
|
static uint8_t tap_count_;
|
|
|
|
void flushQueue(KeyAddr ignored_addr = KeyAddr::none());
|
|
|
|
};
|
|
|
|
} // namespace plugin
|
|
} // namespace kaleidoscope
|
|
|
|
void tapDanceAction(uint8_t tap_dance_index, KeyAddr key_addr, uint8_t tap_count,
|
|
kaleidoscope::plugin::TapDance::ActionType tap_dance_action);
|
|
|
|
extern kaleidoscope::plugin::TapDance TapDance;
|