Applications built on ltk had no way to come back where the user left them: the toolkit hardcoded `app_id = "ltk"` on every toplevel, never wrote anything to disk, and died on SIGTERM without a chance to save. This release gives the runtime the whole plumbing and asks each application only for the bytes worth keeping, in the spirit of Android's saved-instance state. The `App` trait gains three mandatory methods, deliberately without default bodies so every application states its position: `app_id()` (reverse-DNS, used for `xdg_toplevel.set_app_id`, the AccessKit application name and the state directory — the `app_id` element of the deprecated `window_config` tuple is now ignored and a one-time warning reports a mismatch), `save_state() -> Option<Vec<u8>>` and `restore_state(Vec<u8>)`. The bytes are opaque; the trait carries no serde bound. Their rustdoc is the contract: when the runtime saves, where the files live, when the bytes come back and when they do not, what must never go in them, and a worked serde_json example. The runtime persists under `$XDG_STATE_HOME/<app_id>/` (falling back to `~/.local/state`): `session.json` holds the compositor session id, a clean-exit marker and the writer's pid; `state.bin` holds the application bytes. Writes are atomic (temp file + rename, mode 0600, directory 0700) and best-effort. State is saved every 30 s when the bytes changed, once after the event loop exits (which covers `on_close_requested`, `requested_exit` and lost connections), and on SIGTERM/SIGINT — a calloop signal source, installed before any thread exists, now turns those into a clean exit of the loop instead of process death. `restore_state` runs synchronously in `try_run` before the window is created and before the first `view()`, and only when the process is relaunched as part of a session restore (`LTK_SESSION_RESTORE=1`, removed from the environment before the app can spawn children) or when the previous run left `clean_exit: false`; a plain launch starts fresh. A second concurrent instance detects the live pid and runs with persistence disabled rather than clobbering the first. The compositor side of geometry restore goes through `xdg-session-management-v1`. Neither wayland-protocols nor sctk ship generated code for it yet, so the XML is vendored under `protocols/` and `wayland-scanner` generates the client module in-tree (`src/protocol/`), resolving the crate names through sctk's reexports so the bindings stay on the crate instances sctk links. Before the first commit of a `ShellMode::Window` toplevel the runtime binds `xdg_session_manager_v1`, calls `get_session(reason, stored_id)` and `restore_toplevel(toplevel, "main")`; the three window-creation paths in `run.rs` are folded into one `make_window` helper so the attach always sits immediately before `commit()`. `created` persists the id, `replaced` destroys the objects and stops persisting. Compositors without the global lose only the geometry half. Layer-shell and session-lock surfaces skip the whole machinery. Every `App` implementor in the tree is updated: the twelve examples (`showcase`, `scroll` and `mini_shell` persist real state; the rest return `None`), both integration tests (`event_loop_flow` gains `save_restore_round_trip`), the in-source and markdown doctests, README, onboarding, cookbook (new recipe "Surviving relaunch: session state") and architecture docs, and the changelog. `src/session_state.rs` carries unit tests over a temporary state directory. `Makefile install` now copies `protocols/` into the cargo registry — without it downstream builds would fail inside the proc-macro — and `debian/copyright` covers the vendored XML. The trait change is breaking, hence 0.3.0. Also fixes the pre-existing `viewport_tests` module in `render/mod.rs`, which used `Length` without importing it and broke `cargo test`.
232 lines
5.8 KiB
Rust
232 lines
5.8 KiB
Rust
//! `cargo run --example combo`
|
||
//!
|
||
//! Showcases the `combo` widget — a select / dropdown with editable
|
||
//! query, multi-select chips and a scrollable popup.
|
||
//!
|
||
//! The trigger lives in the main `view()` tree; the popup is returned
|
||
//! from [`App::overlays`] as a real Wayland **xdg-popup** child of the
|
||
//! main window, so it can extend outside the parent surface (the
|
||
//! canonical select / dropdown behaviour). The compositor positions the
|
||
//! popup adjacent to the trigger pill and dismisses it via
|
||
//! `popup_done` when the user clicks outside, which fires the spec's
|
||
//! `on_dismiss` message.
|
||
//!
|
||
//! Tap on an item to add it to the selection; tap on the `×` next to a
|
||
//! chip to remove it; tap outside the popup to dismiss. Esc exits.
|
||
|
||
use ltk::
|
||
{
|
||
combo, column, row, separator, spacer, text,
|
||
App, Color, ComboState, Element, Keysym, OverlaySpec, WidgetId,
|
||
};
|
||
|
||
// Distinct anchor ids so each combo's popup can find its own trigger
|
||
// pill in the previous-frame layout snapshot.
|
||
const FRUIT_ANCHOR: WidgetId = WidgetId( "demo-fruit-trigger" );
|
||
const REGION_ANCHOR: WidgetId = WidgetId( "demo-region-trigger" );
|
||
|
||
#[ derive( Clone, Debug ) ]
|
||
enum Msg
|
||
{
|
||
// Multi-select fruit picker.
|
||
FruitToggle,
|
||
FruitQuery( String ),
|
||
FruitSelect( usize ),
|
||
FruitUnselect( usize ),
|
||
FruitDismiss,
|
||
// Single-select region picker (non-searchable).
|
||
RegionToggle,
|
||
RegionSelect( usize ),
|
||
RegionDismiss,
|
||
}
|
||
|
||
struct Demo
|
||
{
|
||
fruits: ComboState,
|
||
fruit_items: Vec<String>,
|
||
region: ComboState,
|
||
region_items: Vec<String>,
|
||
}
|
||
|
||
impl Demo
|
||
{
|
||
fn new() -> Self
|
||
{
|
||
Self
|
||
{
|
||
fruits: ComboState::new(),
|
||
fruit_items: [
|
||
"Apple", "Apricot", "Avocado", "Banana", "Blackberry",
|
||
"Blueberry", "Cherry", "Date", "Fig", "Grape", "Kiwi",
|
||
"Lemon", "Lime", "Mango", "Orange", "Papaya", "Peach",
|
||
"Pear", "Pineapple", "Plum", "Raspberry", "Strawberry",
|
||
].iter().map( |s| s.to_string() ).collect(),
|
||
|
||
region: ComboState::new(),
|
||
region_items: [
|
||
"Galicia", "Asturias", "Cantabria", "País Vasco",
|
||
"Navarra", "La Rioja", "Aragón", "Cataluña",
|
||
].iter().map( |s| s.to_string() ).collect(),
|
||
}
|
||
}
|
||
|
||
fn fruit_combo( &self ) -> ltk::Combo<Msg>
|
||
{
|
||
combo( self.fruits.clone(), self.fruit_items.clone() )
|
||
.label( "Fruits" )
|
||
.description( "Pick the ones you want in the smoothie." )
|
||
.placeholder( "Type to filter…" )
|
||
.helper( "Selected fruits show up as chips above the field." )
|
||
.multi_select( true )
|
||
.searchable( true )
|
||
.anchor_id( FRUIT_ANCHOR )
|
||
.popup_max_height( 280.0 )
|
||
.on_query_change( Msg::FruitQuery )
|
||
.on_toggle_open( Msg::FruitToggle )
|
||
.on_select_idx( Msg::FruitSelect )
|
||
.on_unselect_idx( Msg::FruitUnselect )
|
||
.on_dismiss( Msg::FruitDismiss )
|
||
}
|
||
|
||
fn region_combo( &self ) -> ltk::Combo<Msg>
|
||
{
|
||
combo( self.region.clone(), self.region_items.clone() )
|
||
.label( "Region" )
|
||
.description( "Single-select, non-searchable." )
|
||
.placeholder( "Choose a region…" )
|
||
.anchor_id( REGION_ANCHOR )
|
||
.popup_max_height( 240.0 )
|
||
.on_toggle_open( Msg::RegionToggle )
|
||
.on_select_idx( Msg::RegionSelect )
|
||
.on_dismiss( Msg::RegionDismiss )
|
||
}
|
||
|
||
fn body( &self ) -> Element<Msg>
|
||
{
|
||
let palette = ltk::theme_palette();
|
||
|
||
column::<Msg>()
|
||
.padding( 32.0 )
|
||
.spacing( 24.0 )
|
||
.center_y( false )
|
||
.push(
|
||
text( "ltk — combo / select demo" )
|
||
.size( 24.0 )
|
||
.color( palette.text_primary )
|
||
.align_center(),
|
||
)
|
||
.push( separator() )
|
||
.push( self.fruit_combo().trigger() )
|
||
.push( separator() )
|
||
.push( self.region_combo().trigger() )
|
||
.push( spacer() )
|
||
.push(
|
||
row::<Msg>()
|
||
.padding( 0.0 )
|
||
.spacing( 8.0 )
|
||
.push(
|
||
text( format!( "Fruits selected: {}", self.fruits.selected.len() ) )
|
||
.size( 14.0 )
|
||
.color( palette.text_secondary ),
|
||
)
|
||
.push( spacer() )
|
||
.push(
|
||
text(
|
||
self.region.selected.first()
|
||
.and_then( |&i| self.region_items.get( i ) )
|
||
.map( |s| format!( "Region: {s}" ) )
|
||
.unwrap_or_else( || "Region: —".to_string() ),
|
||
)
|
||
.size( 14.0 )
|
||
.color( palette.text_secondary ),
|
||
),
|
||
)
|
||
.push(
|
||
text( "Esc = quit" )
|
||
.size( 12.0 )
|
||
.color( palette.text_secondary )
|
||
.align_center(),
|
||
)
|
||
.into()
|
||
}
|
||
}
|
||
|
||
impl App for Demo
|
||
{
|
||
type Message = Msg;
|
||
|
||
fn app_id( &self ) -> &str { "net.liberux.ltk.example.combo" }
|
||
fn save_state( &self ) -> Option<Vec<u8>> { None }
|
||
fn restore_state( &mut self, _state: Vec<u8> ) {}
|
||
|
||
fn view( &self ) -> Element<Msg>
|
||
{
|
||
self.body()
|
||
}
|
||
|
||
fn overlays( &self ) -> Vec<OverlaySpec<Msg>>
|
||
{
|
||
// Each open combo contributes one xdg-popup overlay anchored
|
||
// to its trigger pill; closed combos contribute nothing.
|
||
let mut out = Vec::new();
|
||
if let Some( o ) = self.fruit_combo().overlay() { out.push( o ); }
|
||
if let Some( o ) = self.region_combo().overlay() { out.push( o ); }
|
||
out
|
||
}
|
||
|
||
fn update( &mut self, msg: Msg )
|
||
{
|
||
match msg
|
||
{
|
||
Msg::FruitToggle => self.fruits.toggle_open(),
|
||
Msg::FruitQuery( q ) => self.fruits.query = q,
|
||
Msg::FruitSelect( i ) =>
|
||
{
|
||
if self.fruits.selected.contains( &i )
|
||
{
|
||
self.fruits.unselect( i );
|
||
}
|
||
else
|
||
{
|
||
self.fruits.select( i );
|
||
}
|
||
}
|
||
Msg::FruitUnselect( i ) => self.fruits.unselect( i ),
|
||
Msg::FruitDismiss =>
|
||
{
|
||
self.fruits.is_open = false;
|
||
self.fruits.query.clear();
|
||
}
|
||
|
||
Msg::RegionToggle => self.region.toggle_open(),
|
||
Msg::RegionSelect( i ) =>
|
||
{
|
||
// Single-select: replace the whole `selected` vector
|
||
// with just this index, then close.
|
||
self.region.selected = vec![ i ];
|
||
self.region.is_open = false;
|
||
}
|
||
Msg::RegionDismiss => self.region.is_open = false,
|
||
}
|
||
}
|
||
|
||
fn on_key( &mut self, keysym: Keysym ) -> Option<Msg>
|
||
{
|
||
if keysym == Keysym::Escape
|
||
{
|
||
std::process::exit( 0 );
|
||
}
|
||
None
|
||
}
|
||
|
||
fn background_color( &self ) -> Color
|
||
{
|
||
ltk::theme_palette().bg
|
||
}
|
||
}
|
||
|
||
fn main()
|
||
{
|
||
ltk::run( Demo::new() );
|
||
}
|