alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adapt MouseKeys plugin to KeyEvent handlers

Browse Source 
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
pull/1024/head
Michael Richters 4 years ago
parent 5db82fd7c8
commit f91d2a30a3
No known key found for this signature in database
GPG Key ID: 1288FD13E4EEF0C0
2 changed files with 169 additions and 113 deletions
Show Stats Download Patch File Download Diff File

268
plugins/Kaleidoscope-MouseKeys/src/kaleidoscope/plugin/MouseKeys.cpp
Unescape View File

@ -24,8 +24,6 @@
namespace kaleidoscope { namespace kaleidoscope {
namespace plugin { namespace plugin {
uint8_t MouseKeys_::mouseMoveIntent;
uint8_t MouseKeys_::speed = 1; uint8_t MouseKeys_::speed = 1;
uint16_t MouseKeys_::speedDelay = 1; uint16_t MouseKeys_::speedDelay = 1;
@ -39,6 +37,9 @@ uint16_t MouseKeys_::move_start_time_;
uint16_t MouseKeys_::accel_start_time_; uint16_t MouseKeys_::accel_start_time_;
uint16_t MouseKeys_::wheel_start_time_; uint16_t MouseKeys_::wheel_start_time_;
// =============================================================================
// Configuration functions
void MouseKeys_::setWarpGridSize(uint8_t grid_size) { void MouseKeys_::setWarpGridSize(uint8_t grid_size) {
MouseWrapper.warp_grid_size = grid_size; MouseWrapper.warp_grid_size = grid_size;
} }
@ -47,150 +48,199 @@ void MouseKeys_::setSpeedLimit(uint8_t speed_limit) {
MouseWrapper.speedLimit = speed_limit; MouseWrapper.speedLimit = speed_limit;
} }
void MouseKeys_::scrollWheel(uint8_t keyCode) { // =============================================================================
if (!Runtime.hasTimeExpired(wheel_start_time_, wheelDelay)) // Key variant tests
return;
wheel_start_time_ = Runtime.millisAtCycleStart(); bool MouseKeys_::isMouseKey(const Key& key) const {
return (key.getFlags() == (SYNTHETIC | IS_MOUSE_KEY));
}
if (keyCode & KEY_MOUSE_UP) bool MouseKeys_::isMouseButtonKey(const Key& key) const {
kaleidoscope::Runtime.hid().mouse().move(0, 0, wheelSpeed); uint8_t variant = key.getKeyCode() & (KEY_MOUSE_BUTTON | KEY_MOUSE_WARP);
else if (keyCode & KEY_MOUSE_DOWN) return variant == KEY_MOUSE_BUTTON;
kaleidoscope::Runtime.hid().mouse().move(0, 0, -wheelSpeed);
else if (keyCode & KEY_MOUSE_LEFT)
kaleidoscope::Runtime.hid().mouse().move(0, 0, 0, -wheelSpeed);
else if (keyCode & KEY_MOUSE_RIGHT)
kaleidoscope::Runtime.hid().mouse().move(0, 0, 0, wheelSpeed);
} }
EventHandlerResult MouseKeys_::onNameQuery() { bool MouseKeys_::isMouseMoveKey(const Key& key) const {
return ::Focus.sendName(F("MouseKeys")); uint8_t mask = (KEY_MOUSE_BUTTON | KEY_MOUSE_WARP | KEY_MOUSE_WHEEL);
uint8_t variant = key.getKeyCode() & mask;
return variant == 0;
} }
EventHandlerResult MouseKeys_::afterEachCycle() { bool MouseKeys_::isMouseWarpKey(const Key& key) const {
kaleidoscope::Runtime.hid().mouse().sendReport(); return (key.getKeyCode() & KEY_MOUSE_WARP) != 0;
kaleidoscope::Runtime.hid().mouse().releaseAllButtons(); }
mouseMoveIntent = 0;
return EventHandlerResult::OK; bool MouseKeys_::isMouseWheelKey(const Key& key) const {
uint8_t mask = (KEY_MOUSE_BUTTON | KEY_MOUSE_WARP | KEY_MOUSE_WHEEL);
uint8_t variant = key.getKeyCode() & mask;
return variant == KEY_MOUSE_WHEEL;
} }
EventHandlerResult MouseKeys_::beforeReportingState() { // =============================================================================
if (mouseMoveIntent == 0) { // Event Handlers
MouseWrapper.accelStep = 0;
return EventHandlerResult::OK;
}
if (!Runtime.hasTimeExpired(move_start_time_, speedDelay)) // -----------------------------------------------------------------------------
return EventHandlerResult::OK; EventHandlerResult MouseKeys_::onNameQuery() {
return ::Focus.sendName(F("MouseKeys"));
}
move_start_time_ = Runtime.millisAtCycleStart(); // -----------------------------------------------------------------------------
EventHandlerResult MouseKeys_::onSetup(void) {
kaleidoscope::Runtime.hid().mouse().setup();
kaleidoscope::Runtime.hid().absoluteMouse().setup();
int8_t moveX = 0, moveY = 0; return EventHandlerResult::OK;
}
// -----------------------------------------------------------------------------
EventHandlerResult MouseKeys_::afterEachCycle() {
// Check timeout for accel update interval.
if (Runtime.hasTimeExpired(accel_start_time_, accelDelay)) { if (Runtime.hasTimeExpired(accel_start_time_, accelDelay)) {
accel_start_time_ = Runtime.millisAtCycleStart();
// `accelStep` determines the movement speed of the mouse pointer, and gets
// reset to zero when no mouse movement keys is pressed (see below).
if (MouseWrapper.accelStep < 255 - accelSpeed) { if (MouseWrapper.accelStep < 255 - accelSpeed) {
MouseWrapper.accelStep += accelSpeed; MouseWrapper.accelStep += accelSpeed;
} }
accel_start_time_ = Runtime.millisAtCycleStart();
} }
if (mouseMoveIntent & KEY_MOUSE_UP) // Check timeout for position update interval.
moveY -= speed; bool update_position = Runtime.hasTimeExpired(move_start_time_, speedDelay);
if (mouseMoveIntent & KEY_MOUSE_DOWN) if (update_position) {
moveY += speed; move_start_time_ = Runtime.millisAtCycleStart();
// Determine which mouse movement directions are active by searching through
// all the currently active keys for mouse movement keys, and adding them to
// a bitfield (`directions`).
uint8_t directions = 0;
int8_t vx = 0;
int8_t vy = 0;
for (Key key : live_keys.all()) {
if (isMouseKey(key) && isMouseMoveKey(key)) {
directions |= key.getKeyCode();
}
}
if (mouseMoveIntent & KEY_MOUSE_LEFT) if (directions == 0) {
moveX -= speed; // If there are no mouse movement keys held, reset speed to zero.
if (mouseMoveIntent & KEY_MOUSE_RIGHT) MouseWrapper.accelStep = 0;
moveX += speed; } else {
// For each active direction, add the mouse movement speed.
if (directions & KEY_MOUSE_LEFT)
vx -= speed;
if (directions & KEY_MOUSE_RIGHT)
vx += speed;
if (directions & KEY_MOUSE_UP)
vy -= speed;
if (directions & KEY_MOUSE_DOWN)
vy += speed;
// Prepare the mouse report.
MouseWrapper.move(vx, vy);
// Send the report.
Runtime.hid().mouse().sendReport();
}
}
// Check timeout for scroll report interval.
bool update_wheel = Runtime.hasTimeExpired(wheel_start_time_, wheelDelay);
if (update_wheel) {
wheel_start_time_ = Runtime.millisAtCycleStart();
// Determine which scroll wheel keys are active, and add their directions to
// a bitfield (`directions`).
uint8_t directions = 0;
int8_t vx = 0;
int8_t vy = 0;
for (Key key : live_keys.all()) {
if (isMouseKey(key) && isMouseWheelKey(key)) {
directions |= key.getKeyCode();
}
}
MouseWrapper.move(moveX, moveY); if (directions != 0) {
// Horizontal scroll wheel:
if (directions & KEY_MOUSE_LEFT)
vx -= wheelSpeed;
if (directions & KEY_MOUSE_RIGHT)
vx += wheelSpeed;
// Vertical scroll wheel (note coordinates are opposite movement):
if (directions & KEY_MOUSE_UP)
vy += wheelSpeed;
if (directions & KEY_MOUSE_DOWN)
vy -= wheelSpeed;
// Add scroll wheel changes to HID report.
Runtime.hid().mouse().move(0, 0, vy, vx);
// Send the report.
Runtime.hid().mouse().sendReport();
}
}
return EventHandlerResult::OK; return EventHandlerResult::OK;
} }
EventHandlerResult MouseKeys_::onKeyswitchEvent(Key &mappedKey, KeyAddr key_addr, uint8_t keyState) { // -----------------------------------------------------------------------------
if (mappedKey.getFlags() != (SYNTHETIC | IS_MOUSE_KEY)) EventHandlerResult MouseKeys_::onKeyEvent(KeyEvent &event) {
if (!isMouseKey(event.key))
return EventHandlerResult::OK; return EventHandlerResult::OK;
if (mappedKey.getKeyCode() & KEY_MOUSE_BUTTON && !(mappedKey.getKeyCode() & KEY_MOUSE_WARP)) { if (isMouseButtonKey(event.key)) {
uint8_t button = mappedKey.getKeyCode() & ~KEY_MOUSE_BUTTON; sendMouseButtonReport(event);
if (keyIsPressed(keyState)) { } else if (isMouseWarpKey(event.key)) {
// Reset warp state on initial mouse button key-down only so we can use if (keyToggledOn(event.state)) {
// warp keys to drag-and-drop: sendMouseWarpReport(event);
if (keyToggledOn(keyState)) {
MouseWrapper.reset_warping();
}
kaleidoscope::Runtime.hid().mouse().pressButtons(button);
} else if (keyToggledOff(keyState)) {
kaleidoscope::Runtime.hid().mouse().releaseButtons(button);
MouseWrapper.end_warping();
}
} else if (!(mappedKey.getKeyCode() & KEY_MOUSE_WARP)) {
if (keyToggledOn(keyState)) {
move_start_time_ = Runtime.millisAtCycleStart();
accel_start_time_ = Runtime.millisAtCycleStart();
wheel_start_time_ = Runtime.millisAtCycleStart() - wheelDelay;
} }
if (keyIsPressed(keyState)) {
if (mappedKey.getKeyCode() & KEY_MOUSE_WHEEL) {
scrollWheel(mappedKey.getKeyCode());
} else {
mouseMoveIntent |= mappedKey.getKeyCode();
}
} else if (keyToggledOff(keyState)) {
/* If a mouse key toggles off, we want to explicitly stop moving (or
* scrolling) in that direction. We want to do this to support use-cases
* where we send multiple reports per cycle (such as macros), and can't
* rely on the main loop clearing the report for us. We do not want to
* clear the whole report either, because we want any other mouse keys
* to still have their desired effect. Therefore, we selectively stop
* movement or scrolling. */
mouseMoveIntent &= ~mappedKey.getKeyCode();
bool x = false, y = false, vWheel = false, hWheel = false;
if (mappedKey.getKeyCode() & KEY_MOUSE_UP ||
mappedKey.getKeyCode() & KEY_MOUSE_DOWN) {
if (mappedKey.getKeyCode() & KEY_MOUSE_WHEEL) {
vWheel = true;
} else {
y = true;
}
} else if (mappedKey.getKeyCode() & KEY_MOUSE_LEFT ||
mappedKey.getKeyCode() & KEY_MOUSE_RIGHT) {
if (mappedKey.getKeyCode() & KEY_MOUSE_WHEEL) {
hWheel = true;
} else {
x = true;
}
}
kaleidoscope::Runtime.hid().mouse().stop(x, y, vWheel, hWheel); } else if (isMouseMoveKey(event.key)) {
} // No report is sent here; that's handled in `afterEachCycle()`.
} else if (keyToggledOn(keyState)) { move_start_time_ = Runtime.millisAtCycleStart() - speedDelay;
if (mappedKey.getKeyCode() & KEY_MOUSE_WARP && mappedKey.getFlags() & IS_MOUSE_KEY) { accel_start_time_ = Runtime.millisAtCycleStart();
MouseWrapper.warp(((mappedKey.getKeyCode() & KEY_MOUSE_WARP_END) ? WARP_END : 0x00) |
((mappedKey.getKeyCode() & KEY_MOUSE_UP) ? WARP_UP : 0x00) | } else if (isMouseWheelKey(event.key)) {
((mappedKey.getKeyCode() & KEY_MOUSE_DOWN) ? WARP_DOWN : 0x00) | // No report is sent here; that's handled in `afterEachCycle()`.
((mappedKey.getKeyCode() & KEY_MOUSE_LEFT) ? WARP_LEFT : 0x00) | wheel_start_time_ = Runtime.millisAtCycleStart() - wheelDelay;
((mappedKey.getKeyCode() & KEY_MOUSE_RIGHT) ? WARP_RIGHT : 0x00));
}
} }
return EventHandlerResult::EVENT_CONSUMED; return EventHandlerResult::EVENT_CONSUMED;
} }
EventHandlerResult MouseKeys_::onSetup(void) { // =============================================================================
kaleidoscope::Runtime.hid().mouse().setup(); // HID report helper functions
kaleidoscope::Runtime.hid().absoluteMouse().setup();
// -----------------------------------------------------------------------------
return EventHandlerResult::OK; void MouseKeys_::sendMouseButtonReport(const KeyEvent &event) const {
// Get ready to send a new mouse report by building it from live_keys. Note
// that this also clears the movement and scroll values, but since those are
// relative, that's what we want.
Runtime.hid().mouse().releaseAllButtons();
uint8_t buttons = 0;
for (KeyAddr key_addr : KeyAddr::all()) {
if (key_addr == event.addr)
continue;
Key key = live_keys[key_addr];
if (isMouseKey(key) && isMouseButtonKey(key)) {
buttons |= key.getKeyCode();
}
}
if (keyToggledOn(event.state))
buttons |= event.key.getKeyCode();
buttons &= ~KEY_MOUSE_BUTTON;
Runtime.hid().mouse().pressButtons(buttons);
Runtime.hid().mouse().sendReport();
} }
// -----------------------------------------------------------------------------
void MouseKeys_::sendMouseWarpReport(const KeyEvent &event) const {
MouseWrapper.warp(
((event.key.getKeyCode() & KEY_MOUSE_WARP_END) ? WARP_END : 0x00) |
((event.key.getKeyCode() & KEY_MOUSE_UP) ? WARP_UP : 0x00) |
((event.key.getKeyCode() & KEY_MOUSE_DOWN) ? WARP_DOWN : 0x00) |
((event.key.getKeyCode() & KEY_MOUSE_LEFT) ? WARP_LEFT : 0x00) |
((event.key.getKeyCode() & KEY_MOUSE_RIGHT) ? WARP_RIGHT : 0x00));
} }
}
} // namespace plugin
} // namespace kaleidoscope
kaleidoscope::plugin::MouseKeys_ MouseKeys; kaleidoscope::plugin::MouseKeys_ MouseKeys;

14
plugins/Kaleidoscope-MouseKeys/src/kaleidoscope/plugin/MouseKeys.h
Unescape View File

@ -39,17 +39,23 @@ class MouseKeys_ : public kaleidoscope::Plugin {
EventHandlerResult onSetup(); EventHandlerResult onSetup();
EventHandlerResult onNameQuery(); EventHandlerResult onNameQuery();
EventHandlerResult beforeReportingState();
EventHandlerResult afterEachCycle(); EventHandlerResult afterEachCycle();
EventHandlerResult onKeyswitchEvent(Key &mappedKey, KeyAddr key_addr, uint8_t keyState); EventHandlerResult onKeyEvent(KeyEvent &event);
private: private:
static uint8_t mouseMoveIntent;
static uint16_t move_start_time_; static uint16_t move_start_time_;
static uint16_t accel_start_time_; static uint16_t accel_start_time_;
static uint16_t wheel_start_time_; static uint16_t wheel_start_time_;
static void scrollWheel(uint8_t keyCode); bool isMouseKey(const Key &key) const;
bool isMouseButtonKey(const Key &key) const;
bool isMouseMoveKey(const Key &key) const;
bool isMouseWarpKey(const Key &key) const;
bool isMouseWheelKey(const Key &key) const;
void sendMouseButtonReport(const KeyEvent &event) const;
void sendMouseWarpReport(const KeyEvent &event) const;
}; };
} }
} }

Write Preview
Loading…
Cancel
Save