Pedro M. de Echanove Pasquin
ccf07de593
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`.
73 lines
2.9 KiB
TOML
73 lines
2.9 KiB
TOML
[package]
|
|
name = "ltk"
|
|
version = "0.3.0"
|
|
edition = "2021"
|
|
rust-version = "1.85"
|
|
# MSRV-aware resolver: keep a fresh resolve on deps compatible with rust-version (Debian stable = 1.85).
|
|
resolver = "3"
|
|
license = "LGPL-2.1-only"
|
|
description = "Lightweight declarative Wayland UI toolkit. Elm-shaped App / view / update model with GLES and software rendering backends, layer-shell support, runtime theming and a runtime-free core surface for embedding."
|
|
repository = "https://github.com/liberux/ltk"
|
|
documentation = "https://docs.rs/ltk"
|
|
homepage = "https://liberux.net"
|
|
readme = "README.md"
|
|
keywords = [ "wayland", "ui", "gui", "toolkit", "layer-shell" ]
|
|
categories = [ "gui", "rendering", "os::linux-apis" ]
|
|
authors = [ "Liberux Labs, S. L. <info@liberux.net>" ]
|
|
exclude = [
|
|
"target/*",
|
|
"debian/*",
|
|
"themes/*",
|
|
"liberux.toml",
|
|
"TODO",
|
|
]
|
|
|
|
[features]
|
|
# Exposes `ltk::test_support` — internal helpers (widget handlers, laid-out
|
|
# widget lookup, slider math) used only by ltk's own integration tests. Not
|
|
# part of the stable public API; off by default so third-party builds never
|
|
# see it. `make test` enables it.
|
|
test-support = []
|
|
|
|
[dependencies]
|
|
chrono = { version = "0.4", features = ["clock"] }
|
|
serde = { version = "1.0", features = ["derive"] }
|
|
serde_json = "1.0"
|
|
smithay-client-toolkit = { version = "0.20", features = ["calloop", "calloop-wayland-source", "xkbcommon"] }
|
|
calloop = { version = "0.14", features = ["signals"] }
|
|
calloop-wayland-source = "0.4"
|
|
tiny-skia = "0.12"
|
|
fontdue = "=0.9.3"
|
|
unicode-bidi = "0.3"
|
|
rustybuzz = "0.14"
|
|
image = { version = "=0.25.9", default-features = false, features = ["png", "jpeg", "webp"] }
|
|
resvg = "0.44"
|
|
rust-i18n = "3"
|
|
# Transitive dep of rust-i18n (globwalk → ignore); 0.4.24+ needs a rustc
|
|
# newer than Debian's 1.85, and its manifest does not declare that MSRV.
|
|
ignore = "=0.4.23"
|
|
wayland-protocols = { version = "0.32", features = ["client", "unstable", "staging"] }
|
|
wayland-egl = "0.32"
|
|
wayland-scanner = "0.31"
|
|
khronos-egl = { version = "6", features = ["dynamic"] }
|
|
glow = "0.17"
|
|
raw-window-handle = "0.6"
|
|
# AT-SPI2 / accessibility is delegated to AccessKit so we get the same
|
|
# Node / Role / TreeUpdate model the rest of the Rust GUI ecosystem
|
|
# (egui, iced via the COSMIC fork, dioxus) is converging on. The
|
|
# Linux platform adapter (`accesskit_unix`) handles every D-Bus
|
|
# detail — registering against `org.a11y.Bus`, exposing the
|
|
# `org.a11y.atspi.Accessible` interface hierarchy, translating
|
|
# `Action`s back into our event loop, emitting state-changed signals
|
|
# — so this crate only has to construct an `accesskit::TreeUpdate`
|
|
# from `widget_rects` once per frame.
|
|
accesskit = "0.17"
|
|
accesskit_unix = "0.13"
|
|
|
|
[dev-dependencies]
|
|
criterion = { version = "0.5", features = ["html_reports"] }
|
|
|
|
[[bench]]
|
|
name = "lookup"
|
|
harness = false
|