kitty/tools/tui/loop/mouse_test.go
Kovid Goyal 2d3ff7b240
Some checks are pending
CI / Linux (python=3.14 cc=clang sanitize=1) (push) Waiting to run
CI / Linux (python=3.12 cc=gcc sanitize=0) (push) Waiting to run
CI / Linux (python=3.13 cc=gcc sanitize=1) (push) Waiting to run
CI / Linux package (push) Waiting to run
CI / Bundle test (macos-latest) (push) Waiting to run
CI / Bundle test (ubuntu-latest) (push) Waiting to run
CI / macOS Brew (push) Waiting to run
CI / Test ./dev.sh and benchmark (push) Waiting to run
Support detailed wheel events in the kittens framework
Kittens can opt in with Loop.DetailedWheelEvents(), after which scroll
events arrive as MOUSE_WHEEL mouse events whose Wheel field has the
deltas, unit, multiplier, source, phase and momentum/inverted flags.
WheelEvent.Lines() converts the deltas to lines using the terminal's
multiplier when available.

The mouse-demo kitten uses this to move a block drawn with the graphics
protocol up and down with pixel precision, falling back to wheel button
presses in terminals without support, and shows the event details.
2026-11-16 13:43:41 +05:30

52 lines
2.2 KiB
Go

// License: GPLv3 Copyright: 2026, Kovid Goyal, <kovid at kovidgoyal.net>
package loop
import (
"testing"
"github.com/google/go-cmp/cmp"
)
func TestDecodeWheelEvent(t *testing.T) {
sz := ScreenSize{WidthPx: 1000, HeightPx: 500, CellWidth: 10, CellHeight: 20}
ev := func(x, y int, mods KeyModifiers, w WheelEvent) *MouseEvent {
ans := &MouseEvent{Event_type: MOUSE_WHEEL, Mods: mods, Wheel: w}
ans.Pixel.X, ans.Pixel.Y = x, y
ans.Cell.X, ans.Cell.Y = x/10, y/20
return ans
}
for csi, expected := range map[string]*MouseEvent{
">45;65;0;120;1:5;1;0;0;1M": ev(45, 65, 0, WheelEvent{DY: 120, Unit: WHEEL_UNIT_V120, Multiplier: 5, Source: WHEEL_SOURCE_WHEEL}),
">45;65;-3;-42;2:1.5;2;2;0;5M": ev(45, 65, CTRL, WheelEvent{
DX: -3, DY: -42, Unit: WHEEL_UNIT_PIXELS, Multiplier: 1.5, Source: WHEEL_SOURCE_FINGER, Phase: WHEEL_PHASE_CHANGED}),
">45;65;0;0;2;2;3;3;1M": ev(45, 65, 0, WheelEvent{
Unit: WHEEL_UNIT_PIXELS, Source: WHEEL_SOURCE_FINGER, Phase: WHEEL_PHASE_ENDED, Momentum: true, Inverted: true}),
// Unknown parameters and sub-parameters are ignored
">45;65:7;0;120:3;1:5:9;1;0;0;1;99:1M": ev(45, 65, 0, WheelEvent{DY: 120, Unit: WHEEL_UNIT_V120, Multiplier: 5, Source: WHEEL_SOURCE_WHEEL}),
// Too few parameters or wrong final byte
">45;65;0;120;1;1;0;0M": nil,
">45;65;0;120;1;1;0;0;1m": nil,
">45;65;x;120;1;1;0;0;1M": nil,
"<64;45;65M": {Buttons: MOUSE_WHEEL_UP, Pixel: struct{ X, Y int }{45, 65}, Cell: struct{ X, Y int }{4, 3}},
">45;65;0;120;1:0;1;0;0;1M": ev(45, 65, 0, WheelEvent{DY: 120, Unit: WHEEL_UNIT_V120, Source: WHEEL_SOURCE_WHEEL}),
} {
actual := MouseEventFromCSI(csi, sz)
if diff := cmp.Diff(expected, actual); diff != "" {
t.Fatalf("Failed to decode %#v:\n%s", csi, diff)
}
}
// Lines conversion uses the multiplier when present
w := WheelEvent{DY: 240, Unit: WHEEL_UNIT_V120, Multiplier: 5}
if _, dy := w.Lines(20, 3); dy != 10 {
t.Fatalf("Wrong number of lines: %v", dy)
}
w.Multiplier = 0
if _, dy := w.Lines(20, 3); dy != 6 {
t.Fatalf("Wrong number of lines: %v", dy)
}
w = WheelEvent{DY: -30, Unit: WHEEL_UNIT_PIXELS}
if _, dy := w.Lines(20, 3); dy != -1.5 {
t.Fatalf("Wrong number of lines: %v", dy)
}
}