2bc41aeb8602
save_pdf.rs
//! File → Save as PDF: the Save PDF dialog. Preset, Standard and Compatibility on top, then the
//! sections General, Compression, Marks and Bleeds, Output, Advanced, Security and Summary.
//!
//! The fields are the `document.exportPdf` options (sections are objects such as `compression`),
//! plus `preset`, `range`, `path?` and UI-only `__` keys, so agents fill the dialog with
//! `ui.dialog.set`. OK runs `document.exportPdf` through [`io::export_pdf`]; the Summary is
//! `document.pdfSettings`, and its Save Summary… writes it to a text file (`ui.pdfSummary.save`).
//! Save Preset… names the settings as a preset (`pdf.preset.save`).
//! Opened from Export As with Use Artboards off (`__artBounds`), the dialog has no Artboards
//! section, and OK writes one page of the visible art's bounds through [`io::export`]; opened
//! from Export Selection (`__selection` too), the page is the selection's crop. While Alt (Option
//! on macOS) is held, Cancel reads Reset, which puts the options back to the chosen preset's
//! settings and leaves the dialog open (`ui.dialogReset`).
//!
//! The same dialog edits a preset (kind `pdfPreset`, from Edit → PDF Presets): a `name` and
//! `description` instead of the preset and artboards, and OK saves the preset.
use std::sync::LazyLock;
use serde_json::{Map, Value, json};
use vectorcraft_doc::Unit;
use vectorcraft_engine::cmd::fileio::{SaveMode, pdf};
use vectorcraft_engine::cmd::{FlattenOptions, FlattenerPreset};
use vectorcraft_pdf::{
Changes, Choice, ColorConversion, Compatibility, Downsample, Encryption, ImageCodec, JpegQuality, MarkKind, MonoCodec, Overprint, PdfSettings,
Printing, ProfileInclusion, Standard,
};
use super::{DialogSpec, form};
use crate::state::Dialog;
use crate::theme::{self, Tokens};
use crate::{VectorcraftApp, io, widgets};
pub(super) const KIND: &str = "savePdf";
pub(super) const SPEC: DialogSpec = DialogSpec {
heading: |_| tl!("Save PDF").into(),
body,
confirm,
ok: Some("Save PDF"),
inputs: |_| &["path", "flattener"],
reset: Some(reset),
..DialogSpec::FORM
};
/// Custom Transparency Flattener Options, opened over Save PDF by Custom… beside Flattener preset.
pub(super) const CUSTOM_KIND: &str = "pdfFlattenerOptions";
pub(super) const CUSTOM_SPEC: DialogSpec = DialogSpec {
heading: |_| tl!("Custom Transparency Flattener Options").into(),
body: custom_body,
confirm: custom_confirm,
min_width: 420.0,
..DialogSpec::FORM
};
/// The dialog kind of the preset editor (New / Edit in Edit → PDF Presets).
pub(super) const PRESET_KIND: &str = "pdfPreset";
pub(super) const PRESET_SPEC: DialogSpec = DialogSpec {
heading: |d| if d.str(EDITING).is_empty() { tl!("New PDF Preset") } else { tl!("Edit PDF Preset") }.into(),
body,
confirm: confirm_preset,
ok: Some("Save Preset"),
..DialogSpec::FORM
};
/// The preset editor's field holding the name of the saved preset it edits (empty: a new one).
const EDITING: &str = "__editing";
/// Save PDF's field holding the name typed for Save Preset… (present while that row shows).
const SAVE_AS: &str = "__savePresetAs";
/// Save PDF's field that is true when the page is the bounds of the visible art (Export As with
/// Use Artboards off) instead of the artboards.
const ART_BOUNDS: &str = "__artBounds";
pub(super) const SECTIONS: [&str; 7] = ["General", "Compression", "Marks and Bleeds", "Output", "Advanced", "Security", "Summary"];
/// The default settings as JSON: what a field an agent left out reads as.
static DEFAULTS: LazyLock<Value> = LazyLock::new(|| serde_json::to_value(PdfSettings::default()).unwrap_or_default());
/// Is `name` a built-in PDF preset's? Those are ours (translated where listed); the saved ones are
/// names.
pub(super) fn is_builtin_preset(name: &str) -> bool {
static NAMES: LazyLock<Vec<String>> = LazyLock::new(|| vectorcraft_pdf::builtin_presets().into_iter().map(|p| p.name).collect());
NAMES.iter().any(|n| n == name)
}
/// Trim mark weights offered (pt).
const WEIGHTS: [f64; 3] = [0.125, 0.25, 0.5];
const WEIGHT_LABELS: [&str; 3] = ["0.125 pt", "0.25 pt", "0.5 pt"];
/// The Destination entry for the document's own profile (stored as "").
const DOCUMENT_PROFILE: &str = "Document profile";
/// The Output Intent Profile entry for no output intent (stored as "").
const NO_PROFILE: &str = "None";
/// That entry with a PDF/X standard, whose files always have an output intent.
const PDFX_INTENT: &str = "CMYK profile in effect";
pub(super) const LABEL_WIDTH: f32 = 150.0;
/// Width of the section list (its frame adds 6 px a side).
pub(super) const LIST_WIDTH: f32 = 150.0;
/// The top rows' labels end where the section content starts, so their dropdowns line up with it.
pub(super) const TOP_LABEL_WIDTH: f32 = LIST_WIDTH + 26.0;
/// Open the dialog with `params` (`document.exportPdf` options and `path?`) applied over their
/// preset. `useArtboards: false` makes the page the bounds of the visible art.
pub fn open(app: &mut VectorcraftApp, params: &Value) -> Result<Value, String> {
let art_bounds = match params.get("useArtboards") {
None | Some(Value::Null) => false,
Some(Value::Bool(b)) => !b,
Some(v) => return Err(format!("useArtboards must be true or false, not {v}")),
};
let mut fields = settings_fields(app, params)?;
// The PDF settings keep no flattener options: those asked for go over the flattener preset.
match params.get("flattener") {
None | Some(Value::Null) => {}
Some(f @ Value::Object(o)) => {
let known = serde_json::to_value(FlattenOptions::default()).unwrap_or_default();
if let Some(k) = o.keys().find(|k| known.get(k.as_str()).is_none()) {
return Err(format!("flattener.{k} is not a flattener option"));
}
FlattenOptions::for_export(None, Some(f), &[]).map_err(|e| format!("flattener: {e}"))?;
fields.insert("flattener".into(), f.clone());
}
Some(v) => return Err(format!("flattener must be an object of flattener options, not {v}")),
}
let s = |k: &str| params.get(k).and_then(Value::as_str);
fields.insert("preset".into(), json!(s("preset").unwrap_or(pdf::DEFAULT_PRESET)));
fields.insert("__presets".into(), json!(pdf::presets(&app.session)));
fields.insert("__section".into(), json!(SECTIONS[0]));
fields.insert("__allArtboards".into(), json!(s("range").is_none()));
fields.insert("range".into(), json!(s("range").unwrap_or("")));
if let Some(path) = s("path") {
fields.insert("path".into(), json!(path));
}
if art_bounds {
fields.insert(ART_BOUNDS.into(), json!(true));
}
app.ui.dialog = Some(Dialog { kind: KIND.into(), fields });
Ok(Value::Null)
}
/// The settings `params` ask for (their preset, built-in or saved, with their options applied) as
/// dialog fields. A standard the writer can't produce yet still shows (Save PDF then says so).
fn settings_fields(app: &VectorcraftApp, params: &Value) -> Result<Map<String, Value>, String> {
let settings = pdf::resolve("ui.savePdfDialog", params, &app.session.prefs.pdf_presets).map_err(|e| e.to_string())?;
match serde_json::to_value(&settings).map_err(|e| e.to_string())? {
Value::Object(mut fields) => {
// Serialization omits passwords from presets and summaries; the live dialog needs
// the validated passwords so confirming it still encrypts the PDF.
let security = fields.get_mut("security").and_then(Value::as_object_mut).ok_or("PDF security settings are not an object")?;
for (key, password) in
[("openPassword", settings.security.open_password), ("permissionsPassword", settings.security.permissions_password)]
{
if !password.is_empty() {
security.insert(key.into(), json!(password));
}
}
Ok(fields)
}
_ => Err("PDF settings are not an object".into()),
}
}
/// The `document.exportPdf` params the dialog stands for.
fn params(d: &Dialog) -> Value {
let mut p = form::params(d);
let art = d.bool(ART_BOUNDS);
if let Some(o) = p.as_object_mut() {
if art || d.bool("__allArtboards") || d.str("range").trim().is_empty() {
o.remove("range");
}
if art {
o.insert("useArtboards".into(), json!(false));
}
}
p
}
/// The field that holds why the last Save PDF failed, shown in the dialog (the status bar sits
/// behind it, #6861).
const ERROR: &str = "__error";
/// Save PDF: write the file (see [`write`]). When that fails the dialog stays open and says why,
/// under its sections, as well as in the status bar the dialog covers.
fn confirm(app: &mut VectorcraftApp, d: &Dialog) -> Result<Value, String> {
let r = write(app, d);
if let Some(open) = app.ui.dialog.as_mut().filter(|o| o.kind == d.kind) {
match &r {
Err(e) => {
open.fields.insert(ERROR.into(), json!(e));
}
Ok(_) => {
open.fields.remove(ERROR);
}
}
}
r
}
/// Write the file (a PDF copy, or the PDF a Save As / Save a Copy asked for, `__save`); the
/// dialog stays open when that fails (bad range, cancelled save…). While Save Preset… asks for a
/// name, OK (and Enter) saves the preset instead.
fn write(app: &mut VectorcraftApp, d: &Dialog) -> Result<Value, String> {
if d.fields.contains_key(SAVE_AS) {
let mut d = d.clone();
let r = save_preset(app, &mut d);
app.ui.dialog = Some(d);
return r;
}
let r = match SaveMode::of(&d.str("__save")) {
Some(mode) => io::save_pdf(app, mode, params(d)),
None if d.bool(ART_BOUNDS) => export_art(app, d),
None => io::export_pdf(app, params(d)),
};
// A question the write asked (replace the file the document was opened from?) stays open.
if r.is_ok() && app.ui.dialog.as_ref().is_some_and(|o| o.kind == KIND) {
app.ui.dialog = None;
}
r
}
/// A page of the art's bounds (Export As with Use Artboards off), or of the selection's crop
/// (Export Selection): written as Export As writes other formats ([`io::export`]), with the
/// dialog's options and a saved preset written out.
fn export_art(app: &mut VectorcraftApp, d: &Dialog) -> Result<Value, String> {
let mut p = params(d);
let path = p.as_object_mut().and_then(|o| o.remove("path")).and_then(|v| v.as_str().map(str::to_string));
let p = pdf::expand_preset(&app.session, "file.exportAs", &p).map_err(|e| e.to_string())?.into_owned();
io::export(app, Some("pdf"), path, &super::export_as::exported(d, p))
}
/// The settings as `pdf.preset.save` params (without the artboards and path).
fn preset_params(d: &Dialog) -> Value {
let mut p = form::params(d);
if let Some(o) = p.as_object_mut() {
for k in ["range", "path"] {
o.remove(k);
}
}
p
}
/// Save Preset…: save the settings under the typed name and pick that preset.
fn save_preset(app: &mut VectorcraftApp, d: &mut Dialog) -> Result<Value, String> {
let mut p = preset_params(d);
p["name"] = json!(d.str(SAVE_AS));
let r = app.run("pdf.preset.save", p)?;
d.fields.remove(SAVE_AS);
d.fields.insert("preset".into(), r["name"].clone());
d.fields.insert("__presets".into(), json!(pdf::presets(&app.session)));
Ok(r)
}
/// Open the preset editor on the saved preset `name`, or on a new preset starting from `preset`
/// (default: the app default).
pub fn open_preset(app: &mut VectorcraftApp, params: &Value) -> Result<Value, String> {
let s = |k: &str| params.get(k).and_then(Value::as_str);
let (base, name, description, editing) = match s("name") {
Some(name) => {
let p = app.session.prefs.pdf_presets.iter().find(|p| p.name.eq_ignore_ascii_case(name.trim()));
let p = p.ok_or_else(|| format!("no saved PDF preset named `{name}` (built-in presets are read-only: start a new one from them)"))?;
(p.name.clone(), p.name.clone(), p.description.clone(), p.name.clone())
}
None => (s("preset").unwrap_or(pdf::DEFAULT_PRESET).to_string(), app.session.new_pdf_preset_name(), String::new(), String::new()),
};
let mut fields = settings_fields(app, &json!({ "preset": base }))?;
fields.insert("name".into(), json!(name));
fields.insert("description".into(), json!(description));
fields.insert(EDITING.into(), json!(editing));
fields.insert("__section".into(), json!(SECTIONS[0]));
app.ui.dialog = Some(Dialog { kind: PRESET_KIND.into(), fields });
Ok(Value::Null)
}
/// Save Preset (the preset editor's OK): `pdf.preset.save`, then back to Edit → PDF Presets on it.
/// A new preset may not take the name of another one.
fn confirm_preset(app: &mut VectorcraftApp, d: &Dialog) -> Result<Value, String> {
let mut p = preset_params(d);
let (name, editing) = (d.str("name"), d.str(EDITING));
if editing.is_empty() {
if app.session.pdf_presets().iter().any(|q| q.name.eq_ignore_ascii_case(name.trim())) {
return Err(format!("a preset named `{}` exists", name.trim()));
}
} else {
p["name"] = json!(editing);
p["newName"] = json!(name);
}
let r = app.run("pdf.preset.save", p)?;
super::pdf_presets::open(app, r["name"].as_str());
Ok(r)
}
// ---------- fields by path (`compression.color.ppi`) ----------
fn lookup<'a>(m: &'a Map<String, Value>, path: &str) -> Option<&'a Value> {
let mut keys = path.split('.');
let first = m.get(keys.next()?)?;
keys.try_fold(first, |v, k| v.get(k))
}
/// The value at `path`: the dialog's, else the default of the settings it edits (the PDF
/// settings, or the print settings of the Print dialogs).
pub(super) fn get<'a>(d: &'a Dialog, path: &str) -> &'a Value {
let defaults = super::print::defaults(&d.kind).unwrap_or(&DEFAULTS);
lookup(&d.fields, path).or_else(|| defaults.as_object().and_then(|m| lookup(m, path))).unwrap_or(&Value::Null)
}
pub(super) fn set(d: &mut Dialog, path: &str, value: Value) {
let (parents, key) = path.rsplit_once('.').unwrap_or(("", path));
let mut map = &mut d.fields;
for k in parents.split('.').filter(|k| !k.is_empty()) {
let e = map.entry(k).or_insert(Value::Null);
if !e.is_object() {
*e = Value::Object(Map::new());
}
let Value::Object(m) = e else { return };
map = m;
}
map.insert(key.into(), value);
}
// ---------- widgets bound to a path ----------
pub(super) fn heading(ui: &mut egui::Ui, text: &str) {
let t = Tokens::get(ui.ctx());
ui.add_space(6.0);
ui.label(egui::RichText::new(text).font(theme::semibold(12.5)).color(t.text_strong));
ui.add_space(2.0);
}
pub(super) fn note(ui: &mut egui::Ui, text: &str) {
let t = Tokens::get(ui.ctx());
ui.label(egui::RichText::new(text).size(11.5).color(t.text_dim));
}
/// A labelled row.
pub(super) fn row(ui: &mut egui::Ui, label: &str, add: impl FnOnce(&mut egui::Ui)) {
row_with(ui, label, LABEL_WIDTH, add);
}
pub(super) fn row_with(ui: &mut egui::Ui, label: &str, width: f32, add: impl FnOnce(&mut egui::Ui)) {
let t = Tokens::get(ui.ctx());
ui.horizontal(|ui| {
let label_id = ui
.allocate_ui_with_layout(egui::vec2(width, 24.0), egui::Layout::left_to_right(egui::Align::Center), |ui| {
ui.set_min_width(width);
ui.label(egui::RichText::new(label).color(t.text)).id
})
.inner;
ui.label_inputs_by(label_id, add);
});
}
pub(super) fn flag(ui: &mut egui::Ui, d: &mut Dialog, path: &str, label: &str, enabled: bool) {
let on = get(d, path).as_bool().unwrap_or(false);
if widgets::check(ui, label, on, enabled) {
set(d, path, json!(!on));
}
}
/// The index in `T`'s choices of the value at `path`.
fn choice_index<T: Choice>(d: &Dialog, path: &str) -> Option<usize> {
get(d, path).as_str().and_then(|s| T::IDS.iter().position(|i| *i == s))
}
/// The choice at `path`.
pub(super) fn choice<T: Choice>(d: &Dialog, path: &str) -> Option<T> {
choice_index::<T>(d, path).and_then(|i| T::ALL.get(i).copied())
}
/// A dropdown of the choices `T` (options for which `enabled` is false are greyed).
pub(super) fn pick<T: Choice>(ui: &mut egui::Ui, d: &mut Dialog, path: &str, width: f32, enabled: impl Fn(T) -> bool) -> bool {
let current = choice_index::<T>(d, path);
let labels: Vec<_> = T::LABELS.iter().map(|label| choice_label(crate::i18n::current(), path, label)).collect();
let label = current.and_then(|i| labels.get(i)).copied().unwrap_or_default();
let chosen = widgets::dropdown_with(ui, path, label, &labels, width, |i| T::ALL.get(i).is_some_and(|c| enabled(*c)));
let Some(id) = chosen.and_then(|i| T::IDS.get(i)) else { return false };
set(d, path, json!(id));
true
}
/// [`pick`] with a first entry, `unset`, for a setting that isn't set: shown while the value at
/// `path` isn't one of the choices, and stored as [`vectorcraft_pdf::UNSET_CHOICE`] when chosen.
fn pick_or_unset<T: Choice>(ui: &mut egui::Ui, d: &mut Dialog, path: &str, width: f32, unset: &str) -> bool {
let current = choice_index::<T>(d, path).map_or(0, |i| i + 1);
let lang = crate::i18n::current();
let labels: Vec<&str> = std::iter::once(unset).chain(T::LABELS.iter().map(|label| choice_label(lang, path, label))).collect();
let label = labels.get(current).copied().unwrap_or(unset);
let Some(i) = widgets::dropdown_with(ui, path, label, &labels, width, |_| true) else { return false };
let id = i.checked_sub(1).and_then(|i| T::IDS.get(i)).copied().unwrap_or(vectorcraft_pdf::UNSET_CHOICE);
set(d, path, json!(id));
true
}
/// Printer mark styles use adjectives, separately from interface language names.
pub(super) fn choice_label<'a>(lang: crate::i18n::Lang, path: &str, label: &'a str) -> &'a str {
if path == "marks.kind" { crate::i18n::tr_ctx(lang, "mark-style", label) } else { crate::i18n::tr(lang, label) }
}
pub(super) fn number(ui: &mut egui::Ui, d: &mut Dialog, path: &str, suffix: &str, enabled: bool) {
let v = get(d, path).as_f64().unwrap_or(0.0);
ui.add_enabled_ui(enabled, |ui| {
if let Some(x) = widgets::plain_field(ui, path, v, suffix, 3, 64.0) {
set(d, path, json!(x));
}
});
}
/// A length in points, shown in the document's units.
pub(super) fn length(ui: &mut egui::Ui, d: &mut Dialog, path: &str, unit: Unit, enabled: bool) {
let v = get(d, path).as_f64();
ui.add_enabled_ui(enabled, |ui| {
if let Some(x) = widgets::num_field(ui, path, v, unit, 80.0) {
set(d, path, json!(x));
}
});
}
pub(super) fn text(ui: &mut egui::Ui, d: &mut Dialog, path: &str, enabled: bool) {
let mut s = get(d, path).as_str().unwrap_or_default().to_string();
if ui.add_enabled(enabled, egui::TextEdit::singleline(&mut s).align(egui::Align2::LEFT_CENTER).desired_width(240.0)).changed() {
set(d, path, json!(s));
}
}
// ---------- the dialog ----------
fn body(app: &mut VectorcraftApp, ui: &mut egui::Ui, d: &mut Dialog) -> bool {
let t = Tokens::get(ui.ctx());
let editor = d.kind == PRESET_KIND;
if editor {
row_with(ui, tl!("Preset name:"), TOP_LABEL_WIDTH, |ui| {
form::text_edit(ui, d, "name", 288.0);
});
} else {
preset_rows(app, ui, d);
}
row_with(ui, tl!("Standard:"), TOP_LABEL_WIDTH, |ui| {
let picked = pick::<Standard>(ui, d, "standard", 170.0, |_| true);
let standard = choice::<Standard>(d, "standard").unwrap_or_default();
if picked {
standard_chosen(d, standard);
}
ui.add_space(16.0);
ui.label(egui::RichText::new(tl!("Compatibility:")).color(t.text));
pick::<Compatibility>(ui, d, "compatibility", 110.0, |c| standard.allows(c));
});
ui.add_space(10.0);
let section = current_section(d, &SECTIONS);
ui.horizontal_top(|ui| {
section_frame(ui, |ui| section_list(ui, d, &SECTIONS, section));
ui.add_space(14.0);
ui.vertical(|ui| {
ui.set_width(500.0);
ui.label(egui::RichText::new(tl!(section)).font(theme::semibold(14.0)).color(t.text_strong));
let list_h = super::modal::list_height(ui, 360.0);
egui::ScrollArea::vertical().id_salt(("save-pdf", section)).max_height(list_h).auto_shrink([false, false]).show(ui, |ui| match section {
"Compression" => compression(ui, d),
"Marks and Bleeds" => marks_and_bleeds(app, ui, d),
"Output" => output(ui, d),
"Advanced" => advanced(app, ui, d),
"Security" => security(ui, d),
"Summary" => summary(app, ui, d),
_ => general(ui, d, editor),
});
if let Some(e) = d.fields.get(ERROR).and_then(Value::as_str) {
ui.add_space(6.0);
ui.label(egui::RichText::new(crate::i18n::message(crate::i18n::current(), e)).color(t.error));
}
});
});
false
}
/// The section `__section` names (default: the first).
pub(super) fn current_section(d: &Dialog, sections: &[&'static str]) -> &'static str {
sections.iter().copied().find(|s| *s == d.str("__section")).or_else(|| sections.first().copied()).unwrap_or_default()
}
/// The frame of the section list column, at least as tall as the section content.
pub(super) fn section_frame(ui: &mut egui::Ui, add: impl FnOnce(&mut egui::Ui)) {
let t = Tokens::get(ui.ctx());
egui::Frame::NONE.fill(t.panel_darker).corner_radius(egui::CornerRadius::same(4)).inner_margin(egui::Margin::same(6)).show(ui, |ui| {
ui.set_width(LIST_WIDTH);
ui.set_min_height(380.0);
ui.vertical(add);
});
}
/// The section list: clicking a section shows it (`__section`).
pub(super) fn section_list(ui: &mut egui::Ui, d: &mut Dialog, sections: &[&str], section: &str) {
let t = Tokens::get(ui.ctx());
ui.spacing_mut().item_spacing.y = 1.0;
for s in sections {
let sel = *s == section;
let label = egui::RichText::new(tl!(*s)).size(12.5).color(if sel { t.text_strong } else { t.text });
if ui.add(egui::Button::selectable(sel, label).min_size(egui::vec2(LIST_WIDTH - 12.0, 24.0))).clicked() {
d.fields.insert("__section".into(), json!(s));
}
}
}
/// What choosing `standard` changes: the compatibility, to its version unless it allows the one
/// chosen, and off what files of a standard can't have (editing data, passwords; layers in PDF/X-1a
/// and PDF/X-3). In PDF/X-3 and PDF/X-4, Profile inclusion goes back to unset: the picker is
/// disabled there, and `none` would write every CMYK color as DeviceCMYK.
fn standard_chosen(d: &mut Dialog, standard: Standard) {
if choice::<Compatibility>(d, "compatibility").is_some_and(|c| !standard.allows(c)) {
set(d, "compatibility", json!(standard.version().id()));
}
if standard != Standard::None {
set(d, "preserveEditing", json!(false));
for p in [OPEN_PASSWORD, PERMISSIONS_PASSWORD] {
set(d, p, json!(""));
}
}
if !standard.allows_layers() {
set(d, "createLayers", json!(false));
}
if standard.is_pdfx() && !standard.cmyk_only() {
set(d, "output.profiles", json!(vectorcraft_pdf::UNSET_CHOICE));
}
}
/// The Preset row (the presets, built-in and saved, and Save Preset…) and, while Save Preset…
/// asks for a name, the row taking it.
fn preset_rows(app: &mut VectorcraftApp, ui: &mut egui::Ui, d: &mut Dialog) {
row_with(ui, tl!("Preset:"), TOP_LABEL_WIDTH, |ui| {
let presets = pdf::presets(&app.session);
let names: Vec<&str> = presets.iter().map(String::as_str).collect();
// The built-in presets come first (translated); the saved ones are names.
let builtins = names.len().saturating_sub(app.session.prefs.pdf_presets.len());
let chosen = super::mixed_dropdown(ui, "pdf-preset", &d.str("preset"), &names, 300.0, |k| k < builtins)
.and_then(|i| names.get(i))
.map(|p| p.to_string());
if let Some(name) = chosen {
apply_preset(app, d, &name);
}
let asking = d.fields.contains_key(SAVE_AS);
if ui
.add_enabled_ui(!asking, |ui| widgets::flat_button(ui, tl!("Save Preset…"), 96.0))
.inner
.on_hover_text(tl!("Save these settings as a preset"))
.clicked()
{
d.fields.insert(SAVE_AS.into(), json!(app.session.new_pdf_preset_name()));
}
});
if d.fields.contains_key(SAVE_AS) {
row_with(ui, tl!("Save as preset:"), TOP_LABEL_WIDTH, |ui| {
form::text_edit(ui, d, SAVE_AS, 200.0);
if widgets::flat_button(ui, tl!("Save"), 52.0).clicked()
&& let Err(e) = save_preset(app, d)
{
app.status(e);
}
if widgets::flat_button(ui, tl!("Cancel"), 60.0).clicked() {
d.fields.remove(SAVE_AS);
}
});
// `pdf.preset.save` keeps `flattenerPreset` but not `flattener`.
if d.fields.contains_key("flattener") {
note(ui, tl!("The PDF preset keeps the flattener preset but not the Custom… settings."));
}
}
}
/// Replace the settings with preset `name`'s (the artboard choice and path stay).
fn apply_preset(app: &mut VectorcraftApp, d: &mut Dialog, name: &str) {
match settings_fields(app, &json!({ "preset": name })) {
Ok(settings) => {
replace_settings(d, settings);
d.fields.insert("preset".into(), json!(name));
}
Err(e) => app.status(e),
}
}
/// The UI-only fields that stand for options: the Security section's password checkboxes.
const OPTION_FLAGS: [&str; 2] = ["__requireOpenPassword", "__restrictPermissions"];
/// Replace every option with `settings` (from [`settings_fields`]), the password checkboxes
/// included, and let the bleed link follow the new values. The preset, the artboard choice, the
/// path and the other UI-only fields (the section, the Save Preset name) stay.
fn replace_settings(d: &mut Dialog, settings: Map<String, Value>) {
d.fields.retain(|k, _| {
matches!(k.as_str(), "preset" | "range" | "path") || (k.starts_with("__") && !OPTION_FLAGS.contains(&k.as_str()) && k != BLEED_LINKED)
});
d.fields.extend(settings);
}
/// Reset (Cancel with Alt or Option held): the options go back to the chosen preset's settings, as
/// choosing that preset sets them, and the dialog stays open. A preset that can no longer be found
/// (a saved one deleted while the dialog is open) is an error, and the dialog is left as it is.
fn reset(app: &VectorcraftApp, d: &mut Dialog) -> Result<(), String> {
let settings = settings_fields(app, &json!({ "preset": d.str("preset") }))?;
replace_settings(d, settings);
Ok(())
}
/// General: the options, then the artboards (Save PDF) or the description (preset editor).
fn general(ui: &mut egui::Ui, d: &mut Dialog, editor: bool) {
heading(ui, tl!("Options"));
let standard = choice::<Standard>(d, "standard").unwrap_or_default();
flag(ui, d, "preserveEditing", tl!("Preserve editing capabilities"), standard == Standard::None);
flag(ui, d, "thumbnails", tl!("Embed page thumbnails"), true);
flag(ui, d, "fastWebView", tl!("Optimize for fast web view"), true);
flag(ui, d, "viewAfterSaving", tl!("View PDF after saving"), true);
// PDF layers need PDF 1.5, and PDF/X-1a and PDF/X-3 have none.
let layers = standard.allows_layers() && choice::<Compatibility>(d, "compatibility").unwrap_or_default().has_layers();
flag(ui, d, "createLayers", tl!("Create PDF layers from layers and sublayers"), layers);
flag(ui, d, "includeNonPrinting", tl!("Include non-printing layers"), true);
// PDF/X files and PDF 1.3 and 1.4 files always write long pages in points, and PDF/A files
// keep the `UserUnit`.
let compatibility = choice::<Compatibility>(d, "compatibility").unwrap_or_default();
let scales = standard == Standard::None && !matches!(compatibility, Compatibility::Pdf13 | Compatibility::Pdf14);
flag(ui, d, "longPagesInPoints", tl!("Write pages longer than 200 in at full size in points"), scales);
if editor {
heading(ui, tl!("Description"));
if let Some(text) = widgets::text_field_named(ui, "pdf-preset-description", Some(tl!("Description")), Some(&d.str("description")), 460.0, 3) {
d.fields.insert("description".into(), json!(text));
}
return;
}
// A page of the art's bounds has no artboards to choose.
if d.bool(ART_BOUNDS) {
return;
}
heading(ui, tl!("Artboards"));
let mut all = d.bool("__allArtboards");
ui.horizontal(|ui| {
let changed = ui.radio_value(&mut all, true, tl!("All")).changed() | ui.radio_value(&mut all, false, tl!("Range:")).changed();
if changed {
d.fields.insert("__allArtboards".into(), json!(all));
}
let mut range = d.str("range");
if ui
.add_enabled(!all, egui::TextEdit::singleline(&mut range).align(egui::Align2::LEFT_CENTER).desired_width(140.0).hint_text("1-3, 5"))
.changed()
{
d.fields.insert("range".into(), json!(range));
}
});
}
fn image_rows(ui: &mut egui::Ui, d: &mut Dialog, key: &str, title: &str) {
heading(ui, title);
let base = format!("compression.{key}");
let on = get(d, &format!("{base}.downsample")) != Downsample::None.id();
ui.horizontal(|ui| {
pick::<Downsample>(ui, d, &format!("{base}.downsample"), 150.0, |_| true);
ui.label(tl!("to"));
let ppi = super::ppi_suffix();
number(ui, d, &format!("{base}.ppi"), &ppi, on);
ui.label(tl!("above"));
number(ui, d, &format!("{base}.abovePpi"), &ppi, on);
});
ui.horizontal(|ui| {
ui.label(tl!("Compression:"));
if key == "mono" {
pick::<MonoCodec>(ui, d, &format!("{base}.compression"), 150.0, |_| true);
} else {
pick::<ImageCodec>(ui, d, &format!("{base}.compression"), 120.0, |_| true);
let lossy = get(d, &format!("{base}.compression")).as_str().is_some_and(|c| c != ImageCodec::None.id() && c != ImageCodec::Zip.id());
ui.label(tl!("Quality:"));
ui.add_enabled_ui(lossy, |ui| {
pick::<JpegQuality>(ui, d, &format!("{base}.quality"), 110.0, |_| true);
});
}
});
}
fn compression(ui: &mut egui::Ui, d: &mut Dialog) {
image_rows(ui, d, "color", tl!("Color images"));
image_rows(ui, d, "gray", tl!("Grayscale images"));
image_rows(ui, d, "mono", tl!("Monochrome images"));
ui.add_space(8.0);
flag(ui, d, "compression.compressText", tl!("Compress text and line art"), true);
}
pub(super) fn marks_and_bleeds(app: &VectorcraftApp, ui: &mut egui::Ui, d: &mut Dialog) {
let unit = app.session.general_unit();
const MARKS: [(&str, &str); 4] = [
("marks.trim", "Trim marks"),
("marks.registration", "Registration marks"),
("marks.colorBars", "Color bars"),
("marks.pageInfo", "Page information"),
];
heading(ui, tl!("Marks"));
let all = MARKS.iter().all(|(p, _)| get(d, p).as_bool() == Some(true));
if widgets::check(ui, tl!("All printer's marks"), all, true) {
for (p, _) in MARKS {
set(d, p, json!(!all));
}
}
egui::Grid::new("pdf-marks").num_columns(2).spacing([24.0, 4.0]).show(ui, |ui| {
for pair in MARKS.chunks(2) {
for (p, label) in pair {
flag(ui, d, p, tl!(label), true);
}
ui.end_row();
}
});
row(ui, tl!("Printer mark type:"), |ui| {
pick::<MarkKind>(ui, d, "marks.kind", 130.0, |_| true);
});
row(ui, tl!("Trim mark weight:"), |ui| {
let w = get(d, "marks.weight").as_f64().unwrap_or(0.25);
let current =
WEIGHTS.iter().zip(WEIGHT_LABELS).find(|(x, _)| (*x - w).abs() < 1e-9).map_or_else(|| format!("{w} pt"), |(_, l)| l.to_string());
if let Some(x) = widgets::dropdown(ui, "marks.weight", ¤t, &WEIGHT_LABELS, 130.0).and_then(|i| WEIGHTS.get(i)) {
set(d, "marks.weight", json!(x));
}
});
row(ui, tl!("Offset:"), |ui| length(ui, d, "marks.offset", unit, true));
heading(ui, tl!("Bleeds"));
flag(ui, d, "bleed.useDocument", tl!("Use document bleed settings"), true);
// With the document's bleed the fields show it (Document Setup's `[top, bottom, left, right]`).
let document = (get(d, "bleed.useDocument").as_bool() == Some(true)).then(|| app.session.active().map_or([0.0; 4], |s| s.doc.setup.bleed));
// Save PDF and the PDF preset editor link the four sides; Print's Marks and Bleed doesn't.
let pdf = d.kind == KIND || d.kind == PRESET_KIND;
ui.horizontal(|ui| {
egui::Grid::new("pdf-bleed").num_columns(4).spacing([10.0, 6.0]).show(ui, |ui| {
for pair in [
[(0, "bleed.top", tl!("Top:")), (1, "bleed.bottom", tl!("Bottom:"))],
[(2, "bleed.left", tl!("Left:")), (3, "bleed.right", tl!("Right:"))],
] {
for (i, p, label) in pair {
ui.label(label);
match document {
Some(b) => {
ui.add_enabled_ui(false, |ui| widgets::num_field(ui, p, b.get(i).copied(), unit, 80.0));
}
None if pdf => {
if let Some(x) = widgets::num_field(ui, p, get(d, p).as_f64(), unit, 80.0) {
edit_bleed(d, i, x);
}
}
None => length(ui, d, p, unit, true),
}
}
ui.end_row();
}
});
if pdf {
let linked = bleed_linked(d);
let tip = if linked { tl!("Make the bleed values differ") } else { tl!("Make all bleed settings the same") };
// With the document's bleed the link is grayed out and keeps its state for the custom values.
let clicked = ui
.add_enabled_ui(document.is_none(), |ui| widgets::icon_button(ui, if linked { "link" } else { "link-2-off" }, tip, linked, 24.0))
.inner
.clicked();
if clicked {
link_bleed(d, !linked);
}
}
});
}
/// The custom bleed's sides in Save PDF and the PDF preset editor, `[top, bottom, left, right]`.
const BLEED_SIDES: [&str; 4] = ["bleed.top", "bleed.bottom", "bleed.left", "bleed.right"];
/// The field holding whether the link keeps the four custom bleed values the same. Without it,
/// the sides are linked when they are equal (a preset's, or ones `ui.dialog.set` set).
const BLEED_LINKED: &str = "__bleedLinked";
/// Whether the custom bleed's sides are linked.
fn bleed_linked(d: &Dialog) -> bool {
d.fields.get(BLEED_LINKED).and_then(Value::as_bool).unwrap_or_else(|| {
let top = get(d, BLEED_SIDES[0]).as_f64();
BLEED_SIDES[1..].iter().all(|p| get(d, p).as_f64() == top)
})
}
/// Link (every side takes the top's value) or unlink (the sides keep their values) the bleed.
fn link_bleed(d: &mut Dialog, on: bool) {
d.fields.insert(BLEED_LINKED.into(), json!(on));
if on {
let top = get(d, BLEED_SIDES[0]).as_f64().unwrap_or(0.0);
for p in &BLEED_SIDES[1..] {
set(d, p, json!(top));
}
}
}
/// Side `side` of the custom bleed was edited to `value`: linked, every side takes it. The link
/// keeps the state it had before the edit, so an unlinked edit that makes the sides equal leaves
/// it off.
fn edit_bleed(d: &mut Dialog, side: usize, value: f64) {
let linked = bleed_linked(d);
d.fields.insert(BLEED_LINKED.into(), json!(linked));
if linked {
for p in BLEED_SIDES {
set(d, p, json!(value));
}
} else if let Some(p) = BLEED_SIDES.get(side) {
set(d, p, json!(value));
}
}
/// `ui.dialog.set` set `field` of Save PDF or the PDF preset editor: `__bleedLinked` links or
/// unlinks the bleed as its button does, and must be true or false; every write of `bleed`, the
/// same values included, drops the link's state, so the link follows the values set. A flattener
/// preset set there drops the Custom… options, as choosing it in the dropdown does.
pub(super) fn field_set(d: &mut Dialog, field: &str) -> Result<(), String> {
match field {
BLEED_LINKED => match d.fields.get(BLEED_LINKED).cloned() {
Some(Value::Bool(on)) => {
link_bleed(d, on);
Ok(())
}
v => Err(format!("{BLEED_LINKED} must be true or false, not {}", v.unwrap_or(Value::Null))),
},
"bleed" => {
d.fields.remove(BLEED_LINKED);
Ok(())
}
"flattenerPreset" => {
d.fields.remove("flattener");
Ok(())
}
_ => Ok(()),
}
}
/// A dropdown of names such as colour profiles or flattener presets (`names`, the first one
/// standing for "" at `path`), showing the name at `path` (one that isn't among them too). The
/// first `builtins` entries are ours (translated); the others (profiles, saved presets) are names.
pub(super) fn profile_pick(ui: &mut egui::Ui, d: &mut Dialog, path: &str, names: &[&str], builtins: usize, enabled: bool) {
let blank = names.first().copied().unwrap_or_default();
let current = get(d, path).as_str().filter(|s| !s.is_empty()).unwrap_or(blank).to_string();
ui.add_enabled_ui(enabled, |ui| {
if let Some(i) = super::mixed_dropdown(ui, path, ¤t, names, 300.0, |k| k < builtins) {
set(d, path, json!(if i == 0 { "" } else { names.get(i).copied().unwrap_or_default() }));
}
});
}
fn output(ui: &mut egui::Ui, d: &mut Dialog) {
let profiles = vectorcraft_color::cms::profiles();
let names = |blank: &'static str| -> Vec<&str> { std::iter::once(blank).chain(profiles.iter().map(|p| p.name.as_str())).collect() };
let standard = choice::<Standard>(d, "standard").unwrap_or_default();
heading(ui, tl!("Color"));
row(ui, tl!("Color conversion:"), |ui| {
pick::<ColorConversion>(ui, d, "output.conversion", 300.0, |_| true);
});
// PDF/X-1a converts to CMYK even without a conversion.
let converting = get(d, "output.conversion") != ColorConversion::None.id() || standard.cmyk_only();
// The document's own profile (blank), the CMYK profile in effect, then every profile.
let destinations: Vec<&str> = std::iter::once(DOCUMENT_PROFILE)
.chain(std::iter::once(vectorcraft_pdf::DOCUMENT_CMYK))
.chain(profiles.iter().map(|p| p.name.as_str()))
.collect();
row(ui, tl!("Destination:"), |ui| profile_pick(ui, d, "output.destination", &destinations, 2, converting));
row(ui, tl!("Profile inclusion:"), |ui| {
// A standard decides whether colours are tagged. Not set, colors are untagged and gray and
// RGB images keep their profiles (shown as Default).
ui.add_enabled_ui(standard == Standard::None, |ui| pick_or_unset::<ProfileInclusion>(ui, d, "output.profiles", 300.0, tl!("Default")));
});
if standard.cmyk_only() {
note(ui, tl!("PDF/X-1a files are CMYK: every colour is converted to the destination (blank: the output intent's CMYK profile), untagged."));
} else if standard.is_pdfx() {
note(
ui,
tl!(
"Files of this standard tag their colors with ICC profiles, except CMYK colors in the output intent's profile, which are written as DeviceCMYK."
),
);
// A preset or the dialog's params can bring `none` with the standard; the picker can't change it.
if choice::<ProfileInclusion>(d, "output.profiles") == Some(ProfileInclusion::None) {
note(
ui,
tl!(
"With Don't include profiles and a CMYK output intent, every CMYK color is written as DeviceCMYK unless it is converted to a CMYK destination of another profile."
),
);
}
} else if standard != Standard::None {
note(ui, tl!("Files of this standard tag their colours with ICC profiles."));
}
heading(ui, tl!("Output Intent"));
// PDF/A files carry their own output intent; PDF/X files always have one.
let own = standard != Standard::PdfA2b;
let blank = if standard.is_pdfx() { PDFX_INTENT } else { NO_PROFILE };
row(ui, tl!("Output intent profile:"), |ui| profile_pick(ui, d, "output.outputIntent", &names(blank), 1, own));
for (p, label) in [
("output.outputCondition", tl!("Output condition:")),
("output.outputConditionId", tl!("Condition identifier:")),
("output.registry", tl!("Registry name:")),
] {
row(ui, label, |ui| text(ui, d, p, own));
}
flag(ui, d, "output.trapped", tl!("Mark as trapped"), own);
if !own {
note(ui, tl!("PDF/A files carry their own output intent."));
}
}
/// The name of the flattener preset Save PDF `d` flattens with: its `flattenerPreset` (High
/// Resolution when empty), a built-in one named by id (`high`) as its name.
fn flattener_name(d: &Dialog) -> String {
let name = get(d, "flattenerPreset").as_str().map(str::trim).filter(|n| !n.is_empty()).unwrap_or(pdf::DEFAULT_FLATTENER);
FlattenOptions::preset_label(&name.to_ascii_lowercase()).unwrap_or(name).to_string()
}
/// The flattener options Save PDF `d` flattens with: its preset, with the Custom… options over it.
fn flattener(d: &Dialog, saved: &[FlattenerPreset]) -> Result<FlattenOptions, String> {
FlattenOptions::for_export(Some(&flattener_name(d)), d.fields.get("flattener"), saved)
}
/// The switches the PDF 1.3 writer sets itself, which Custom Transparency Flattener Options show
/// but can't change: rasterized areas are always clipped to their regions and keep no alpha, and
/// overprints are kept only with Overprint set to Preserve.
const FIXED: [&str; 3] = ["clipComplexRegions", "preserveAlpha", "preserveOverprints"];
/// `o` as the PDF 1.3 writer flattens with it (see [`FIXED`]), for Save PDF `parent`.
fn as_written(o: &mut FlattenOptions, parent: &Dialog) {
o.clip_complex_regions = true;
o.preserve_alpha = false;
o.preserve_overprints &= choice::<Overprint>(parent, "advanced.overprint") != Some(Overprint::Discard);
}
/// Custom Transparency Flattener Options over Save PDF `parent`, on the options it flattens with
/// (the default preset's while those are not valid).
pub(super) fn over(parent: &Dialog, saved: &[FlattenerPreset]) -> Dialog {
let mut o = flattener(parent, saved).unwrap_or_else(|_| FlattenOptions::preset(pdf::DEFAULT_FLATTENER).unwrap_or_default());
let kept = o.preserve_overprints;
as_written(&mut o, parent);
let mut d = Dialog::new(CUSTOM_KIND, json!({}));
super::flatten::put_options(&mut d.fields, &o);
d.fields.insert(KEPT_OVERPRINTS.into(), json!(kept));
d.fields.insert(super::PARENT.into(), serde_json::to_value(parent).unwrap_or_default());
d
}
/// The `preserveOverprints` value of the options Custom Transparency Flattener Options opened on,
/// before Overprint applies to it.
const KEPT_OVERPRINTS: &str = "__keptOverprints";
/// The options Custom Transparency Flattener Options `d` holds.
fn custom_options(d: &Dialog) -> Result<FlattenOptions, String> {
FlattenOptions::from_params_with(&Value::Object(d.fields.clone()), &[])
}
/// The flattener options, with the switches of [`FIXED`] showing what the PDF 1.3 writer does.
fn custom_body(_app: &mut VectorcraftApp, ui: &mut egui::Ui, d: &mut Dialog) -> bool {
let current = custom_options(d);
// Values refused stay as entered, so that changing another option keeps them.
let (mut o, unread) = super::flatten::shown_options(&d.fields, ¤t);
if let Some(parent) = super::parent(d) {
as_written(&mut o, &parent);
}
super::flatten::fields_editor(ui, "pdf-flattener", &mut d.fields, &mut o, &unread, &FIXED);
if let Err(e) = ¤t {
ui.label(egui::RichText::new(e).color(Tokens::get(ui.ctx()).text_dim).size(11.5));
}
ui.add_space(8.0);
form::caption(ui, tl!("PDF 1.3 files clip rasterized areas to their regions, and Overprint sets whether overprints are kept."));
false
}
/// OK: Save PDF again, flattening with these options over its preset (High Resolution when a saved
/// preset was deleted meanwhile). Options equal to the preset's leave the preset alone; bad options
/// keep the dialog open.
fn custom_confirm(app: &mut VectorcraftApp, d: &Dialog) -> Result<Value, String> {
let mut o = custom_options(d)?;
let mut parent = super::parent(d).ok_or("the dialog it was opened over is no longer open")?;
let kept = d
.fields
.get(KEPT_OVERPRINTS)
.and_then(Value::as_bool)
.or_else(|| flattener(&parent, &app.session.prefs.flattener_presets).ok().map(|before| before.preserve_overprints));
let base = match FlattenOptions::find_preset(&flattener_name(&parent), &app.session.prefs.flattener_presets) {
Some(base) => base,
None => {
set(&mut parent, "flattenerPreset", json!(""));
FlattenOptions::preset(pdf::DEFAULT_FLATTENER).unwrap_or_default()
}
};
// The writer sets the first two itself, so they take the preset's values: options that
// otherwise match the preset leave its name showing. The writer keeps overprints only where the
// options and Overprint both keep them, so the options keep the value they opened with, even
// when their preset was deleted, changed or made again under its name meanwhile.
o.clip_complex_regions = base.clip_complex_regions;
o.preserve_alpha = base.preserve_alpha;
o.preserve_overprints = kept.unwrap_or(o.preserve_overprints);
if o == base {
parent.fields.remove("flattener");
} else {
parent.fields.insert("flattener".into(), serde_json::to_value(&o).map_err(|e| e.to_string())?);
}
app.ui.dialog = Some(parent);
Ok(Value::Null)
}
fn advanced(app: &VectorcraftApp, ui: &mut egui::Ui, d: &mut Dialog) {
heading(ui, tl!("Fonts"));
let outline = get(d, "advanced.outlineText").as_bool() == Some(true);
row(ui, tl!("Subset fonts below:"), |ui| {
number(ui, d, "advanced.fontSubsetPercent", "%", !outline);
ui.label(tl!("of characters used"));
});
flag(ui, d, "advanced.outlineText", tl!("Convert text to outlines"), true);
heading(ui, tl!("Overprint and Transparency Flattener"));
row(ui, tl!("Overprint:"), |ui| {
pick::<Overprint>(ui, d, "advanced.overprint", 130.0, |_| true);
});
// PDF 1.3 files (PDF/X-1a and PDF/X-3 ones too) have no transparency: it is flattened.
let flat = choice::<Compatibility>(d, "compatibility") == Some(Compatibility::Pdf13)
|| choice::<Standard>(d, "standard").is_some_and(Standard::flattens);
row(ui, tl!("Flattener preset:"), |ui| {
let presets = app.session.flattener_presets();
let saved = &app.session.prefs.flattener_presets;
// [Custom] while Custom… options differ from the preset's.
let current = flattener(d, saved).ok();
// The preset as the list names it: the export finds a name in any case.
let name = flattener_name(d);
let name = presets.iter().find(|p| p.name.eq_ignore_ascii_case(name.trim())).map_or(name.as_str(), |p| p.name.as_str());
let mut custom = false;
ui.add_enabled_ui(flat, |ui| {
if let Some(p) = super::flatten::preset_dropdown(ui, "flattenerPreset", &presets, name, current.as_ref(), 200.0) {
set(d, "flattenerPreset", json!(p.name));
d.fields.remove("flattener");
}
// PDF presets keep no custom flattener options, so the preset editor has no Custom….
custom = d.kind == KIND && widgets::flat_button_fit(ui, tl!("Custom…"), 72.0).clicked();
});
if custom {
*d = over(d, saved);
}
});
if flat {
let name = get(d, "flattenerPreset").as_str().map(str::trim).filter(|n| !n.is_empty()).unwrap_or(pdf::DEFAULT_FLATTENER);
let preset_opts = FlattenOptions::for_export(Some(name), d.fields.get("flattener"), &app.session.prefs.flattener_presets).unwrap_or_default();
let line_ppi = preset_opts.line_art_ppi.round() as u32;
let grad_ppi = preset_opts.gradient_ppi.round() as u32;
note(
ui,
&crate::i18n::fmt(
tl!("Raster resolution: {line_ppi} ppi line art and text, {grad_ppi} ppi gradient and mesh"),
&[("line_ppi", &line_ppi.to_string()), ("grad_ppi", &grad_ppi.to_string())],
),
);
note(ui, tl!("PDF 1.3 files have no transparency: the preset flattens it."));
}
}
/// The password fields (never stored in presets).
const OPEN_PASSWORD: &str = "security.openPassword";
const PERMISSIONS_PASSWORD: &str = "security.permissionsPassword";
/// A checkbox turning a password on (UI-only `flag`) or off (clearing it); checked while the
/// password is set. Returns whether the password applies.
fn password_check(ui: &mut egui::Ui, d: &mut Dialog, path: &str, flag: &str, label: &str, enabled: bool) -> bool {
let on = d.bool(flag) || get(d, path).as_str().is_some_and(|s| !s.is_empty());
if widgets::check(ui, label, on, enabled) {
d.fields.insert(flag.into(), json!(!on));
if on {
set(d, path, json!(""));
}
}
on && enabled
}
fn password_field(ui: &mut egui::Ui, d: &mut Dialog, path: &str, enabled: bool) {
let mut s = get(d, path).as_str().unwrap_or_default().to_string();
if ui.add_enabled(enabled, egui::TextEdit::singleline(&mut s).password(true).align(egui::Align2::LEFT_CENTER).desired_width(200.0)).changed() {
set(d, path, json!(s));
}
}
fn security(ui: &mut egui::Ui, d: &mut Dialog) {
let plain = choice::<Standard>(d, "standard").unwrap_or_default() == Standard::None;
if !plain {
note(ui, tl!("Files of a PDF standard can't be password-protected."));
}
heading(ui, tl!("Document open password"));
let open = password_check(ui, d, OPEN_PASSWORD, "__requireOpenPassword", tl!("Require a password to open the document"), plain);
row(ui, tl!("Open password:"), |ui| password_field(ui, d, OPEN_PASSWORD, open));
heading(ui, tl!("Permissions"));
let restrict = password_check(ui, d, PERMISSIONS_PASSWORD, "__restrictPermissions", tl!("Restrict printing, editing and other tasks"), plain);
row(ui, tl!("Permissions password:"), |ui| password_field(ui, d, PERMISSIONS_PASSWORD, restrict));
ui.add_enabled_ui(restrict, |ui| {
row(ui, tl!("Printing allowed:"), |ui| {
pick::<Printing>(ui, d, "security.printing", 260.0, |_| true);
});
row(ui, tl!("Changes allowed:"), |ui| {
pick::<Changes>(ui, d, "security.changes", 260.0, |_| true);
});
});
flag(ui, d, "security.copy", tl!("Enable copying of text, images and other content"), restrict);
let reader = tl!("Enable text access for screen readers");
if get(d, "security.copy").as_bool() == Some(true) {
// What can be copied can be read out.
widgets::check(ui, reader, true, false);
} else {
flag(ui, d, "security.screenReader", reader, restrict);
}
let compatibility = choice::<Compatibility>(d, "compatibility").unwrap_or_default();
flag(
ui,
d,
"security.plaintextMetadata",
tl!("Enable plaintext metadata"),
(open || restrict) && !matches!(compatibility, Compatibility::Pdf13 | Compatibility::Pdf14),
);
ui.add_space(6.0);
note(ui, &crate::i18n::fmt(tl!("Encryption: {name} (set by Compatibility)"), &[("name", Encryption::for_compatibility(compatibility).label())]));
}
/// The section a changed option belongs to (for the Summary's order).
pub(super) fn section_of(option: &str) -> usize {
match option.split('.').next().unwrap_or_default() {
"compression" => 1,
"marks" | "bleed" => 2,
"output" => 3,
"advanced" => 4,
"security" => 5,
_ => 0,
}
}
/// `compression.color.abovePpi` → "Compression › Color › Above Ppi": the section, then the keys
/// (without the section's own object), `thumbnails` → "General › Thumbnails".
pub(super) fn option_label(option: &str) -> String {
let section = SECTIONS.get(section_of(option)).copied().unwrap_or(SECTIONS[0]);
let mut keys = option.split('.').peekable();
keys.next_if(|k| k.eq_ignore_ascii_case(section));
std::iter::once(section.to_string()).chain(keys.map(|k| form::humanize(k).trim_end_matches(':').to_string())).collect::<Vec<_>>().join(" › ")
}
/// `document.pdfSettings` for the dialog with the document's warnings (an export in memory),
/// cached until a field, the document, the saved PDF or flattener presets, the loaded color
/// profiles or the available fonts change.
fn summary_of(app: &mut VectorcraftApp, ctx: &egui::Context, p: &Value) -> Result<Value, String> {
let (key, stamp) = summary_key(app, p);
if let Some((s, v)) = ctx.data(|m| m.get_temp::<(egui::Id, Result<Value, String>)>(key))
&& s == stamp
{
return v;
}
let v = summary_settings(app, p);
ctx.data_mut(|m| m.insert_temp(key, (stamp, v.clone())));
v
}
/// Where [`summary_of`] keeps the Summary, and the stamp of what it was computed for: the params
/// `p`, the active document and its revision, the saved PDF presets (which `preset` can name), the
/// saved flattener presets (which `flattenerPreset` can name), the loaded color profiles (which
/// `output.destination` and `output.outputIntent` can name) and the available fonts (which decide
/// what is embedded or outlined).
fn summary_key(app: &VectorcraftApp, p: &Value) -> (egui::Id, egui::Id) {
let document = app.session.active().map(|s| (s.uid, s.revision));
let prefs = &app.session.prefs;
let presets = serde_json::to_string(&(&prefs.pdf_presets, &prefs.flattener_presets)).unwrap_or_default();
let shared = (vectorcraft_color::cms::profiles_generation(), vectorcraft_text::FontDb::global().generation());
(egui::Id::unique("save-pdf-summary"), egui::Id::unique((p.to_string(), document, presets, shared)))
}
/// `document.pdfSettings` for the dialog's `document.exportPdf` params `p`, with the document's
/// warnings (an export in memory).
fn summary_settings(app: &mut VectorcraftApp, p: &Value) -> Result<Value, String> {
let mut q = p.clone();
q["includeDocument"] = json!(true);
app.session.execute("document.pdfSettings", &q).map_err(|e| e.to_string())
}
/// The `document.pdfSettings` params of the Summary: the dialog's export params, without the
/// preset editor's own `name` and `description`, which are not PDF options.
fn summary_params(d: &Dialog) -> Value {
let mut p = params(d);
if d.kind == PRESET_KIND
&& let Some(o) = p.as_object_mut()
{
o.remove("name");
o.remove("description");
}
p
}
fn summary(app: &mut VectorcraftApp, ui: &mut egui::Ui, d: &mut Dialog) {
let t = Tokens::get(ui.ctx());
let v = match summary_of(app, ui.ctx(), &summary_params(d)) {
Ok(v) => v,
Err(e) => {
heading(ui, tl!("Error"));
ui.label(egui::RichText::new(warning_line(crate::i18n::current(), &e)).color(t.text));
return;
}
};
heading(ui, tl!("Options"));
let changed = changed_options(&v);
if changed.is_empty() {
note(ui, &unchanged_line(d));
}
option_rows(ui, changed, option_label);
heading(ui, tl!("Warnings"));
warning_rows(ui, v["warnings"].as_array().map(Vec::as_slice).unwrap_or_default());
ui.add_space(8.0);
if widgets::secondary_button(ui, tl!("Save Summary…")).clicked() {
// The text of the Summary drawn now: saving it does not compute the settings again.
let text = summary_text(d, &v);
if let Err(e) = crate::picks::in_dialog(app, d, move |app, d| save_summary_from_dialog(app, d, &text)) {
app.status(e);
}
}
}
/// The changed options of `document.pdfSettings`'s reply `v`, in the order of the sections.
fn changed_options(v: &Value) -> Vec<&Value> {
let mut changed: Vec<&Value> = v["changed"].as_array().map(|a| a.iter().collect()).unwrap_or_default();
changed.sort_by_key(|c| section_of(c["option"].as_str().unwrap_or_default()));
changed
}
/// The Summary's line when no option differs from the preset.
fn unchanged_line(d: &Dialog) -> String {
let base = if d.kind == PRESET_KIND { pdf::DEFAULT_PRESET } else { tl!("the preset") };
crate::i18n::fmt(tl!("Every option matches {base}."), &[("base", base)])
}
/// The Summary of `document.pdfSettings`'s reply `v` as text, line for line as the section shows
/// it in the interface language: Options and each changed option (or the line saying none
/// changed), a blank line, then Warnings and each warning (or "None."). Lines end in LF, including
/// line breaks inside an option's value.
fn summary_text(d: &Dialog, v: &Value) -> String {
let lang = crate::i18n::current();
let mut lines = vec![tl!("Options").to_string()];
let changed = changed_options(v);
if changed.is_empty() {
lines.push(unchanged_line(d));
}
lines.extend(changed.into_iter().map(|c| option_line(c, option_label)));
lines.push(String::new());
lines.push(tl!("Warnings").to_string());
let warnings = v["warnings"].as_array().map(Vec::as_slice).unwrap_or_default();
if warnings.is_empty() {
lines.push(tl!("None.").to_string());
}
lines.extend(warnings.iter().map(|w| warning_line(lang, w.as_str().unwrap_or_default())));
let mut text = lines.join("\n").replace("\r\n", "\n").replace('\r', "\n");
text.push('\n');
text
}
/// The UI command that writes the Summary to a text file.
pub(crate) const SAVE_SUMMARY: &str = "ui.pdfSummary.save";
/// Is a dialog with the Summary open (Save PDF, or the preset editor)?
pub(crate) fn summary_open(app: &VectorcraftApp) -> bool {
app.ui.dialog.as_ref().is_some_and(|d| d.kind == KIND || d.kind == PRESET_KIND)
}
/// `ui.pdfSummary.save {path}`: write the open Save PDF dialog's (or preset editor's) Summary as
/// text to `path` (the web downloads it under the path's file name). The Summary the section last
/// drew for the same fields, document, saved PDF and flattener presets, loaded color profiles
/// and available fonts is used as it is; the settings are computed only when there is none. The dialog stays open and the document is not changed →
/// `{path, bytes}`. A missing, empty or non-string `path` is an error that writes nothing.
pub(crate) fn save_summary(app: &mut VectorcraftApp, p: &Value) -> Result<Value, String> {
let key = "path";
let path = match p.get(key) {
None | Some(Value::Null) => return Err("missing `path`".into()),
Some(Value::String(s)) if s.trim().is_empty() => return Err("path is empty".into()),
Some(Value::String(s)) => Some(s.clone()),
Some(_) => return Err(format!("`{key}` must be a string")),
};
let d = app.ui.dialog.clone().filter(|_| summary_open(app)).ok_or("the Save PDF dialog is not open")?;
let p = summary_params(&d);
let v = match app.ui_ctx.clone() {
Some(ctx) => summary_of(app, &ctx, &p),
None => summary_settings(app, &p),
}?;
write_summary(app, path, &summary_text(&d, &v))
}
/// Save Summary…: the Summary's `text` to a file picked in a save panel (the web downloads it). A
/// write that fails is told in a message over the dialog, which shows again when it closes; a
/// canceled panel writes nothing.
fn save_summary_from_dialog(app: &mut VectorcraftApp, d: &mut Dialog, text: &str) -> Result<(), String> {
let waiting = app.ui.told.len();
let r = write_summary(app, None, text);
// The message about a failed write: the open dialog when the panel answered after this frame,
// else waiting behind the dialog being drawn.
let told = app.ui.dialog.take_if(|t| t.kind == super::confirm::MESSAGE).or_else(|| {
(app.ui.told.len() > waiting && app.ui.told.last().is_some_and(|t| t.kind == super::confirm::MESSAGE)).then(|| app.ui.told.pop()).flatten()
});
if let Some(mut told) = told {
told.fields.insert(super::PARENT.into(), serde_json::to_value(&*d).unwrap_or_default());
*d = told;
}
match r {
Err(e) if e == "cancelled" => Ok(()),
r => r.map(|_| ()),
}
}
/// Write the Summary's `text` (UTF-8) to `path`, else to a picked `<document> PDF Summary.txt`
/// next to the document → `{path, bytes}`.
fn write_summary(app: &mut VectorcraftApp, path: Option<String>, text: &str) -> Result<Value, String> {
let title = app.session.active().map(|d| d.title()).unwrap_or_default();
let stem = std::path::Path::new(&title).file_stem().map_or_else(|| "Untitled".into(), |s| s.to_string_lossy().into_owned());
let path = io::write_named(app, path, &format!("{stem} PDF Summary.txt"), text.as_bytes())?;
app.status(format!("Saved {path}"));
Ok(json!({ "path": path, "bytes": text.len() }))
}
/// A Summary line per changed option (`{option, value}`), labelled by `label`.
pub(super) fn option_rows<'a>(ui: &mut egui::Ui, changed: impl IntoIterator<Item = &'a Value>, label: impl Fn(&str) -> String) {
let t = Tokens::get(ui.ctx());
for c in changed {
ui.label(egui::RichText::new(option_line(c, &label)).color(t.text));
}
}
/// The displayed value of the changed option `c` (`{option, value}`).
fn option_value(c: &Value) -> String {
match &c["value"] {
Value::Bool(b) => if *b { tl!("On") } else { tl!("Off") }.to_string(),
Value::String(s) if c["option"] == "marks.kind" => choice_label(crate::i18n::current(), "marks.kind", s).to_string(),
Value::String(s) => s.clone(),
other => other.to_string(),
}
}
/// The Summary's line for the changed option `c` (`{option, value}`), labeled by `label`, with the
/// colon the interface language writes.
fn option_line(c: &Value, label: impl Fn(&str) -> String) -> String {
format!("{} {}", crate::i18n::colon(&label(c["option"].as_str().unwrap_or_default())), option_value(c))
}
/// The Summary's warnings ("None." without any).
pub(super) fn warning_rows(ui: &mut egui::Ui, warnings: &[Value]) {
let t = Tokens::get(ui.ctx());
if warnings.is_empty() {
note(ui, tl!("None."));
}
for w in warnings {
ui.label(egui::RichText::new(warning_line(crate::i18n::current(), w.as_str().unwrap_or_default())).color(t.text));
}
}
/// One of the Summary's warnings or errors, in `lang` as far as its catalog has it.
pub(super) fn warning_line(lang: crate::i18n::Lang, w: &str) -> String {
format!("⚠ {}", crate::i18n::message(lang, w))
}
#[cfg(test)]
mod tests;
No file is open. Choose one in the tree, or press Ctrl+O (⌘O on a Mac) to find one by name.
Syntax highlighting could not load. The unmodified read-only text remains available above.