diff --git a/Cargo.lock b/Cargo.lock
index fd186d995c..d2f4dadad0 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1178,17 +1178,17 @@ dependencies = [
[[package]]
name = "craft-docpath"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
[[package]]
name = "craft-fonts-build"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
[[package]]
name = "craft-i18n"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
dependencies = [
"fixed_decimal",
"icu_decimal",
@@ -1211,7 +1211,7 @@ dependencies = [
[[package]]
name = "craft-keymap"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
dependencies = [
"egui",
"serde",
@@ -1221,7 +1221,7 @@ dependencies = [
[[package]]
name = "craft-menu"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
dependencies = [
"craft-keymap",
"craft-quit",
@@ -1234,7 +1234,7 @@ dependencies = [
[[package]]
name = "craft-print"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
dependencies = [
"craft-winprint-gdi",
"log",
@@ -1248,7 +1248,7 @@ dependencies = [
[[package]]
name = "craft-quit"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
dependencies = [
"dispatch2",
"egui",
@@ -1259,7 +1259,7 @@ dependencies = [
[[package]]
name = "craft-ui"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
dependencies = [
"craft-fonts-build",
"craft-i18n",
@@ -1280,7 +1280,7 @@ dependencies = [
[[package]]
name = "craft-update"
version = "0.1.0"
-source = "git+https://github.com/storytold/craft-libs?rev=c5a1cbfb5f9049f9270955caffb5bee5997aebf7#c5a1cbfb5f9049f9270955caffb5bee5997aebf7"
+source = "git+https://github.com/storytold/craft-libs?rev=787a7a0f972fd1d7a7618fdbeca3a5267a0407ff#787a7a0f972fd1d7a7618fdbeca3a5267a0407ff"
dependencies = [
"chrono",
"dunce",
@@ -4208,7 +4208,7 @@ dependencies = [
[[package]]
name = "pdfcraft"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"chrono",
"craft-update",
@@ -4232,7 +4232,7 @@ dependencies = [
[[package]]
name = "pdfcraft-a11y"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"pdfcraft-content",
"pdfcraft-cos",
@@ -4244,7 +4244,7 @@ dependencies = [
[[package]]
name = "pdfcraft-annot"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"hayro-syntax",
"pdfcraft-cos",
@@ -4255,7 +4255,7 @@ dependencies = [
[[package]]
name = "pdfcraft-audit"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"pdfcraft-content",
"pdfcraft-cos",
@@ -4266,7 +4266,7 @@ dependencies = [
[[package]]
name = "pdfcraft-automation"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"base64 0.23.1",
"flate2",
@@ -4288,7 +4288,7 @@ dependencies = [
[[package]]
name = "pdfcraft-cli"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"base64 0.23.1",
"pdfcraft-audit",
@@ -4306,11 +4306,11 @@ dependencies = [
[[package]]
name = "pdfcraft-compare"
-version = "0.16.1"
+version = "0.17.0"
[[package]]
name = "pdfcraft-content"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"hayro-syntax",
"pdfcraft-cos",
@@ -4318,7 +4318,7 @@ dependencies = [
[[package]]
name = "pdfcraft-cos"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"chrono",
"hayro-syntax",
@@ -4333,11 +4333,10 @@ dependencies = [
[[package]]
name = "pdfcraft-create"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"encoding_rs",
"hayro-ccitt",
- "hayro-jbig2",
"hayro-syntax",
"image",
"pdfcraft-cos",
@@ -4353,7 +4352,7 @@ dependencies = [
[[package]]
name = "pdfcraft-crypt"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"aes",
"md-5",
@@ -4365,7 +4364,7 @@ dependencies = [
[[package]]
name = "pdfcraft-edit"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"hayro-syntax",
"kurbo 0.13.1",
@@ -4374,6 +4373,8 @@ dependencies = [
"pdfcraft-cos",
"pdfcraft-fonts",
"pdfcraft-model",
+ "pdfcraft-render",
+ "proptest",
"sha2 0.11.1",
"thiserror 2.0.21",
"unicode-bidi",
@@ -4381,7 +4382,7 @@ dependencies = [
[[package]]
name = "pdfcraft-engine"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"chrono",
"craft-docpath",
@@ -4393,10 +4394,12 @@ dependencies = [
"pdfcraft-annot",
"pdfcraft-audit",
"pdfcraft-compare",
+ "pdfcraft-content",
"pdfcraft-cos",
"pdfcraft-create",
"pdfcraft-edit",
"pdfcraft-export",
+ "pdfcraft-filters",
"pdfcraft-fonts",
"pdfcraft-forms",
"pdfcraft-geom",
@@ -4423,14 +4426,14 @@ dependencies = [
[[package]]
name = "pdfcraft-export"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"flate2",
]
[[package]]
name = "pdfcraft-filters"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"fax",
"flate2",
@@ -4443,7 +4446,7 @@ dependencies = [
[[package]]
name = "pdfcraft-fonts"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"harfrust",
"pdfcraft-cos",
@@ -4453,7 +4456,7 @@ dependencies = [
[[package]]
name = "pdfcraft-forms"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"hayro-syntax",
"pdfcraft-content",
@@ -4466,11 +4469,11 @@ dependencies = [
[[package]]
name = "pdfcraft-geom"
-version = "0.16.1"
+version = "0.17.0"
[[package]]
name = "pdfcraft-js"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"boa_engine",
"chrono",
@@ -4478,7 +4481,7 @@ dependencies = [
[[package]]
name = "pdfcraft-measure"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"pdfcraft-annot",
"pdfcraft-content",
@@ -4491,14 +4494,14 @@ dependencies = [
[[package]]
name = "pdfcraft-model"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"pdfcraft-cos",
]
[[package]]
name = "pdfcraft-ocr"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"ocrs",
"pdfcraft-fonts",
@@ -4509,7 +4512,7 @@ dependencies = [
[[package]]
name = "pdfcraft-optimize"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"image",
"pdfcraft-annot",
@@ -4525,11 +4528,11 @@ dependencies = [
[[package]]
name = "pdfcraft-oracle"
-version = "0.16.1"
+version = "0.17.0"
[[package]]
name = "pdfcraft-organize"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"hayro-syntax",
"pdfcraft-content",
@@ -4540,7 +4543,7 @@ dependencies = [
[[package]]
name = "pdfcraft-platform"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"async-channel",
"futures-lite",
@@ -4550,7 +4553,7 @@ dependencies = [
[[package]]
name = "pdfcraft-preflight"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"flate2",
"pdfcraft-content",
@@ -4561,7 +4564,7 @@ dependencies = [
[[package]]
name = "pdfcraft-print"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"craft-print",
"pdfcraft-content",
@@ -4573,7 +4576,7 @@ dependencies = [
[[package]]
name = "pdfcraft-redact"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"pdfcraft-annot",
"pdfcraft-content",
@@ -4590,7 +4593,7 @@ dependencies = [
[[package]]
name = "pdfcraft-render"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"bytemuck",
"flate2",
@@ -4609,7 +4612,7 @@ dependencies = [
[[package]]
name = "pdfcraft-sign"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"aes",
"aws-lc-rs",
@@ -4645,11 +4648,11 @@ dependencies = [
[[package]]
name = "pdfcraft-testkit"
-version = "0.16.1"
+version = "0.17.0"
[[package]]
name = "pdfcraft-ui-egui"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"arboard",
"base64 0.23.1",
@@ -4673,6 +4676,7 @@ dependencies = [
"objc2 0.6.5",
"objc2-app-kit 0.3.2",
"objc2-foundation 0.3.2",
+ "pdfcraft-content",
"pdfcraft-cos",
"pdfcraft-engine",
"pdfcraft-fonts",
@@ -4683,6 +4687,7 @@ dependencies = [
"plist",
"png 0.18.1",
"pollster 1.0.1",
+ "proptest",
"rfd",
"rustix 1.1.5",
"serde",
@@ -4701,7 +4706,7 @@ dependencies = [
[[package]]
name = "pdfcraft-web"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"eframe",
"egui",
@@ -4713,7 +4718,7 @@ dependencies = [
[[package]]
name = "pdfcraft-xfa"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"base64 0.23.1",
"image",
@@ -4727,7 +4732,7 @@ dependencies = [
[[package]]
name = "pdfcraft-xfdf"
-version = "0.16.1"
+version = "0.17.0"
dependencies = [
"pdfcraft-annot",
"pdfcraft-cos",
diff --git a/Cargo.toml b/Cargo.toml
index 85d02570ba..edd9e682b7 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -5,7 +5,7 @@ exclude = ["vendor"]
default-members = ["crates/*", "apps/pdfcraft", "apps/pdfcraft-cli", "xtask"]
[workspace.package]
-version = "0.16.1"
+version = "0.17.0"
edition = "2024"
license = "MIT OR Apache-2.0"
rust-version = "1.95"
@@ -13,52 +13,52 @@ repository = "https://github.com/storytold/pdfcraft"
[workspace.dependencies]
# Shared frontend components; engines remain independent of egui.
-craft-ui = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "c5a1cbfb5f9049f9270955caffb5bee5997aebf7", features = ["serde"] }
+craft-ui = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff", features = ["serde"] }
# Quit the macOS way (#1136): ⌘Q asks about unsaved changes, and closing quits through `terminate:`.
-craft-quit = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "c5a1cbfb5f9049f9270955caffb5bee5997aebf7" }
+craft-quit = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff" }
# One menu definition for the native macOS menu bar and the in-window bar elsewhere.
-craft-menu = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "c5a1cbfb5f9049f9270955caffb5bee5997aebf7" }
-craft-keymap = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "c5a1cbfb5f9049f9270955caffb5bee5997aebf7", default-features = false }
+craft-menu = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff" }
+craft-keymap = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff", default-features = false }
# Shared system spooler; document composition remains in pdfcraft-print.
-craft-print = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "c5a1cbfb5f9049f9270955caffb5bee5997aebf7" }
+craft-print = { git = "https://github.com/storytold/craft-libs", version = "0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff" }
# Whether a path stored in a document may be opened (GoToR link targets).
-craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "c5a1cbfb5f9049f9270955caffb5bee5997aebf7" }
+craft-docpath = { version = "0.1.0", git = "https://github.com/storytold/craft-libs", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff" }
# craft-update: app-specific pretend versions apply to startup and manual checks.
-craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "c5a1cbfb5f9049f9270955caffb5bee5997aebf7", features = ["egui"] }
+craft-update = { git = "https://github.com/storytold/craft-libs", version = "=0.1.0", rev = "787a7a0f972fd1d7a7618fdbeca3a5267a0407ff", features = ["egui"] }
# internal
-pdfcraft-geom = { path = "crates/geom", version = "0.16.1" }
-pdfcraft-filters = { path = "crates/filters", version = "0.16.1" }
-pdfcraft-cos = { path = "crates/cos", version = "0.16.1" }
-pdfcraft-crypt = { path = "crates/crypt", version = "0.16.1" }
-pdfcraft-organize = { path = "crates/organize", version = "0.16.1" }
-pdfcraft-measure = { path = "crates/measure", version = "0.16.1" }
-pdfcraft-annot = { path = "crates/annot", version = "0.16.1" }
-pdfcraft-audit = { path = "crates/audit", version = "0.16.1" }
-pdfcraft-fonts = { path = "crates/fonts", version = "0.16.1" }
-pdfcraft-model = { path = "crates/model", version = "0.16.1" }
-pdfcraft-content = { path = "crates/content", version = "0.16.1" }
-pdfcraft-redact = { path = "crates/redact", version = "0.16.1" }
-pdfcraft-print = { path = "crates/print", version = "0.16.1" }
-pdfcraft-xfdf = { path = "crates/xfdf", version = "0.16.1" }
-pdfcraft-sign = { path = "crates/sign", version = "0.16.1" }
-pdfcraft-optimize = { path = "crates/optimize", version = "0.16.1" }
-pdfcraft-a11y = { path = "crates/a11y", version = "0.16.1" }
-pdfcraft-oracle = { path = "crates/oracle", version = "0.16.1" }
-pdfcraft-testkit = { path = "crates/testkit", version = "0.16.1" }
-pdfcraft-ocr = { path = "crates/ocr", version = "0.16.1" }
-pdfcraft-js = { path = "crates/js", version = "0.16.1" }
-pdfcraft-compare = { path = "crates/compare", version = "0.16.1" }
-pdfcraft-preflight = { path = "crates/preflight", version = "0.16.1" }
-pdfcraft-export = { path = "crates/export", version = "0.16.1" }
-pdfcraft-edit = { path = "crates/edit", version = "0.16.1" }
-pdfcraft-create = { path = "crates/create", version = "0.16.1" }
-pdfcraft-forms = { path = "crates/forms", version = "0.16.1" }
-pdfcraft-xfa = { path = "crates/xfa", version = "0.16.1" }
-pdfcraft-render = { path = "crates/render", version = "0.16.1" }
-pdfcraft-engine = { path = "crates/engine", version = "0.16.1" }
-pdfcraft-platform = { path = "crates/platform", version = "0.16.1" }
-pdfcraft-ui-egui = { path = "crates/ui-egui", version = "0.16.1" }
-pdfcraft-automation = { path = "crates/automation", version = "0.16.1", default-features = false }
+pdfcraft-geom = { path = "crates/geom", version = "0.17.0" }
+pdfcraft-filters = { path = "crates/filters", version = "0.17.0" }
+pdfcraft-cos = { path = "crates/cos", version = "0.17.0" }
+pdfcraft-crypt = { path = "crates/crypt", version = "0.17.0" }
+pdfcraft-organize = { path = "crates/organize", version = "0.17.0" }
+pdfcraft-measure = { path = "crates/measure", version = "0.17.0" }
+pdfcraft-annot = { path = "crates/annot", version = "0.17.0" }
+pdfcraft-audit = { path = "crates/audit", version = "0.17.0" }
+pdfcraft-fonts = { path = "crates/fonts", version = "0.17.0" }
+pdfcraft-model = { path = "crates/model", version = "0.17.0" }
+pdfcraft-content = { path = "crates/content", version = "0.17.0" }
+pdfcraft-redact = { path = "crates/redact", version = "0.17.0" }
+pdfcraft-print = { path = "crates/print", version = "0.17.0" }
+pdfcraft-xfdf = { path = "crates/xfdf", version = "0.17.0" }
+pdfcraft-sign = { path = "crates/sign", version = "0.17.0" }
+pdfcraft-optimize = { path = "crates/optimize", version = "0.17.0" }
+pdfcraft-a11y = { path = "crates/a11y", version = "0.17.0" }
+pdfcraft-oracle = { path = "crates/oracle", version = "0.17.0" }
+pdfcraft-testkit = { path = "crates/testkit", version = "0.17.0" }
+pdfcraft-ocr = { path = "crates/ocr", version = "0.17.0" }
+pdfcraft-js = { path = "crates/js", version = "0.17.0" }
+pdfcraft-compare = { path = "crates/compare", version = "0.17.0" }
+pdfcraft-preflight = { path = "crates/preflight", version = "0.17.0" }
+pdfcraft-export = { path = "crates/export", version = "0.17.0" }
+pdfcraft-edit = { path = "crates/edit", version = "0.17.0" }
+pdfcraft-create = { path = "crates/create", version = "0.17.0" }
+pdfcraft-forms = { path = "crates/forms", version = "0.17.0" }
+pdfcraft-xfa = { path = "crates/xfa", version = "0.17.0" }
+pdfcraft-render = { path = "crates/render", version = "0.17.0" }
+pdfcraft-engine = { path = "crates/engine", version = "0.17.0" }
+pdfcraft-platform = { path = "crates/platform", version = "0.17.0" }
+pdfcraft-ui-egui = { path = "crates/ui-egui", version = "0.17.0" }
+pdfcraft-automation = { path = "crates/automation", version = "0.17.0", default-features = false }
# pdf
hayro = "0.7.1"
diff --git a/README.md b/README.md
index ce9e71d4a9..3c1b67936a 100644
--- a/README.md
+++ b/README.md
@@ -547,9 +547,18 @@ stand on its own.
| 
| **VectorCraft** | Vector illustration | [GitHub](https://github.com/storytold/vectorcraft) | [Website](https://getartcraft.com/apps/vectorcraft) |
| 
| **FilmCraft** | Video editing, color and sound | [GitHub](https://github.com/storytold/filmcraft) | [Website](https://getartcraft.com/apps/filmcraft) |
| 
| **LightCraft** | Photo library and raw development | [GitHub](https://github.com/storytold/lightcraft) | [Website](https://getartcraft.com/apps/lightcraft) |
-| 
| **PdfCraft** | **Reading, organizing and protecting PDFs · you are here** | [GitHub](https://github.com/storytold/pdfcraft) | [Website](https://getartcraft.com/apps/pdfcraft) |
+| | **PdfCraft** | Reading, organizing and protecting PDFs | [GitHub](https://github.com/storytold/pdfcraft) | [Website](https://getartcraft.com/apps/pdfcraft) |
| 
| **EffectCraft** | Motion graphics and visual effects | [GitHub](https://github.com/storytold/effectcraft) | [Website](https://getartcraft.com/apps/effectcraft) |
| 
| **DesignCraft** | Page layout and publishing | [GitHub](https://github.com/storytold/designcraft) | [Website](https://getartcraft.com/apps/designcraft) |
+| 
| **FigCraft** | Interface design and prototyping | [GitHub](https://github.com/storytold/figcraft) | [Website](https://getartcraft.com/apps/figcraft) |
+| 
| **WordCraft** | Word processing and documents | [GitHub](https://github.com/storytold/wordcraft) | [Website](https://getartcraft.com/apps/wordcraft) |
+| 
| **SoundCraft** | Audio recording and editing | [GitHub](https://github.com/storytold/soundcraft) | [Website](https://getartcraft.com/apps/soundcraft) |
+| 
| **DeckCraft** | Presentations and slide decks | [GitHub](https://github.com/storytold/deckcraft) | [Website](https://getartcraft.com/apps/deckcraft) |
+| 
| **CADCraft** | Computer-aided design | [GitHub](https://github.com/storytold/cadcraft) | [Website](https://getartcraft.com/apps/cadcraft) |
+| 
| **GridCraft** | Spreadsheets and data | [GitHub](https://github.com/storytold/gridcraft) | [Website](https://getartcraft.com/apps/gridcraft) |
+| 
| **TextureCraft** | 3D texture painting | [GitHub](https://github.com/storytold/texturecraft) | [Website](https://getartcraft.com/apps/texturecraft) |
+| 
| **Craft Anything** | See how any software works, then build your own | [GitHub](https://github.com/storytold/craft-anything) | [Website](https://getartcraft.com/apps/craft-anything) |
+| 
| **SolidCraft** | Parametric 3D CAD by Tangency Labs (community app) | [GitHub](https://github.com/tangency-labs/solidcraft) | |
And [**ArtCraft**](https://getartcraft.com/) itself, our AI image and video studio for artists who want real control.
diff --git a/ROADMAP.md b/ROADMAP.md
index 14419f9857..a39d6f8b6c 100644
--- a/ROADMAP.md
+++ b/ROADMAP.md
@@ -1,5 +1,11 @@
# PdfCraft roadmap
+> **Last reviewed:** 2026-11-01 | **Last updated:** 2026-11-01 | **Change:** patch (M7, PR #2155 further review: inherited drawing/text state, affine image gestures, paste/selection ownership, no-op scripts and menu permissions; estimates unchanged)
+
+> **Last reviewed:** 2026-11-01 | **Last updated:** 2026-11-01 | **Change:** patch (M7, PR #2155 latest comments: explicit image-paste events, mixed-size field refresh, and documented mixed-script normalization with Undo; estimates unchanged)
+
+> **Last reviewed:** 2026-11-01 | **Last updated:** 2026-11-01 | **Change:** patch (M7, PR #2155 review follow-up: preserve image crop/tag/stream ownership, resize in page orientation, harden clipboard and text formatting, and reload installed fonts; estimates unchanged)
+
> **Last reviewed:** 2026-10-31 | **Last updated:** 2026-10-31 | **Change:** patch (M2, PR #4172: GBK rasters compared with explicit Unicode and independently selected installed faces; wrong-glyph and wrong-family negative controls fail; estimates unchanged)
> **Last reviewed:** 2026-10-31 | **Last updated:** 2026-10-31 | **Change:** patch (M2, PR #4172: integrate main fa5f9f8c; retain CJK viewer and upstream raster regressions, restore explicit display_config imports; estimates unchanged)
> **Last reviewed:** 2026-10-28 · **Last updated:** 2026-10-28 · **Change:** patch (M2, PR #4172: integrate main 5af10276; retain both roadmap histories and viewer-only CJK font policy; estimates unchanged)
@@ -213,6 +219,18 @@ Ranked; detail and the full milestone table in [docs/roadmap.md](docs/roadmap.md
## Progress log
+- **2026-11-01 (M7, #5657):** Header/footer, watermark and background additions and replacements stage the complete call before committing. Synthetic later-page failures preserve exact incremental bytes, object count, dirty state and allocation cursor; success controls retain other marks and shared/inherited resources. Estimates unchanged.
+
+- **2026-11-01 (M14, #5572):** Preferences ▸ Documents and view sets how many recent files to keep, from 0 to 50 with 12 by default. At 0 Home has no Recent section and File ▸ Open Recent is disabled. The list is cut when Preferences closes, so the number can pass through 0 on its way to another.
+
+- **2026-11-01 (M5/M14, customizable hotbar, freehand highlight, and moveable navigation rail):** Added Freehand-Highlight (`/Subtype /Ink`, `/IT /FreehandHighlight`, Multiply blending, 100 pt max line width) inside the standard Highlight flyout and headless `comment_add`; added a customizable floating or side-docked hotbar with a full-side chrome strip mode, settings gear icon anchored at the bar end, and 24–64 px sizing; and added Left/Right docking for the navigation rail (`rail_side`). Focused unit and integration tests pass across `annot`, `automation`, and `ui-egui`. Estimates unchanged.
+- 2026-11-01: PR #2155 further review preserves inherited Form text state and soft-mask chronology during Arrange, composes crop-group moves in the proper scope, and uses affine/press-relative image resize plus a shared rotation pivot. No-op script buttons preserve hidden source text; paste coordinates, visible selection ownership, and Snapshot/Export permissions have dedicated regressions. Candidate only; estimates unchanged.
+
+- 2026-11-01: PR #2155 latest follow-up handles explicit image-paste events without release-time guesses, refreshes the font-size field when a selection becomes mixed, and specifies mixed-script normalization with exact Undo restoration. Candidate only; estimates unchanged.
+
+- 2026-11-01: PR #2155 review follow-up preserves editor crops through group moves and keeps arranged artwork outside added-item streams; unsafe nested-tag extraction is refused. Image handles and flips follow page orientation, added images accept general transforms, and clipboard/text/Home/font-discovery edge cases have focused regressions. Candidate only; estimates unchanged.
+- 2026-11-01: PR #2155 maintainer edits remove redundant image/text helpers and add regressions for crop ownership, arrange scope/state fidelity, clipboard precedence, crop-drag bounds, and font scanning. Transform and Unicode-script tools complete the headless paths.
+
- **2026-10-18 (M3, #1354, local candidate):** Integrated --two-paged with current main, retaining upstream modal/picker ownership and single-tab reuse. Native launch/opening/password regressions, negative checks against the old wrapper, visual inspection, formatting, strict scoped Clippy, layers, assets, parity and scoped WASM compilation pass. Three existing socket tests are unavailable in this workspace; one existing network test remains ignored. No push or GitHub merge; estimates unchanged.
- **2026-10-31 (M2, PR #4172 review):** Added same-machine pixel oracles for GBK Song, Hei, Kai and FangSong, including all four subset-prefixed Founder aliases. Reference PDFs use explicit Unicode mappings and independently selected installed faces; font data and rasters remain in memory. All eight cases ran; wrong-glyph and wrong-family production mutations each failed the new assertion and were restored. Validation: 422 renderer unit tests, renderer all-target Clippy with -D warnings, formatting, layers/assets/parity and renderer WASM checks passed; existing optional-patch/WASM warnings and parity notes remain. Estimates unchanged.
@@ -727,6 +745,7 @@ Newest first: the date, what moved, and the new overall estimate.
| Date | Change | Summary |
|---|---|---|
+| 2026-11-01 | patch | M7 #5657: header/footer, watermark and background operations commit all selected pages together; later-page errors preserve marks, content, shared/inherited resources and pending edits; estimates unchanged. |
| 2026-10-28 | patch | M2, PR #4172: integrate main 5af10276 and retain both roadmap histories; viewer-only CJK and print/output font policies and estimates unchanged. |
| 2026-10-27 | minor | M10: OCR stages SHA-256-verified ONNX models after the upstream RTEN URL brownout; discovery prefers a complete ONNX pair per directory, falls back to a complete RTEN pair, and never mixes formats or directories; language/web limits and estimates unchanged. |
| 2026-10-23 | minor | M8, #3205 follow-up: phone-pattern redaction includes the +39 country code on labelled Italian geographic numbers with a slash; dates, protocol identifiers and whole-run guards remain. Estimates unchanged. |
diff --git a/apps/pdfcraft/src/main.rs b/apps/pdfcraft/src/main.rs
index d2a75c5941..5bc5c5c372 100644
--- a/apps/pdfcraft/src/main.rs
+++ b/apps/pdfcraft/src/main.rs
@@ -10,7 +10,7 @@
//! --theme light|dark|system --language auto| --mode all|read|edit|convert|sign --tool --left open|closed
//! --organize on --fields on --dialog properties|shortcuts|about --palette --home on
//! --cover on|off --default-layout single|continuous|two-up|two-page --default-continuous on|off --default-zoom fit-width|fit-page| --always-default-view on|off
-//! --page-gaps on|off --default-page-gaps on|off
+//! --page-gaps on|off --default-page-gaps on|off --recent-files 0..50
//! --combine-view grid|list --combine-zoom 60..200`
//!
//! `--new-window` opens a window of its own. Without it, on Windows, a launch that only names files
diff --git a/contributors/people.toml b/contributors/people.toml
index a5a47f5c52..fecfb68c90 100644
--- a/contributors/people.toml
+++ b/contributors/people.toml
@@ -180,3 +180,6 @@ sync_github_name = true
[people.dylanmtaylor]
sync_github_name = true
+
+[people.Combiler01]
+sync_github_name = true
diff --git a/crates/annot/src/appearance.rs b/crates/annot/src/appearance.rs
index abc746c0dd..909250ef26 100644
--- a/crates/annot/src/appearance.rs
+++ b/crates/annot/src/appearance.rs
@@ -392,9 +392,13 @@ struct AppearanceDrawing {
}
impl AppearanceDrawing {
+ /// Initialize an appearance drawing buffer and configure its graphics state for opacity and blend mode.
fn new(context: &AppearanceContext<'_>) -> Self {
let mut drawing = Self::default();
- if let Some(gs) = ext_gstate(context.opacity, context.subtype == b"Highlight") {
+ if let Some(gs) = ext_gstate(
+ context.opacity,
+ context.subtype == b"Highlight" || (context.subtype == b"Ink" && context.dict.name(b"IT") == Some(b"FreehandHighlight")),
+ ) {
drawing.resources.set(b"ExtGState".to_vec(), Object::Dict(gs));
drawing.content.push_str("/GS0 gs\n");
}
diff --git a/crates/annot/src/create.rs b/crates/annot/src/create.rs
index a6db5b940b..1904745e95 100644
--- a/crates/annot/src/create.rs
+++ b/crates/annot/src/create.rs
@@ -33,6 +33,16 @@ pub(crate) fn grow(r: [f64; 4], by: f64) -> [f64; 4] {
[r[0] - by, r[1] - by, r[2] + by, r[3] + by]
}
+/// Tight bounding box of ink strokes, including Bezier control points for strokes with three or
+/// more points (matching [`appearance::smooth_segments`]).
+pub(crate) fn ink_bounds(strokes: &[Vec<[f64; 2]>]) -> Option<[f64; 4]> {
+ let controls = strokes.iter().filter(|s| s.len() > 2).flat_map(|s| {
+ let pts: Vec<(f64, f64)> = s.iter().map(|p| (p[0], p[1])).collect();
+ appearance::smooth_segments(&pts).into_iter().flat_map(|[a, b, _]| [[a.0, a.1], [b.0, b.1]])
+ });
+ bounds(strokes.iter().flatten().copied().chain(controls))
+}
+
pub(crate) fn ending_draws(ending: LineEnding) -> bool {
ending != LineEnding::None
}
@@ -87,17 +97,11 @@ pub(crate) fn rect_for(shape: &Shape, style: &Style) -> Result<[f64; 4], AnnotEr
let pad = half + if ending_draws(*start) || ending_draws(*end) { appearance::arrow_size(style.width) } else { 0.0 };
grow(bounds([*from, *to].into_iter()).unwrap_or_default(), pad + 1.0)
}
- Shape::Ink { strokes } | Shape::Signature { strokes } => {
+ Shape::Ink { strokes } | Shape::FreehandHighlight { strokes } | Shape::Signature { strokes } => {
if strokes.iter().all(Vec::is_empty) || !strokes.iter().flatten().all(|p| finite(p)) {
return Err(bad("drawing (no points)"));
}
- // Strokes of three or more points are drawn as curves, which stay within their
- // points and control points.
- let controls = strokes.iter().filter(|s| s.len() > 2).flat_map(|s| {
- let pts: Vec<(f64, f64)> = s.iter().map(|p| (p[0], p[1])).collect();
- appearance::smooth_segments(&pts).into_iter().flat_map(|[a, b, _]| [[a.0, a.1], [b.0, b.1]])
- });
- grow(bounds(strokes.iter().flatten().copied().chain(controls)).unwrap_or_default(), half + 1.0)
+ grow(ink_bounds(strokes).unwrap_or_default(), half + 1.0)
}
Shape::Polygon { vertices, cloud } => {
let b = bounds(vertices.iter().copied())
@@ -164,6 +168,7 @@ fn subject(shape: &Shape) -> &'static str {
Shape::Oval { .. } => "Oval",
Shape::Line { start: LineEnding::None, end: LineEnding::OpenArrow, .. } => "Arrow",
Shape::Line { .. } => "Line",
+ Shape::FreehandHighlight { .. } => "Freehand Highlight",
Shape::Ink { .. } => "Pencil",
Shape::TextBox { .. } => "Text Box",
Shape::Typewriter { .. } => "Typewriter",
@@ -292,10 +297,13 @@ pub fn add_annotation(doc: &mut Document, new: &NewAnnotation, meta: &Meta) -> R
}
}
}
- Shape::Ink { strokes } | Shape::Signature { strokes } => {
+ Shape::Ink { strokes } | Shape::FreehandHighlight { strokes } | Shape::Signature { strokes } => {
d.set(b"C".to_vec(), rgb(style.color));
let list = strokes.iter().filter(|s| !s.is_empty()).map(|s| num_array(&s.concat())).collect();
d.set(b"InkList".to_vec(), Object::Array(list));
+ if matches!(&new.shape, Shape::FreehandHighlight { .. }) {
+ d.set(b"IT".to_vec(), Object::name("FreehandHighlight"));
+ }
border(&mut d);
}
Shape::Polygon { vertices, cloud } => {
diff --git a/crates/annot/src/modify.rs b/crates/annot/src/modify.rs
index 2e3ae0b7d0..a615b8e013 100644
--- a/crates/annot/src/modify.rs
+++ b/crates/annot/src/modify.rs
@@ -1,5 +1,5 @@
use super::create::{
- add_annotation, base_dict, bounds, callout_attach, ending_draws, ending_pair, finite, grow, normalize, num_array, rect_for, rgb,
+ add_annotation, base_dict, bounds, callout_attach, ending_draws, ending_pair, finite, grow, ink_bounds, normalize, num_array, rect_for, rgb,
};
use super::draw::{draw_appearance, redraw_or_restore, set_appearance};
use super::info::{line_endings_of, text_value};
@@ -529,7 +529,33 @@ fn apply_text_box(doc: &mut Document, r: ObjRef, rect: [f64; 4], meta: &Meta, ne
}
fn border_width_of(d: &Dict) -> f64 {
- d.get(b"BS").and_then(|b| b.as_dict()).and_then(|b| b.get(b"W")).and_then(|w| w.as_f64()).unwrap_or(1.0).max(0.0)
+ appearance::border_width(d)
+}
+
+/// Recompute `/Rect` for an `Ink` annotation when its stroke width changes from `old_w` to `w`.
+/// Preserves any baseline margin beyond `old_w / 2.0` (at least `1.0` pt) without accumulating
+/// padding across repeated width increases and decreases.
+fn ink_rect_for_width(d: &Dict, old_w: f64, w: f64) -> Option<[f64; 4]> {
+ let list = d.get(b"InkList")?.as_array()?;
+ let mut strokes: Vec> = Vec::with_capacity(list.len());
+ for s in list {
+ let pts: Vec = s.as_array()?.iter().map(Object::as_f64).collect::>()?;
+ strokes.push(pts.as_chunks::<2>().0.iter().map(|p| [p[0], p[1]]).collect());
+ }
+ let inner = ink_bounds(&strokes)?;
+ let vals: Vec = d.get(b"Rect").and_then(Object::as_array).map(|a| a.iter().filter_map(Object::as_f64).collect()).unwrap_or_default();
+ let Some(old_rect) = four(&vals).map(normalize) else {
+ return Some(grow(inner, w / 2.0 + 1.0));
+ };
+ let old_half = old_w / 2.0;
+ let new_half = w / 2.0;
+ let base = [
+ (inner[0] - old_rect[0] - old_half).max(1.0),
+ (inner[1] - old_rect[1] - old_half).max(1.0),
+ (old_rect[2] - inner[2] - old_half).max(1.0),
+ (old_rect[3] - inner[3] - old_half).max(1.0),
+ ];
+ Some([inner[0] - base[0] - new_half, inner[1] - base[1] - new_half, inner[2] + base[2] + new_half, inner[3] + base[3] + new_half])
}
/// Change a comment's colour, opacity, line width and/or line endings, and redraw it.
@@ -576,10 +602,17 @@ pub fn set_style(doc: &mut Document, page: usize, index: usize, change: StyleCha
}
}
if let Some(w) = width {
+ let old_w = border_width_of(d);
+ let w = w.max(0.0);
let mut bs = d.get(b"BS").and_then(|b| b.as_dict()).cloned().unwrap_or_default();
- bs.set(b"W".to_vec(), Object::Real(w.max(0.0)));
+ bs.set(b"W".to_vec(), Object::Real(w));
d.set(b"BS".to_vec(), Object::Dict(bs));
d.remove(b"Border");
+ if d.name(b"Subtype") == Some(b"Ink")
+ && let Some(rect) = ink_rect_for_width(d, old_w, w)
+ {
+ d.set(b"Rect".to_vec(), num_array(&rect));
+ }
}
if let Some(ends) = endings {
if ends.len() == 1 {
diff --git a/crates/annot/src/tests.rs b/crates/annot/src/tests.rs
index a3dc14e262..cf800fa98a 100644
--- a/crates/annot/src/tests.rs
+++ b/crates/annot/src/tests.rs
@@ -2194,3 +2194,59 @@ fn degenerate_and_absurd_leader_and_caption_values_do_not_panic() {
assert!(long.contains(&format!("({}) Tj", "w".repeat(256))), "cut to 256");
assert!(!long.contains(&"w".repeat(257)));
}
+
+#[test]
+fn freehand_highlight_is_compatible_ink_with_marker_blending() {
+ let shape = Shape::FreehandHighlight { strokes: vec![vec![[20.0, 100.0], [120.0, 100.0]]] };
+ let mut annotation = new(0, shape.clone());
+ annotation.style = Style::default_for(&shape);
+ let mut doc = fixture();
+ let index = add_annotation(&mut doc, &annotation, &meta("marker")).unwrap();
+ let doc = reopen(&doc);
+ let ink = &list(&doc, 0)[index];
+
+ assert_eq!(ink.name(b"Subtype"), Some(&b"Ink"[..]));
+ assert_eq!(ink.name(b"IT"), Some(&b"FreehandHighlight"[..]));
+ assert_eq!(ink.get(b"CA").and_then(Object::as_f64), Some(0.35));
+ let ap = ink.get(b"AP").unwrap().as_dict().unwrap().reference(b"N").unwrap();
+ let resources = doc.get(ap).as_dict().unwrap().get(b"Resources").cloned().unwrap();
+ let blend = resources.as_dict().unwrap().get(b"ExtGState").unwrap().as_dict().unwrap().get(b"GS0").unwrap().as_dict().unwrap();
+ assert_eq!(blend.name(b"BM"), Some(&b"Multiply"[..]));
+
+ let mut doc = doc;
+ let rect_of = |doc: &Document, idx: usize| -> Vec {
+ list(doc, 0)[idx].get(b"Rect").unwrap().as_array().unwrap().iter().filter_map(Object::as_f64).collect()
+ };
+ let rect_before = rect_of(&doc, index);
+ set_style(&mut doc, 0, index, StyleChange { color: None, opacity: None, width: Some(34.0), endings: None }, &meta("wider")).unwrap();
+ let rect_after = rect_of(&doc, index);
+ assert!((rect_after[0] - (rect_before[0] - 10.0)).abs() < 1e-4);
+ assert!((rect_after[2] - (rect_before[2] + 10.0)).abs() < 1e-4);
+
+ // Repeated increase/decrease cycles must keep bounds stable and never accumulate padding.
+ set_style(&mut doc, 0, index, StyleChange { color: None, opacity: None, width: Some(14.0), endings: None }, &meta("narrower")).unwrap();
+ let rect_restored = rect_of(&doc, index);
+ for (a, b) in rect_restored.iter().zip(rect_before.iter()) {
+ assert!((a - b).abs() < 1e-4, "expected {rect_before:?}, got {rect_restored:?}");
+ }
+ set_style(&mut doc, 0, index, StyleChange { color: None, opacity: None, width: Some(34.0), endings: None }, &meta("wider-again")).unwrap();
+ let rect_second_wide = rect_of(&doc, index);
+ for (a, b) in rect_second_wide.iter().zip(rect_after.iter()) {
+ assert!((a - b).abs() < 1e-4, "expected {rect_after:?}, got {rect_second_wide:?}");
+ }
+
+ // Imported ink whose width is specified only by `/Border [0 0 20]` must use 20 pt as its
+ // previous width (shrinking by 5 pt on a decrease to 10 pt rather than expanding as if 1 pt).
+ let (_, r) = lookup::annot_ref(&mut doc, 0, index).unwrap();
+ doc.update_dict(r, |d| {
+ d.remove(b"BS");
+ d.set(b"Border".to_vec(), Object::Array(vec![Object::Real(0.0), Object::Real(0.0), Object::Real(20.0)]));
+ d.set(b"Rect".to_vec(), create::num_array(&[5.0, 85.0, 135.0, 115.0]));
+ })
+ .unwrap();
+ set_style(&mut doc, 0, index, StyleChange { color: None, opacity: None, width: Some(10.0), endings: None }, &meta("border-shrink")).unwrap();
+ let rect_from_border = rect_of(&doc, index);
+ for (a, b) in rect_from_border.iter().zip([10.0, 90.0, 130.0, 110.0]) {
+ assert!((a - b).abs() < 1e-4, "expected [10, 90, 130, 110], got {rect_from_border:?}");
+ }
+}
diff --git a/crates/annot/src/types.rs b/crates/annot/src/types.rs
index bd3409b5ae..522995b9f9 100644
--- a/crates/annot/src/types.rs
+++ b/crates/annot/src/types.rs
@@ -355,6 +355,10 @@ pub enum Shape {
start: LineEnding,
end: LineEnding,
},
+ /// Translucent freehand highlighting, stored as ink with a distinct intent.
+ FreehandHighlight {
+ strokes: Vec>,
+ },
/// Freehand strokes (Draw tool).
Ink {
strokes: Vec>,
@@ -474,6 +478,7 @@ pub fn rect_quad(r: [f64; 4]) -> [f64; 8] {
}
impl Shape {
+ /// Return the PDF `/Subtype` name for this annotation shape.
pub fn subtype(&self) -> &'static str {
match self {
Shape::Note { .. } => "Text",
@@ -481,7 +486,7 @@ impl Shape {
Shape::Rectangle { .. } => "Square",
Shape::Oval { .. } => "Circle",
Shape::Line { .. } => "Line",
- Shape::Ink { .. } | Shape::Signature { .. } => "Ink",
+ Shape::Ink { .. } | Shape::FreehandHighlight { .. } | Shape::Signature { .. } => "Ink",
Shape::TextBox { .. } | Shape::Typewriter { .. } | Shape::Callout { .. } => "FreeText",
Shape::Mark { .. } | Shape::Stamp { .. } | Shape::CustomStamp { .. } | Shape::TypedSignature { .. } => "Stamp",
Shape::Redact { .. } => "Redact",
@@ -610,6 +615,7 @@ impl Style {
}
Shape::Callout { .. } => ([0.0, 0.0, 0.0], 1.0),
Shape::Caret { .. } | Shape::Attachment { .. } => ([0.0, 0.47, 0.84], 1.0),
+ Shape::FreehandHighlight { .. } => return Self { color: [1.0, 0.94, 0.0], opacity: 0.35, width: 14.0, fill: None },
Shape::Ink { .. } => ([0.0, 0.4, 0.87], 2.0),
Shape::TextBox { .. } | Shape::Typewriter { .. } => ([0.0, 0.0, 0.0], 0.0),
Shape::Mark { .. } => ([0.0, 0.0, 0.0], 1.5),
diff --git a/crates/automation/README.md b/crates/automation/README.md
index 176946c175..92fd2775c9 100644
--- a/crates/automation/README.md
+++ b/crates/automation/README.md
@@ -21,6 +21,9 @@ them with the image's current orientation. Full turns retain its appearance, rec
and flips. Angles that are not multiples of 90 are refused without changing the document or
its undo/redo history.
+`page_add_text`, `content_update` and `text_edit` take per-line `aligns`. An `"inherit"` entry
+follows the box-level `align`; legacy `null` entries remain accepted with the same meaning.
+
`Content` is `Json(Value)` or `Png { data, width, height }`. Errors are `UnknownTool`, `InvalidArgs` (the call didn't match the schema) or `Failed` (a readable message for the agent).
## Conventions
@@ -199,6 +202,19 @@ undoable and survive saving/reopening. `image_hit` shares the UI's curve and hol
The bounds, limits and font requirements are in [existing-text editing](../../docs/editing-existing-text.md)
and [image editing](../../docs/editing-images.md).
+### Superscript and subscript normalization
+
+`text_script` changes characters to their Unicode superscript or subscript forms; it does not
+change the font size or baseline. For characters that have such forms, uniformly plain text
+toggles to the requested script, and uniformly scripted text toggles back to plain text.
+Characters without a matching form stay unchanged and do not determine the selection's state.
+
+A selection mixing plain and target-script characters normalizes to the requested script.
+For example, subscript changes `H₂2` to `H₂₂`, then to `H22` on the next call; superscript
+changes `Q²2` to `Q²²`, then to `Q22`. A second toggle does not reconstruct the original
+mixture. Each call is one undoable text edit: `edit_undo` restores the exact prior text,
+including its original mixture. Save/reopen preserves the resulting normalized characters.
+
## Opening local GoToR links
`link_open {doc, page, index, password?}` follows a local PDF link using `link_list`
diff --git a/crates/automation/src/comments.rs b/crates/automation/src/comments.rs
index f87fd0b58e..5dbd5b8542 100644
--- a/crates/automation/src/comments.rs
+++ b/crates/automation/src/comments.rs
@@ -183,6 +183,7 @@ impl Automation {
"page": c.page + 1,
"index": c.index + 1,
"type": c.subtype,
+ "intent": c.intent,
"author": c.author,
"contents": c.contents,
"modified": c.modified,
@@ -328,7 +329,7 @@ impl Automation {
let [start, end] = ending_pair(kind, endings.as_deref())?;
Shape::Line { from: to_user(&info, f[0], f[1]), to: to_user(&info, t[0], t[1]), start, end }
}
- "ink" => {
+ "ink" | "freehand_highlight" => {
let wrong = || ToolError::InvalidArgs("strokes must be an array of arrays of [x, y] points".into());
let strokes = a.get("strokes").ok_or_else(|| ToolError::InvalidArgs("ink needs `strokes`".into()))?;
let strokes = strokes
@@ -346,7 +347,7 @@ impl Automation {
.collect::>>()
})
.collect::>>()?;
- Shape::Ink { strokes }
+ if kind == "freehand_highlight" { Shape::FreehandHighlight { strokes } } else { Shape::Ink { strokes } }
}
"polygon" | "cloud" | "polyline" => {
let wrong = || ToolError::InvalidArgs(format!("{kind} needs `points`: an array of [x, y] points"));
diff --git a/crates/automation/src/content.rs b/crates/automation/src/content.rs
index 7518072d1c..6b25c31f61 100644
--- a/crates/automation/src/content.rs
+++ b/crates/automation/src/content.rs
@@ -83,10 +83,10 @@ pub(crate) fn parse_align(al: &str) -> Result {
/// Most entries `aligns` takes: one per paragraph, and no text has this many.
const MAX_ALIGNS: usize = 4096;
-/// `aligns`: each paragraph's (line's) own alignment, or null where it follows `align`.
+/// `aligns`: each paragraph's (line's) own alignment, or inherit/null where it follows `align`.
pub(crate) fn opt_aligns(a: &Args) -> Result>>> {
let Some(v) = a.get("aligns") else { return Ok(None) };
- let items = v.as_array().ok_or_else(|| bad("aligns must be an array of left, center, right, justify or null"))?;
+ let items = v.as_array().ok_or_else(|| bad("aligns must be an array of left, center, right, justify, inherit or null"))?;
if items.len() > MAX_ALIGNS {
return Err(bad(format!("aligns takes at most {MAX_ALIGNS} entries")));
}
@@ -94,8 +94,9 @@ pub(crate) fn opt_aligns(a: &Args) -> Result>>> {
.iter()
.map(|v| match v {
Value::Null => Ok(None),
+ Value::String(s) if s == "inherit" => Ok(None),
Value::String(s) => parse_align(s).map(Some),
- _ => Err(bad("each entry of aligns is left, center, right, justify or null")),
+ _ => Err(bad("each entry of aligns is left, center, right, justify, inherit or null")),
})
.collect::>>()
.map(Some)
diff --git a/crates/automation/src/dispatch.rs b/crates/automation/src/dispatch.rs
index 36e0d00454..8bc23ff280 100644
--- a/crates/automation/src/dispatch.rs
+++ b/crates/automation/src/dispatch.rs
@@ -12,6 +12,35 @@ pub enum Content {
Png { data: Vec, width: u32, height: u32 },
}
+/// `image_edit` `transform`: a matrix `[a b c d e f]` acting on top-left-origin points (a point
+/// moves to `(a·x + c·y + e, b·x + d·y + f)`) → the same motion in PDF user space, which is
+/// what `ImageEdit::Transform` applies after the image's placement. Both spaces are related by
+/// an affine map, so three corners of the crop box pin the result down.
+fn view_transform_to_user(info: &pdfcraft_render::PageInfo, m: [f64; 6]) -> Result<[f64; 6]> {
+ let [a, b, c, d, e, f] = m;
+ let det = a * d - b * c;
+ if !m.iter().all(|v| v.is_finite()) || !det.is_finite() || det.abs() < 1e-9 {
+ return Err(ToolError::InvalidArgs("transform needs a finite matrix that keeps an area (a·d − b·c must not be 0)".into()));
+ }
+ let moved = |x: f32, y: f32| {
+ let [vx, vy] = info.user_to_view(x, y).map(f64::from);
+ info.view_to_user((a * vx + c * vy + e) as f32, (b * vx + d * vy + f) as f32).map(f64::from)
+ };
+ let [x0, y0, x1, y1] = info.crop;
+ let (w, h) = (f64::from(x1 - x0), f64::from(y1 - y0));
+ if w.abs() < 1e-3 || h.abs() < 1e-3 {
+ return Err(ToolError::InvalidArgs("the page has no area to transform in".into()));
+ }
+ let (o, px, py) = (moved(x0, y0), moved(x1, y0), moved(x0, y1));
+ let (ua, ub, uc, ud) = ((px[0] - o[0]) / w, (px[1] - o[1]) / w, (py[0] - o[0]) / h, (py[1] - o[1]) / h);
+ let (x0, y0) = (f64::from(x0), f64::from(y0));
+ let user = [ua, ub, uc, ud, o[0] - ua * x0 - uc * y0, o[1] - ub * x0 - ud * y0];
+ if !user.iter().all(|v| v.is_finite()) {
+ return Err(ToolError::InvalidArgs("the transform moves the image too far".into()));
+ }
+ Ok(user)
+}
+
impl Automation {
/// Run the tool `name` with JSON `args` (an object; `null` means no arguments).
pub fn call(&mut self, name: &str, args: &Value) -> Result> {
@@ -357,7 +386,7 @@ impl Automation {
let (u, v) = (info.user_to_view(rect[0] as f32, rect[1] as f32), info.user_to_view(rect[2] as f32, rect[3] as f32));
[r(u[0].min(v[0])), r(u[1].min(v[1])), r(u[0].max(v[0])), r(u[1].max(v[1]))]
});
- json!({ "visible_rect": visible, "image": i + 1, "rect": [r(u[0].min(v[0])), r(u[1].min(v[1])), r(u[0].max(v[0])), r(u[1].max(v[1]))], "pixels": [im.width, im.height], "name": im.name, "kind": if im.is_form { "form" } else { "image" } })
+ json!({ "visible_rect": visible, "has_editor_crop": im.has_editor_crop(), "image": i + 1, "rect": [r(u[0].min(v[0])), r(u[1].min(v[1])), r(u[0].max(v[0])), r(u[1].max(v[1]))], "pixels": [im.width, im.height], "name": im.name, "kind": if im.is_form { "form" } else { "image" } })
})
.collect();
json!({ "page": page + 1, "count": list.len(), "images": list })
@@ -395,6 +424,16 @@ impl Automation {
let (u0, u1) = (info.view_to_user(r[0] as f32, r[1] as f32), info.view_to_user(r[2] as f32, r[3] as f32));
ImageEdit::Move([u0[0].min(u1[0]) as f64, u0[1].min(u1[1]) as f64, u0[0].max(u1[0]) as f64, u0[1].max(u1[1]) as f64])
}
+ "transform" => {
+ let m: Vec = a
+ .get("matrix")
+ .and_then(Value::as_array)
+ .and_then(|x| x.iter().map(Value::as_f64).collect())
+ .ok_or_else(|| ToolError::InvalidArgs("transform needs matrix: 6 numbers [a, b, c, d, e, f]".into()))?;
+ let m = <[f64; 6]>::try_from(m)
+ .map_err(|_| ToolError::InvalidArgs("transform needs matrix: 6 numbers [a, b, c, d, e, f]".into()))?;
+ ImageEdit::Transform(view_transform_to_user(&self.doc(&a)?.info.pages[page], m)?)
+ }
"rotate_by" => ImageEdit::RotateBy(
a.get("degrees")
.and_then(Value::as_f64)
@@ -410,9 +449,18 @@ impl Automation {
let (u0, u1) = (info.view_to_user(r[0] as f32, r[1] as f32), info.view_to_user(r[2] as f32, r[3] as f32));
ImageEdit::Crop([u0[0].min(u1[0]) as f64, u0[1].min(u1[1]) as f64, u0[0].max(u1[0]) as f64, u0[1].max(u1[1]) as f64])
}
- "flip_horizontal" => ImageEdit::Flip { horizontal: true },
- "flip_vertical" => ImageEdit::Flip { horizontal: false },
+ action @ ("flip_horizontal" | "flip_vertical") => {
+ let horizontal = action == "flip_horizontal";
+ let info = self.doc(&a)?.info.pages.get(page).ok_or_else(|| ToolError::InvalidArgs("the page does not exist".into()))?;
+ // The tool names displayed axes; the engine names PDF user-space axes.
+ ImageEdit::Flip { horizontal: horizontal ^ (info.rotation % 180 == 90) }
+ }
"delete" => ImageEdit::Delete,
+ "bring_to_front" => ImageEdit::Arrange(pdfcraft_engine::ArrangeOrder::BringToFront),
+ "send_to_back" => ImageEdit::Arrange(pdfcraft_engine::ArrangeOrder::SendToBack),
+ "bring_forward" => ImageEdit::Arrange(pdfcraft_engine::ArrangeOrder::BringForward),
+ "send_backward" => ImageEdit::Arrange(pdfcraft_engine::ArrangeOrder::SendBackward),
+ "remove_crop" => ImageEdit::RemoveCrop,
"replace" => {
let path = self.resolve(a.str("path")?, false)?;
let bytes = read_input(&path)?;
@@ -624,6 +672,7 @@ impl Automation {
}
out
}
+ "text_script" => self.text_script(&a)?,
"doc_audit_space" => {
let rows: Vec = self
.doc(&a)?
@@ -815,4 +864,52 @@ impl Automation {
};
Ok(vec![Content::Json(out)])
}
+
+ /// `text_script`: Format text ▸ Superscript or Subscript on a paragraph, or on a byte range
+ /// of its editor text, written as `text_edit` writes the paragraph.
+ fn text_script(&mut self, a: &Args) -> Result {
+ use pdfcraft_engine::text_script::{Script, toggle};
+ let name = a.str("script")?;
+ let script = match name {
+ "superscript" => Script::Super,
+ "subscript" => Script::Sub,
+ other => return Err(ToolError::InvalidArgs(format!("unknown script {other:?} (superscript, subscript)"))),
+ };
+ let page = self.page(a)?;
+ let k = a.int("paragraph")?;
+ let text = {
+ let doc = self.doc(a)?;
+ let blocks = doc.text_blocks(page);
+ let index = self.paragraph_index(doc.id, page, k, &blocks)?;
+ blocks.get(index).map(|b| b.editor_text.clone()).ok_or_else(|| ToolError::InvalidArgs(format!("paragraph {k} is out of range")))?
+ };
+ let range = match a.opt_ints("range")? {
+ None => None,
+ Some(r) => {
+ let bounds = match r.as_slice() {
+ [start, end] => usize::try_from(*start).ok().zip(usize::try_from(*end).ok()),
+ _ => None,
+ };
+ let range = bounds
+ .map(|(start, end)| start..end)
+ .filter(|r| r.start < r.end && r.end <= text.len() && text.is_char_boundary(r.start) && text.is_char_boundary(r.end));
+ let Some(range) = range else {
+ return Err(ToolError::InvalidArgs(format!(
+ "range must be [start, end]: UTF-8 byte offsets of the paragraph's editor_text (from text_paragraphs) with start < end <= {}, on character boundaries",
+ text.len()
+ )));
+ };
+ Some(range)
+ }
+ };
+ let (toggled, _) = toggle(&text, range.as_ref(), script)
+ .ok_or_else(|| ToolError::InvalidArgs(format!("nothing to change: no character of the text has a {name} form")))?;
+ let args = json!({ "doc": a.get("doc"), "page": a.get("page"), "paragraph": k, "text": toggled });
+ let mut out = match self.call("text_edit", &args)?.into_iter().next() {
+ Some(Content::Json(out)) => out,
+ _ => json!({}),
+ };
+ out["script"] = json!(name);
+ Ok(out)
+ }
}
diff --git a/crates/automation/src/tools.rs b/crates/automation/src/tools.rs
index c6c200cece..866138899d 100644
--- a/crates/automation/src/tools.rs
+++ b/crates/automation/src/tools.rs
@@ -175,7 +175,7 @@ pub fn tools() -> Vec {
}), &["doc", "page"])),
t("object_list", "List editable objects", "List existing paragraphs, Image/Form artwork and added content once, with source kind/index references, displayed rectangles and document generation. Indexes change when content changes; use generation in object_move to reject stale references.")
.ro().with(schema(json!({"doc":doc(),"page":{"type":"integer","minimum":1}}), &["doc","page"])),
- t("object_move", "Move objects together", "Atomically translate 1–1000 mixed references from object_list by [dx, dy] in displayed points (right/down). Preserves glyph codes, fonts, image data and relative spacing; success is one undo step. Clipping and vertical text are refused. A bad/stale reference refuses the entire move.")
+ t("object_move", "Move objects together", "Atomically translate 1–1000 mixed references from object_list by [dx, dy] in displayed points (right/down). Preserves glyph codes, fonts, image data and relative spacing; success is one undo step. Text used as a clipping path and vertical text are refused. A bad/stale reference refuses the entire move.")
.with(schema(json!({"doc":doc(),"page":{"type":"integer","minimum":1},
"objects":{"type":"array","minItems":1,"maxItems":1000,"uniqueItems":true,"items":{
"type":"object","properties":{"kind":{"type":"string","enum":["added","text","image"]},"index":{"type":"integer","minimum":1}},"required":["kind","index"],"additionalProperties":false}},
@@ -637,7 +637,7 @@ pub fn tools() -> Vec {
"font": { "type": "string", "enum": ["helvetica", "times", "courier"] }, "size": { "type": "number", "minimum": 1, "maximum": 500 },
"bold": { "type": "boolean" }, "italic": { "type": "boolean" }, "color": { "type": "string" },
"align": { "type": "string", "enum": ["left", "center", "right", "justify"] },
- "aligns": { "type": "array", "maxItems": 4096, "items": { "enum": ["left", "center", "right", "justify", null] }, "description": "Each paragraph's (line's) own alignment, by index; null follows align." },
+ "aligns": { "type": "array", "maxItems": 4096, "items": { "type": "string", "enum": ["left", "center", "right", "justify", "inherit"] }, "description": "Each paragraph's (line's) own alignment, by index; inherit (or legacy null) follows align." },
"char_spacing": { "type": "number", "minimum": -500, "maximum": 500, "description": "Points after each character." },
}),
&["doc", "page", "text"],
@@ -660,7 +660,7 @@ pub fn tools() -> Vec {
"font": { "type": "string", "enum": ["helvetica", "times", "courier"] }, "size": { "type": "number", "minimum": 1, "maximum": 500 },
"bold": { "type": "boolean" }, "italic": { "type": "boolean" }, "color": { "type": "string" },
"align": { "type": "string", "enum": ["left", "center", "right", "justify"] },
- "aligns": { "type": "array", "maxItems": 4096, "items": { "enum": ["left", "center", "right", "justify", null] }, "description": "Each paragraph's (line's) own alignment, by index; null follows align." },
+ "aligns": { "type": "array", "maxItems": 4096, "items": { "type": "string", "enum": ["left", "center", "right", "justify", "inherit"] }, "description": "Each paragraph's (line's) own alignment, by index; inherit (or legacy null) follows align." },
"char_spacing": { "type": "number", "minimum": -500, "maximum": 500, "description": "Points after each character." },
"rotate": { "type": "integer" }, "flip_h": { "type": "boolean" }, "flip_v": { "type": "boolean" },
"crop": { "type": "array", "items": { "type": "number", "minimum": 0, "maximum": 0.95 }, "minItems": 4, "maxItems": 4, "description": "Fractions trimmed: left, bottom, right, top. Left and right together, and bottom and top together, trim at most 0.95." },
@@ -754,7 +754,7 @@ pub fn tools() -> Vec {
json!({
"doc": doc(),
"page": { "type": "integer", "minimum": 1 },
- "type": { "type": "string", "enum": ["note", "highlight", "underline", "strikeout", "squiggly", "replace", "rectangle", "oval", "line", "arrow", "ink", "textbox", "stamp", "polygon", "cloud", "polyline", "callout", "caret", "attachment"] },
+ "type": { "type": "string", "enum": ["note", "highlight", "underline", "strikeout", "squiggly", "replace", "rectangle", "oval", "line", "arrow", "ink", "freehand_highlight", "textbox", "stamp", "polygon", "cloud", "polyline", "callout", "caret", "attachment"] },
"path": { "type": "string", "description": "attachment: the file to attach." },
"points": { "type": "array", "items": point(), "minItems": 2 },
"knee": point(),
@@ -1281,7 +1281,7 @@ pub fn tools() -> Vec {
.ro()
.cmd("ocr.recognize")
.with(schema(json!({}), &[])),
- t("doc_export_all_images", "Export all images", "Write the images that pages use into a folder (`_Page__Image_.jpg|png`, n zero-padded to the page count's digits), each once: JPEG images unchanged, others as PNG with their soft mask as alpha. min_size skips images with fewer pixels on their shorter side. Images that can't be decoded yet (JPEG 2000, JBIG2 inside other filters, separations) are listed under skipped. Includes unsaved edits.")
+ t("doc_export_all_images", "Export all images", "Write the images that pages use into a folder (`_Page__Image_.jpg|png`, n zero-padded to the page count's digits), each once: JPEG images unchanged, others as PNG with their soft mask as alpha. min_size skips images with fewer pixels on their shorter side. Images that can't be decoded yet (JPEG 2000, separations) are listed under skipped. Includes unsaved edits.")
.cmd("export.all_images")
.with(schema(
json!({
@@ -1378,17 +1378,18 @@ pub fn tools() -> Vec {
.ro()
.cmd("edit.edit_text")
.with(schema(json!({ "doc": doc(), "page": { "type": "integer", "minimum": 1 } }), &["doc", "page"])),
- t("image_edit", "Edit an image", "Change one of a page's images (number from page_images): action move (rect: new full placement box in top-left-origin points, based on page_images.rect), crop (rect: the part to keep, top-left-origin points; the pixels stay in place and page_images.visible_rect shows the result; a later move carries the crop along), rotate (quarters clockwise, default 1), rotate_by (degrees: any angle clockwise about the visible centre; the box in page_images then becomes the turned image's bounding box), flip_horizontal, flip_vertical, replace (path: an image file, drawn in the same place) or delete. Undoable. The selected image crop transforms with its pixels, isolating shared path scopes while retaining neighboring painting. Text-outline clips return a clear error. Rotation/flip use the visible centre. Form artwork supports move/resize/rotate/flip/delete as a group; replace and image_save only support raster images.")
+ t("image_edit", "Edit an image", "Change one of a page's images (number from page_images): action move (rect: new full placement box in top-left-origin points, based on page_images.rect), crop (rect: the part to keep, top-left-origin points; the pixels stay in place and page_images.visible_rect shows the result; a later move carries the crop along), remove_crop (remove a crop created by PdfCraft while preserving clipping paths from the original document), rotate (quarters clockwise, default 1), rotate_by (degrees: any angle clockwise about the visible centre; the box in page_images then becomes the turned image's bounding box), transform (matrix: 6 numbers [a, b, c, d, e, f] in top-left-origin points, applied after the current placement so a point (x, y) of the image moves to (a·x + c·y + e, b·x + d·y + f); finite, with a·d − b·c not 0; the box in page_images becomes the transformed image's bounding box), flip_horizontal (reflect left/right on the displayed page), flip_vertical (reflect top/bottom on the displayed page; both flip actions follow the page rotation), replace (path: an image file, drawn in the same place), delete, or arrange: bring_to_front, send_to_back, bring_forward, send_backward (reorder stacking order among content on the page; errors when the image is already at the requested limit; arranging an added image converts it into an ordinary page image). Undoable. The selected image crop transforms with its pixels, isolating shared path scopes while retaining neighboring painting. Text-outline clips return a clear error. Rotation/flip use the visible centre. Form artwork supports move/resize/rotate/flip/delete as a group; replace and image_save only support raster images.")
.cmd("edit.edit_text")
.with(schema(
json!({
"doc": doc(),
"page": { "type": "integer", "minimum": 1 },
"image": { "type": "integer", "minimum": 1 },
- "action": { "type": "string", "enum": ["move", "crop", "rotate", "rotate_by", "flip_horizontal", "flip_vertical", "replace", "delete"] },
+ "action": { "type": "string", "enum": ["move", "crop", "rotate", "rotate_by", "transform", "flip_horizontal", "flip_vertical", "replace", "delete", "bring_to_front", "send_to_back", "bring_forward", "send_backward", "remove_crop"] },
"rect": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 },
"quarters": { "type": "integer" },
"degrees": { "type": "number" },
+ "matrix": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 },
"path": { "type": "string" },
}),
&["doc", "page", "image", "action"],
@@ -1428,7 +1429,7 @@ pub fn tools() -> Vec {
"size": { "type": "number", "exclusiveMinimum": 0 },
"color": { "type": "string", "description": "#rrggbb" },
"align": { "type": "string", "enum": ["left", "center", "right", "justify"] },
- "aligns": { "type": "array", "maxItems": 4096, "items": { "enum": ["left", "center", "right", "justify", null] }, "description": "Each paragraph's (line's) own alignment, by index; null follows align." },
+ "aligns": { "type": "array", "maxItems": 4096, "items": { "type": "string", "enum": ["left", "center", "right", "justify", "inherit"] }, "description": "Each paragraph's (line's) own alignment, by index; inherit (or legacy null) follows align." },
"underline": { "type": "boolean" },
"line_spacing": { "type": "number", "description": "Multiple of the font size (1.2 is ordinary)." },
"dx": { "type": "number", "description": "Paragraph only: move right by this many points (negative: left)." },
@@ -1438,11 +1439,19 @@ pub fn tools() -> Vec {
"scale": { "type": "number", "description": "Horizontal scale in percent." } }),
&["doc", "page"],
)),
+ t("text_script", "Superscript or subscript", "Format text ▸ Superscript or Subscript on one paragraph (paragraph, from text_paragraphs), or on range [start, end): UTF-8 byte offsets of its editor_text. The characters take the Unicode superscript or subscript forms (2 → ², 2 → ₂; the font must have those glyphs, and extracted text contains them); text already in that script goes back to plain characters. Characters Unicode has no such form for (q, a space) stay unchanged and do not determine the selection's script state. Mixed plain and target-script characters normalize to that script, then to plain text on the next call (H₂2 → H₂₂ → H22); a second toggle does not reconstruct the original mixture. Use Undo to restore the exact prior text. The paragraph is then rewritten as text_edit rewrites it, with the same result fields. Refused when no character would change. Undoable. Mathematical minus U+2212 has its own script mapping; ASCII hyphen-minus stays unchanged.")
+ .cmd("edit.edit_text")
+ .with(schema(
+ json!({ "doc": doc(), "page": { "type": "integer", "minimum": 1 }, "paragraph": { "type": "integer", "minimum": 1 },
+ "script": { "type": "string", "enum": ["superscript", "subscript"] },
+ "range": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 2, "maxItems": 2, "description": "UTF-8 byte offsets [start, end) of the paragraph's editor_text; the whole paragraph when omitted." } }),
+ &["doc", "page", "paragraph", "script"],
+ )),
t("doc_revisions", "List revisions", "List the document's saved revisions (oldest first): each incremental update is one. Returns revision number, where it ends in the file and its size, and which signatures sign exactly that revision.")
.with(schema(json!({ "doc": doc() }), &["doc"])),
t("doc_open_revision", "Open a revision", "Open saved revision `revision` (1 = the oldest) of a document as a new, unsaved document, to see the file as it was then.")
.with(schema(json!({ "doc": doc(), "revision": { "type": "integer", "minimum": 1 } }), &["doc", "revision"])),
- t("doc_optimize", "Optimize PDF", "Write an optimized copy to `path` (Acrobat's PDF Optimizer). preset: standard (default; Reduce File Size's choices) or mobile (images to 96 ppi above 144, JPEG high quality); the options below change it. compatibility: retain (default; keeps the document's version, or 1.5 when object streams are written), 1.4, 1.5, 1.6, 1.7 or 2.0. merge_fragments (default true) first puts a page picture drawn as many stacked image strips (as some PDF printers write it) back together into one image, so it can be resampled (merged_images, fragments_merged). color / gray: { downsample, ppi, above_ppi, compression: jpeg|zip|retain, quality 1–100 } (defaults: downsample to 150 ppi above 225, JPEG 60). mono: { downsample, ppi, above_ppi, compression: ccitt_g4|jbig2|retain } for black-and-white images and image masks (default: averaged down to 300 ppi above 450 ppi, counted in images_resampled; stored losslessly as CCITT Group 4 or JBIG2 (or 1-bit Flate, once resampled or packed from more bits) when that is smaller, Group 3 fax images, black-and-white RGB and indexed images using only palette entries 0 and 1 among them, counted in images_recompressed; retain resamples only, a CCITT image staying CCITT and any other becoming Flate). Images are measured where pages draw them and replaced only when smaller. discard_*: thumbnails (default true), alternate_images (true), tags, print_settings; flate_unencoded (true); object_streams (default true; always off for 1.4); lzw_to_flate (true) decodes LZW streams and stores them with Flate instead, leaving any it cannot decode unchanged (lzw_streams counts the streams converted); remove_invalid_links and remove_unreferenced_dests (true); images and forms the pages list but never draw are always dropped (unused_xobjects). discard: Remove Hidden Information categories (metadata, attachments, comments, form-fields, hidden-text, hidden-layers, bookmarks, links-actions-scripts, private-data). Signed documents are refused. The open document is unchanged.")
+ t("doc_optimize", "Optimize PDF", "Write an optimized copy to `path` (Acrobat's PDF Optimizer). preset: standard (default; Reduce File Size's choices) or mobile (images to 96 ppi above 144, JPEG high quality); the options below change it. compatibility: retain (default; keeps the document's version, or 1.5 when object streams are written), 1.4, 1.5, 1.6, 1.7 or 2.0. merge_fragments (default true) first puts a page picture drawn as many stacked image strips (as some PDF printers write it) back together into one image, so it can be resampled (merged_images, fragments_merged). color / gray: { downsample, ppi, above_ppi, compression: jpeg|zip|retain, quality 1–100 } (defaults: downsample to 150 ppi above 225, JPEG 60). mono: { downsample, ppi, above_ppi, compression: ccitt_g4|jbig2|retain } for black-and-white images and image masks (default: averaged down to 300 ppi above 450 ppi, counted in images_resampled; stored losslessly as CCITT Group 4 or JBIG2 (or 1-bit Flate, once resampled or packed from more bits) when that is smaller, Group 3 fax images, JBIG2 images, black-and-white RGB and indexed images using only palette entries 0 and 1 among them, counted in images_recompressed; retain resamples only, a CCITT image staying CCITT, a JBIG2 image JBIG2 and any other becoming Flate). Images are measured where pages draw them and replaced only when smaller. discard_*: thumbnails (default true), alternate_images (true), tags, print_settings; flate_unencoded (true); object_streams (default true; always off for 1.4); lzw_to_flate (true) decodes LZW streams and stores them with Flate instead, leaving any it cannot decode unchanged (lzw_streams counts the streams converted); remove_invalid_links and remove_unreferenced_dests (true); images and forms the pages list but never draw are always dropped (unused_xobjects). discard: Remove Hidden Information categories (metadata, attachments, comments, form-fields, hidden-text, hidden-layers, bookmarks, links-actions-scripts, private-data). Signed documents are refused. The open document is unchanged.")
.cmd("optimize.advanced")
.with(schema(
json!({
diff --git a/crates/automation/tests/it/automation.rs b/crates/automation/tests/it/automation.rs
index 6a5765b911..0d73dbb900 100644
--- a/crates/automation/tests/it/automation.rs
+++ b/crates/automation/tests/it/automation.rs
@@ -664,6 +664,44 @@ fn tool_table_is_well_formed() {
}
}
+fn assert_homogeneous_enums(schema: &Value, path: &str) {
+ fn json_kind(value: &Value) -> &'static str {
+ match value {
+ Value::Null => "null",
+ Value::Bool(_) => "boolean",
+ Value::Number(_) => "number",
+ Value::String(_) => "string",
+ Value::Array(_) => "array",
+ Value::Object(_) => "object",
+ }
+ }
+
+ if let Some(values) = schema.get("enum").and_then(Value::as_array) {
+ let first = values.first().map(json_kind);
+ assert!(values.iter().map(json_kind).all(|kind| Some(kind) == first), "mixed enum types at {path}: {values:?}");
+ }
+ match schema {
+ Value::Object(object) => {
+ for (key, child) in object {
+ assert_homogeneous_enums(child, &format!("{path}.{key}"));
+ }
+ }
+ Value::Array(array) => {
+ for (index, child) in array.iter().enumerate() {
+ assert_homogeneous_enums(child, &format!("{path}[{index}]"));
+ }
+ }
+ _ => {}
+ }
+}
+
+#[test]
+fn tool_schema_enums_have_one_json_type() {
+ for tool in tools() {
+ assert_homogeneous_enums(&tool.input_schema, tool.name);
+ }
+}
+
#[test]
fn explicit_font_and_disjoint_ranges_save_reopen_through_tools() {
let dir = workdir("font-ranges");
@@ -2111,6 +2149,27 @@ fn comments_through_tools() {
save_and_reopen_comments(&dir, &mut a, doc);
}
+#[test]
+fn freehand_highlight_through_tools() {
+ let dir = workdir("freehand-highlight");
+ let mut a = auto(&dir);
+ let doc = ok(&mut a, "doc_open", json!({ "path": "a.pdf" }))["doc"].as_u64().unwrap();
+ ok(
+ &mut a,
+ "comment_add",
+ json!({ "doc": doc, "page": 1, "type": "freehand_highlight", "width": 100,
+ "strokes": [[[20, 100], [120, 100]]] }),
+ );
+ let list = ok(&mut a, "comment_list", json!({ "doc": doc }));
+ assert_eq!(list["count"], 1);
+ assert_eq!(list["comments"][0]["type"], "Ink");
+ assert_eq!(list["comments"][0]["intent"], "FreehandHighlight");
+ assert_eq!(list["comments"][0]["color"], "#FFF000");
+ let undone = ok(&mut a, "edit_undo", json!({ "doc": doc }));
+ assert_eq!(undone["undone"], "Add freehand highlight");
+ assert_eq!(ok(&mut a, "comment_list", json!({ "doc": doc }))["count"], 0);
+}
+
fn add_comment_examples(a: &mut Automation, doc: u64) -> String {
// "Page 2" sits at y = 150 (user space) = 150 from the top of the 300 pt page.
let hl = ok(a, "comment_add", json!({ "doc": doc, "page": 2, "type": "highlight", "find": "page 2", "contents": "check", "author": "Ada" }));
@@ -3286,6 +3345,39 @@ fn editing_existing_text_through_tools() {
assert_eq!(p["lines"].as_array().map(Vec::len), Some(2), "{p}");
}
+/// Format text ▸ Superscript and Subscript without the GUI: a range, then back again over a space
+/// (which has no superscript form), each one undo step; refusals change nothing.
+#[test]
+fn superscript_and_subscript_through_tools() {
+ let dir = workdir("text-script");
+ let mut a = auto(&dir);
+ let doc = ok(&mut a, "doc_open", json!({ "path": "a.pdf" }))["doc"].as_u64().unwrap();
+ let paragraph =
+ |a: &mut Automation| ok(a, "text_paragraphs", json!({ "doc": doc, "page": 2 }))["paragraphs"][0]["text"].as_str().unwrap().to_string();
+ let script = |script: &str, range: Value| json!({ "doc": doc, "page": 2, "paragraph": 1, "script": script, "range": range });
+ // "Page 2": the 2 is byte 5.
+ let r = ok(&mut a, "text_script", script("superscript", json!([5, 6])));
+ assert_eq!((r["script"].as_str(), r["paragraph"]["text"].as_str()), (Some("superscript"), Some("Page ²")), "{r}");
+ assert_eq!(page_text(&mut a, doc)[1], "Page ²");
+ // " ²": the space has no superscript form, and the range still toggles back.
+ ok(&mut a, "text_script", script("superscript", json!([4, 7])));
+ assert_eq!(paragraph(&mut a), "Page 2");
+ assert_eq!(ok(&mut a, "edit_undo", json!({ "doc": doc }))["undone"], "Edit text");
+ assert_eq!(paragraph(&mut a), "Page ²");
+ // Refused, changing nothing: a range that splits ², one past the end, an empty one, a range
+ // with nothing that has a subscript form, an unknown script.
+ for (name, range) in [
+ ("superscript", json!([5, 6])),
+ ("superscript", json!([0, 99])),
+ ("superscript", json!([3, 3])),
+ ("subscript", json!([4, 5])),
+ ("italic", json!([0, 1])),
+ ] {
+ assert!(matches!(a.call("text_script", &script(name, range.clone())), Err(ToolError::InvalidArgs(_))), "{name} {range}");
+ }
+ assert_eq!(paragraph(&mut a), "Page ²");
+}
+
#[test]
fn styled_cyrillic_fallback_is_batched_through_tools_and_reopen() {
if pdfcraft_fonts::document_japanese_font().is_none() {
@@ -3453,6 +3545,13 @@ fn editing_page_images_through_tools() {
assert_eq!(cropped["visible_rect"], json!([10.0, 10.0, 25.0, 30.0]));
ok(&mut a, "image_edit", json!({ "doc": made, "page": 1, "image": 1, "action": "rotate" }));
ok(&mut a, "image_edit", json!({ "doc": made, "page": 1, "image": 1, "action": "flip_horizontal" }));
+ // A single image is already in front and at the back; no-op arrange is refused without dirtying undo.
+ assert!(a.call("image_edit", &json!({ "doc": made, "page": 1, "image": 1, "action": "bring_to_front" })).is_err());
+ assert!(a.call("image_edit", &json!({ "doc": made, "page": 1, "image": 1, "action": "send_to_back" })).is_err());
+ assert!(a.call("image_edit", &json!({ "doc": made, "page": 1, "image": 1, "action": "bring_forward" })).is_err());
+ assert!(a.call("image_edit", &json!({ "doc": made, "page": 1, "image": 1, "action": "send_backward" })).is_err());
+ let r = ok(&mut a, "image_edit", json!({ "doc": made, "page": 1, "image": 1, "action": "remove_crop" }));
+ assert_eq!(r["undo"], "Remove crop");
// Any angle: the box grows to the turned picture's bounds, and it undoes like a quarter turn.
let before = ok(&mut a, "page_images", json!({ "doc": made, "page": 1 }))["images"][0]["rect"].clone();
let r = ok(&mut a, "image_edit", json!({ "doc": made, "page": 1, "image": 1, "action": "rotate_by", "degrees": 30.5 }));
@@ -3472,6 +3571,80 @@ fn editing_page_images_through_tools() {
assert!(matches!(a.call("image_edit", &json!({ "doc": made, "page": 1, "image": 1, "action": "delete" })), Err(ToolError::InvalidArgs(_))));
}
+#[test]
+fn arranging_page_images_through_tools() {
+ let dir = workdir("arrange-page-images");
+ let mut a = auto(&dir);
+ let doc = ok(&mut a, "doc_open", json!({ "path": "a.pdf" }))["doc"].as_u64().unwrap();
+ ok(&mut a, "doc_export_images", json!({ "doc": doc, "folder": "src", "dpi": 18, "pages": [1, 2] }));
+ let made = ok(&mut a, "doc_create", json!({ "from": "images", "paths": ["src/a_page_1.png"] }))["doc"].as_u64().unwrap();
+ ok(&mut a, "page_add_image", json!({ "doc": made, "page": 1, "path": "src/a_page_2.png", "rect": [50, 50, 100, 100] }));
+ assert_eq!(ok(&mut a, "page_images", json!({ "doc": made, "page": 1 }))["count"], 2);
+ let r = ok(&mut a, "image_edit", json!({ "doc": made, "page": 1, "image": 1, "action": "bring_to_front" }));
+ assert_eq!(r["undo"], "Bring to front");
+ let r = ok(&mut a, "image_edit", json!({ "doc": made, "page": 1, "image": 2, "action": "send_to_back" }));
+ assert_eq!(r["undo"], "Send to back");
+ ok(&mut a, "doc_save", json!({ "doc": made, "path": "arranged.pdf" }));
+ let reopened = ok(&mut a, "doc_open", json!({ "path": "arranged.pdf" }))["doc"].as_u64().unwrap();
+ let after_reopen = ok(&mut a, "page_images", json!({ "doc": reopened, "page": 1 }));
+ assert_eq!(after_reopen["count"], 2);
+ assert_eq!(after_reopen["images"][0]["rect"], json!([0.0, 0.0, 50.0, 75.0]));
+ assert_eq!(after_reopen["images"][1]["rect"], json!([50.0, 50.0, 100.0, 100.0]));
+}
+
+/// The transform a rotated-image resize sends (`ImageEdit::Transform`) is reachable headlessly,
+/// in the same top-left-origin points as the other image tools, also on a turned page.
+#[test]
+fn transforming_page_images_through_tools() {
+ let dir = workdir("transform-page-images");
+ let mut a = auto(&dir);
+ let doc = ok(&mut a, "doc_open", json!({ "path": "a.pdf" }))["doc"].as_u64().unwrap();
+ ok(&mut a, "doc_export_images", json!({ "doc": doc, "folder": "src", "dpi": 18, "pages": [1] }));
+ let made = ok(&mut a, "doc_create", json!({ "from": "images", "paths": ["src/a_page_1.png"] }))["doc"].as_u64().unwrap();
+ let rect = |a: &mut Automation| ok(a, "page_images", json!({ "doc": made, "page": 1 }))["images"][0]["rect"].clone();
+ let transform =
+ |a: &mut Automation, m: Value| ok(a, "image_edit", json!({ "doc": made, "page": 1, "image": 1, "action": "transform", "matrix": m }));
+ ok(&mut a, "image_edit", json!({ "doc": made, "page": 1, "image": 1, "action": "move", "rect": [5, 5, 25, 35] }));
+
+ // Right 10, down 20.
+ assert_eq!(transform(&mut a, json!([1, 0, 0, 1, 10, 20]))["undo"], "Transform image");
+ assert_eq!(rect(&mut a), json!([15.0, 25.0, 35.0, 55.0]));
+ // Twice the size about the top-left corner of the page.
+ transform(&mut a, json!([2, 0, 0, 2, 0, 0]));
+ assert_eq!(rect(&mut a), json!([30.0, 50.0, 70.0, 110.0]));
+ // A quarter turn, (x, y) → (200 − y, x): the box turns with it, and it undoes in one step.
+ transform(&mut a, json!([0, 1, -1, 0, 200, 0]));
+ assert_eq!(rect(&mut a), json!([90.0, 30.0, 150.0, 70.0]));
+ ok(&mut a, "edit_undo", json!({ "doc": made }));
+ assert_eq!(rect(&mut a), json!([30.0, 50.0, 70.0, 110.0]));
+
+ // On a turned page "right" is still right on screen.
+ ok(&mut a, "page_rotate", json!({ "doc": made, "pages": [1], "degrees": 90 }));
+ let numbers = |v: Value| [0, 1, 2, 3].map(|i| v[i].as_f64().unwrap());
+ let [x0, y0, x1, y1] = numbers(rect(&mut a));
+ transform(&mut a, json!([1, 0, 0, 1, 10, 0]));
+ let after = numbers(rect(&mut a));
+ for (got, want) in after.into_iter().zip([x0 + 10.0, y0, x1 + 10.0, y1]) {
+ assert!((got - want).abs() < 0.015, "{after:?} is not ({x0}, {y0}, {x1}, {y1}) moved right by 10");
+ }
+
+ // Flat, non-finite, short and missing matrices are refused before anything changes.
+ let before = rect(&mut a);
+ for bad in [
+ json!([1, 2, 2, 4, 0, 0]),
+ json!([0, 0, 0, 0, 0, 0]),
+ json!([1e300, 0, 0, 1e300, 0, 0]),
+ json!([1, 0, 0, 1]),
+ json!([1, 0, "invalid", 0, 1, 10, 0]),
+ json!([1, 0, null, 0, 1, 10, 0]),
+ ] {
+ let r = a.call("image_edit", &json!({ "doc": made, "page": 1, "image": 1, "action": "transform", "matrix": bad }));
+ assert!(matches!(r, Err(ToolError::InvalidArgs(_))), "{bad}: {r:?}");
+ }
+ assert!(matches!(a.call("image_edit", &json!({ "doc": made, "page": 1, "image": 1, "action": "transform" })), Err(ToolError::InvalidArgs(_))));
+ assert_eq!(rect(&mut a), before);
+}
+
#[test]
fn enhance_camera_image_through_tools() {
let dir = workdir("enhance-camera");
@@ -9764,7 +9937,11 @@ fn added_text_lines_take_their_own_alignments() {
let dir = workdir("paragraph-aligns");
let mut a = auto(&dir);
let id = ok(&mut a, "doc_create", json!({"from":"blank","width":600,"height":400}))["doc"].as_u64().unwrap();
- ok(&mut a, "page_add_text", json!({"doc":id,"page":1,"text":"Left line\nRight line","at":[40,50],"width":500,"size":12,"aligns":[null,"right"]}));
+ ok(
+ &mut a,
+ "page_add_text",
+ json!({"doc":id,"page":1,"text":"Left line\nRight line\nInherited line","at":[40,50],"width":500,"size":12,"aligns":[null,"right","inherit"]}),
+ );
let rect = |a: &mut Automation, text: &str| -> Vec {
let lines = ok(a, "text_lines", json!({"doc":id,"page":1}));
let line = lines["lines"].as_array().unwrap().iter().find(|l| l["text"] == text).cloned().unwrap();
@@ -9772,10 +9949,13 @@ fn added_text_lines_take_their_own_alignments() {
};
assert!((rect(&mut a, "Left line")[0] - 40.0).abs() < 1.0);
assert!((rect(&mut a, "Right line")[2] - 540.0).abs() < 1.0, "{:?}", rect(&mut a, "Right line"));
+ assert!((rect(&mut a, "Inherited line")[0] - 40.0).abs() < 1.0);
// The whole box centred: the right-aligned line goes with it.
ok(&mut a, "content_update", json!({"doc":id,"page":1,"index":1,"align":"center"}));
let right = rect(&mut a, "Right line");
assert!(((right[0] + right[2]) / 2.0 - 290.0).abs() < 1.0, "{right:?}");
+ let inherited = rect(&mut a, "Inherited line");
+ assert!(((inherited[0] + inherited[2]) / 2.0 - 290.0).abs() < 1.0, "{inherited:?}");
assert!(a.call("content_update", &json!({"doc":id,"page":1,"index":1,"aligns":["sideways"]})).is_err());
assert!(a.call("content_update", &json!({"doc":id,"page":1,"index":1,"aligns":"right"})).is_err());
}
@@ -10190,3 +10370,154 @@ fn simple_rule_scan_drawn(content: &[u8]) -> Vec {
}
write_full(&doc, &SaveOptions::default()).unwrap()
}
+
+#[test]
+fn editor_crop_group_move_and_arrange_survive_added_item_deletion_through_tools() {
+ let dir = workdir("editor-crop-group-arrange");
+ let mut a = auto(&dir);
+ let source = ok(&mut a, "doc_open", json!({"path":"a.pdf"}))["doc"].as_u64().unwrap();
+ ok(&mut a, "doc_export_images", json!({"doc":source,"folder":"src","dpi":18,"pages":[1]}));
+ let doc = ok(&mut a, "doc_create", json!({"from":"images","paths":["src/a_page_1.png"]}))["doc"].as_u64().unwrap();
+ ok(&mut a, "image_edit", json!({"doc":doc,"page":1,"image":1,"action":"move","rect":[5,5,25,35]}));
+ ok(&mut a, "image_edit", json!({"doc":doc,"page":1,"image":1,"action":"crop","rect":[10,10,20,30]}));
+ ok(&mut a, "page_add_text", json!({"doc":doc,"page":1,"text":"Movable label","rect":[2,40,45,55],"size":6}));
+ let inventory = ok(&mut a, "object_list", json!({"doc":doc,"page":1}));
+ let objects: Vec<_> = inventory["objects"].as_array().unwrap().iter().map(|o| json!({"kind":o["kind"],"index":o["index"]})).collect();
+ assert_eq!(objects.len(), 2);
+ let moved = ok(&mut a, "object_move", json!({"doc":doc,"page":1,"objects":objects,"offset":[3,4]}));
+ assert_eq!(moved["moved"], 2);
+ let picture = ok(&mut a, "page_images", json!({"doc":doc,"page":1}))["images"][0].clone();
+ assert_eq!(picture["rect"], json!([8.0, 9.0, 28.0, 39.0]));
+ assert_eq!(picture["visible_rect"], json!([13.0, 14.0, 23.0, 34.0]));
+ assert!(page_text(&mut a, doc)[0].contains("Movable label"));
+ ok(&mut a, "edit_undo", json!({"doc":doc}));
+ assert_eq!(ok(&mut a, "page_images", json!({"doc":doc,"page":1}))["images"][0]["visible_rect"], json!([10.0, 10.0, 20.0, 30.0]));
+ ok(&mut a, "edit_redo", json!({"doc":doc}));
+ ok(&mut a, "doc_save", json!({"doc":doc,"path":"grouped.pdf"}));
+ let reopened = ok(&mut a, "doc_open", json!({"path":"grouped.pdf"}))["doc"].as_u64().unwrap();
+ assert_eq!(ok(&mut a, "page_images", json!({"doc":reopened,"page":1}))["images"][0]["visible_rect"], picture["visible_rect"]);
+ ok(&mut a, "image_edit", json!({"doc":reopened,"page":1,"image":1,"action":"bring_to_front"}));
+ assert_eq!(ok(&mut a, "content_list", json!({"doc":reopened}))["count"], 1);
+ ok(&mut a, "content_delete", json!({"doc":reopened,"page":1,"index":1}));
+ ok(&mut a, "doc_save", json!({"doc":reopened,"path":"independent.pdf"}));
+ let saved = ok(&mut a, "doc_open", json!({"path":"independent.pdf"}))["doc"].as_u64().unwrap();
+ let after = ok(&mut a, "page_images", json!({"doc":saved,"page":1}));
+ assert_eq!(after["count"], 1);
+ assert_eq!(after["images"][0]["rect"], picture["rect"]);
+ assert_eq!(after["images"][0]["visible_rect"], picture["visible_rect"]);
+ let rendered = a.call("page_render", &json!({"doc":saved,"page":1,"dpi":72})).unwrap();
+ assert!(rendered.iter().any(|c| matches!(c, Content::Png {data,width,height} if !data.is_empty() && *width > 0 && *height > 0)));
+}
+
+#[test]
+fn image_flip_tools_follow_displayed_axes_on_every_page_rotation() {
+ fn corners(a: &Automation, id: u64) -> [[f64; 2]; 4] {
+ let doc = a.session().get(pdfcraft_engine::DocId(id)).unwrap();
+ let [aa, b, c, d, e, f] = doc.page_images(0)[0].matrix;
+ [(0.0, 0.0), (1.0, 0.0), (0.0, 1.0), (1.0, 1.0)]
+ .map(|(x, y)| doc.info.pages[0].user_to_view((aa * x + c * y + e) as f32, (b * x + d * y + f) as f32).map(f64::from))
+ }
+ fn raster(a: &mut Automation, id: u64) -> (usize, usize, Vec) {
+ let rendered = a.call("page_render", &json!({"doc":id,"page":1,"dpi":72})).unwrap();
+ let Content::Png { data, .. } = &rendered[0] else { panic!("expected PNG") };
+ let mut reader = png::Decoder::new(std::io::Cursor::new(data)).read_info().unwrap();
+ let mut bytes = vec![0; reader.output_buffer_size().unwrap()];
+ let frame = reader.next_frame(&mut bytes).unwrap();
+ bytes.truncate(frame.buffer_size());
+ if frame.color_type == png::ColorType::Rgb {
+ bytes = bytes.as_chunks::<3>().0.iter().flat_map(|&[r, g, b]| [r, g, b, 255]).collect();
+ } else {
+ assert_eq!(frame.color_type, png::ColorType::Rgba);
+ }
+ (frame.width as usize, frame.height as usize, bytes)
+ }
+ let dir = workdir("displayed-image-flip");
+ let mut png_bytes = Vec::new();
+ {
+ let mut encoder = png::Encoder::new(&mut png_bytes, 8, 4);
+ encoder.set_color(png::ColorType::Rgb);
+ let colors = [[240, 20, 30], [20, 230, 40], [30, 40, 220], [220, 210, 20]];
+ let pixels: Vec = (0..4).flat_map(|y| (0..8).flat_map(move |x| colors[usize::from(x >= 4) + 2 * usize::from(y >= 2)])).collect();
+ encoder.write_header().unwrap().write_image_data(&pixels).unwrap();
+ }
+ std::fs::write(dir.join("quadrants.png"), png_bytes).unwrap();
+ let mut a = auto(&dir);
+ let mut failures = Vec::new();
+ for rotation in [0, 90, 180, 270] {
+ let doc = ok(&mut a, "doc_create", json!({"from":"images","paths":["quadrants.png"]}))["doc"].as_u64().unwrap();
+ if rotation != 0 {
+ ok(&mut a, "page_rotate", json!({"doc":doc,"pages":[1],"degrees":rotation}));
+ }
+ let before = corners(&a, doc);
+ let (width, height, pixels) = raster(&mut a, doc);
+ let xmin = before.iter().map(|p| p[0]).fold(f64::INFINITY, f64::min);
+ let xmax = before.iter().map(|p| p[0]).fold(f64::NEG_INFINITY, f64::max);
+ let ymin = before.iter().map(|p| p[1]).fold(f64::INFINITY, f64::min);
+ let ymax = before.iter().map(|p| p[1]).fold(f64::NEG_INFINITY, f64::max);
+ for (action, horizontal) in [("flip_horizontal", true), ("flip_vertical", false)] {
+ ok(&mut a, "image_edit", json!({"doc":doc,"page":1,"image":1,"action":action}));
+ let after = corners(&a, doc);
+ for (old, new) in before.into_iter().zip(after) {
+ let expected = if horizontal { [xmin + xmax - old[0], old[1]] } else { [old[0], ymin + ymax - old[1]] };
+ if new.into_iter().zip(expected).any(|(actual, want)| (actual - want).abs() > 0.001) {
+ failures.push(format!("rotation {rotation} {action}: corner {old:?} became {new:?}, expected {expected:?}"));
+ break;
+ }
+ }
+ let (new_width, new_height, actual_pixels) = raster(&mut a, doc);
+ assert_eq!((new_width, new_height), (width, height));
+ let mut expected_pixels = Vec::new();
+ for y in 0..height {
+ for x in 0..width {
+ let source = if horizontal { (y * width + width - 1 - x) * 4 } else { ((height - 1 - y) * width + x) * 4 };
+ expected_pixels.extend_from_slice(&pixels[source..source + 4]);
+ }
+ }
+ if actual_pixels.iter().zip(&expected_pixels).any(|(actual, want)| actual.abs_diff(*want) > 1) {
+ failures.push(format!("rotation {rotation} {action}: raster flipped the wrong displayed axis"));
+ }
+ assert_ne!(actual_pixels, pixels, "the asymmetric image makes both flip axes observable");
+ ok(&mut a, "edit_undo", json!({"doc":doc}));
+ assert_eq!(corners(&a, doc), before, "one undo restores the original placement");
+ }
+ }
+ assert!(failures.is_empty(), "{}", failures.join("\n"));
+}
+
+#[test]
+fn mixed_script_tools_normalize_but_undo_restores_the_exact_mixture() {
+ let dir = workdir("mixed-script-policy");
+ let mut a = auto(&dir);
+ for (script, mixed, uniform, plain) in [("superscript", "Q²2", "Q²²", "Q22"), ("subscript", "H₂2", "H₂₂", "H22")] {
+ let doc = ok(&mut a, "doc_open", json!({"path":"a.pdf"}))["doc"].as_u64().unwrap();
+ ok(&mut a, "text_edit", json!({"doc":doc,"page":1,"paragraph":1,"text":mixed,"size":14,"width":160}));
+ let paragraph =
+ |a: &mut Automation| ok(a, "text_paragraphs", json!({"doc":doc,"page":1}))["paragraphs"][0]["editor_text"].as_str().unwrap().to_owned();
+ assert_eq!(paragraph(&mut a), mixed);
+ let before = a.session().get(pdfcraft_engine::DocId(doc)).unwrap().bytes.clone();
+ let args = json!({"doc":doc,"page":1,"paragraph":1,"script":script});
+ let once = ok(&mut a, "text_script", args.clone());
+ assert_eq!(once["paragraph"]["text"], uniform);
+ assert_eq!(paragraph(&mut a), uniform);
+ ok(&mut a, "text_script", args);
+ assert_eq!(paragraph(&mut a), plain);
+ assert_ne!(plain, mixed, "normalization does not promise to recreate the original mixture");
+ ok(&mut a, "edit_undo", json!({"doc":doc}));
+ assert_eq!(paragraph(&mut a), uniform, "one Undo restores the preceding scripted text");
+ ok(&mut a, "edit_undo", json!({"doc":doc}));
+ assert_eq!(paragraph(&mut a), mixed, "Undo restores the exact initial Unicode mixture");
+ assert_eq!(
+ a.session().get(pdfcraft_engine::DocId(doc)).unwrap().bytes.as_ref(),
+ before.as_ref(),
+ "Undo also restores the exact prior document bytes"
+ );
+ ok(&mut a, "edit_redo", json!({"doc":doc}));
+ assert_eq!(paragraph(&mut a), uniform);
+ ok(&mut a, "edit_redo", json!({"doc":doc}));
+ assert_eq!(paragraph(&mut a), plain);
+ let path = format!("mixed-{script}.pdf");
+ ok(&mut a, "doc_save", json!({"doc":doc,"path":path}));
+ let reopened = ok(&mut a, "doc_open", json!({"path":path}))["doc"].as_u64().unwrap();
+ assert_eq!(page_text(&mut a, reopened)[0], plain);
+ }
+}
diff --git a/crates/content/src/lib.rs b/crates/content/src/lib.rs
index c52916d332..4957f86861 100644
--- a/crates/content/src/lib.rs
+++ b/crates/content/src/lib.rs
@@ -730,11 +730,14 @@ impl Matrix {
pub fn invert(&self) -> Option {
let [a, b, c, d, e, f] = self.0;
let det = a * d - b * c;
- if det.abs() < 1e-12 || !det.is_finite() {
+ if det == 0.0 || !det.is_finite() || det.abs() <= 1e-12 * ((a * d).abs() + (b * c).abs()) {
return None;
}
let (ia, ib, ic, id) = (d / det, -b / det, -c / det, a / det);
- Some(Matrix([ia, ib, ic, id, -(e * ia + f * ic), -(e * ib + f * id)]))
+ let inverse = [ia, ib, ic, id, -(e * ia + f * ic), -(e * ib + f * id)];
+ // A determinant that underflows toward zero can still pass the relative check above,
+ // and dividing by it overflows: such a matrix has no usable inverse.
+ inverse.iter().all(|v| v.is_finite()).then_some(Matrix(inverse))
}
/// The bounding box of a rectangle `[x0 y0 x1 y1]` after this transform.
diff --git a/crates/content/src/tests.rs b/crates/content/src/tests.rs
index c5c7a3aaac..9ac9297cd2 100644
--- a/crates/content/src/tests.rs
+++ b/crates/content/src/tests.rs
@@ -552,3 +552,17 @@ fn inline_images_end_where_the_renderer_ends_them() {
assert_eq!((parsed.skipped, parsed.ambiguous_images), (0, 0), "{}", String::from_utf8_lossy(data));
}
}
+
+#[test]
+fn invert_accepts_small_scale_and_rejects_singular() {
+ let m = Matrix([1e-7, 0., 0., 1e-7, 0., 0.]);
+ let inv = m.invert().expect("a uniform 1e-7 scale is invertible");
+ let id = m.then(&inv).0;
+ for (got, want) in id.iter().zip(Matrix::IDENTITY.0) {
+ assert!((got - want).abs() < 1e-9, "{id:?}");
+ }
+ assert!(Matrix([1., 2., 2., 4., 0., 0.]).invert().is_none());
+ assert!(Matrix([f64::NAN, 0., 0., 1., 0., 0.]).invert().is_none());
+ // A subnormal scale passes the relative check but its inverse overflows (CodeRabbit on #5703).
+ assert!(Matrix([1e-310, 0., 0., 1., 0., 0.]).invert().is_none());
+}
diff --git a/crates/cos/README.md b/crates/cos/README.md
index 2cf3342954..1e2551036f 100644
--- a/crates/cos/README.md
+++ b/crates/cos/README.md
@@ -90,6 +90,8 @@ recognisable in a diff and byte-stable when re-serialized.
- Linearized output, Fast Web View (`core.linearization`, M11).
- Structural validation against the Arlington model (`core.arlington-validation`), which will live
in the reserved `arlington` crate.
-- Image codecs. `pdfcraft-filters` carries the non-image filters and CCITT fax decoding
- (`Document::decoded_image`); DCT, JPX and JBIG2 are still decoded through the bootstrap renderer
- (`core.image-filters`, M2.6).
+- Image codecs. `pdfcraft-filters` carries the non-image filters and CCITT fax and JBIG2 decoding
+ (`Document::decoded_image`, a JBIG2 image's `/JBIG2Globals` within `MAX_JBIG2_GLOBALS`, 32 MiB,
+ their filters undone once a document for the images that share them, up to 64 MiB kept, while
+ their segments are decoded for every image);
+ DCT and JPX are still decoded through the bootstrap renderer (`core.image-filters`, M2.6).
diff --git a/crates/cos/src/document.rs b/crates/cos/src/document.rs
index 0d9b84b749..082d1910d1 100644
--- a/crates/cos/src/document.rs
+++ b/crates/cos/src/document.rs
@@ -10,7 +10,7 @@ use std::collections::{BTreeMap, HashMap, HashSet};
use std::sync::{Arc, Mutex, Weak};
use crate::CosError;
-use crate::object::{Dict, MAX_DECODED, ObjRef, Object, Stream};
+use crate::object::{Dict, MAX_DECODED, MAX_JBIG2_GLOBALS, ObjRef, Object, Stream};
use crate::parser::{EndstreamIndex, Lexer, is_whitespace, parse_indirect, parse_indirect_shared};
mod objects;
@@ -49,6 +49,9 @@ pub struct Document {
repair_log: Arc>,
cache: Arc>>>,
objstms: Arc>>>,
+ /// What `/JBIG2Globals` streams of the file decode to, by object number: the images of a scan
+ /// share them, and each would otherwise decode them again (see `Document::jbig2_globals`).
+ jbig2_globals: Arc>>>>,
stream_limit: usize,
overlay: BTreeMap,
next_num: u32,
diff --git a/crates/cos/src/document/objects.rs b/crates/cos/src/document/objects.rs
index 4f05d03ae0..bab99ac45e 100644
--- a/crates/cos/src/document/objects.rs
+++ b/crates/cos/src/document/objects.rs
@@ -1,7 +1,13 @@
use super::reader::find;
use super::state::{LENGTHS, LoadGuard, ObjStm, ObjectReader, ReadState, Slot, SourceIdentity, objstm_member, owned_bytes};
use super::xref::{Revision, XrefEntry};
-use super::{Arc, CosError, Cow, Dict, Document, Lexer, MAX_DECODED, ObjRef, Object, Stream, is_whitespace, parse_indirect_shared};
+use super::{
+ Arc, CosError, Cow, Dict, Document, Lexer, MAX_DECODED, MAX_JBIG2_GLOBALS, ObjRef, Object, Stream, is_whitespace, parse_indirect_shared,
+};
+
+/// The most decoded `/JBIG2Globals` a document keeps for its images to share (see
+/// `Document::jbig2_globals`): two streams at [`MAX_JBIG2_GLOBALS`].
+const JBIG2_GLOBALS_HELD: usize = 2 * MAX_JBIG2_GLOBALS;
impl Document {
pub fn bytes(&self) -> &Arc> {
@@ -233,18 +239,7 @@ impl Document {
if !matches!(chain.last(), Some((pdfcraft_filters::Filter::CcittFax, _))) {
return None;
}
- // Its place in /Filter, /Crypt included, pairs it with its /DecodeParms entry (§7.4.1): the
- // last filter but a /Crypt, which `filters` leaves out wherever it stands.
- let index = match s.dict.get(b"Filter") {
- Some(Object::Array(a)) => a.iter().rposition(|f| f.as_name() != Some(b"Crypt".as_slice())).unwrap_or(0),
- _ => 0,
- };
- let parms = match s.dict.get(b"DecodeParms").map(|p| self.resolve(p)).as_deref() {
- Some(Object::Array(a)) => a.get(index).and_then(|p| self.dict(p)),
- Some(p) if index == 0 => p.as_dict().cloned(),
- _ => None,
- }
- .unwrap_or_default();
+ let parms = self.last_filter_parms(s);
let int = |key: &[u8], default: i64| parms.get(key).and_then(|v| self.resolve(v).as_int()).unwrap_or(default);
let flag = |key: &[u8], default: bool| match parms.get(key).map(|v| self.resolve(v)).as_deref() {
Some(Object::Bool(b)) => *b,
@@ -262,23 +257,62 @@ impl Document {
})
}
+ /// The `/DecodeParms` dictionary of stream `s`'s last filter, resolved: that of a lone filter,
+ /// or its entry in an array. Empty when there is none.
+ fn last_filter_parms(&self, s: &Stream) -> Dict {
+ // Its place in /Filter, /Crypt included, pairs it with its /DecodeParms entry (§7.4.1): the
+ // last filter but a /Crypt, which `filters` leaves out wherever it stands.
+ let index = match s.dict.get(b"Filter") {
+ Some(Object::Array(a)) => a.iter().rposition(|f| f.as_name() != Some(b"Crypt".as_slice())).unwrap_or(0),
+ _ => 0,
+ };
+ match s.dict.get(b"DecodeParms").map(|p| self.resolve(p)).as_deref() {
+ Some(Object::Array(a)) => a.get(index).and_then(|p| self.dict(p)),
+ Some(p) if index == 0 => p.as_dict().cloned(),
+ _ => None,
+ }
+ .unwrap_or_default()
+ }
+
/// The samples of image `s`, decoded: through its filters ([`Stream::decoded`]), or, for a
- /// CCITT fax image (its last filter), through the filters before it and then
- /// [`pdfcraft_filters::decode_ccitt`] with its [`Document::fax_params`], as `CCITTFaxDecode`
- /// gives them (ISO 32000-2 §7.4.6). Parameters given by reference count, for every filter
- /// ([`Document::with_direct_parms`]). A fax image's `/Columns` has to be its `/Width`. Up to
- /// its `/Height` rows are decoded, whatever `/Rows` says, within [`MAX_DECODED`] bytes; damaged
- /// data gives fewer, so a caller checks it has the rows it needs.
+ /// CCITT fax or JBIG2 image (its last filter), through the filters before it and then
+ /// [`pdfcraft_filters::decode_ccitt`] with its [`Document::fax_params`], or
+ /// [`pdfcraft_filters::decode_jbig2`] with its `/JBIG2Globals`, as `CCITTFaxDecode` and
+ /// `JBIG2Decode` give them (ISO 32000-2 §7.4.6, §7.4.7). Parameters given by reference count,
+ /// for every filter ([`Document::with_direct_parms`]). A fax image's `/Columns` has to be its
+ /// `/Width`, and a JBIG2 image's page its `/Width` × `/Height`: PdfCraft's renderer draws the
+ /// whole page into the image. Up to its `/Height` rows are decoded, whatever a fax image's `/Rows` says,
+ /// within [`MAX_DECODED`] bytes; damaged fax data gives fewer, so a caller checks it has the
+ /// rows it needs. Damaged JBIG2 data, and globals that can't be read (within
+ /// [`MAX_JBIG2_GLOBALS`]), are an error.
pub fn decoded_image(&self, s: &Stream) -> Result, CosError> {
self.decoded_image_within(s, MAX_DECODED)
}
/// [`Document::decoded_image`] for an image whose decoding has a tighter bound than
- /// [`MAX_DECODED`]: no stage, the filters before a fax decoder included, may produce more than
- /// `max` bytes.
+ /// [`MAX_DECODED`]: no stage, the filters before a fax or JBIG2 decoder included, may produce
+ /// more than `max` bytes. A JBIG2 image's `/JBIG2Globals` are another stream, shared between
+ /// images, and are decoded within [`MAX_JBIG2_GLOBALS`] whatever `max` is.
pub fn decoded_image_within(&self, s: &Stream, max: usize) -> Result, CosError> {
let max = max.min(MAX_DECODED);
let s = &*self.with_direct_parms(s);
+ let filter = |e: pdfcraft_filters::FilterError| CosError::Filter(e.to_string());
+ let chain = s.readable_filters().map_err(filter)?;
+ // The filters before the image codec, such as ASCII85Decode, are undone first.
+ let undo = |before: &[(pdfcraft_filters::Filter, pdfcraft_filters::Params)]| match before {
+ [] => Ok(Cow::Borrowed(&s.raw[..])),
+ _ => pdfcraft_filters::decode_tolerant(before, &s.raw, max).map(|(data, _)| Cow::Owned(data)).map_err(filter),
+ };
+ // `/Width` and `/Height` are read as given directly, as every caller reads them first: one
+ // given by reference has the image refused there, before it gets here.
+ let height = s.dict.int(b"Height").and_then(|h| u32::try_from(h).ok());
+ if let Some(((pdfcraft_filters::Filter::Jbig2, _), before)) = chain.split_last() {
+ let (Some(columns), Some(height)) = (s.dict.int(b"Width").and_then(|w| u32::try_from(w).ok()), height) else {
+ return Err(CosError::Filter("a JBIG2 image's /Width or /Height isn't a size".into()));
+ };
+ let globals = self.jbig2_globals(s)?;
+ return pdfcraft_filters::decode_jbig2(&undo(before)?, globals.as_deref().map(Vec::as_slice), columns, height, max).map_err(filter);
+ }
let Some(p) = self.fax_params(s) else { return s.decoded_within(max) };
// As many rows as the image has: a /Rows below /Height would cut the picture short, and
// rows past /Height aren't drawn.
@@ -286,18 +320,65 @@ impl Document {
if s.dict.int(b"Width") != Some(p.columns) {
return Err(CosError::Filter("a fax image's /Columns aren't its /Width".into()));
}
- let height = s.dict.int(b"Height").and_then(|h| u32::try_from(h).ok()).unwrap_or(0);
let stride = usize::try_from(p.columns).unwrap_or(usize::MAX).div_ceil(8).max(1);
- let rows = u32::try_from(max / stride).unwrap_or(u32::MAX).min(height);
- // The filters before it, such as ASCII85Decode, are undone first.
- let chain = s.readable_filters().map_err(|e| CosError::Filter(e.to_string()))?;
- let data = match chain.split_last() {
- Some((_, before)) if !before.is_empty() => {
- Cow::Owned(pdfcraft_filters::decode_tolerant(before, &s.raw, max).map_err(|e| CosError::Filter(e.to_string()))?.0)
- }
- _ => Cow::Borrowed(&s.raw[..]),
+ let rows = u32::try_from(max / stride).unwrap_or(u32::MAX).min(height.unwrap_or(0));
+ let data = undo(chain.split_last().map_or(&[][..], |(_, before)| before))?;
+ pdfcraft_filters::decode_ccitt(&data, &p, rows).map_err(filter)
+ }
+
+ /// The `/JBIG2Globals` stream a JBIG2 image `s` names by reference in its last filter's
+ /// `/DecodeParms`: `None` for a stream whose last filter isn't `JBIG2Decode`, or one without
+ /// globals. Redaction finds with it the other images that share a redacted image's globals.
+ pub fn jbig2_globals_ref(&self, s: &Stream) -> Option {
+ let chain = s.readable_filters().ok()?;
+ if !matches!(chain.last(), Some((pdfcraft_filters::Filter::Jbig2, _))) {
+ return None;
+ }
+ self.last_filter_parms(s).get(b"JBIG2Globals").and_then(Object::as_ref)
+ }
+
+ /// What the `/JBIG2Globals` stream of JBIG2 image `s` (in its last filter's `/DecodeParms`)
+ /// decodes to, within [`MAX_JBIG2_GLOBALS`]; `None` without one (a reference to no object is
+ /// one to null, ISO 32000-2 §7.3.10, which is an absent entry, §7.3.7). The image is then read
+ /// without them, as the renderer draws it, so an image that needed them mostly fails to decode
+ /// and can decode to other pixels. A stream that is there and can't be read is an error, rather
+ /// than the image decoded without it.
+ ///
+ /// The images of a scan share one globals stream, so a stream of the file, not edited since
+ /// it was read (the same in every clone) and with its `/DecodeParms` direct (by reference they
+ /// are another object, which can change while this one doesn't), has its filters undone once a
+ /// document and is kept, up to [`JBIG2_GLOBALS_HELD`] in all; others are read each time. That
+ /// saves the filters only: the segments it holds are decoded again for every image.
+ fn jbig2_globals(&self, s: &Stream) -> Result>>, CosError> {
+ let Some(entry) = self.last_filter_parms(s).get(b"JBIG2Globals").cloned() else { return Ok(None) };
+ let held = match entry {
+ Object::Ref(r) if !self.overlay.contains_key(&r.num) => Some(r.num),
+ _ => None,
};
- pdfcraft_filters::decode_ccitt(&data, &p, rows).map_err(|e| CosError::Filter(e.to_string()))
+ if let Some(hit) = held.and_then(|num| self.jbig2_globals.lock().ok()?.get(&num).cloned()) {
+ return Ok(Some(hit));
+ }
+ let Object::Stream(g) = &*self.resolve(&entry) else { return Ok(None) };
+ let readable = self.with_direct_parms(g);
+ let held = held.filter(|_| matches!(readable, Cow::Borrowed(_)));
+ let mut data = readable.decoded_within(MAX_JBIG2_GLOBALS).map_err(|e| {
+ let detail = match e {
+ CosError::Filter(detail) => detail,
+ e => e.to_string(),
+ };
+ CosError::Filter(format!("the JBIG2 globals can't be read: {detail}"))
+ })?;
+ // What is kept counts by its length, so that's all it may hold on to.
+ data.shrink_to_fit();
+ let data = Arc::new(data);
+ // A poisoned lock only means nothing is kept.
+ if let (Some(num), Ok(mut kept)) = (held, self.jbig2_globals.lock()) {
+ let total = kept.values().map(|g| g.len()).fold(data.len(), usize::saturating_add);
+ if total <= JBIG2_GLOBALS_HELD {
+ kept.insert(num, data.clone());
+ }
+ }
+ Ok(Some(data))
}
pub fn try_get(&self, num: u32) -> Result, CosError> {
diff --git a/crates/cos/src/document/open.rs b/crates/cos/src/document/open.rs
index 57d697ed66..395424b771 100644
--- a/crates/cos/src/document/open.rs
+++ b/crates/cos/src/document/open.rs
@@ -19,6 +19,7 @@ impl Document {
repair_log: Arc::new(Vec::new()),
cache: Arc::default(),
objstms: Arc::default(),
+ jbig2_globals: Arc::default(),
stream_limit: crate::object::MAX_DECODED,
overlay: BTreeMap::new(),
next_num: 1,
@@ -102,6 +103,7 @@ impl Document {
repair_log: Arc::new(Vec::new()),
cache: Arc::default(),
objstms: Arc::default(),
+ jbig2_globals: Arc::default(),
stream_limit: stream_limit.min(crate::object::MAX_DECODED),
overlay: BTreeMap::new(),
next_num: 1,
diff --git a/crates/cos/src/document/tests.rs b/crates/cos/src/document/tests.rs
index f5e36f9c83..cca4b87326 100644
--- a/crates/cos/src/document/tests.rs
+++ b/crates/cos/src/document/tests.rs
@@ -173,6 +173,217 @@ fn fax_images_decode_with_their_parameters() {
assert!(behind(&[Object::Int(5), fax], &[null, own], coded.clone()).is_err(), "a /Filter entry that isn't a name");
}
+/// Images that share a `/JBIG2Globals` stream of the file decode it once a document: it is kept
+/// for the next, in every clone. A globals stream edited since is read afresh (the kept one is the
+/// file's), and objects added in memory aren't kept.
+#[test]
+fn shared_jbig2_globals_are_read_once() {
+ let bits = [0b1111_1000, 0, 0b1111_1000, 0, 0b1111_1000, 0];
+ let coded = pdfcraft_filters::encode_jbig2_generic(&bits, 10, 3).unwrap();
+ let mut doc = Document::new_empty();
+ let mut d = Dict::new();
+ d.set(b"Filter".to_vec(), Object::name("FlateDecode"));
+ let skipped = [0, 0, 0, 0, 0x3E, 0, 0, 0, 0, 0, 4, 0, 0, 0, 1];
+ let globals = doc.add(Object::Stream(Stream::from_raw(d, pdfcraft_filters::encode_flate(&skipped))));
+ let image = |doc: &mut Document| {
+ let mut d = Dict::new();
+ d.set(b"Width".to_vec(), Object::Int(10));
+ d.set(b"Height".to_vec(), Object::Int(3));
+ d.set(b"Filter".to_vec(), Object::name("JBIG2Decode"));
+ let mut parms = Dict::new();
+ parms.set(b"JBIG2Globals".to_vec(), Object::Ref(globals));
+ d.set(b"DecodeParms".to_vec(), Object::Dict(parms));
+ doc.add(Object::Stream(Stream::from_raw(d, coded.clone())))
+ };
+ let (a, b) = (image(&mut doc), image(&mut doc));
+ let stream = |doc: &Document, r: ObjRef| match &*doc.get(r) {
+ Object::Stream(s) => s.clone(),
+ _ => panic!("not a stream"),
+ };
+ assert_eq!(doc.decoded_image(&stream(&doc, a)).unwrap(), bits);
+ assert!(doc.jbig2_globals.lock().unwrap().is_empty(), "an object added in memory isn't kept");
+
+ // The same objects read from a file, the catalog holding on to the images (a full save may
+ // number them anew).
+ let root = doc.root().unwrap();
+ doc.update_dict(root, |c| c.set(b"Images".to_vec(), Object::Array(vec![Object::Ref(a), Object::Ref(b)]))).unwrap();
+ let file = crate::write_full(&doc, &crate::SaveOptions::default()).unwrap();
+ let mut doc = Document::open(Arc::new(file)).unwrap();
+ let images = doc.get(doc.root().unwrap()).as_dict().unwrap().get(b"Images").unwrap().as_array().unwrap().clone();
+ let (a, b) = (images[0].as_ref().unwrap(), images[1].as_ref().unwrap());
+ let parms = stream(&doc, a).dict.get(b"DecodeParms").unwrap().as_dict().unwrap().clone();
+ let globals = parms.reference(b"JBIG2Globals").unwrap();
+ let clone = doc.clone();
+ assert_eq!(doc.decoded_image(&stream(&doc, a)).unwrap(), bits);
+ assert_eq!(doc.jbig2_globals.lock().unwrap().len(), 1, "kept");
+ let kept = doc.jbig2_globals.lock().unwrap()[&globals.num].clone();
+ assert_eq!(clone.decoded_image(&stream(&clone, b)).unwrap(), bits, "the clone's other image");
+ let shared = clone.jbig2_globals.lock().unwrap()[&globals.num].clone();
+ assert!(Arc::ptr_eq(&kept, &shared), "the clone uses the one kept, not a second decode");
+ doc.set(globals, Object::Stream(Stream::from_raw(Dict::new(), b"not JBIG2".to_vec())));
+ assert!(doc.decoded_image(&stream(&doc, b)).is_err(), "the edited globals are read afresh");
+ assert_eq!(clone.decoded_image(&stream(&clone, b)).unwrap(), bits, "the clone keeps the file's");
+}
+
+/// A JBIG2 image's size is read as given directly, as every caller reads it first, and an image
+/// with neither is an error, not an image of no rows.
+#[test]
+fn a_jbig2_image_needs_its_size_given_directly() {
+ let coded = pdfcraft_filters::encode_jbig2_generic(&[0xFF, 0xFF], 8, 2).unwrap();
+ let mut doc = Document::new_empty();
+ let size = doc.add(Object::Int(2));
+ let image = |width: Object, height: Object| {
+ let mut d = Dict::new();
+ d.set(b"Width".to_vec(), width);
+ d.set(b"Height".to_vec(), height);
+ d.set(b"Filter".to_vec(), Object::name("JBIG2Decode"));
+ doc.decoded_image(&Stream::from_raw(d, coded.clone()))
+ };
+ assert!(image(Object::Int(8), Object::Int(2)).is_ok());
+ assert!(image(Object::Ref(size), Object::Int(2)).is_err(), "/Width by reference");
+ assert!(image(Object::Int(8), Object::Ref(size)).is_err(), "/Height by reference");
+}
+
+/// A document that kept globals of 64 MiB keeps no more, and the images past that still read:
+/// three streams of 22 MiB, shared by three images, are two kept and one decoded each time.
+#[test]
+fn kept_jbig2_globals_are_bounded_in_total() {
+ let bits = [0b1111_1000, 0, 0b1111_1000, 0, 0b1111_1000, 0];
+ let coded = pdfcraft_filters::encode_jbig2_generic(&bits, 10, 3).unwrap();
+ let length = 22 * 1024 * 1024;
+ let mut skipped = vec![0, 0, 0, 0, 0x3E, 0, 0];
+ skipped.extend_from_slice(&u32::try_from(4 + length).unwrap().to_be_bytes());
+ skipped.extend_from_slice(&[0, 0, 0, 1]);
+ skipped.resize(skipped.len() + length, 0);
+ let mut doc = Document::new_empty();
+ let mut images = Vec::new();
+ for _ in 0..3 {
+ let mut d = Dict::new();
+ d.set(b"Filter".to_vec(), Object::name("FlateDecode"));
+ let globals = doc.add(Object::Stream(Stream::from_raw(d, pdfcraft_filters::encode_flate(&skipped))));
+ let mut d = Dict::new();
+ d.set(b"Width".to_vec(), Object::Int(10));
+ d.set(b"Height".to_vec(), Object::Int(3));
+ d.set(b"Filter".to_vec(), Object::name("JBIG2Decode"));
+ let mut parms = Dict::new();
+ parms.set(b"JBIG2Globals".to_vec(), Object::Ref(globals));
+ d.set(b"DecodeParms".to_vec(), Object::Dict(parms));
+ images.push(Object::Ref(doc.add(Object::Stream(Stream::from_raw(d, coded.clone())))));
+ }
+ let root = doc.root().unwrap();
+ doc.update_dict(root, |c| c.set(b"Images".to_vec(), Object::Array(images))).unwrap();
+ let doc = Document::open(Arc::new(crate::write_full(&doc, &crate::SaveOptions::default()).unwrap())).unwrap();
+ let images = doc.get(doc.root().unwrap()).as_dict().unwrap().get(b"Images").unwrap().as_array().unwrap().clone();
+ for image in &images {
+ let Object::Stream(s) = &*doc.get(image.as_ref().unwrap()) else { panic!("not a stream") };
+ assert_eq!(doc.decoded_image(s).unwrap(), bits, "every image reads");
+ }
+ let kept = doc.jbig2_globals.lock().unwrap();
+ assert_eq!(kept.len(), 2, "two fit in 64 MiB, a third doesn't");
+ assert!(kept.values().all(|g| g.capacity() == g.len()), "what is kept holds no more than it counts");
+}
+
+/// Globals whose `/DecodeParms` are given by reference aren't kept: that's another object, so
+/// editing it changes what they decode to while the stream itself, the key kept by, stays the same.
+#[test]
+fn jbig2_globals_with_parameters_by_reference_are_read_afresh() {
+ let bits = [0b1111_1000, 0, 0b1111_1000, 0, 0b1111_1000, 0];
+ let coded = pdfcraft_filters::encode_jbig2_generic(&bits, 10, 3).unwrap();
+ let skipped = [0, 0, 0, 0, 0x3E, 0, 0, 0, 0, 0, 4, 0, 0, 0, 1];
+ let params = pdfcraft_filters::Params { predictor: 12, colors: 1, bits_per_component: 8, columns: 15, early_change: 1 };
+ let mut doc = Document::new_empty();
+ let mut parms = Dict::new();
+ parms.set(b"Predictor".to_vec(), Object::Int(12));
+ parms.set(b"Columns".to_vec(), Object::Int(15));
+ let parms = doc.add(Object::Dict(parms));
+ let mut d = Dict::new();
+ d.set(b"Filter".to_vec(), Object::name("FlateDecode"));
+ d.set(b"DecodeParms".to_vec(), Object::Ref(parms));
+ let predicted = pdfcraft_filters::encode(&pdfcraft_filters::Filter::Flate, ¶ms, &skipped).unwrap();
+ let globals = doc.add(Object::Stream(Stream::from_raw(d, predicted)));
+ let mut d = Dict::new();
+ d.set(b"Width".to_vec(), Object::Int(10));
+ d.set(b"Height".to_vec(), Object::Int(3));
+ d.set(b"Filter".to_vec(), Object::name("JBIG2Decode"));
+ let mut image_parms = Dict::new();
+ image_parms.set(b"JBIG2Globals".to_vec(), Object::Ref(globals));
+ d.set(b"DecodeParms".to_vec(), Object::Dict(image_parms));
+ let image = doc.add(Object::Stream(Stream::from_raw(d, coded)));
+ let root = doc.root().unwrap();
+ doc.update_dict(root, |c| c.set(b"Image".to_vec(), Object::Ref(image))).unwrap();
+ let mut doc = Document::open(Arc::new(crate::write_full(&doc, &crate::SaveOptions::default()).unwrap())).unwrap();
+ let image = doc.get(doc.root().unwrap()).as_dict().unwrap().reference(b"Image").unwrap();
+ let stream = |doc: &Document| match &*doc.get(image) {
+ Object::Stream(s) => s.clone(),
+ _ => panic!("not a stream"),
+ };
+ assert_eq!(doc.decoded_image(&stream(&doc)).unwrap(), bits);
+ assert!(doc.jbig2_globals.lock().unwrap().is_empty(), "not kept");
+ let globals = stream(&doc).dict.get(b"DecodeParms").unwrap().as_dict().unwrap().reference(b"JBIG2Globals").unwrap();
+ let Object::Stream(g) = &*doc.get(globals) else { panic!("not a stream") };
+ let parms = g.dict.reference(b"DecodeParms").unwrap();
+ doc.set(parms, Object::Dict(Dict::new()));
+ assert!(doc.decoded_image(&stream(&doc)).is_err(), "without the predictor they read otherwise");
+}
+
+/// A JBIG2 image reads through its decoder, behind other filters too, with the `/JBIG2Globals` of
+/// its own `/DecodeParms` (a dictionary or its place in an array, /Crypt counting, by reference
+/// too): globals that can't be read are an error, and ones at another filter's place aren't its
+/// own, nor are those of a lone dictionary when other filters come first. Its page has to be its
+/// /Width × /Height, and fit the bound.
+#[test]
+fn jbig2_images_decode_with_their_globals() {
+ // 10 × 3: the first five samples of each row white, the rest black.
+ let bits = [0b1111_1000, 0, 0b1111_1000, 0, 0b1111_1000, 0];
+ let coded = pdfcraft_filters::encode_jbig2_generic(&bits, 10, 3).unwrap();
+ let hex = coded.iter().map(|b| format!("{b:02x}")).chain([">".to_string()]).collect::().into_bytes();
+ let mut doc = Document::new_empty();
+ // An extension segment (ISO/IEC 14492 7.4.14), which a decoder skips, Flate-encoded; and data
+ // that isn't JBIG2.
+ let globals = |doc: &mut Document, data: &[u8]| {
+ let mut d = Dict::new();
+ d.set(b"Filter".to_vec(), Object::name("FlateDecode"));
+ let globals = doc.add(Object::Stream(Stream::from_raw(d, pdfcraft_filters::encode_flate(data))));
+ let mut parms = Dict::new();
+ parms.set(b"JBIG2Globals".to_vec(), Object::Ref(globals));
+ Object::Dict(parms)
+ };
+ let (good, bad) = (globals(&mut doc, &[0, 0, 0, 0, 0x3E, 0, 0, 0, 0, 0, 4, 0, 0, 0, 1]), globals(&mut doc, b"not JBIG2"));
+ let indirect = Object::Ref(doc.add(bad.clone()));
+ let image = |filters: &[&str], parms: Option