Skip to content

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

Merge upstream main 1d996da (#263, #296) into next

aionggf2a6b0e4c2f6
diff --cc crates/ui-egui/src/dialogs.rs
index 239a913b2,1e1ae0e21..898548a37
--- a/crates/ui-egui/src/dialogs.rs
+++ b/crates/ui-egui/src/dialogs.rs
@@@ -1769,16 -1581,9 +1776,9 @@@ pub fn confirm(app: &mut DesignApp) ->
}
r
}
- "paragraphRules" => {
- let attrs = rule_edits(&d, "");
- if attrs.is_empty() {
- return Ok(Value::Null);
- }
- app.run("type.para", json!({"attrs": attrs}))
- }
"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();
@@@ -3812,309 -3427,74 +3745,376 @@@ mod tests
assert_eq!(resolved(&app)["ruleBelow"], rule);
}
+ fn command_app(id: &str, fields: Value) -> DesignApp {
+ let mut app = DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.ui.dialog = Some(Dialog::new(&format!("cmd:{id}"), fields));
+ app
+ }
+
+ #[test]
+ fn generic_new_document_preserves_typed_values_and_text_entry() {
+ for pages in [json!(2), json!(" 2 ")] {
+ let mut app = command_app(
+ "file.new",
+ json!({
+ "preset": "A4", "pages": pages, "facingPages": false, "gutter": 0,
+ "margins": {"top": 10, "bottom": 20, "inside": 30, "outside": 40},
+ "title": " ", "status": "internal", "primaryTextFrame": true
+ }),
+ );
+ confirm(&mut app).unwrap();
+ let doc = &app.session.active().unwrap().doc;
+ assert_eq!(doc.page_count(), 2);
+ assert!(!doc.settings.facing_pages);
+ assert!(doc.title.starts_with("Untitled-"));
+ for page in doc.spreads.iter().flat_map(|s| &s.pages) {
+ assert!((page.width - 595.2755905511812).abs() < 0.01);
+ assert!((page.height - 841.8897637795277).abs() < 0.01);
+ assert_eq!(page.columns.gutter, 0.0);
+ assert_eq!(page.margins.top, 10.0);
+ assert_eq!(page.margins.outside, 40.0);
+ }
+ assert!(doc.spreads.iter().all(|s| s.items.is_empty()), "undocumented fields stay excluded");
+ assert!(app.ui.dialog.is_none());
+ }
+ }
+
+ #[test]
+ fn generic_command_preserves_array_geometry() {
+ let mut app = command_app("file.new", json!({}));
+ confirm(&mut app).unwrap();
+ app.ui.dialog = Some(Dialog::new("cmd:frame.create", json!({"rect": [10, 20, 110, 220]})));
+ confirm(&mut app).unwrap();
+ let doc = &app.session.active().unwrap().doc;
+ let item = doc.spreads.iter().flat_map(|s| &s.items).next().unwrap();
+ assert_eq!(item.bounds(), designcraft_geom::Rect::new(10.0, 20.0, 110.0, 220.0));
+ }
+
+ #[test]
+ fn generic_explicit_null_uses_the_commands_existing_semantics() {
+ // file.new accepts null width by using the selected preset's width.
+ for width in [Value::Null, json!("null")] {
+ let mut app = command_app("file.new", json!({"preset": "A4", "width": width, "title": " Sample layout "}));
+ confirm(&mut app).unwrap();
+ let doc = &app.session.active().unwrap().doc;
+ assert_eq!(doc.title, "Sample layout");
+ assert!((doc.settings.page_width - 595.2755905511812).abs() < 0.01);
+ }
+ }
+
+ #[test]
+ fn generic_invalid_number_retains_dialog_without_creating_document() {
+ let mut app = command_app("file.new", json!({"width": 0}));
+ assert!(confirm(&mut app).is_err());
+ assert!(app.session.active().is_none());
+ let dialog = app.ui.dialog.as_ref().unwrap();
+ assert_eq!(dialog.fields["width"], 0);
+ assert!(dialog.fields["status"].as_str().unwrap().contains("page size out of range"));
+ }
+
#[test]
+ fn text_frame_options_change_only_what_was_edited() {
+ let mut app = crate::DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.run("file.new", json!({})).unwrap();
+ let r = app.run("frame.create", json!({"rect": [36, 36, 336, 236], "content": "text", "text": "Hello"})).unwrap();
+ let id = designcraft_doc::ItemId(r["id"].as_u64().unwrap());
+ app.run("object.textFrameOptions", json!({"ids": [id.0], "columns": 2, "inset": [1, 2, 3, 4]})).unwrap();
+ let opts = |app: &DesignApp| app.session.doc().unwrap().doc.item(id).unwrap().text_frame().unwrap().options.clone();
+ let before = opts(&app);
+ let open = |app: &mut DesignApp, fields: &[(&str, Value)]| {
+ app.ui.dialog = Some(Dialog::new("textFrameOptions", json!({})));
+ let mut d = app.ui.dialog.take().unwrap();
+ seed_text_frame_options(app, &mut d);
+ for (k, v) in fields {
+ d.fields.insert((*k).into(), v.clone());
+ }
+ app.ui.dialog = Some(d);
+ confirm(app)
+ };
+ // OK without edits changes nothing (no undo step either).
+ assert_eq!(open(&mut app, &[]).unwrap(), Value::Null);
+ assert_eq!(opts(&app), before);
+ // The rule's weight is in points; unequal insets the user didn't touch stay.
+ open(&mut app, &[("columnRule", json!(true)), ("columnRuleWeight", json!("6"))]).unwrap();
+ let o = opts(&app);
+ assert!(o.column_rule && o.column_rule_weight == 6.0, "{o:?}");
+ assert_eq!((o.inset, o.columns, o.gutter), (before.inset, before.columns, before.gutter));
+ // One of the rule's insets edited: the other rule settings stay.
+ open(&mut app, &[("columnRuleBottomInset", json!("0p9")), ("columnRuleTint", json!("40"))]).unwrap();
+ let o = opts(&app);
+ assert_eq!((o.column_rule_bottom_inset, o.column_rule_top_inset, o.column_rule_offset, o.column_rule_weight), (9.0, 0.0, 0.0, 6.0));
+ assert!((o.column_rule_tint - 0.4).abs() < 1e-6 && o.column_rule);
+ // One inset side edited: the others keep their values.
+ open(&mut app, &[("insetLeft", json!("1p0"))]).unwrap();
+ assert_eq!(opts(&app).inset, [1.0, 12.0, 3.0, 4.0]);
+ // An unknown swatch is an error and the dialog stays open.
+ let e = open(&mut app, &[("columnRuleColor", json!("Mauve"))]).unwrap_err();
+ assert!(e.contains("Mauve") && app.ui.dialog.is_some(), "{e}");
+ assert_eq!(opts(&app).column_rule_color, designcraft_color::swatch::BLACK);
+ // Each OK is one undo step.
+ for _ in 0..3 {
+ app.run("edit.undo", json!({})).unwrap();
+ }
+ assert_eq!(opts(&app), before);
+ }
+
+ fn dialog_context(language: &str) -> egui::Context {
+ let ctx = egui::Context::default();
+ crate::theme::install_fonts(&ctx, language);
+ crate::theme::apply(&ctx, &crate::theme::Tokens::for_brightness(crate::theme::Brightness::default()));
+ ctx
+ }
+
+ fn dialog_frame(app: &mut DesignApp, ctx: &egui::Context, screen: egui::Rect, events: Vec<egui::Event>) -> Vec<(String, egui::Rect, egui::Rect)> {
+ let time = ctx.input(|i| i.time) + 1.0 / 60.0;
+ let mut output = ctx.run_ui(egui::RawInput { screen_rect: Some(screen), time: Some(time), events, ..Default::default() }, |ui| {
+ show(app, ui.ctx());
+ });
+ output.textures_delta.clear();
+ fn collect(shape: &egui::Shape, clip: egui::Rect, labels: &mut Vec<(String, egui::Rect, egui::Rect)>) {
+ match shape {
+ egui::Shape::Text(t) => labels.push((t.galley.job.text.clone(), t.visual_bounding_rect(), clip)),
+ egui::Shape::Vec(shapes) => {
+ for s in shapes {
+ collect(s, clip, labels);
+ }
+ }
+ _ => {}
+ }
+ }
+ let mut labels = Vec::new();
+ for shape in output.shapes {
+ collect(&shape.shape, shape.clip_rect, &mut labels);
+ }
+ labels
+ }
+
+ fn visible_label(labels: &[(String, egui::Rect, egui::Rect)], screen: egui::Rect, expected: &str) -> egui::Rect {
+ let (_, rect, clip) = labels.iter().find(|(text, _, _)| text.trim() == expected).unwrap_or_else(|| panic!("{expected} is painted"));
+ assert!(screen.contains_rect(*rect), "{expected} must stay on screen: {rect:?}");
+ assert!(clip.contains_rect(*rect), "{expected} must not be clipped: {rect:?}, {clip:?}");
+ *rect
+ }
+
+ fn click_dialog(app: &mut DesignApp, ctx: &egui::Context, screen: egui::Rect, pos: egui::Pos2) {
+ for pressed in [true, false] {
+ dialog_frame(
+ app,
+ ctx,
+ screen,
+ vec![
+ egui::Event::PointerMoved(pos),
+ egui::Event::PointerButton { pos, button: egui::PointerButton::Primary, pressed, modifiers: egui::Modifiers::NONE },
+ ],
+ );
+ }
+ }
+
+ fn scroll_dialog(app: &mut DesignApp, ctx: &egui::Context, screen: egui::Rect, pos: egui::Pos2, delta: egui::Vec2) {
+ dialog_frame(
+ app,
+ ctx,
+ screen,
+ vec![
+ egui::Event::PointerMoved(pos),
+ egui::Event::MouseWheel { unit: egui::MouseWheelUnit::Point, delta, phase: egui::TouchPhase::Move, modifiers: egui::Modifiers::NONE },
+ ],
+ );
+ // Let smooth wheel scrolling and scrollbar visibility settle before clicking.
+ for _ in 0..30 {
+ dialog_frame(app, ctx, screen, vec![]);
+ }
+ }
+
+ #[test]
+ fn dialog_title_and_actions_fit_scaled_viewports() {
+ for language in ["en", "ar"] {
+ for size in [egui::vec2(1178.0, 814.0), egui::vec2(589.0, 407.0), egui::vec2(392.0, 271.0), egui::vec2(450.0, 280.0)] {
+ for (command, title) in [("app.preferences", "Preferences"), ("app.newDocumentDialog", "New Document")] {
+ let mut app = DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.ui.language = language.into();
+ app.run("file.new", json!({})).unwrap();
+ app.run(command, json!({})).unwrap();
+ let ctx = dialog_context(language);
+ let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, size);
+ for _ in 0..3 {
+ dialog_frame(&mut app, &ctx, screen, vec![]);
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ for expected in [title, "OK", "Cancel"] {
+ visible_label(&labels, screen, crate::i18n::tr(language, expected));
+ }
+ }
+ }
+ }
+ }
+
+ #[test]
+ fn preferences_sidebar_scroll_keeps_selected_options_visible() {
+ let mut app = DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.run("file.new", json!({})).unwrap();
+ app.run("app.preferences", json!({})).unwrap();
+ let ctx = dialog_context("en");
+ let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, egui::vec2(589.0, 407.0));
+ for _ in 0..3 {
+ dialog_frame(&mut app, &ctx, screen, vec![]);
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ let sidebar = visible_label(&labels, screen, "General").center();
+ assert!(
+ !labels.iter().any(|(text, rect, clip)| text == "File Handling" && clip.contains_rect(*rect)),
+ "last section starts below the sidebar"
+ );
+ scroll_dialog(&mut app, &ctx, screen, sidebar, egui::vec2(0.0, -600.0));
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ let files = visible_label(&labels, screen, "File Handling").center();
+ click_dialog(&mut app, &ctx, screen, files);
+ assert_eq!(app.ui.dialog.as_ref().unwrap().s("section"), "files");
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ for expected in ["Document Recovery Data", "Save recovery data every:", "OK", "Cancel"] {
+ visible_label(&labels, screen, expected);
+ }
+ }
+
+ #[test]
+ fn preferences_horizontal_scroll_reaches_clipped_options() {
+ let mut app = DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.run("app.preferences", json!({})).unwrap();
+ let ctx = dialog_context("en");
+ let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, egui::vec2(450.0, 280.0));
+ for _ in 0..3 {
+ dialog_frame(&mut app, &ctx, screen, vec![]);
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ let body = visible_label(&labels, screen, "When Scaling").center();
+ let option = "Absolute Numbering (instead of Section Numbering)";
+ let (_, rect, clip) = labels.iter().find(|(text, _, _)| text == option).unwrap();
+ assert!(rect.right() > clip.right(), "rightmost option starts horizontally clipped: {rect:?}, {clip:?}");
+ scroll_dialog(&mut app, &ctx, screen, body, egui::vec2(-600.0, 0.0));
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ for expected in [option, "Preferences", "OK", "Cancel"] {
+ visible_label(&labels, screen, expected);
+ }
+ click_dialog(&mut app, &ctx, screen, visible_label(&labels, screen, option).center());
+ assert!(app.ui.dialog.as_ref().unwrap().b("absolutePageNumbers"));
+ }
+
+ #[test]
+ fn new_document_vertical_scroll_reaches_last_field() {
+ let mut app = DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.run("app.newDocumentDialog", json!({})).unwrap();
+ let ctx = dialog_context("en");
+ let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, egui::vec2(392.0, 271.0));
+ for _ in 0..3 {
+ dialog_frame(&mut app, &ctx, screen, vec![]);
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ let body = visible_label(&labels, screen, "Width").center();
+ let (_, rect, clip) = labels.iter().find(|(text, _, _)| text == "Primary Text Frame").unwrap();
+ assert!(rect.bottom() > clip.bottom(), "last field starts vertically clipped");
+ scroll_dialog(&mut app, &ctx, screen, body, egui::vec2(0.0, -600.0));
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ for expected in ["Primary Text Frame", "New Document", "OK", "Cancel"] {
+ visible_label(&labels, screen, expected);
+ }
+ click_dialog(&mut app, &ctx, screen, visible_label(&labels, screen, "Primary Text Frame").center());
+ assert!(app.ui.dialog.as_ref().unwrap().b("primaryTextFrame"));
+ }
+
+ #[test]
+ fn arabic_new_document_leftmost_fields_remain_reachable() {
+ for size in [egui::vec2(392.0, 271.0), egui::vec2(450.0, 280.0)] {
+ let mut app = DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.ui.language = "ar".into();
+ app.run("app.newDocumentDialog", json!({})).unwrap();
+ let fields = [("height", "66p1"), ("gutter", "1p2"), ("marginBottom", "3p3"), ("marginOutside", "3p4")];
+ for (field, value) in fields {
+ app.ui.dialog.as_mut().unwrap().fields.insert(field.into(), json!(value));
+ }
+ let ctx = dialog_context("ar");
+ let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, size);
+ for _ in 0..3 {
+ dialog_frame(&mut app, &ctx, screen, vec![]);
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ for (_, value) in fields {
+ visible_label(&labels, screen, value);
+ }
+ let body = visible_label(&labels, screen, "66p1").center();
+ for x in [-600.0, 600.0] {
+ scroll_dialog(&mut app, &ctx, screen, body, egui::vec2(x, 0.0));
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ for (_, value) in fields {
+ visible_label(&labels, screen, value);
+ }
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ click_dialog(&mut app, &ctx, screen, visible_label(&labels, screen, "66p1").center());
+ dialog_frame(
+ &mut app,
+ &ctx,
+ screen,
+ vec![
+ egui::Event::Key {
+ key: egui::Key::A,
+ physical_key: None,
+ pressed: true,
+ repeat: false,
+ modifiers: egui::Modifiers { ctrl: true, command: true, ..Default::default() },
+ },
+ egui::Event::Text("88p8".into()),
+ ],
+ );
+ assert_eq!(app.ui.dialog.as_ref().unwrap().s("height"), "88p8", "leftmost numeric field accepts edits");
+ scroll_dialog(&mut app, &ctx, screen, body, egui::vec2(0.0, -600.0));
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ let label = crate::i18n::tr("ar", "Primary Text Frame");
+ click_dialog(&mut app, &ctx, screen, visible_label(&labels, screen, label).center());
+ assert!(app.ui.dialog.as_ref().unwrap().b("primaryTextFrame"), "leftmost checkbox remains clickable after scrolling");
+ }
+ }
+
+ #[test]
+ fn resized_dialogs_cancel_and_reopen_without_applying_edits() {
+ for (command, title, field) in [("app.preferences", "Preferences", "recoveryMinutes"), ("app.newDocumentDialog", "New Document", "pages")] {
+ let mut app = DesignApp::new(designcraft_engine::Session::new(), crate::Services::default());
+ app.run(command, json!({})).unwrap();
+ let original = app.ui.dialog.as_ref().unwrap().fields[field].clone();
+ app.ui.dialog.as_mut().unwrap().fields.insert(field.into(), json!(42));
+ let ctx = dialog_context("en");
+ for size in [egui::vec2(1178.0, 814.0), egui::vec2(392.0, 271.0), egui::vec2(589.0, 407.0)] {
+ let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, size);
+ for _ in 0..3 {
+ dialog_frame(&mut app, &ctx, screen, vec![]);
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ for expected in [title, "OK", "Cancel"] {
+ visible_label(&labels, screen, expected);
+ }
+ }
+ let screen = egui::Rect::from_min_size(egui::Pos2::ZERO, egui::vec2(589.0, 407.0));
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ click_dialog(&mut app, &ctx, screen, visible_label(&labels, screen, "Cancel").center());
+ assert!(app.ui.dialog.is_none());
+ assert!(app.session.active().is_none(), "cancelling must not create a document");
+ app.run(command, json!({})).unwrap();
+ assert_eq!(app.ui.dialog.as_ref().unwrap().fields[field], original, "cancelled edits must not survive reopening");
+ for _ in 0..3 {
+ dialog_frame(&mut app, &ctx, screen, vec![]);
+ }
+ let labels = dialog_frame(&mut app, &ctx, screen, vec![]);
+ visible_label(&labels, screen, title);
+ dialog_frame(
+ &mut app,
+ &ctx,
+ screen,
+ vec![egui::Event::Key { key: egui::Key::Escape, physical_key: None, pressed: true, repeat: false, modifiers: egui::Modifiers::NONE }],
+ );
+ assert!(app.ui.dialog.is_none(), "Escape must also close the reopened dialog");
+ }
+ }
+
+ #[test]
fn parses_command_params() {
let f = command_fields("{name, type: custom|lastPageNumber|chapterNumber, text?, rule?: {on, weight}, flag?: bool} — creates");
let keys: Vec<&str> = f.iter().map(|f| f.key.as_str()).collect();