Skip to content

EffectCraft: An open-source motion graphics and compositing tool written by scratch in pure Rust

Dock: dragging a divider past a panel's minimum no longer crashes the app (#306)

Claudef440adbb5a49
diff --git a/crates/ui-egui/src/dock.rs b/crates/ui-egui/src/dock.rs
index 65bca8803..b586e8c95 100644
--- a/crates/ui-egui/src/dock.rs
+++ b/crates/ui-egui/src/dock.rs
@@ -878,12 +878,7 @@ pub fn layout(ui: &mut egui::Ui, node: &mut DockNode, rect: Rect, t: &Tokens, pa
let g = t.gap;
let total = if *vertical { rect.height() } else { rect.width() };
let avail = (total - g).max(0.0);
- let first = match *size {
- SplitSize::Ratio(r) => avail * r,
- SplitSize::FixedA(px) => px.min(avail - 20.0),
- SplitSize::FixedB(px) => avail - px.min(avail - 20.0),
- }
- .clamp(20.0_f32.min(avail), (avail - 20.0).max(0.0));
+ let first = split_first(*size, avail);
let (ra, gutter_rect, rb) = if *vertical {
(
Rect::from_min_max(rect.min, pos2(rect.max.x, rect.min.y + first)),
@@ -898,7 +893,7 @@ pub fn layout(ui: &mut egui::Ui, node: &mut DockNode, rect: Rect, t: &Tokens, pa
)
};
if let Some(d) = gutter(ui, gutter_rect, *vertical, path, t, reg) {
- let nf = (first + d).clamp(40.0, (avail - 40.0).max(40.0));
+ let nf = clamp_ordered(first + d, 40.0, avail - 40.0);
*size = match *size {
SplitSize::Ratio(_) => SplitSize::Ratio(nf / avail.max(1.0)),
SplitSize::FixedA(_) => SplitSize::FixedA(nf),
@@ -965,6 +960,27 @@ fn stack_bodies(entries: &[StackEntry], avail: f32) -> Vec<f32> {
.collect()
}
+/// `v` held to `lo..=hi`, never panicking: when the room is too small for both minimums
+/// (`hi < lo`), `lo` wins; a non-finite `v` gives `lo`.
+fn clamp_ordered(v: f32, lo: f32, hi: f32) -> f32 {
+ let lo = if lo.is_finite() { lo } else { 0.0 };
+ let hi = if hi.is_finite() { hi.max(lo) } else { lo };
+ if v.is_finite() { v.max(lo).min(hi) } else { lo }
+}
+
+/// The size of a split's first side in `avail` points (both sides keep 20 pt when there is room).
+/// `f32::clamp` panics when its bounds cross, which a split shorter than 40 pt did (#306).
+fn split_first(size: SplitSize, avail: f32) -> f32 {
+ let avail = if avail.is_finite() { avail.max(0.0) } else { 0.0 };
+ let first = match size {
+ SplitSize::Ratio(r) => avail * r,
+ SplitSize::FixedA(px) => px.min(avail - 20.0),
+ SplitSize::FixedB(px) => avail - px.min(avail - 20.0),
+ };
+ let lo = 20.0_f32.min(avail);
+ clamp_ordered(first, lo, avail - 20.0).min(avail)
+}
+
/// Drag the gap between the open stacked panels `above` and `below` (laid out at `bodies`) by
/// `d` points: one grows as much as the other shrinks, neither below [`STACK_MIN`]. The new sizes
/// become the panels' heights, except that the last panel without one keeps sharing the rest
@@ -1328,6 +1344,38 @@ mod tests {
}
}
+ #[test]
+ fn short_splits_lay_out_without_panicking() {
+ // #306: a split 0 < avail < 40 pt tall made `f32::clamp` panic (its bounds crossed).
+ for avail in [0.0, 5.0, 19.0, 20.0, 30.0, 39.0, 40.0, 41.0, -10.0, f32::NAN, f32::INFINITY] {
+ for size in [SplitSize::Ratio(0.5), SplitSize::Ratio(f32::NAN), SplitSize::FixedA(300.0), SplitSize::FixedB(300.0), SplitSize::FixedA(-5.0)] {
+ let f = split_first(size, avail);
+ assert!(f.is_finite() && f >= 0.0, "{size:?} {avail}: {f}");
+ if avail.is_finite() && avail > 0.0 {
+ assert!(f <= avail, "{size:?} {avail}: {f}");
+ }
+ }
+ }
+ assert_eq!(split_first(SplitSize::FixedA(300.0), 30.0), 20.0);
+ assert_eq!(split_first(SplitSize::Ratio(0.5), 200.0), 100.0);
+ assert_eq!(clamp_ordered(5.0, 40.0, -4.0), 40.0);
+ // Every workspace, laid out in rects too short and too narrow for its minimums.
+ let ctx = egui::Context::default();
+ let t = Tokens::for_kind(crate::theme::ThemeKind::Dark);
+ for w in WORKSPACES {
+ for (wd, ht) in [(30.0, 30.0), (800.0, 36.0), (800.0, 45.0), (36.0, 600.0), (1.0, 1.0), (0.0, 0.0)] {
+ let mut node = workspace(w);
+ let mut frame = ctx.run_ui(egui::RawInput::default(), |ui| {
+ let mut out = vec![];
+ let mut reg = crate::automation::Registry::default();
+ layout(ui, &mut node, Rect::from_min_size(pos2(0.0, 0.0), vec2(wd, ht)), &t, "", &mut out, &mut reg);
+ assert!(!out.is_empty(), "{w}");
+ });
+ frame.textures_delta.clear();
+ }
+ }
+ }
+
#[test]
fn drop_zone_math() {
let r = Rect::from_min_size(pos2(100.0, 100.0), vec2(400.0, 300.0));
diff --git a/crates/ui-egui/tests/ui_tabs.rs b/crates/ui-egui/tests/ui_tabs.rs
index d3a71ec32..207e5cf48 100644
--- a/crates/ui-egui/tests/ui_tabs.rs
+++ b/crates/ui-egui/tests/ui_tabs.rs
@@ -298,3 +298,30 @@ fn project_empty_area_double_click_and_dropped_files_import() {
h.run_steps(2);
assert_eq!(imports(&h), 2, "the dropped file was imported");
}
+
+/// Issue #306: dragging the viewer/Timeline divider far up made a nested split shorter than its
+/// two 20 pt minimums, and `f32::clamp` panicked with crossed bounds, closing the app.
+#[test]
+fn dragging_the_viewer_timeline_divider_far_up_does_not_crash() {
+ let (mut h, _, _) = harness();
+ // The horizontal gutter right above the Timeline.
+ let tl = rect(&h, "panel.Timeline");
+ let gutter = |h: &Harness<'_, EffectcraftApp>| {
+ h.state()
+ .auto
+ .previous
+ .iter()
+ .filter(|e| e.id.starts_with("dock.gutter.") && e.rect[2] > e.rect[3])
+ .map(|e| (e.id.clone(), egui::Rect::from_min_size(pos2(e.rect[0], e.rect[1]), egui::vec2(e.rect[2], e.rect[3]))))
+ .filter(|(_, g)| g.x_range().contains(tl.center().x) && g.max.y <= tl.min.y + 1.0)
+ .min_by(|a, b| (tl.min.y - a.1.max.y).total_cmp(&(tl.min.y - b.1.max.y)))
+ .expect("the gutter above the Timeline")
+ };
+ let (id, g) = gutter(&h);
+ drag(&mut h, g.center(), g.center() - egui::vec2(0.0, 2000.0));
+ let g2 = rect(&h, &id);
+ assert!(g2.center().y < g.center().y - 100.0, "the divider moved up: {g:?} → {g2:?}");
+ // And back down past the bottom.
+ drag(&mut h, g2.center(), g2.center() + egui::vec2(0.0, 3000.0));
+ h.run_steps(2);
+}