Skip to content

DesignCraft: An open-source page and layout design editor written by scratch in pure Rust

Merge #171: Paragraph and Character Styles: wire save and delete into the UI (#169)

aiongg2fb7ddafe217
diff --cc crates/engine/src/tests.rs
index 31ad7bb2e,add42889b..b3142316c
--- a/crates/engine/src/tests.rs
+++ b/crates/engine/src/tests.rs
@@@ -562,144 -560,113 +562,255 @@@ fn commands_take_non_object_params_with
}
}
+/// Load the text from a frame's out port with the Selection tool and click on the pasteboard:
+/// a new frame is threaded there and the overset text flows into it.
+#[test]
+fn threading_with_the_loaded_text_cursor_on_the_sample() {
+ use designcraft_tools::{PointerEvent, PointerKind};
+ let mut s = Session::new();
+ s.execute("file.newSample", &json!({})).unwrap();
+ let d = s.doc().unwrap().doc.clone();
+ let (sid, first) = d.stories.values().find(|st| st.frames.len() >= 2).map(|st| (st.id, st.frames[0])).expect("a threaded story");
+ // Break the thread so the first frame is overset, and select it.
+ s.execute("text.unthread", &json!({"frame": first.0})).unwrap();
+ assert!(s.cache.get(&s.doc().unwrap().doc, sid, None).is_overset());
+ s.execute("selection.set", &json!({"ids": [first.0]})).unwrap();
+ s.set_tool("selection");
+ let v = ViewInfo::at_zoom(1.0);
+ let layout = s.layout();
+ let port = designcraft_tools::thread::port_center(&s.doc().unwrap().doc, &layout, first, true, v.zoom).unwrap();
+ let ev = |k, p: designcraft_geom::Point| PointerEvent::new(k, p.x, p.y);
+ s.pointer(&ev(PointerKind::Down, port), v).unwrap();
+ s.pointer(&ev(PointerKind::Up, port), v).unwrap();
+ assert_eq!(s.cursor(port + designcraft_geom::Vec2::new(-2000.0, 0.0), Default::default(), v), designcraft_tools::Cursor::LoadedText);
+ // On the pasteboard left of the first spread.
+ let b = layout.slots[0].bounds;
+ let at = designcraft_geom::Point::new(b.x0 - 300.0, b.y0 + 100.0);
+ let undo = s.doc().unwrap().history.undo.len();
+ s.pointer(&ev(PointerKind::Down, at), v).unwrap();
+ s.pointer(&ev(PointerKind::Up, at), v).unwrap();
+ let st = s.doc().unwrap();
+ assert_eq!(st.history.undo.len(), undo + 1, "one undo step");
+ let frames = st.doc.story(sid).unwrap().frames.clone();
+ assert_eq!(frames.len(), 2);
+ let new = frames[1];
+ assert_eq!(st.selection.items, [new]);
+ let cs = s.cache.get(&s.doc().unwrap().doc, sid, None);
+ assert!(cs.frames.iter().any(|f| f.frame == new && !f.range.is_empty()), "the text flows into the new frame");
+ let nb = s.doc().unwrap().doc.item(new).unwrap().bounds();
+ assert!((nb.y0 - layout.to_spread(designcraft_doc::SpreadRef::Doc(0), at).y).abs() < 1e-6, "{nb:?}");
+}
+
+/// Drag a selection handle of item 0 on spread 0 from the edge point `at` by `by` (canvas units).
+fn drag_handle(s: &mut Session, at: designcraft_geom::Point, by: designcraft_geom::Vec2, v: ViewInfo) {
+ use designcraft_tools::{PointerEvent, PointerKind};
+ let p = s.layout().to_canvas(designcraft_doc::SpreadRef::Doc(0), at);
+ s.pointer(&PointerEvent::new(PointerKind::Down, p.x, p.y), v).unwrap();
+ s.pointer(&PointerEvent::new(PointerKind::Drag, p.x + by.x / 2.0, p.y + by.y / 2.0), v).unwrap();
+ s.pointer(&PointerEvent::new(PointerKind::Drag, p.x + by.x, p.y + by.y), v).unwrap();
+ s.pointer(&PointerEvent::new(PointerKind::Up, p.x + by.x, p.y + by.y), v).unwrap();
+}
+
+#[test]
+fn text_frame_resize_snaps_to_the_margins() {
+ use designcraft_geom::{Point, Vec2};
+ for zoom in [1.0, 0.5] {
+ let mut s = Session::new();
+ s.execute("file.newSample", &json!({})).unwrap();
+ let margin = s.doc().unwrap().doc.spreads[0].pages[0].margin_rect();
+ let (x0, y0) = (margin.x0 + 40.0, margin.y0 + 40.0);
+ s.execute("frame.create", &json!({"rect": [x0, y0, x0 + 200.0, y0 + 200.0], "content": "text"})).unwrap();
+ s.set_tool("selection");
+ let v = ViewInfo::at_zoom(zoom);
+ let b0 = s.doc().unwrap().doc.spreads[0].items.last().unwrap().bounds();
+ // Right handle to 1.5 pt short of the right margin.
+ drag_handle(&mut s, Point::new(b0.x1, b0.center().y), Vec2::new(margin.x1 - 1.5 - b0.x1, 0.0), v);
+ let b = s.doc().unwrap().doc.spreads[0].items.last().unwrap().bounds();
+ assert!((b.x1 - margin.x1).abs() < 1e-6, "zoom {zoom}: right edge {} not on the margin {}", b.x1, margin.x1);
+ // Bottom handle to 1.5 pt past the bottom margin.
+ drag_handle(&mut s, Point::new(b.center().x, b.y1), Vec2::new(0.0, margin.y1 + 1.5 - b.y1), v);
+ let b = s.doc().unwrap().doc.spreads[0].items.last().unwrap().bounds();
+ assert!((b.y1 - margin.y1).abs() < 1e-6, "zoom {zoom}: bottom edge {} not on the margin {}", b.y1, margin.y1);
+ // Top-left corner handle onto the top and left margins.
+ drag_handle(&mut s, Point::new(b.x0, b.y0), Vec2::new(margin.x0 + 1.0 - b.x0, margin.y0 - 1.0 - b.y0), v);
+ let b = s.doc().unwrap().doc.spreads[0].items.last().unwrap().bounds();
+ assert!((b.x0 - margin.x0).abs() < 1e-6 && (b.y0 - margin.y0).abs() < 1e-6, "zoom {zoom}: corner {b:?} not on the margins {margin:?}");
+ }
+}
+
+#[test]
+fn type_tool_frames_snap_to_the_margins() {
+ use designcraft_geom::Point;
+ use designcraft_tools::{PointerEvent, PointerKind};
+ let mut s = session();
+ let margin = s.doc().unwrap().doc.spreads[0].pages[0].margin_rect();
+ s.set_tool("type");
+ let v = ViewInfo::at_zoom(1.0);
+ let c = |s: &Session, x: f64, y: f64| s.layout().to_canvas(designcraft_doc::SpreadRef::Doc(0), Point::new(x, y));
+ // From 1.5 pt off the top-left margin corner to 1.5 pt off the right margin.
+ let a = c(&s, margin.x0 + 1.5, margin.y0 + 1.5);
+ let b = c(&s, margin.x1 - 1.5, margin.y0 + 101.5);
+ let before = s.doc().unwrap().doc.spreads[0].items.len();
+ s.pointer(&PointerEvent::new(PointerKind::Down, a.x, a.y), v).unwrap();
+ s.pointer(&PointerEvent::new(PointerKind::Drag, (a.x + b.x) / 2.0, b.y), v).unwrap();
+ s.pointer(&PointerEvent::new(PointerKind::Drag, b.x, b.y), v).unwrap();
+ s.pointer(&PointerEvent::new(PointerKind::Up, b.x, b.y), v).unwrap();
+ let items = &s.doc().unwrap().doc.spreads[0].items;
+ assert_eq!(items.len(), before + 1, "a frame was drawn");
+ let r = items.last().unwrap().bounds();
+ assert!((r.x0 - margin.x0).abs() < 1e-6 && (r.y0 - margin.y0).abs() < 1e-6, "press point {r:?} vs {margin:?}");
+ assert!((r.x1 - margin.x1).abs() < 1e-6, "right edge {} vs {}", r.x1, margin.x1);
+}
+
+#[test]
+fn preflight_distinguishes_unplaced_stories_and_locates_footnote_overset() {
+ use designcraft_doc::{AnchorPosition, AnchoredObject, ParaFormat, SpreadRef, Story, StoryId};
+ use designcraft_geom::Rect;
+ let mut s = session();
+ let doc = Arc::make_mut(&mut s.doc_mut().unwrap().doc);
+ let layer = doc.default_layer();
+ let (host, body) = doc.add_text_frame(SpreadRef::Doc(0), Rect::new(20.0, 20.0, 400.0, 600.0), layer, "Body", ParaFormat::default()).unwrap();
+ let (frame, _) = doc.add_text_frame(SpreadRef::Doc(0), Rect::new(0.0, 0.0, 5.0, 2.0), layer, "Overflow", ParaFormat::default()).unwrap();
+ let item = doc.item(frame).unwrap().clone();
+ doc.spread_mut(SpreadRef::Doc(0)).unwrap().items.retain(|i| i.id != frame);
+ let story = doc.story_mut(body).unwrap();
+ story.insert_note(4, "Note", ParaFormat::default());
+ Arc::make_mut(&mut story.notes[0]).text.insert_object(0, AnchoredObject::new(item, AnchorPosition::Inline { y_offset: 0.0 }));
+ let unplaced = StoryId(doc.alloc());
+ doc.stories.insert(unplaced, Arc::new(Story::with_text(unplaced, "Unplaced", ParaFormat::default())));
+ doc.check().unwrap();
+ let issues = s.execute("preflight.run", &json!({})).unwrap();
+ let issues = issues["issues"].as_array().unwrap();
+ let overset: Vec<_> = issues.iter().filter(|i| i["kind"] == "overset").collect();
+ assert_eq!(overset.len(), 1, "{issues:?}");
+ assert_eq!(overset[0]["item"], host.0);
+ assert_eq!(overset[0]["page"], 0);
+ let unplaced = issues.iter().find(|i| i["kind"] == "unplacedStory").unwrap();
+ assert_eq!(unplaced["severity"], "warning");
+ assert!(unplaced.get("page").is_none());
+}
+
+#[test]
+fn preflight_mojikumi_uses_the_same_supported_rules_as_composition() {
+ let mut s = session();
+ s.execute("frame.create", &json!({"rect": [36, 36, 300, 300], "content": "text", "text": "中文 A1"})).unwrap();
+ let story = s.doc().unwrap().doc.stories.keys().next().unwrap().0;
+ s.execute("text.select", &json!({"story": story, "anchor": 0, "focus": 1})).unwrap();
+ for (name, unsupported) in [("SimpChineseDefault", false), ("LineEndAllOneHalfEmEnum", false), ("UnknownPreset", true), ("Nothing", false)] {
+ s.execute("type.para", &json!({"attrs": {"mojikumi": name, "kinsokuType": "KinsokuPushInFirst"}})).unwrap();
+ let result = s.execute("preflight.run", &json!({})).unwrap();
+ let warnings: Vec<_> = result["issues"].as_array().unwrap().iter().filter(|i| i["kind"] == "unsupportedTypography").collect();
+ assert_eq!(!warnings.is_empty(), unsupported, "{name}: {warnings:?}");
+ }
+}
++
+ #[test]
+ fn paragraph_style_edit_persists_attrs_and_rename() {
+ let mut s = session();
+ let name =
+ s.execute("style.paragraph.create", &json!({"name": "Body Copy", "para": {"align": "left"}})).unwrap()["name"].as_str().unwrap().to_string();
+ s.execute("style.paragraph.edit", &json!({"name": name, "para": {"align": "center"}})).unwrap();
+ {
+ let st = s.doc().unwrap();
+ let style = st.doc.styles.para(&name).expect("style still exists");
+ assert_eq!(style.para.align, Some(designcraft_doc::Align::Center), "edited attribute persisted");
+ }
+ // Renaming updates the style definition itself, and every place it's referenced.
+ s.execute("style.paragraph.edit", &json!({"name": name, "rename": "Body Text"})).unwrap();
+ let st = s.doc().unwrap();
+ assert!(st.doc.styles.para("Body Text").is_some(), "renamed style exists under the new name");
+ assert!(st.doc.styles.para(&name).is_none(), "old name is gone");
+ }
+
+ #[test]
+ fn paragraph_style_edit_rejects_based_on_cycle() {
+ let mut s = session();
+ let a = s.execute("style.paragraph.create", &json!({"name": "A"})).unwrap()["name"].as_str().unwrap().to_string();
+ let b = s.execute("style.paragraph.create", &json!({"name": "B", "basedOn": a})).unwrap()["name"].as_str().unwrap().to_string();
+ let r = s.execute("style.paragraph.edit", &json!({"name": a, "basedOn": b}));
+ assert!(r.is_err(), "A based on B based on A must be rejected");
+ }
+
+ #[test]
+ fn paragraph_style_delete_reassigns_affected_text() {
+ let mut s = session();
+ let name = s.execute("style.paragraph.create", &json!({"name": "Caption"})).unwrap()["name"].as_str().unwrap().to_string();
+ let sid = s.execute("frame.create", &json!({"rect": [36, 36, 300, 200], "content": "text"})).unwrap()["story"].as_u64().unwrap();
+ s.execute("text.insert", &json!({"text": "Hello, world"})).unwrap();
+ s.execute("text.select", &json!({"story": sid, "anchor": 0, "focus": 0})).unwrap();
+ s.execute("style.paragraph.apply", &json!({"name": name})).unwrap();
+ {
+ let st = s.doc().unwrap();
+ let story = st.doc.stories.get(&designcraft_doc::StoryId(sid)).expect("story exists");
+ assert_eq!(story.paras[0].style, name, "style applied before delete");
+ }
+ s.execute("style.paragraph.delete", &json!({"name": name, "replaceWith": designcraft_doc::BASIC_PARAGRAPH})).unwrap();
+ let st = s.doc().unwrap();
+ assert!(st.doc.styles.para(&name).is_none(), "deleted style is gone");
+ let story = st.doc.stories.get(&designcraft_doc::StoryId(sid)).expect("story exists");
+ assert_eq!(story.paras[0].style, designcraft_doc::BASIC_PARAGRAPH, "affected paragraph reassigned to the replacement style");
+ }
+
+ #[test]
+ fn paragraph_style_delete_rejects_builtin_styles() {
+ let mut s = session();
+ let r = s.execute("style.paragraph.delete", &json!({"name": designcraft_doc::BASIC_PARAGRAPH}));
+ assert!(r.is_err(), "built-in styles can't be deleted");
+ }
+
+ #[test]
+ fn character_style_edit_persists_attrs_and_rename() {
+ let mut s = session();
+ let name = s.execute("style.character.create", &json!({"name": "Key Term", "chars": {"fontStyle": "Bold"}})).unwrap()["name"]
+ .as_str()
+ .unwrap()
+ .to_string();
+ s.execute("style.character.edit", &json!({"name": name, "chars": {"tracking": 20.0}})).unwrap();
+ {
+ let st = s.doc().unwrap();
+ let style = st.doc.styles.char_style(&name).expect("style still exists");
+ assert_eq!(style.chars.tracking, Some(20.0), "edited attribute persisted");
+ }
+ // Renaming updates the style definition itself, and every place it's referenced.
+ s.execute("style.character.edit", &json!({"name": name, "rename": "Emphasis"})).unwrap();
+ let st = s.doc().unwrap();
+ assert!(st.doc.styles.char_style("Emphasis").is_some(), "renamed style exists under the new name");
+ assert!(st.doc.styles.char_style(&name).is_none(), "old name is gone");
+ }
+
+ #[test]
+ fn character_style_edit_rejects_based_on_cycle() {
+ let mut s = session();
+ let a = s.execute("style.character.create", &json!({"name": "A"})).unwrap()["name"].as_str().unwrap().to_string();
+ let b = s.execute("style.character.create", &json!({"name": "B", "basedOn": a})).unwrap()["name"].as_str().unwrap().to_string();
+ let r = s.execute("style.character.edit", &json!({"name": a, "basedOn": b}));
+ assert!(r.is_err(), "A based on B based on A must be rejected");
+ }
+
+ #[test]
+ fn character_style_delete_reassigns_affected_text() {
+ let mut s = session();
+ let name = s.execute("style.character.create", &json!({"name": "Key Term"})).unwrap()["name"].as_str().unwrap().to_string();
+ let r = s.execute("frame.create", &json!({"rect": [36, 36, 300, 200], "content": "text"})).unwrap();
+ let sid = r["story"].as_u64().unwrap();
+ s.execute("text.insert", &json!({"text": "Hello, world"})).unwrap();
+ s.execute("text.select", &json!({"story": sid, "anchor": 0, "focus": 5})).unwrap();
+ s.execute("style.character.apply", &json!({"name": name})).unwrap();
+ {
+ let st = s.doc().unwrap();
+ let story = st.doc.stories.get(&designcraft_doc::StoryId(sid)).expect("story exists");
+ assert_eq!(story.chars[0].format.style, name, "style applied before delete");
+ }
+ s.execute("style.character.delete", &json!({"name": name, "replaceWith": designcraft_doc::NO_CHAR_STYLE})).unwrap();
+ let st = s.doc().unwrap();
+ assert!(st.doc.styles.char_style(&name).is_none(), "deleted style is gone");
+ let story = st.doc.stories.get(&designcraft_doc::StoryId(sid)).expect("story exists");
+ assert_eq!(story.chars[0].format.style, designcraft_doc::NO_CHAR_STYLE, "affected run reassigned to the replacement style");
+ }
+
+ #[test]
+ fn character_style_delete_rejects_builtin_styles() {
+ let mut s = session();
+ let r = s.execute("style.character.delete", &json!({"name": designcraft_doc::NO_CHAR_STYLE}));
+ assert!(r.is_err(), "built-in styles can't be deleted");
+ }
diff --cc crates/ui-egui/src/dialogs.rs
index dee4eed41,616961aea..84cc9a0d9
--- a/crates/ui-egui/src/dialogs.rs
+++ b/crates/ui-egui/src/dialogs.rs
@@@ -1903,9 -1914,17 +1918,17 @@@ pub fn confirm(app: &mut DesignApp) ->
}
r
}
+ "deleteCharacterStyle" => {
+ let name = d.s("name");
+ let replace = d.s("replaceWith");
+ app.run(
+ "style.character.delete",
+ json!({"name": name, "replaceWith": if replace.is_empty() { json!(designcraft_doc::NO_CHAR_STYLE) } else { json!(replace) }}),
+ )
+ }
"colorPicker" => {
let hex = d.s("hex");
- app.run("object.color", json!({"color": hex, "target": d.s("target")}))
+ app.run("object.color", json!({"color": hex, "target": d.s("target"), "text": d.b("text")}))
}
"layerOptions" => {
let hidden: Vec<Value> = d.fields.get("layers").and_then(Value::as_array).map(|a| a.iter().filter(|l| l["visible"] == false).map(|l| l["name"].clone()).collect()).unwrap_or_default();