Skip to content

VectorCraft: An open-source, vector art tool written by scratch in pure Rust

19.4 KB
Raw Blame
use super::*;
use vectorcraft_engine::Session;
use vectorcraft_tools::{PointerEvent, PointerKind};

/// A 10 pt line from (100, 150) to (300, 150) with a 4 + 4 pt width point in the middle.
fn app() -> (VectorcraftApp, u64) {
    let mut app = VectorcraftApp::new(Session::new(), Default::default());
    app.run("file.new", json!({"width": 400, "height": 300})).unwrap();
    let id = app.run("shape.line", json!({"x1": 100, "y1": 150, "x2": 300, "y2": 150})).unwrap()["id"].as_u64().unwrap();
    app.run("stroke.set", json!({"ids": [id], "weight": 10})).unwrap();
    app.run("stroke.widthPoint.set", json!({"id": id, "t": 0.5, "left": 4, "right": 4})).unwrap();
    (app, id)
}

fn points(app: &VectorcraftApp, id: u64) -> Vec<(f64, f64, f64)> {
    let st = app.session.active().unwrap().doc.node(NodeId(id)).unwrap().appearance.stroke().unwrap().clone();
    let round = |v: f64| (v * 1e9).round() / 1e9;
    st.profile.map(|p| p.points.into_iter().map(|(t, l, r)| (round(t), round(l), round(r))).collect()).unwrap_or_default()
}

fn frame(app: &mut VectorcraftApp) -> Vec<String> {
    fn texts(s: &egui::Shape, out: &mut Vec<String>) {
        match s {
            egui::Shape::Text(t) => out.push(t.galley.text().to_string()),
            egui::Shape::Vec(v) => v.iter().for_each(|s| texts(s, out)),
            _ => {}
        }
    }
    let ctx = egui::Context::default();
    crate::theme::install_fonts(&ctx);
    // A new window lays itself out in its first frame and paints in the next.
    ctx.run_ui(Default::default(), |ui| super::super::show(app, ui.ctx())).textures_delta.clear();
    let mut out = ctx.run_ui(Default::default(), |ui| super::super::show(app, ui.ctx()));
    out.textures_delta.clear();
    let mut v = vec![];
    out.shapes.iter().for_each(|c| texts(&c.shape, &mut v));
    v
}

#[test]
fn double_click_opens_it_and_ok_sets_the_widths() {
    for shift in [false, true] {
        let (mut app, id) = app();
        let before = app.session.doc().unwrap().doc.clone();
        let undo = app.session.doc().unwrap().history.undo.len();
        let view = app.view_info();
        app.select_tool("width");
        let mut ev = PointerEvent::new(PointerKind::DoubleClick, 200.0, 150.0);
        ev.mods.shift = shift;
        crate::canvas::dispatch(&mut app, &ev, view);
        let d = app.ui.dialog.clone().expect("Width Point Edit opened");
        assert_eq!((d.kind.as_str(), d.f64("side1", 0.0), d.f64("side2", 0.0), d.bool("linked")), (KIND, 4.0, 4.0, true));
        assert_eq!(d.bool("adjustAdjoining"), shift);
        let shown = frame(&mut app);
        for s in ["Width Point Edit", "Side 1:", "Side 2:", "Total Width:", "Adjust Adjoining Width Points", "Delete"] {
            assert!(shown.iter().any(|t| t == s), "{s} in {shown:?}");
        }
        let d = app.ui.dialog.as_mut().unwrap();
        d.fields.insert("side1".into(), json!(6));
        d.fields.insert("side2".into(), json!(2));
        super::super::confirm(&mut app).unwrap();
        assert!(app.ui.dialog.is_none());
        let ends = if shift { (1.5, 0.5) } else { (1.0, 1.0) };
        assert_eq!(points(&app, id), vec![(0.0, ends.0, ends.1), (0.5, 1.2, 0.4), (1.0, ends.0, ends.1)]);
        assert_eq!(app.session.doc().unwrap().history.undo.len(), undo + 1);
        if shift {
            let edited = app.session.doc().unwrap().doc.clone();
            app.run("edit.undo", json!({})).unwrap();
            assert_eq!(app.session.doc().unwrap().doc, before);
            app.run("edit.redo", json!({})).unwrap();
            assert_eq!(app.session.doc().unwrap().doc, edited);
            crate::canvas::dispatch(&mut app, &ev, view);
            app.ui.dialog.as_mut().unwrap().fields.insert("side1".into(), json!(20));
            super::super::cancel(&mut app);
            assert!(app.ui.dialog.is_none());
            let st = app.session.doc().unwrap();
            assert_eq!(st.doc, edited);
            assert_eq!((st.history.undo.len(), st.history.redo.len()), (undo + 1, 0));
        }
    }
}

#[test]
fn delete_removes_the_point() {
    let (mut app, id) = app();
    app.run("ui.widthPointEdit", json!({"id": id, "index": 1})).unwrap();
    app.ui.dialog.as_mut().unwrap().fields.insert("discard".into(), json!(true));
    super::super::confirm(&mut app).unwrap();
    assert_eq!(points(&app, id).len(), 2);
    assert!(app.run("ui.widthPointEdit", json!({"id": id, "index": 9})).is_err());
}

#[test]
fn it_does_not_stretch_to_the_screen() {
    let height = |screen_h: f32| {
        let (mut app, id) = app();
        app.run("ui.widthPointEdit", json!({"id": id, "index": 1})).unwrap();
        let ctx = egui::Context::default();
        crate::theme::install_fonts(&ctx);
        let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, egui::vec2(1600.0, screen_h));
        for _ in 0..4 {
            let input = egui::RawInput { screen_rect: Some(screen), ..Default::default() };
            ctx.run_ui(input, |ui| super::super::show(&mut app, ui.ctx())).textures_delta.clear();
        }
        ctx.memory(|m| m.area_rect(egui::Id::unique(("dialog", KIND)))).unwrap().height()
    };
    let (short, tall) = (height(1000.0), height(2000.0));
    assert!((short - tall).abs() < 1.0 && short < 400.0, "{short} vs {tall}");
}

fn creation_app() -> (VectorcraftApp, u64) {
    let (mut app, id) = app();
    app.run("stroke.set", json!({"ids": [id], "profile": "uniform"})).unwrap();
    app.run("shape.rectangle", json!({"x": 20, "y": 20, "width": 30, "height": 40})).unwrap();
    app.run("select.set", json!({"ids": [id]})).unwrap();
    app.select_tool("width");
    (app, id)
}

fn creation_history(app: &VectorcraftApp) -> (usize, usize, bool) {
    let st = app.session.doc().unwrap();
    (st.history.undo.len(), st.history.redo.len(), st.is_dirty())
}

/// The actual tool-event sequence from two stationary canvas clicks. No profile or dialog
/// is installed by the fixture after either click; DoubleClick must open the pending point.
fn creation_double_click(app: &mut VectorcraftApp, x: f64, y: f64) {
    let before = app.session.doc().unwrap().doc.clone();
    let history = creation_history(app);
    let view = app.view_info();
    for kind in [PointerKind::Down, PointerKind::Up, PointerKind::Down, PointerKind::Up] {
        crate::canvas::dispatch(app, &PointerEvent::new(kind, x, y), view);
        assert!(app.ui.dialog.is_none());
        assert_eq!(app.session.doc().unwrap().doc, before, "click alone must not add a width point");
        assert_eq!(creation_history(app), history);
    }
    assert!(!app.session.in_interaction());
    crate::canvas::dispatch(app, &PointerEvent::new(PointerKind::DoubleClick, x, y), view);
    assert!(app.ui.dialog.is_some(), "double-clicking a stroked segment must open Width Point Edit");
    assert_eq!(app.session.doc().unwrap().doc, before, "opening creates no point yet");
    assert_eq!(creation_history(app), history);
    assert!(!app.session.in_interaction());
}

#[test]
fn new_width_point_double_click_creates_with_history() {
    let (mut app, id) = creation_app();
    app.session.doc_mut().unwrap().mark_saved();
    let before = app.session.doc().unwrap().doc.clone();
    let selection = app.session.doc().unwrap().selection.clone();
    let history = creation_history(&app);
    creation_double_click(&mut app, 200.0, 150.0);
    let d = app.ui.dialog.as_ref().unwrap();
    assert_eq!(d.kind, KIND);
    assert_eq!(d.fields["id"], json!(id));
    assert!(d.fields.get("index").is_none_or(Value::is_null));
    assert!((d.f64("t", -1.0) - 0.5).abs() < 1e-6);
    assert_eq!((d.f64("side1", 0.0), d.f64("side2", 0.0), d.bool("linked")), (5.0, 5.0, true));
    assert!(!d.bool("adjustAdjoining"));
    let shown = frame(&mut app);
    for label in ["Width Point Edit", "Side 1:", "Side 2:", "Total Width:", "Cancel"] {
        assert!(shown.iter().any(|text| text == label), "{label} in {shown:?}");
    }
    let d = app.ui.dialog.as_mut().unwrap();
    d.fields.insert("side1".into(), json!(6));
    d.fields.insert("side2".into(), json!(2));
    super::super::confirm(&mut app).unwrap();
    assert!(app.ui.dialog.is_none());
    assert_eq!(points(&app, id), vec![(0.0, 1.0, 1.0), (0.5, 1.2, 0.4), (1.0, 1.0, 1.0)]);
    let after = app.session.doc().unwrap().doc.clone();
    assert_eq!(after.node(NodeId(id)).unwrap().kind, before.node(NodeId(id)).unwrap().kind, "path geometry remains unchanged");
    before.walk(|node| {
        if node.id != NodeId(id) && matches!(node.kind, vectorcraft_engine::doc::NodeKind::Path { .. }) {
            assert_eq!(after.node(node.id), Some(node), "other artwork remains unchanged");
        }
    });
    assert_eq!(app.session.doc().unwrap().selection, selection);
    assert_eq!(creation_history(&app), (history.0 + 1, 0, true));
    assert_eq!(app.session.doc().unwrap().history.undo.last().unwrap().label, "Width Point");
    app.run("edit.undo", json!({})).unwrap();
    assert_eq!(app.session.doc().unwrap().doc, before);
    assert_eq!(app.session.doc().unwrap().selection, selection);
    assert_eq!(creation_history(&app), (history.0, 1, false));
    app.run("edit.redo", json!({})).unwrap();
    assert_eq!(app.session.doc().unwrap().doc, after);
    assert_eq!(app.session.doc().unwrap().selection, selection);
    assert_eq!(creation_history(&app), (history.0 + 1, 0, true));
}

#[test]
fn new_width_point_cancel_and_discard_keep_redo() {
    for discard in [false, true] {
        let (mut app, _) = creation_app();
        app.run("shape.rectangle", json!({"x": 50, "y": 20, "width": 20, "height": 20})).unwrap();
        let redo = app.session.doc().unwrap().doc.clone();
        app.run("edit.undo", json!({})).unwrap();
        app.session.doc_mut().unwrap().mark_saved();
        let before = app.session.doc().unwrap().doc.clone();
        let selection = app.session.doc().unwrap().selection.clone();
        let history = creation_history(&app);
        assert_eq!(history.1, 1);
        creation_double_click(&mut app, 200.0, 150.0);
        app.ui.dialog.as_mut().unwrap().fields.insert("side1".into(), json!(20));
        if discard {
            app.ui.dialog.as_mut().unwrap().fields.insert("discard".into(), json!(true));
            super::super::confirm(&mut app).unwrap();
        } else {
            super::super::cancel(&mut app);
        }
        assert!(app.ui.dialog.is_none());
        assert_eq!(app.session.doc().unwrap().doc, before);
        assert_eq!(app.session.doc().unwrap().selection, selection);
        assert_eq!(creation_history(&app), history);
        app.run("edit.redo", json!({})).unwrap();
        assert_eq!(app.session.doc().unwrap().doc, redo);
    }
}

#[test]
fn new_width_point_profile_and_compound_target() {
    for compound in [false, true] {
        let (mut app, line) = creation_app();
        let (id, member) = if compound {
            let second = app.run("shape.line", json!({"x1": 320, "y1": 50, "x2": 320, "y2": 250})).unwrap()["id"].as_u64().unwrap();
            app.run("select.set", json!({"ids": [line, second]})).unwrap();
            (app.run("object.compoundPath.make", json!({})).unwrap()["id"].as_u64().unwrap(), second)
        } else {
            (line, line)
        };
        app.run("stroke.widthProfile.set", json!({"ids": [id], "points": [[0, 1, 0.5], [1, 2, 1.5]]})).unwrap();
        app.select_tool("width");
        app.session.doc_mut().unwrap().mark_saved();
        let before = app.session.doc().unwrap().doc.clone();
        let selection = app.session.doc().unwrap().selection.clone();
        let history = creation_history(&app);
        // Make Compound Path can reverse the member. Choose the quarter point from its
        // stored direction; on a straight segment this is exactly one quarter of its length.
        let path = before.node(NodeId(member)).unwrap().path_data().unwrap();
        assert_eq!(path.subpaths.len(), 1);
        let subpath = &path.subpaths[0];
        assert_eq!(subpath.anchors.len(), 2);
        assert!(subpath.segment_is_line(0));
        let quarter = subpath.anchors[0].p.lerp(subpath.anchors[1].p, 0.25);
        creation_double_click(&mut app, quarter.x, quarter.y);
        let d = app.ui.dialog.as_mut().unwrap();
        assert_eq!(d.fields["id"], json!(id), "the compound owns its members' stroke");
        assert!(d.fields.get("index").is_none_or(Value::is_null));
        let actual_t = d.f64("t", -1.0);
        assert!((actual_t - 0.25).abs() < 1e-6, "compound={compound} pointer={quarter:?} actual_t={actual_t} want=0.25");
        assert!((d.f64("side1", 0.0) - 6.25).abs() < 1e-6);
        assert!((d.f64("side2", 0.0) - 3.75).abs() < 1e-6);
        assert!(!d.bool("linked"));
        d.fields.insert("side1".into(), json!(8));
        d.fields.insert("side2".into(), json!(3));
        super::super::confirm(&mut app).unwrap();
        assert_eq!(points(&app, id), vec![(0.0, 1.0, 0.5), (0.25, 1.6, 0.6), (1.0, 2.0, 1.5)]);
        let after = app.session.doc().unwrap().doc.clone();
        assert_eq!(after.node(NodeId(id)).unwrap().kind, before.node(NodeId(id)).unwrap().kind, "member paths retain their geometry");
        assert_eq!(app.session.doc().unwrap().selection, selection);
        assert_eq!(creation_history(&app), (history.0 + 1, 0, true));
        app.run("edit.undo", json!({})).unwrap();
        assert_eq!(app.session.doc().unwrap().doc, before);
        assert_eq!(creation_history(&app), (history.0, 1, false));
        app.run("edit.redo", json!({})).unwrap();
        assert_eq!(app.session.doc().unwrap().doc, after);
    }
}

#[test]
fn new_width_point_command_opens_pending_point() {
    let (mut app, id) = creation_app();
    let before = app.session.doc().unwrap().doc.clone();
    let history = creation_history(&app);
    app.run("ui.widthPointEdit", json!({"id": id, "t": 0.25})).expect("the UI command accepts a prospective point");
    let d = app.ui.dialog.as_ref().unwrap();
    assert!(d.fields.get("index").is_none_or(Value::is_null));
    assert_eq!((d.f64("t", -1.0), d.f64("side1", 0.0), d.f64("side2", 0.0)), (0.25, 5.0, 5.0));
    super::super::cancel(&mut app);
    assert_eq!(app.session.doc().unwrap().doc, before);
    assert_eq!(creation_history(&app), history);
}

#[test]
fn new_width_point_invalid_command_keeps_document() {
    let (mut app, id) = creation_app();
    let before = app.session.doc().unwrap().doc.clone();
    let history = creation_history(&app);
    for p in [
        json!({"id": id, "t": -0.01}),
        json!({"id": id, "t": 1.01}),
        json!({"id": id, "t": "invalid"}),
        json!({"id": id, "index": "invalid", "t": 0.5}),
        json!({"id": id, "index": 999, "t": 0.5}),
    ] {
        assert!(app.run("ui.widthPointEdit", p).is_err());
        assert!(app.ui.dialog.is_none());
        assert_eq!(app.session.doc().unwrap().doc, before);
        assert_eq!(creation_history(&app), history);
    }
}

fn creation_dialog_frame(app: &mut VectorcraftApp, ctx: &egui::Context, events: Vec<egui::Event>) -> Vec<(String, egui::Rect)> {
    fn collect(shape: &egui::Shape, clip: egui::Rect, texts: &mut Vec<(String, egui::Rect)>) {
        match shape {
            egui::Shape::Text(t) if clip.contains_rect(t.visual_bounding_rect()) => {
                texts.push((t.galley.text().to_string(), t.visual_bounding_rect()));
            }
            egui::Shape::Vec(shapes) => shapes.iter().for_each(|shape| collect(shape, clip, texts)),
            _ => {}
        }
    }
    let input = egui::RawInput { screen_rect: Some(egui::Rect::from_min_size(egui::Pos2::ZERO, vec2(1000.0, 700.0))), events, ..Default::default() };
    let mut output = ctx.run_ui(input, |ui| super::super::show(app, ui.ctx()));
    output.textures_delta.clear();
    let mut texts = vec![];
    output.shapes.iter().for_each(|shape| collect(&shape.shape, shape.clip_rect, &mut texts));
    texts
}

fn creation_dialog_click(app: &mut VectorcraftApp, ctx: &egui::Context, label: &str) {
    for _ in 0..4 {
        creation_dialog_frame(app, ctx, vec![]);
    }
    let texts = creation_dialog_frame(app, ctx, vec![]);
    let pos = texts.iter().find(|(text, _)| text == label).unwrap_or_else(|| panic!("missing visible control {label}: {texts:?}")).1.center();
    for pressed in [true, false] {
        creation_dialog_frame(
            app,
            ctx,
            vec![
                egui::Event::PointerMoved(pos),
                egui::Event::PointerButton { pos, button: egui::PointerButton::Primary, pressed, modifiers: Default::default() },
            ],
        );
    }
    creation_dialog_frame(app, ctx, vec![]);
}

fn creation_adjoining_checkbox(adjust: bool) {
    let (mut app, id) = creation_app();
    app.run("stroke.widthProfile.set", json!({"ids": [id], "points": [[0, 1, 1], [1, 1, 1]]})).unwrap();
    app.session.doc_mut().unwrap().mark_saved();
    let before = app.session.doc().unwrap().doc.clone();
    let selection = app.session.doc().unwrap().selection.clone();
    let history = creation_history(&app);
    creation_double_click(&mut app, 200.0, 150.0);
    assert!(app.ui.dialog.as_ref().unwrap().fields["index"].is_null());
    let ctx = egui::Context::default();
    crate::theme::install_fonts(&ctx);
    crate::theme::apply(&ctx, Default::default());
    for _ in 0..5 {
        creation_dialog_frame(&mut app, &ctx, vec![]);
    }
    // The dialog naturally focuses and selects Side 1. Its linked partner changes
    // when the checkbox click commits the typed value; no fields are seeded.
    assert!(ctx.memory(|m| m.focused()).is_some());
    creation_dialog_frame(&mut app, &ctx, vec![egui::Event::Text("10 pt".into())]);
    creation_dialog_click(&mut app, &ctx, "Adjust Adjoining Width Points");
    assert!(app.ui.dialog.as_ref().unwrap().bool("adjustAdjoining"), "real checkbox click enables adjustment");
    if !adjust {
        creation_dialog_click(&mut app, &ctx, "Adjust Adjoining Width Points");
    }
    let d = app.ui.dialog.as_ref().unwrap();
    assert_eq!(d.bool("adjustAdjoining"), adjust);
    assert_eq!((d.f64("side1", 0.0), d.f64("side2", 0.0)), (10.0, 10.0));
    assert_eq!(app.session.doc().unwrap().doc, before);
    assert_eq!(creation_history(&app), history);
    creation_dialog_click(&mut app, &ctx, "OK");
    assert!(app.ui.dialog.is_none(), "real OK click confirms the pending point");
    let end = if adjust { 2.0 } else { 1.0 };
    assert_eq!(points(&app, id), vec![(0.0, end, end), (0.5, 2.0, 2.0), (1.0, end, end)], "checkbox choice controls adjoining widths");
    let after = app.session.doc().unwrap().doc.clone();
    assert_eq!(after.node(NodeId(id)).unwrap().kind, before.node(NodeId(id)).unwrap().kind);
    before.walk(|node| {
        if node.id != NodeId(id) && matches!(node.kind, vectorcraft_engine::doc::NodeKind::Path { .. }) {
            assert_eq!(after.node(node.id), Some(node), "other artwork remains unchanged");
        }
    });
    assert_eq!(app.session.doc().unwrap().selection, selection);
    assert_eq!(creation_history(&app), (history.0 + 1, 0, true));
    assert_eq!(app.session.doc().unwrap().history.undo.last().unwrap().label, "Width Point");
    app.run("edit.undo", json!({})).unwrap();
    assert_eq!(app.session.doc().unwrap().doc, before);
    assert_eq!(app.session.doc().unwrap().selection, selection);
    assert_eq!(creation_history(&app), (history.0, 1, false));
    app.run("edit.redo", json!({})).unwrap();
    assert_eq!(app.session.doc().unwrap().doc, after);
    assert_eq!(app.session.doc().unwrap().selection, selection);
    assert_eq!(creation_history(&app), (history.0 + 1, 0, true));
}

#[test]
fn new_width_point_checkbox_adjusts_adjoining_in_one_step() {
    creation_adjoining_checkbox(true);
}

#[test]
fn new_width_point_checkbox_off_preserves_adjoining() {
    creation_adjoining_checkbox(false);
}