From e759bededdfab6f433082bfc99b2dab0f715ea75 Mon Sep 17 00:00:00 2001 From: Kayshen-X Date: Fri, 8 May 2026 22:03:34 +0800 Subject: [PATCH] =?UTF-8?q?refactor(shell-native):=20finish=20v19.4=20clea?= =?UTF-8?q?nup=20=E2=80=94=20drop=20orphan=20event/=20+=20stale=20test?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Step 1a v19.4 commit f9dd4b56 deleted ShellEvent + JianPointerMapper, but the merge in 46f77eab (cf61bcc1 ↔ origin/v0.8.0) inadvertently re-added src/event/mod.rs and tests/event_mapping.rs from the inbound side. src/event/mod.rs is dead source — lib.rs no longer declares `pub mod event` and no consumer imports JianPointerMapper. The test file imports a symbol lib.rs no longer re-exports, so `cargo test -p openpencil-shell-native --no-run` fails compile. Step 1b Phase 0 must start from a green baseline; deleting both files restores it. cargo test -p openpencil-shell-native --no-run → all integration tests compile clean. --- .../openpencil-shell-native/src/event/mod.rs | 163 ------ .../tests/event_mapping.rs | 467 ------------------ 2 files changed, 630 deletions(-) delete mode 100644 crates/openpencil-shell-native/src/event/mod.rs delete mode 100644 crates/openpencil-shell-native/tests/event_mapping.rs diff --git a/crates/openpencil-shell-native/src/event/mod.rs b/crates/openpencil-shell-native/src/event/mod.rs deleted file mode 100644 index f91ac269a..000000000 --- a/crates/openpencil-shell-native/src/event/mod.rs +++ /dev/null @@ -1,163 +0,0 @@ -//! Desktop event mapping (spec v19 §5.1.1). -//! -//! `winit::event::WindowEvent` → -//! ([`PointerTranslator`] from `jian_host_desktop`) → -//! `jian_core::gesture::PointerEvent` → -//! ([`JianPointerMapper`]) → -//! `openpencil_shell_core::ShellEvent`. -//! -//! Window / Key / MouseWheel events do **not** go through Jian — they -//! map straight from winit. Pointer / Touch primitives go through Jian -//! so OP reuses Jian's button-set + cursor-cache state machine -//! (`jian-host-desktop/src/pointer.rs`). -//! -//! This module is **desktop-only** (target-gated in `lib.rs`). Mobile -//! pointer/touch mapping lands in Step 1f. - -use std::collections::HashMap; - -use jian_core::gesture::{ - Modifiers as JianModifiers, MouseButtons as JianMouseButtons, PointerEvent as JianPointerEvent, - PointerId as JianPointerId, PointerKind as JianPointerKind, PointerPhase as JianPointerPhase, -}; -use openpencil_shell_core::event::{ - ElementState, Modifiers, MouseButton, PointerId, ShellEvent, TouchForce, TouchId, TouchPhase, -}; -use openpencil_shell_core::render_backend::Point2D; - -/// Stateful mapper from Jian `PointerEvent` to OP `ShellEvent` (spec -/// §5.1.1). Owns a per-`PointerId` snapshot of the last-seen -/// `MouseButtons` bitset so it can diff button transitions across -/// `Down / Up / Move` phases — Jian carries the **current** bitset, not -/// added/removed deltas (see `jian-core/src/gesture/pointer.rs:48-59` -/// + `jian-host-desktop/src/pointer.rs:104-134` for why all three -/// phases must diff). -#[derive(Debug, Clone, Default)] -pub struct JianPointerMapper { - previous_buttons: HashMap, -} - -impl JianPointerMapper { - pub fn new() -> Self { - Self::default() - } - - /// Translate one Jian `PointerEvent` into zero, one, or many - /// `ShellEvent`s. Empty `Vec` = degraded input the caller should - /// ignore (no `ShellEvent::Other` variant exists; see spec §5.1). - /// - /// Multi-button transitions during `Move` produce a `PointerButton` - /// per changed bit followed by a trailing `PointerMove` (spec - /// §5.1.1 round 3 CONCERN-R3-1 fix). - pub fn from_jian_pointer(&mut self, p: &JianPointerEvent) -> Vec { - let mut out = Vec::new(); - match p.kind { - JianPointerKind::Touch => { - let phase = match p.phase { - JianPointerPhase::Down => TouchPhase::Started, - JianPointerPhase::Move => TouchPhase::Moved, - JianPointerPhase::Up => TouchPhase::Ended, - JianPointerPhase::Cancel => TouchPhase::Cancelled, - // Touches never `Hover`: return empty so callers - // ignore the event rather than fabricate a phase. - JianPointerPhase::Hover => return out, - }; - out.push(ShellEvent::Touch { - id: TouchId(u64::from(p.id.0)), - phase, - pos: jian_point_to_point2d(p.position), - force: Some(TouchForce::Normalized(f64::from(p.pressure))), - }); - } - JianPointerKind::Mouse - | JianPointerKind::Pen - | JianPointerKind::Stylus - | JianPointerKind::Trackpad => { - let prev = self - .previous_buttons - .get(&p.id) - .copied() - .unwrap_or_default(); - let added = p.buttons.difference(prev); - let removed = prev.difference(p.buttons); - self.previous_buttons.insert(p.id, p.buttons); - - let pos = jian_point_to_point2d(p.position); - let modifiers = from_jian_modifiers(p.modifiers); - let id = PointerId(u64::from(p.id.0)); - - // 1. Emit one `PointerButton{Pressed}` per added bit. - for bit in added.iter() { - if let Some(button) = mouse_buttons_bit_to_button(bit) { - out.push(ShellEvent::PointerButton { - id, - button, - state: ElementState::Pressed, - pos, - modifiers, - }); - } - } - // 2. Emit one `PointerButton{Released}` per removed bit. - for bit in removed.iter() { - if let Some(button) = mouse_buttons_bit_to_button(bit) { - out.push(ShellEvent::PointerButton { - id, - button, - state: ElementState::Released, - pos, - modifiers, - }); - } - } - // 3. Hover / Move add a trailing `PointerMove` so motion - // is preserved alongside the button transitions. - // Down / Up don't emit Move (the PointerButton event - // carries the current pos). Cancel doesn't appear - // here — Jian only raises `Cancel` on Touch, which - // was branched out above; an unexpected - // `Mouse|Pen|Stylus|Trackpad + Cancel` is treated as - // degraded and ignored. - match p.phase { - JianPointerPhase::Hover | JianPointerPhase::Move => { - out.push(ShellEvent::PointerMove { id, pos, modifiers }); - } - JianPointerPhase::Down | JianPointerPhase::Up | JianPointerPhase::Cancel => {} - } - } - } - out - } -} - -/// Convert one `JianMouseButtons` single-bit flag to OP `MouseButton`. -/// Returns `None` if the input has zero or more than one bit set — -/// callers iterate the bitset one bit at a time so `None` should never -/// happen in practice; treating it as a no-op keeps the mapper -/// degradation contract intact (empty `Vec` rather than panic). -fn mouse_buttons_bit_to_button(bit: JianMouseButtons) -> Option { - match bit { - JianMouseButtons::LEFT => Some(MouseButton::Left), - JianMouseButtons::RIGHT => Some(MouseButton::Right), - JianMouseButtons::MIDDLE => Some(MouseButton::Middle), - JianMouseButtons::BACK => Some(MouseButton::Back), - JianMouseButtons::FORWARD => Some(MouseButton::Forward), - _ => None, - } -} - -/// Convert Jian `Modifiers` bitflags to OP `Modifiers` struct. -/// Jian's `CMD` bit maps to OP's `meta` (Cmd on macOS, Super/Win -/// elsewhere — same convention as `winit::keyboard::ModifiersState::super_key`). -fn from_jian_modifiers(m: JianModifiers) -> Modifiers { - Modifiers { - shift: m.contains(JianModifiers::SHIFT), - ctrl: m.contains(JianModifiers::CTRL), - alt: m.contains(JianModifiers::ALT), - meta: m.contains(JianModifiers::CMD), - } -} - -fn jian_point_to_point2d(p: jian_core::geometry::Point) -> Point2D { - Point2D::new(p.x, p.y) -} diff --git a/crates/openpencil-shell-native/tests/event_mapping.rs b/crates/openpencil-shell-native/tests/event_mapping.rs deleted file mode 100644 index eec5e5187..000000000 --- a/crates/openpencil-shell-native/tests/event_mapping.rs +++ /dev/null @@ -1,467 +0,0 @@ -//! Spec v19 §5.1.1 unit tests — Jian `PointerEvent` → OP `ShellEvent` -//! mapper (`JianPointerMapper`). -//! -//! Coverage target (plan v7 Task 3 Step 11 + spec §5.1.1 fixture list): -//! - 4 Touch phases (Started / Moved / Ended / Cancelled). -//! - Mouse Hover → `[PointerMove]`; LEFT Down/Up pair → Pressed/Released. -//! - Multi-button Move (press / release mid-gesture) — diff each bit -//! then trailing PointerMove (CONCERN-R3-1). -//! - Pen / Stylus / Trackpad route through the Mouse branch. -//! - Degraded inputs (no button change on Down/Up, Touch Hover) → -//! `Vec::new()` (spec round 4 CONCERN-R4-1; no `ShellEvent::Other`). -//! - Modifiers propagate (shift/ctrl/alt/meta/CMD). - -use std::time::Instant; - -use jian_core::geometry::point; -use jian_core::gesture::{ - Modifiers as JianModifiers, MouseButtons as JianMouseButtons, PointerEvent as JianPointerEvent, - PointerId as JianPointerId, PointerKind, PointerPhase, -}; -use openpencil_shell_core::event::{ - ElementState, Modifiers, MouseButton, PointerId, ShellEvent, TouchForce, TouchId, TouchPhase, -}; -use openpencil_shell_native::JianPointerMapper; - -/// Build a `JianPointerEvent` with default tilt / pressure / timestamp, -/// overriding the fields each test cares about. -fn jian_event( - id: u32, - kind: PointerKind, - phase: PointerPhase, - buttons: JianMouseButtons, - modifiers: JianModifiers, - pos_x: f32, - pos_y: f32, -) -> JianPointerEvent { - JianPointerEvent { - id: JianPointerId(id), - kind, - phase, - position: point(pos_x, pos_y), - pressure: 1.0, - buttons, - modifiers, - tilt: None, - timestamp: Instant::now(), - } -} - -// ---------------------------------------------------------------- Touch ---- - -#[test] -fn touch_down_emits_started_phase() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 7, - PointerKind::Touch, - PointerPhase::Down, - JianMouseButtons::empty(), - JianModifiers::empty(), - 10.0, - 20.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert_eq!(out.len(), 1); - match &out[0] { - ShellEvent::Touch { - id, - phase, - pos, - force, - } => { - assert_eq!(*id, TouchId(7)); - assert_eq!(*phase, TouchPhase::Started); - assert_eq!(pos.x, 10.0); - assert_eq!(pos.y, 20.0); - assert_eq!(*force, Some(TouchForce::Normalized(1.0))); - } - other => panic!("expected ShellEvent::Touch, got {other:?}"), - } -} - -#[test] -fn touch_move_emits_moved_phase() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 1, - PointerKind::Touch, - PointerPhase::Move, - JianMouseButtons::empty(), - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert!(matches!( - out.as_slice(), - [ShellEvent::Touch { - phase: TouchPhase::Moved, - .. - }] - )); -} - -#[test] -fn touch_up_emits_ended_phase() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 1, - PointerKind::Touch, - PointerPhase::Up, - JianMouseButtons::empty(), - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert!(matches!( - out.as_slice(), - [ShellEvent::Touch { - phase: TouchPhase::Ended, - .. - }] - )); -} - -#[test] -fn touch_cancel_emits_cancelled_phase() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 1, - PointerKind::Touch, - PointerPhase::Cancel, - JianMouseButtons::empty(), - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert!(matches!( - out.as_slice(), - [ShellEvent::Touch { - phase: TouchPhase::Cancelled, - .. - }] - )); -} - -#[test] -fn touch_hover_returns_empty_vec() { - // Touches never `Hover`; mapper drops the event so callers don't - // synthesize a fake `Moved` phase. - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 1, - PointerKind::Touch, - PointerPhase::Hover, - JianMouseButtons::empty(), - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert!(out.is_empty(), "expected empty Vec for touch Hover"); -} - -// ---------------------------------------------------------------- Mouse ---- - -#[test] -fn mouse_hover_emits_pointer_move() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 3, - PointerKind::Mouse, - PointerPhase::Hover, - JianMouseButtons::empty(), - JianModifiers::empty(), - 100.0, - 50.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert_eq!(out.len(), 1); - match &out[0] { - ShellEvent::PointerMove { id, pos, modifiers } => { - assert_eq!(*id, PointerId(3)); - assert_eq!(pos.x, 100.0); - assert_eq!(pos.y, 50.0); - assert_eq!(*modifiers, Modifiers::default()); - } - other => panic!("expected PointerMove, got {other:?}"), - } -} - -#[test] -fn mouse_left_down_then_up() { - let mut mapper = JianPointerMapper::new(); - - // Down: previous = empty, current = LEFT → emit Pressed. - let down = jian_event( - 9, - PointerKind::Mouse, - PointerPhase::Down, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&down); - assert_eq!(out.len(), 1); - match &out[0] { - ShellEvent::PointerButton { button, state, .. } => { - assert_eq!(*button, MouseButton::Left); - assert_eq!(*state, ElementState::Pressed); - } - other => panic!("expected PointerButton{{Pressed}}, got {other:?}"), - } - - // Up: previous = LEFT, current = empty → emit Released. - let up = jian_event( - 9, - PointerKind::Mouse, - PointerPhase::Up, - JianMouseButtons::empty(), - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&up); - assert_eq!(out.len(), 1); - match &out[0] { - ShellEvent::PointerButton { button, state, .. } => { - assert_eq!(*button, MouseButton::Left); - assert_eq!(*state, ElementState::Released); - } - other => panic!("expected PointerButton{{Released}}, got {other:?}"), - } -} - -#[test] -fn multi_button_press_during_move() { - // CONCERN-R3-1 fixture (a): LEFT held + Move with LEFT|RIGHT → - // [PointerButton{RIGHT, Pressed}, PointerMove]. - let mut mapper = JianPointerMapper::new(); - - // Prime previous = LEFT via a Down. - let prime = jian_event( - 4, - PointerKind::Mouse, - PointerPhase::Down, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 0.0, - 0.0, - ); - let _ = mapper.from_jian_pointer(&prime); - - // Now Move with LEFT|RIGHT. - let mid = jian_event( - 4, - PointerKind::Mouse, - PointerPhase::Move, - JianMouseButtons::LEFT | JianMouseButtons::RIGHT, - JianModifiers::empty(), - 5.0, - 7.0, - ); - let out = mapper.from_jian_pointer(&mid); - assert_eq!(out.len(), 2, "expected button Pressed + PointerMove"); - match &out[0] { - ShellEvent::PointerButton { button, state, .. } => { - assert_eq!(*button, MouseButton::Right); - assert_eq!(*state, ElementState::Pressed); - } - other => panic!("expected PointerButton{{Right,Pressed}}, got {other:?}"), - } - assert!(matches!(out[1], ShellEvent::PointerMove { .. })); -} - -#[test] -fn multi_button_release_during_move() { - // CONCERN-R3-1 fixture (b): LEFT|RIGHT held + Move with LEFT only → - // [PointerButton{RIGHT, Released}, PointerMove]. - let mut mapper = JianPointerMapper::new(); - - // Prime previous = LEFT|RIGHT via two Downs. - let _ = mapper.from_jian_pointer(&jian_event( - 2, - PointerKind::Mouse, - PointerPhase::Down, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 0.0, - 0.0, - )); - let _ = mapper.from_jian_pointer(&jian_event( - 2, - PointerKind::Mouse, - PointerPhase::Move, - JianMouseButtons::LEFT | JianMouseButtons::RIGHT, - JianModifiers::empty(), - 0.0, - 0.0, - )); - - let release = jian_event( - 2, - PointerKind::Mouse, - PointerPhase::Move, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 9.0, - 9.0, - ); - let out = mapper.from_jian_pointer(&release); - assert_eq!(out.len(), 2, "expected button Released + PointerMove"); - match &out[0] { - ShellEvent::PointerButton { button, state, .. } => { - assert_eq!(*button, MouseButton::Right); - assert_eq!(*state, ElementState::Released); - } - other => panic!("expected PointerButton{{Right,Released}}, got {other:?}"), - } - assert!(matches!(out[1], ShellEvent::PointerMove { .. })); -} - -// ---------------------------------------------------- Pen / Stylus / Trackpad - -#[test] -fn pen_phase_routes_through_mouse_branch() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 11, - PointerKind::Pen, - PointerPhase::Down, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert_eq!(out.len(), 1); - assert!(matches!( - out[0], - ShellEvent::PointerButton { - button: MouseButton::Left, - state: ElementState::Pressed, - .. - } - )); -} - -#[test] -fn stylus_phase_routes_through_mouse_branch() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 12, - PointerKind::Stylus, - PointerPhase::Down, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert!(matches!( - out.as_slice(), - [ShellEvent::PointerButton { - button: MouseButton::Left, - state: ElementState::Pressed, - .. - }] - )); -} - -#[test] -fn trackpad_phase_routes_through_mouse_branch() { - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 13, - PointerKind::Trackpad, - PointerPhase::Move, - JianMouseButtons::empty(), - JianModifiers::empty(), - 1.0, - 2.0, - ); - let out = mapper.from_jian_pointer(&ev); - // No buttons changed → only a PointerMove. - assert!(matches!(out.as_slice(), [ShellEvent::PointerMove { .. }])); -} - -// ---------------------------------------------------------- Degraded inputs - -#[test] -fn degraded_down_no_button_change_returns_empty() { - // Round 4 CONCERN-R4-1 fix: empty buttons on Down with empty - // previous → mapper returns `Vec::new()` (no `ShellEvent::Other`). - let mut mapper = JianPointerMapper::new(); - let ev = jian_event( - 5, - PointerKind::Mouse, - PointerPhase::Down, - JianMouseButtons::empty(), - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert!(out.is_empty(), "expected empty Vec, got {out:?}"); -} - -#[test] -fn degraded_up_no_button_change_returns_empty() { - // Up where current buttons match previous → no diff, no Move - // (Up phase doesn't emit Move) → empty Vec. - let mut mapper = JianPointerMapper::new(); - // Prime previous = LEFT. - let _ = mapper.from_jian_pointer(&jian_event( - 6, - PointerKind::Mouse, - PointerPhase::Down, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 0.0, - 0.0, - )); - // Now Up but buttons still LEFT (e.g. host-side bookkeeping bug). - let ev = jian_event( - 6, - PointerKind::Mouse, - PointerPhase::Up, - JianMouseButtons::LEFT, - JianModifiers::empty(), - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert!(out.is_empty(), "expected empty Vec, got {out:?}"); -} - -// ---------------------------------------------------------------- Modifiers - -#[test] -fn modifiers_propagate() { - let mut mapper = JianPointerMapper::new(); - let mods = JianModifiers::SHIFT | JianModifiers::CTRL | JianModifiers::ALT | JianModifiers::CMD; - let ev = jian_event( - 8, - PointerKind::Mouse, - PointerPhase::Hover, - JianMouseButtons::empty(), - mods, - 0.0, - 0.0, - ); - let out = mapper.from_jian_pointer(&ev); - assert_eq!(out.len(), 1); - match &out[0] { - ShellEvent::PointerMove { modifiers, .. } => { - assert!(modifiers.shift); - assert!(modifiers.ctrl); - assert!(modifiers.alt); - assert!(modifiers.meta, "Jian CMD must map to OP meta"); - } - other => panic!("expected PointerMove, got {other:?}"), - } -}