Files
ltk/examples/scroll.rs
Pedro M. de Echanove Pasquin ccf07de593
Some checks failed
CI / build + test (push) Has been cancelled
CI / cargo audit (push) Has been cancelled
Session management: xdg-session-management-v1 client, mandatory App::app_id / save_state / restore_state, runtime-managed state persistence and clean exit on signals (0.3.0)
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`.
2026-08-15 10:16:30 +02:00

172 lines
4.7 KiB
Rust

//! `cargo run --example scroll`
//!
//! Demonstrates the two main scroll use cases:
//!
//! - **List mode** — a long vertical list inside a `scroll(column(...))`.
//! - **Grid mode** — a grid of buttons inside a `scroll(grid(4))` (app-drawer style).
//!
//! Press the "List" / "Grid" toggle at the top to switch between modes.
//! Drag the content area to scroll. Esc exits.
//!
//! NOTE: ltk is a Wayland layer-shell toolkit. This example requires a running
//! Wayland compositor (e.g. sway, labwc, or a full desktop session).
use ltk::{
App, Element, Keysym, ButtonVariant,
button, column, row, text, scroll, grid, spacer,
};
// ── Messages ──────────────────────────────────────────────────────────────────
#[ derive( Clone ) ]
enum Message
{
ShowList,
ShowGrid,
ItemPressed( usize ),
}
// ── App state ─────────────────────────────────────────────────────────────────
#[ derive( PartialEq ) ]
enum Mode { List, Grid }
struct ScrollApp
{
mode: Mode,
last_pressed: Option<usize>,
}
impl ScrollApp
{
fn new() -> Self
{
Self { mode: Mode::List, last_pressed: None }
}
}
// ── App trait ─────────────────────────────────────────────────────────────────
const ITEM_COUNT: usize = 64;
impl App for ScrollApp
{
type Message = Message;
fn app_id( &self ) -> &str { "net.liberux.ltk.example.scroll" }
fn save_state( &self ) -> Option<Vec<u8>>
{
Some( match self.mode { Mode::List => b"list".to_vec(), Mode::Grid => b"grid".to_vec() } )
}
fn restore_state( &mut self, state: Vec<u8> )
{
match state.as_slice()
{
b"list" => self.mode = Mode::List,
b"grid" => self.mode = Mode::Grid,
_ => {}
}
}
fn view( &self ) -> Element<Message>
{
let palette = ltk::theme_palette();
let primary = palette.text_primary;
let secondary = palette.text_secondary;
let status = match self.last_pressed
{
Some( i ) => format!( "Pressed item {}", i + 1 ),
None => String::from( "Drag to scroll · click an item" ),
};
// Top bar: toggle buttons + status
let toggle_list = button::<Message>( "List" )
.variant( if self.mode == Mode::List { ButtonVariant::Primary } else { ButtonVariant::Secondary } )
.on_press( Message::ShowList );
let toggle_grid = button::<Message>( "Grid" )
.variant( if self.mode == Mode::Grid { ButtonVariant::Primary } else { ButtonVariant::Secondary } )
.on_press( Message::ShowGrid );
let top_bar = row::<Message>()
.spacing( 8.0 )
.push( toggle_list )
.push( toggle_grid )
.push( spacer() )
.push( text( &status ).size( 14.0 ).color( secondary ) );
// Scrollable content area
let content: Element<Message> = match self.mode
{
Mode::List =>
{
// A long list of labeled buttons in a scrollable column
let mut col = column::<Message>().padding( 8.0 ).spacing( 6.0 );
for i in 0..ITEM_COUNT
{
col = col.push(
button::<Message>( format!( "List item {} — click me", i + 1 ) )
.variant( ButtonVariant::Secondary )
.on_press( Message::ItemPressed( i ) ),
);
}
scroll( col ).into()
}
Mode::Grid =>
{
// A grid of labeled buttons in a scrollable 4-column grid
let mut g = grid::<Message>( 4 ).padding( 8.0 ).spacing( 6.0 );
for i in 0..ITEM_COUNT
{
g = g.push(
button::<Message>( format!( "Item {}", i + 1 ) )
.variant( ButtonVariant::Secondary )
.on_press( Message::ItemPressed( i ) ),
);
}
scroll( g ).into()
}
};
column::<Message>()
.padding( 16.0 )
.spacing( 12.0 )
.push( text( "ltk — scroll showcase" ).size( 22.0 ).color( primary ).align_center() )
.push( top_bar )
.push( content )
.push(
text( "Drag = scroll · Esc = quit" )
.size( 12.0 )
.color( secondary )
.align_center(),
)
.into()
}
fn update( &mut self, msg: Message )
{
match msg
{
Message::ShowList => self.mode = Mode::List,
Message::ShowGrid => self.mode = Mode::Grid,
Message::ItemPressed( i ) => self.last_pressed = Some( i ),
}
}
fn on_key( &mut self, keysym: Keysym ) -> Option<Message>
{
if keysym == Keysym::Escape { std::process::exit( 0 ); }
None
}
}
// ── Entry point ───────────────────────────────────────────────────────────────
fn main()
{
ltk::run( ScrollApp::new() );
}