diff --git a/crates/engine/src/cmd/drawing_export.rs b/crates/engine/src/cmd/drawing_export.rs index 3d94a0f39..03ae56d8d 100644 --- a/crates/engine/src/cmd/drawing_export.rs +++ b/crates/engine/src/cmd/drawing_export.rs @@ -34,7 +34,7 @@ pub static COMMANDS: &[CommandSpec] = &[CommandSpec::new(CMD, "Export Sheet", cr .doc_only() .contract(&CONTRACT) .output(output_schema_for::) - .params("sheet: id or name; format?: svg (default) | png (dxf is not supported yet); path?: a file with the format's extension (else the reply holds the document: text for svg, base64 data for png, at most 64 MiB); png only: dpi?: 25 to 2400 (default the sheet's own), colour?: grey (default) | black_white | rgb | transparent; paper?: white (default) | blueprint | prussian_blue, whose png is rgb → {sheet, format, bytes, path | text | data, report: {widths_snapped, pieces_merged, pixels?: [width, height]}, views: [{view, status: drawn|placeholder|failed, reason?, stats?}]}. The sheet as drawing.scene draws it: its drawing border, each image on it, then each view's lines, then its title block's lines. Refused, naming them, while any view on the sheet failed or any image won't decode; a placeholder view draws nothing. No model is evaluated.")]; + .params("sheet: id or name; format?: svg (default) | png (dxf is not supported yet); path?: a file with the format's extension (else the reply holds the document: its text as svg, its base64 as data for png, at most 64 MiB); png only: dpi?: 25 to 2400 (default the sheet's own), colour?: grey (default) | black_white | rgb | transparent; paper?: white (default) | blueprint | prussian_blue, whose png is rgb → {sheet, format, bytes, path | svg | data, report: {widths_snapped, pieces_merged, pixels?: [width, height]}, views: [{view, status: drawn|placeholder|failed, reason?, stats?}]}. The sheet as drawing.scene draws it: its drawing border, each image on it, then each view's lines, then its title block's lines. Refused, naming them, while any view on the sheet failed or any image won't decode; a placeholder view draws nothing. No model is evaluated.")]; /// A document held for the reply, refused once it passes `limit` bytes: a larger one goes to a file. struct Held { @@ -118,7 +118,7 @@ fn export(s: &mut Session, p: &Value) -> Result { } }; let bytes = document.len(); - let (path, text, data) = match request.path { + let (path, svg, data) = match request.path { Some(path) => { // Checked again just before writing, as the view DXF does. solidcraft_io::vfs::check(&path).map_err(|e| EngineError::Other(e.to_string()))?; @@ -133,7 +133,7 @@ fn export(s: &mut Session, p: &Value) -> Result { format: request.format, bytes, path, - text, + svg, data, report: ExportReport { widths_snapped: grid.widths_snapped, pieces_merged: grid.pieces_merged, pixels }, views: built.views.into_iter().map(Into::into).collect(), diff --git a/crates/engine/src/cmd/drawing_export_tests.rs b/crates/engine/src/cmd/drawing_export_tests.rs index a766a49d2..d6bb7fb39 100644 --- a/crates/engine/src/cmd/drawing_export_tests.rs +++ b/crates/engine/src/cmd/drawing_export_tests.rs @@ -46,7 +46,7 @@ fn a_sheet_exports_as_its_scenes_svg() { let schema = output_schema_for::(); assert!(conforms(schema.as_value(), schema.as_value(), &reply), "{reply}"); let svg = scene_svg(&s, sheet); - assert_eq!(reply["text"].as_str().map(str::as_bytes), Some(svg.as_slice())); + assert_eq!(reply["svg"].as_str().map(str::as_bytes), Some(svg.as_slice())); assert_eq!((&reply["format"], reply["bytes"].as_u64(), reply.get("path")), (&json!("svg"), Some(svg.len() as u64), None), "{reply}"); // Each view on the sheet, in id order, as drawing.scene lists them. let views: Vec<_> = reply["views"].as_array().unwrap().iter().map(|v| (v["view"].clone(), v["status"].clone())).collect(); @@ -54,15 +54,15 @@ fn a_sheet_exports_as_its_scenes_svg() { in_order.sort_unstable(); assert_eq!(views, in_order.map(|v| (json!(ids::encode(v)), json!("drawn")))); let name = s.drawing("test").unwrap().sheets[0].name.clone(); - assert_eq!(run(&mut s, CMD, json!({"sheet": name, "format": "svg"}))["text"], reply["text"]); + assert_eq!(run(&mut s, CMD, json!({"sheet": name, "format": "svg"}))["svg"], reply["svg"]); assert!(std::sync::Arc::ptr_eq(&doc, &s.doc) && s.evaluations == evaluations); // The sheet named, not the first: a second sheet, with no views, exports as its own scene. let added = run(&mut s, "drawing.sheet.add", json!({})); let second = ids::decode(added["sheet"].as_str().unwrap()).unwrap(); let other = run(&mut s, CMD, json!({"sheet": ids::encode(second)})); assert_eq!((&other["sheet"], other["views"].as_array().map(Vec::len)), (&json!(ids::encode(second)), Some(0)), "{other}"); - assert_eq!(other["text"].as_str().map(str::as_bytes), Some(scene_svg(&s, second).as_slice())); - assert_ne!(other["text"], reply["text"]); + assert_eq!(other["svg"].as_str().map(str::as_bytes), Some(scene_svg(&s, second).as_slice())); + assert_ne!(other["svg"], reply["svg"]); } /// With a path the file holds the same SVG and the reply names it instead. @@ -75,7 +75,7 @@ fn a_path_gets_the_svg_written_to_it() { let written = std::fs::read(&path).unwrap(); assert_eq!(written, scene_svg(&s, sheet)); assert_eq!( - (reply["path"].as_str(), reply.get("text"), reply["bytes"].as_u64()), + (reply["path"].as_str(), reply.get("svg"), reply["bytes"].as_u64()), (Some(path.as_str()), None, Some(written.len() as u64)), "{reply}" ); @@ -119,7 +119,7 @@ fn a_failed_view_is_named_and_nothing_is_written() { let reply = run(&mut s, CMD, json!({"sheet": ids::encode(sheet)})); let statuses: Vec<_> = reply["views"].as_array().unwrap().iter().map(|v| v["status"].clone()).collect(); assert_eq!(statuses, [json!("placeholder"), json!("placeholder")], "{reply}"); - assert_eq!(reply["text"].as_str().map(str::as_bytes), Some(scene_svg(&s, sheet).as_slice())); + assert_eq!(reply["svg"].as_str().map(str::as_bytes), Some(scene_svg(&s, sheet).as_slice())); } /// A sheet exports as its scene's PNG, byte for byte: in the reply as base64 data, grey at the @@ -137,7 +137,7 @@ fn a_sheet_exports_as_its_scenes_png() { let png = scene_png(&s, sheet, PngOptions::default()); assert_eq!(reply["data"].as_str().and_then(base64_decode), Some(png.clone())); assert_eq!((reply["bytes"].as_u64(), &reply["report"]["pixels"]), (Some(png.len() as u64), &json!([4961, 3508])), "{reply}"); - assert_eq!((reply.get("text"), reply.get("path"), &reply["format"]), (None, None, &json!("png"))); + assert_eq!((reply.get("svg"), reply.get("path"), &reply["format"]), (None, None, &json!("png"))); run(&mut s, "drawing.sheet.set", json!({"sheet": id, "dpi": 50})); let reply = run(&mut s, CMD, json!({"sheet": id, "format": "png"})); let png = scene_png(&s, sheet, PngOptions { dpi: 50.0, colour: PngColour::Grey }); @@ -167,7 +167,7 @@ fn a_sheet_exports_on_its_paper() { let data = |reply: Value| reply["data"].as_str().and_then(base64_decode).unwrap(); let plain = scene_svg(&s, sheet); let reply = run(&mut s, CMD, json!({"sheet": id, "paper": "white"})); - assert_eq!(reply["text"].as_str().map(str::as_bytes), Some(plain.as_slice())); + assert_eq!(reply["svg"].as_str().map(str::as_bytes), Some(plain.as_slice())); for colour in [json!({}), json!({"colour": "rgb"}), json!({"colour": "grey"}), json!({"colour": "black_white"}), json!({"colour": "transparent"})] { let mut asked = json!({"sheet": id, "format": "png", "dpi": 25}); @@ -178,7 +178,7 @@ fn a_sheet_exports_on_its_paper() { } for (name, paper, hex) in [("blueprint", PaperColour::Blueprint, "#123A76"), ("prussian_blue", PaperColour::PrussianBlue, "#003153")] { let reply = run(&mut s, CMD, json!({"sheet": id, "paper": name})); - let text = reply["text"].as_str().unwrap(); + let text = reply["svg"].as_str().unwrap(); assert!(text.contains(&format!("fill=\"{hex}\"")) && text.contains("stroke=\"#E2EEFC\"") && !text.contains("#000"), "{name}"); let png = scene_png(&s, sheet, PngOptions { dpi: 25.0, colour: PngColour::On(paper) }); assert_eq!(data(run(&mut s, CMD, json!({"sheet": id, "format": "png", "dpi": 25, "paper": name}))), png, "{name}"); @@ -258,13 +258,13 @@ fn a_shaded_view_exports_its_picture() { let (mut s, sheet, [front, _]) = front_and_top(); let png = |s: &mut Session| run(s, CMD, json!({"sheet": ids::encode(sheet), "format": "png", "dpi": 25}))["data"].clone(); let lines_only = png(&mut s); - let plain = run(&mut s, CMD, json!({"sheet": ids::encode(sheet)}))["text"].as_str().unwrap().to_owned(); + let plain = run(&mut s, CMD, json!({"sheet": ids::encode(sheet)}))["svg"].as_str().unwrap().to_owned(); assert!(!plain.contains(", - /// The document when no path was given and it is text (SVG). + /// The SVG's text when no path was given. #[serde(skip_serializing_if = "Option::is_none")] - pub text: Option, + pub svg: Option, /// The document as base64 when no path was given and it is binary (PNG). #[serde(skip_serializing_if = "Option::is_none")] pub data: Option,