Files
ltk/tests/element_map.rs
Pedro M. de Echanove Pasquin 4a80165428
Some checks failed
CI / build + test (push) Has been cancelled
CI / cargo audit (push) Has been cancelled
event_loop, a11y, text_shaping: AccessKit AT-SPI2 bridge, cross-app clipboard, xdg-activation, HarfBuzz shaping, multi-touch hooks
Five orthogonal capabilities land together because they share the same `try_run` plumbing: an optional global is bound at startup, a piece of state is added to `AppData`, the run-loop iteration drains an inbox / pushes a frame snapshot, and the public surface gains a small set of opt-in `App` hooks. Nothing here breaks an existing app — every new path degrades to a no-op when the compositor does not advertise the relevant global or when the platform adapter cannot start.
AT-SPI2 accessibility via AccessKit. A new `src/a11y/` module owns the platform adapter and the inbound `ActionRequest` channel. `A11yState::try_new` constructs an `accesskit_unix::Adapter`; when the AT-SPI2 daemon is not on the session bus (headless CI, locked-down compositors) the constructor returns `None` and the rest of the pipeline runs unchanged. After every successful `draw_frame`, the run loop builds a fresh `accesskit::TreeUpdate` from `widget_rects` and pushes it through the adapter — main surface plus every visible overlay, each translated to global coordinates via `surface_offset_for` so screen readers report positions in the same frame the user sees. Buttons / toggles / checkboxes / radios / list items / sliders / text edits map to the matching `Role`s; `Click` and `Focus` actions are advertised on every interactive node; inbound action requests are drained at the top of each iteration and translated into a synthetic press / focus on the matching widget. The integration is documented as best-effort in `docs/architecture.md` under "Known gaps and non-goals": hierarchical nesting, per-widget accessible names, live regions and `Action::SetValue` are listed as the natural follow-ups that the foundation now supports but does not yet wire.
Cross-application clipboard via `wl_data_device_manager`. A new `src/event_loop/data_device.rs` bridges the existing process-local `clipboard: String` to the Wayland selection. Outbound (Ctrl+C / Cut): after the local clipboard is populated, `publish_clipboard_selection` creates a `CopyPasteSource` offering `text/plain;charset=utf-8` and installs it as the seat's selection; `DataSourceHandler::send` writes the cached string into the fd the peer hands us. Inbound (Ctrl+V from another app): `DataDeviceHandler::selection` asks for the offered text via `WlDataOffer::receive`, spawns a tiny worker thread to drain the read pipe with a 16 MiB cap to prevent paste-bomb DoS, and posts the result back through an `mpsc::Sender` that the run loop drains each iteration into `data.clipboard`. The `clipboard:` field's doc-comment is updated to reflect the new behaviour: process-local when the compositor does not advertise the global, synchronised with the seat selection otherwise.
External drag-and-drop reception. The same `data_device` module handles `DragOffer` enter / motion / leave / drop_performed: `on_drop_motion( x, y )` fires while the drag hovers over the surface, `on_drop_leave()` when it withdraws without dropping, and `on_drop_received( x, y, mime, text )` when an external payload (`text/uri-list`, `text/plain`, …) is released on top of an ltk window. The receive path reuses the same worker-thread / channel pattern as the clipboard so the run loop never blocks on the read fd. Three new `App` hooks expose the events with no-op defaults; apps that ignore them get the previous behaviour.
`xdg-activation-v1`. The global is bound optionally; when it is present, `try_run` reads `$XDG_ACTIVATION_TOKEN` from the environment, removes it immediately (single-use; preventing leaks into child processes) and stashes it on `AppData::activation_token_pending`. After the first successful configure of the main surface — the earliest point at which `xdg_activation_v1.activate` is meaningful — the token is consumed once and the surface raised to focus. Compositors without the global leave `activation_state` as `None` and the inbound path silently degrades. An `App::request_activation_token` outbound path is reserved on the trait but not yet exercised here.
HarfBuzz shaping. A new `src/text_shaping.rs::shape_line` drives both renderers: the logical-order string is run through `unicode-bidi`, split into per-font sub-runs, and shaped through `rustybuzz`. Each `PositionedGlyph` carries the per-font `glyph_id`, the visual advance and the ink offsets — exactly what `fontdue::Font::rasterize_indexed` needs to render Arabic connected forms, Devanagari clusters and CJK shaped glyphs correctly. The GLES atlas is re-keyed on `(glyph_id, size_bits, font_id)` so glyphs from different fonts at the same size no longer collide, and the atlas format is selected per ES profile (`GL_R8` / `GL_RED` on ES3, `GL_LUMINANCE` on ES2) — the fragment shader samples `.r` for both, since `GL_LUMINANCE` replicates the coverage byte into `.r=.g=.b`. Software path follows the same key. New `Cargo.toml` deps: `unicode-bidi = "0.3"`, `rustybuzz = "0.14"`.
Multi-touch hooks. `App::on_touch_down / on_touch_move / on_touch_up( id, x, y )` expose the raw `wl_touch.id` of every secondary finger. The first finger to land remains the *primary slot* and is fed through the regular gesture machine (`on_pointer_*`, swipe, scroll, long-press, drag-and-drop). Every additional finger fires the new callbacks instead, leaving the existing single-slot behaviour untouched for apps that do not override them. This is the substrate for app-defined pinch-zoom / two-finger pan; the toolkit itself does not yet ship a built-in pinch gesture (called out in the same "Known gaps" doc section).
`event_loop::frame` extracted from `draw/mod.rs`. The `draw_frame` orchestrator and its per-format SHM helper (`pick_shm_format`) move into `src/event_loop/frame.rs`, leaving `draw/` strictly responsible for per-surface paint primitives. The import in `event_loop/run.rs` is rewritten accordingly; `draw/mod.rs` shrinks from 192-line orchestrator to a thin module index.
Overlay teardown safety. `AppData::discard_overlay( id )` synchronously removes a destroyed overlay from the map and rewrites every per-device focus that pointed at it (pointer, keyboard, every touch slot), migrating an in-flight long-press drag to the main surface the same way `reconcile_overlays` does. Used by the compositor-driven destruction paths (`PopupHandler::done`, `LayerShellHandler::closed`) where waiting for the next reconcile would leave a window in which `surface()` / `surface_mut()` panic. The non-panicking siblings `try_surface` / `try_surface_mut` are added for callers on async dispatch paths (IME `Done`, tooltip arm) that may race a teardown.
Miscellaneous. CI: `master` → `main` to match the actual default branch. `Makefile` adds `cargo run --example dialog` to the examples target. `src/lib.rs` re-exports `widget::scroll::ScrollAxis` so apps can configure a `scroll()` axis without reaching into a `pub(crate)` module. `Cargo.toml` adds `accesskit = "0.17"` and `accesskit_unix = "0.13"`. `docs/architecture.md` gains the "Known gaps and non-goals" section that enumerates the new capabilities, what still ships flat, and what is deferred (per-widget a11y labels, primary selection, intra-process multi-touch gestures, `wp_fractional_scale_v1`).
2026-05-16 22:09:59 +02:00

249 lines
6.7 KiB
Rust

//! Integration tests for [`ltk::Element::map`] — the Elm-style adapter
//! that re-tags every per-leaf message in a sub-tree.
//!
//! Each test renders the mapped tree through a software [`UiSurface`],
//! looks up the per-widget [`WidgetHandlers`] snapshot the runtime
//! produced, and asserts that pressing a leaf fires the *outer*
//! `AppMsg::Sub( ... )` instead of the inner `SubMsg::...`.
use ltk::core::{ RenderOptions, UiSurface };
use ltk::test_support::WidgetHandlers;
use ltk::{
button, checkbox, column, list_item, radio, slider, text_edit, toggle,
vslider,
Color, Element,
};
#[ derive( Clone, Debug, PartialEq ) ]
enum SubMsg
{
Pressed,
Toggled,
Selected,
Open,
Slid( i32 ),
Vol( i32 ),
Typed( String ),
Submit,
}
#[ derive( Clone, Debug, PartialEq ) ]
enum AppMsg
{
Sub( SubMsg ),
}
fn sub_view() -> Element<SubMsg>
{
column::<SubMsg>()
.padding( 0.0 )
.spacing( 4.0 )
.push( button( "press" ).on_press( SubMsg::Pressed ) )
.push( toggle( false ).on_toggle( SubMsg::Toggled ) )
.push( checkbox( true ).on_toggle( SubMsg::Toggled ) )
.push( radio( false ).on_select( SubMsg::Selected ) )
.push( list_item( "row" ).on_press( SubMsg::Open ) )
.push( slider( 0.5 ).on_change( |v| SubMsg::Slid( ( v * 100.0 ) as i32 ) ) )
.push( vslider( 0.25 ).on_change( |v| SubMsg::Vol( ( v * 100.0 ) as i32 ) ) )
.push( text_edit::<SubMsg>( "ph", "" )
.on_change( SubMsg::Typed )
.on_submit( SubMsg::Submit ) )
.into()
}
fn render_mapped() -> UiSurface<AppMsg>
{
let mapped: Element<AppMsg> = sub_view().map( AppMsg::Sub );
let mut surface = UiSurface::<AppMsg>::new( 320, 320 );
let _ = surface.render(
&mapped,
RenderOptions::full_canvas( 320, 320 ).background( Color::rgb( 0.1, 0.1, 0.1 ) ),
);
surface
}
/// Walk every laid-out widget rect in `surface` and call `probe` with
/// each handler snapshot. The probe builds the test assertion for the
/// matching widget kind.
fn for_each_handler( surface: &UiSurface<AppMsg>, mut probe: impl FnMut( &WidgetHandlers<AppMsg> ) )
{
for widget in surface.widget_rects()
{
probe( &widget.handlers );
}
}
#[ test ]
fn button_press_msg_is_remapped()
{
let surface = render_mapped();
let mut found = false;
for_each_handler( &surface, |h|
{
if let WidgetHandlers::Button { on_press, .. } = h
{
if let Some( msg ) = on_press
{
assert_eq!( *msg, AppMsg::Sub( SubMsg::Pressed ), "button.on_press" );
found = true;
}
}
} );
assert!( found, "no Button handler with on_press in the rendered tree" );
}
#[ test ]
fn toggle_and_checkbox_messages_are_remapped()
{
let surface = render_mapped();
let mut toggle_seen = false;
let mut checkbox_seen = false;
for_each_handler( &surface, |h|
{
match h
{
WidgetHandlers::Toggle { on_toggle: Some( m ), .. } =>
{
assert_eq!( *m, AppMsg::Sub( SubMsg::Toggled ) );
toggle_seen = true;
}
WidgetHandlers::Checkbox { on_toggle: Some( m ), .. } =>
{
assert_eq!( *m, AppMsg::Sub( SubMsg::Toggled ) );
checkbox_seen = true;
}
_ => {}
}
} );
assert!( toggle_seen );
assert!( checkbox_seen );
}
#[ test ]
fn radio_and_list_item_messages_are_remapped()
{
let surface = render_mapped();
let mut radio_seen = false;
let mut item_seen = false;
for_each_handler( &surface, |h|
{
match h
{
WidgetHandlers::Radio { on_select: Some( m ), .. } =>
{
assert_eq!( *m, AppMsg::Sub( SubMsg::Selected ) );
radio_seen = true;
}
WidgetHandlers::ListItem { on_press: Some( m ) } =>
{
assert_eq!( *m, AppMsg::Sub( SubMsg::Open ) );
item_seen = true;
}
_ => {}
}
} );
assert!( radio_seen );
assert!( item_seen );
}
#[ test ]
fn slider_callbacks_run_through_the_mapper()
{
let surface = render_mapped();
let mut h_axis = false;
let mut v_axis = false;
for_each_handler( &surface, |h|
{
if let WidgetHandlers::Slider { on_change: Some( cb ), axis, .. } = h
{
// `cb` binds by-ref through default match ergonomics, so
// reach the trait object via `**cb` to invoke it.
let msg = ( **cb )( 0.5 );
match axis
{
ltk::SliderAxis::Horizontal =>
{
assert_eq!( msg, AppMsg::Sub( SubMsg::Slid( 50 ) ) );
h_axis = true;
}
ltk::SliderAxis::Vertical =>
{
assert_eq!( msg, AppMsg::Sub( SubMsg::Vol( 50 ) ) );
v_axis = true;
}
}
}
} );
assert!( h_axis, "horizontal slider handler not exercised" );
assert!( v_axis, "vertical slider handler not exercised" );
}
#[ test ]
fn text_edit_on_change_and_submit_are_remapped()
{
let surface = render_mapped();
let mut found = false;
for_each_handler( &surface, |h|
{
if let WidgetHandlers::TextEdit { on_change: Some( cb ), on_submit: Some( s ), .. } = h
{
let typed = ( **cb )( "hello".to_string() );
assert_eq!( typed, AppMsg::Sub( SubMsg::Typed( "hello".to_string() ) ) );
assert_eq!( *s, AppMsg::Sub( SubMsg::Submit ) );
found = true;
}
} );
assert!( found, "TextEdit handler not seen" );
}
#[ test ]
fn map_walks_into_nested_layouts()
{
// One level of nesting: Column -> Container -> Button.
use ltk::container;
let inner: Element<SubMsg> = container( button( "inner" ).on_press( SubMsg::Pressed ) ).into();
let outer: Element<SubMsg> = column::<SubMsg>().padding( 0.0 ).push( inner ).into();
let mapped: Element<AppMsg> = outer.map( AppMsg::Sub );
let mut surface = UiSurface::<AppMsg>::new( 200, 200 );
let _ = surface.render(
&mapped,
RenderOptions::full_canvas( 200, 200 ).background( Color::rgb( 0.1, 0.1, 0.1 ) ),
);
let widget = surface.widget_rects().iter().find( |w|
matches!( w.handlers, WidgetHandlers::Button { on_press: Some( _ ), .. } ) );
let widget = widget.expect( "button under nested layout not found" );
if let WidgetHandlers::Button { on_press: Some( msg ), .. } = &widget.handlers
{
assert_eq!( *msg, AppMsg::Sub( SubMsg::Pressed ) );
} else { unreachable!() }
}
#[ test ]
fn map_can_be_chained()
{
// `view -> map(L1) -> map(L2)` rewrites twice; the inner Sub gets
// double-wrapped. Verifies that a child Element<U> mapped again is
// still walkable and the closure chain composes left-to-right.
#[ derive( Clone, Debug, PartialEq ) ]
enum L1 { Wrap( SubMsg ) }
#[ derive( Clone, Debug, PartialEq ) ]
enum L2 { Wrap( L1 ) }
let leaf: Element<SubMsg> = button( "x" ).on_press( SubMsg::Pressed ).into();
let l1: Element<L1> = leaf.map( L1::Wrap );
let l2: Element<L2> = l1.map( L2::Wrap );
let mut surface = UiSurface::<L2>::new( 100, 80 );
let _ = surface.render(
&l2,
RenderOptions::full_canvas( 100, 80 ).background( Color::rgb( 0.1, 0.1, 0.1 ) ),
);
let widget = &surface.widget_rects()[ 0 ];
if let WidgetHandlers::Button { on_press: Some( msg ), .. } = &widget.handlers
{
assert_eq!( *msg, L2::Wrap( L1::Wrap( SubMsg::Pressed ) ) );
} else { panic!( "expected Button handler" ) }
}