From 56c1a1e5043027ef84ac9b7c46889ef37beb65d7 Mon Sep 17 00:00:00 2001 From: Eric Kaden <608341+EricKaden@users.noreply.github.com> Date: Sat, 24 Oct 2026 15:02:32 -0400 Subject: [PATCH] M6: an edit's XFA and field scripts share one field highlight --- crates/engine/src/lib.rs | 35 +++++++++++++++++++++++++++-------- crates/engine/src/tests.rs | 15 +++++++++++++++ 2 files changed, 42 insertions(+), 8 deletions(-) diff --git a/crates/engine/src/lib.rs b/crates/engine/src/lib.rs index 67083e1233..ae369c700f 100644 --- a/crates/engine/src/lib.rs +++ b/crates/engine/src/lib.rs @@ -2481,6 +2481,21 @@ struct EditCtx { } impl EditCtx { + /// The field highlight (`app.runtimeHighlight`) the edit's next script reads: the field + /// scripts' runner holds it while there is one (its scripts change it there), else the edit. + fn highlight(&self) -> bool { + self.js.as_ref().map_or(self.highlight, |js| js.doc.highlight) + } + + /// A script changed the field highlight: both script runtimes of the edit read the new one, + /// so a later edit of a batch sees it whichever kind of script it runs. + fn set_highlight(&mut self, on: bool) { + self.highlight = on; + if let Some(js) = self.js.as_mut() { + js.doc.highlight = on; + } + } + /// The context for one edit: `now` (the session's clock) dates it, and with `salt` seeds the /// ids it makes. fn new(now: Option, salt: u64) -> Self { @@ -2682,13 +2697,14 @@ fn run_edit(doc: &mut pdfcraft_cos::Document, edit: &Edit, cx: &mut EditCtx) -> }, Edit::XfaEvent { som, activity } => { let tpl = cx.xfa.clone().ok_or_else(|| EditError::Invalid("this is not a laid-out XFA form, or JavaScript is off".into()))?; - let mut run = - xfa::XfaRun { page_count: cx.pages, out: &mut cx.xfa_out, datasets: cx.xfa_datasets, ran_away: false, highlight: cx.highlight }; + let highlight = cx.highlight(); + let mut run = xfa::XfaRun { page_count: cx.pages, out: &mut cx.xfa_out, datasets: cx.xfa_datasets, ran_away: false, highlight }; let ran = xfa::on_event(doc, &tpl, som, activity, &mut run); cx.xfa_datasets = run.datasets; cx.xfa_ran_away |= run.ran_away; // The next edit of a batch reads the highlight this one's scripts set. - cx.highlight = run.highlight; + let on = run.highlight; + cx.set_highlight(on); ran.map_err(EditError::Invalid)?; } Edit::SetFieldImage { name, image } => { @@ -3481,13 +3497,15 @@ fn image_content_type(bytes: &[u8]) -> Option<&'static str> { /// fields take the data's values. fn xfa_after_data_change(doc: &mut pdfcraft_cos::Document, cx: &mut EditCtx, calculate: bool) -> Result<(), EditError> { if let Some(tpl) = cx.xfa.clone() { - let mut run = xfa::XfaRun { page_count: cx.pages, out: &mut cx.xfa_out, datasets: cx.xfa_datasets, ran_away: false, highlight: cx.highlight }; + let highlight = cx.highlight(); + let mut run = xfa::XfaRun { page_count: cx.pages, out: &mut cx.xfa_out, datasets: cx.xfa_datasets, ran_away: false, highlight }; let r = guard(|| xfa::on_data_replaced(doc, &tpl, calculate, &mut run)) .unwrap_or_else(|m| Err(format!("laying the form out again failed unexpectedly ({m})"))); cx.xfa_datasets = run.datasets; cx.xfa_ran_away |= run.ran_away; // The next edit of a batch reads the highlight this one's scripts set. - cx.highlight = run.highlight; + let on = run.highlight; + cx.set_highlight(on); if let Err(e) = r { cx.xfa_out.errors.push(e); } @@ -4067,8 +4085,8 @@ impl Session { let mut reset = false; collect(&edit, &mut changed, &mut reset); if !changed.is_empty() || reset { - let mut run = - xfa::XfaRun { page_count: cx.pages, out: &mut cx.xfa_out, datasets: cx.xfa_datasets, ran_away: false, highlight: cx.highlight }; + let highlight = cx.highlight(); + let mut run = xfa::XfaRun { page_count: cx.pages, out: &mut cx.xfa_out, datasets: cx.xfa_datasets, ran_away: false, highlight }; // Every changed field's scripts, then the calculations once (after a reset, // only those). let ran = guard(|| xfa::on_changes(&mut next, &tpl, &changed, &mut run)) @@ -4076,7 +4094,8 @@ impl Session { cx.xfa_datasets = run.datasets; cx.xfa_ran_away |= run.ran_away; // The next edit of a batch reads the highlight this one's scripts set. - cx.highlight = run.highlight; + let on = run.highlight; + cx.set_highlight(on); if let Err(e) = ran { cx.xfa_out.errors.push(e); } diff --git a/crates/engine/src/tests.rs b/crates/engine/src/tests.rs index 8b739e3056..9bef836122 100644 --- a/crates/engine/src/tests.rs +++ b/crates/engine/src/tests.rs @@ -8102,6 +8102,21 @@ fn a_forms_layout_ready_scripts_run_once_it_is_laid_out() { assert!(s.take_js_output(id).requests.is_empty()); } +/// An edit's two script runtimes share one field highlight: a change an XFA script makes reaches +/// the field scripts' runner, and one the field scripts make is what the next XFA script reads. +#[test] +fn an_edits_xfa_and_field_scripts_share_the_field_highlight() { + let cos = pdfcraft_cos::Document::open(Arc::new(fixture(1))).unwrap(); + let mut cx = EditCtx::new(None, 0); + cx.js = Some(js::JsRunner::new(&cos, "synthetic.pdf", false)); + cx.set_highlight(true); + assert!(cx.js.as_ref().is_some_and(|js| js.doc.highlight), "an XFA script's change reaches the field scripts"); + if let Some(js) = cx.js.as_mut() { + js.doc.highlight = false; + } + assert!(!cx.highlight(), "the next XFA script reads the field scripts' change"); +} + /// In a batch of XFA events, a later event's scripts read the field highlight an earlier one's set: /// `on`'s click turns it on, and `look`'s click, in the same batch, records what it reads. #[test]