mirror of
https://github.com/storytold/pdfcraft.git
synced 2026-11-13 09:51:22 +00:00
Merge remote-tracking branch 'upstream/main' into fix/xfa-relevant-print
This commit is contained in:
commit
df05fd2ec9
16 files changed
+586
-9
No files matched your search
@@ -199,6 +199,8 @@ Ranked; detail and the full milestone table in [docs/roadmap.md](docs/roadmap.md
|
||||
|
||||
## Progress log
|
||||
|
||||
- **2026-10-24 (M14, #4253):** The annotation quick bar remembers Keep tool selected across restarts, including unpinning. Old and malformed settings keep safe defaults; the opt-in UI control channel reads and changes the same preference. Estimates unchanged.
|
||||
|
||||
- **2026-10-23 (M7, #4280):** Edit text names each standard stand-in font after its face (`PCEdTimesBold`, ...) instead of one shared `PCEdHelv`. Rewriting a bold paragraph whose subset lacks an accent no longer repoints the paragraphs set earlier in a regular stand-in at Times-Bold, and the editor's frame stays on the paragraph being edited. Pages saved by older builds keep their shared name and are not repaired. Estimates unchanged.
|
||||
- **2026-10-23 (M8, #3205 follow-up):** Phone-pattern redaction matches complete labelled Italian geographic numbers such as `Tel. +39 0426/123456`, with synthetic matcher and mark/apply/save/reopen coverage; unlabelled international slash numbers remain unsupported.
|
||||
- **2026-10-23 (M7, #2636 partial):** A new `PasteContent` edit pastes an added text box or image copied in the same document or another, keeping its style, picture, turns, flips and crop, as one undo step; `content_copy` drives it headlessly. A paste lands beside earlier copies (18 pt steps) and stays on the page. A pasted image reuses its picture object in its own document and after the first paste into another; there a colour profile is dropped and CMYK colours stored losslessly are turned to RGB. The desktop keys and menus follow in separate PRs. Estimates unchanged.
|
||||
|
||||
@@ -8911,6 +8911,34 @@ fn bookmark_list_reports_colour_and_style() {
|
||||
assert_eq!(style(&ok(&mut b, "bookmark_list", json!({ "doc": re }))["bookmarks"]), style(&set), "saved");
|
||||
}
|
||||
|
||||
/// An editable combo box (ISO 32000-2 Table 233, Edit) takes a value that isn't one of its
|
||||
/// options, and its page appearance shows it, before and after a save; one without Edit takes
|
||||
/// only its options.
|
||||
#[test]
|
||||
fn form_fill_takes_free_text_only_in_an_editable_combo_box() {
|
||||
let dir = workdir("editable-combo");
|
||||
let mut a = auto(&dir);
|
||||
let doc = ok(&mut a, "doc_open", json!({ "path": "a.pdf" }))["doc"].as_u64().unwrap();
|
||||
let combo = |name: &str, top: f64, editable: bool| json!({ "doc": doc, "page": 1, "type": "combo", "rect": [20, top, 200, top + 22.0], "name": name, "options": ["Apple", "Banana"], "editable": editable });
|
||||
ok(&mut a, "form_add_field", combo("fruit", 20.0, true));
|
||||
ok(&mut a, "form_add_field", combo("veg", 60.0, false));
|
||||
ok(&mut a, "form_fill", json!({ "doc": doc, "values": { "fruit": "Cherry" } }));
|
||||
assert!(page_text(&mut a, doc)[0].contains("Cherry"), "the typed value is drawn");
|
||||
let refused = err(&mut a, "form_fill", json!({ "doc": doc, "values": { "veg": "Cherry" } }));
|
||||
assert!(matches!(&refused, ToolError::Failed(m) | ToolError::InvalidArgs(m) if m.contains("no option")), "{refused:?}");
|
||||
// A choice from the list still works in both.
|
||||
ok(&mut a, "form_fill", json!({ "doc": doc, "values": { "veg": "Banana" } }));
|
||||
ok(&mut a, "doc_save", json!({ "doc": doc, "path": "filled.pdf" }));
|
||||
let saved = ok(&mut a, "doc_open", json!({ "path": "filled.pdf" }))["doc"].as_u64().unwrap();
|
||||
let fields = ok(&mut a, "form_fields", json!({ "doc": saved }));
|
||||
let value = |name: &str| fields["fields"].as_array().unwrap().iter().find(|f| f["name"] == name).map(|f| f["value"].clone());
|
||||
assert_eq!(value("fruit"), Some(json!("Cherry")), "{fields}");
|
||||
assert_eq!(value("veg"), Some(json!("Banana")), "{fields}");
|
||||
let text = page_text(&mut a, saved);
|
||||
assert!(text[0].contains("Cherry") && text[0].contains("Banana"), "{text:?}");
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
/// `page_render`'s pixels show a rubber stamp written without an appearance as the stamp its
|
||||
/// `/Name` names (ISO 32000-2 Table 184), and one with an unknown name as a grey placeholder.
|
||||
#[test]
|
||||
|
||||
@@ -5,6 +5,7 @@ mod inline_image_ei;
|
||||
mod jbig2_invariants;
|
||||
mod named_form_properties;
|
||||
mod search;
|
||||
mod separation_all;
|
||||
mod substitute_widths;
|
||||
mod type3_text_clip;
|
||||
mod tiling_cell_placement;
|
||||
mod type3_text_clip;
|
||||
@@ -0,0 +1,145 @@
|
||||
//! Contributor-original synthetic pages for the special colourant names of a Separation colour
|
||||
//! space (ISO 32000-2 §8.6.6.4): `/All` paints every colourant of the output device at once, so
|
||||
//! on screen a tint t is the gray 1 − t whatever the alternate space and tint transform say;
|
||||
//! `/None` paints nothing; any other name goes through its alternate space.
|
||||
use pdfcraft_render::{PageRenderer, RenderConfig, RenderRequest, RenderedPage};
|
||||
use std::sync::Arc;
|
||||
|
||||
/// A tint transform into DeviceCMYK that gives cyan: tint t → (t, 0, 0, 0). Through it a tint
|
||||
/// draws light or full cyan, never a neutral gray, so a gray result proves it was not used.
|
||||
const CYAN: &str = "<< /FunctionType 2 /Domain [0 1] /C0 [0 0 0 0] /C1 [1 0 0 0] /N 1 >>";
|
||||
|
||||
/// A PDF of the given objects (object 1 the catalog), with a cross-reference table. Each object
|
||||
/// is its bytes: a stream's data need not be text.
|
||||
fn pdf(objects: &[Vec<u8>]) -> Vec<u8> {
|
||||
let mut bytes = b"%PDF-1.7\n".to_vec();
|
||||
let mut offsets = Vec::new();
|
||||
for (i, object) in objects.iter().enumerate() {
|
||||
offsets.push(bytes.len());
|
||||
bytes.extend_from_slice(format!("{} 0 obj\n", i + 1).as_bytes());
|
||||
bytes.extend_from_slice(object);
|
||||
bytes.extend_from_slice(b"\nendobj\n");
|
||||
}
|
||||
let xref = bytes.len();
|
||||
bytes.extend_from_slice(format!("xref\n0 {}\n0000000000 65535 f \n", objects.len() + 1).as_bytes());
|
||||
for offset in offsets {
|
||||
bytes.extend_from_slice(format!("{offset:010} 00000 n \n").as_bytes());
|
||||
}
|
||||
bytes.extend_from_slice(format!("trailer << /Size {} /Root 1 0 R >>\nstartxref\n{xref}\n%%EOF\n", objects.len() + 1).as_bytes());
|
||||
bytes
|
||||
}
|
||||
|
||||
fn stream(dict: &str, data: &[u8]) -> Vec<u8> {
|
||||
let mut bytes = format!("<< {dict} /Length {} >>\nstream\n", data.len()).into_bytes();
|
||||
bytes.extend_from_slice(data);
|
||||
bytes.extend_from_slice(b"\nendstream");
|
||||
bytes
|
||||
}
|
||||
|
||||
/// A 300 × 100 pt page drawing `content` with `resources`, then `extra` as objects 5 onwards.
|
||||
fn page(content: &str, resources: &str, extra: &[Vec<u8>]) -> Vec<u8> {
|
||||
let mut objects = vec![
|
||||
b"<< /Type /Catalog /Pages 2 0 R >>".to_vec(),
|
||||
b"<< /Type /Pages /Kids [3 0 R] /Count 1 >>".to_vec(),
|
||||
format!("<< /Type /Page /Parent 2 0 R /MediaBox [0 0 300 100] /Contents 4 0 R /Resources {resources} >>").into_bytes(),
|
||||
stream("", content.as_bytes()),
|
||||
];
|
||||
objects.extend_from_slice(extra);
|
||||
pdf(&objects)
|
||||
}
|
||||
|
||||
fn render(pdf: Vec<u8>) -> RenderedPage {
|
||||
let mut renderer = PageRenderer::new(Arc::new(pdf), RenderConfig::default());
|
||||
let out = renderer.render(RenderRequest { page: 0, scale: 1.0, ..Default::default() });
|
||||
assert!(out.error.is_none(), "{:?}", out.error);
|
||||
assert_eq!((out.width, out.height), (300, 100));
|
||||
out
|
||||
}
|
||||
|
||||
/// The RGB of the pixel at (`x`, `y`) pt from the page's top left.
|
||||
fn rgb(out: &RenderedPage, x: usize, y: usize) -> [u8; 3] {
|
||||
let at = (y * out.width as usize + x) * 4;
|
||||
let pixel = out.rgba.get(at..at + 3).expect("the pixel lies on the page");
|
||||
[pixel[0], pixel[1], pixel[2]]
|
||||
}
|
||||
|
||||
/// `got` is the neutral gray `want`, give or take one level of rounding.
|
||||
fn assert_gray(got: [u8; 3], want: u8, what: &str) {
|
||||
assert!(got.iter().all(|c| c.abs_diff(want) <= 1), "{what}: got {got:?}, want gray {want}");
|
||||
}
|
||||
|
||||
/// Three boxes filled with `cs` at tints 0, 0.5 and 1, left to right.
|
||||
fn three_tints(space: &str) -> RenderedPage {
|
||||
let content = "/CS0 cs 0 scn 0 0 100 100 re f 0.5 scn 100 0 100 100 re f 1 scn 200 0 100 100 re f";
|
||||
render(page(content, "<< /ColorSpace << /CS0 5 0 R >> >>", &[space.as_bytes().to_vec(), CYAN.as_bytes().to_vec()]))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn separation_all_fills_paint_the_complemented_tint_as_gray() {
|
||||
let out = three_tints("[/Separation /All /DeviceCMYK 6 0 R]");
|
||||
assert_gray(rgb(&out, 50, 50), 255, "tint 0 paints no colourant: white");
|
||||
assert_gray(rgb(&out, 150, 50), 128, "tint 0.5 paints half of every colourant: 50% gray");
|
||||
assert_gray(rgb(&out, 250, 50), 0, "tint 1 paints every colourant: black");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn separation_all_strokes_paint_the_complemented_tint_as_gray() {
|
||||
let content = "/CS0 CS 0.25 SCN 40 w 0 50 m 300 50 l S";
|
||||
let out =
|
||||
render(page(content, "<< /ColorSpace << /CS0 5 0 R >> >>", &[b"[/Separation /All /DeviceCMYK 6 0 R]".to_vec(), CYAN.as_bytes().to_vec()]));
|
||||
assert_gray(rgb(&out, 150, 50), 191, "a stroke at tint 0.25: 75% gray");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn separation_none_paints_nothing() {
|
||||
// A red background, so "nothing" is told apart from white.
|
||||
let content = "1 0 0 rg 0 0 300 100 re f /CS0 cs 0 scn 0 0 100 100 re f 0.5 scn 100 0 100 100 re f 1 scn 200 0 100 100 re f";
|
||||
let out =
|
||||
render(page(content, "<< /ColorSpace << /CS0 5 0 R >> >>", &[b"[/Separation /None /DeviceCMYK 6 0 R]".to_vec(), CYAN.as_bytes().to_vec()]));
|
||||
for x in [50, 150, 250] {
|
||||
assert_eq!(rgb(&out, x, 50), [255, 0, 0], "a /None fill at x = {x} leaves the background");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_named_separation_still_paints_through_its_alternate() {
|
||||
let out = three_tints("[/Separation /Cyan /DeviceCMYK 6 0 R]");
|
||||
let [white, half, full] = [rgb(&out, 50, 50), rgb(&out, 150, 50), rgb(&out, 250, 50)];
|
||||
assert_gray(white, 255, "tint 0 of a named colourant");
|
||||
for (what, colour) in [("tint 0.5", half), ("tint 1", full)] {
|
||||
// Cyan: red well below green and blue.
|
||||
assert!(colour[0] < colour[1] && colour[0] < colour[2] && colour[2] > 200, "{what} of /Cyan is cyan: {colour:?}");
|
||||
}
|
||||
assert!(full[0] < half[0], "full cyan is deeper than half: {full:?} against {half:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_device_n_space_naming_all_still_paints_through_its_alternate() {
|
||||
// §8.6.6.4 gives All its meaning in a Separation space; a DeviceN space keeps its alternate.
|
||||
let out = three_tints("[/DeviceN [/All] /DeviceCMYK 6 0 R]");
|
||||
let half = rgb(&out, 150, 50);
|
||||
assert!(half[0] < half[1] && half[0] < half[2], "DeviceN [/All] at 0.5 draws its tint transform's cyan: {half:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn separation_all_images_paint_each_sample_as_the_complemented_gray() {
|
||||
// Three 8-bit samples: tints 0, 128/255 and 1.
|
||||
let data = [0u8, 128, 255];
|
||||
let image =
|
||||
stream("/Type /XObject /Subtype /Image /Width 3 /Height 1 /ColorSpace [/Separation /All /DeviceCMYK 6 0 R] /BitsPerComponent 8", &data);
|
||||
let out = render(page("q 300 0 0 100 0 0 cm /Im Do Q", "<< /XObject << /Im 5 0 R >> >>", &[image, CYAN.as_bytes().to_vec()]));
|
||||
assert_gray(rgb(&out, 50, 50), 255, "sample 0");
|
||||
assert_gray(rgb(&out, 150, 50), 127, "sample 128");
|
||||
assert_gray(rgb(&out, 250, 50), 0, "sample 255");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn separation_all_shadings_paint_the_complemented_gray() {
|
||||
// An axial shading from tint 0 at x = 0 to tint 1 at x = 300, painted with `sh`.
|
||||
let shading = "<< /ShadingType 2 /ColorSpace [/Separation /All /DeviceCMYK 6 0 R] /Coords [0 0 300 0] /Function << /FunctionType 2 /Domain [0 1] /C0 [0] /C1 [1] /N 1 >> /Extend [true true] >>";
|
||||
let out = render(page("/Sh sh", "<< /Shading << /Sh 5 0 R >> >>", &[shading.as_bytes().to_vec(), CYAN.as_bytes().to_vec()]));
|
||||
for (x, want) in [(1usize, 254u8), (150, 128), (298, 1)] {
|
||||
let got = rgb(&out, x, 50);
|
||||
assert!(got.iter().all(|c| c.abs_diff(want) <= 3), "shading at x = {x}: got {got:?}, want gray near {want}");
|
||||
}
|
||||
}
|
||||
@@ -36,6 +36,8 @@
|
||||
//! for this session without changing the saved preference. `ui.state.default_mode` reports it.
|
||||
//! `theme=light|dark|system` changes the saved theme preference; `ui.state.theme_preference`
|
||||
//! reports the choice and `ui.state.theme` reports the resolved light/dark colours.
|
||||
//! `comment-tool-pinned=true|false` remembers the annotation quick bar's pin across restarts;
|
||||
//! `ui.state.comment_tool_pinned` reports the same preference.
|
||||
//! - `ui.open {path}`: open a file. A file whose tab is already open focuses it
|
||||
//! (`"focused": true`) instead of adding a tab; native opens report `pending: true` until
|
||||
//! they complete and are listed in `ui.state.pending_opens`; only a failed open replies `Err`.
|
||||
@@ -731,6 +733,7 @@ impl Host for crate::PdfCraftApp {
|
||||
"home": self.active.is_none(),
|
||||
"mode": format!("{:?}", self.mode),
|
||||
"default_mode": self.default_mode,
|
||||
"comment_tool_pinned": self.comment_prefs.pinned,
|
||||
"left_panel": if self.left_open { json!(format!("{:?}", self.left)) } else { Value::Null },
|
||||
"tools_side": if self.docking.tools_on_right() { "right" } else { "left" },
|
||||
"right_panel": self.right.map(|r| format!("{r:?}")),
|
||||
|
||||
@@ -493,7 +493,7 @@ impl PdfCraftApp {
|
||||
&& committed.as_ref().is_some_and(|draft| draft.name == focus.name)
|
||||
&& let Some(field) = self.session.get(view.id).and_then(|doc| doc.form.iter().find(|field| field.name == focus.name))
|
||||
{
|
||||
focus.text = field.value.first().cloned().unwrap_or_default();
|
||||
focus.text = crate::forms_ui::draft_text(field);
|
||||
focus.picked = field.value.clone();
|
||||
}
|
||||
if let Some(page) = signature_page
|
||||
|
||||
@@ -4,7 +4,8 @@
|
||||
//! cancels, Tab moves to the next field). Check boxes and radio buttons toggle on click, or on
|
||||
//! Space once Tab or a click has focused them. List boxes are directly selectable in-place on the
|
||||
//! page (clicking picks an option; Ctrl-click toggles on multi-select lists). Combo boxes open a
|
||||
//! list of their options. Every change is one undoable engine edit.
|
||||
//! list of their options; an editable one (Edit flag) also takes typed text in a box over the
|
||||
//! field. Every change is one undoable engine edit.
|
||||
|
||||
use std::collections::HashSet;
|
||||
|
||||
@@ -89,11 +90,29 @@ fn fillable(f: &FormField) -> bool {
|
||||
!f.read_only() && !matches!(f.kind, FormFieldKind::PushButton | FormFieldKind::Signature)
|
||||
}
|
||||
|
||||
/// Whether a combo box takes typed text as well as a choice from its list: the Edit flag
|
||||
/// (ISO 32000-2 Table 233), which only means something with Combo set.
|
||||
fn editable_combo(f: &FormField) -> bool {
|
||||
f.kind == FormFieldKind::Combo && f.has(field_flags::EDIT)
|
||||
}
|
||||
|
||||
/// The text a field's editor starts with: its value, or for a combo box the shown text of the
|
||||
/// option it picks (a free value typed into an editable one has no option, and shows as is).
|
||||
pub(crate) fn draft_text(f: &FormField) -> String {
|
||||
let value = f.value.first().cloned().unwrap_or_default();
|
||||
if f.kind == FormFieldKind::Combo
|
||||
&& let Some((_, shown)) = f.options.iter().find(|(export, _)| *export == value)
|
||||
{
|
||||
return shown.clone();
|
||||
}
|
||||
value
|
||||
}
|
||||
|
||||
fn open_focus(f: &FormField, widget: usize) -> Focus {
|
||||
Focus {
|
||||
name: f.name.clone(),
|
||||
widget,
|
||||
text: f.value.first().cloned().unwrap_or_default(),
|
||||
text: draft_text(f),
|
||||
picked: f.value.clone(),
|
||||
request_focus: true,
|
||||
select_all: false,
|
||||
@@ -273,6 +292,11 @@ pub(crate) fn draft_edit(focus: &Focus, form: &[FormField]) -> Option<Edit> {
|
||||
let f = form.iter().find(|f| f.name == focus.name)?;
|
||||
let value = match f.kind {
|
||||
FormFieldKind::Text if f.value.first().map(String::as_str).unwrap_or("") != focus.text => FieldValue::Text(focus.text.clone()),
|
||||
// Typed into an editable combo box: a shown text picks its option, anything else is the
|
||||
// value itself (the engine maps it, and refuses free text when Edit is clear).
|
||||
FormFieldKind::Combo if editable_combo(f) && focus.text != draft_text(f) && f.value.first() != Some(&focus.text) => {
|
||||
FieldValue::Choice(if focus.text.is_empty() { Vec::new() } else { vec![focus.text.clone()] })
|
||||
}
|
||||
_ => return None,
|
||||
};
|
||||
Some(Edit::SetFieldValue { name: f.name.clone(), value })
|
||||
@@ -288,6 +312,49 @@ pub(crate) fn commit(view: &mut DocView, form: &[FormField]) {
|
||||
}
|
||||
}
|
||||
|
||||
/// The text box of an editable combo box, over the field. What is typed becomes the value when
|
||||
/// Enter, Tab or a click away commits it; a pick from the list still sets an option.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
fn combo_editor(ctx: &egui::Context, view: &mut DocView, form: &[FormField], f: &FormField, w: &FormWidget, rect: Rect, zoom: f32, widget: usize) {
|
||||
let mut enter = false;
|
||||
egui::Area::new(egui::Id::new(("form-editor", view.id.0)))
|
||||
.fade_in(false)
|
||||
.order(egui::Order::Foreground)
|
||||
.fixed_pos(rect.min)
|
||||
.constrain_to(view.viewport_rect())
|
||||
.constrain(false)
|
||||
.show(ctx, |ui| {
|
||||
ui.set_min_size(rect.size());
|
||||
let Some(fx) = view.forms.focus.as_mut() else { return };
|
||||
let font = (field_text_size(ui.painter(), f, w, &fx.text) * zoom).clamp(3.0, 64.0);
|
||||
// The box is pale yellow in every theme, as a text field's is (#655).
|
||||
ui.visuals_mut().text_cursor.stroke.color = crate::edit_text_ui::caret_color_on(FIELD_FILL);
|
||||
let te = egui::TextEdit::singleline(&mut fx.text)
|
||||
.desired_width((rect.width() - 6.0 * zoom + 6.0).max(1.0))
|
||||
.font(egui::FontId::proportional(font))
|
||||
.background_color(FIELD_FILL)
|
||||
.text_color(Color32::BLACK)
|
||||
.margin(egui::Margin::symmetric(3, 1))
|
||||
.id(egui::Id::new(("form-field", view.id.0, &f.name, widget)));
|
||||
let r = ui.add_sized(rect.size(), te);
|
||||
if std::mem::take(&mut fx.request_focus) {
|
||||
r.request_focus();
|
||||
// Entered with Tab: typing replaces the value.
|
||||
if std::mem::take(&mut fx.select_all)
|
||||
&& let Some(mut st) = egui::TextEdit::load_state(ui.ctx(), r.id)
|
||||
{
|
||||
let n = fx.text.chars().count();
|
||||
st.cursor.set_char_range(Some(egui::text::CCursorRange::two(egui::text::CCursor::new(0), egui::text::CCursor::new(n))));
|
||||
st.store(ui.ctx(), r.id);
|
||||
}
|
||||
}
|
||||
enter = r.lost_focus() && ui.input(|i| i.key_pressed(egui::Key::Enter));
|
||||
});
|
||||
if enter {
|
||||
commit(view, form);
|
||||
}
|
||||
}
|
||||
|
||||
const MONTHS: [&str; 12] = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
|
||||
|
||||
/// The date picker under a focused date field: a month of days, and a Today button under them.
|
||||
@@ -695,6 +762,11 @@ pub(crate) fn overlay(
|
||||
}
|
||||
}
|
||||
FormFieldKind::Combo => {
|
||||
// An editable combo box has a text box over the field as well as its list (ISO
|
||||
// 32000-2 Table 233, Edit).
|
||||
if editable_combo(f) {
|
||||
combo_editor(ctx, view, form, f, w, rect, zoom, focus.widget);
|
||||
}
|
||||
let resp = egui::Area::new(egui::Id::new(("form-choices", view.id.0)))
|
||||
.order(egui::Order::Foreground)
|
||||
.fixed_pos(rect.left_bottom() + vec2(0.0, 2.0))
|
||||
|
||||
@@ -2637,6 +2637,7 @@ impl PdfCraftApp {
|
||||
v["redact_prefs"] = self.redact_defaults.to_json();
|
||||
// Set outside json! above, which is at serde_json's macro recursion limit.
|
||||
v["hide_empty_highlight_hover"] = serde_json::Value::Bool(self.comment_prefs.hide_empty_highlight_hover);
|
||||
v["comment_tool_pinned"] = serde_json::Value::Bool(self.comment_prefs.pinned);
|
||||
v["show_secured_notice"] = serde_json::Value::Bool(self.show_secured_notice);
|
||||
v["organize_zoom"] = serde_json::json!(self.organize_zoom);
|
||||
// Canonical names survive changes to the order of PAPERS and do not depend on UI language.
|
||||
@@ -2769,6 +2770,9 @@ impl PdfCraftApp {
|
||||
if let Some(hide) = v["hide_empty_highlight_hover"].as_bool() {
|
||||
self.comment_prefs.hide_empty_highlight_hover = hide;
|
||||
}
|
||||
if let Some(pinned) = v["comment_tool_pinned"].as_bool() {
|
||||
self.comment_prefs.pinned = pinned;
|
||||
}
|
||||
// Per-tool comment styles (#340): each field goes through its clamping setter, so a
|
||||
// malformed or hostile entry is clamped or ignored rather than trusted.
|
||||
if let Some(styles) = v["comment_styles"].as_array() {
|
||||
@@ -3111,6 +3115,13 @@ impl PdfCraftApp {
|
||||
};
|
||||
}
|
||||
("author", _) => self.comment_prefs.author = value.to_string(),
|
||||
("comment-tool-pinned", _) => {
|
||||
self.comment_prefs.pinned = match value {
|
||||
"true" => true,
|
||||
"false" => false,
|
||||
_ => return Err("comment-tool-pinned must be true or false".into()),
|
||||
};
|
||||
}
|
||||
("hide-empty-highlight-hover", _) => {
|
||||
self.comment_prefs.hide_empty_highlight_hover = match value {
|
||||
"true" => true,
|
||||
|
||||
@@ -0,0 +1,161 @@
|
||||
//! The annotation quick bar's pin is a preference, including across older settings files.
|
||||
|
||||
use egui::{Pos2, pos2};
|
||||
use egui_kittest::{Harness, kittest::Queryable};
|
||||
use pdfcraft_ui_egui::{PdfCraftApp, QuickTool, comments::CommentTool};
|
||||
use serde_json::{Value, json};
|
||||
|
||||
// Contributor-original blank page: no document assets or fonts are needed.
|
||||
const PDF: &[u8] = b"%PDF-1.7
|
||||
1 0 obj << /Type /Catalog /Pages 2 0 R >> endobj
|
||||
2 0 obj << /Type /Pages /Kids [3 0 R] /Count 1 >> endobj
|
||||
3 0 obj << /Type /Page /Parent 2 0 R /MediaBox [0 0 300 200] >> endobj
|
||||
xref
|
||||
0 4
|
||||
0000000000 65535 f\r
|
||||
0000000009 00000 n\r
|
||||
0000000058 00000 n\r
|
||||
0000000115 00000 n\r
|
||||
trailer << /Size 4 /Root 1 0 R >>
|
||||
startxref
|
||||
186
|
||||
%%EOF";
|
||||
|
||||
/// Start a fresh shell with the state a previous process saved.
|
||||
fn harness(saved: Option<String>) -> Harness<'static, PdfCraftApp> {
|
||||
let mut h = Harness::builder().with_size(egui::vec2(1400.0, 900.0)).build_eframe(move |_cc| {
|
||||
let mut app = PdfCraftApp::new();
|
||||
if let Some(saved) = saved {
|
||||
app.restore(&saved);
|
||||
}
|
||||
app.set_option("language", "en").unwrap();
|
||||
app.set_option("author", "Tester").unwrap();
|
||||
app.open_bytes("pin.pdf", None, PDF.to_vec()).unwrap();
|
||||
app.set_option("left", "closed").unwrap();
|
||||
app.set_option("quick", "callout").unwrap();
|
||||
app
|
||||
});
|
||||
crate::support::wait_until(&mut h, "the blank page", |app| app.views[0].page_screen_rect(0).is_some() && !app.render_pending());
|
||||
h
|
||||
}
|
||||
|
||||
/// Place and post a callout at known PDF coordinates, independently of panel and zoom changes.
|
||||
fn callout(h: &mut Harness<'static, PdfCraftApp>, y: f32) {
|
||||
let r = h.state().views[0].page_screen_rect(0).unwrap();
|
||||
let at = |x: f32| -> Pos2 { pos2(r.left() + x / 300.0 * r.width(), r.top() + (200.0 - y) / 200.0 * r.height()) };
|
||||
h.hover_at(at(40.0));
|
||||
h.run_steps(1);
|
||||
h.drag_at(at(40.0));
|
||||
h.run_steps(1);
|
||||
h.hover_at(at(140.0));
|
||||
h.run_steps(1);
|
||||
h.drop_at(at(140.0));
|
||||
h.run_steps(3);
|
||||
h.query_all_by(|node| node.placeholder() == Some("Type text")).next().unwrap().type_text("Remember this");
|
||||
h.run_steps(2);
|
||||
h.get_by_label("Post").click();
|
||||
h.run_steps(3);
|
||||
}
|
||||
|
||||
/// Optional private visual evidence, kept outside the repository by the test runner.
|
||||
fn shot(h: &mut Harness<'static, PdfCraftApp>, name: &str) {
|
||||
if let Ok(dir) = std::env::var("PDFCRAFT_PIN_SHOTS") {
|
||||
h.render().unwrap().save(std::path::Path::new(&dir).join(name)).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pin_from_quick_bar_survives_restart_and_unpinning() {
|
||||
let _gpu = crate::gpu();
|
||||
let mut h = harness(None);
|
||||
h.get_by_label("Keep tool selected").click();
|
||||
h.run_steps(3);
|
||||
assert!(h.state().comment_prefs.pinned);
|
||||
let doc = h.state().session.get(h.state().views[0].id).unwrap();
|
||||
assert!(doc.repair_log().is_empty(), "the synthetic page opens without repair");
|
||||
assert_eq!(doc.bytes.as_slice(), PDF, "changing this preference leaves the PDF unchanged");
|
||||
assert!(!doc.dirty);
|
||||
let saved = h.state().persist();
|
||||
drop(h);
|
||||
|
||||
let mut h = harness(Some(saved));
|
||||
assert!(h.state().comment_prefs.pinned, "the pin survives a fresh shell");
|
||||
h.get_by_label("Keep tool selected: on");
|
||||
shot(&mut h, "pin-restored.png");
|
||||
callout(&mut h, 140.0);
|
||||
crate::support::wait_until(&mut h, "the pinned callout", |app| app.session.get(app.views[0].id).unwrap().info.annotations.len() == 1);
|
||||
assert!(matches!(h.state().quick_tool, QuickTool::Comment(CommentTool::Callout)), "the restored pin keeps the tool selected after use");
|
||||
|
||||
h.get_by_label("Keep tool selected: on").click();
|
||||
h.run_steps(3);
|
||||
assert!(!h.state().comment_prefs.pinned);
|
||||
shot(&mut h, "pin-disabled.png");
|
||||
let saved = h.state().persist();
|
||||
callout(&mut h, 60.0);
|
||||
crate::support::wait_until(&mut h, "the unpinned callout returning to Select", |app| {
|
||||
app.session.get(app.views[0].id).unwrap().info.annotations.len() == 2 && matches!(app.quick_tool, QuickTool::Select)
|
||||
});
|
||||
assert!(!matches!(h.state().quick_tool, QuickTool::Comment(_)), "unpinning restores one-shot use");
|
||||
|
||||
let mut restored = PdfCraftApp::new();
|
||||
restored.comment_prefs.pinned = true;
|
||||
restored.restore(&saved);
|
||||
assert!(!restored.comment_prefs.pinned, "unpinning survives the next restart too");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn saved_pin_round_trips_both_boolean_values() {
|
||||
for pinned in [true, false] {
|
||||
let mut app = PdfCraftApp::new();
|
||||
app.comment_prefs.pinned = pinned;
|
||||
let saved = app.persist();
|
||||
let value: Value = serde_json::from_str(&saved).unwrap();
|
||||
assert_eq!(value["comment_tool_pinned"], json!(pinned));
|
||||
let mut restored = PdfCraftApp::new();
|
||||
restored.comment_prefs.pinned = !pinned;
|
||||
restored.restore(&saved);
|
||||
assert_eq!(restored.comment_prefs.pinned, pinned);
|
||||
assert!(matches!(restored.quick_tool, QuickTool::Select), "remembering the pin does not select a drawing tool at startup");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn restoring_explicit_pin_choice_overrides_current_choice() {
|
||||
for pinned in [true, false] {
|
||||
let mut app = PdfCraftApp::new();
|
||||
app.comment_prefs.pinned = !pinned;
|
||||
app.restore(&json!({"comment_tool_pinned": pinned}).to_string());
|
||||
assert_eq!(app.comment_prefs.pinned, pinned);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn legacy_settings_keep_the_default_and_other_preferences() {
|
||||
let mut app = PdfCraftApp::new();
|
||||
assert!(!app.comment_prefs.pinned);
|
||||
let legacy = r#"{"author":"Legacy reviewer","comment_styles":[{"tool":"comment.line","color":[0.25,0.5,1.0]}]}"#;
|
||||
app.restore(legacy);
|
||||
assert!(!app.comment_prefs.pinned, "old settings retain the default one-shot behavior");
|
||||
assert_eq!(app.comment_prefs.author, "Legacy reviewer");
|
||||
assert_eq!(app.comment_prefs.style(CommentTool::Line).color, [0.25, 0.5, 1.0]);
|
||||
app.comment_prefs.pinned = true;
|
||||
app.restore(legacy);
|
||||
assert!(app.comment_prefs.pinned, "a partial restore without this key leaves the current choice alone");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn malformed_pin_values_preserve_the_current_choice() {
|
||||
for pinned in [false, true] {
|
||||
let mut app = PdfCraftApp::new();
|
||||
app.comment_prefs.pinned = pinned;
|
||||
for value in [json!(null), json!(0), json!(1), json!(-1), json!("true"), json!("false"), json!([]), json!({})] {
|
||||
app.restore(&json!({"comment_tool_pinned": value, "author": "Still restored"}).to_string());
|
||||
assert_eq!(app.comment_prefs.pinned, pinned, "invalid pin value: {value}");
|
||||
assert_eq!(app.comment_prefs.author, "Still restored", "other valid preferences still restore");
|
||||
}
|
||||
for invalid in ["", "{", r#"{"comment_tool_pinned":true"#, "[]", "null", "false", "0"] {
|
||||
app.restore(invalid);
|
||||
assert_eq!(app.comment_prefs.pinned, pinned);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -88,6 +88,25 @@ fn ok(h: &mut Harness<'static, PdfCraftApp>, c: &ControlClient, method: &str, pa
|
||||
call(h, c, method, params).unwrap_or_else(|e| panic!("{method}: {e}"))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn comment_pin_is_reported_and_persistent() {
|
||||
let (mut h, c) = harness();
|
||||
assert_eq!(ok(&mut h, &c, "ui.state", json!({}))["comment_tool_pinned"], false);
|
||||
for pinned in [true, false] {
|
||||
ok(&mut h, &c, "ui.set", json!({"key":"comment-tool-pinned","value":pinned}));
|
||||
assert_eq!(ok(&mut h, &c, "ui.state", json!({}))["comment_tool_pinned"], pinned);
|
||||
let mut restored = PdfCraftApp::new();
|
||||
restored.comment_prefs.pinned = !pinned;
|
||||
restored.restore(&h.state().persist());
|
||||
assert_eq!(restored.comment_prefs.pinned, pinned);
|
||||
for invalid in [json!("yes"), json!(1), json!(null), json!([]), json!({})] {
|
||||
assert!(call(&mut h, &c, "ui.set", json!({"key":"comment-tool-pinned","value":invalid})).is_err());
|
||||
assert_eq!(ok(&mut h, &c, "ui.state", json!({}))["comment_tool_pinned"], pinned);
|
||||
}
|
||||
assert_eq!(ok(&mut h, &c, "ui.state", json!({}))["documents"][0]["dirty"], false);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn thumbnail_size_is_settable_and_inspectable_through_the_control_channel() {
|
||||
let (mut h, c) = harness();
|
||||
|
||||
@@ -1423,6 +1423,95 @@ fn mode_tabs_keep_the_hand_over_a_text_field_scrolled_under_them() {
|
||||
assert_eq!(h.state().mode, pdfcraft_ui_egui::Mode::Convert, "the tab takes the click, not the field's editor");
|
||||
}
|
||||
|
||||
/// Two combo boxes of Apple and Banana: `fruit` editable (Combo and Edit, ISO 32000-2 Table 233),
|
||||
/// `veg` a drop-down list only.
|
||||
fn combo_form() -> Vec<u8> {
|
||||
pdf_from_objects(&[
|
||||
"<< /Type /Catalog /Pages 2 0 R /AcroForm << /Fields [4 0 R 6 0 R] /DA (/Helv 0 Tf 0 g) /DR << /Font << /Helv 5 0 R >> >> >> >>",
|
||||
"<< /Type /Pages /Kids [3 0 R] /Count 1 /MediaBox [0 0 300 400] >>",
|
||||
"<< /Type /Page /Parent 2 0 R /Annots [4 0 R 6 0 R] >>",
|
||||
"<< /Type /Annot /Subtype /Widget /FT /Ch /T (fruit) /Ff 393216 /Opt [(Apple) (Banana)] /Rect [20 350 280 372] /P 3 0 R /F 4 >>",
|
||||
"<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica /Encoding /WinAnsiEncoding >>",
|
||||
"<< /Type /Annot /Subtype /Widget /FT /Ch /T (veg) /Ff 131072 /Opt [(Apple) (Banana)] /Rect [20 300 280 322] /P 3 0 R /F 4 >>",
|
||||
])
|
||||
}
|
||||
|
||||
fn combo_harness() -> Harness<'static, PdfCraftApp> {
|
||||
let mut h = Harness::builder().with_size(egui::vec2(1400.0, 900.0)).build_eframe(|_cc| {
|
||||
let mut app = PdfCraftApp::new();
|
||||
app.set_option("language", "en").unwrap();
|
||||
app.open_bytes("combo.pdf", None, combo_form()).unwrap();
|
||||
app.set_option("left", "closed").unwrap();
|
||||
app.set_option("zoom", "150").unwrap();
|
||||
app
|
||||
});
|
||||
crate::support::settle(&mut h);
|
||||
h
|
||||
}
|
||||
|
||||
/// An editable combo box takes a typed value that isn't among its options, and still takes a
|
||||
/// pick from its list; the typed value is what Save writes.
|
||||
#[test]
|
||||
fn an_editable_combo_box_takes_a_typed_value() {
|
||||
let dir = scratch("editable-combo");
|
||||
let out = dir.join("saved.pdf");
|
||||
let mut h = combo_harness();
|
||||
click_field(&mut h, "fruit", 0);
|
||||
assert_eq!(focused(&h), Some(("fruit".into(), 0)));
|
||||
h.event(egui::Event::Text("Cherry".into()));
|
||||
h.run_steps(2);
|
||||
h.key_press(egui::Key::Enter);
|
||||
h.run_steps(4);
|
||||
assert_eq!(value(&h, "fruit"), ["Cherry"], "Enter commits the typed value");
|
||||
assert!(h.state().views[0].forms.focus.is_none(), "and closes the field");
|
||||
// Reopened, it shows the typed value, and the list still picks an option.
|
||||
click_field(&mut h, "fruit", 0);
|
||||
assert_eq!(h.state().views[0].forms.focus.as_ref().map(|f| f.text.as_str()), Some("Cherry"));
|
||||
h.get_by_label("Banana").click();
|
||||
h.run_steps(4);
|
||||
assert_eq!(value(&h, "fruit"), ["Banana"], "a pick from the list");
|
||||
// Typed again, Tab commits it, and Save writes it.
|
||||
click_field(&mut h, "fruit", 0);
|
||||
h.key_press_modifiers(egui::Modifiers::COMMAND, egui::Key::A);
|
||||
h.event(egui::Event::Text("Damson".into()));
|
||||
h.run_steps(2);
|
||||
h.key_press(egui::Key::Tab);
|
||||
h.run_steps(4);
|
||||
assert_eq!(value(&h, "fruit"), ["Damson"], "Tab commits the typed value");
|
||||
h.state_mut().save_override = Some(out.to_string_lossy().into_owned());
|
||||
h.key_press_modifiers(egui::Modifiers::COMMAND, egui::Key::S);
|
||||
wait_for_file(&mut h, &out);
|
||||
assert_eq!(saved_value(&out, "fruit"), ["Damson"]);
|
||||
// Undo takes the typing back as one step.
|
||||
h.state_mut().undo();
|
||||
h.run_steps(2);
|
||||
assert_eq!(value(&h, "fruit"), ["Banana"]);
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
/// A combo box without the Edit flag is a drop-down list only: typing changes nothing.
|
||||
#[test]
|
||||
fn a_combo_box_without_edit_takes_no_typing() {
|
||||
let mut h = combo_harness();
|
||||
click_field(&mut h, "veg", 0);
|
||||
assert_eq!(focused(&h), Some(("veg".into(), 0)));
|
||||
h.event(egui::Event::Text("Cherry".into()));
|
||||
h.run_steps(2);
|
||||
assert_eq!(h.state().views[0].forms.focus.as_ref().map(|f| f.text.as_str()), Some(""), "no text box took the typing");
|
||||
h.key_press(egui::Key::Enter);
|
||||
h.run_steps(2);
|
||||
h.key_press(egui::Key::Tab);
|
||||
h.run_steps(4);
|
||||
assert!(value(&h, "veg").is_empty(), "nothing typed reaches the field");
|
||||
// Tab went on to `fruit`, whose open list covers `veg`: close it first.
|
||||
h.key_press(egui::Key::Escape);
|
||||
h.run_steps(2);
|
||||
click_field(&mut h, "veg", 0);
|
||||
h.get_by_label("Apple").click();
|
||||
h.run_steps(4);
|
||||
assert_eq!(value(&h, "veg"), ["Apple"], "its list still picks");
|
||||
}
|
||||
|
||||
/// A button script's `ShowHideFileAttachment` opens the attachments panel, and running it again
|
||||
/// closes it.
|
||||
#[test]
|
||||
|
||||
@@ -29,6 +29,7 @@ mod camera;
|
||||
mod column_select;
|
||||
mod combine_grid;
|
||||
mod commands;
|
||||
mod comment_pin;
|
||||
mod comments;
|
||||
mod compare;
|
||||
mod content;
|
||||
|
||||
@@ -28,6 +28,24 @@ the low-disk artifacts, run `cargo clean --profile low-disk`.
|
||||
Building PdfCraft requires Rust 1.95 or later: the UI crate and its `egui` and `craft-ui`
|
||||
dependencies need it, and the workspace `rust-version` states the same minimum.
|
||||
|
||||
## Annotation tool pin
|
||||
|
||||
The annotation quick bar's **Keep tool selected** pin is a shared preference, stored as the
|
||||
boolean `comment_tool_pinned`. It survives application restarts, including when switched off.
|
||||
Startup uses Select; the remembered pin applies when an annotation tool is picked. Older settings
|
||||
without the key keep the default one-shot behavior. Non-boolean values are ignored, preserving
|
||||
the current choice and the other valid settings.
|
||||
|
||||
The existing opt-in UI control channel uses the same preference:
|
||||
|
||||
```sh
|
||||
pdfcraft-cli ui --control /path/to/control.json set key=comment-tool-pinned value=true
|
||||
pdfcraft-cli ui --control /path/to/control.json state
|
||||
```
|
||||
|
||||
`ui.state.comment_tool_pinned` reports the boolean. `ui.set` accepts `true` or `false` and refuses
|
||||
other values before changing the preference. This changes interface settings only.
|
||||
|
||||
## Interface appearance
|
||||
|
||||
Display theme saves System, Light or Dark separately from the palette currently drawn. New
|
||||
|
||||
@@ -3934,6 +3934,18 @@ tools = []
|
||||
evidence = ["crates/ui-egui/tests/it/comments.rs::make_current_properties_default", "crates/ui-egui/tests/it/comments.rs::properties_dialog_makes_the_strikethrough_colour_default"]
|
||||
notes = "colour, opacity and line width become the tool's defaults (canvas and Comments panel menus, and Acrobat's Make Properties Default box in Comment Properties, applied on OK with the edited look) and survive a restart: the per-tool styles are persisted with the settings and restored through their clamping setters (#340)"
|
||||
|
||||
[[feature]]
|
||||
id = "comment.keep-tool-selected"
|
||||
title = "Keep annotation tools selected between uses and restarts"
|
||||
area = "E"
|
||||
tier = "P2"
|
||||
milestone = "M14"
|
||||
status = "shipped"
|
||||
commands = ["comment.line"]
|
||||
tools = []
|
||||
evidence = ["crates/ui-egui/tests/it/comment_pin.rs::pin_from_quick_bar_survives_restart_and_unpinning", "crates/ui-egui/tests/it/comment_pin.rs::legacy_settings_keep_the_default_and_other_preferences", "crates/ui-egui/tests/it/comment_pin.rs::malformed_pin_values_preserve_the_current_choice", "crates/ui-egui/tests/it/control.rs::comment_pin_is_reported_and_persistent"]
|
||||
notes = "The annotation quick bar's shared pin survives restarts as a boolean setting (#4253); unpinning is remembered too. Old settings default to one-shot use, and malformed values keep the current choice. UI-only preference, reachable through opt-in ui.set key=comment-tool-pinned and reported by ui.state.comment_tool_pinned. Startup uses Select; the shared pin applies when an annotation tool is picked. Independent per-tool pins and restoring the active tool are outside this preference."
|
||||
|
||||
[[feature]]
|
||||
id = "comment.author-identity"
|
||||
title = "Author name from identity preferences"
|
||||
@@ -4499,8 +4511,8 @@ milestone = "M6"
|
||||
status = "shipped"
|
||||
commands = ["form.fields"]
|
||||
tools = ["form_fill"]
|
||||
evidence = ["crates/ui-egui/tests/it/forms.rs::check_boxes_radios_and_choices", "crates/forms/src/tests.rs::choices_accept_exports_or_display_text"]
|
||||
notes = "combo and list boxes, multi-select lists; editable combo boxes accept free text"
|
||||
evidence = ["crates/ui-egui/tests/it/forms.rs::check_boxes_radios_and_choices", "crates/forms/src/tests.rs::choices_accept_exports_or_display_text", "crates/ui-egui/tests/it/forms.rs::an_editable_combo_box_takes_a_typed_value", "crates/ui-egui/tests/it/forms.rs::a_combo_box_without_edit_takes_no_typing", "crates/automation/tests/it/automation.rs::form_fill_takes_free_text_only_in_an_editable_combo_box"]
|
||||
notes = "combo and list boxes, multi-select lists; an editable combo box (Edit flag) has a text box over the field as well as its list, and takes typed text on the page and through form_fill; a combo box without Edit takes only its options. No type-ahead or spell check in the typed box"
|
||||
|
||||
[[feature]]
|
||||
id = "form.push-buttons"
|
||||
|
||||
Vendored
+1
-1
@@ -17,7 +17,7 @@ Other resource categories retain their existing parent-chain lookup.
|
||||
|
||||
| Crate | Version | Licence | Patches | Test |
|
||||
|---|---|---|---|---|
|
||||
| hayro-interpret | 0.7.0 | Apache-2.0 OR MIT | (1) select `/AP /N` appearance states via `/AS` (checkboxes, radios, stateful icons) and honour the NoView flag; (2) Type3 Unicode fallback to `/Encoding` glyph names, then printable ASCII; (3) `Type3Glyph::advance_width`; (4) `InterpreterSettings::ocg_overrides` for viewer layer toggles; (5) soft masks whose group lacks `/CS` were dropped (Chrome gradient text); (6) paint nesting cap `MAX_PAINT_NESTING` for tiling patterns and Type 3 glyphs (self-referencing content overflowed the stack); (7) CID width ranges in `/W` and `/W2` clamped to `MAX_CID` (a `0 4294967295 w` range hung); (8) `InterpreterSettings::hide_comments` skips markup annotations but keeps widgets and links (View ▸ Hide all comments); (9) `image_size_ok`: images and masks over 2^28 pixels are not decoded (a fuzzed `/W 4294967295` stencil mask allocated 4 GiB); (10) `MAX_NESTED_PAINTS`: nested paints (forms, Type 3 glyphs and tiling patterns inside one another) share a per-page budget of 50,000 (a glyph showing eight glyphs of its own font, sixteen deep, hung); (11) depends on skrifa 0.47 instead of 0.42 (upstream read-fonts fixed a Type 1 tokenizer that recursed through runs of numbers: a fuzzed font hung or overflowed the stack), with the one API change (`Charset::glyph_id` returns `Option`); (12) annotation appearances whose `/BBox` or `/Matrix` collapses to a line or a point are skipped (mapping them onto `/Rect` divided by zero and handed the device infinite or NaN matrices); (13) a Highlight annotation without a usable normal appearance is drawn from its `/QuadPoints`, `/C` and `/CA` with Multiply blending, as pdfcraft-annot draws highlights (it was not drawn at all); (14) simple-font `/Widths` (`read_widths`): entries only for codes 0–255 (one entry per code below `/FirstChar` was allocated: `4294967295` asked for 34 GB), an entry that isn't a number leaves its code missing instead of ending the array, and a `/LastChar` below `/FirstChar` gives no widths instead of discarding the font for a standard one; (15) the appearance box is mapped onto `/Rect` corner to corner: the translation now accounts for the scale (an appearance whose box didn't start at the origin and differed in size from `/Rect` was drawn shifted); (16) a clip set by `W`/`W*` takes effect after whichever path-painting operator ends the path (`S`, `f`, `B`, … as well as `n`; ISO 32000-2 §8.5.4): it was applied only on `n`, so `re W* S` clipped nothing and the clip stayed pending for a later, unrelated `n`; (17) `InterpreterSettings::cancelled`: once set, interpretation stops before the next content operator (a render pool sets it for every worker when dropped, after an edit or on closing, and for one worker when the watchdog gives up on its render, so renders whose answers nobody can receive stop instead of running to the end); (18) `MAX_PAGE_CONTENT`: the content a page holds at once (its contents, and the forms, tiling patterns and Type 3 glyph procedures being painted) stays within 512 MiB (`decode_content`; once it runs out, `InterpreterWarning::ContentTruncated` is reported (once per page by pdfcraft-render) so a truncated page is not a clean render; each level gives its bytes back when it finishes): forms nest fifty deep and each level kept its content while the next ran, so a form painting itself around a stream inflating to 256 MiB would have held over 12 GB; and Type 0 sampled functions take at most `MAX_SAMPLE_ENTRIES` (2^21) table points and `MAX_SAMPLE_VALUES` (2^23) samples, read no further than `/Size` asks (256 MiB of 1-bit samples asked for over 8 GB); (19) mesh shadings (types 4–7) are sampled only inside the area being drawn (`ShadingPattern::encode_within`, which the vendored hayro renderer calls with that area plus a pixel), within 8 visits per pixel of it plus 4 per triangle (`TriangleSampler`), and patches are triangulated one at a time: points far off the page were sampled over their whole bounding box, up to 65536 × 65536 entries (a fuzzed 147-byte patch stream; a synthetic page passed 6 GB in six seconds), ten thousand overlapping triangles ran for minutes, and every patch became 722 triangles before any limit; meshes hold at most `MAX_MESH_PATCHES` (2^16) patches and `MAX_MESH_TRIANGLES` (2^20) triangles, a lattice needs two to 2^19 vertices per row (`/VerticesPerRow 0` pushed empty rows for ever; one huge row read the whole stream), and a page samples at most `MAX_PAGE_MESH_TRIANGLES` (2^25) mesh triangles in all (a mesh painted a thousand times was triangulated a thousand times); each cut logs a warning; (20) PDF function construction is limited to 64 levels and 10,000 total nodes with cycle detection; calculator parsing and evaluation share procedure depth/work budgets, integer division/bitshift/rotation/index are panic-free, and fixed-size stack errors propagate; (21) a Type 0 font drawn with a substitute that isn't CID-keyed (it isn't embedded, or its program doesn't load) draws `.nLine truncated
|
||||
| hayro-interpret | 0.7.0 | Apache-2.0 OR MIT | (1) select `/AP /N` appearance states via `/AS` (checkboxes, radios, stateful icons) and honour the NoView flag; (2) Type3 Unicode fallback to `/Encoding` glyph names, then printable ASCII; (3) `Type3Glyph::advance_width`; (4) `InterpreterSettings::ocg_overrides` for viewer layer toggles; (5) soft masks whose group lacks `/CS` were dropped (Chrome gradient text); (6) paint nesting cap `MAX_PAINT_NESTING` for tiling patterns and Type 3 glyphs (self-referencing content overflowed the stack); (7) CID width ranges in `/W` and `/W2` clamped to `MAX_CID` (a `0 4294967295 w` range hung); (8) `InterpreterSettings::hide_comments` skips markup annotations but keeps widgets and links (View ▸ Hide all comments); (9) `image_size_ok`: images and masks over 2^28 pixels are not decoded (a fuzzed `/W 4294967295` stencil mask allocated 4 GiB); (10) `MAX_NESTED_PAINTS`: nested paints (forms, Type 3 glyphs and tiling patterns inside one another) share a per-page budget of 50,000 (a glyph showing eight glyphs of its own font, sixteen deep, hung); (11) depends on skrifa 0.47 instead of 0.42 (upstream read-fonts fixed a Type 1 tokenizer that recursed through runs of numbers: a fuzzed font hung or overflowed the stack), with the one API change (`Charset::glyph_id` returns `Option`); (12) annotation appearances whose `/BBox` or `/Matrix` collapses to a line or a point are skipped (mapping them onto `/Rect` divided by zero and handed the device infinite or NaN matrices); (13) a Highlight annotation without a usable normal appearance is drawn from its `/QuadPoints`, `/C` and `/CA` with Multiply blending, as pdfcraft-annot draws highlights (it was not drawn at all); (14) simple-font `/Widths` (`read_widths`): entries only for codes 0–255 (one entry per code below `/FirstChar` was allocated: `4294967295` asked for 34 GB), an entry that isn't a number leaves its code missing instead of ending the array, and a `/LastChar` below `/FirstChar` gives no widths instead of discarding the font for a standard one; (15) the appearance box is mapped onto `/Rect` corner to corner: the translation now accounts for the scale (an appearance whose box didn't start at the origin and differed in size from `/Rect` was drawn shifted); (16) a clip set by `W`/`W*` takes effect after whichever path-painting operator ends the path (`S`, `f`, `B`, … as well as `n`; ISO 32000-2 §8.5.4): it was applied only on `n`, so `re W* S` clipped nothing and the clip stayed pending for a later, unrelated `n`; (17) `InterpreterSettings::cancelled`: once set, interpretation stops before the next content operator (a render pool sets it for every worker when dropped, after an edit or on closing, and for one worker when the watchdog gives up on its render, so renders whose answers nobody can receive stop instead of running to the end); (18) `MAX_PAGE_CONTENT`: the content a page holds at once (its contents, and the forms, tiling patterns and Type 3 glyph procedures being painted) stays within 512 MiB (`decode_content`; once it runs out, `InterpreterWarning::ContentTruncated` is reported (once per page by pdfcraft-render) so a truncated page is not a clean render; each level gives its bytes back when it finishes): forms nest fifty deep and each level kept its content while the next ran, so a form painting itself around a stream inflating to 256 MiB would have held over 12 GB; and Type 0 sampled functions take at most `MAX_SAMPLE_ENTRIES` (2^21) table points and `MAX_SAMPLE_VALUES` (2^23) samples, read no further than `/Size` asks (256 MiB of 1-bit samples asked for over 8 GB); (19) mesh shadings (types 4–7) are sampled only inside the area being drawn (`ShadingPattern::encode_within`, which the vendored hayro renderer calls with that area plus a pixel), within 8 visits per pixel of it plus 4 per triangle (`TriangleSampler`), and patches are triangulated one at a time: points far off the page were sampled over their whole bounding box, up to 65536 × 65536 entries (a fuzzed 147-byte patch stream; a synthetic page passed 6 GB in six seconds), ten thousand overlapping triangles ran for minutes, and every patch became 722 triangles before any limit; meshes hold at most `MAX_MESH_PATCHES` (2^16) patches and `MAX_MESH_TRIANGLES` (2^20) triangles, a lattice needs two to 2^19 vertices per row (`/VerticesPerRow 0` pushed empty rows for ever; one huge row read the whole stream), and a page samples at most `MAX_PAGE_MESH_TRIANGLES` (2^25) mesh triangles in all (a mesh painted a thousand times was triangulated a thousand times); each cut logs a warning; (20) PDF function construction is limited to 64 levels and 10,000 total nodes with cycle detection; calculator parsing and evaluation share procedure depth/work budgets, integer division/bitshift/rotation/index are panic-free, and fixed-size stack errors propagate; (21) a Type 0 font drawn with a substitute that isn't CID-keyed (it isn't embedded, or its program doesn't load) draws `.nLine truncated
|
||||
| hayro | 0.7.1 | Apache-2.0 OR MIT | (1) `RenderSettings::{x_offset, y_offset}` to render one tile of a large page; (2) images over `MAX_IMAGE_PIXELS` (2^28) are skipped (a fuzzed `/W 4294967295` hung in resampling); (3) `tiling_cell_scale` keeps a tiling pattern's cell pixmap within 3000 px a side whatever its `/XStep`/`/YStep` (a fuzzed step far beyond `/BBox` allocated 2 GB); (4) stroke widths clamped to 4 × (canvas width + height) device pixels (a fuzzed `/LW 9223372036854775807` allocated 10 GB in stroke expansion); (5) `usable_dash_pattern`: a stroke whose dash pattern could cut it into more than `MAX_DASHES_PER_STROKE` (250,000) pieces, counting kurbo's restart of the pattern at every subpath and `ClosePath`, is drawn solid (a fuzzed `/D [[11] 0]` on a line from x = 92234775807 allocated over 5 GB, `[0.000001] 0 d` on a 20 pt line over 10 GB); (6) a dash pattern with a negative or non-finite entry, or a period that isn't positive, is drawn solid (`[-1 -1] 0 d` looped for ever in kurbo); (7) `render_size` and `render_into`: render into a buffer the caller allocates (PdfCraft renders into pixel-aligned memory that the GUI takes over as texture data); `render` is `render_into` on a new pixmap; (8) checked image source/target/RGBA, alpha-premultiplication scratch and intermediate sizes before resampling, finite transforms and exact source/mask buffers; sources wider than u16 may shrink before backend limits, with a 2^20 source-axis cap and conservative 128 MiB filter-planning estimate; an over-limit or failed resize keeps the original image resolution and geometry when the source fits the backend, otherwise skips it, with a logged warning; staging, resampling output/scratch, RGBA conversion and padding buffers use fallible reserves; (9) `may_paint_canvas`: a fill or stroke whose control-point box, grown by how far its paint reaches past the path (half the stroke width times the larger of the miter limit and √2) plus 0.5 user units and 2 pixels, misses the canvas is not drawn, so a tile no longer strokes and fills every path of its page (item 5 of #623); `set_skip_offscreen_paths` turns this off for the regression test; (10) `/Interpolate` governs the pre-resize too (#624): a minified image that does not request interpolation is pre-resized with nearest-neighbour, planned without the Catmull-Rom filter limits (`image_resampling_size` takes the flag); a Type 3 glyph image is sampled bicubically only when interpolated; a minified image with a matching soft mask is nearest-sampled straight into premultiplied RGBA; (11) `may_paint_rect`: an image whose stream-size box, mapped to the device, misses the canvas is skipped before decoding (decoded data can only shrink against that box), so a tile of an image-heavy page no longer decodes, resamples and rasterizes every image on it; (12) preview renders (`InterpreterSettings::preview`: backdrops, thumbnails, grid cells, signature-drag backgrounds) skip images under `PREVIEW_MIN_IMAGE_AREA` device pixels, while final renders always draw them; (13) reading colours (#897): `RenderSettings::color_replacement` takes a `ColorReplacement` (text colour, background, `only_black`, `line_art`) that remaps solid text and line-art paint while rendering, glyph outlines counting as text and stencil-mask ink as line art; images, image alpha masks, soft masks and pattern cells keep their colours; `render_pdf` gains a `color_replacement: Option<ColorReplacement>` argument (pass `None` for true colours); the upstream-only `[dev-dependencies.log]` entry is removed from `Cargo.toml` (log is a normal dependency since the logging patch), so `cargo test -p hayro` runs this crate's unit tests; (14) a shrunk, interpolated, axis-aligned image is snapped to whole device pixels: shrunk once to its rounded device rectangle and drawn 1:1 at the rounded corner, instead of a ceil-sized raster resampled again at a fractional scale and offset (`snap_minified_image`; scans looked soft next to Acrobat); (15) a soft mask of another size than its image is filtered when shrunk, whatever its `/Interpolate` (#1649): such a mask carries the shape on its own (Word saves text as a tiny black image with a glyph-bitmap mask), and nearest-neighbour dropped every stroke thinner than the shrink factor; (16) under a soft mask or a blend mode, axial and radial shadings are sampled instead of drawn as native gradients (#2128): vello_cpu 0.0.8 copies an opaque gradient over fully covered tiles without the mask or blend mode, so PowerPoint's faded gradient fills came out solid; (17) the renderer keeps annotation paints out of the reading-colours mapping between `begin_annotations` and `end_annotations` (#1548); (18) the page renders as one transparency group; under reading colours its background is painted inside it as the initial backdrop, so a Multiply highlight blends with the dark background instead of staying an opaque block, and otherwise the background stays outside, so a blend mode over an empty part of thLine truncated
|
||||
| hayro-jbig2 | 0.3.0 | Apache-2.0 OR MIT | (1) at most 2^28 pixels per bitmap, page bitmap, halftone grid and grayscale image (each side could be 65535: 4.3 billion pixels decoded one by one); (2) at most 2^26 symbol pixels per symbol dictionary (a fuzzed dictionary decoded for minutes); (3) a symbol dictionary's height classes are capped at one per new symbol and its export runs at `2 × symbols + 1`, each plus `EXTRA_EMPTY_STEPS` (1024): an empty height class or a zero-length export run doesn't advance, and past the end of its data the arithmetic decoder can decode them for ever (one changed byte hung the renderer); (4) a segment header's long-form referred-to segment count is capped at `u16::MAX` and a larger count is refused before its retention or referred-to bytes are read: the 29-bit count went straight to `Vec::with_capacity`, a reservation of about 2 GiB whose failure aborts the process (from storytold/craft-libs#176) | (1) `raster::tests::jbig2_regions_of_billions_of_pixels_are_refused`; (2) the nightly `cargo xtask fuzz` finding, which now finishes in about a second; (3) `raster::tests::jbig2_symbol_dictionaries_that_never_advance_terminate`; (4) `segment::tests::test_referred_to_count_is_capped` (`cargo test --manifest-path vendor/hayro-jbig2/Cargo.toml`) |
|
||||
| lopdf | 0.45.0 | MIT | (1) PNG predictor rows longer than the data are refused before their buffers are allocated (a fuzzed `/Columns 4294967295` allocated two 4 GiB rows), and empty frames return without row buffers; (2) predictor row widths use saturating arithmetic or reject overflow; (3) sub-byte TIFF Predictor 2 scratch is bounded by the samples present in the input instead of the declared `/Colors`, aligned with [lopdf#589](https://github.com/J-F-Liu/lopdf/pull/589); (4) the object lookup keeps its cycle history through compressed objects, requires an ordinary in-file container, and caps the chain of indirect lookups at 16 (a chain of new objects, each a `/Length` compressed in a container whose own `/Length` names the next, or a stream whose `/Length` names the next stream, overflowed the stack: a dev build's 2 MiB thread within 800 hops); (5) object-stream members are parsed within their own extent (up to the next distinct offset), an entry whose offset repeats an earlier entry's is skipped (so a repeated object number can resolve to its earlier entry), and offsets are processed in index order; (6) `find_latest_trailer`: a rebuild takes a `/Type /XRef` stream dictionary as the trailer when the file has no `trailer` keyword (the latest in the file wins, as a later `trailer` would), so a concatenated or truncated file keeps its /Info and /ID instead of failing to load; a candidate whose /Root is the catalog beats one whose /Root is another dictionary, and an in-file /Root must match its generation (#2365) | (1) `inspect::tests::png_predictor_rows_longer_than_the_data_are_refused_before_allocating`, `inspect::tests::empty_png_predictor_frames_do_not_allocate_rows`; (2) `inspect::tests::tiff_subbyte_predictor_row_width_overflow_is_refused`; (3) `inspect::tests::tiff_subbyte_predictor_scratch_is_bounded_by_available_samples`, `inspect::tests::tiff_subbyte_predictors_keep_components_rows_and_padding`; (4) `inspect::tests::compressed_object_self_container_does_not_recurse`, `inspect::tests::compressed_object_mutual_containers_do_not_recurse`, `inspect::tests::object_stream_length_cycle_does_not_recurse`, `inspect::tests::compressed_object_container_chain_does_not_recurse`, `inspect::tests::compressed_length_chain_does_not_recurse`, `inspect::tests::plain_stream_length_chain_does_not_recurse`, `inspect::tests::compressed_objects_and_indirect_stream_length_still_load`, `inspect::tests::compressed_length_in_a_container_with_an_indirect_length_still_loads`; (5) `inspect::tests::object_stream_member_extents_bound_owned_strings`, `inspect::tests::object_stream_member_extents_preserve_index_order_and_whitespace`; (6) `inspect::tests::rebuilt_file_keeps_the_info_of_its_cross_reference_stream`, `inspect::tests::rebuilt_file_prefers_a_trailer_whose_root_is_the_catalog` |
|
||||
|
||||
Vendored
+17
-2
@@ -1050,6 +1050,8 @@ pub(crate) struct Separation {
|
||||
/// `eval_tint_transform`).
|
||||
tint_transform: Option<Function>,
|
||||
is_none_separation: bool,
|
||||
/// PdfCraft patch (66): the colourant is the special name `All`.
|
||||
is_all: bool,
|
||||
}
|
||||
|
||||
/// PdfCraft patch (55): `tint_transform` run on the tints of one colour, or, when it cannot be
|
||||
@@ -1080,20 +1082,33 @@ impl Separation {
|
||||
// PdfCraft patch (55): an unreadable tint transform keeps the space (see
|
||||
// `eval_tint_transform`).
|
||||
let tint_transform = iter.next::<Object<'_>>().and_then(|f| Function::new(&f));
|
||||
// Either I did something wrong, or no other viewers properly handles
|
||||
// `All`, so let's just ignore it as well.
|
||||
let is_none_separation = name.as_str() == "None";
|
||||
// PdfCraft patch (66): `All` names every colourant of the output device at once
|
||||
// (ISO 32000-2 §8.6.6.4), so its tints never go through the alternate space.
|
||||
let is_all = name.as_str() == "All";
|
||||
|
||||
Some(Self {
|
||||
alternate_space,
|
||||
tint_transform,
|
||||
is_none_separation,
|
||||
is_all,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl ToRgb for Separation {
|
||||
fn convert_f32(&self, input: &[f32], output: &mut [u8], _: bool) -> Option<()> {
|
||||
if self.is_all {
|
||||
// PdfCraft patch (66): §8.6.6.4: the tint applies to every colourant, and on an
|
||||
// additive device it is complemented first, so tint t is the gray 1 − t on each of
|
||||
// R, G and B whatever the alternate space and tint transform say.
|
||||
for (tint, rgb) in input.iter().zip(output.chunks_exact_mut(3)) {
|
||||
// `clamp` keeps NaN, and `f32_to_u8`'s cast saturates it to 0.
|
||||
let gray = f32_to_u8(1.0 - tint.clamp(0.0, 1.0));
|
||||
rgb.copy_from_slice(&[gray, gray, gray]);
|
||||
}
|
||||
return Some(());
|
||||
}
|
||||
count_tint_transform_runs(input.len());
|
||||
// PdfCraft patch (55): see `eval_tint_transform`.
|
||||
let evaluated = input
|
||||
|
||||
Reference in new issue
Block a user