Files
vectorcraft/crates/ui-egui/src/addons/document.rs
T
Don Omondi 33b57fb581 Batch Trace Folder: move to Object › Plug-ins as an add-on
Batch Trace Folder replaces a script, so it is now a Document Tools
add-on command, addon.document.batchTraceFolder, under Object ›
Plug-ins › Document Tools (as Export All Open Documents is), and no
longer in Object › Image Trace. Behaviour, caps and the refusal of a
folder too big to list in full are unchanged; the tests move with it.

The status messages have @msgplural rows in every catalog, as does the
menu label. When some images trace and some don't, the status is one
counted message ("Traced {n} images; not traced: {failed}") so it
translates as a whole.
2026-11-04 20:12:07 +07:00

98 lines
4.9 KiB
Rust
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//! Document Tools in the interface: its submenu (Object › Plug-ins › Document Tools), which runs
//! Save a Timestamped Copy, New Symbols from Layers and Convert Layers to Symbols (the same, with
//! each layer's art replaced by an instance). Save a Timestamped Copy of a document never saved
//! asks for the folder to put it in ([`save_copy`]). Export All Open Documents as PDF or SVG asks
//! for the folder the copies go in ([`export_all`], #4920). Batch Trace Folder asks for the folder of
//! images and then the folder the results go in ([`batch_trace`], #4921).
use serde_json::{Value, json};
use crate::VectorcraftApp;
use crate::menus::Item;
/// Save a Timestamped Copy.
pub const SAVE_COPY: &str = "addon.document.saveTimestampedCopy";
/// Export All Open Documents.
pub const EXPORT_ALL: &str = "addon.document.exportAllOpen";
/// Batch Trace Folder.
pub const BATCH_TRACE: &str = "addon.document.batchTraceFolder";
/// New Symbols from Layers (Convert Layers to Symbols: with their art replaced by instances).
const SYMBOLS: &str = "addon.document.symbolsFromLayers";
/// Object › Plug-ins › Document Tools.
pub fn menu() -> Vec<Item> {
vec![
Item::Cmd("Save a Timestamped Copy", SAVE_COPY, json!({})),
Item::Cmd("Export All Open Documents as PDF", EXPORT_ALL, json!({ "format": "pdf" })),
Item::Cmd("Export All Open Documents as SVG", EXPORT_ALL, json!({ "format": "svg" })),
Item::Cmd("Batch Trace Folder", BATCH_TRACE, json!({})),
Item::Sep,
Item::Cmd("New Symbols from Layers", SYMBOLS, json!({})),
Item::Cmd("Convert Layers to Symbols", SYMBOLS, json!({ "replace": true })),
]
}
/// Save a Timestamped Copy with params `p`: a document never saved, given no `folder`, goes in the
/// folder picked. The status bar says where the copy went.
pub(crate) fn save_copy(app: &mut VectorcraftApp, p: &Value) -> Result<Value, String> {
let mut p = if p.is_object() { p.clone() } else { json!({}) };
if p.get("folder").is_none() && app.session.active().is_some_and(|st| st.path.is_none()) {
p["folder"] = json!(crate::picks::folder(app).ok_or("cancelled")?);
}
let r = app.session.execute(SAVE_COPY, &p).map_err(|e| e.to_string())?;
crate::io::report_saved(app, r["path"].as_str().unwrap_or_default(), &r);
Ok(r)
}
/// Export All Open Documents with params `p`: without a `folder`, the copies go in the folder
/// picked. The status bar says how many were written and names the first that failed.
pub(crate) fn export_all(app: &mut VectorcraftApp, p: &Value) -> Result<Value, String> {
let mut p = if p.is_object() { p.clone() } else { json!({}) };
if p.get("folder").is_none() {
p["folder"] = json!(crate::picks::folder(app).ok_or("cancelled")?);
}
let r = app.session.execute(EXPORT_ALL, &p).map_err(|e| e.to_string())?;
let written = r["files"].as_array().map_or(0, Vec::len);
let failed = r["failed"].as_array().cloned().unwrap_or_default();
let status = match failed.first() {
Some(f) => {
let args = [("title", f["title"].as_str().unwrap_or_default()), ("error", f["error"].as_str().unwrap_or_default())];
let (one, other) = ("Exported {n} document; {title} wasn't written: {error}", "Exported {n} documents; {title} wasn't written: {error}");
crate::i18n::msg_n(written as u64, one, other, &args)
}
None => crate::i18n::msg_n(written as u64, "Exported {n} document", "Exported {n} documents", &[]),
};
app.status(status);
Ok(r)
}
/// Batch Trace Folder with params `p`: the folder of images and then the folder the results go in
/// are asked for when not given. The status bar says how many images were traced and how many
/// couldn't be.
pub(crate) fn batch_trace(app: &mut VectorcraftApp, p: &Value) -> Result<Value, String> {
let mut p = if p.is_object() { p.clone() } else { json!({}) };
for key in ["folder", "destinationFolder"] {
if p.get(key).is_none() {
p[key] = json!(crate::picks::folder(app).ok_or("cancelled")?);
}
}
let r = app.session.execute(BATCH_TRACE, &p).map_err(|e| e.to_string())?;
let traced = r["traced"].as_array().map_or(0, Vec::len) as u64;
let failed = r["failed"].as_array().map_or(0, Vec::len) as u64;
// One count per message: a count inside another counted message would read as the wrong
// template when the status is translated.
let status = if failed == 0 {
crate::i18n::msg_n(traced, "Traced {n} image", "Traced {n} images", &[])
} else if traced == 0 {
crate::i18n::msg_n(failed, "{n} image couldn't be traced", "{n} images couldn't be traced", &[])
} else {
let failed = failed.to_string();
crate::i18n::msg_n(traced, "Traced {n} image; not traced: {failed}", "Traced {n} images; not traced: {failed}", &[("failed", &failed)])
};
app.status(status);
Ok(r)
}
#[cfg(test)]
mod tests;