# Conflicts:
#	apps/lightcraft/src/main.rs
#	docs/parity-checklist.md
#	docs/whats-new.md
This commit is contained in:
Brandon Thomas
2026-10-14 22:33:14 -04:00
6 changed files with 1079 additions and 6 deletions
+137 -5
View File
@@ -81,6 +81,8 @@ impl eframe::App for App {
self.0.ui(ui);
}
fn on_exit(&mut self, _gl: Option<&eframe::glow::Context>) {
// (a size the window was just given is remembered too)
self.0.ui.window = self.1.window_at_exit(self.0.ui.window);
if let Err(e) = self.1.save(&self.0) {
log::error!("{e}");
}
@@ -224,6 +226,16 @@ fn config_dir() -> Option<std::path::PathBuf> {
lightcraft_engine::config::config_dir()
}
/// The window at the size it was last used at, zoomed if it was (`window`), or at the usual size
/// when nothing is remembered. A zoomed window is given the size it goes back to. Where it
/// opens is the system's to say.
fn as_remembered(builder: egui::ViewportBuilder, window: Option<lightcraft_ui_egui::window_place::WindowPlace>) -> egui::ViewportBuilder {
let builder = builder.with_inner_size(window.map_or(lightcraft_ui_egui::window_place::DEFAULT_SIZE, |w| w.size));
// (only ever asked to zoom: asked not to, macOS un-zooms a window whose size fills the screen
// to a size of its own choosing)
if window.is_some_and(|w| w.zoomed) { builder.with_maximized(true) } else { builder }
}
/// `<config>/ui.json`, the saved UI state and app settings — `None` when nothing is read or
/// written: `LIGHTCRAFT_NO_PREFS` (tests, scripts) or no home folder.
fn prefs_path() -> Option<std::path::PathBuf> {
@@ -342,6 +354,11 @@ struct PrefsWriter {
failing: bool,
/// `ui.json` couldn't be read at launch: never overwrite it this session.
keep_file: bool,
/// Follows the window, to remember the size it rests at (`UiState::window`).
window: lightcraft_ui_egui::window_place::WindowWatch,
/// When the window was first looked at: its watch goes by the clock from then on, not by
/// the interface's time, which stands still while the window is hidden.
window_since: Option<std::time::Instant>,
}
impl PrefsWriter {
@@ -372,8 +389,33 @@ impl PrefsWriter {
Ok(())
}
/// What to remember of the window as the app quits ([`WindowWatch::at_exit`]).
///
/// [`WindowWatch::at_exit`]: lightcraft_ui_egui::window_place::WindowWatch::at_exit
fn window_at_exit(
&mut self,
remembered: Option<lightcraft_ui_egui::window_place::WindowPlace>,
) -> Option<lightcraft_ui_egui::window_place::WindowPlace> {
match self.window_since {
Some(since) => self.window.at_exit(remembered, since.elapsed().as_secs_f64()),
None => remembered,
}
}
fn tick(&mut self, app: &mut LightcraftApp, ctx: &egui::Context) {
let now = ctx.input(|i| i.time);
// (asked for before the input is read: the context is not asked from inside its own lock)
let zoom = ctx.zoom_factor();
let (now, seen) = ctx.input(|i| (i.time, lightcraft_ui_egui::window_place::Seen::of(i.viewport(), i.content_rect(), zoom)));
// how the window is, to open like that next time (written with the settings below). What
// the settings hold is checked first: a script may have set it (`ui.set`)
let remembered = app.ui.window.and_then(lightcraft_ui_egui::window_place::WindowPlace::checked);
let at = self.window_since.get_or_insert_with(std::time::Instant::now).elapsed().as_secs_f64();
app.ui.window = self.window.note(remembered, &seen, at);
if let Some(wait) = self.window.waits(at) {
// (a size is only remembered once the window has rested at it: look again then, though
// nothing else asks for a frame)
ctx.request_repaint_after(wait);
}
let moved = app.ui.settings.library_path != self.library;
if !moved && now - self.checked < 3.0 {
return;
@@ -881,12 +923,12 @@ fn main() -> eframe::Result {
// the window came up: a failure after this is LightCraft stopping, not a start that failed
let came_up = std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false));
let came_up_app = came_up.clone();
// how the window was when the app was last used (checked: the settings file is a file)
let opens_as = prefs.as_ref().and_then(|ui| ui.window).and_then(lightcraft_ui_egui::window_place::WindowPlace::checked);
let options = eframe::NativeOptions {
renderer,
viewport: egui::ViewportBuilder::default()
.with_title("LightCraft")
.with_inner_size([1600.0, 1000.0])
.with_min_inner_size([900.0, 560.0])
viewport: as_remembered(egui::ViewportBuilder::default().with_title("LightCraft"), opens_as)
.with_min_inner_size(lightcraft_ui_egui::window_place::MIN_SIZE)
.with_drag_and_drop(true)
.with_fullsize_content_view(true)
.with_titlebar_shown(false)
@@ -1386,6 +1428,96 @@ mod tests {
let _ = std::fs::remove_dir_all(&d);
}
/// Given what the settings remember of the window, when the app's window is built, then it
/// opens at that size, zoomed if it was, where the system puts it; with nothing remembered it
/// opens at the usual size.
#[test]
fn the_window_opens_as_it_was() {
use lightcraft_ui_egui::window_place::{DEFAULT_SIZE, WindowPlace};
let fresh = as_remembered(egui::ViewportBuilder::default(), None);
assert_eq!((fresh.inner_size, fresh.position, fresh.maximized), (Some(egui::Vec2::from(DEFAULT_SIZE)), None, None));
let b = as_remembered(egui::ViewportBuilder::default(), Some(WindowPlace { size: [1300.0, 800.0], zoomed: true }));
assert_eq!((b.inner_size, b.position, b.maximized), (Some(egui::vec2(1300.0, 800.0)), None, Some(true)));
// (not asked to un-zoom: macOS would then resize a window that fills its screen)
let b = as_remembered(egui::ViewportBuilder::default(), Some(WindowPlace { size: [1300.0, 800.0], zoomed: false }));
assert_eq!((b.inner_size, b.position, b.maximized), (Some(egui::vec2(1300.0, 800.0)), None, None));
}
/// Given a window that rests at a size, when the settings are written and read again, then
/// they hold how it was. A window in the file that is not one (a hand edit, another version's)
/// reads as nothing remembered and costs no other setting; and a window resized just before
/// the app quits is remembered at that size.
#[test]
fn the_settings_keep_how_the_window_was() {
use lightcraft_ui_egui::window_place::{Seen, WindowPlace};
let d = dir("window");
let path = d.join("ui.json");
let mut app = LightcraftApp::new(lightcraft_engine::Session::with_demo(), Services::default());
app.ui.settings.library_path = "/pictures/library".into();
let mut writer = PrefsWriter { path: Some(path.clone()), ..Default::default() };
writer.save(&app).unwrap();
assert!(!std::fs::read_to_string(&path).unwrap().contains("\"window\""), "nothing to remember yet");
let window = WindowPlace { size: [1300.0, 800.0], zoomed: true };
app.ui.window = Some(window);
writer.save(&app).unwrap();
let (restored, warning, _) = load_prefs_at(&path, false);
assert_eq!((restored.unwrap().window, warning), (Some(window), None));
// a window that is no window: the file is read all the same, with its other settings
let text = std::fs::read_to_string(&path).unwrap();
for odd in [r#""window": {}"#, r#""window": "wide""#, r#""window": {"size": [1, 2, 3]}"#, r#""window": {"size": [null, 800.0]}"#] {
let start = text.find("\"window\"").unwrap();
let end = start + text[start..].find('}').unwrap() + 1;
std::fs::write(&path, format!("{}{odd}{}", &text[..start], &text[end..])).unwrap();
let (restored, warning, keep) = load_prefs_at(&path, true);
let restored = restored.unwrap_or_else(|| panic!("{odd}: {warning:?}"));
assert_eq!((restored.window, restored.settings.library_path.as_str(), warning, keep), (None, "/pictures/library", None, false), "{odd}");
}
// resized, and the app quits a moment later: the new size is what is written
let mut writer = PrefsWriter { path: Some(path.clone()), ..Default::default() };
let rest = Some(WindowPlace { size: [1300.0, 800.0], zoomed: false });
writer.window.note(rest, &Seen { size: Some([1500.0, 900.0]), ..Default::default() }, 0.0);
writer.window_since = std::time::Instant::now().checked_sub(std::time::Duration::from_millis(400));
assert!(writer.window_since.is_some());
assert_eq!(writer.window_at_exit(rest), Some(WindowPlace { size: [1500.0, 900.0], zoomed: false }));
assert_eq!(PrefsWriter::default().window_at_exit(rest), rest, "a window that was never seen");
let _ = std::fs::remove_dir_all(&d);
}
/// Given the app's window at a size, when the settings writer looks at it frame after frame,
/// then it asks to be woken while the size has still to rest, remembers the size once it has,
/// and asks for nothing more. A window in the settings that is not one (a script set it) is
/// put right before it is gone by.
#[test]
fn the_writer_follows_the_window_from_frame_to_frame() {
use lightcraft_ui_egui::window_place::WindowPlace;
let mut app = LightcraftApp::new(lightcraft_engine::Session::with_demo(), Services::default());
let mut writer = PrefsWriter::default();
let ctx = egui::Context::default();
let pass = |look: &mut dyn FnMut(&egui::Context)| {
let raw =
egui::RawInput { screen_rect: Some(egui::Rect::from_min_size(egui::Pos2::ZERO, egui::vec2(1300.0, 800.0))), ..Default::default() };
let mut out = ctx.run_ui(raw, |ui| look(ui.ctx()));
out.textures_delta.clear();
out.viewport_output.get(&egui::ViewportId::ROOT).map(|v| v.repaint_delay)
};
// (egui's own first frames ask for another: let them pass)
for _ in 0..3 {
pass(&mut |_| {});
}
app.ui.window = Some(WindowPlace { size: [f32::NAN, 800.0], zoomed: true });
let asked = pass(&mut |ctx| writer.tick(&mut app, ctx));
assert_eq!(app.ui.window, None, "no window, and not yet at rest");
assert!(asked.is_some_and(|wait| wait <= std::time::Duration::from_secs(1)), "{asked:?}");
// a second later
writer.window_since = writer.window_since.and_then(|since| since.checked_sub(std::time::Duration::from_secs(1)));
pass(&mut |ctx| writer.tick(&mut app, ctx));
assert_eq!(app.ui.window, Some(WindowPlace { size: [1300.0, 800.0], zoomed: false }));
let asked = pass(&mut |ctx| writer.tick(&mut app, ctx));
assert!(asked.is_none_or(|wait| wait > std::time::Duration::from_secs(3600)), "at rest and remembered: {asked:?}");
}
/// #1331: on macOS the process ends inside `on_exit`, before eframe would tear the window down.
/// The check runs in a child (this test binary again), since on macOS it ends the process.
#[test]
+1
View File
@@ -42,6 +42,7 @@ pub mod text_field;
pub mod theme;
pub mod titlebar;
pub mod widgets;
pub mod window_place;
#[cfg(test)]
mod tests_activity;
+6
View File
@@ -612,6 +612,11 @@ pub enum KeywordChips {
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(default, rename_all = "camelCase")]
pub struct UiState {
/// How large the app's window was and whether it was zoomed, to open it like that again (the
/// desktop app; absent until a window has rested at a size). Read leniently: a window that
/// is not one reads as none, and never costs the other settings.
#[serde(skip_serializing_if = "Option::is_none", deserialize_with = "crate::window_place::WindowPlace::lenient")]
pub window: Option<crate::window_place::WindowPlace>,
/// Shared panel arrangement; absent in legacy settings until their first layout.
pub docking: Option<crate::docking::Workspace>,
#[serde(default = "crate::i18n::default_language")]
@@ -1229,6 +1234,7 @@ pub struct SyncCounts {
impl Default for UiState {
fn default() -> Self {
UiState {
window: None,
docking: None,
language: crate::i18n::default_language(),
preview_build_seen: None,
+919
View File
@@ -0,0 +1,919 @@
//! How large the app's window was and whether it was zoomed (macOS) / maximized, so that it opens
//! like that again. Kept with the settings (`ui.json`).
//!
//! The size is the window's as it is when neither zoomed nor full screen: a zoomed window opens
//! zoomed, and goes back to that size when it is un-zoomed. Full screen is not remembered (the
//! app opens as a window), and neither is where on the desktop the window was: the system places
//! it. A place can be on a display that is gone, and only the window system knows which
//! displays there are.
//!
//! Windows and Linux say whether a window is maximized. macOS says so only when the window opens
//! and when the app zooms it itself, so there the window's size is gone by as well (`Unsaid`): a
//! window is zoomed when the system said so, or when it was seen to come to fill its screen, and
//! for as long as it then keeps its size (or is fitted to another screen that it fills). That
//! is a judgement, and it errs to one side on purpose: whatever is in doubt is a window of the
//! size it has, which opens as large as it was left, and only the size it would have gone back
//! to is not kept. So it is with a zoom from the Window menu beside a Dock at the side of the
//! screen, or of a window already as wide as its screen. The other way round there is one case:
//! a window dragged out by hand until it is as wide as its screen and nearly as tall is taken
//! for zoomed, and opens filling the screen.
//!
//! This module only decides (what to remember from what the window reports, what to open with);
//! the desktop app builds its window from it and feeds it each frame.
use serde::{Deserialize, Serialize};
/// The size a window opens with when none is remembered, in points.
pub const DEFAULT_SIZE: [f32; 2] = [1600.0, 1000.0];
/// The smallest the window gets.
pub const MIN_SIZE: [f32; 2] = [900.0, 560.0];
/// No window is wider or taller than this: a larger number in the settings is not a size.
const MAX_SIDE: f32 = 16_384.0;
/// How long a size must stay as it is before it is remembered: a window that is being resized
/// or zoomed (which the system animates) passes through sizes it never rests at.
const SETTLED_SECONDS: f64 = 0.5;
/// A size that has stayed this long when the app quits is remembered too (an animation changes
/// it with every frame; a person who resizes and quits at once has let go of it by then).
const SETTLED_AT_EXIT_SECONDS: f64 = 0.15;
/// Two sizes this near each other, across and down, are one size (a size goes through the
/// screen's pixels and back).
const SAME_WITHIN: f32 = 1.5;
/// How much of its screen's height a zoomed window leaves to the system at most: the menu bar
/// (taller beside a camera housing) and a Dock along the bottom at its largest.
const SCREEN_KEPT_DOWN: f32 = 240.0;
/// A little longer than the wait, so that the frame asked for comes after it and not just before.
const LOOK_AGAIN_MARGIN_SECONDS: f64 = 0.05;
/// How long a window that has just left full screen is not looked at: the system animates the
/// way back, and not every way of leaving says that it is still under way.
const AFTER_FULL_SCREEN_SECONDS: f64 = 1.0;
/// How the window was.
#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WindowPlace {
/// Its inner size while neither zoomed nor full screen, in points (of the system, not of
/// the interface's own scale).
pub size: [f32; 2],
/// Zoomed (macOS) / maximized.
#[serde(default)]
pub zoomed: bool,
}
fn size_is_one(size: [f32; 2]) -> bool {
size.iter().all(|s| s.is_finite() && (1.0..=MAX_SIDE).contains(s))
}
/// `size`, or the smallest the window gets where it is smaller (a window manager that does not
/// keep to the minimum, a script): what is remembered is always a size the window opens at.
fn at_least_min(size: [f32; 2]) -> [f32; 2] {
[size[0].max(MIN_SIZE[0]), size[1].max(MIN_SIZE[1])]
}
fn same(a: [f32; 2], b: [f32; 2]) -> bool {
(a[0] - b[0]).abs() <= SAME_WITHIN && (a[1] - b[1]).abs() <= SAME_WITHIN
}
/// Whether a window of `size` fills `screen` as a zoomed one does where the Dock is hidden or
/// along the bottom: from side to side, and down to what the system keeps.
fn fills(size: [f32; 2], screen: [f32; 2]) -> bool {
size[0] >= screen[0] - SAME_WITHIN && size[1] >= screen[1] - SCREEN_KEPT_DOWN
}
/// Whether a window of `size` covers `screen` altogether, as one in full screen does.
fn covers(size: [f32; 2], screen: [f32; 2]) -> bool {
size[0] >= screen[0] - SAME_WITHIN && size[1] >= screen[1] - SAME_WITHIN
}
impl WindowPlace {
/// What the settings hold (which a person or another version may have written), as
/// something a window can be: a size within bounds. `None` when the size is no size at all.
pub fn checked(self) -> Option<WindowPlace> {
size_is_one(self.size).then(|| WindowPlace { size: at_least_min(self.size), zoomed: self.zoomed })
}
/// Reads the window from the settings without letting it cost the rest of them: anything that
/// is not a window as this version writes it (another shape, a hand edit) reads as nothing
/// remembered, where a strict reading would have the whole file taken for damaged.
pub fn lenient<'de, D: serde::Deserializer<'de>>(d: D) -> Result<Option<WindowPlace>, D::Error> {
let value = serde_json::Value::deserialize(d)?;
Ok(serde_json::from_value::<Option<WindowPlace>>(value).ok().flatten().and_then(WindowPlace::checked))
}
}
/// What the window reports in one frame, in the system's points.
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct Seen {
/// The size of what it shows.
pub size: Option<[f32; 2]>,
/// The size of the screen it is on.
pub screen: Option<[f32; 2]>,
/// What the window system last said of its being zoomed / maximized.
pub zoomed: bool,
pub full_screen: bool,
pub minimized: bool,
}
impl Seen {
/// From what egui holds of the window: its `info`, the rectangle it draws in (`content`: the
/// one size every platform reports, Wayland too) and the interface's own scale (`zoom`), by
/// which egui's points differ from the system's.
pub fn of(info: &egui::ViewportInfo, content: egui::Rect, zoom: f32) -> Seen {
let zoom = if zoom.is_finite() && zoom > 0.0 { zoom } else { 1.0 };
let scaled = |v: egui::Vec2| [v.x * zoom, v.y * zoom];
Seen {
size: Some(scaled(content.size())).filter(|s| size_is_one(*s)),
screen: info.monitor_size.map(scaled).filter(|s| size_is_one(*s)),
zoomed: info.maximized == Some(true),
full_screen: info.fullscreen == Some(true),
minimized: info.minimized == Some(true),
}
}
}
/// Follows the window from frame to frame and says what to remember of it.
#[derive(Debug)]
pub struct WindowWatch {
/// A size the window has, and since when (seconds), until it has rested there long enough.
resting: Option<(WindowPlace, f64)>,
/// Whether the window system's word on being zoomed is kept up to date. On macOS it is only
/// what was true when the window opened or the app last zoomed it itself (the top bar
/// double-clicked): Window ▸ Zoom and a drag of the window's edge go unseen.
told_live: bool,
/// What the watch goes by where that word is not live.
unsaid: Unsaid,
/// The window was full screen when it was last seen.
full_screen: bool,
/// Until when (seconds) a window that has left full screen is not looked at.
back_from_full_screen: Option<f64>,
}
/// Where the window system's word on being zoomed is not live: what the window is taken for.
/// It is zoomed on the system's word, or when it was seen to come to fill its screen, and for as
/// long as it then keeps the size it has zoomed. Anything else is a window: taking a window for
/// zoomed would open it larger than it was left, where taking a zoomed one for a window opens
/// it as large as it was.
#[derive(Debug, Default)]
struct Unsaid {
/// The system's word at the last frame. When it changes, the app has zoomed or un-zoomed the
/// window itself, and what it is taken for starts over from that.
said: bool,
taken: Taken,
}
#[derive(Clone, Copy, Debug, Default)]
enum Taken {
/// Not seen yet (or let go of): the system's word says what it is.
#[default]
Unseen,
/// A window, of this size when it was last seen.
Window { size: [f32; 2] },
/// Zoomed: at this size since then (seconds), on this screen; `rested` once it has stayed
/// that size for a moment. Until then it may be on its way there (the system animates a
/// zoom), and `size` is the largest it has been, across and down: on its way it only grows.
Zoomed { size: [f32; 2], since: f64, screen: Option<[f32; 2]>, rested: bool },
}
impl Default for WindowWatch {
fn default() -> Self {
WindowWatch::told_live(!cfg!(target_os = "macos"))
}
}
impl WindowWatch {
/// A watch on a platform where the window system's word on being zoomed is live, or not.
pub fn told_live(told_live: bool) -> WindowWatch {
WindowWatch { resting: None, told_live, unsaid: Unsaid::default(), full_screen: false, back_from_full_screen: None }
}
/// The window is `seen` at time `now` (seconds), and `remembered` is what the settings hold:
/// returns what they should hold from now on. Whether the window is zoomed is taken at
/// once; a size only once the window has rested at it for a moment. A minimized or
/// full-screen window changes nothing, nor does one that has only just left full screen.
pub fn note(&mut self, remembered: Option<WindowPlace>, seen: &Seen, now: f64) -> Option<WindowPlace> {
if seen.full_screen {
self.full_screen = true;
self.back_from_full_screen = None;
self.let_go();
return remembered;
}
if std::mem::take(&mut self.full_screen) {
self.back_from_full_screen = Some(now + AFTER_FULL_SCREEN_SECONDS);
}
if seen.minimized {
self.back_from_full_screen = None;
self.let_go();
return remembered;
}
if self.back_from_full_screen.is_some_and(|until| now < until) {
self.let_go();
return remembered;
}
self.back_from_full_screen = None;
let zoomed = if self.told_live { seen.zoomed } else { self.taken_for_zoomed(seen, now) };
if zoomed {
// (its size now is the screen's, not the window's own: the size it goes back to stays)
self.resting = None;
return Some(WindowPlace { size: remembered.map_or(DEFAULT_SIZE, |r| r.size), zoomed: true });
}
let Some(size) = seen.size else {
self.resting = None;
return remembered;
};
if seen.screen.is_some_and(|screen| covers(size, screen)) {
// (no window of its own size covers its screen: full screen, though nothing says so)
self.resting = None;
return remembered;
}
let place = WindowPlace { size: at_least_min(size), zoomed: false };
if Some(place) == remembered {
self.resting = None;
return remembered;
}
match self.resting {
Some((resting, since)) if resting == place => {
if now - since >= SETTLED_SECONDS {
self.resting = None;
return Some(place);
}
}
_ => self.resting = Some((place, now)),
}
// (meanwhile only what is certain: the window is not zoomed)
remembered.map(|r| WindowPlace { zoomed: false, ..r })
}
/// Lets go of whatever has not rested yet: nothing waits (and wakes the app) while the
/// window is not one to look at. A window taken for zoomed stays that, at the size it was
/// last seen at.
fn let_go(&mut self) {
self.resting = None;
if let Taken::Zoomed { rested, .. } = &mut self.unsaid.taken {
*rested = true;
}
}
/// Whether the window is zoomed, where the window system does not keep saying (`Unsaid`).
fn taken_for_zoomed(&mut self, seen: &Seen, now: f64) -> bool {
let Some(size) = seen.size else {
// (nothing to go by in this frame: as it was taken, or by the system's word if it
// was never seen)
self.let_go();
return match self.unsaid.taken {
Taken::Unseen => seen.zoomed,
taken => matches!(taken, Taken::Zoomed { .. }),
};
};
let zoomed_now = Taken::Zoomed { size, since: now, screen: seen.screen, rested: false };
let fills_its_screen = |size: [f32; 2]| seen.screen.is_some_and(|screen| fills(size, screen));
self.unsaid.taken = if matches!(self.unsaid.taken, Taken::Unseen) || seen.zoomed != self.unsaid.said {
if seen.zoomed { zoomed_now } else { Taken::Window { size } }
} else {
match self.unsaid.taken {
// it comes to fill its screen: zoomed from the Window menu
Taken::Window { size: was } if fills_its_screen(size) && !fills_its_screen(was) => zoomed_now,
Taken::Window { .. } | Taken::Unseen => Taken::Window { size },
Taken::Zoomed { size: at, since, screen, rested } => {
// (at one size for a moment: rested, whether or not a frame came to see it)
let rested = rested || now - since >= SETTLED_SECONDS;
let other_screen = seen.screen.is_some() && screen != seen.screen;
if same(at, size) && (!other_screen || fills_its_screen(size)) {
// as it was (not carried, as large as it is, to a screen it does not fill)
Taken::Zoomed { size: at, since, screen, rested }
} else if !rested && !other_screen && size[0] >= at[0] - SAME_WITHIN && size[1] >= at[1] - SAME_WITHIN {
// on its way there: larger than it has been, and never smaller again
Taken::Zoomed { size: [size[0].max(at[0]), size[1].max(at[1])], since: now, screen, rested: false }
} else if rested && other_screen && fills_its_screen(size) {
// its screen changed (a display unplugged, another resolution) and it fills the new one
zoomed_now
} else {
// resized by its edge, or zoomed back from the Window menu
Taken::Window { size }
}
}
}
};
self.unsaid.said = seen.zoomed;
matches!(self.unsaid.taken, Taken::Zoomed { .. })
}
/// How long until a size the window has will have rested long enough, if one is waiting: the
/// app then looks again (nothing else may ask for a frame once the window is let go of).
pub fn waits(&self, now: f64) -> Option<std::time::Duration> {
let (since, wait) = match (self.back_from_full_screen, self.resting, self.unsaid.taken) {
(Some(until), _, _) => (until - AFTER_FULL_SCREEN_SECONDS, AFTER_FULL_SCREEN_SECONDS),
(None, Some((_, since)), _) | (None, None, Taken::Zoomed { since, rested: false, .. }) => (since, SETTLED_SECONDS),
_ => return None,
};
let left = (wait - (now - since)).clamp(0.0, wait) + LOOK_AGAIN_MARGIN_SECONDS;
Some(std::time::Duration::try_from_secs_f64(left).unwrap_or(std::time::Duration::from_secs(1)))
}
/// The app quits at time `now`: what the settings should hold. A size the window has rested
/// at, if only briefly, is remembered; one it is passing through is not.
pub fn at_exit(&mut self, remembered: Option<WindowPlace>, now: f64) -> Option<WindowPlace> {
match self.resting.take() {
Some((place, since)) if now - since >= SETTLED_AT_EXIT_SECONDS => Some(place),
_ => remembered,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
const SCREEN: [f32; 2] = [2560.0, 1440.0];
fn window(size: [f32; 2]) -> Seen {
Seen { size: Some(size), screen: Some(SCREEN), ..Default::default() }
}
fn place(size: [f32; 2], zoomed: bool) -> WindowPlace {
WindowPlace { size, zoomed }
}
/// Given a window that is resized and comes to rest, when it is watched, then its new size
/// is remembered once it has rested for a moment, and none of the sizes it passed through.
#[test]
fn a_window_is_remembered_at_the_size_it_comes_to_rest_at() {
for live in [true, false] {
let mut watch = WindowWatch::told_live(live);
let mut remembered = None;
for (i, width) in [1000.0, 1100.0, 1200.0, 1300.0].into_iter().enumerate() {
remembered = watch.note(remembered, &window([width, 800.0]), i as f64 * 0.1);
assert_eq!(remembered, None, "passing through {width}");
assert!(watch.waits(i as f64 * 0.1).is_some(), "and the app looks again");
}
remembered = watch.note(remembered, &window([1300.0, 800.0]), 0.5);
assert_eq!(remembered, None, "not yet at rest");
// (it has been this size since 0.3: the app looks again just after 0.8)
let wait = watch.waits(0.5).map(|w| w.as_secs_f64()).unwrap();
assert!((wait - 0.35).abs() < 1e-6, "{wait}");
remembered = watch.note(remembered, &window([1300.0, 800.0]), 0.9);
assert_eq!(remembered, Some(place([1300.0, 800.0], false)));
assert!(watch.waits(0.9).is_none());
// as it is: nothing to wait for
assert_eq!(watch.note(remembered, &window([1300.0, 800.0]), 5.0), remembered);
assert!(watch.waits(5.0).is_none());
}
}
/// Given a window at rest that is zoomed (the top bar double-clicked), when it is watched
/// where the window system says so, then it is remembered as zoomed at once, with the size
/// it had before, though it grew through other sizes on the way; un-zoomed, it is no longer
/// zoomed at once and keeps that size.
#[test]
fn a_zoomed_window_keeps_the_size_it_goes_back_to() {
let mut watch = WindowWatch::told_live(true);
let rest = place([1300.0, 800.0], false);
let mut remembered = Some(rest);
for (i, width) in [1600.0, 2000.0, 2400.0].into_iter().enumerate() {
remembered = watch.note(remembered, &window([width, 1300.0]), 10.0 + i as f64 * 0.05);
assert_eq!(remembered, Some(rest));
}
let zoomed = Seen { zoomed: true, ..window([2560.0, 1412.0]) };
remembered = watch.note(remembered, &zoomed, 10.2);
assert_eq!(remembered, Some(place([1300.0, 800.0], true)));
assert_eq!(watch.note(remembered, &zoomed, 30.0), Some(place([1300.0, 800.0], true)), "however long it stays zoomed");
assert!(watch.waits(30.0).is_none());
remembered = watch.note(remembered, &window([2000.0, 1100.0]), 31.0);
assert_eq!(remembered, Some(rest), "no longer zoomed, and the size it had");
assert_eq!(watch.note(remembered, &window([1300.0, 800.0]), 31.2), Some(rest));
// zoomed before anything was remembered: it opens zoomed, and goes back to the usual size
assert_eq!(WindowWatch::told_live(true).note(None, &zoomed, 0.0), Some(place(DEFAULT_SIZE, true)));
// the system's word is the answer there: a window as large as its screen is a window
assert_eq!(WindowWatch::told_live(true).note(Some(rest), &window([2560.0, 1335.0]), 0.0).map(|p| p.zoomed), Some(false));
}
/// Given macOS, where the window system says whether the window is zoomed only as it opens
/// and when the app zooms it itself: when a window that opened zoomed is resized by its edge,
/// then it is a window again, remembered at the size it was given, though the system's word
/// still says zoomed; zoomed once more, it is zoomed.
#[test]
fn a_zoomed_window_resized_by_its_edge_is_a_window_again_where_the_system_does_not_say() {
let mut watch = WindowWatch::told_live(false);
let rest = place([1300.0, 800.0], true);
let zoomed = Seen { zoomed: true, ..window([2560.0, 1335.0]) };
let mut remembered = watch.note(Some(rest), &zoomed, 0.0);
assert_eq!(remembered, Some(rest));
assert!(watch.waits(0.0).is_some(), "the size it is zoomed at is still to be seen at rest");
remembered = watch.note(remembered, &zoomed, 0.6);
assert_eq!(remembered, Some(rest));
assert!(watch.waits(0.6).is_none());
assert_eq!(watch.note(remembered, &zoomed, 60.0), Some(rest), "however long it stays zoomed");
// (a size goes through the screen's pixels and back: a point off is the same size)
assert_eq!(watch.note(remembered, &Seen { zoomed: true, ..window([2559.0, 1336.0]) }, 60.5), Some(rest));
// its right edge dragged in a little, far less than a Dock is wide; the word is unchanged
let dragged = Seen { zoomed: true, ..window([2500.0, 1335.0]) };
remembered = watch.note(remembered, &dragged, 61.0);
assert_eq!(remembered, Some(place([1300.0, 800.0], false)), "not zoomed any more");
remembered = watch.note(remembered, &dragged, 61.6);
assert_eq!(remembered, Some(place([2500.0, 1335.0], false)), "and at the size it was given");
assert!(watch.waits(61.6).is_none());
// zoomed again from the Window menu: back at the size it is zoomed at
assert_eq!(watch.note(remembered, &zoomed, 70.0), Some(place([2500.0, 1335.0], true)));
}
/// Given macOS, when the app zooms the window itself (the top bar double-clicked), then the
/// system says so at once and the window is zoomed through all the sizes it grows through,
/// with the size it had, wherever the Dock is; un-zoomed the same way, it is a window again
/// at that size.
#[test]
fn a_window_the_app_zooms_is_zoomed_at_once_where_the_system_does_not_say() {
let mut watch = WindowWatch::told_live(false);
let rest = place([1300.0, 800.0], false);
let mut remembered = watch.note(Some(rest), &window([1300.0, 800.0]), 0.0);
// (a Dock at the left: zoomed, the window is narrower than its screen)
for (i, width) in [1300.0, 1700.0, 2100.0, 2410.0].into_iter().enumerate() {
remembered = watch.note(remembered, &Seen { zoomed: true, ..window([width, 1415.0]) }, 1.0 + i as f64 * 0.05);
assert_eq!(remembered, Some(place([1300.0, 800.0], true)), "growing through {width}");
}
remembered = watch.note(remembered, &Seen { zoomed: true, ..window([2410.0, 1415.0]) }, 2.0);
assert_eq!(remembered, Some(place([1300.0, 800.0], true)));
assert!(watch.waits(2.0).is_none());
for (i, width) in [2100.0, 1700.0, 1300.0].into_iter().enumerate() {
remembered = watch.note(remembered, &window([width, 800.0]), 3.0 + i as f64 * 0.05);
assert_eq!(remembered, Some(rest), "shrinking through {width}");
}
assert!(watch.waits(3.1).is_none(), "back at the size it had: nothing to wait for");
}
/// Given macOS and a window zoomed from the Window menu (the system's word stays "not
/// zoomed"), when it is seen to come to fill its screen from side to side, then it is zoomed,
/// with the size it had, and zoomed back it is a window at that size again. A window that
/// only grows large is not zoomed, on any screen.
#[test]
fn a_window_that_comes_to_fill_its_screen_is_zoomed_where_the_system_does_not_say() {
let rest = place([1300.0, 800.0], false);
// a window of 1300 × 800 on `screen` that is next seen at `size`
let zoomed_on = |screen: [f32; 2], size: [f32; 2]| {
let mut watch = WindowWatch::told_live(false);
let seen = |size: [f32; 2]| Seen { size: Some(size), screen: Some(screen), ..Default::default() };
watch.note(Some(rest), &seen([1300.0, 800.0]), 0.0);
watch.note(Some(rest), &seen(size), 0.2).map(|p| p.zoomed)
};
// under the menu bar, with the Dock hidden, small, or as large as it gets
for (screen, size) in [
([2560.0, 1440.0], [2560.0, 1415.0]),
([2560.0, 1440.0], [2560.0, 1335.0]),
([2560.0, 1440.0], [2559.0, 1335.0]),
([1728.0, 1117.0], [1728.0, 1084.0]),
([1512.0, 982.0], [1512.0, 794.0]),
] {
assert_eq!(zoomed_on(screen, size), Some(true), "{size:?} on {screen:?}");
}
// the usual size on a laptop's screen, windows sized by hand to nearly the screen, one
// that is a little narrower than it, and one as wide as it and far from as tall
for (screen, size) in [
([1728.0, 1117.0], DEFAULT_SIZE),
([1710.0, 1107.0], DEFAULT_SIZE),
([1512.0, 982.0], [1400.0, 820.0]),
([1470.0, 956.0], [1340.0, 780.0]),
([2560.0, 1440.0], [2430.0, 1270.0]),
([2560.0, 1440.0], [2300.0, 1200.0]),
([2560.0, 1440.0], [2550.0, 1415.0]),
([2560.0, 1440.0], [2560.0, 1190.0]),
] {
assert_eq!(zoomed_on(screen, size), Some(false), "{size:?} on {screen:?}");
}
let mut watch = WindowWatch::told_live(false);
let filling = window([2560.0, 1335.0]);
let mut remembered = watch.note(Some(rest), &window([1300.0, 800.0]), 0.0);
remembered = watch.note(remembered, &window([2000.0, 1100.0]), 0.9);
remembered = watch.note(remembered, &filling, 1.0);
assert_eq!(remembered, Some(place([1300.0, 800.0], true)));
assert_eq!(watch.note(remembered, &filling, 9.0), remembered, "and its own size is not written over");
remembered = watch.note(remembered, &window([1900.0, 1000.0]), 10.0);
assert_eq!(remembered, Some(rest), "zoomed back: a window, at the size it had");
assert_eq!(watch.note(remembered, &window([1300.0, 800.0]), 10.2), Some(rest));
assert!(watch.waits(10.2).is_none());
// not told apart: zoomed from the Window menu beside a Dock at the side, it is remembered
// as a window of that size
let mut watch = WindowWatch::told_live(false);
let beside_a_dock = window([2410.0, 1415.0]);
watch.note(Some(rest), &window([1300.0, 800.0]), 0.0);
watch.note(Some(rest), &beside_a_dock, 0.3);
assert_eq!(watch.note(Some(rest), &beside_a_dock, 0.9), Some(place([2410.0, 1415.0], false)));
// without a screen's size to go by, the system's word is all there is
let no_screen = Seen { size: Some([2560.0, 1335.0]), screen: None, zoomed: true, ..Default::default() };
assert_eq!(WindowWatch::told_live(false).note(Some(rest), &no_screen, 0.0), Some(place([1300.0, 800.0], true)));
}
/// Given macOS and a window that was left as wide as its screen and a little shorter (its
/// lower edge dragged up after a zoom), when the app opens it at that size, then it is a
/// window of that size, launch after launch: filling the screen is no sign of a zoom unless
/// the window was seen to come to it. Dragged shorter still, it is remembered at that.
#[test]
fn a_window_that_opens_as_wide_as_its_screen_is_a_window_where_the_system_does_not_say() {
for (screen, size) in [([1728.0, 1117.0], [1728.0, 1054.0]), ([1512.0, 982.0], [1512.0, 760.0]), ([3440.0, 1440.0], [3440.0, 1200.0])] {
let left = place(size, false);
let seen = |size: [f32; 2]| Seen { size: Some(size), screen: Some(screen), ..Default::default() };
let mut watch = WindowWatch::told_live(false);
for frame in 0..5 {
assert_eq!(watch.note(Some(left), &seen(size), f64::from(frame) * 0.3), Some(left), "{size:?} on {screen:?}");
}
let shorter = [size[0], size[1] - 20.0];
watch.note(Some(left), &seen(shorter), 2.0);
assert_eq!(watch.note(Some(left), &seen(shorter), 2.6), Some(place(shorter, false)));
}
// the same after a double-click on the top bar that changed nothing (the system's word was
// stale, and is now "not zoomed"): still the window it is
let mut watch = WindowWatch::told_live(false);
let screen = [1728.0, 1117.0];
let left = place([1728.0, 1054.0], false);
watch.note(Some(left), &Seen { size: Some(left.size), screen: Some(screen), zoomed: true, ..Default::default() }, 0.0);
watch.note(Some(left), &Seen { size: Some(left.size), screen: Some(screen), zoomed: true, ..Default::default() }, 1.0);
// (taken for zoomed on the system's word, until that word is taken back)
let unsaid = Seen { size: Some(left.size), screen: Some(screen), zoomed: false, ..Default::default() };
assert_eq!(watch.note(Some(left), &unsaid, 2.0), Some(left));
assert_eq!(watch.note(Some(left), &unsaid, 9.0), Some(left));
}
/// Given macOS and a zoomed window, when it is zoomed back from the Window menu (or resized by
/// its edge) before it was ever seen at rest, then it is a window at once, and the size it
/// comes to rest at is the window's, not taken for the size it is zoomed at.
#[test]
fn a_window_zoomed_back_at_once_is_a_window_where_the_system_does_not_say() {
let mut watch = WindowWatch::told_live(false);
let rest = place([1240.0, 820.0], true);
let mut remembered = watch.note(Some(rest), &Seen { zoomed: true, ..window([2560.0, 1415.0]) }, 0.0);
assert_eq!(remembered, Some(rest));
for (i, width) in [2200.0, 1700.0, 1240.0, 1240.0, 1240.0].into_iter().enumerate() {
remembered = watch.note(remembered, &Seen { zoomed: true, ..window([width, 820.0]) }, 0.3 + i as f64 * 0.05);
assert_eq!(remembered, Some(place([1240.0, 820.0], false)), "{width}");
}
assert_eq!(watch.note(remembered, &Seen { zoomed: true, ..window([1240.0, 820.0]) }, 60.0), Some(place([1240.0, 820.0], false)));
assert!(watch.waits(60.0).is_none());
}
/// Given macOS and a zoomed window, when its screen changes (the display unplugged, another
/// resolution) and it is fitted to the new one, then it is still zoomed and keeps the size
/// it goes back to. Moved to a larger screen that it does not fill, it is a window.
#[test]
fn a_zoomed_window_is_still_zoomed_on_another_screen_where_the_system_does_not_say() {
for said in [true, false] {
let rest = place([1240.0, 820.0], false);
let on = |screen: [f32; 2], size: [f32; 2]| Seen { size: Some(size), screen: Some(screen), zoomed: said, ..Default::default() };
let mut watch = WindowWatch::told_live(false);
let mut remembered = watch.note(Some(rest), &on([2560.0, 1440.0], [1240.0, 820.0]), 0.0);
if said {
// (the system's word as the window opened: a window; the app zooms it later)
remembered = watch.note(remembered, &Seen { zoomed: false, ..on([2560.0, 1440.0], [1240.0, 820.0]) }, 0.0);
}
for now in [1.0, 2.0] {
remembered = watch.note(remembered, &on([2560.0, 1440.0], [2560.0, 1415.0]), now);
}
assert_eq!(remembered, Some(place([1240.0, 820.0], true)), "said: {said}");
for now in [10.0, 10.6, 60.0] {
remembered = watch.note(remembered, &on([1728.0, 1117.0], [1728.0, 1084.0]), now);
assert_eq!(remembered, Some(place([1240.0, 820.0], true)), "on the smaller screen at {now}, said: {said}");
}
assert!(watch.waits(60.0).is_none());
// dragged over to a screen it does not fill
remembered = watch.note(remembered, &on([3440.0, 1440.0], [1728.0, 1084.0]), 70.0);
assert_eq!(remembered.map(|p| p.zoomed), Some(false), "said: {said}");
}
// seen zoomed in one frame only, and fitted to another screen long after: it had rested
let mut watch = WindowWatch::told_live(false);
let rest = place([1240.0, 820.0], true);
watch.note(Some(rest), &Seen { zoomed: true, ..window([2560.0, 1415.0]) }, 0.0);
let fitted = Seen { size: Some([1728.0, 1084.0]), screen: Some([1728.0, 1117.0]), zoomed: true, ..Default::default() };
assert_eq!(watch.note(Some(rest), &fitted, 5.0), Some(rest));
}
/// Given a size the window has not rested at yet, when the window goes full screen or is
/// minimized, or reports no size, then nothing waits (the app is not woken again and again
/// for as long as that lasts), and back as a window its size is seen afresh.
#[test]
fn nothing_waits_while_the_window_is_full_screen_or_minimized() {
let rest = place([1300.0, 800.0], false);
for live in [true, false] {
for away in [
Seen { full_screen: true, ..window(SCREEN) },
Seen { minimized: true, ..window([160.0, 28.0]) },
Seen { size: None, ..window(SCREEN) },
] {
let mut watch = WindowWatch::told_live(live);
watch.note(Some(rest), &window([1500.0, 900.0]), 1.0);
assert!(watch.waits(1.0).is_some());
assert_eq!(watch.note(Some(rest), &away, 1.1), Some(rest));
assert!(watch.waits(1.1).is_none(), "{away:?}");
assert_eq!(watch.note(Some(rest), &away, 900.0), Some(rest));
assert!(watch.waits(900.0).is_none(), "{away:?}");
assert_eq!(watch.note(Some(rest), &window([1500.0, 900.0]), 901.0), Some(rest));
let mut remembered = Some(rest);
for now in [902.2, 902.8] {
remembered = watch.note(remembered, &window([1500.0, 900.0]), now);
}
assert_eq!(remembered, Some(place([1500.0, 900.0], false)), "{away:?}");
assert!(watch.waits(902.8).is_none());
}
}
// (macOS: the same of a zoomed window's size that was still to be seen at rest)
for away in [Seen { full_screen: true, zoomed: true, ..window(SCREEN) }, Seen { size: None, zoomed: true, ..window(SCREEN) }] {
let mut watch = WindowWatch::told_live(false);
watch.note(Some(rest), &Seen { zoomed: true, ..window([2560.0, 1335.0]) }, 0.0);
assert!(watch.waits(0.0).is_some());
watch.note(Some(rest), &away, 0.1);
assert!(watch.waits(0.1).is_none(), "{away:?}");
}
}
/// Given a zoomed window that was full screen, when it leaves full screen, then for a moment
/// it is not looked at (the system animates the way back, at sizes that are neither the
/// window's nor the zoomed one), the app looks again once that is over, and the window is
/// zoomed with the size it goes back to, as before.
#[test]
fn a_window_that_has_just_left_full_screen_is_not_looked_at() {
for live in [true, false] {
let mut watch = WindowWatch::told_live(live);
let rest = place([1240.0, 820.0], true);
let zoomed = Seen { zoomed: true, ..window([2560.0, 1415.0]) };
for now in [0.0, 1.0] {
assert_eq!(watch.note(Some(rest), &zoomed, now), Some(rest));
}
assert_eq!(watch.note(Some(rest), &Seen { full_screen: true, zoomed: true, ..window(SCREEN) }, 5.0), Some(rest));
// on the way back the system no longer says "full screen", nor "zoomed" where its word is live
for now in [9.0, 9.3, 9.6, 9.9] {
assert_eq!(watch.note(Some(rest), &Seen { zoomed: !live, ..window(SCREEN) }, now), Some(rest), "at {now}");
let wait = watch.waits(now).map(|w| w.as_secs_f64()).unwrap();
assert!((wait - (10.05 - now)).abs() < 1e-6, "at {now}: looks again after the moment, {wait}");
}
assert_eq!(watch.note(Some(rest), &zoomed, 10.1), Some(rest));
assert_eq!(watch.note(Some(rest), &zoomed, 11.0), Some(rest));
assert!(watch.waits(11.0).is_none());
}
}
/// Given macOS and a window dragged by its corner, when it reaches the screen's width and is
/// then dragged on, taller and little by little narrower again, and left narrower than the
/// screen, then it is a window at the size it was left at: a zoom only grows on its way, so
/// what gets narrower again is somebody's hand.
#[test]
fn a_window_dragged_wide_and_narrower_again_is_a_window_where_the_system_does_not_say() {
for per_frame in [1.0, 1.4] {
let screen = [1728.0, 1117.0];
let seen = |size: [f32; 2]| Seen { size: Some(size), screen: Some(screen), ..Default::default() };
let rest = place([1600.0, 950.0], false);
let mut watch = WindowWatch::told_live(false);
let mut remembered = watch.note(Some(rest), &seen(rest.size), 0.0);
let mut size = [1728.0, 950.0];
let mut now = 1.0;
for _ in 0..40 {
remembered = watch.note(remembered, &seen(size), now);
size = [size[0] - per_frame, size[1] + 3.0];
now += 1.0 / 60.0;
}
for _ in 0..3 {
remembered = watch.note(remembered, &seen(size), now);
now += 0.3;
}
assert_eq!(remembered, Some(place(size, false)), "{per_frame} pt narrower a frame");
}
// a zoomed window whose edge is dragged in slowly: a window once it is no longer the size it was zoomed at
let mut watch = WindowWatch::told_live(false);
let rest = place([1300.0, 800.0], true);
for now in [0.0, 1.0] {
watch.note(Some(rest), &Seen { zoomed: true, ..window([2560.0, 1335.0]) }, now);
}
let mut remembered = Some(rest);
for frame in 1..=10 {
remembered = watch.note(remembered, &Seen { zoomed: true, ..window([2560.0 - frame as f32, 1335.0]) }, 2.0 + f64::from(frame) / 60.0);
}
assert_eq!(remembered.map(|p| p.zoomed), Some(false), "ten points narrower, a point at a time");
// and one whose lower edge is dragged up a little: it still fills its screen, and is a window
let mut watch = WindowWatch::told_live(false);
for now in [0.0, 1.0] {
watch.note(Some(rest), &Seen { zoomed: true, ..window([2560.0, 1415.0]) }, now);
}
let shorter = Seen { zoomed: true, ..window([2560.0, 1385.0]) };
watch.note(Some(rest), &shorter, 2.0);
assert_eq!(watch.note(Some(rest), &shorter, 2.6), Some(place([2560.0, 1385.0], false)));
}
/// Given macOS and a window that opened zoomed, when its edge is dragged in before it was
/// seen at rest (one side only gets smaller), or it is carried to a larger screen in that
/// moment, then it is a window; and a frame without the screen's size costs a zoomed window
/// nothing.
#[test]
fn a_zoomed_window_changed_before_it_rested_is_a_window_where_the_system_does_not_say() {
let rest = place([1240.0, 820.0], true);
let zoomed = Seen { zoomed: true, ..window([2560.0, 1415.0]) };
for at in [0.1, 0.3] {
let mut watch = WindowWatch::told_live(false);
watch.note(Some(rest), &zoomed, 0.0);
let dragged = Seen { zoomed: true, ..window([2000.0, 1415.0]) };
assert_eq!(watch.note(Some(rest), &dragged, at), Some(place([1240.0, 820.0], false)), "dragged at {at}");
assert_eq!(watch.note(Some(rest), &dragged, at + 0.6), Some(place([2000.0, 1415.0], false)));
}
// carried to a larger screen, as large as it is, a moment after it opened: no frame came in between
for at in [0.2, 0.52, 0.9] {
let mut watch = WindowWatch::told_live(false);
watch.note(Some(rest), &zoomed, 0.0);
let carried = Seen { size: Some([2560.0, 1415.0]), screen: Some([5120.0, 2880.0]), zoomed: true, ..Default::default() };
assert_eq!(watch.note(Some(rest), &carried, at).map(|p| p.zoomed), Some(false), "carried at {at}");
}
// the screen's size missing for a frame
let mut watch = WindowWatch::told_live(false);
for now in [0.0, 1.0] {
watch.note(Some(rest), &zoomed, now);
}
assert_eq!(watch.note(Some(rest), &Seen { screen: None, ..zoomed }, 2.0), Some(rest));
assert_eq!(watch.note(Some(rest), &zoomed, 2.1), Some(rest));
}
/// Given macOS and a window that opened zoomed and was then resized by hand (the system's
/// word still says zoomed), when it goes full screen and back, or reports no size for a
/// frame, then it is still the window it was: what was made out of it is not let go of for
/// the system's old word.
#[test]
fn a_window_made_out_is_not_taken_for_zoomed_again_on_the_systems_old_word() {
for away in [Seen { full_screen: true, zoomed: true, ..window(SCREEN) }, Seen { size: None, zoomed: true, ..window(SCREEN) }] {
let mut watch = WindowWatch::told_live(false);
let rest = place([1240.0, 820.0], true);
for now in [0.0, 1.0] {
watch.note(Some(rest), &Seen { zoomed: true, ..window([2560.0, 1415.0]) }, now);
}
let dragged = Seen { zoomed: true, ..window([1500.0, 900.0]) };
let mut remembered = watch.note(Some(rest), &dragged, 2.0);
remembered = watch.note(remembered, &dragged, 2.6);
assert_eq!(remembered, Some(place([1500.0, 900.0], false)));
remembered = watch.note(remembered, &away, 5.0);
for now in [8.0, 8.6, 9.2, 30.0] {
remembered = watch.note(remembered, &dragged, now);
assert_eq!(remembered, Some(place([1500.0, 900.0], false)), "{away:?} at {now}");
}
}
}
/// Given a platform where the system says whether the window is maximized, when a window
/// grows until it fills its screen, then it is a window all the same: only the system's
/// word counts there. And the watch the app makes goes by that word everywhere but on macOS.
#[test]
fn where_the_system_says_only_its_word_counts() {
let rest = place([1300.0, 800.0], false);
let mut watch = WindowWatch::told_live(true);
let mut remembered = Some(rest);
for (i, size) in [[1300.0, 800.0], [2000.0, 1100.0], [2560.0, 1335.0], [2560.0, 1335.0], [2560.0, 1335.0]].into_iter().enumerate() {
remembered = watch.note(remembered, &window(size), i as f64 * 0.4);
assert_eq!(remembered.map(|p| p.zoomed), Some(false));
}
assert_eq!(remembered, Some(place([2560.0, 1335.0], false)));
// the app's own watch: opened zoomed and then seen at a hand size, the system's word unchanged
let mut watch = WindowWatch::default();
for now in [0.0, 1.0] {
watch.note(Some(rest), &Seen { zoomed: true, ..window([2560.0, 1335.0]) }, now);
}
let zoomed = watch.note(Some(rest), &Seen { zoomed: true, ..window([1500.0, 900.0]) }, 2.0).map(|p| p.zoomed);
assert_eq!(zoomed, Some(!cfg!(target_os = "macos")), "macOS goes by the size, the others by the word");
}
/// Given a window that left full screen a moment ago, when it is minimized or goes full
/// screen again, then nothing waits; and a window that covers its screen altogether (full
/// screen, though nothing says so) is not remembered as a size, however long it stays.
#[test]
fn nothing_waits_when_a_window_just_back_from_full_screen_goes_away_again() {
let rest = place([1300.0, 800.0], false);
for live in [true, false] {
for away in [Seen { minimized: true, ..window([160.0, 28.0]) }, Seen { full_screen: true, ..window(SCREEN) }] {
let mut watch = WindowWatch::told_live(live);
watch.note(Some(rest), &Seen { full_screen: true, ..window(SCREEN) }, 1.0);
watch.note(Some(rest), &window([1300.0, 800.0]), 2.0);
assert!(watch.waits(2.0).is_some(), "the moment after full screen");
for now in [2.1, 2.7, 60.0] {
assert_eq!(watch.note(Some(rest), &away, now), Some(rest));
assert!(watch.waits(now).is_none(), "{away:?} at {now}");
}
}
let mut watch = WindowWatch::told_live(live);
watch.note(Some(rest), &window([1300.0, 800.0]), 0.0);
for now in [1.0, 1.6, 2.2, 60.0] {
// (where the system does not say, a window that comes to cover its screen is zoomed)
assert_eq!(watch.note(Some(rest), &window(SCREEN), now).map(|p| p.size), Some(rest.size), "covering its screen at {now}");
}
assert!(watch.waits(60.0).is_none());
}
}
/// Given a window smaller than the app's smallest (a window manager that does not keep to
/// it, a script), when it rests, then the smallest size is remembered, once: what is
/// remembered and what is seen agree from then on, and nothing waits.
#[test]
fn a_window_smaller_than_the_smallest_is_remembered_once() {
for live in [true, false] {
let mut watch = WindowWatch::told_live(live);
let small = window([640.0, 700.0]);
let mut remembered = watch.note(Some(place([1300.0, 800.0], false)), &small, 0.0);
remembered = watch.note(remembered.and_then(WindowPlace::checked), &small, 0.6);
assert_eq!(remembered, Some(place([MIN_SIZE[0], 700.0], false)));
for frame in 0..20 {
let now = 1.0 + f64::from(frame) * 0.1;
assert_eq!(watch.note(remembered.and_then(WindowPlace::checked), &small, now), remembered);
assert!(watch.waits(now).is_none(), "frame {frame}");
}
}
}
/// Full screen and a minimized window are not sizes to open at: nothing is remembered of
/// them. Nor of a window that reports no size.
#[test]
fn full_screen_and_minimized_windows_are_not_remembered() {
let rest = place([1300.0, 800.0], false);
for seen in [
Seen { full_screen: true, ..window(SCREEN) },
Seen { full_screen: true, zoomed: true, ..window(SCREEN) },
Seen { minimized: true, ..window([160.0, 28.0]) },
Seen { size: None, ..window([0.0, 0.0]) },
] {
for live in [true, false] {
let mut watch = WindowWatch::told_live(live);
assert_eq!(watch.note(Some(rest), &seen, 0.0), Some(rest), "{seen:?}");
assert_eq!(watch.note(Some(rest), &seen, 5.0), Some(rest), "{seen:?}");
assert_eq!(watch.at_exit(Some(rest), 6.0), Some(rest));
}
}
}
/// Given a window that was resized, when the app quits before the size has rested its
/// moment, then the size is remembered if the window had been let go of, and not if it was
/// still changing with every frame (a zoom the system was animating).
#[test]
fn a_size_the_window_rested_at_is_remembered_when_the_app_quits() {
let rest = place([1300.0, 800.0], false);
let mut watch = WindowWatch::told_live(true);
watch.note(Some(rest), &window([1500.0, 900.0]), 1.0);
assert_eq!(watch.at_exit(Some(rest), 1.3), Some(place([1500.0, 900.0], false)));
assert_eq!(watch.at_exit(Some(rest), 9.0), Some(rest), "said once");
let mut watch = WindowWatch::told_live(true);
watch.note(Some(rest), &window([1500.0, 900.0]), 1.00);
watch.note(Some(rest), &window([1700.0, 1000.0]), 1.02);
assert_eq!(watch.at_exit(Some(rest), 1.04), Some(rest), "a size it was passing through");
assert_eq!(WindowWatch::told_live(true).at_exit(None, 3.0), None);
}
/// What egui holds of the window is read in the system's points: a size every platform
/// reports (the rectangle the app draws in), brought back from the interface's own scale.
#[test]
fn the_window_is_seen_in_the_systems_points() {
use egui::{Rect, ViewportInfo, pos2, vec2};
let info = ViewportInfo { monitor_size: Some(vec2(1280.0, 720.0)), maximized: Some(true), fullscreen: Some(false), ..Default::default() };
let content = Rect::from_min_size(pos2(0.0, 0.0), vec2(650.0, 400.0));
// (the interface at twice its size: egui's points are half the system's)
let seen = Seen::of(&info, content, 2.0);
assert_eq!(seen, Seen { size: Some([1300.0, 800.0]), screen: Some([2560.0, 1440.0]), zoomed: true, full_screen: false, minimized: false });
let away = ViewportInfo { maximized: Some(false), fullscreen: Some(true), minimized: Some(true), ..Default::default() };
let seen = Seen::of(&away, content, 1.0);
assert!(!seen.zoomed && seen.full_screen && seen.minimized);
// nothing reported but the content (Wayland): the size is there all the same
assert_eq!(Seen::of(&ViewportInfo::default(), content, 1.0).size, Some([650.0, 400.0]));
// a scale or a size that is none
assert_eq!(Seen::of(&info, content, f32::NAN).size, Some([650.0, 400.0]));
assert_eq!(Seen::of(&info, Rect::NOTHING, 1.0).size, None);
assert_eq!(Seen::of(&info, Rect::from_min_size(pos2(0.0, 0.0), vec2(0.0, 0.0)), 1.0).size, None);
}
/// What the settings hold is not trusted as it is: a size is brought within what a window can
/// be, and anything that is no window reads as nothing remembered, without an error (which
/// would have the whole settings file taken for damaged).
#[test]
fn what_was_remembered_is_checked_and_never_costs_the_other_settings() {
#[derive(Deserialize, Debug, PartialEq)]
struct Settings {
#[serde(default, deserialize_with = "WindowPlace::lenient")]
window: Option<WindowPlace>,
other: u8,
}
let read = |window: &str| serde_json::from_str::<Settings>(&format!(r#"{{"window":{window},"other":7}}"#)).map(|s| s.window);
assert_eq!(read(r#"{"size":[1300.0,800.0],"zoomed":true}"#).unwrap(), Some(place([1300.0, 800.0], true)));
assert_eq!(read(r#"{"size":[1300,800]}"#).unwrap(), Some(place([1300.0, 800.0], false)));
// (a place on the desktop, as a version that remembered one would write it, is passed over)
assert_eq!(read(r#"{"size":[1300,800],"position":[40,60],"zoomed":false}"#).unwrap(), Some(place([1300.0, 800.0], false)));
assert_eq!(read(r#"{"size":[200,100]}"#).unwrap().map(|p| p.size), Some(MIN_SIZE), "too small to be the app's window");
for odd in [
"null",
"{}",
r#""x""#,
"5",
"[]",
"true",
r#"{"size":[1,2,3]}"#,
r#"{"size":[1]}"#,
r#"{"size":"big"}"#,
r#"{"size":[null,800]}"#,
r#"{"size":[1300,800],"zoomed":1}"#,
r#"{"size":[0,0]}"#,
r#"{"size":[-5,800]}"#,
r#"{"size":[1e39,800]}"#,
r#"{"size":[99999,800]}"#,
] {
assert_eq!(read(odd).unwrap(), None, "{odd}");
}
assert_eq!(serde_json::from_str::<Settings>(r#"{"other":7}"#).unwrap(), Settings { window: None, other: 7 }, "settings from before");
// and what is written is read back
let written = serde_json::to_string(&place([1300.5, 800.25], true)).unwrap();
assert_eq!(read(&written).unwrap(), Some(place([1300.5, 800.25], true)));
for size in [[f32::NAN, 800.0], [f32::INFINITY, 800.0], [0.5, 800.0]] {
assert_eq!(place(size, false).checked(), None, "{size:?}");
}
}
}
+2 -1
View File
@@ -51,7 +51,7 @@ cited here still exists. Formerly docs/parity.md.
| U. Map & location (MAP) | 0 | 1 | 1 | 0 | — | 0/1 (0%) |
| V. Preferences (PREF) | 6 | 2 | 2 | 2 | 1/1 (100%) | 4/5 (80%) |
| W. Cloud & AI infrastructure (CLOUD / AI) | 1 | 0 | 1 | 2 | — | — |
| X. Cross-cutting behaviours (BEHAV) | 23 | 6 | 1 | 1 | 8/8 (100%) | 7/10 (70%) |
| X. Cross-cutting behaviours (BEHAV) | 23 | 7 | 1 | 1 | 8/8 (100%) | 7/10 (70%) |
| Y. Menus | 84 | 0 | 4 | 8 | 47/47 (100%) | 23/23 (100%) |
| Z. Keyboard shortcuts (desktop) | 76 | 4 | 3 | 1 | 49/52 (94%) | 23/25 (92%) |
| Lightroom Classic extras | 36 | 22 | 27 | 8 | — | 24/26 (92%) |
@@ -802,6 +802,7 @@ Latin stays upright. Advanced Japanese composition remains open. Regression cove
| 2026-10-14 | minor | LR-MERGE-HDR ✅ → 🟡: tested on real 67 MP Sony brackets; moving clipped highlights (black-hole stars) and dark-sky ghosts fixed, merge memory cut ~25 %; AI Denoise on merged DNGs, JPEG response curves and per-frame memory remain (gap 29). LR-MERGE-HEADLESS, MENU-PHOTO-MERGE: HDR for Each Bracket Set (`merge.hdrBatch`) |
| 2026-10-15 | patch | LR-VIEW-BEFOREAFTER: side by side and stacked panes share click-zoom animation for whole-frame images, window tiles and input; render requests keep the final target (#1821); status unchanged |
| 2026-10-14 | patch | LR-META-XMP: automatic sidecar writes that fail (folder offline or read-only) wait and are written again once the files are reachable, with a notice (`cmd:library.retrySidecars`); status unchanged |
| 2026-10-13 | minor | LR-BEHAV-WINDOW (new, 🟡): the desktop app's window opens at the size it was left at, zoomed / maximized if it was; full screen and the place on the desktop are not remembered |
| 2026-10-13 | patch | LR-VIEW-COMPARE, LRC-LIB-COMPARE: ⌘/Ctrl- and Shift-clicks on the filmstrip in Compare change the selection as in the grid; the two photos shown stay selected and the active photo is unchanged (#187); statuses unchanged |
| 2026-10-13 | minor | KEYC-SELECTONLYACTIVE: Edit → Select Only Active Photo (⌘⇧D) lands as a new row; status 🟡 (headless-tested, native macOS menu path unverified) |
| 2026-10-13 | patch | LRC-LIB-CATALOG-IMPORT: a catalog whose tables are all still in its `-wal` file (main file schema format 0) opens instead of failing as an unsupported schema format; status unchanged |
+14
View File
@@ -130,6 +130,20 @@
- Photos that start matching still appear at once, and deleting a photo or taking it out of the album or folder
shown still takes it out of the view.
### The window opens at the size you left it
- LightCraft's window opens at the size it had when you last used it, and zoomed (macOS) / maximized if it was: it
used to open at 1600 × 1000 every time. Double-click the top bar to zoom the window, quit, and it is zoomed when
you come back; un-zoom it and it goes back to the size it had before.
- Full screen is not remembered (the app opens as a window), and neither is where on the desktop the window was:
the system places it.
- On macOS the system does not tell LightCraft when a window is zoomed from the Window menu or resized after a
zoom, so it goes by the window's size, and when in doubt takes the window for a window of the size it has: it
comes back as large as you left it, but not as a zoomed window. That is so after a zoom from the Window menu
with the Dock at a side of the screen, or of a window already as wide as the screen. Zoomed by a double-click
on the top bar it comes back zoomed. The other way round, a window you drag out until it is as wide as the
screen and nearly as tall counts as zoomed.
- For scripts: a size set with `ui.resize` is remembered like any other, so a script that needs a size sets it.
### HDR merges keep the lens correction
- An HDR made with Photo ▸ Photo Merge ▸ HDR now keeps the lens correction the photos carry (Sony's, Panasonic's
and Leica's, and the one some DNGs carry, e.g. from drones): Optics ▸ Enable Lens Corrections straightens it as it